Total War Modding - User contributions [en]

Functions without document

2025-12-29T14:57:24Z

Rhox:

This page will include information about functions without a document, or the document has the wrong information.

== cm:add_unit_to_province_mercenary_pool ==
cm:add_unit_to_province_mercenary_pool(region_script_interface ''region'', string ''unit_key'', string ''mercenary pool'', number ''unit_count'', number ''replen_chance'', number ''max_units'', number ''max_replen_per_turn'', string ''faction_requirement'', string ''subculture_requirement'', string ''culture_requirement'', boolean ''use_partial_replen'', string ''merc_unit_group'')

This one is used to add province mercenaries. In the case of Wh3, they're used for the undead's Raise Dead and Warrior of Chaos' Warband recruitment. The document has the wrong parameters for this function, and the vanilla does not use it, so make sure to check the correct parameters.

Also, one province can have only one main unit added via this function. So if you added a zombie with a faction Alpha restriction with this function, and add another zombie with the faction Beta restriction with this function, Alpha won't have access to the zombie since that one is overridden.

== cm:is_agent_transformation_available ==
cm:is_agent_transformation_available(string ''agent_subtype_key'')

Returns true if your agent_subtype is in the DB campaign_to_agent_subtypes_tables with the given campaign. Especially useful if you want to check certain agent_subtype is unique. (Given that modders have added it to that table)

== cm:military_force_add_temporary_stance ==
cm:military_force_add_temporary_stance(number ''mf_cqi'',string ''stance'', number ''turn'')

Can be used to give a certain stance to a military force for a time even if that faction does not have access to the stance via campaign_stances_factions_junctions_tables. If 0 is given to turn, it will be infinite.

== cm:faction_set_total_potential_override_value ==
cm:faction_set_total_potential_override_value(FACTION_SCRIPT_INTERFACE faction, bool use_override_value, int32 total_potential_override_value) – bypasses the faction potential calculation and sets a fixed value

ex: cm:faction_set_total_potential_override_value(cm:get_faction("wh3_main_dae_daemon_prince"), true, 500) This will forcibly set the Daemon Prince's faction potential to 500

== cm:faction_set_potential_modifier ==
cm:faction_set_potential_modifier(FACTION_SCRIPT_INTERFACE faction, int32 faction_potential_modifier) – Calculates the faction potential as normal, then modifies it by an additional amount

ex: cm:faction_set_potential_modifier(cm:get_faction("wh3_main_dae_daemon_prince"), -100) This will calculate the Daemon Prince's faction potential as normal (probably 200), and then subtract 100 from it to reach 100 total.

== cm:set_plague_component_state ==
cm:set_plague_component_state(faction_script_interface ''faction'', string ''component'', string ''state'', boolean set_to_blessed)

Used to handle ToD's new plague system. While they're not in the document, vanilla uses it, so check there.

== Other vanilla using functions ==
cm:set_force_sphere_of_influence_radius

cm:entity_add_pooled_resource_transaction

cm:awaken_faction_from_death

cm:sabotage_garrison_army

cm:campaign_var_int_value

cm:entity_transfer_pooled_resource

cm:remove_override_building_chain_display_from_region(display_chain, region_key)

cm:get_override_building_chain_display_for_region(display_chain, region_key)

== FactionDeath ==
While not function, and is in the document, I'll include it here since Chadvandy does not have it yet.

This listener listens for the faction death and supports these in the contexts

- killer(): Faction that killed this faction

- faction(): Faction that died

- is_game_over(): Is the game over

== try_get_agent_plague_components() ==
Also not a function and is callable from CHARACTER_SCRIPT_INTERFACE. Mostly used for plague checking
[[Category:Script]]

Functions without document

2025-12-10T09:26:56Z

Rhox: /* Other vanilla using functions */

This page will include information about functions without a document, or the document has the wrong information.

== cm:add_unit_to_province_mercenary_pool ==
cm:add_unit_to_province_mercenary_pool(region_script_interface ''region'', string ''unit_key'', string ''mercenary pool'', number ''unit_count'', number ''replen_chance'', number ''max_units'', number ''max_replen_per_turn'', string ''faction_requirement'', string ''subculture_requirement'', string ''culture_requirement'', boolean ''use_partial_replen'', string ''merc_unit_group'')

This one is used to add province mercenaries. In the case of Wh3, they're used for the undead's Raise Dead and Warrior of Chaos' Warband recruitment. The document has the wrong parameters for this function, and the vanilla does not use it, so make sure to check the correct parameters.

Also, one province can have only one main unit added via this function. So if you added a zombie with a faction Alpha restriction with this function, and add another zombie with the faction Beta restriction with this function, Alpha won't have access to the zombie since that one is overridden.

== cm:is_agent_transformation_available ==
cm:is_agent_transformation_available(string ''agent_subtype_key'')

Returns true if your agent_subtype is in the DB campaign_to_agent_subtypes_tables with the given campaign. Especially useful if you want to check certain agent_subtype is unique. (Given that modders have added it to that table)

== cm:military_force_add_temporary_stance ==
cm:military_force_add_temporary_stance(number ''mf_cqi'',string ''stance'', number ''turn'')

Can be used to give a certain stance to a military force for a time even if that faction does not have access to the stance via campaign_stances_factions_junctions_tables. If 0 is given to turn, it will be infinite.

== cm:faction_set_total_potential_override_value ==
cm:faction_set_total_potential_override_value(FACTION_SCRIPT_INTERFACE faction, bool use_override_value, int32 total_potential_override_value) – bypasses the faction potential calculation and sets a fixed value

ex: cm:faction_set_total_potential_override_value(cm:get_faction("wh3_main_dae_daemon_prince"), true, 500) This will forcibly set the Daemon Prince's faction potential to 500

== cm:faction_set_potential_modifier ==
cm:faction_set_potential_modifier(FACTION_SCRIPT_INTERFACE faction, int32 faction_potential_modifier) – Calculates the faction potential as normal, then modifies it by an additional amount

ex: cm:faction_set_potential_modifier(cm:get_faction("wh3_main_dae_daemon_prince"), -100) This will calculate the Daemon Prince's faction potential as normal (probably 200), and then subtract 100 from it to reach 100 total.

== cm:set_plague_component_state ==
cm:set_plague_component_state(faction_script_interface ''faction'', string ''component'', string ''state'', boolean set_to_blessed)

Used to handle ToD's new plague system. While they're not in the document, vanilla uses it, so check there.

== Other vanilla using functions ==
cm:set_force_sphere_of_influence_radius

cm:entity_add_pooled_resource_transaction

cm:awaken_faction_from_death

cm:sabotage_garrison_army

cm:campaign_var_int_value

cm:entity_transfer_pooled_resource

== FactionDeath ==
While not function, and is in the document, I'll include it here since Chadvandy does not have it yet.

This listener listens for the faction death and supports these in the contexts

- killer(): Faction that killed this faction

- faction(): Faction that died

- is_game_over(): Is the game over

== try_get_agent_plague_components() ==
Also not a function and is callable from CHARACTER_SCRIPT_INTERFACE. Mostly used for plague checking
[[Category:Script]]

Functions without document

2025-12-10T09:21:45Z

Rhox: /* Other vanilla using functions */

This page will include information about functions without a document, or the document has the wrong information.

== cm:add_unit_to_province_mercenary_pool ==
cm:add_unit_to_province_mercenary_pool(region_script_interface ''region'', string ''unit_key'', string ''mercenary pool'', number ''unit_count'', number ''replen_chance'', number ''max_units'', number ''max_replen_per_turn'', string ''faction_requirement'', string ''subculture_requirement'', string ''culture_requirement'', boolean ''use_partial_replen'', string ''merc_unit_group'')

This one is used to add province mercenaries. In the case of Wh3, they're used for the undead's Raise Dead and Warrior of Chaos' Warband recruitment. The document has the wrong parameters for this function, and the vanilla does not use it, so make sure to check the correct parameters.

Also, one province can have only one main unit added via this function. So if you added a zombie with a faction Alpha restriction with this function, and add another zombie with the faction Beta restriction with this function, Alpha won't have access to the zombie since that one is overridden.

== cm:is_agent_transformation_available ==
cm:is_agent_transformation_available(string ''agent_subtype_key'')

Returns true if your agent_subtype is in the DB campaign_to_agent_subtypes_tables with the given campaign. Especially useful if you want to check certain agent_subtype is unique. (Given that modders have added it to that table)

== cm:military_force_add_temporary_stance ==
cm:military_force_add_temporary_stance(number ''mf_cqi'',string ''stance'', number ''turn'')

Can be used to give a certain stance to a military force for a time even if that faction does not have access to the stance via campaign_stances_factions_junctions_tables. If 0 is given to turn, it will be infinite.

== cm:faction_set_total_potential_override_value ==
cm:faction_set_total_potential_override_value(FACTION_SCRIPT_INTERFACE faction, bool use_override_value, int32 total_potential_override_value) – bypasses the faction potential calculation and sets a fixed value

ex: cm:faction_set_total_potential_override_value(cm:get_faction("wh3_main_dae_daemon_prince"), true, 500) This will forcibly set the Daemon Prince's faction potential to 500

== cm:faction_set_potential_modifier ==
cm:faction_set_potential_modifier(FACTION_SCRIPT_INTERFACE faction, int32 faction_potential_modifier) – Calculates the faction potential as normal, then modifies it by an additional amount

ex: cm:faction_set_potential_modifier(cm:get_faction("wh3_main_dae_daemon_prince"), -100) This will calculate the Daemon Prince's faction potential as normal (probably 200), and then subtract 100 from it to reach 100 total.

== cm:set_plague_component_state ==
cm:set_plague_component_state(faction_script_interface ''faction'', string ''component'', string ''state'', boolean set_to_blessed)

Used to handle ToD's new plague system. While they're not in the document, vanilla uses it, so check there.

== Other vanilla using functions ==
cm:set_force_sphere_of_influence_radius

cm:entity_add_pooled_resource_transaction

cm:awaken_faction_from_death

cm:sabotage_garrison_army

cm:campaign_var_int_value

== FactionDeath ==
While not function, and is in the document, I'll include it here since Chadvandy does not have it yet.

This listener listens for the faction death and supports these in the contexts

- killer(): Faction that killed this faction

- faction(): Faction that died

- is_game_over(): Is the game over

== try_get_agent_plague_components() ==
Also not a function and is callable from CHARACTER_SCRIPT_INTERFACE. Mostly used for plague checking
[[Category:Script]]

Functions without document

2025-12-10T09:18:33Z

Rhox: /* Other vanilla using functions */

This page will include information about functions without a document, or the document has the wrong information.

== cm:add_unit_to_province_mercenary_pool ==
cm:add_unit_to_province_mercenary_pool(region_script_interface ''region'', string ''unit_key'', string ''mercenary pool'', number ''unit_count'', number ''replen_chance'', number ''max_units'', number ''max_replen_per_turn'', string ''faction_requirement'', string ''subculture_requirement'', string ''culture_requirement'', boolean ''use_partial_replen'', string ''merc_unit_group'')

This one is used to add province mercenaries. In the case of Wh3, they're used for the undead's Raise Dead and Warrior of Chaos' Warband recruitment. The document has the wrong parameters for this function, and the vanilla does not use it, so make sure to check the correct parameters.

Also, one province can have only one main unit added via this function. So if you added a zombie with a faction Alpha restriction with this function, and add another zombie with the faction Beta restriction with this function, Alpha won't have access to the zombie since that one is overridden.

== cm:is_agent_transformation_available ==
cm:is_agent_transformation_available(string ''agent_subtype_key'')

Returns true if your agent_subtype is in the DB campaign_to_agent_subtypes_tables with the given campaign. Especially useful if you want to check certain agent_subtype is unique. (Given that modders have added it to that table)

== cm:military_force_add_temporary_stance ==
cm:military_force_add_temporary_stance(number ''mf_cqi'',string ''stance'', number ''turn'')

Can be used to give a certain stance to a military force for a time even if that faction does not have access to the stance via campaign_stances_factions_junctions_tables. If 0 is given to turn, it will be infinite.

== cm:faction_set_total_potential_override_value ==
cm:faction_set_total_potential_override_value(FACTION_SCRIPT_INTERFACE faction, bool use_override_value, int32 total_potential_override_value) – bypasses the faction potential calculation and sets a fixed value

ex: cm:faction_set_total_potential_override_value(cm:get_faction("wh3_main_dae_daemon_prince"), true, 500) This will forcibly set the Daemon Prince's faction potential to 500

== cm:faction_set_potential_modifier ==
cm:faction_set_potential_modifier(FACTION_SCRIPT_INTERFACE faction, int32 faction_potential_modifier) – Calculates the faction potential as normal, then modifies it by an additional amount

ex: cm:faction_set_potential_modifier(cm:get_faction("wh3_main_dae_daemon_prince"), -100) This will calculate the Daemon Prince's faction potential as normal (probably 200), and then subtract 100 from it to reach 100 total.

== cm:set_plague_component_state ==
cm:set_plague_component_state(faction_script_interface ''faction'', string ''component'', string ''state'', boolean set_to_blessed)

Used to handle ToD's new plague system. While they're not in the document, vanilla uses it, so check there.

== Other vanilla using functions ==
cm:set_force_sphere_of_influence_radius

cm:entity_add_pooled_resource_transaction

cm:awaken_faction_from_death

cm:sabotage_garrison_army

== FactionDeath ==
While not function, and is in the document, I'll include it here since Chadvandy does not have it yet.

This listener listens for the faction death and supports these in the contexts

- killer(): Faction that killed this faction

- faction(): Faction that died

- is_game_over(): Is the game over

== try_get_agent_plague_components() ==
Also not a function and is callable from CHARACTER_SCRIPT_INTERFACE. Mostly used for plague checking
[[Category:Script]]

Functions without document

2025-12-10T09:14:17Z

Rhox:

This page will include information about functions without a document, or the document has the wrong information.

== cm:add_unit_to_province_mercenary_pool ==
cm:add_unit_to_province_mercenary_pool(region_script_interface ''region'', string ''unit_key'', string ''mercenary pool'', number ''unit_count'', number ''replen_chance'', number ''max_units'', number ''max_replen_per_turn'', string ''faction_requirement'', string ''subculture_requirement'', string ''culture_requirement'', boolean ''use_partial_replen'', string ''merc_unit_group'')

This one is used to add province mercenaries. In the case of Wh3, they're used for the undead's Raise Dead and Warrior of Chaos' Warband recruitment. The document has the wrong parameters for this function, and the vanilla does not use it, so make sure to check the correct parameters.

Also, one province can have only one main unit added via this function. So if you added a zombie with a faction Alpha restriction with this function, and add another zombie with the faction Beta restriction with this function, Alpha won't have access to the zombie since that one is overridden.

== cm:is_agent_transformation_available ==
cm:is_agent_transformation_available(string ''agent_subtype_key'')

Returns true if your agent_subtype is in the DB campaign_to_agent_subtypes_tables with the given campaign. Especially useful if you want to check certain agent_subtype is unique. (Given that modders have added it to that table)

== cm:military_force_add_temporary_stance ==
cm:military_force_add_temporary_stance(number ''mf_cqi'',string ''stance'', number ''turn'')

Can be used to give a certain stance to a military force for a time even if that faction does not have access to the stance via campaign_stances_factions_junctions_tables. If 0 is given to turn, it will be infinite.

== cm:faction_set_total_potential_override_value ==
cm:faction_set_total_potential_override_value(FACTION_SCRIPT_INTERFACE faction, bool use_override_value, int32 total_potential_override_value) – bypasses the faction potential calculation and sets a fixed value

ex: cm:faction_set_total_potential_override_value(cm:get_faction("wh3_main_dae_daemon_prince"), true, 500) This will forcibly set the Daemon Prince's faction potential to 500

== cm:faction_set_potential_modifier ==
cm:faction_set_potential_modifier(FACTION_SCRIPT_INTERFACE faction, int32 faction_potential_modifier) – Calculates the faction potential as normal, then modifies it by an additional amount

ex: cm:faction_set_potential_modifier(cm:get_faction("wh3_main_dae_daemon_prince"), -100) This will calculate the Daemon Prince's faction potential as normal (probably 200), and then subtract 100 from it to reach 100 total.

== cm:set_plague_component_state ==
cm:set_plague_component_state(faction_script_interface ''faction'', string ''component'', string ''state'', boolean set_to_blessed)

Used to handle ToD's new plague system. While they're not in the document, vanilla uses it, so check there.

== Other vanilla using functions ==
cm:set_force_sphere_of_influence_radius

cm:entity_add_pooled_resource_transaction

== FactionDeath ==
While not function, and is in the document, I'll include it here since Chadvandy does not have it yet.

This listener listens for the faction death and supports these in the contexts

- killer(): Faction that killed this faction

- faction(): Faction that died

- is_game_over(): Is the game over

== try_get_agent_plague_components() ==
Also not a function and is callable from CHARACTER_SCRIPT_INTERFACE. Mostly used for plague checking
[[Category:Script]]

Functions without document

2025-12-07T14:27:42Z

Rhox: 7.0 changes

This page will include information about functions without a document, or the document has the wrong information.

== cm:add_unit_to_province_mercenary_pool ==
cm:add_unit_to_province_mercenary_pool(region_script_interface ''region'', string ''unit_key'', string ''mercenary pool'', number ''unit_count'', number ''replen_chance'', number ''max_units'', number ''max_replen_per_turn'', string ''faction_requirement'', string ''subculture_requirement'', string ''culture_requirement'', boolean ''use_partial_replen'', string ''merc_unit_group'')

This one is used to add province mercenaries. In the case of Wh3, they're used for the undead's Raise Dead and Warrior of Chaos' Warband recruitment. The document has the wrong parameters for this function, and the vanilla does not use it, so make sure to check the correct parameters.

Also, one province can have only one main unit added via this function. So if you added a zombie with a faction Alpha restriction with this function, and add another zombie with the faction Beta restriction with this function, Alpha won't have access to the zombie since that one is overridden.

== cm:is_agent_transformation_available ==
cm:is_agent_transformation_available(string ''agent_subtype_key'')

Returns true if your agent_subtype is in the DB campaign_to_agent_subtypes_tables with the given campaign. Especially useful if you want to check certain agent_subtype is unique. (Given that modders have added it to that table)

== cm:military_force_add_temporary_stance ==
cm:military_force_add_temporary_stance(number ''mf_cqi'',string ''stance'', number ''turn'')

Can be used to give a certain stance to a military force for a time even if that faction does not have access to the stance via campaign_stances_factions_junctions_tables. If 0 is given to turn, it will be infinite.

== cm:faction_set_total_potential_override_value ==
cm:faction_set_total_potential_override_value(FACTION_SCRIPT_INTERFACE faction, bool use_override_value, int32 total_potential_override_value) – bypasses the faction potential calculation and sets a fixed value

ex: cm:faction_set_total_potential_override_value(cm:get_faction("wh3_main_dae_daemon_prince"), true, 500) This will forcibly set the Daemon Prince's faction potential to 500

== cm:faction_set_potential_modifier ==
cm:faction_set_potential_modifier(FACTION_SCRIPT_INTERFACE faction, int32 faction_potential_modifier) – Calculates the faction potential as normal, then modifies it by an additional amount

ex: cm:faction_set_potential_modifier(cm:get_faction("wh3_main_dae_daemon_prince"), -100) This will calculate the Daemon Prince's faction potential as normal (probably 200), and then subtract 100 from it to reach 100 total.

== cm:set_plague_component_state ==
cm:set_plague_component_state(faction_script_interface ''faction'', string ''component'', string ''state'', boolean set_to_blessed)

Used to handle ToD's new plague system. While they're not in the document, vanilla uses it, so check there.

== FactionDeath ==
While not function, and is in the document, I'll include it here since Chadvandy does not have it yet.

This listener listens for the faction death and supports these in the contexts

- killer(): Faction that killed this faction

- faction(): Faction that died

- is_game_over(): Is the game over

== try_get_agent_plague_components() ==
Also not a function and is callable from CHARACTER_SCRIPT_INTERFACE. Mostly used for plague checking
[[Category:Script]]

Startpos

2025-10-08T03:42:35Z

Rhox:

(Disclaimer: Some of the opinions are solitary of Rhox's and might not align with the community's)

Startpos is turn 0 save of the campaign. The key point is, that '''there can be only one startpos'''. Thus, appending or removing via another mod isn't possible. That's why most of the users use only one startpos mod, Mixer. Technically, IEE and TOW are also startpos mods. But they're made to have each entry the same as Mixer and Chaos Robie's stuff are appended manually.

Due to this characteristic,
Modders have made several works around for many startpos-only features, some parts are still startpos bound and need Mixer's work though.

=== Startpos things that can't be replicated ===

* Cultures available agent_types: Mixer has added every possible case for every known culture and Mixer added culture. This would also mean the culture you added won't work due to this. Even if your faction does not have heroes, there is also the tech issue.
* Slot types used for Landmarks: Same as above, Mixu makes slots for each region.
* Potential for each faction: Same.
* Factions: Both playable and spawnable need startpos work. Making it playable requires more work than just spawnable ones. Use the Mixer faction requests thread if you need them. Every playable entry increases the loading time so my advice is to practice with any mixer faction in it, then request when the work is complete. Also, Mixu prefers batch work rather than getting small requests multiple times
* Diplomacy: For non-aggression and military access only. Others can be replicated via scripts.
** '''<code>cm:force_grant_military_access</code>''' has some serious quirks and military access given by this can't be canceled in the UI
* Regions held by a faction in the faction selection window: It needs startpos work but it's minor so I would say just ignore it
* Faction leader CQI: If you need your leader to have a certain CQI, you need startpos. You don't normally need it unless you're going to make a quest battle for the leader. However, you can use a script to fool the users. Check Wh2 OvN's Halfing scripts
* Name group: You can make the name after apwning, but you can't make the name to appear in the recruitment section.

=== Startpos things that the script can theoretically replace but no one has done it yet ===

* Offices: Because it's just an effect bundle given to a character and not so exciting for many of the makers. If you happen to make one, consider sending it to Mixu
* Horde marker in the diplomacy panel: It's related to the feature forest, and the script below does not change this. Theoretically, you can change it with the script to change the icon and tooltip. (But I haven't tried)

=== Startpos things that can be replaced with script and DB way ===

* Faction RoR (mercenaries): Setup mercenary DB and call '''<code>cm:add_unit_to_faction_mercenary_pool()</code>'''function at first tick callback new
* Province mercenaries (raise dead and warbands): Similar but the function in the document is wrong so check other mods that use this function
* Settings like starting region, leader, items, units, buildings, and such: Check other faction mods, Most of the things can be replicated with the script.
** Faction starting position pin: Use frontend_faction_leaders_tables and alter the 'Override Force Location X & Y' column.
* Tech node Set: While the tech node set is startpos, you can use some workaround. Do note that all the methods below need script work to lock all the vanilla techs you want to remove access from your faction. Otherwise, AI can research it plus will create research available alarm to the player when they have researched all available techs shown in the UI
** Overriding some of the nodes with faction-specific nodes: Use the faction column in the node tables to override the vanilla one. Even CA uses this method for some of the factions. But it can only do overrides and the tech tree's shape needs to cover all the vanilla tech nodes.
** Sending all existing techs to a place where users can't see: While you might not know it, every tech node set can have only one tech key. This means if you make a new faction-specific tech node that has a vanilla tech key, that faction will not have access to the vanilla tech node and will have access to the node the user has made. If you send all the vanilla nodes to a place with this method to a place where users can't see them, now you can create a new tech node set of your own. Check out OvN Dread King if you need an example. Note that it doesn't work for center-starting tech node sets like Chaos Warriors
** Make a new tech tab and hide the previous one: Need some script work but also works. Do note that it can cause problems if another mod adds a tab of its own, but you can create compatibility if you want to.
* Feature Forest: You don't normally use it, but if you're making a full horde faction (factions that can't occupy settlements) into a normal faction, or turning a full horde faction into a normal faction, but you can use other ways.
** You can use the cm:add_or_remove_faction_features() function in the script to remove or add features from a certain faction
** You can add more into feature into feature_set_to_faction_features_tables if you want to change accessible features of all the factions of that feature forest
* Norsca vassal thing, and empire giving region thing (start_pos_entity_association_faction_regions_tables): Depends on what you're using it for, but since it's used in occupation options, you can use a script to hide certain things when the conditions don't match

Functions without document

2025-09-17T02:58:15Z

Rhox: /* cm:add_unit_to_province_mercenary_pool */

This page will include information about functions without a document, or the document has the wrong information.

== cm:add_unit_to_province_mercenary_pool ==
cm:add_unit_to_province_mercenary_pool(region_script_interface ''region'', string ''unit_key'', string ''recruitment_source'', number ''unit_count'', number ''replen_chance'', number ''max_units'', number ''max_replen_per_turn'', string ''faction_requirement'', string ''subculture_requirement'', string ''culture_requirement'', boolean ''use_partial_replen'', string ''merc_unit_group'')

This one is used to add province mercenaries. In the case of Wh3, they're used for the undead's Raise Dead and Warrior of Chaos' Warband recruitment. The document has the wrong parameters for this function, and the vanilla does not use it, so make sure to check the correct parameters.

Also, one province can have only one main unit added via this function. So if you added a zombie with a faction Alpha restriction with this function, and add another zombie with the faction Beta restriction with this function, Alpha won't have access to the zombie since that one is overridden.

== cm:is_agent_transformation_available ==
cm:is_agent_transformation_available(string ''agent_subtype_key'')

Returns true if your agent_subtype is in the DB campaign_to_agent_subtypes_tables with the given campaign. Especially useful if you want to check certain agent_subtype is unique. (Given that modders have added it to that table)

== cm:military_force_add_temporary_stance ==
cm:military_force_add_temporary_stance(number ''mf_cqi'',string ''stance'', number ''turn'')

Can be used to give a certain stance to a military force for a time even if that faction does not have access to the stance via campaign_stances_factions_junctions_tables. If 0 is given to turn, it will be infinite.

== cm:faction_set_total_potential_override_value ==
cm:faction_set_total_potential_override_value(FACTION_SCRIPT_INTERFACE faction, bool use_override_value, int32 total_potential_override_value) – bypasses the faction potential calculation and sets a fixed value

ex: cm:faction_set_total_potential_override_value(cm:get_faction("wh3_main_dae_daemon_prince"), true, 500) This will forcibly set the Daemon Prince's faction potential to 500

== cm:faction_set_potential_modifier ==
cm:faction_set_potential_modifier(FACTION_SCRIPT_INTERFACE faction, int32 faction_potential_modifier) – Calculates the faction potential as normal, then modifies it by an additional amount

ex: cm:faction_set_potential_modifier(cm:get_faction("wh3_main_dae_daemon_prince"), -100) This will calculate the Daemon Prince's faction potential as normal (probably 200), and then subtract 100 from it to reach 100 total.

== cm:set_plague_component_state ==
cm:set_plague_component_state(faction_script_interface ''faction'', string ''component'', string ''state'', boolean set_to_blessed)

Used to handle ToD's new plague system. While they're not in the document, vanilla uses it, so check there.

== FactionDeath ==
While not function, and is in the document, I'll include it here since Chadvandy does not have it yet.

This listener listens for the faction death and supports these in the contexts

- killer(): Faction that killed this faction

- faction(): Faction that died

- is_game_over(): Is the game over

== try_get_agent_plague_components() ==
Also not a function and is callable from CHARACTER_SCRIPT_INTERFACE. Mostly used for plague checking
[[Category:Script]]

Porting other faction's UI feature

2025-01-12T04:24:12Z

Rhox: /* Making own twui */

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 ===
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, look at other tutorials if you don't have any ideas)

==== 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 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 ====
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 GUID

[[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.

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====

Now write some script like the one below.

cm:add_first_tick_callback(
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 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 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
)
Apply this script to the mod, and 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

# 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
#Things are not showing properly: Check the DBs and references of the DBs in the twui are correct.

Porting other faction's UI feature

2025-01-09T14:32:18Z

Rhox: /* Getting Original Code */

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 ===
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, look at other tutorials if you don't have any ideas)

==== 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 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 ====
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 GUID

[[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.

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====

Now write some script like the one below.

cm:add_first_tick_callback(
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 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 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
)
Apply this script to the mod, and 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

# 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
#Things are not showing properly: Check the DBs and references of the DBs in the twui are correct.

Troubleshooting

2024-07-29T11:35:51Z

Rhox: /* Generic pointers: */ https://discord.com/channels/373745291289034763/731080362758766652/1267442399588909056

This is a troubleshooting guide for mod users in TW: Warhammer 3. There will be different details and more or less big variations, beginning with what mod managers you could use, but generic pointers should be valid for all recent TW games.

– Your neighbourhood Cataph

''last updated in may 2024''

== Managing Mods ==
So, you have subscribed to mods on the workshop, I say, as I lift one foot to rest on a stool and one arm on that knee for stereotypical posture. By default, you'll obviously be using CA’s mod manager (hereby called George by emulating CA's name-giving tradition) from the game's launcher to enable, remove or whatever the mods you have subscribed to.

However, while George got some upgrades in the past years and has resolved some of its most painful problem, it's still fairly limited in what it does. There is a recommendation at this point of grabbing a community-made mod managers, and oh boy we're so lucky we even have a selection. I cannot in good conscience offer pros/cons of each as I didn't make that kind of comparison within WH3.

* [https://github.com/Kaedrin/warhammer-mod-manager/releases/ Kaedrin's]: first of this lot, works across multiple titles.
* [https://github.com/Shazbot/WH3-Mod-Manager/releases/ PropJoes's, aka WH3MM].
* [https://github.com/Frodo45127/runcher/releases/ Runcher]: made by Frodo, same guy behind RPFM, the modding tool.

These managers have something in common, which is offering a whole lot of options compared to George: making groups of mods, ease of opening them with RPFM or reaching their workshop page, backup and cloning options, cool stuff like that. '''''Personally''''', I'm currently using the second, PJ's, because it was the first of these to work for WH3 and I never had reasons to change back to KMM or try Runcher, but that is my personal choice and habit. Pick your favourite. Inevitably, this guide will also be written in a way that is influenced by this choice of mine; some things or options will be worded differently for the other MMs, be in different spots, or not be there. You get the drift though.

== How to Load Order ==
[[File:Load order bad.png|thumb|BAD]]
All of these managers, including George, have functions to manually change mod listing and how mods are loaded, which speaks to the old habit of handling load order within other modding communities, so you’d be tempted to change it manually to make things work just right, right?

'''''WRONG.'''''

Ok, I’ll spare some time for this before we get into the actually useful tips, because this is one of the nastiest tropes in the context. The truth is that compatibility-minded TW modders already handle load order on their own as far as possible. Manually changing load order may do absolutely nothing, shift the problem somewhere else or break everything.

Some context. There are six main possible categories of folders in a mod pack and this is how they handle load order, either through actual '''pack name''' (the file name as the .pack gets downloaded) or '''table name''' (internal bits you won't see unless you open the pack):

* '''Db''': table name.
* '''Scripts''': pack name.
* '''Startpos''' (the big bad): pack name. CEO for 3K is similar.
* '''Text''': table name.
* '''UI''': pack name.
* '''Variants''': pack name.

And that is if the modder doesn’t redirect content (e.g., telling database to use a different icon from a different file path). There are things like balance submods (mostly Db overrides) that are still completely in the hands of the modders and intentionally so. In essence, packs should be ordered alphabetically and let the inner bits do their thing.

In other words, there are only two possible cases in which you may want to alter load order manually: UI and variants, basically if you want to use specific reskin B.pack in the midst of larger reskin A.pack, in which case you push B on top. But generally speaking this should be out of your mind or can be manually tweaked with a bit more care.

''In conclusion, give Steam time to download/remove mods and keep load order in an alphabetical fashion (e.g. order by name and save profile), especially after adding new mods.''

Which, incidentally, is this:

! # $ % & ‘ ( ) + , – ; = @ 0-9 a-z [ ] ^ _ ` { } ~

Where “!” wins over “a”.

Sometimes, mod descriptions will tell you to manually alter load order to make that mod work over another, but quite frankly that is either unnecessary or the modder didn't do their homework to make sure that worked ''anyway'' (e.g., already making sure their pack and table names were right).

== Common Troubleshooting ==
Ok, this is probably the reason you're here, ''something'' is wrong in your mod list and you need to find out what.

In an efficient mod, at least half of the reported issues are down to user error or what is technically called launcher f***-up. We’re going to try and cut that amount down for the greater good.

Let's get two things out of the way immediately:

*'''When in doubt, redownload''': Steam Workshop is acceptable for many things but it does have some god-awful behaviours. One of these is getting you a version of the mod that is either 1) older than it should be or 2) straight up a corrupted and broken file. This means crashing when it's obviously not supposed to happen, or getting older, possibly broken, features. This is particularly painful around patch time, of course. And it is painfully common, so please, seriously, verify that this is not your case before rushing to a comment section to say "mod crash". Your options are:
**'''Force download''' with a community manager (e.g., right click on the specific mod and click it, or PJ's can do it for all mods).
**Go to the mod's Steam page, unsuscribe and resuscribe after a pause, aka the unsub/resub cycle.
**Go to the game's content folder and physically delete the folder or pack.[[File:Steam workshop mod dates.jpg|thumb|If that last date doesn't match, clearly you got an old version]]

NONE OF THESE is guaranteed to work, especially on a first attempt. Keep that in mind and keep trying when things are fishy, e.g. the "last updated" date on your mod manager is older than Update: DD/MM on its workshop page on the top right.

Yes, this is tiresome, but trust me, '''if Steam is doing this to the mod, and it's very common that it does, we modders can't do anything for you'''. And if the wretched modder actually pushed an update that crashed the game, they'll know by the sheer amount of reports.

So if a mod that clearly shouldn't be crashing (or having pre-patch features) but it keeps doing it for you, just keep forcing the update locally for your game. And maybe go pester Valve for a fix.

== User good practices: ==
The following is a list of tips that you should observe in general when dealing with TW mods.

''This list is of course not meant to insult anybody’s intelligence, but you’d be surprised at how many issues and massive wastes of time are due to neglect of these simple rules. Following them is in the user’s interest in order to find a solution sooner, and it will allow the modder more time for improvement rather than wasting their precious free time in unnecessary bug-hunts.''
# '''Read the mod description.''' Seriously, this alone would prevent 80% of comments on Steam pages. Even if a description looks long, do it, at least skim it to parse the important bits, it’s there for a reason. Some mods will also have FAQs or a list of known issues, incompatibilities and instructions. Read the comments before yours too if you have to post one. There’s an excellent chance the question you’re going to ask is already answered in in descriptions, FAQs and recent comments. Also, it's always good to know what the mod you grabbed actually do, so you know where stuff might be coming from.
# '''Don’t ignore the required items.''' The mod may show you a popup upon subscribing, disregarding that is almost always cue for disaster. This popup is ''not'' shown when subbing from a Steam collection (thanks Gaben), so actually check the mod’s page. PJ's MM will warn you about this if you haven't enabled important mods.
# '''Keep load order alphanumerical.''' We’ve been over that already. If you have new mods that have somehow popped at the tail of the list, just reset the mod list, e.g., click twice again on the <code>Name</code> column in George until it looks alphabetical.
# '''Troubleshoot yourself!''' The thing is, we don’t have time to help everybody, and in most cases the problem is local. Test if the issue happens when only that mod is enabled (plus any other that it requires); if you don't know what mod is doing the thing, bisect the mod list (e.g., load only half of it, PJ's MM can do it semi-automatically). We’ll get to best practices on this, don’t worry.
# '''Issue Context''': upon commenting about an issue, provide as much info as possible. Ok, you did everything right but that ugly bug is still there. That’s fine. The worst thing you could do at this point is comment “mod doesn’t work” because that means absolutely nothing. Modders aren’t usually telepaths, although we might be developing a sense of it under environmental pressure. Steam comments aren’t the best place for this, so use a discussion or the discord server/channel lurked by that given modder. If you still haven't figured out which mod is doing it and need help, use the #mod_user_troubleshooting channel in the [https://discord.gg/moddingden Modding Den].
#* Context: when and how the thing happened. E.g. during the interturn after X’s turn, or clicking this button, whether it was mortal empires campaign or not, multiplayer, custom battle or campaign battle.
#* Mod list: if asked, link a collection or post a screenshot of the mod list (possibly not in George). For example, the big thing is not being naïve enough that the overhaul in your list can’t affect other mods. For some reason, sometimes it feels like pulling teeth to know what else is there. However, if your mod list is longer than, say, 40 items, don't expect people to miraculously figure out what's going on while just reading through 200 mod names.
#* Screenshot: always helps for clarity and visual context.
#* Save game: if requested, you can find your save game in (example) C:\Users\%USER%\AppData\Roaming\The Creative Assembly\Warhammer2\save_games. Remember the mod list, because the modder may not be able to load without it.
#* Results of your own troubleshooting: for example it’s good to know it happens with that one mod only. Relatedly, if you posted about an issue and later find the cause, let us know.
# '''"It doesn't crash so it works"'''. Don't assume your mod list is working just because it's not currently blowing up your computer or it didn't murder your cat. A crash is only the most visible of symptoms, it's like assuming a coal miner is perfectly fine just because they haven't dropped dead yet. You may have all kinds of issues in your 400-mods list ranging from fucked models to script breaks. Did I mention don't use 400 mods? Yeah nah, probably don't.

== APPENDIX: Trimming the Mod List ==
There is no such thing as a mod cap in WH3, which is another common trope. It’s up to you to keep your mod list functional, and '''the more mods you run the more likely you are to encounter issues, or just to see maintenance time increase for you'''. Making your mod list work is up to how careful you are. '''Remember, just because your list doesn’t produce an instant crash you can’t be sure there aren’t less visible issues''', e.g. script breaks.

As a rule of thumb, don’t be cocky with your list of 250 mods. It’s all fun and games until everything works perfectly (and with those numbers chances are it doesn’t already, you just can’t see it), at which point there’s a lot of stuff to check. Even if 300 out of 350 are reskins you would entrust with your house keys, it all adds to the volume of annoyance if something goes wrong. For example, maybe don't enable mods that affect stuff you will NEVER see as a player for a given campaign.

If you’re not experienced yet (and don’t assume you are just because you played Skyrim, this is different), use the mod list of someone that has very carefully been curating it, and check that it looks ok with the help of the modders themselves. For example, start by a modder’s own collection on Steam, they often have one.

=== Finding the culprit ===
The usual problem with large mod lists is this: bad, I got a crash; worse, which one of the N mods I have is the culprit?

==== Generic pointers: ====

* Pure Text, Variant, and simple icon replacement mods will hardly ever be able to cause a crash for the user (assuming the modder ever tested their changes).
** It's possible for text to have some specific and crashy missing references, and for UI mods to have more complex TWUI files for panel structure and interfaces, and those can cause problems. Again, if translation mods tell you to change load order, those might be doing something very risky and frankly daft.
** If variants crash, such as trying to open a character's panel and getting a CTD because it's trying to load its 3d full portrait, try fiddling with your graphic settings and report back to the modder.
* Momentarily sort by date on the MM to find the most recent updates, if you didn’t add additional mods those ''may'' (just may) be responsible.
* If you had the issue during a campaign, do not remove mods that have custom items, units or buildings because you’re just going to crash harder if those are around in the campaign map.
* Watch out for movie packs. These are packs with a specific setting that long story short used to be required for some things but it may cause them to automatically fire despite being disabled. In WH3, these are really only necessary (as of may '24) for new audio content. If you’re inexplicably crashing even with no mods on, you might have a movie pack with crashy data in it and the modder might need screaming at.

==== Bisect and Conquer: ====
[[File:Bisect wh3mm.jpg|thumb|Within PJ's WH3MM, within Other Options]]
Especially when dealing with big mod lists, the quickest method is to enable half of it. If you crash, that’s the troublesome half. Halve again to tighten the noose.

Keep in mind mod requirements while you do this.

If you want to check on a particular mod, disable everything and load the bare minimum to make that mod work, in other words mod+whatever required mods that comes with. And up from there, adding one or small groups of mods at a time until you can reproduce the issue.

It’s patient work but the modder will appreciate it, and it takes less than panicking for hours in a comment section. Assume that a modder won’t troubleshoot your mod list of 150 packs because you say it’s their mod doing it, unless they have proof because you tested without anything else plus requirements.

Remember: a happy modder is a happy user.

== APPENDIX: Scripts ==
Scripts are being increasingly used by mods. While most scripters are getting smarter by the day to maintain compatibility, some require a framework or some mods will just struggle to work when there are too many mods around.

You may encounter symptoms of broken scripts, due to botched downloads, bad compatibility or just plain unforeseen issues because we can just mess stuff up sometimes. Script glitches may end up being tricky to root out.

A few examples of broken scripts:

* Starting lords that should be custom are not custom, or don’t spawn, or don’t have the correct army or settlement. (in some cases, this is intentionally delayed to turn 2 for performance reasons)
* Sword of Khaine button is unchained right off.
* Chaos and all Rogue armies may spawn immediately.
* Campaign camera on a fresh campaign starts zoomed-out and doesn’t pan in.
* Chivalry starts at 0.
* One of the worst, characters do not gain XP (this may sometimes happen in full vanilla too, requires repair).

==== Scropt broken, what do? ====
Remember, it's always important to trim your mod list to determine the culprit/s. With scripts, there may be specific interactions that cause problems, such as trying to do thing A to thing B but another mod has already removed or changed B irreparably for that to work.

When/if you report the issue to modders, remember to provide as much info as humanly possible because finding a script break can turn ugly and complicated.

Particularly useful to help with scripting issues: please enable [https://steamcommunity.com/sharedfiles/filedetails/?id=1271877744 this debugger] (or enable the option in PJ's MM), reproduce the bug and send the resulting log, which will be a lenghty txt generated in ''Steam\steamapps\common\Total War WARHAMMER II''. Specific scripty mods may come with additional instructions in their mod descriptions/faqs.

Do not keep the script logger enabled past this necessity, since it will noticeably slow down your game.

One of the most frequent issues at the moment is a performance-related clog-up at the start of a campaign. This basically means that too many scripts are trying to fit into that time frame to do their stuff (legendary lords, changing armies, this kinda stuff) and results in some of them not working. This is where size of the mod list, in regards to any mod with a first-tick script, becomes serious.

== APPENDIX: [https://steamcommunity.com/sharedfiles/filedetails/?id=1354363596 Mod Configuration Tool] ==
This other framework is used to provide settings for compatible mods, i.e. to tweak some details at your heart’s content. Usually a good thing to keep it around because there’s quite a few mods supporting it, or that may do it in the future. For example, you may use it to configure some scripts to fire in a performance mode to reduce impact on campaign start.
== APPENDIX: WH3, crashing on clicking Skirmish ==
The most likely cause for this right now is that you saved a character (that new fancy function in WH3 to play campaign characters into skirmishes) but it was originated or affected by a mod that you have since then removed. Kaboom. The other symptom is going kaboom when trying to recruit any hero or lord in campaign.

Go in <code>C:\Users\user\AppData\Roaming\The Creative Assembly\Warhammer3\saved_characters</code> (or search %appdata% in windows search, then continue to those folders) and delete them.

== APPENDIX: the Powershell rummage ==
TBC

Troubleshooting

2024-07-29T11:03:51Z

Rhox: /* Generic pointers: */ The case is different in Wh3

This is a troubleshooting guide for mod users in TW: Warhammer 3. There will be different details and more or less big variations, beginning with what mod managers you could use, but generic pointers should be valid for all recent TW games.

– Your neighbourhood Cataph

''last updated in may 2024''

== Managing Mods ==
So, you have subscribed to mods on the workshop, I say, as I lift one foot to rest on a stool and one arm on that knee for stereotypical posture. By default, you'll obviously be using CA’s mod manager (hereby called George by emulating CA's name-giving tradition) from the game's launcher to enable, remove or whatever the mods you have subscribed to.

However, while George got some upgrades in the past years and has resolved some of its most painful problem, it's still fairly limited in what it does. There is a recommendation at this point of grabbing a community-made mod managers, and oh boy we're so lucky we even have a selection. I cannot in good conscience offer pros/cons of each as I didn't make that kind of comparison within WH3.

* [https://github.com/Kaedrin/warhammer-mod-manager/releases/ Kaedrin's]: first of this lot, works across multiple titles.
* [https://github.com/Shazbot/WH3-Mod-Manager/releases/ PropJoes's, aka WH3MM].
* [https://github.com/Frodo45127/runcher/releases/ Runcher]: made by Frodo, same guy behind RPFM, the modding tool.

These managers have something in common, which is offering a whole lot of options compared to George: making groups of mods, ease of opening them with RPFM or reaching their workshop page, backup and cloning options, cool stuff like that. '''''Personally''''', I'm currently using the second, PJ's, because it was the first of these to work for WH3 and I never had reasons to change back to KMM or try Runcher, but that is my personal choice and habit. Pick your favourite. Inevitably, this guide will also be written in a way that is influenced by this choice of mine; some things or options will be worded differently for the other MMs, be in different spots, or not be there. You get the drift though.

== How to Load Order ==
[[File:Load order bad.png|thumb|BAD]]
All of these managers, including George, have functions to manually change mod listing and how mods are loaded, which speaks to the old habit of handling load order within other modding communities, so you’d be tempted to change it manually to make things work just right, right?

'''''WRONG.'''''

Ok, I’ll spare some time for this before we get into the actually useful tips, because this is one of the nastiest tropes in the context. The truth is that compatibility-minded TW modders already handle load order on their own as far as possible. Manually changing load order may do absolutely nothing, shift the problem somewhere else or break everything.

Some context. There are six main possible categories of folders in a mod pack and this is how they handle load order, either through actual '''pack name''' (the file name as the .pack gets downloaded) or '''table name''' (internal bits you won't see unless you open the pack):

* '''Db''': table name.
* '''Scripts''': pack name.
* '''Startpos''' (the big bad): pack name. CEO for 3K is similar.
* '''Text''': table name.
* '''UI''': pack name.
* '''Variants''': pack name.

And that is if the modder doesn’t redirect content (e.g., telling database to use a different icon from a different file path). There are things like balance submods (mostly Db overrides) that are still completely in the hands of the modders and intentionally so. In essence, packs should be ordered alphabetically and let the inner bits do their thing.

In other words, there are only two possible cases in which you may want to alter load order manually: UI and variants, basically if you want to use specific reskin B.pack in the midst of larger reskin A.pack, in which case you push B on top. But generally speaking this should be out of your mind or can be manually tweaked with a bit more care.

''In conclusion, give Steam time to download/remove mods and keep load order in an alphabetical fashion (e.g. order by name and save profile), especially after adding new mods.''

Which, incidentally, is this:

! # $ % & ‘ ( ) + , – ; = @ 0-9 a-z [ ] ^ _ ` { } ~

Where “!” wins over “a”.

Sometimes, mod descriptions will tell you to manually alter load order to make that mod work over another, but quite frankly that is either unnecessary or the modder didn't do their homework to make sure that worked ''anyway'' (e.g., already making sure their pack and table names were right).

== Common Troubleshooting ==
Ok, this is probably the reason you're here, ''something'' is wrong in your mod list and you need to find out what.

In an efficient mod, at least half of the reported issues are down to user error or what is technically called launcher f***-up. We’re going to try and cut that amount down for the greater good.

Let's get two things out of the way immediately:

*'''When in doubt, redownload''': Steam Workshop is acceptable for many things but it does have some god-awful behaviours. One of these is getting you a version of the mod that is either 1) older than it should be or 2) straight up a corrupted and broken file. This means crashing when it's obviously not supposed to happen, or getting older, possibly broken, features. This is particularly painful around patch time, of course. And it is painfully common, so please, seriously, verify that this is not your case before rushing to a comment section to say "mod crash". Your options are:
**'''Force download''' with a community manager (e.g., right click on the specific mod and click it, or PJ's can do it for all mods).
**Go to the mod's Steam page, unsuscribe and resuscribe after a pause, aka the unsub/resub cycle.
**Go to the game's content folder and physically delete the folder or pack.[[File:Steam workshop mod dates.jpg|thumb|If that last date doesn't match, clearly you got an old version]]

NONE OF THESE is guaranteed to work, especially on a first attempt. Keep that in mind and keep trying when things are fishy, e.g. the "last updated" date on your mod manager is older than Update: DD/MM on its workshop page on the top right.

Yes, this is tiresome, but trust me, '''if Steam is doing this to the mod, and it's very common that it does, we modders can't do anything for you'''. And if the wretched modder actually pushed an update that crashed the game, they'll know by the sheer amount of reports.

So if a mod that clearly shouldn't be crashing (or having pre-patch features) but it keeps doing it for you, just keep forcing the update locally for your game. And maybe go pester Valve for a fix.

== User good practices: ==
The following is a list of tips that you should observe in general when dealing with TW mods.

''This list is of course not meant to insult anybody’s intelligence, but you’d be surprised at how many issues and massive wastes of time are due to neglect of these simple rules. Following them is in the user’s interest in order to find a solution sooner, and it will allow the modder more time for improvement rather than wasting their precious free time in unnecessary bug-hunts.''
# '''Read the mod description.''' Seriously, this alone would prevent 80% of comments on Steam pages. Even if a description looks long, do it, at least skim it to parse the important bits, it’s there for a reason. Some mods will also have FAQs or a list of known issues, incompatibilities and instructions. Read the comments before yours too if you have to post one. There’s an excellent chance the question you’re going to ask is already answered in in descriptions, FAQs and recent comments. Also, it's always good to know what the mod you grabbed actually do, so you know where stuff might be coming from.
# '''Don’t ignore the required items.''' The mod may show you a popup upon subscribing, disregarding that is almost always cue for disaster. This popup is ''not'' shown when subbing from a Steam collection (thanks Gaben), so actually check the mod’s page. PJ's MM will warn you about this if you haven't enabled important mods.
# '''Keep load order alphanumerical.''' We’ve been over that already. If you have new mods that have somehow popped at the tail of the list, just reset the mod list, e.g., click twice again on the <code>Name</code> column in George until it looks alphabetical.
# '''Troubleshoot yourself!''' The thing is, we don’t have time to help everybody, and in most cases the problem is local. Test if the issue happens when only that mod is enabled (plus any other that it requires); if you don't know what mod is doing the thing, bisect the mod list (e.g., load only half of it, PJ's MM can do it semi-automatically). We’ll get to best practices on this, don’t worry.
# '''Issue Context''': upon commenting about an issue, provide as much info as possible. Ok, you did everything right but that ugly bug is still there. That’s fine. The worst thing you could do at this point is comment “mod doesn’t work” because that means absolutely nothing. Modders aren’t usually telepaths, although we might be developing a sense of it under environmental pressure. Steam comments aren’t the best place for this, so use a discussion or the discord server/channel lurked by that given modder. If you still haven't figured out which mod is doing it and need help, use the #mod_user_troubleshooting channel in the [https://discord.gg/moddingden Modding Den].
#* Context: when and how the thing happened. E.g. during the interturn after X’s turn, or clicking this button, whether it was mortal empires campaign or not, multiplayer, custom battle or campaign battle.
#* Mod list: if asked, link a collection or post a screenshot of the mod list (possibly not in George). For example, the big thing is not being naïve enough that the overhaul in your list can’t affect other mods. For some reason, sometimes it feels like pulling teeth to know what else is there. However, if your mod list is longer than, say, 40 items, don't expect people to miraculously figure out what's going on while just reading through 200 mod names.
#* Screenshot: always helps for clarity and visual context.
#* Save game: if requested, you can find your save game in (example) C:\Users\%USER%\AppData\Roaming\The Creative Assembly\Warhammer2\save_games. Remember the mod list, because the modder may not be able to load without it.
#* Results of your own troubleshooting: for example it’s good to know it happens with that one mod only. Relatedly, if you posted about an issue and later find the cause, let us know.
# '''"It doesn't crash so it works"'''. Don't assume your mod list is working just because it's not currently blowing up your computer or it didn't murder your cat. A crash is only the most visible of symptoms, it's like assuming a coal miner is perfectly fine just because they haven't dropped dead yet. You may have all kinds of issues in your 400-mods list ranging from fucked models to script breaks. Did I mention don't use 400 mods? Yeah nah, probably don't.

== APPENDIX: Trimming the Mod List ==
There is no such thing as a mod cap in WH3, which is another common trope. It’s up to you to keep your mod list functional, and '''the more mods you run the more likely you are to encounter issues, or just to see maintenance time increase for you'''. Making your mod list work is up to how careful you are. '''Remember, just because your list doesn’t produce an instant crash you can’t be sure there aren’t less visible issues''', e.g. script breaks.

As a rule of thumb, don’t be cocky with your list of 250 mods. It’s all fun and games until everything works perfectly (and with those numbers chances are it doesn’t already, you just can’t see it), at which point there’s a lot of stuff to check. Even if 300 out of 350 are reskins you would entrust with your house keys, it all adds to the volume of annoyance if something goes wrong. For example, maybe don't enable mods that affect stuff you will NEVER see as a player for a given campaign.

If you’re not experienced yet (and don’t assume you are just because you played Skyrim, this is different), use the mod list of someone that has very carefully been curating it, and check that it looks ok with the help of the modders themselves. For example, start by a modder’s own collection on Steam, they often have one.

=== Finding the culprit ===
The usual problem with large mod lists is this: bad, I got a crash; worse, which one of the N mods I have is the culprit?

==== Generic pointers: ====

* Pure Text, Variant and UI mods CAN cause CTD in Wh3, so don't cast them away from the candidate.
** Text: If it's a submod, it can be caused by missing an entry, or by using the wrong {tr:}
** UI: TWUI can cause CTD in various ways. Also, several of the UI mods use a script to show them as the users like
** Variant: Every VMD can cause CTD
* Momentarily sort by date on the MM to find the most recent updates, if you didn’t add additional mods those ''may'' (just may) be responsible.
* If you had the issue during a campaign, do not remove mods that have custom items, units or buildings because you’re just going to crash harder if those are around in the campaign map.
* Watch out for movie packs. These are packs with a specific setting that long story short used to be required for some things but it may cause them to automatically fire despite being disabled. In WH3, these are really only necessary (as of may '24) for new audio content. If you’re inexplicably crashing even with no mods on, you might have a movie pack with crashy data in it and the modder might need screaming at.

==== Bisect and Conquer: ====
[[File:Bisect wh3mm.jpg|thumb|Within PJ's WH3MM, within Other Options]]
Especially when dealing with big mod lists, the quickest method is to enable half of it. If you crash, that’s the troublesome half. Halve again to tighten the noose.

Keep in mind mod requirements while you do this.

If you want to check on a particular mod, disable everything and load the bare minimum to make that mod work, in other words mod+whatever required mods that comes with. And up from there, adding one or small groups of mods at a time until you can reproduce the issue.

It’s patient work but the modder will appreciate it, and it takes less than panicking for hours in a comment section. Assume that a modder won’t troubleshoot your mod list of 150 packs because you say it’s their mod doing it, unless they have proof because you tested without anything else plus requirements.

Remember: a happy modder is a happy user.

== APPENDIX: Scripts ==
Scripts are being increasingly used by mods. While most scripters are getting smarter by the day to maintain compatibility, some require a framework or some mods will just struggle to work when there are too many mods around.

You may encounter symptoms of broken scripts, due to botched downloads, bad compatibility or just plain unforeseen issues because we can just mess stuff up sometimes. Script glitches may end up being tricky to root out.

A few examples of broken scripts:

* Starting lords that should be custom are not custom, or don’t spawn, or don’t have the correct army or settlement. (in some cases, this is intentionally delayed to turn 2 for performance reasons)
* Sword of Khaine button is unchained right off.
* Chaos and all Rogue armies may spawn immediately.
* Campaign camera on a fresh campaign starts zoomed-out and doesn’t pan in.
* Chivalry starts at 0.
* One of the worst, characters do not gain XP (this may sometimes happen in full vanilla too, requires repair).

==== Scropt broken, what do? ====
Remember, it's always important to trim your mod list to determine the culprit/s. With scripts, there may be specific interactions that cause problems, such as trying to do thing A to thing B but another mod has already removed or changed B irreparably for that to work.

When/if you report the issue to modders, remember to provide as much info as humanly possible because finding a script break can turn ugly and complicated.

Particularly useful to help with scripting issues: please enable [https://steamcommunity.com/sharedfiles/filedetails/?id=1271877744 this debugger] (or enable the option in PJ's MM), reproduce the bug and send the resulting log, which will be a lenghty txt generated in ''Steam\steamapps\common\Total War WARHAMMER II''. Specific scripty mods may come with additional instructions in their mod descriptions/faqs.

Do not keep the script logger enabled past this necessity, since it will noticeably slow down your game.

One of the most frequent issues at the moment is a performance-related clog-up at the start of a campaign. This basically means that too many scripts are trying to fit into that time frame to do their stuff (legendary lords, changing armies, this kinda stuff) and results in some of them not working. This is where size of the mod list, in regards to any mod with a first-tick script, becomes serious.

== APPENDIX: [https://steamcommunity.com/sharedfiles/filedetails/?id=1354363596 Mod Configuration Tool] ==
This other framework is used to provide settings for compatible mods, i.e. to tweak some details at your heart’s content. Usually a good thing to keep it around because there’s quite a few mods supporting it, or that may do it in the future. For example, you may use it to configure some scripts to fire in a performance mode to reduce impact on campaign start.
== APPENDIX: WH3, crashing on clicking Skirmish ==
The most likely cause for this right now is that you saved a character (that new fancy function in WH3 to play campaign characters into skirmishes) but it was originated or affected by a mod that you have since then removed. Kaboom. The other symptom is going kaboom when trying to recruit any hero or lord in campaign.

Go in <code>C:\Users\user\AppData\Roaming\The Creative Assembly\Warhammer3\saved_characters</code> (or search %appdata% in windows search, then continue to those folders) and delete them.

== APPENDIX: the Powershell rummage ==
TBC

Functions without document

2024-07-09T10:29:28Z

Rhox: Added ones that was added in the official document

This page will include information about functions without a document, or the document has the wrong information.

== cm:add_unit_to_province_mercenary_pool ==
cm:add_unit_to_province_mercenary_pool(region_script_interface ''region'', string ''unit_key'', string ''recruitment_source'', number ''unit_count'', number ''replen_chance'', number ''max_units'', number ''max_replen_per_turn'', string ''faction_requirement'', string ''subculture_requirement'', string ''culture_requirement'', boolean ''use_partial_replen'', string ''merc_unit_group'')

This one is used to add province mercenaries, in the case of Wh3, they're used for undead's raise dead and Warrior of Chaos' Warband recruitment. The document has the wrong parameters for this function, and the vanilla does not use it, so make sure to check the correct parameters

== cm:is_agent_transformation_available ==
cm:is_agent_transformation_available(string ''agent_subtype_key'')

Returns true if your agent_subtype is in the DB campaign_to_agent_subtypes_tables with the given campaign. Especially useful if you want to check certain agent_subtype is unique. (Given that modders have added it to that table)

== cm:military_force_add_temporary_stance ==
cm:military_force_add_temporary_stance(number ''mf_cqi'',string ''stance'', number ''turn'')

Can be used to give a certain stance to a military force for a time even if that faction does not have access to the stance via campaign_stances_factions_junctions_tables. If 0 is given to turn, it will be infinite.

== cm:faction_set_total_potential_override_value ==
cm:faction_set_total_potential_override_value(FACTION_SCRIPT_INTERFACE faction, bool use_override_value, int32 total_potential_override_value) – bypasses the faction potential calculation and sets a fixed value

ex: cm:faction_set_total_potential_override_value(cm:get_faction("wh3_main_dae_daemon_prince"), true, 500) This will forcibly set the Daemon Prince's faction potential to 500

== cm:faction_set_potential_modifier ==
cm:faction_set_potential_modifier(FACTION_SCRIPT_INTERFACE faction, int32 faction_potential_modifier) – Calculates the faction potential as normal, then modifies it by an additional amount

ex: cm:faction_set_potential_modifier(cm:get_faction("wh3_main_dae_daemon_prince"), -100) This will calculate the Daemon Prince's faction potential as normal (probably 200), and then subtract 100 from it to reach 100 total.

== cm:set_plague_component_state ==
cm:set_plague_component_state(faction_script_interface ''faction'', string ''component'', string ''state'', boolean set_to_blessed)

Used to handle ToD's new plague system. While they're not in the document, vanilla uses it, so check there.

== FactionDeath ==
While not function, and is in the document, I'll include it here since Chadvandy does not have it yet.

This listener listens for the faction death and supports these in the contexts

- killer(): Faction that killed this faction

- faction(): Faction that died

- is_game_over(): Is the game over

== try_get_agent_plague_components() ==
Also not a function and is callable from CHARACTER_SCRIPT_INTERFACE. Mostly used for plague checking
[[Category:Script]]

Functions without document

2024-07-09T10:21:25Z

Rhox: another function error

This page will include information about functions without a document, or the document has the wrong information.

== cm:add_unit_to_province_mercenary_pool ==
cm:add_unit_to_province_mercenary_pool(region_script_interface ''region'', string ''unit_key'', string ''recruitment_source'', number ''unit_count'', number ''replen_chance'', number ''max_units'', number ''max_replen_per_turn'', string ''faction_requirement'', string ''subculture_requirement'', string ''culture_requirement'', boolean ''use_partial_replen'', string ''merc_unit_group'')

This one is used to add province mercenaries, in the case of Wh3, they're used for undead's raise dead and Warrior of Chaos' Warband recruitment. The document has the wrong parameters for this function, and the vanilla does not use it, so make sure to check the correct parameters

== cm:instantly_research_technology ==
cm:instantly_research_technology(${1:string faction key}, ${2:string technology key}, ${3:boolean notify event feed})

Instantly completes research for the specified technology for the specified faction

== cm:instantly_research_all_technologies ==
cm:instantly_research_all_technologies(${1:string faction key})

Instantly completes research on all technologies for the specified faction

== cm:instantly_clear_all_technologies ==
cm:instantly_clear_all_technologies(${1:string faction key})

Instantly resets all technologies for the specified faction to an unresearched state.

== cm:pending_battle_cache_get_attacker_embedded_character_subtypes & cm:pending_battle_cache_get_defender_embedded_character_subtypes ==
cm:pending_battle_cache_get_defender_embedded_character_subtypes(number ''index_of_defender'')

Returns table ''embedded_character_subtypes''

Similar to cm:pending_battle_cache_get_defender_subtype(), but you can get embedding heroes subtypes also.

== cm:is_agent_transformation_available ==
cm:is_agent_transformation_available(string ''agent_subtype_key'')

Returns true if your agent_subtype is in the DB campaign_to_agent_subtypes_tables with the given campaign. Especially useful if you want to check certain agent_subtype is unique. (Given that modders have added it to that table)

== cm:military_force_add_temporary_stance ==
cm:military_force_add_temporary_stance(number ''mf_cqi'',string ''stance'', number ''turn'')

Can be used to give a certain stance to a military force for a time even if that faction does not have access to the stance via campaign_stances_factions_junctions_tables. If 0 is given to turn, it will be infinite.

== cm:faction_set_total_potential_override_value ==
cm:faction_set_total_potential_override_value(FACTION_SCRIPT_INTERFACE faction, bool use_override_value, int32 total_potential_override_value) – bypasses the faction potential calculation and sets a fixed value

ex: cm:faction_set_total_potential_override_value(cm:get_faction("wh3_main_dae_daemon_prince"), true, 500) This will forcibly set the Daemon Prince's faction potential to 500

== cm:faction_set_potential_modifier ==
cm:faction_set_potential_modifier(FACTION_SCRIPT_INTERFACE faction, int32 faction_potential_modifier) – Calculates the faction potential as normal, then modifies it by an additional amount

ex: cm:faction_set_potential_modifier(cm:get_faction("wh3_main_dae_daemon_prince"), -100) This will calculate the Daemon Prince's faction potential as normal (probably 200), and then subtract 100 from it to reach 100 total.

== cm:set_plague_component_state ==
cm:set_plague_component_state(faction_script_interface ''faction'', string ''component'', string ''state'', boolean set_to_blessed)

Used to handle ToD's new plague system. While they're not in the document, vanilla uses it, so check there.

== FactionDeath ==
While not function, and is in the document, I'll include it here since Chadvandy does not have it yet.

This listener listens for the faction death and supports these in the contexts

- killer(): Faction that killed this faction

- faction(): Faction that died

- is_game_over(): Is the game over

== try_get_agent_plague_components() ==
Also not a function and is callable from CHARACTER_SCRIPT_INTERFACE. Mostly used for plague checking
[[Category:Script]]

Functions without document

2024-07-07T04:45:43Z

Rhox: plague thing

This page will include information about functions without a document, or the document has the wrong information.

== cm:add_unit_to_province_mercenary_pool ==
cm:add_unit_to_province_mercenary_pool(faction_script_interface ''faction'', string ''unit_key'', string ''recruitment_source'', number ''unit_count'', number ''replen_chance'', number ''max_units'', number ''max_replen_per_turn'', string ''faction_requirement'', string ''subculture_requirement'', string ''culture_requirement'', boolean ''use_partial_replen'', string ''merc_unit_group'')

This one is used to add province mercenaries, in the case of Wh3, they're used for undead's raise dead and Warrior of Chaos' Warband recruitment. The document has the wrong parameters for this function, and the vanilla does not use it, so make sure to check the correct parameters

== cm:instantly_research_technology ==
cm:instantly_research_technology(${1:string faction key}, ${2:string technology key}, ${3:boolean notify event feed})

Instantly completes research for the specified technology for the specified faction

== cm:instantly_research_all_technologies ==
cm:instantly_research_all_technologies(${1:string faction key})

Instantly completes research on all technologies for the specified faction

== cm:instantly_clear_all_technologies ==
cm:instantly_clear_all_technologies(${1:string faction key})

Instantly resets all technologies for the specified faction to an unresearched state.

== cm:pending_battle_cache_get_attacker_embedded_character_subtypes & cm:pending_battle_cache_get_defender_embedded_character_subtypes ==
cm:pending_battle_cache_get_defender_embedded_character_subtypes(number ''index_of_defender'')

Returns table ''embedded_character_subtypes''

Similar to cm:pending_battle_cache_get_defender_subtype(), but you can get embedding heroes subtypes also.

== cm:is_agent_transformation_available ==
cm:is_agent_transformation_available(string ''agent_subtype_key'')

Returns true if your agent_subtype is in the DB campaign_to_agent_subtypes_tables with the given campaign. Especially useful if you want to check certain agent_subtype is unique. (Given that modders have added it to that table)

== cm:military_force_add_temporary_stance ==
cm:military_force_add_temporary_stance(number ''mf_cqi'',string ''stance'', number ''turn'')

Can be used to give a certain stance to a military force for a time even if that faction does not have access to the stance via campaign_stances_factions_junctions_tables. If 0 is given to turn, it will be infinite.

== cm:faction_set_total_potential_override_value ==
cm:faction_set_total_potential_override_value(FACTION_SCRIPT_INTERFACE faction, bool use_override_value, int32 total_potential_override_value) – bypasses the faction potential calculation and sets a fixed value

ex: cm:faction_set_total_potential_override_value(cm:get_faction("wh3_main_dae_daemon_prince"), true, 500) This will forcibly set the Daemon Prince's faction potential to 500

== cm:faction_set_potential_modifier ==
cm:faction_set_potential_modifier(FACTION_SCRIPT_INTERFACE faction, int32 faction_potential_modifier) – Calculates the faction potential as normal, then modifies it by an additional amount

ex: cm:faction_set_potential_modifier(cm:get_faction("wh3_main_dae_daemon_prince"), -100) This will calculate the Daemon Prince's faction potential as normal (probably 200), and then subtract 100 from it to reach 100 total.

== cm:set_plague_component_state ==
cm:set_plague_component_state(faction_script_interface ''faction'', string ''component'', string ''state'', boolean set_to_blessed)

Used to handle ToD's new plague system. While they're not in the document, vanilla uses it, so check there.

== FactionDeath ==
While not function, and is in the document, I'll include it here since Chadvandy does not have it yet.

This listener listens for the faction death and supports these in the contexts

- killer(): Faction that killed this faction

- faction(): Faction that died

- is_game_over(): Is the game over

== try_get_agent_plague_components() ==
Also not a function and is callable from CHARACTER_SCRIPT_INTERFACE. Mostly used for plague checking
[[Category:Script]]

Functions without document

2024-07-07T03:47:26Z

Rhox: plague

This page will include information about functions without a document, or the document has the wrong information.

== cm:add_unit_to_province_mercenary_pool ==
cm:add_unit_to_province_mercenary_pool(faction_script_interface ''faction'', string ''unit_key'', string ''recruitment_source'', number ''unit_count'', number ''replen_chance'', number ''max_units'', number ''max_replen_per_turn'', string ''faction_requirement'', string ''subculture_requirement'', string ''culture_requirement'', boolean ''use_partial_replen'', string ''merc_unit_group'')

This one is used to add province mercenaries, in the case of Wh3, they're used for undead's raise dead and Warrior of Chaos' Warband recruitment. The document has the wrong parameters for this function, and the vanilla does not use it, so make sure to check the correct parameters

== cm:instantly_research_technology ==
cm:instantly_research_technology(${1:string faction key}, ${2:string technology key}, ${3:boolean notify event feed})

Instantly completes research for the specified technology for the specified faction

== cm:instantly_research_all_technologies ==
cm:instantly_research_all_technologies(${1:string faction key})

Instantly completes research on all technologies for the specified faction

== cm:instantly_clear_all_technologies ==
cm:instantly_clear_all_technologies(${1:string faction key})

Instantly resets all technologies for the specified faction to an unresearched state.

== cm:pending_battle_cache_get_attacker_embedded_character_subtypes & cm:pending_battle_cache_get_defender_embedded_character_subtypes ==
cm:pending_battle_cache_get_defender_embedded_character_subtypes(number ''index_of_defender'')

Returns table ''embedded_character_subtypes''

Similar to cm:pending_battle_cache_get_defender_subtype(), but you can get embedding heroes subtypes also.

== cm:is_agent_transformation_available ==
cm:is_agent_transformation_available(string ''agent_subtype_key'')

Returns true if your agent_subtype is in the DB campaign_to_agent_subtypes_tables with the given campaign. Especially useful if you want to check certain agent_subtype is unique. (Given that modders have added it to that table)

== cm:military_force_add_temporary_stance ==
cm:military_force_add_temporary_stance(number ''mf_cqi'',string ''stance'', number ''turn'')

Can be used to give a certain stance to a military force for a time even if that faction does not have access to the stance via campaign_stances_factions_junctions_tables. If 0 is given to turn, it will be infinite.

== cm:faction_set_total_potential_override_value ==
cm:faction_set_total_potential_override_value(FACTION_SCRIPT_INTERFACE faction, bool use_override_value, int32 total_potential_override_value) – bypasses the faction potential calculation and sets a fixed value

ex: cm:faction_set_total_potential_override_value(cm:get_faction("wh3_main_dae_daemon_prince"), true, 500) This will forcibly set the Daemon Prince's faction potential to 500

== cm:faction_set_potential_modifier ==
cm:faction_set_potential_modifier(FACTION_SCRIPT_INTERFACE faction, int32 faction_potential_modifier) – Calculates the faction potential as normal, then modifies it by an additional amount

ex: cm:faction_set_potential_modifier(cm:get_faction("wh3_main_dae_daemon_prince"), -100) This will calculate the Daemon Prince's faction potential as normal (probably 200), and then subtract 100 from it to reach 100 total.

== cm:set_plague_component_state ==
cm:set_plague_component_state(faction_script_interface ''faction'', string ''component'', string ''state'', boolean set_to_blessed)

Used to handle ToD's new plague system. While they're not in the document, vanilla uses it, so check there.

== FactionDeath ==
While not function, and is in the document, I'll include it here since Chadvandy does not have it yet.

This listener listens for the faction death and supports these in the contexts

- killer(): Faction that killed this faction

- faction(): Faction that died

- is_game_over(): Is the game over
[[Category:Script]]

Functions without document

2024-07-07T03:40:09Z

Rhox: I said faction instead of province. Yeah I'm stupid

This page will include information about functions without a document, or the document has the wrong information.

== cm:add_unit_to_province_mercenary_pool ==
cm:add_unit_to_province_mercenary_pool(faction_script_interface ''faction'', string ''unit_key'', string ''recruitment_source'', number ''unit_count'', number ''replen_chance'', number ''max_units'', number ''max_replen_per_turn'', string ''faction_requirement'', string ''subculture_requirement'', string ''culture_requirement'', boolean ''use_partial_replen'', string ''merc_unit_group'')

This one is used to add province mercenaries, in the case of Wh3, they're used for undead's raise dead and Warrior of Chaos' Warband recruitment. The document has the wrong parameters for this function, and the vanilla does not use it, so make sure to check the correct parameters

== cm:instantly_research_technology ==
cm:instantly_research_technology(${1:string faction key}, ${2:string technology key}, ${3:boolean notify event feed})

Instantly completes research for the specified technology for the specified faction

== cm:instantly_research_all_technologies ==
cm:instantly_research_all_technologies(${1:string faction key})

Instantly completes research on all technologies for the specified faction

== cm:instantly_clear_all_technologies ==
cm:instantly_clear_all_technologies(${1:string faction key})

Instantly resets all technologies for the specified faction to an unresearched state.

== cm:pending_battle_cache_get_attacker_embedded_character_subtypes & cm:pending_battle_cache_get_defender_embedded_character_subtypes ==
cm:pending_battle_cache_get_defender_embedded_character_subtypes(number ''index_of_defender'')

Returns table ''embedded_character_subtypes''

Similar to cm:pending_battle_cache_get_defender_subtype(), but you can get embedding heroes subtypes also.

== cm:is_agent_transformation_available ==
cm:is_agent_transformation_available(string ''agent_subtype_key'')

Returns true if your agent_subtype is in the DB campaign_to_agent_subtypes_tables with the given campaign. Especially useful if you want to check certain agent_subtype is unique. (Given that modders have added it to that table)

== cm:military_force_add_temporary_stance ==
cm:military_force_add_temporary_stance(number ''mf_cqi'',string ''stance'', number ''turn'')

Can be used to give a certain stance to a military force for a time even if that faction does not have access to the stance via campaign_stances_factions_junctions_tables. If 0 is given to turn, it will be infinite.

== cm:faction_set_total_potential_override_value ==
cm:faction_set_total_potential_override_value(FACTION_SCRIPT_INTERFACE faction, bool use_override_value, int32 total_potential_override_value) – bypasses the faction potential calculation and sets a fixed value

ex: cm:faction_set_total_potential_override_value(cm:get_faction("wh3_main_dae_daemon_prince"), true, 500) This will forcibly set the Daemon Prince's faction potential to 500

== cm:faction_set_potential_modifier ==
cm:faction_set_potential_modifier(FACTION_SCRIPT_INTERFACE faction, int32 faction_potential_modifier) – Calculates the faction potential as normal, then modifies it by an additional amount

ex: cm:faction_set_potential_modifier(cm:get_faction("wh3_main_dae_daemon_prince"), -100) This will calculate the Daemon Prince's faction potential as normal (probably 200), and then subtract 100 from it to reach 100 total.

== cm:set_plague_component_state ==
cm:set_plague_component_state(faction_script_interface ''faction'', string ''component'', string ''state'', boolean ?)

Used to handle ToD's new plague system. While they're not in the document, vanilla uses it, so check there.

== FactionDeath ==
While not function, and is in the document, I'll include it here since Chadvandy does not have it yet.

This listener listens for the faction death and supports these in the contexts

- killer(): Faction that killed this faction

- faction(): Faction that died

- is_game_over(): Is the game over
[[Category:Script]]

Building units allowed tables

2024-07-06T09:34:27Z

Rhox:

[[File:Enabled.png|thumb|This mod disables recruitment of wh_dlc07_brt_inf_spearmen_at_arms_1 from barracks only for wh_main_brt_bordeleaux while other Bretonnia factions can still recruit them]]
The "Enabled" column is somewhat misleading, but it does its work. But only in limited situation

* There must be the same building-unit entry in another mod or vanilla. If it doesn't, the "enabled" column doesn't do anything and it always enables unit recruitment.
* The faction column must be filled in.
* Finally, the "enabled" column needs to be unticked

In this situation, this enabled unticked row will disable vanilla or other mod's building recruitment for the faction you've filled in the row. If you filled in the wh_main_brt_bordeleaux for the faction column, and if you filled in all the other columns correctly, then all the other Bretonnia has access to this building unit recruitment while wh_main_brt_bordeleaux does not.
[[Category:DB Table]]

File:Enabled.png

2024-07-06T09:33:21Z

Rhox:

This disables recruitment

Building units allowed tables

2024-07-06T09:24:36Z

Rhox: Enabled column

The "Enabled" column is somewhat misleading, but it does its work. But only in limited situation

* There must be the same building-unit entry in another mod or vanilla. If it doesn't, the "enabled" column doesn't do anything and it always enables unit recruitment.
* The faction column must be filled in.
* Finally, the "enabled" column needs to be unticked

In this situation, this enabled unticked row will disable vanilla or other mod's building recruitment for the faction you've filled in the row. If you filled in the wh_main_brt_bordeleaux for the faction column, and if you filled in all the other columns correctly, then all the other Bretonnia has access to this building unit recruitment while wh_main_brt_bordeleaux does not.
[[Category:DB Table]]

Startpos

2024-06-23T07:54:43Z

Rhox:

(Disclaimer: Some of the opinions are solitary of Rhox's and might not align with the community's)

Startpos is turn 0 save of the campaign. The key point is, that '''there can be only one startpos'''. Thus, appending or removing via another mod isn't possible. That's why most of the users use only one startpos mod, Mixer. Technically, IEE and TOW are also startpos mods. But they're made to have each entry the same as Mixer and Chaos Robie's stuff are appended manually.

Due to this characteristic,
Modders have made several works around for many startpos-only features, some parts are still startpos bound and need Mixer's work though.

=== Startpos things that can't be replicated ===

* Cultures available agent_types: Mixer has added every possible case for every known culture and Mixer added culture. This would also mean the culture you added won't work due to this. Even if your faction does not have heroes, there is also the tech issue.
* Slot types used for Landmarks: Same as above, Mixu makes slots for each region.
* Potential for each faction: Same.
* Factions: Both playable and spawnable need startpos work. Making it playable requires more work than just spawnable ones. Use the Mixer faction requests thread if you need them. Every playable entry increases the loading time so my advice is to practice with any mixer faction in it, then request when the work is complete. Also, Mixu prefers batch work rather than getting small requests multiple times
* Diplomacy: For non-aggression and military access only. Others can be replicated via scripts.
** '''<code>cm:force_grant_military_access</code>''' has some serious quirks and military access given by this can't be canceled in the UI
* Regions held by a faction in the faction selection window: It needs startpos work but it's minor so I would say just ignore it
* Faction leader CQI: If you need your leader to have a certain CQI, you need startpos. You don't normally need it unless you're going to make a quest battle for the leader. However, you can use a script to fool the users. Check Wh2 OvN's Halfing scripts

=== Startpos things that the script can theoretically replace but no one has done it yet ===

* Offices: Because it's just an effect bundle given to a character and not so exciting for many of the makers. If you happen to make one, consider sending it to Mixu
* Horde marker in the diplomacy panel: It's related to the feature forest, and the script below does not change this. Theoretically, you can change it with the script to change the icon and tooltip. (But I haven't tried)

=== Startpos things that can be replaced with script and DB way ===

* Faction RoR (mercenaries): Setup mercenary DB and call '''<code>cm:add_unit_to_faction_mercenary_pool()</code>'''function at first tick callback new
* Province mercenaries (raise dead and warbands): Similar but the function in the document is wrong so check other mods that use this function
* Settings like starting region, leader, items, units, buildings, and such: Check other faction mods, Most of the things can be replicated with the script.
** Faction starting position pin: Use frontend_faction_leaders_tables and alter the 'Override Force Location X & Y' column.
* Tech node Set: While the tech node set is startpos, you can use some workaround. Do note that all the methods below need script work to lock all the vanilla techs you want to remove access from your faction. Otherwise, AI can research it plus will create research available alarm to the player when they have researched all available techs shown in the UI
** Overriding some of the nodes with faction-specific nodes: Use the faction column in the node tables to override the vanilla one. Even CA uses this method for some of the factions. But it can only do overrides and the tech tree's shape needs to cover all the vanilla tech nodes.
** Sending all existing techs to a place where users can't see: While you might not know it, every tech node set can have only one tech key. This means if you make a new faction-specific tech node that has a vanilla tech key, that faction will not have access to the vanilla tech node and will have access to the node the user has made. If you send all the vanilla nodes to a place with this method to a place where users can't see them, now you can create a new tech node set of your own. Check out OvN Dread King if you need an example. Note that it doesn't work for center-starting tech node sets like Chaos Warriors
** Make a new tech tab and hide the previous one: Need some script work but also works. Do note that it can cause problems if another mod adds a tab of its own, but you can create compatibility if you want to.
* Feature Forest: You don't normally use it, but if you're making a full horde faction (factions that can't occupy settlements) into a normal faction, or turning a full horde faction into a normal faction, but you can use other ways.
** You can use the cm:add_or_remove_faction_features() function in the script to remove or add features from a certain faction
** You can add more into feature into feature_set_to_faction_features_tables if you want to change accessible features of all the factions of that feature forest
* Norsca vassal thing, and empire giving region thing (start_pos_entity_association_faction_regions_tables): Depends on what you're using it for, but since it's used in occupation options, you can use a script to hide certain things when the conditions don't match

Startpos

2024-06-23T07:29:20Z

Rhox: feature forest

(Disclaimer: Some of the opinions are solitary of Rhox's and might not align with the community's)

Startpos is turn 0 save of the campaign. The key point is, that '''there can be only one startpos'''. Thus, appending or removing via another mod isn't possible. That's why most of the users use only one startpos mod, Mixer. Technically, IEE and TOW are also startpos mods. But they're made to have each entry the same as Mixer and Chaos Robie's stuff are appended manually.

Due to this characteristic,
Modders have made several works around for many startpos-only features, some parts are still startpos bound and need Mixer's work though.

=== Startpos things that can't be replicated ===

* Cultures available agent_types: Mixer has added every possible case for every known culture and Mixer added culture. This would also mean the culture you added won't work due to this. Even if your faction does not have heroes, there is also the tech issue.
* Slot types used for Landmarks: Same as above, Mixu makes slots for each region.
* Potential for each faction: Same.
* Factions: Both playable and spawnable need startpos work. Making it playable requires more work than just spawnable ones. Use the Mixer faction requests thread if you need them. Every playable entry increases the loading time so my advice is to practice with any mixer faction in it, then request when the work is complete. Also, Mixu prefers batch work rather than getting small requests multiple times
* Diplomacy: For non-aggression and military access only. Others can be replicated via scripts.
** '''<code>cm:force_grant_military_access</code>''' has some serious quirks and military access given by this can't be canceled in the UI
* Regions held by a faction in the faction selection window: It needs startpos work but it's minor so I would say just ignore it
* Faction leader CQI: If you need your leader to have a certain CQI, you need startpos. You don't normally need it unless you're going to make a quest battle for the leader. However, you can use a script to fool the users. Check Wh2 OvN's Halfing scripts

=== Startpos things that the script can theoretically replace but no one has done it yet ===

* Offices: Because it's just an effect bundle given to a character and not so exciting for many of the makers. If you happen to make one, consider sending it to Mixu

=== Startpos things that can be replaced with script and DB way ===

* Faction RoR (mercenaries): Setup mercenary DB and call '''<code>cm:add_unit_to_faction_mercenary_pool()</code>'''function at first tick callback new
* Province mercenaries (raise dead and warbands): Similar but the function in the document is wrong so check other mods that use this function
* Settings like starting region, leader, items, units, buildings, and such: Check other faction mods, Most of the things can be replicated with the script.
** Faction starting position pin: Use frontend_faction_leaders_tables and alter the 'Override Force Location X & Y' column.
* Tech node Set: While the tech node set is startpos, you can use some workaround. Do note that all the methods below need script work to lock all the vanilla techs you want to remove access from your faction. Otherwise, AI can research it plus will create research available alarm to the player when they have researched all available techs shown in the UI
** Overriding some of the nodes with faction-specific nodes: Use the faction column in the node tables to override the vanilla one. Even CA uses this method for some of the factions. But it can only do overrides and the tech tree's shape needs to cover all the vanilla tech nodes.
** Sending all existing techs to a place where users can't see: While you might not know it, every tech node set can have only one tech key. This means if you make a new faction-specific tech node that has a vanilla tech key, that faction will not have access to the vanilla tech node and will have access to the node the user has made. If you send all the vanilla nodes to a place with this method to a place where users can't see them, now you can create a new tech node set of your own. Check out OvN Dread King if you need an example. Note that it doesn't work for center-starting tech node sets like Chaos Warriors
** Make a new tech tab and hide the previous one: Need some script work but also works. Do note that it can cause problems if another mod adds a tab of its own, but you can create compatibility if you want to.
* Feature Forest: You don't normally use it, but if you're making a full horde faction (factions that can't occupy settlements) into a normal faction, or turning a full horde faction into a normal faction, but you can use other ways.
** You can use the cm:add_or_remove_faction_features() function in the script to remove or add features from a certain faction
** You can add more into feature into feature_set_to_faction_features_tables if you want to change accessible features of all the factions of that feature forest
* Norsca vassal thing, and empire giving region thing (start_pos_entity_association_faction_regions_tables): Depends on what you're using it for, but since it's used in occupation options, you can use a script to hide certain things when the conditions don't match

Startpos

2024-06-23T07:12:26Z

Rhox: feature forest

(Disclaimer: Some of the opinions are solitary of Rhox's and might not align with the community's)

Startpos is turn 0 save of the campaign. The key point is, that '''there can be only one startpos'''. Thus, appending or removing via another mod isn't possible. That's why most of the users use only one startpos mod, Mixer. Technically, IEE and TOW are also startpos mods. But they're made to have each entry the same as Mixer and Chaos Robie's stuff are appended manually.

Due to this characteristic,
Modders have made several works around for many startpos-only features, some parts are still startpos bound and need Mixer's work though.

=== Startpos things that can't be replicated ===

* Cultures available agent_types: Mixer has added every possible case for every known culture and Mixer added culture. This would also mean the culture you added won't work due to this. Even if your faction does not have heroes, there is also the tech issue.
* Slot types used for Landmarks: Same as above, Mixu makes slots for each region.
* Potential for each faction: Same.
* Factions: Both playable and spawnable need startpos work. Making it playable requires more work than just spawnable ones. Use the Mixer faction requests thread if you need them. Every playable entry increases the loading time so my advice is to practice with any mixer faction in it, then request when the work is complete. Also, Mixu prefers batch work rather than getting small requests multiple times.
* Feature Forest: You don't normally use it, but if you're making a full horde faction (factions that can't occupy settlements) into a normal faction, or turning a full horde faction into a normal faction, but you can use other ways.
** You can add more into feature into feature_set_to_faction_features_tables, and while this is not startpos it will affect every other faction that has this feature forest, so be careful when you use it
** You can also use the cm:add_or_remove_faction_features() function in the script to remove or add features
* Diplomacy: For non-aggression and military access only. Others can be replicated via scripts.
** '''<code>cm:force_grant_military_access</code>''' has some serious quirks and military access given by this can't be canceled in the UI
* Regions held by a faction in the faction selection window: It needs startpos work but it's minor so I would say just ignore it
* Faction leader CQI: If you need your leader to have a certain CQI, you need startpos. You don't normally need it unless you're going to make a quest battle for the leader. However, you can use a script to fool the users. Check Wh2 OvN's Halfing scripts

=== Startpos things that the script can theoretically replace but no one has done it yet ===

* Offices: Because it's just an effect bundle given to a character and not so exciting for many of the makers. If you happen to make one, consider sending it to Mixu

=== Startpos things that can be replaced with script and DB way ===

* Faction RoR (mercenaries): Setup mercenary DB and call '''<code>cm:add_unit_to_faction_mercenary_pool()</code>'''function at first tick callback new
* Province mercenaries (raise dead and warbands): Similar but the function in the document is wrong so check other mods that use this function
* Settings like starting region, leader, items, units, buildings, and such: Check other faction mods, Most of the things can be replicated with the script.
** Faction starting position pin: Use frontend_faction_leaders_tables and alter the 'Override Force Location X & Y' column.
* Tech node Set: While the tech node set is startpos, you can use some workaround. Do note that all the methods below need script work to lock all the vanilla techs you want to remove access from your faction. Otherwise, AI can research it plus will create research available alarm to the player when they have researched all available techs shown in the UI
** Overriding some of the nodes with faction-specific nodes: Use the faction column in the node tables to override the vanilla one. Even CA uses this method for some of the factions. But it can only do overrides and the tech tree's shape needs to cover all the vanilla tech nodes.
** Sending all existing techs to a place where users can't see: While you might not know it, every tech node set can have only one tech key. This means if you make a new faction-specific tech node that has a vanilla tech key, that faction will not have access to the vanilla tech node and will have access to the node the user has made. If you send all the vanilla nodes to a place with this method to a place where users can't see them, now you can create a new tech node set of your own. Check out OvN Dread King if you need an example. Note that it doesn't work for center-starting tech node sets like Chaos Warriors
** Make a new tech tab and hide the previous one: Need some script work but also works. Do note that it can cause problems if another mod adds a tab of its own, but you can create compatibility if you want to.
* Norsca vassal thing, and empire giving region thing (start_pos_entity_association_faction_regions_tables): Depends on what you're using it for, but since it's used in occupation options, you can use a script to hide certain things when the conditions don't match

Functions without document

2024-06-10T18:45:00Z

Rhox: faction potential

This page will include information about functions without a document, or the document has the wrong information.

== cm:add_unit_to_faction_mercenary_pool ==
cm:add_unit_to_faction_mercenary_pool(faction_script_interface ''faction'', string ''unit_key'', string ''recruitment_source'', number ''unit_count'', number ''replen_chance'', number ''max_units'', number ''max_replen_per_turn'', string ''faction_requirement'', string ''subculture_requirement'', string ''culture_requirement'', boolean ''use_partial_replen'', string ''merc_unit_group'')

This one is used to add province mercenaries, in the case of Wh3, they're used for undead's raise dead and Warrior of Chaos' Warband recruitment. The document has the wrong parameters for this function, and the vanilla does not use it, so make sure to check the correct parameters

== cm:instantly_research_technology ==
cm:instantly_research_technology(${1:string faction key}, ${2:string technology key}, ${3:boolean notify event feed})

Instantly completes research for the specified technology for the specified faction

== cm:instantly_research_all_technologies ==
cm:instantly_research_all_technologies(${1:string faction key})

Instantly completes research on all technologies for the specified faction

== cm:instantly_clear_all_technologies ==
cm:instantly_clear_all_technologies(${1:string faction key})

Instantly resets all technologies for the specified faction to an unresearched state.

== cm:pending_battle_cache_get_attacker_embedded_character_subtypes & cm:pending_battle_cache_get_defender_embedded_character_subtypes ==
cm:pending_battle_cache_get_defender_embedded_character_subtypes(number ''index_of_defender'')

Returns table ''embedded_character_subtypes''

Similar to cm:pending_battle_cache_get_defender_subtype(), but you can get embedding heroes subtypes also.

== cm:is_agent_transformation_available ==
cm:is_agent_transformation_available(string ''agent_subtype_key'')

Returns true if your agent_subtype is in the DB campaign_to_agent_subtypes_tables with the given campaign. Especially useful if you want to check certain agent_subtype is unique. (Given that modders have added it to that table)

== cm:military_force_add_temporary_stance ==
cm:military_force_add_temporary_stance(number ''mf_cqi'',string ''stance'', number ''turn'')

Can be used to give a certain stance to a military force for a time even if that faction does not have access to the stance via campaign_stances_factions_junctions_tables. If 0 is given to turn, it will be infinite.

== cm:faction_set_total_potential_override_value ==
cm:faction_set_total_potential_override_value(FACTION_SCRIPT_INTERFACE faction, bool use_override_value, int32 total_potential_override_value) – bypasses the faction potential calculation and sets a fixed value

ex: cm:faction_set_total_potential_override_value(cm:get_faction("wh3_main_dae_daemon_prince"), true, 500) This will forcibly set the Daemon Prince's faction potential to 500

== cm:faction_set_potential_modifier ==
cm:faction_set_potential_modifier(FACTION_SCRIPT_INTERFACE faction, int32 faction_potential_modifier) – Calculates the faction potential as normal, then modifies it by an additional amount

ex: cm:faction_set_potential_modifier(cm:get_faction("wh3_main_dae_daemon_prince"), -100) This will calculate the Daemon Prince's faction potential as normal (probably 200), and then subtract 100 from it to reach 100 total.

== cm:set_plague_component_state ==
cm:set_plague_component_state(faction_script_interface ''faction'', string ''component'', string ''state'', boolean ?)

Used to handle ToD's new plague system. While they're not in the document, vanilla uses it, so check there.

== FactionDeath ==
While not function, and is in the document, I'll include it here since Chadvandy does not have it yet.

This listener listens for the faction death and supports these in the contexts

- killer(): Faction that killed this faction

- faction(): Faction that died

- is_game_over(): Is the game over
[[Category:Script]]

Functions without document

2024-06-05T10:50:33Z

Rhox:

This page will include information about functions without a document, or the document has the wrong information.

== cm:add_unit_to_faction_mercenary_pool ==
cm:add_unit_to_faction_mercenary_pool(faction_script_interface ''faction'', string ''unit_key'', string ''recruitment_source'', number ''unit_count'', number ''replen_chance'', number ''max_units'', number ''max_replen_per_turn'', string ''faction_requirement'', string ''subculture_requirement'', string ''culture_requirement'', boolean ''use_partial_replen'', string ''merc_unit_group'')

This one is used to add province mercenaries, in the case of Wh3, they're used for undead's raise dead and Warrior of Chaos' Warband recruitment. The document has the wrong parameters for this function, and the vanilla does not use it, so make sure to check the correct parameters

== cm:instantly_research_technology ==
cm:instantly_research_technology(${1:string faction key}, ${2:string technology key}, ${3:boolean notify event feed})

Instantly completes research for the specified technology for the specified faction

== cm:instantly_research_all_technologies ==
cm:instantly_research_all_technologies(${1:string faction key})

Instantly completes research on all technologies for the specified faction

== cm:instantly_clear_all_technologies ==
cm:instantly_clear_all_technologies(${1:string faction key})

Instantly resets all technologies for the specified faction to an unresearched state.

== cm:pending_battle_cache_get_attacker_embedded_character_subtypes & cm:pending_battle_cache_get_defender_embedded_character_subtypes ==
cm:pending_battle_cache_get_defender_embedded_character_subtypes(number ''index_of_defender'')

Returns table ''embedded_character_subtypes''

Similar to cm:pending_battle_cache_get_defender_subtype(), but you can get embedding heroes subtypes also.

== cm:is_agent_transformation_available ==
cm:is_agent_transformation_available(string ''agent_subtype_key'')

Returns true if your agent_subtype is in the DB campaign_to_agent_subtypes_tables with the given campaign. Especially useful if you want to check certain agent_subtype is unique. (Given that modders have added it to that table)

== cm:military_force_add_temporary_stance ==
cm:military_force_add_temporary_stance(number ''mf_cqi'',string ''stance'', number ''turn'')

Can be used to give a certain stance to a military force for a time even if that faction does not have access to the stance via campaign_stances_factions_junctions_tables. If 0 is given to turn, it will be infinite.

== cm:set_plague_component_state ==
cm:set_plague_component_state(faction_script_interface ''faction'', string ''component'', string ''state'', boolean ?)

Used to handle ToD's new plague system. While they're not in the document, vanilla uses it, so check there.

== FactionDeath ==
While not function, and is in the document, I'll include it here since Chadvandy does not have it yet.

This listener listens for the faction death and supports these in the contexts

- killer(): Faction that killed this faction

- faction(): Faction that died

- is_game_over(): Is the game over
[[Category:Script]]

Functions without document

2024-06-05T07:34:34Z

Rhox: additions

This page will include information about functions without a document, or the document has the wrong information.

== cm:add_unit_to_faction_mercenary_pool ==
cm:add_unit_to_faction_mercenary_pool(faction_script_interface ''faction'', string ''unit_key'', string ''recruitment_source'', number ''unit_count'', number ''replen_chance'', number ''max_units'', number ''max_replen_per_turn'', string ''faction_requirement'', string ''subculture_requirement'', string ''culture_requirement'', boolean ''use_partial_replen'', string ''merc_unit_group'')

This one is used to add province mercenaries, in the case of Wh3, they're used for undead's raise dead and Warrior of Chaos' Warband recruitment. The document has the wrong parameters for this function, and the vanilla does not use it, so make sure to check the correct parameters

== cm:instantly_research_technology ==
cm:instantly_research_technology(${1:string faction key}, ${2:string technology key}, ${3:boolean notify event feed})

Instantly completes research for the specified technology for the specified faction

== cm:instantly_research_all_technologies ==
cm:instantly_research_all_technologies(${1:string faction key})

Instantly completes research on all technologies for the specified faction

== cm:instantly_clear_all_technologies ==
cm:instantly_clear_all_technologies(${1:string faction key})

Instantly resets all technologies for the specified faction to an unresearched state.

== cm:pending_battle_cache_get_attacker_embedded_character_subtypes & cm:pending_battle_cache_get_defender_embedded_character_subtypes ==
cm:pending_battle_cache_get_defender_embedded_character_subtypes(number ''index_of_defender'')

Similar to cm:pending_battle_cache_get_defender_subtype(), but you can get embedding heroes subtypes also.

== cm:is_agent_transformation_available ==
cm:is_agent_transformation_available(string ''agent_subtype_key'')

Returns true if your agent_subtype is in the DB campaign_to_agent_subtypes_tables with the given campaign. Especially useful if you want to check certain agent_subtype is unique. (Given that modders have added it to that table)

== cm:military_force_add_temporary_stance ==
cm:military_force_add_temporary_stance(number ''mf_cqi'',string ''stance'', number ''turn'')

Can be used to give a certain stance to a military force for a time even if that faction does not have access to the stance via campaign_stances_factions_junctions_tables. If 0 is given to turn, it will be infinite.

== cm:set_plague_component_state ==
cm:set_plague_component_state(faction_script_interface ''faction'', string ''component'', string ''state'', boolean ?)

Used to handle ToD's new plague system. While they're not in the document, vanilla uses it, so check there.

== FactionDeath ==
While not function, and is in the document, I'll include it here since Chadvandy does not have it yet.

This listener listens for the faction death and supports these in the contexts

- killer(): Faction that killed this faction

- faction(): Faction that died

- is_game_over(): Is game over
[[Category:Script]]

Functions without document

2024-06-05T07:29:18Z

Rhox: functions

Agent subtypes tables

2024-05-28T15:58:03Z

Rhox:

* [[File:Lore.png|thumb]]"Magic Lore": This column creates multiple buttons on the left side. While this is expected, there is one thing you should be cautious about it if you use it with the "legendary_lords" recruitment category. When this agent_subtype is in the recruitable lord pool due to wound or respec, this agent_subtype will block all other LL in the pool from visibility.

[[Category:DB Table]]

Agent subtypes tables

2024-05-28T15:55:48Z

Rhox: Created page with "* thumb"Magic Lore": This column creates multiple buttons on the left side. While this is expected, there is one thing you should be cautious while using it. If you use it with the "legendary_lords" recruitment category, this agent_subtype will block all other LL in the pool from visibility. Category:DB Table"

* [[File:Lore.png|thumb]]"Magic Lore": This column creates multiple buttons on the left side. While this is expected, there is one thing you should be cautious while using it. If you use it with the "legendary_lords" recruitment category, this agent_subtype will block all other LL in the pool from visibility.

[[Category:DB Table]]

File:Lore.png

2024-05-28T15:54:01Z

Rhox:

Lore button on recruit agent

Startpos

2024-05-21T11:36:54Z

Rhox: English

(Disclaimer: Some of the opinions are solitary of Rhox's and might not align with the community's)

Startpos is turn 0 save of the campaign. The key point is, that '''there can be only one startpos'''. Thus, appending or removing via another mod isn't possible. That's why most of the users use only one startpos mod, Mixer. Technically, IEE and TOW are also startpos mods. But they're made to have each entry the same as Mixer and Chaos Robie's stuff are appended manually.

Due to this characteristic,
Modders have made several works around for many startpos-only features, some parts are still startpos bound and need Mixer's work though.

=== Startpos things that can't be replicated ===

* Cultures available agent_types: Mixer has added every possible case for every known culture and Mixer added culture. This would also mean the culture you added won't work due to this. Even if your faction does not have heroes, there is also the tech issue.
* Slot types used for Landmarks: Same as above, Mixu makes slots for each region.
* Potential for each faction: Same.
* Factions: Both playable and spawnable need startpos work. Making it playable requires more work than just spawnable ones. Use the Mixer faction requests thread if you need them. Every playable entry increases the loading time so my advice is to practice with any mixer faction in it, then request when the work is complete. Also, Mixu prefers batch work rather than getting small requests multiple times.
* Feature Forest: You don't normally use it, but if you're making a full horde faction (factions that can't occupy settlements) into a normal faction, or turning a full horde faction into a normal faction, you'll need it.
** You can add more into feature into feature_set_to_faction_features_tables, and while this is not startpos it will affect every other faction that has this feature forest, so be careful when you use it
* Diplomacy: For non-aggression and military access only. Others can be replicated via scripts.
** '''<code>cm:force_grant_military_access</code>''' has some serious quirks and military access given by this can't be canceled in the UI
* Regions held by a faction in the faction selection window: It needs startpos work but it's minor so I would say just ignore it
* Faction leader CQI: If you need your leader to have a certain CQI, you need startpos. You don't normally need it unless you're going to make a quest battle for the leader. However, you can use a script to fool the users. Check Wh2 OvN's Halfing scripts

=== Startpos things that the script can theoretically replace but no one has done it yet ===

* Offices: Because it's just an effect bundle given to a character and not so exciting for many of the makers. If you happen to make one, consider sending it to Mixu

=== Startpos things that can be replaced with script and DB way ===

* Faction RoR (mercenaries): Setup mercenary DB and call '''<code>cm:add_unit_to_faction_mercenary_pool()</code>'''function at first tick callback new
* Province mercenaries (raise dead and warbands): Similar but the function in the document is wrong so check other mods that use this function
* Settings like starting region, leader, items, units, buildings, and such: Check other faction mods, Most of the things can be replicated with the script.
** Faction starting position pin: Use frontend_faction_leaders_tables and alter the 'Override Force Location X & Y' column.
* Tech node Set: While the tech node set is startpos, you can use some workaround. Do note that all the methods below need script work to lock all the vanilla techs you want to remove access from your faction. Otherwise, AI can research it plus will create research available alarm to the player when they have researched all available techs shown in the UI
** Overriding some of the nodes with faction-specific nodes: Use the faction column in the node tables to override the vanilla one. Even CA uses this method for some of the factions. But it can only do overrides and the tech tree's shape needs to cover all the vanilla tech nodes.
** Sending all existing techs to a place where users can't see: While you might not know it, every tech node set can have only one tech key. This means if you make a new faction-specific tech node that has a vanilla tech key, that faction will not have access to the vanilla tech node and will have access to the node the user has made. If you send all the vanilla nodes to a place with this method to a place where users can't see them, now you can create a new tech node set of your own. Check out OvN Dread King if you need an example. Note that it doesn't work for center-starting tech node sets like Chaos Warriors
** Make a new tech tab and hide the previous one: Need some script work but also works. Do note that it can cause problems if another mod adds a tab of its own, but you can create compatibility if you want to.
* Norsca vassal thing, and empire giving region thing (start_pos_entity_association_faction_regions_tables): Depends on what you're using it for, but since it's used in occupation options, you can use a script to hide certain things when the conditions don't match

Startpos

2024-05-21T07:37:38Z

Rhox: startpos

(Disclaimer: Some of the opinions are solitary of Rhox's and might not align with community's)

Startpos is turn 0 save of the campaign. The key point is, that '''there can be only one startpos'''. Thus, appending or removing via another mod isn't possible. That's why most of the mods use only one startpos mod. Mixer. There are also IEE and TOW, and they're made to have each entry the same as Mixer and append some of the Chaos Robie's stuff.

Modders have made several works around for many startpos-only features, but some parts are still startpos bound and need Mixer's work.

=== Startpos things that can't be replicated ===

* Cultures available agent_types: Mixer has added every possible case for every known culture and Mixer added culture
* Slot types used for Landmarks: Same as above
* Factions: Both playable and spawnable need startpos work. Making it playable requires more work than just spawnable ones. Use Mixer faction requests if you need them. Every playable entry increases the loading time so my advice is to practice with any mixer faction in it, then request when the work is complete
* Feature Forest: You don't normally use it, but if you're making a full horde faction (factions that can't occupy settlements) into a normal faction, or turning a full horde faction into a normal faction, you'll need it.
** You can add more into feature into feature_set_to_faction_features_tables, and while this is not startpos it will affect every other faction that has this feature forest, so be careful when you use it
* Diplomacy: For non-aggression and military access only. Others can be replicated via scripts. '''<code>cm:force_grant_military_access</code>''' has some serious quirks and military access given by this can't be canceled in the UI
* Regions held by a faction in the faction selection window: It needs startpos work but it's minor so I would say just ignore it
* Faction leader CQI: If you need your leader to have a certain CQI, it needs startpos. You don't normally need it, but it might get problematic if you're making a quest battle for it. However, you can use a script to fool the users. Check Wh2 OvN's Halfing scripts

=== Startpos things that the script can theoretically replace but no one has done it yet ===

* Offices: Because it's just an effect bundle given to a character and not so exciting for many of the makers. If you happen to make one, consider sending it to Mixu

=== Startpos things that can be replaced with script and DB way ===

* Faction RoR (mercenaries): Setup mercenary DB and call '''<code>cm:add_unit_to_faction_mercenary_pool()</code>'''function at first tick callback new
* Province mercenaries (raise dead and warbands): Similar but the function in the document is wrong so check other mods that do it
* Settings like region, leader, items, units, buildings, and such: Check other faction mods, Most of the things can be replicated with the script.
** Faction starting position pin: Use frontend_faction_leaders_tables and alter the 'Override Force Location X & Y' column.
* Tech node Set: While the tech node set is startpos, you can use some workaround. Do note that all the methods below need script work to lock all the initial techs, otherwise, AI can research it, and will create research available alarm when the player has researched all available techs shown in the UI
** Overriding some of the nodes with faction-specific nodes: Even CA uses this method for some of the factions. But it can only do overrides and the tech tree's shape needs to be the shape same as the vanilla one.
** Sending all existing techs to a place where users can't see: While you might not know it, every tech node set can have only one tech. This means if you make a new faction-specific tech node that has a vanilla tech key, that faction will not have access to the vanilla tech node and will have access to the one the user has made. If you send all of these nodes to a place where users can't see them, now you can create a new tech node set of your own. Check out OvN Dread King if you need an example. Note that it doesn't work for center-starting tech node set like Chaos Warriors
** Make a new tech tab and hide the previous one: Also works, but it can cause problems if another mod adds a tab of their own, but you can create compatibility if you want to.
* Norsca vassal thing, and empire giving region thing (start_pos_entity_association_faction_regions_tables): Depends on what you're using it for, but since it's used in occupation options, you can use a script to hide certain things when the conditions don't match

Character skill nodes tables

2024-05-19T15:39:04Z

Rhox: category

* Tier doesn't work if it is bigger than the ones defined in character_experience_skill_tiers. So normally, set the value lower than 48
* If you want a campaign, subculture, and faction-specific skill node key, define it here. Columns in character_skill_node_sets_tables won't work
* If a character gains an additional skill node via the upper method via confederation, it needs an additional first tick to gain access to it. Same for the startpos character's innate skills
[[Category:DB Table]]

Cooking ingredients tables

2024-05-19T15:38:42Z

Rhox: category

* The game will CTD if the "Vo Trigger" column is left blank. If you want the game to be silent, add some unrelated string. like "empty"
[[Category:DB Table]]

Units custom battle permissions tables

2024-05-19T15:38:18Z

Rhox: category

At first glance, this DB looks like it is only for the custom battle, but actually, several campaign things will be affected by this DB
[[File:Hero recruitment.png|thumb|Hero's unit card in the building browser is not determined by porthole.bin nor unit_variants but custom battle]]

* Hero recruitment portrait: The hero unit card shown in the building browser is determined by this DB
* Affected Unit Preview: Starting from Chaos Dwarf DLC, every effect shows the affected unit set in their tooltip. Among the affected unit_set, the ones that the faction does not have access to via military group or exclusive permission do not show normally. (You can also disable the unit or unit_set from all previews, but that's another DB) But there is another quirk in this preview. '''If any of the factions with that culture has access to a certain unit in the CB, that unit will be shown in the affected unit set preview no matter the military group or exclusive permission.''' So if you want to limit certain units to a certain faction, best to leave it out from CB, or make a CB-only cultured faction.
* [[File:Changeling.png|thumb|In this Changeling unit category, you'll see Grudgebringer. This doesn't make sense at first glance as Grudgebringer is just a faction with Empire culture. This is because Changeling's category is decided by a custom battle, and hence showing custom battle only cultures]]Changeling: Changeling has access to certain agent_subtypes in their shapeshifting via another table. However, how the game categorizes what category agent_subtype belongs to is done via this DB. That is why CB-only only cultures are showing up as categories for Changeling.
[[Category:DB Table]]

Units custom battle permissions tables

2024-05-19T15:37:10Z

Rhox: Category

Units custom battle permissions tables

2024-05-19T14:57:18Z

Rhox: images

File:Changeling.png

2024-05-19T14:55:24Z

Rhox:

Changeling panel example

File:Hero recruitment.png

2024-05-19T14:53:48Z

Rhox:

Hero's unit card you see in the building recruitment is not determined by porthole.bin or unit_variants, but a custom battle

Unique ID

2024-05-19T06:27:02Z

Rhox: some more info about it

=== What is a Unique ID? ===
Unique IDs are found throughout the database in various tables and these act as numeric identifiers that must be unique from each other in order to not cause compatibility issues within the game's tables as well as mods.

It needs to be smaller than 2,147,483,647 (size of int). You can use Modding Den Discord's

<blockquote>/modding random_number num: NUMBER</blockquote>to generate the random numbers

==== Warhammer III Tables with Unique ID's ====
db/armed_citizenry_units_to_unit_groups_junctions_tables
 db/army_special_abilities_tables
 db/battle_set_piece_armies_tables
 db/building_chain_availabilities_tables
 db/building_level_armed_citizenry_junctions_tables
 db/building_units_allowed_tables
 db/campaign_agent_subtype_factorial_effect_junctions_tables
 db/campaign_building_level_factorial_effect_junctions_tables
 db/campaign_character_arts_tables
 db/campaign_post_battle_captive_options_tables
 db/cdir_events_dilemma_option_junctions_tables
 db/cdir_events_dilemma_payloads_tables
 db/cdir_events_incident_option_junctions_tables
 db/cdir_events_incident_payloads_tables
 db/cdir_events_mission_option_junctions_tables
 db/cdir_events_mission_payloads_tables
 db/culture_settlement_occupation_options_tables
 db/faction_set_items_tables
 db/main_units_tables
 db/mercenary_pool_to_groups_junctions_tables
 db/names_tables
 db/ritual_payload_spawn_mercenaries_tables
 db/slot_set_items_tables
 db/technologies_tables
 db/unit_special_abilities_tables
 db/units_custom_battle_types_to_factions_tables
 db/units_custom_battle_types_tables
 db/warscape_animated_lod_tables

Units custom battle permissions tables

2024-05-19T06:24:07Z

Rhox: custom battle quirk

At first glance, this DB looks like it is only for the custom battle, but actually, several campaign things will be affected by this DB

* Hero recruitment portrait: The hero unit card shown in the building browser is determined by this DB
* Affected Unit Preview: Starting from Chaos Dwarf DLC, every effect shows the affected unit set in their tooltip. Among the affected unit_set, the ones that the faction does not have access to via military group or exclusive permission do not show normally. (You can also disable the unit or unit_set from all previews, but that's another DB) But there is another quirk in this preview. '''If any of the factions with that culture has access to a certain unit in the CB, that unit will be shown in the affected unit set preview no matter the military group or exclusive permission.''' So if you want to limit certain units to a certain faction, best to leave it out from CB, or make a CB-only cultured faction.
* Changeling: Changeling has access to certain agent_subtypes in their shapeshifting via another table. However, how the game categorizes what category agent_subtype belongs to is done via this DB. That is why CB-only only cultures are showing up as categories for Changeling.

Cooking ingredients tables

2024-05-15T03:08:18Z

Rhox: Created page with "* The game will CTD if the "Vo Trigger" column is left blank. If you want the game to be silent, add some unrelated string. like "empty""

* The game will CTD if the "Vo Trigger" column is left blank. If you want the game to be silent, add some unrelated string. like "empty"

Character skill nodes tables

2024-05-15T03:03:41Z

Rhox: DB page

Porting other faction's UI feature

2023-07-21T06:12:51Z

Rhox:

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 ===
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, look at other tutorials if you don't have any ideas)

==== 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 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 ====
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 GUID

[[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.

====Scripting====

Now write some script like the one below.

cm:add_first_tick_callback(
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 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 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
)
Apply this script to the mod, and 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

# 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
# Things are not showing properly: Check the DBs and references of the DBs in the twui are correct.

Porting other faction's UI feature

2023-07-08T09:03:45Z

Rhox:

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 ===
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, look at other tutorials if you don't have any ideas)

==== 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 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 ====
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 GUID

[[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.

====Scripting====

Now make write some script like the one below.

cm:add_first_tick_callback(
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 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 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.
[[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

# 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
# Things are not showing properly: Check the DBs and references of the DBs in the twui are correct.

Porting other faction's UI feature

2023-07-08T04:46:13Z

Rhox:

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 ===
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, look at other tutorials if you don't have any ideas)

==== 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 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 ====
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 GUID

[[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.

====Scripting====

Now make write some script like the one below.

cm:add_first_tick_callback(
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 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 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.
[[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

# 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
# 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.

Porting other faction's UI feature

2023-07-08T03:09:33Z

Rhox:

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 ===
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, look at other tutorials if you don't have no ideas)

==== 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 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 ====
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 GUID

[[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.

====Scripting====

Now make write some script like the one below.

cm:add_first_tick_callback(
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
   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
   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.
[[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

# 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

Porting other faction's UI feature

2023-07-08T03:08:08Z

Rhox: Finished

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 ===
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, look at other tutorials if you don't have no ideas)

==== 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 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 ====
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. Put the twui made this way into your pack.

====Scripting====

Now make write some script like the one below.

cm:add_first_tick_callback(
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
   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
   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.
[[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

# 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

File:Rhythm.png

2023-07-08T02:59:25Z

Rhox:

Wurrzag has the rhythm.

Porting other faction's UI feature

2023-07-07T17:26:35Z

Rhox: mid save

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.

==== 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.

====Scripting====

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)