Porting other faction's UI feature - Revision history

Rhox: /* Making own twui */

2025-01-12T04:24:12Z

Making own twui

← Older revision		Revision as of 00:24, 12 January 2025
Line 29:		Line 29:
	Congratulations, now you just finished your own twui. Now we have to show it to people via script. Put the twui made this way into your pack.		Congratulations, now you just finished your own twui. Now we have to show it to people via script. Put the twui made this way into your pack.

	Note, if your TWUI references another GUID in command, it shouldn't be changed in most cases. As the referenced component's GUID isn't getting changed. EX: Component(&quot;17A9800A-927B-1EF3-753A8CCD4148C7DB&quot;)		Note, if your TWUI references another GUID of other TWUI in command, it shouldn't be changed in most cases. As the referenced component's GUID isn't getting changed. EX: Component(&quot;17A9800A-927B-1EF3-753A8CCD4148C7DB&quot;) and the GUID is directing to the component in the hud_campaign

	====Scripting====		====Scripting====

Rhox: /* Getting Original Code */

2025-01-09T14:32:18Z

Getting Original Code

← Older revision		Revision as of 10:32, 9 January 2025
Line 27:		Line 27:
	[[File:Guid regen.png\|center\|thumb]]		[[File:Guid regen.png\|center\|thumb]]

	Congratulations, now you just finished your own twui. Now we have to show it to people via script. Put the twui made this way into your pack.		Congratulations, now you just finished your own twui. Now we have to show it to people via script. Put the twui made this way into your pack.

			Note, if your TWUI references another GUID in command, it shouldn't be changed in most cases. As the referenced component's GUID isn't getting changed. EX: Component(&quot;17A9800A-927B-1EF3-753A8CCD4148C7DB&quot;)

	====Scripting====		====Scripting====
Line 55:		Line 57:

	# The component is not created, even in the component viewer: Check the script, and whether your twui has the correct structure. If you've set up all correctly, check the callbacks of the TWUI components. Very rarely some of them have 'destroy callbacks' in them		# The component is not created, even in the component viewer: Check the script, and whether your twui has the correct structure. If you've set up all correctly, check the callbacks of the TWUI components. Very rarely some of them have 'destroy callbacks' in them
	# Game CTDs: Check the hierarchy and whether your component has all the components listed in the hierarchy		#Game CTDs: Check the hierarchy and whether your component has all the components listed in the hierarchy
	# Things are not showing properly: Check the DBs and references of the DBs in the twui are correct.		#Things are not showing properly: Check the DBs and references of the DBs in the twui are correct.

Rhox at 06:12, 21 July 2023

2023-07-21T06:12:51Z

← Older revision		Revision as of 02:12, 21 July 2023
Line 33:		Line 33:


	Now ~~make~~ write some script like the one below.		Now write some script like the one below.


Line 48:		Line 48:
	end		end
	)		)
	~~Now~~ start the game as Wurrzag and check whether it works.		Apply this script to the mod, and start the game as Wurrzag and check whether it works.
	[[File:Rhythm.png\|center\|thumb]]		[[File:Rhythm.png\|center\|thumb]]
	Congratulations! You still have to set the script, and DB effect to really make it interesting, but the job on the twui side is done.		Congratulations! You still have to set the script, and DB effect to really make it interesting, but the job on the twui side is done.

Rhox at 09:03, 8 July 2023

2023-07-08T09:03:45Z

← Older revision		Revision as of 05:03, 8 July 2023
Line 54:		Line 54:
	If it's not working, check the following things		If it's not working, check the following things

	# The component is not created, even in the component viewer: Check the script, and whether your twui has the correct structure.		# The component is not created, even in the component viewer: Check the script, and whether your twui has the correct structure. If you've set up all correctly, check the callbacks of the TWUI components. Very rarely some of them have 'destroy callbacks' in them
	# Game CTDs: Check the hierarchy and whether your component has all the components listed in the hierarchy		# Game CTDs: Check the hierarchy and whether your component has all the components listed in the hierarchy
	# Things are not showing properly: Check the DBs and references of the DBs in the twui are correct		# Things are not showing properly: Check the DBs and references of the DBs in the twui are correct.
	~~# Check callbacks of the TWUI components. Some of them have destroy callbacks in them~~.

Rhox at 04:46, 8 July 2023

2023-07-08T04:46:13Z

← Older revision		Revision as of 00:46, 8 July 2023
Line 7:		Line 7:


	(I'm going to skip all the pooled resource parts, look at other tutorials if you don't have no ideas)		(I'm going to skip all the pooled resource parts, look at other tutorials if you don't have any ideas)

	==== Getting Original Code ====		==== Getting Original Code ====
Line 38:		Line 38:
	cm:add_first_tick_callback(		cm:add_first_tick_callback(
	function()		function()
	if cm:get_local_faction_name(true) == "wh_main_grn_orcs_of_the_bloody_hand" then--put your faction name. It's just for showing UI so it should ~~be local~~		if cm:get_local_faction_name(true) == "wh_main_grn_orcs_of_the_bloody_hand" then--put your faction name. It's just for showing UI so it should use cm:get_local_faction thing
	local parent_ui = find_uicomponent(core:get_ui_root(), "hud_campaign", "resources_bar_holder", "resources_bar");--where your TWUI will reside		local parent_ui = find_uicomponent(core:get_ui_root(), "hud_campaign", "resources_bar_holder", "resources_bar");--where your TWUI will reside
	local result = core:get_or_create_component("rhox_dancer_harmony_holder", "ui/campaign ui/rhox_dancer.twui.xml", parent_ui) --put your path to the twui		local result = core:get_or_create_component("rhox_dancer_harmony_holder", "ui/campaign ui/rhox_dancer.twui.xml", parent_ui) --put your path to the twui
Line 54:		Line 54:
	If it's not working, check the following things		If it's not working, check the following things

	# The component is not created: Check the script, and whether your twui has the correct structure.		# The component is not created, even in the component viewer: Check the script, and whether your twui has the correct structure.
	# Game CTDs: Check the hierarchy and whether your component has all the components listed in the hierarchy		# Game CTDs: Check the hierarchy and whether your component has all the components listed in the hierarchy
	# Things are not showing properly: Check the DBs and references of the DBs in the twui are correct		# Things are not showing properly: Check the DBs and references of the DBs in the twui are correct
			# Check callbacks of the TWUI components. Some of them have destroy callbacks in them.

Rhox at 03:09, 8 July 2023

2023-07-08T03:09:33Z

← Older revision		Revision as of 23:09, 7 July 2023
Line 23:		Line 23:
	# Now for the component part, we want to copy every component mentioned in the hierarchy, including the root.		# Now for the component part, we want to copy every component mentioned in the hierarchy, including the root.
	# After that, we want to change the pooled resource name and effect bundle name into what we have set.		# After that, we want to change the pooled resource name and effect bundle name into what we have set.
	# As a final step, we want to feed the hairy robot a twui we made to change the ~~guide~~		# As a final step, we want to feed the hairy robot a twui we made to change the GUID

	[[File:Guid regen.png\|center\|thumb]]		[[File:Guid regen.png\|center\|thumb]]

	Congratulations, now you just finished your own twui. Now we have to show it to people via script. Put the twui made this way into your pack.		Congratulations, now you just finished your own twui. Now we have to show it to people via script. Put the twui made this way into your pack.

Rhox: Finished

2023-07-08T03:08:08Z

Finished

← Older revision		Revision as of 23:08, 7 July 2023
Line 1:		Line 1:
	This tutorial talks about how to create a custom twui based on other vanilla UI		This tutorial talks about how to create a custom twui based on other vanilla UI

			'''Do not try to use twui unless you're confident with your scripting.''' In many cases, you can't make the twui do what you want because we don't understand many of the twui callbacks (especially from the ones before the Wh3) and you have to use the script for that. So practice scripting, or get a team member who is good at it.

	=== Synopsis ===		=== Synopsis ===
Line 5:		Line 7:


	(I'm going to skip all the pooled resource parts, ~~for that~~ look at other tutorials)		(I'm going to skip all the pooled resource parts, look at other tutorials if you don't have no ideas)

	==== Getting Original Code ====		==== Getting Original Code ====
Line 13:		Line 15:


	On hud_campaign_resource_bar_wh3.twui.xml, you'll find the twui parts responsible for it. Now it's time to copy it and make our own.		On hud_campaign_resource_bar_wh3.twui.xml or harmony.twui.xml, you'll find the twui parts responsible for it. Now it's time to copy it and make our own.

	==== Making own twui ====		==== Making own twui ====
Line 25:		Line 27:
	[[File:Guid regen.png\|center\|thumb]]		[[File:Guid regen.png\|center\|thumb]]

	Congratulations, now you just finished your own twui. Now we have to show it to people via script.		Congratulations, now you just finished your own twui. Now we have to show it to people via script. Put the twui made this way into your pack.

	====Scripting====		====Scripting====


	~~Now make your script and write some script like below~~

			Now make write some script like the one below.

	cm:~~add_post_first_tick_callback~~(
			cm:add_first_tick_callback(
	function()		function()
	if cm:get_local_faction_name(true) == "wh_main_grn_orcs_of_the_bloody_hand" then--put your faction name		if cm:get_local_faction_name(true) == "wh_main_grn_orcs_of_the_bloody_hand" then--put your faction name. It's just for showing UI so it should be local
	local parent_ui = find_uicomponent(core:get_ui_root(), "hud_campaign", "resources_bar_holder", "resources_bar");		local parent_ui = find_uicomponent(core:get_ui_root(), "hud_campaign", "resources_bar_holder", "resources_bar");--where your TWUI will reside
	local result = core:get_or_create_component("rhox_dancer_harmony_holder", "ui/campaign ui/rhox_dancer.twui.xml", parent_ui) --put your path to the twui		local result = core:get_or_create_component("rhox_dancer_harmony_holder", "ui/campaign ui/rhox_dancer.twui.xml", parent_ui) --put your path to the twui
	if not result then		if not result then
Line 46:		Line 49:
	)		)
	Now start the game as Wurrzag and check whether it works.		Now start the game as Wurrzag and check whether it works.
			[[File:Rhythm.png\|center\|thumb]]
			Congratulations! You still have to set the script, and DB effect to really make it interesting, but the job on the twui side is done.

			If it's not working, check the following things

	~~And you'll find out it's~~ not ~~working. Now we have to find out what is~~ the ~~problem~~.		# The component is not created: Check the script, and whether your twui has the correct structure.
			# Game CTDs: Check the hierarchy and whether your component has all the components listed in the hierarchy
			# Things are not showing properly: Check the DBs and references of the DBs in the twui are correct


	~~(Under construction)~~

Rhox: mid save

2023-07-07T17:26:35Z

mid save

← Older revision		Revision as of 13:26, 7 July 2023
Line 27:		Line 27:
	Congratulations, now you just finished your own twui. Now we have to show it to people via script.		Congratulations, now you just finished your own twui. Now we have to show it to people via script.

			====Scripting====

	(Under ~~Construction~~)
			Now make your script and write some script like below


			cm:add_post_first_tick_callback(
			function()
			if cm:get_local_faction_name(true) == "wh_main_grn_orcs_of_the_bloody_hand" then--put your faction name
			local parent_ui = find_uicomponent(core:get_ui_root(), "hud_campaign", "resources_bar_holder", "resources_bar");
			local result = core:get_or_create_component("rhox_dancer_harmony_holder", "ui/campaign ui/rhox_dancer.twui.xml", parent_ui) --put your path to the twui
			if not result then
			script_error("Rhox dancer: ".. "ERROR: could not create harmony ui component? How can this be?");
			return false;
			end;
			end
			end
			)
			Now start the game as Wurrzag and check whether it works.


			And you'll find out it's not working. Now we have to find out what is the problem.




			(Under construction)

Rhox: twui

2023-07-07T16:06:41Z

twui

← Older revision		Revision as of 12:06, 7 July 2023
Line 9:		Line 9:
	==== Getting Original Code ====		==== Getting Original Code ====
	[[File:Harmony.png\|center\|thumb]]		[[File:Harmony.png\|center\|thumb]]
	First, you want to check the path and some component names by playing the Cathay and checking the path to the UI by using the component viewer. You can turn this feature on by checking the check box in the settings and pressing the` button (the one on your upper left) in your keyboard		First, you want to check the path and some component names by playing the Cathay and checking the path to the UI by using the component viewer. You can turn this feature on by checking the check box in the settings and pressing the ` button (the one on your upper left) in your keyboard
	[[File:Twui.png\|center\|thumb]]		[[File:Twui.png\|center\|thumb]]


	On hud_campaign_resource_bar_wh3.twui.xml, you'll find the twui parts responsible for it. Now it's time to copy it and make our own.		On hud_campaign_resource_bar_wh3.twui.xml, you'll find the twui parts responsible for it. Now it's time to copy it and make our own.

			==== Making own twui ====
			Now for Hierarchy, we want to copy 'Root' and all harmony-related parts. So the hierarchy part will look like below.
			[[File:Harmony hierarchy.png\|center\|thumb]]

			# Now for the component part, we want to copy every component mentioned in the hierarchy, including the root.
			# After that, we want to change the pooled resource name and effect bundle name into what we have set.
			# As a final step, we want to feed the hairy robot a twui we made to change the guide

			[[File:Guid regen.png\|center\|thumb]]

			Congratulations, now you just finished your own twui. Now we have to show it to people via script.


	(Under Construction)		(Under Construction)

Rhox: under construction

2023-07-07T15:40:30Z

under construction

New page

This tutorial talks about how to create a custom twui based on other vanilla UI

=== Synopsis ===
Let's say I want to create a new feature for Wurrzag based on his dancing. Huh, what does dancing have to do with Total War and how are we going to represent it? Maybe I should focus on the rhythm of the dancing and fitting the perfect harmony. And for that, we should Harmony feature used by Cathay.

(I'm going to skip all the pooled resource parts, for that look at other tutorials)

==== Getting Original Code ====
[[File:Harmony.png|center|thumb]]
First, you want to check the path and some component names by playing the Cathay and checking the path to the UI by using the component viewer. You can turn this feature on by checking the check box in the settings and pressing the` button (the one on your upper left) in your keyboard
[[File:Twui.png|center|thumb]]

On hud_campaign_resource_bar_wh3.twui.xml, you'll find the twui parts responsible for it. Now it's time to copy it and make our own.

(Under Construction)