Tutorial:Pooled Resource Unit Costs - Revision history

Freakpear: /* 📷 Creating / Copying Components */

2023-07-16T03:30:15Z

📷 Creating / Copying Components

← Older revision		Revision as of 23:30, 15 July 2023
Line 36:		Line 36:

	Using the paths we've previously established, the path for this new "prestige_cost" UIC we've created is therefore:		Using the paths we've previously established, the path for this new "prestige_cost" UIC we've created is therefore:
	<code>local prestige_cost_parent_uic = ~~find_uicomponent~~(~~unit_uic, "unit_icon",~~ "prestige_cost")</code>		<code>local prestige_cost_parent_uic = UIComponent(recruitment_cost_uic:CopyComponent("prestige_cost"))</code>

	=== ⬇️ Repositioning Components ===		=== ⬇️ Repositioning Components ===

Vandy: Vandy moved page Tutorial:Pooled Resource Costs to Tutorial:Pooled Resource Unit Costs over a redirect without leaving a redirect

2023-07-14T00:00:42Z

Vandy moved page Tutorial:Pooled Resource Costs to Tutorial:Pooled Resource Unit Costs over a redirect without leaving a redirect

← Older revision

Revision as of 20:00, 13 July 2023

Freakpear: /* 🎨 Making the UI */

2023-07-12T09:30:23Z

🎨 Making the UI

← Older revision		Revision as of 05:30, 12 July 2023
Line 65:		Line 65:

	== 🎨 Making the UI ==		== 🎨 Making the UI ==
	So let's start! First we'll be looking at two functions. In short, the two functions apply the UI knowledge we covered earlier (and a little extra) to create UICs, resize UICs, and set their docking points, text, and icons. The ~~<code>initialise_uics()</code> and <code>finalise_uics()</code>~~ functions are seperated because the first one has to run only when the panel is opened, ~~while~~ the second has to run every time the UI is refreshed while the panel is open. For the purpose of the guide we will be keeping the vanilla treasury costs and making one new Pooled Resource cost which will go below the unit card.		So let's start! First we'll be looking at two functions — <code>initialise_uics()</code> and <code>finalise_uics()</code> . In short, the two functions apply the UI knowledge we covered earlier (and a little extra) to create UICs, resize UICs, and set their docking points, text, and icons. The functions are seperated even though they do similar things because the first one has to run only when the panel is opened, whereas the second has to run every time the UI is refreshed while the panel is open. For the purpose of the guide we will be keeping the vanilla treasury costs and making one new Pooled Resource cost which will go below the unit card.

	'''IMPORTANT''': Make sure you change the '''listener and saved value names''' from the examples to avoid incompatibilities.		'''IMPORTANT''': Make sure you change the '''listener and saved value names''' from the examples to avoid incompatibilities.

Freakpear: /* 🎨 Making the UI */

2023-07-12T09:28:12Z

🎨 Making the UI

← Older revision		Revision as of 05:28, 12 July 2023
Line 65:		Line 65:

	== 🎨 Making the UI ==		== 🎨 Making the UI ==
	So let's start! First we'll be looking at two functions. In short, the two functions apply the UI knowledge we covered earlier (and a little extra) to create UICs, resize UICs, and set their docking points, text, and icons. ~~Comments in~~ the ~~functions briefly explain what each part does so I won't go into too much detail here. If it does not make sense I'd suggest looking up~~ the ~~functions used in~~ the ~~documentation~~. For the purpose of the guide we will be keeping the vanilla treasury costs and making one new Pooled Resource cost which will go below the unit card.		So let's start! First we'll be looking at two functions. In short, the two functions apply the UI knowledge we covered earlier (and a little extra) to create UICs, resize UICs, and set their docking points, text, and icons. The <code>initialise_uics()</code> and <code>finalise_uics()</code> functions are seperated because the first one has to run only when the panel is opened, while the second has to run every time the UI is refreshed while the panel is open. For the purpose of the guide we will be keeping the vanilla treasury costs and making one new Pooled Resource cost which will go below the unit card.

	'''IMPORTANT''': Make sure you change the '''listener and saved value names''' from the examples to avoid incompatibilities.		'''IMPORTANT''': Make sure you change the '''listener and saved value names''' from the examples to avoid incompatibilities.

Freakpear: /* 🔍 Finding UI Components */

2023-07-12T09:23:00Z

🔍 Finding UI Components

← Older revision		Revision as of 05:23, 12 July 2023
Line 16:		Line 16:
	=== 🔍 Finding UI Components ===		=== 🔍 Finding UI Components ===
	[[File:Recruitment cost component.png\|right\|thumb\|Recruitment Cost Component in the Context Viewer]]		[[File:Recruitment cost component.png\|right\|thumb\|Recruitment Cost Component in the Context Viewer]]
	In order to modify a part of the UI you need to find where it's located. To do this we can use the [https://tw-modding.com/wiki/Tutorial:Context_Viewer_(Warhammer_3) Context Viewer]. A quick way to do this is by having the Context Viewer open and clicking on the screen with ~~you~~ mouse wheel.		In order to modify a part of the UI you need to find where it's located. To do this we can use the [https://tw-modding.com/wiki/Tutorial:Context_Viewer_(Warhammer_3) Context Viewer]. A quick way to do this is by having the Context Viewer open and clicking on the screen with your mouse wheel.

	For the purpose of this tutorial, try clicking the unit card you want to add a Pooled Resource to then expanding the unit card path in the Context Viewer until you find the "RecruitmentCost" UIC. Once you've found it, paste <code>CopyFullPathToClipboard()</code> in the expression tester box. This copies the path to that UIC.		For the purpose of this tutorial, try clicking the unit card you want to add a Pooled Resource to then expanding the unit card path in the Context Viewer until you find the "RecruitmentCost" UIC. Once you've found it, paste <code>CopyFullPathToClipboard()</code> in the expression tester box. This copies the path to that UIC.

Freakpear: /* Originally written by Pear */

2023-07-12T09:18:01Z

Originally written by Pear

← Older revision		Revision as of 05:18, 12 July 2023
Line 1:		Line 1:
	=~~== Originally written~~ by Pear ===		= Total War: Warhammer 3 Guide by Pear =
	This guide and the [[:File:!units_cost_pooled_resource.pack\|example mod]] are my submission for '''Mod Jam #7'''.		This guide and the [[:File:!units_cost_pooled_resource.pack\|example mod]] are my submission for '''Mod Jam #7'''.

Freakpear: /* 🚀 Initialising UICs */

2023-07-11T23:34:35Z

🚀 Initialising UICs

← Older revision		Revision as of 19:34, 11 July 2023
Line 77:		Line 77:
	}</code>		}</code>

	This table is then used in the functions <code>initialise_uics(~~recruitment_type~~)</code> and <code>finalise_uics()</code>.		This table is then used in the functions <code>initialise_uics()</code> and <code>finalise_uics()</code>.

	The first function <code>initialise_uics(~~recruitment_type~~)</code> handles resizing the parents for UICs to make sure the list clips are displaying our new components and everything else appears correctly. The first part of that runs in a loop, once for local and once for global recruitment if the UIC exists then it proceeds:		The first function <code>initialise_uics()</code> handles resizing the parents for UICs to make sure the list clips are displaying our new components and everything else appears correctly. The first part of that runs in a loop, once for local and once for global recruitment if the UIC exists then it proceeds:

	<code>local function initialise_uics()		<code>local function initialise_uics()

Freakpear: /* 🪟 Finding panels */

2023-07-11T23:30:58Z

🪟 Finding panels

← Older revision		Revision as of 19:30, 11 July 2023
Line 58:		Line 58:

	=== 🪟 Finding panels ===		=== 🪟 Finding panels ===
	To find the name of the panel that you want to check is opened or closed ~~using the <code>PanelOpenedCampaign</code> and <code>PanelClosedCampaign</code> listeners~~ you can check the log produced by Groove's Modding Dev Tools. In the log it will look something like this:		To find the name of the panel that you want to check is opened or closed you can check the log produced by Groove's Modding Dev Tools. In the log it will look something like this:

	<code>[ui] <97.6s> Panel opened units_panel		<code>[ui] <97.6s> Panel opened units_panel

Freakpear: /* 🪟 Finding panels */

2023-07-11T23:30:10Z

🪟 Finding panels

← Older revision		Revision as of 19:30, 11 July 2023
Line 58:		Line 58:

	=== 🪟 Finding panels ===		=== 🪟 Finding panels ===
	To find the name of the panel that you want to check is opened or closed using the <code>~~CampaignPanelOpened~~</code> and <code>~~CampaignPanelClosed~~</code> listeners you can check the log produced by Groove's Modding Dev Tools. In the log it will look something like this:		To find the name of the panel that you want to check is opened or closed using the <code>PanelOpenedCampaign</code> and <code>PanelClosedCampaign</code> listeners you can check the log produced by Groove's Modding Dev Tools. In the log it will look something like this:

	<code>[ui] <97.6s> Panel opened units_panel		<code>[ui] <97.6s> Panel opened units_panel

Freakpear: /* 🎮 Triggering the UI */

2023-07-11T18:24:01Z

🎮 Triggering the UI

← Older revision		Revision as of 14:24, 11 July 2023
Line 280:		Line 280:
	)</code>		)</code>

	A refresh to the UI occurs when switching ~~to the Encamp~~ stance. This messes up the sizing of the parent panels. To account for this we need to use <code>ComponentLClickUp</code> which checks when the ~~Encamp button is pressed as well as a saved value similar to before~~ like this:		A refresh to the UI occurs when switching army stance. This messes up the sizing of the parent panels. To account for this we need to use <code>ComponentLClickUp</code> which checks when the stance changes occur like this:

	<code>core:add_listener(		<code>core:add_listener(