Tutorial:Context Viewer (Warhammer 3) - Revision history

Druwski: Add a missing hyperlink for Component Context Objects

2024-04-16T18:02:18Z

Add a missing hyperlink for Component Context Objects

← Older revision		Revision as of 14:02, 16 April 2024
Line 7:		Line 7:
	But what you might not know is you can also use it to make UI mod creation easier. This guide is intended to teach you how to use the viewer and outline some places it can make the UI Modding workflow easier.		But what you might not know is you can also use it to make UI mod creation easier. This guide is intended to teach you how to use the viewer and outline some places it can make the UI Modding workflow easier.

	This guide is intended to provide examples of how to use this tool. Depending what you're using it for, you may want to first familiarize yourself with [[Component Context Objects\|Component Context Objects.]]		This guide is intended to provide examples of how to use this tool. Depending what you're using it for, you may want to first familiarize yourself with [[Tutorial:Component Context Objects (CCOs)\|Component Context Objects]].

	== Enabling the Context Viewer ==		== Enabling the Context Viewer ==

DrunkFlamingo: Getting Region, Faction, Character Keys from the UI.

2022-04-01T15:02:14Z

Getting Region, Faction, Character Keys from the UI.

← Older revision		Revision as of 11:02, 1 April 2022
Line 52:		Line 52:
	== Example Usages ==		== Example Usages ==
	Here are some common tasks the UI Context Viewer can help with.		Here are some common tasks the UI Context Viewer can help with.

			=== Getting Faction Keys, Region Keys, and Other Information ===
			For many common tasks, it is necessary to find faction, subtype or region keys. The context viewer can speed up this process.

			To find the key of any region, select it in the UI, hover it's label (the 'zoom to settlement' button), and press the middle mouse button with the context viewer open. This will open the settlement UI in the context viewer. From here, you can expand the ContextsList field to see the available context, which will include the region context. The region key will be listed under ModelRegionContext on the region context page, and can be copied to the clipboard by right clicking the key.

			To find the subtype and agent key of any character, select them in the UI, hover the first unit card, and press middle mouse with the context viewer open. This will open the unit card UI in the context viewer. From here, you can expand the ContextsList field to see the available context, which will include the character context. The subtype is listed under AgentSubtypeRecordContext, while the type is listed under AgentRecordContext.

			In both region and character contexts, you can click links to go to other contexts. For instance, to find a faction key, you would open the context for a region or character that the faction owns and open the FactionContext.

	=== Gathering UI Path/GUIDs for Scripting/XML Editing ===		=== Gathering UI Path/GUIDs for Scripting/XML Editing ===

DrunkFlamingo: formatting

2022-03-30T13:24:08Z

formatting

← Older revision		Revision as of 09:24, 30 March 2022
Line 59:		Line 59:
	To use the context viewer to make this easier, use the component tree to navigate to the component that you are looking for.		To use the context viewer to make this easier, use the component tree to navigate to the component that you are looking for.

	Then use CopyFullPathToClipboard() in the expression tester box. You can now paste this into your scripts.		Then use <code>CopyFullPathToClipboard()</code> in the expression tester box. You can now paste this into your scripts.

	You can also use the related CopyStringToClipboard(GuidOriginal()) to copy the GUID - this can be used to find the component with the twui.xml files.		You can also use the related <code>CopyStringToClipboard(GuidOriginal())</code> to copy the GUID - this can be used to find the component with the twui.xml files.

DrunkFlamingo at 13:23, 30 March 2022

2022-03-30T13:23:06Z

← Older revision		Revision as of 09:23, 30 March 2022
Line 17:		Line 17:


	~~Keep~~ in ~~mind:~~ the ~~context viewer won't always~~ be ~~stable. There are elements, context object types, and operations which will crash your game~~.		The context viewer appears in the centre of the screen by default but can be dragged around as you please.




			Keep in mind: the context viewer won't always be stable. There are elements, context object types, and operations which will crash your game.

	== Using the Context Viewer ==		== Using the Context Viewer ==

DrunkFlamingo: How to use the context viewer

2022-03-30T13:21:23Z

How to use the context viewer

@@ Line 6: / Line 6: @@
 But what you might not know is you can also use it to make UI mod creation easier. This guide is intended to teach you how to use the viewer and outline some places it can make the UI Modding workflow easier.
 == Enabling the Context Viewer ==
@@ Line 13: / Line 15: @@
 You can now open the context viewer in game using your ` key. That's right above tab, to the left of 1, on a standard keyboard.
 == Using the Context Viewer ==
-Some stuff about the different panels and the expression tester
+The Documentation folder in the game's data packfile has two documentation files: an HTML file which we will refer to as the Component Context Object documentation, or CCO Documentation, and a short microsoft word file called context_viewer_doc, which explains how to use the context viewer.
 == Example Usages ==

DrunkFlamingo: Gathering UI Paths/GUID

2022-03-30T13:07:53Z

Gathering UI Paths/GUID

@@ Line 1: / Line 1: @@
 The context viewer is a CA hack that can be activated in the settings menu in Total War: Warhammer 3.
@@ Line 10: / Line 8: @@
 == Enabling the Context Viewer ==
-[[File:Enable ui context viewer.png|alt=options > settings > Modding > enable context viewer|left|thumb]]
+[[File:Enable ui context viewer.png|alt=options > settings > Modding > enable context viewer|left|thumb]]To enable the context viewer, simply open the settings menu, hit the gear icon (fourth down on the left side menu), and then check the box under Modding.

DrunkFlamingo at 00:58, 30 March 2022

2022-03-30T00:58:32Z

← Older revision		Revision as of 20:58, 29 March 2022
Line 10:		Line 10:

	== Enabling the Context Viewer ==		== Enabling the Context Viewer ==
			[[File:Enable ui context viewer.png\|alt=options > settings > Modding > enable context viewer\|left\|thumb]]

DrunkFlamingo: Created page with "== UNDER CONSTRUCTION - APPROVE MY IMAGES VANDY PLS == The context viewer is a CA hack that can be activated in the settings menu in Total War: Warhammer 3. You already k..."

2022-03-29T22:37:34Z

Created page with "== UNDER CONSTRUCTION - APPROVE MY IMAGES VANDY PLS == The context viewer is a CA hack that can be activated in the settings menu in Total War: Warhammer 3. You already k..."

New page

== UNDER CONSTRUCTION - APPROVE MY IMAGES VANDY PLS ==

The context viewer is a CA hack that can be activated in the settings menu in Total War: Warhammer 3.

You already knew that, of course, because you've been using it to cheat in your single player games.

But what you might not know is you can also use it to make UI mod creation easier. This guide is intended to teach you how to use the viewer and outline some places it can make the UI Modding workflow easier.

== Enabling the Context Viewer ==