Total War Modding - User contributions [en]

Example Scripts

2021-02-03T12:47:38Z

Aexrael:

A list of example scripts that can easily be copied, edited and then put into a [[Mods|mod]].

== Using Example Scripts ==
Unless otherwise stated these scripts go into a .pack file at `script/campaign/mod/?.lua`, replace ? with whatever your file name is.

Each script listed is self-contained - so you can use multiple of the example scripts in a single .lua file.

When using the scripts, please keep the credits at the top and don't remove comments. Comments are the text following -- or in a comment block denoted by --[[ Text here ]].

Typically an example script will have a list of variables that should be changed to tailor the script to your particular mod, these will often have comments next to them explaining where you will find the keys or values from.

Example in the Replace Starting General example script, you have a line that reads 'local faction_name = "wh_main_emp_empire";'

This could instead be changed to 'local faction_name = "wh2_dlc11_vmp_the_barrow_legion";' to affect the Barrow Legion faction instead of The Empire.

If there are out() calls within the example script, you are encouraged to insert a unique text identifier, so you can find your unique output in the [[Script logging|script logs]] using ctrl+f.

Example in the Replacing Starting General Script, replace REPLAC: with your unique identifier, maybe the starting letters of your discord username, or the mod name or the name of your cat, or something else unique to you.

== Contributing new scripts ==
If you have some generic scripted functionality you think would be useful for the wider community, please consider adding it to the wiki here, or bring attention to it via Modding Discord in the channel for the wiki.

Add a new Sub-Heading 1 within the Example Scripts section below, give it a meaningful title and a short description. Include what games it is valid for and any specific notes necessary, ie. has to go in this directory, has to be done this way etc.

Avoid using global variables in the example scripts, use local variables and local functions to avoid incidents involving scripts that have overlapping names. Make sure to use comments explaining what the various parts of the script is doing or when referring to specific keys from the database, like where to find them. Context and explanation goes a long way towards helping make sense of the scripts for beginners.

If your script runs through a single init function that's triggered through a first tick callback, give the local function a meaningful name and implement the first-tick-callback, and leave it at that. No need to have the modder replace the local function name in their own replication.

Mind that plopping something in this page leaves it open for collaboration, so someone in the future may come in and add more comments, change anything necessary for an update, make an extra version for another game, or much else. If you're editing the original script, leave the credits the same, or add your name to the credits if you think the addition is meaningful. Don't remove the OG author for sure.

== Example Scripts ==

=== Replacing a Starting General ===

<nowiki>
--[[
Script by Aexrael Dex
Replaces the starting general for a specific faction
]]

local function replace_starting_general()
if cm:is_new_game() then
-- The Empire
local faction_name = "wh_main_emp_empire"; -- Faction key from Factions table
local faction = cm:get_faction(faction_name);

if faction:is_null_interface() == false and faction:is_dead() == false then

-- Creating replacement for Karl Franz with a regular Empire General
local general_details = {
general_faction = faction_name,
unit_list = "wh_main_emp_cav_reiksguard,wh_main_emp_cav_reiksguard,wh_main_emp_cav_reiksguard"; -- unit keys from main_units table
region_key = faction:home_region():name(),
type = "general", -- Agent type
subtype = "emp_lord", -- Agent subtype
forename = "names_name_1904032251", -- From local_en names table, Bernhoff the Butcher is now ruler of Reikland
clanname = "", -- From local_en names table
surname = "names_name_151217003", -- From local_en names table
othername = "", -- From local_en names table
is_faction_leader = true, -- Bool for whether the general being replaced is the new faction leader
trait = "wh2_dlc09_trait_benevolence" -- The trait key you want to assign to the new General from character traits table
};

local general_x_pos, general_y_pos = cm:find_valid_spawn_location_for_character_from_settlement(general_details.general_faction, general_details.region_key, false, true, 8);
out(faction_name .. " home region name is " .. general_details.region_key);

cm:create_force_with_general(
general_details.general_faction,
general_details.unit_list,
general_details.region_key,
general_x_pos,
general_y_pos,
general_details.type,
general_details.subtype,
general_details.forename,
general_details.clanname,
general_details.surname,
general_details.othername,
general_details.is_faction_leader,

-- Generals created this way does not come with a trait normally
function(cqi)
local char_str = cm:char_lookup_str(cqi);

-- Adding a new trait to the above general
cm:force_add_trait(char_str, general_details.trait, true);
out("Adding Replacement General's trait");
end
);
out("Created replacement Lord " .. general_details.forename .. " for " .. faction_name);

-- Killing Karl Franz permanently
local char_list = faction:character_list();
local char_subtype = "emp_karl_franz"; -- Karl Franz's agent subtype
local char_forename = "names_name_2147343849"; -- Karl Franz's forename

for i = 0, char_list:num_items() - 1 do
local current_char = char_list:item_at(i);
local char_str = cm:char_lookup_str(current_char);

if current_char:is_null_interface() == false and current_char:character_subtype_key() == char_subtype and current_char:get_forename() == char_forename and current_char:has_military_force() == true then
cm:set_character_immortality(char_str, false);
cm:disable_event_feed_events(true, "wh_event_category_character", "", "");
cm:kill_character(current_char:command_queue_index(), true, true);
cm:callback(function() cm:disable_event_feed_events(false, "wh_event_category_character", "", "") end, 0.5);
out("Killing original " .. char_subtype .. " with forename " .. char_forename .. " for " .. faction_name .. " permanently");
end;
end;
end;
end;
end;

cm:add_first_tick_callback(function() replace_starting_general() end);</nowiki>

=== Adding RoRs to mercenary pool ===

<nowiki>--[[
Script by Aexrael Dex
Adds custom Regiments of Reknown to specified factions
]]

local function add_custom_ror()

-- Checking whether the script has already run for saved games and if it has then the script doesn't need to run again
if cm:get_saved_value("custom_ror_enabled") == nil then

-- Table for faction, unit key and parameters for add_unit_to_faction_mercenary_pool
local cror_list = {
{faction_key = "wh_main_vmp_schwartzhafen", unit = "wh2_dlc11_cst_inf_zombie_deckhands_mob_ror_0", count = 1, rcp = 100, munits = 1, murpt = 0.1, xplevel = 0, frr = "", srr = "", trr = "", replen = true},
{faction_key = "wh_main_vmp_vampire_counts", unit = "wh2_dlc11_cst_inf_zombie_deckhands_mob_ror_0", count = 1, rcp = 100, munits = 1, murpt = 0.1, xplevel = 0, frr = "", srr = "", trr = "", replen = true}
};

-- Loop for the table above
for i = 1, #cror_list do
local faction_name = cror_list[i].faction_key; -- Faction whose pool the unit(s) should be added to
local faction = cm:get_faction(faction_name); -- FACTION_SCRIPT_INTERFACE
local unit_key = cror_list[i].unit; -- Key of unit to add to the mercenary pool, from the main_units table
local unit_count = cror_list[i].count; -- Number of units to add to the mercenary pool
local rcp = cror_list[i].rcp; -- Replenishment chance, as a percentage
local munits = cror_list[i].munits; -- The maximum number of units of the supplied type that the pool is allowed to contain.
local murpt = cror_list[i].murpt; -- The maximum number of units of the supplied type that may be added by replenishment per-turn
local xplevel = cror_list[i].xplevel; -- The experience level of the units when recruited
local frr = cror_list[i].frr; -- (may be empty) The key of the faction who can actually recruit the units, from the factions database table
local srr = cror_list[i].srr; -- (may be empty) The key of the subculture who can actually recruit the units, from the cultures_subcultures database table
local trr = cror_list[i].trr; -- (may be empty) The key of a technology that must be researched in order to recruit the units, from the technologies database table
local replen = cror_list[i].replen; -- Allow replenishment of partial units

-- Adding the listed unit to the listed faction in the above table
cm:add_unit_to_faction_mercenary_pool(faction, unit_key, unit_count, rcp, munits, murpt, xplevel, frr, srr, trr, replen);

-- Debug message for log
out("CROR: adding the custom ror unit " .. unit_key .. " to " .. faction_name);
end;

-- Setting saved value, so that the script doesn't run again when reloaded from a saved game
cm:set_saved_value("custom_ror_enabled", true);
end;
end;

cm:add_first_tick_callback(function() add_custom_ror() end);</nowiki>

=== Replacing Starting Armies ===

<nowiki>--[[
Script by Aexrael Dex
Replaces the starting units for specified starting Lords
]]

local function army_tweaks()

-- Checking whether it's a new game, we don't want to replace armies in the middle of a campaign
if cm:is_new_game() then

-- Creating a table with entries for the various starting Lords, their Faction key from Factions table, subtype key from agent_subtypes, Forename from names table and Unit List with keys from Main Units
local starting_army = {
-- Vlad, Carsteins
{faction_key = "wh_main_vmp_schwartzhafen", subtype = "dlc04_vmp_vlad_con_carstein", forename = "names_name_2147345130", units = {"wh_main_vmp_inf_skeleton_warriors_0", "wh_main_vmp_inf_skeleton_warriors_0", "wh_main_vmp_mon_fell_bats", "wh_main_vmp_mon_fell_bats", "wh_main_vmp_cav_black_knights_0", "wh_main_vmp_cav_black_knights_0"}},
-- Isabella, Carsteins
{faction_key = "wh_main_vmp_schwartzhafen", subtype = "pro02_vmp_isabella_von_carstein", forename = "names_name_2147345124", units = {"wh_main_vmp_inf_zombie", "wh_main_vmp_inf_zombie", "wh_main_vmp_mon_dire_wolves", "wh_main_vmp_mon_dire_wolves", "wh_main_vmp_mon_fell_bats", "wh_main_vmp_mon_vargheists"}}
};

for i = 1, #starting_army do
local faction_name = starting_army[i].faction_key;
local faction = cm:get_faction(faction_name);
local char_list = faction:character_list();
local general_subtype = starting_army[i].subtype;
local general_forename = starting_army[i].forename;
local unit_list = starting_army[i].units;

for j = 0, char_list:num_items() - 1 do
local current_char = char_list:item_at(j);
local char_str = cm:char_lookup_str(current_char);

if current_char:is_null_interface() == false and current_char:character_subtype_key() == general_subtype and current_char:get_forename() == general_forename and current_char:has_military_force() == true then

-- Removing all existing units from the General
cm:remove_all_units_from_general(current_char);
out("ARMY: Removing starting units from " .. general_subtype .. " with forename " .. general_forename);

for k = 1, #unit_list do
local unit = unit_list[k];

-- Granting new units to the General
cm:grant_unit_to_character(char_str, unit);
out("ARMY: Adding new starting units to " .. general_subtype .. " with forename " .. general_forename);
end;
end;
end;
end;
end;
end;

cm:add_first_tick_callback(function() army_tweaks() end);</nowiki>

=== Changing CAI based on campaign difficulty ===

<nowiki>--[[
Script by Aexrael Dex
Replaces the Campaign AI Personality for specific factions depending on the chosen campaign difficulty level
]]

local function replace_cai_difficulty()
if cm:is_new_game() == true then
local difficulty_str = cm:get_difficulty(true);
local def_personality = "";
local hef_personality = "";
local wef_personality = "";

-- CAI personality to use for easy difficulty
if difficulty_str == "easy" then

def_personality = "wh2_darkelf_early_easy";
hef_personality = "wh2_highelf_early_easy";
wef_personality = "wh_dlc05_wood_elves_default_main";

-- CAI personality to use for normal difficulty
elseif difficulty_str == "normal" then

def_personality = "wh2_darkelf_early";
hef_personality = "wh2_highelf_early";
wef_personality = "wh_dlc05_wood_elves_default_main";

-- CAI personality to use for hard difficulty
elseif difficulty_str == "hard" then

def_personality = "wh2_darkelf_early_hard";
hef_personality = "wh2_highelf_early_hard";
wef_personality = "wh_dlc05_wood_elves_default_main";

-- CAI personality to use for very hard difficulty
elseif difficulty_str == "very hard" then

def_personality = "wh2_darkelf_early_hard";
hef_personality = "wh2_highelf_early_hard";
wef_personality = "wh_dlc05_wood_elves_default_main";

-- CAI personality to use for legendary difficulty
elseif difficulty_str == "legendary" then

def_personality = "wh2_darkelf_early_hard";
hef_personality = "wh2_highelf_early_hard";
wef_personality = "wh_dlc05_wood_elves_default_main";
end;

local faction_list = cm:model():world():faction_list();

for i = 0, faction_list:num_items() - 1 do
local faction = faction_list:item_at(i);
local faction_name = faction:name();
local faction_culture = faction:culture();

-- Checking whetether the faction exists and is alive
if faction:is_null_interface() == false and faction:is_dead() == false and faction:is_human() == false then

-- Dark Elves culture
if faction_culture == "wh2_main_def_dark_elves" then

-- Changing the CAI for all Dark Elf factions
cm:force_change_cai_faction_personality(faction_name, def_personality);
out("ELF: Changing CAI personality for " .. faction_name .. " to " .. def_personality .. " on " .. difficulty_str .. " difficulty");

-- High Elves culture
elseif faction_culture == "wh2_main_hef_high_elves" then

-- Changing the CAI for all High Elf factions
cm:force_change_cai_faction_personality(faction_name, hef_personality);
out("ELF: Changing CAI personality for " .. faction_name .. " to " .. hef_personality .. " on " .. difficulty_str .. " difficulty");

-- Wood Elves culture
elseif faction_culture == "wh_dlc05_wef_wood_elves" then

-- Changing the CAI for all Wood Elf factions
cm:force_change_cai_faction_personality(faction_name, wef_personality);
out("ELF: Changing CAI personality for " .. faction_name .. " to " .. wef_personality .. " on " .. difficulty_str .. " difficulty");
end;
end;
end;
end;
end;

cm:add_first_tick_callback(function() replace_cai_difficulty() end);</nowiki>

=== Spawning a Unique Agent ===

<nowiki>
--[[
Script by Aexrael Dex
Spawns a Unique Agent next to the starting lord of a specified faction
]]

local function add_unique_agent()

-- Checking whether the script has already run for saved games and if it has then the script doesn't need to run again
if cm:get_saved_value("unique_agent_enabled") == nil then

-- Starting agent setup
unique_agent_setup();
end;
end;

function unique_agent_setup()
-- Agent Details
local agent_details = {
faction_str = "wh2_dlc13_emp_the_huntmarshals_expedition", -- faction_key from factions
forename_key = "names_name_2147359013", -- forename_key from names
family_name_key = "names_name_1535812850", -- family_name_key from names
subtype_key = "wh2_dlc13_emp_hunter_jorek_grimm", -- agent subtype_key from agent_subtypes
art_set_key = "wh2_dlc13_art_set_emp_hunter_jorek_grimm_0", -- agent art_set_id from campaign_character_arts
unique_string = "wh2_dlc13_emp_hunter_jorek_grimm", -- unique agent string from unique_agents
saved_value = "unique_agent_enabled", -- saved_value string
trait = "wh2_dlc09_trait_benevolence" -- agent trait from character_traits
};

-- Monitor activated, listening for FactionTurnStart for The Huntmarshals Expedition
core:add_listener(
"unique_agent_setup",
"FactionTurnStart",
function(context)
return context:faction():name() == agent_details.faction_str;
end,
function(context)
-- Spawning Jorek as a unique agent next to Markus
local faction = cm:get_faction(agent_details.faction_str);
local faction_cqi = faction:command_queue_index();
local faction_leader_cqi = faction:faction_leader():command_queue_index();

cm:disable_event_feed_events(true, "wh_event_category_agent", "", "");
cm:spawn_unique_agent_at_character(
faction_cqi,
agent_details.unique_string,
faction_leader_cqi,
true
);
cm:callback(function()
cm:disable_event_feed_events(false, "wh_event_category_agent", "", "");
CampaignUI.ClearSelection();
end, 0.5);
out("UNIQ: Spawned Jorek next to Markus");

-- Looping through the character list for The Huntmarshals Expedition
local char_list = faction:character_list();

for i = 0, char_list:num_items() - 1 do
local current_char = char_list:item_at(i);
local char_str = cm:char_lookup_str(current_char);

-- Adding Joreks trait, replenishing AP and overriding the art set
if current_char:is_null_interface() == false and current_char:character_subtype_key() == agent_details.subtype_key then

-- Adding trait
cm:force_add_trait(char_str, agent_details.trait, false);
out("UNIQ: Adding " .. agent_details.trait .. " to Jorek");

-- Replenishing action points
cm:replenish_action_points(char_str);
out("UNIQ: Replenishing the action points of Jorek");

-- Failsafe for the random chance that the art_set doesn't apply properly
cm:add_unit_model_overrides(char_str, agent_details.art_set_key);
out("UNIQ: Adding unit model override for Jorek");
end;
end;

-- Setting saved value, so that the script doesn't run again when reloaded from a saved game
cm:set_saved_value(agent_details.saved_value, true);
out("UNIQ: Setting saved value " .. agent_details.saved_value);
end,
false
);
end;

cm:add_first_tick_callback(function() add_unique_agent() end);</nowiki>

Example Scripts

2021-02-03T12:46:37Z

Aexrael:

A list of example scripts that can easily be copied, edited and then put into a [[Mods|mod]].

== Using Example Scripts ==
Unless otherwise stated these scripts go into a .pack file at `script/campaign/mod/?.lua`, replace ? with whatever your file name is.

Each script listed is self-contained - so you can use multiple of the example scripts in a single .lua file.

When using the scripts, please keep the credits at the top and don't remove comments. Comments are the text following -- or in a comment block denoted by --[[ Text here ]].

Typically an example script will have a list of variables that should be changed to tailor the script to your particular mod, these will often have comments next to them explaining where you will find the keys or values from.

Example in the Replace Starting General example script, you have a line that reads 'local faction_name = "wh_main_emp_empire";'

This could instead be changed to 'local faction_name = "wh2_dlc11_vmp_the_barrow_legion";' to affect the Barrow Legion faction instead of The Empire.

If there are out() calls within the example script, you are encouraged to insert a unique text identifier, so you can find your unique output in the [[Script logging|script logs]] using ctrl+f.

Example in the Replacing Starting General Script, replace REPLAC: with your unique identifier, maybe the starting letters of your discord username, or the mod name or the name of your cat, or something else unique to you.

== Contributing new scripts ==
If you have some generic scripted functionality you think would be useful for the wider community, please consider adding it to the wiki here, or bring attention to it via Modding Discord in the channel for the wiki.

Add a new Sub-Heading 1 within the Example Scripts section below, give it a meaningful title and a short description. Include what games it is valid for and any specific notes necessary, ie. has to go in this directory, has to be done this way etc.

Avoid using global variables in the example scripts, use local variables and local functions to avoid incidents involving scripts that have overlapping names. Make sure to use comments explaining what the various parts of the script is doing or when referring to specific keys from the database, like where to find them. Context and explanation goes a long way towards helping make sense of the scripts for beginners.

If your script runs through a single init function that's triggered through a first tick callback, give the local function a meaningful name and implement the first-tick-callback, and leave it at that. No need to have the modder replace the local function name in their own replication.

Mind that plopping something in this page leaves it open for collaboration, so someone in the future may come in and add more comments, change anything necessary for an update, make an extra version for another game, or much else. If you're editing the original script, leave the credits the same, or add your name to the credits if you think the addition is meaningful. Don't remove the OG author for sure.

== Example Scripts ==

=== Replacing a Starting General ===

<nowiki>
--[[
Script by Aexrael Dex
Replaces the starting general for a specific faction
]]

local function replace_starting_general()
if cm:is_new_game() then
-- The Empire
local faction_name = "wh_main_emp_empire"; -- Faction key from Factions table
local faction = cm:get_faction(faction_name);

if faction:is_null_interface() == false and faction:is_dead() == false then

-- Creating replacement for Karl Franz with a regular Empire General
local general_details = {
general_faction = faction_name,
unit_list = "wh_main_emp_cav_reiksguard,wh_main_emp_cav_reiksguard,wh_main_emp_cav_reiksguard"; -- unit keys from main_units table
region_key = faction:home_region():name(),
type = "general", -- Agent type
subtype = "emp_lord", -- Agent subtype
forename = "names_name_1904032251", -- From local_en names table, Bernhoff the Butcher is now ruler of Reikland
clanname = "", -- From local_en names table
surname = "names_name_151217003", -- From local_en names table
othername = "", -- From local_en names table
is_faction_leader = true, -- Bool for whether the general being replaced is the new faction leader
trait = "wh2_dlc09_trait_benevolence" -- The trait key you want to assign to the new General from character traits table
};

local general_x_pos, general_y_pos = cm:find_valid_spawn_location_for_character_from_settlement(general_details.general_faction, general_details.region_key, false, true, 8);
out(faction_name .. " home region name is " .. general_details.region_key);

cm:create_force_with_general(
general_details.general_faction,
general_details.unit_list,
general_details.region_key,
general_x_pos,
general_y_pos,
general_details.type,
general_details.subtype,
general_details.forename,
general_details.clanname,
general_details.surname,
general_details.othername,
general_details.is_faction_leader,

-- Generals created this way does not come with a trait normally
function(cqi)
local char_str = cm:char_lookup_str(cqi);

-- Adding a new trait to the above general
cm:force_add_trait(char_str, general_details.trait, true);
out("Adding Replacement General's trait");
end
);
out("Created replacement Lord " .. general_details.forename .. " for " .. faction_name);

-- Killing Karl Franz permanently
local char_list = faction:character_list();
local char_subtype = "emp_karl_franz"; -- Karl Franz's agent subtype
local char_forename = "names_name_2147343849"; -- Karl Franz's forename

for i = 0, char_list:num_items() - 1 do
local current_char = char_list:item_at(i);
local char_str = cm:char_lookup_str(current_char);

if current_char:is_null_interface() == false and current_char:character_subtype_key() == char_subtype and current_char:get_forename() == char_forename and current_char:has_military_force() == true then
cm:set_character_immortality(char_str, false);
cm:disable_event_feed_events(true, "wh_event_category_character", "", "");
cm:kill_character(current_char:command_queue_index(), true, true);
cm:callback(function() cm:disable_event_feed_events(false, "wh_event_category_character", "", "") end, 0.5);
out("Killing original " .. char_subtype .. " with forename " .. char_forename .. " for " .. faction_name .. " permanently");
end;
end;
end;
end;
end;

cm:add_first_tick_callback(function() replace_starting_general() end);</nowiki>

=== Adding RoRs to mercenary pool ===

<nowiki>--[[
Script by Aexrael Dex
Adds custom Regiments of Reknown to specified factions
]]

local function add_custom_ror()

-- Checking whether the script has already run for saved games and if it has then the script doesn't need to run again
if cm:get_saved_value("custom_ror_enabled") == nil then

-- Table for faction, unit key and parameters for add_unit_to_faction_mercenary_pool
local cror_list = {
{faction_key = "wh_main_vmp_schwartzhafen", unit = "wh2_dlc11_cst_inf_zombie_deckhands_mob_ror_0", count = 1, rcp = 100, munits = 1, murpt = 0.1, xplevel = 0, frr = "", srr = "", trr = "", replen = true},
{faction_key = "wh_main_vmp_vampire_counts", unit = "wh2_dlc11_cst_inf_zombie_deckhands_mob_ror_0", count = 1, rcp = 100, munits = 1, murpt = 0.1, xplevel = 0, frr = "", srr = "", trr = "", replen = true}
};

-- Loop for the table above
for i = 1, #cror_list do
local faction_name = cror_list[i].faction_key; -- Faction whose pool the unit(s) should be added to
local faction = cm:get_faction(faction_name); -- FACTION_SCRIPT_INTERFACE
local unit_key = cror_list[i].unit; -- Key of unit to add to the mercenary pool, from the main_units table
local unit_count = cror_list[i].count; -- Number of units to add to the mercenary pool
local rcp = cror_list[i].rcp; -- Replenishment chance, as a percentage
local munits = cror_list[i].munits; -- The maximum number of units of the supplied type that the pool is allowed to contain.
local murpt = cror_list[i].murpt; -- The maximum number of units of the supplied type that may be added by replenishment per-turn
local xplevel = cror_list[i].xplevel; -- The experience level of the units when recruited
local frr = cror_list[i].frr; -- (may be empty) The key of the faction who can actually recruit the units, from the factions database table
local srr = cror_list[i].srr; -- (may be empty) The key of the subculture who can actually recruit the units, from the cultures_subcultures database table
local trr = cror_list[i].trr; -- (may be empty) The key of a technology that must be researched in order to recruit the units, from the technologies database table
local replen = cror_list[i].replen; -- Allow replenishment of partial units

-- Adding the listed unit to the listed faction in the above table
cm:add_unit_to_faction_mercenary_pool(faction, unit_key, unit_count, rcp, munits, murpt, xplevel, frr, srr, trr, replen);

-- Debug message for log
out("CROR: adding the custom ror unit " .. unit_key .. " to " .. faction_name);
end;

-- Setting saved value, so that the script doesn't run again when reloaded from a saved game
cm:set_saved_value("custom_ror_enabled", true);
end;
end;

cm:add_first_tick_callback(function() add_custom_ror() end);</nowiki>

=== Replacing Starting Armies ===

<nowiki>--[[
Script by Aexrael Dex
Replaces the starting units for specified starting Lords
]]

local function army_tweaks()

-- Checking whether it's a new game, we don't want to replace armies in the middle of a campaign
if cm:is_new_game() then

-- Creating a table with entries for the various starting Lords, their Faction key from Factions table, subtype key from agent_subtypes, Forename from names table and Unit List with keys from Main Units
local starting_army = {
-- Vlad, Carsteins
{faction_key = "wh_main_vmp_schwartzhafen", subtype = "dlc04_vmp_vlad_con_carstein", forename = "names_name_2147345130", units = {"wh_main_vmp_inf_skeleton_warriors_0", "wh_main_vmp_inf_skeleton_warriors_0", "wh_main_vmp_mon_fell_bats", "wh_main_vmp_mon_fell_bats", "wh_main_vmp_cav_black_knights_0", "wh_main_vmp_cav_black_knights_0"}},
-- Isabella, Carsteins
{faction_key = "wh_main_vmp_schwartzhafen", subtype = "pro02_vmp_isabella_von_carstein", forename = "names_name_2147345124", units = {"wh_main_vmp_inf_zombie", "wh_main_vmp_inf_zombie", "wh_main_vmp_mon_dire_wolves", "wh_main_vmp_mon_dire_wolves", "wh_main_vmp_mon_fell_bats", "wh_main_vmp_mon_vargheists"}}
};

for i = 1, #starting_army do
local faction_name = starting_army[i].faction_key;
local faction = cm:get_faction(faction_name);
local char_list = faction:character_list();
local general_subtype = starting_army[i].subtype;
local general_forename = starting_army[i].forename;
local unit_list = starting_army[i].units;

for j = 0, char_list:num_items() - 1 do
local current_char = char_list:item_at(j);
local char_str = cm:char_lookup_str(current_char);

if current_char:is_null_interface() == false and current_char:character_subtype_key() == general_subtype and current_char:get_forename() == general_forename and current_char:has_military_force() == true then

-- Removing all existing units from the General
cm:remove_all_units_from_general(current_char);
out("ARMY: Removing starting units from " .. general_subtype .. " with forename " .. general_forename);

for k = 1, #unit_list do
local unit = unit_list[k];

-- Granting new units to the General
cm:grant_unit_to_character(char_str, unit);
out("ARMY: Adding new starting units to " .. general_subtype .. " with forename " .. general_forename);
end;
end;
end;
end;
end;
end;

cm:add_first_tick_callback(function() army_tweaks() end);</nowiki>

=== Changing CAI based on campaign difficulty ===

<nowiki>--[[
Script by Aexrael Dex
Replaces the Campaign AI Personality for specific factions depending on the chosen campaign difficulty level
]]

local function replace_cai_difficulty()
if cm:is_new_game() == true then
local difficulty_str = cm:get_difficulty(true);
local def_personality = "";
local hef_personality = "";
local wef_personality = "";

-- CAI personality to use for easy difficulty
if difficulty_str == "easy" then

def_personality = "wh2_darkelf_early_easy";
hef_personality = "wh2_highelf_early_easy";
wef_personality = "wh_dlc05_wood_elves_default_main";

-- CAI personality to use for normal difficulty
elseif difficulty_str == "normal" then

def_personality = "wh2_darkelf_early";
hef_personality = "wh2_highelf_early";
wef_personality = "wh_dlc05_wood_elves_default_main";

-- CAI personality to use for hard difficulty
elseif difficulty_str == "hard" then

def_personality = "wh2_darkelf_early_hard";
hef_personality = "wh2_highelf_early_hard";
wef_personality = "wh_dlc05_wood_elves_default_main";

-- CAI personality to use for very hard difficulty
elseif difficulty_str == "very hard" then

def_personality = "wh2_darkelf_early_hard";
hef_personality = "wh2_highelf_early_hard";
wef_personality = "wh_dlc05_wood_elves_default_main";

-- CAI personality to use for legendary difficulty
elseif difficulty_str == "legendary" then

def_personality = "wh2_darkelf_early_hard";
hef_personality = "wh2_highelf_early_hard";
wef_personality = "wh_dlc05_wood_elves_default_main";
end;

local faction_list = cm:model():world():faction_list();

for i = 0, faction_list:num_items() - 1 do
local faction = faction_list:item_at(i);
local faction_name = faction:name();
local faction_culture = faction:culture();

-- Checking whetether the faction exists and is alive
if faction:is_null_interface() == false and faction:is_dead() == false and faction:is_human() == false then

-- Dark Elves culture
if faction_culture == "wh2_main_def_dark_elves" then

-- Changing the CAI for all Dark Elf factions
cm:force_change_cai_faction_personality(faction_name, def_personality);
out("ELF: Changing CAI personality for " .. faction_name .. " to " .. def_personality .. " on " .. difficulty_str .. " difficulty");

-- High Elves culture
elseif faction_culture == "wh2_main_hef_high_elves" then

-- Changing the CAI for all High Elf factions
cm:force_change_cai_faction_personality(faction_name, hef_personality);
out("ELF: Changing CAI personality for " .. faction_name .. " to " .. hef_personality .. " on " .. difficulty_str .. " difficulty");

-- Wood Elves culture
elseif faction_culture == "wh_dlc05_wef_wood_elves" then

-- Changing the CAI for all Wood Elf factions
cm:force_change_cai_faction_personality(faction_name, wef_personality);
out("ELF: Changing CAI personality for " .. faction_name .. " to " .. wef_personality .. " on " .. difficulty_str .. " difficulty");
end;
end;
end;
end;
end;

cm:add_first_tick_callback(function() replace_cai_difficulty() end);</nowiki>

=== Spawning a Unique Agent ===

<nowiki>
--[[
Script by Aexrael Dex
Spawns a Unique Agent next to the starting lord of a specified faction
]]

local function add_unique_agent()

-- Checking whether the script has already run for saved games and if it has then the script doesn't need to run again
if cm:get_saved_value("unique_agent_enabled") == nil then

-- Starting agent setup
unique_agent_setup();
end;
end;

function unique_agent_setup()
-- Agent Details
local agent_details = {
faction_str = "wh2_dlc13_emp_the_huntmarshals_expedition", -- faction_key from factions
forename_key = "names_name_2147359013", -- forename_key from names
family_name_key = "names_name_1535812850", -- family_name_key from names
subtype_key = "wh2_dlc13_emp_hunter_jorek_grimm", -- agent subtype_key from agent_subtypes
art_set_key = "wh2_dlc13_art_set_emp_hunter_jorek_grimm_0", -- agent art_set_id from campaign_character_arts
unique_string = "wh2_dlc13_emp_hunter_jorek_grimm", -- unique agent string from unique_agents
saved_value = "unique_agent_enabled", -- saved_value string
trait = "wh2_dlc09_trait_benevolence" -- agent trait from character_traits
};

-- Monitor activated, listening for FactionTurnStart for The Huntmarshals Expedition
core:add_listener(
"unique_agent_setup",
"FactionTurnStart",
function(context)
return context:faction():name() == agent_details.faction_str;
end,
function(context)
-- Spawning Jorek as a unique agent next to Markus
local faction = cm:get_faction(agent_details.faction_str);
local faction_cqi = faction:command_queue_index();
local faction_leader_cqi = faction:faction_leader():command_queue_index();

cm:disable_event_feed_events(true, "wh_event_category_agent", "", "");
cm:spawn_unique_agent_at_character(
faction_cqi,
agent_details.unique_string,
faction_leader_cqi,
true
);
cm:callback(function()
cm:disable_event_feed_events(false, "wh_event_category_agent", "", "");
CampaignUI.ClearSelection();
end, 0.5);
out("UNIQ: Spawned Jorek next to Markus");

-- Looping through the character list for The Empire
local char_list = faction:character_list();

for i = 0, char_list:num_items() - 1 do
local current_char = char_list:item_at(i);
local char_str = cm:char_lookup_str(current_char);

-- Adding Joreks trait, replenishing AP and overriding the art set
if current_char:is_null_interface() == false and current_char:character_subtype_key() == agent_details.subtype_key then

-- Adding trait
cm:force_add_trait(char_str, agent_details.trait, false);
out("UNIQ: Adding " .. agent_details.trait .. " to Jorek");

-- Replenishing action points
cm:replenish_action_points(char_str);
out("UNIQ: Replenishing the action points of Jorek");

-- Failsafe for the random chance that the art_set doesn't apply properly
cm:add_unit_model_overrides(char_str, agent_details.art_set_key);
out("UNIQ: Adding unit model override for Jorek");
end;
end;

-- Setting saved value, so that the script doesn't run again when reloaded from a saved game
cm:set_saved_value(agent_details.saved_value, true);
out("UNIQ: Setting saved value " .. agent_details.saved_value);
end,
false
);
end;

cm:add_first_tick_callback(function() add_unique_agent() end);</nowiki>

Example Scripts

2021-02-03T12:46:11Z

Aexrael:

A list of example scripts that can easily be copied, edited and then put into a [[Mods|mod]].

== Using Example Scripts ==
Unless otherwise stated these scripts go into a .pack file at `script/campaign/mod/?.lua`, replace ? with whatever your file name is.

Each script listed is self-contained - so you can use multiple of the example scripts in a single .lua file.

When using the scripts, please keep the credits at the top and don't remove comments. Comments are the text following -- or in a comment block denoted by --[[ Text here ]].

Typically an example script will have a list of variables that should be changed to tailor the script to your particular mod, these will often have comments next to them explaining where you will find the keys or values from.

Example in the Replace Starting General example script, you have a line that reads 'local faction_name = "wh_main_emp_empire";'

This could instead be changed to 'local faction_name = "wh2_dlc11_vmp_the_barrow_legion";' to affect the Barrow Legion faction instead of The Empire.

If there are out() calls within the example script, you are encouraged to insert a unique text identifier, so you can find your unique output in the [[Script logging|script logs]] using ctrl+f.

Example in the Replacing Starting General Script, replace REPLAC: with your unique identifier, maybe the starting letters of your discord username, or the mod name or the name of your cat, or something else unique to you.

== Contributing new scripts ==
If you have some generic scripted functionality you think would be useful for the wider community, please consider adding it to the wiki here, or bring attention to it via Modding Discord in the channel for the wiki.

Add a new Sub-Heading 1 within the Example Scripts section below, give it a meaningful title and a short description. Include what games it is valid for and any specific notes necessary, ie. has to go in this directory, has to be done this way etc.

Avoid using global variables in the example scripts, use local variables and local functions to avoid incidents involving scripts that have overlapping names. Make sure to use comments explaining what the various parts of the script is doing or when referring to specific keys from the database, like where to find them. Context and explanation goes a long way towards helping make sense of the scripts for beginners.

If your script runs through a single init function that's triggered through a first tick callback, give the local function a meaningful name and implement the first-tick-callback, and leave it at that. No need to have the modder replace the local function name in their own replication.

Mind that plopping something in this page leaves it open for collaboration, so someone in the future may come in and add more comments, change anything necessary for an update, make an extra version for another game, or much else. If you're editing the original script, leave the credits the same, or add your name to the credits if you think the addition is meaningful. Don't remove the OG author for sure.

== Example Scripts ==

=== Replacing a Starting General ===

<nowiki>
--[[
Script by Aexrael Dex
Replaces the starting general for a specific faction
]]

local function replace_starting_general()
if cm:is_new_game() then
-- The Empire
local faction_name = "wh_main_emp_empire"; -- Faction key from Factions table
local faction = cm:get_faction(faction_name);

if faction:is_null_interface() == false and faction:is_dead() == false then

-- Creating replacement for Karl Franz with a regular Empire General
local general_details = {
general_faction = faction_name,
unit_list = "wh_main_emp_cav_reiksguard,wh_main_emp_cav_reiksguard,wh_main_emp_cav_reiksguard"; -- unit keys from main_units table
region_key = faction:home_region():name(),
type = "general", -- Agent type
subtype = "emp_lord", -- Agent subtype
forename = "names_name_1904032251", -- From local_en names table, Bernhoff the Butcher is now ruler of Reikland
clanname = "", -- From local_en names table
surname = "names_name_151217003", -- From local_en names table
othername = "", -- From local_en names table
is_faction_leader = true, -- Bool for whether the general being replaced is the new faction leader
trait = "wh2_dlc09_trait_benevolence" -- The trait key you want to assign to the new General from character traits table
};

local general_x_pos, general_y_pos = cm:find_valid_spawn_location_for_character_from_settlement(general_details.general_faction, general_details.region_key, false, true, 8);
out(faction_name .. " home region name is " .. general_details.region_key);

cm:create_force_with_general(
general_details.general_faction,
general_details.unit_list,
general_details.region_key,
general_x_pos,
general_y_pos,
general_details.type,
general_details.subtype,
general_details.forename,
general_details.clanname,
general_details.surname,
general_details.othername,
general_details.is_faction_leader,

-- Generals created this way does not come with a trait normally
function(cqi)
local char_str = cm:char_lookup_str(cqi);

-- Adding a new trait to the above general
cm:force_add_trait(char_str, general_details.trait, true);
out("Adding Replacement General's trait");
end
);
out("Created replacement Lord " .. general_details.forename .. " for " .. faction_name);

-- Killing Karl Franz permanently
local char_list = faction:character_list();
local char_subtype = "emp_karl_franz"; -- Karl Franz's agent subtype
local char_forename = "names_name_2147343849"; -- Karl Franz's forename

for i = 0, char_list:num_items() - 1 do
local current_char = char_list:item_at(i);
local char_str = cm:char_lookup_str(current_char);

if current_char:is_null_interface() == false and current_char:character_subtype_key() == char_subtype and current_char:get_forename() == char_forename and current_char:has_military_force() == true then
cm:set_character_immortality(char_str, false);
cm:disable_event_feed_events(true, "wh_event_category_character", "", "");
cm:kill_character(current_char:command_queue_index(), true, true);
cm:callback(function() cm:disable_event_feed_events(false, "wh_event_category_character", "", "") end, 0.5);
out("Killing original " .. char_subtype .. " with forename " .. char_forename .. " for " .. faction_name .. " permanently");
end;
end;
end;
end;
end;

cm:add_first_tick_callback(function() replace_starting_general() end);</nowiki>

=== Adding RoRs to mercenary pool ===

<nowiki>--[[
Script by Aexrael Dex
Adds custom Regiments of Reknown to specified factions
]]

local function add_custom_ror()

-- Checking whether the script has already run for saved games and if it has then the script doesn't need to run again
if cm:get_saved_value("custom_ror_enabled") == nil then

-- Table for faction, unit key and parameters for add_unit_to_faction_mercenary_pool
local cror_list = {
{faction_key = "wh_main_vmp_schwartzhafen", unit = "wh2_dlc11_cst_inf_zombie_deckhands_mob_ror_0", count = 1, rcp = 100, munits = 1, murpt = 0.1, xplevel = 0, frr = "", srr = "", trr = "", replen = true},
{faction_key = "wh_main_vmp_vampire_counts", unit = "wh2_dlc11_cst_inf_zombie_deckhands_mob_ror_0", count = 1, rcp = 100, munits = 1, murpt = 0.1, xplevel = 0, frr = "", srr = "", trr = "", replen = true}
};

-- Loop for the table above
for i = 1, #cror_list do
local faction_name = cror_list[i].faction_key; -- Faction whose pool the unit(s) should be added to
local faction = cm:get_faction(faction_name); -- FACTION_SCRIPT_INTERFACE
local unit_key = cror_list[i].unit; -- Key of unit to add to the mercenary pool, from the main_units table
local unit_count = cror_list[i].count; -- Number of units to add to the mercenary pool
local rcp = cror_list[i].rcp; -- Replenishment chance, as a percentage
local munits = cror_list[i].munits; -- The maximum number of units of the supplied type that the pool is allowed to contain.
local murpt = cror_list[i].murpt; -- The maximum number of units of the supplied type that may be added by replenishment per-turn
local xplevel = cror_list[i].xplevel; -- The experience level of the units when recruited
local frr = cror_list[i].frr; -- (may be empty) The key of the faction who can actually recruit the units, from the factions database table
local srr = cror_list[i].srr; -- (may be empty) The key of the subculture who can actually recruit the units, from the cultures_subcultures database table
local trr = cror_list[i].trr; -- (may be empty) The key of a technology that must be researched in order to recruit the units, from the technologies database table
local replen = cror_list[i].replen; -- Allow replenishment of partial units

-- Adding the listed unit to the listed faction in the above table
cm:add_unit_to_faction_mercenary_pool(faction, unit_key, unit_count, rcp, munits, murpt, xplevel, frr, srr, trr, replen);

-- Debug message for log
out("CROR: adding the custom ror unit " .. unit_key .. " to " .. faction_name);
end;

-- Setting saved value, so that the script doesn't run again when reloaded from a saved game
cm:set_saved_value("custom_ror_enabled", true);
end;
end;

cm:add_first_tick_callback(function() add_custom_ror() end);</nowiki>

=== Replacing Starting Armies ===

<nowiki>--[[
Script by Aexrael Dex
Replaces the starting units for specified starting Lords
]]

local function army_tweaks()

-- Checking whether it's a new game, we don't want to replace armies in the middle of a campaign
if cm:is_new_game() then

-- Creating a table with entries for the various starting Lords, their Faction key from Factions table, subtype key from agent_subtypes, Forename from names table and Unit List with keys from Main Units
local starting_army = {
-- Vlad, Carsteins
{faction_key = "wh_main_vmp_schwartzhafen", subtype = "dlc04_vmp_vlad_con_carstein", forename = "names_name_2147345130", units = {"wh_main_vmp_inf_skeleton_warriors_0", "wh_main_vmp_inf_skeleton_warriors_0", "wh_main_vmp_mon_fell_bats", "wh_main_vmp_mon_fell_bats", "wh_main_vmp_cav_black_knights_0", "wh_main_vmp_cav_black_knights_0"}},
-- Isabella, Carsteins
{faction_key = "wh_main_vmp_schwartzhafen", subtype = "pro02_vmp_isabella_von_carstein", forename = "names_name_2147345124", units = {"wh_main_vmp_inf_zombie", "wh_main_vmp_inf_zombie", "wh_main_vmp_mon_dire_wolves", "wh_main_vmp_mon_dire_wolves", "wh_main_vmp_mon_fell_bats", "wh_main_vmp_mon_vargheists"}}
};

for i = 1, #starting_army do
local faction_name = starting_army[i].faction_key;
local faction = cm:get_faction(faction_name);
local char_list = faction:character_list();
local general_subtype = starting_army[i].subtype;
local general_forename = starting_army[i].forename;
local unit_list = starting_army[i].units;

for j = 0, char_list:num_items() - 1 do
local current_char = char_list:item_at(j);
local char_str = cm:char_lookup_str(current_char);

if current_char:is_null_interface() == false and current_char:character_subtype_key() == general_subtype and current_char:get_forename() == general_forename and current_char:has_military_force() == true then

-- Removing all existing units from the General
cm:remove_all_units_from_general(current_char);
out("ARMY: Removing starting units from " .. general_subtype .. " with forename " .. general_forename);

for k = 1, #unit_list do
local unit = unit_list[k];

-- Granting new units to the General
cm:grant_unit_to_character(char_str, unit);
out("ARMY: Adding new starting units to " .. general_subtype .. " with forename " .. general_forename);
end;
end;
end;
end;
end;
end;

cm:add_first_tick_callback(function() army_tweaks() end);</nowiki>

=== Changing CAI based on chosen campaign difficulty ===

<nowiki>--[[
Script by Aexrael Dex
Replaces the Campaign AI Personality for specific factions depending on the chosen campaign difficulty level
]]

local function replace_cai_difficulty()
if cm:is_new_game() == true then
local difficulty_str = cm:get_difficulty(true);
local def_personality = "";
local hef_personality = "";
local wef_personality = "";

-- CAI personality to use for easy difficulty
if difficulty_str == "easy" then

def_personality = "wh2_darkelf_early_easy";
hef_personality = "wh2_highelf_early_easy";
wef_personality = "wh_dlc05_wood_elves_default_main";

-- CAI personality to use for normal difficulty
elseif difficulty_str == "normal" then

def_personality = "wh2_darkelf_early";
hef_personality = "wh2_highelf_early";
wef_personality = "wh_dlc05_wood_elves_default_main";

-- CAI personality to use for hard difficulty
elseif difficulty_str == "hard" then

def_personality = "wh2_darkelf_early_hard";
hef_personality = "wh2_highelf_early_hard";
wef_personality = "wh_dlc05_wood_elves_default_main";

-- CAI personality to use for very hard difficulty
elseif difficulty_str == "very hard" then

def_personality = "wh2_darkelf_early_hard";
hef_personality = "wh2_highelf_early_hard";
wef_personality = "wh_dlc05_wood_elves_default_main";

-- CAI personality to use for legendary difficulty
elseif difficulty_str == "legendary" then

def_personality = "wh2_darkelf_early_hard";
hef_personality = "wh2_highelf_early_hard";
wef_personality = "wh_dlc05_wood_elves_default_main";
end;

local faction_list = cm:model():world():faction_list();

for i = 0, faction_list:num_items() - 1 do
local faction = faction_list:item_at(i);
local faction_name = faction:name();
local faction_culture = faction:culture();

-- Checking whetether the faction exists and is alive
if faction:is_null_interface() == false and faction:is_dead() == false and faction:is_human() == false then

-- Dark Elves culture
if faction_culture == "wh2_main_def_dark_elves" then

-- Changing the CAI for all Dark Elf factions
cm:force_change_cai_faction_personality(faction_name, def_personality);
out("ELF: Changing CAI personality for " .. faction_name .. " to " .. def_personality .. " on " .. difficulty_str .. " difficulty");

-- High Elves culture
elseif faction_culture == "wh2_main_hef_high_elves" then

-- Changing the CAI for all High Elf factions
cm:force_change_cai_faction_personality(faction_name, hef_personality);
out("ELF: Changing CAI personality for " .. faction_name .. " to " .. hef_personality .. " on " .. difficulty_str .. " difficulty");

-- Wood Elves culture
elseif faction_culture == "wh_dlc05_wef_wood_elves" then

-- Changing the CAI for all Wood Elf factions
cm:force_change_cai_faction_personality(faction_name, wef_personality);
out("ELF: Changing CAI personality for " .. faction_name .. " to " .. wef_personality .. " on " .. difficulty_str .. " difficulty");
end;
end;
end;
end;
end;

cm:add_first_tick_callback(function() replace_cai_difficulty() end);</nowiki>

=== Spawning a Unique Agent ===

<nowiki>
--[[
Script by Aexrael Dex
Spawns a Unique Agent next to the starting lord of a specified faction
]]

local function add_unique_agent()

-- Checking whether the script has already run for saved games and if it has then the script doesn't need to run again
if cm:get_saved_value("unique_agent_enabled") == nil then

-- Starting agent setup
unique_agent_setup();
end;
end;

function unique_agent_setup()
-- Agent Details
local agent_details = {
faction_str = "wh2_dlc13_emp_the_huntmarshals_expedition", -- faction_key from factions
forename_key = "names_name_2147359013", -- forename_key from names
family_name_key = "names_name_1535812850", -- family_name_key from names
subtype_key = "wh2_dlc13_emp_hunter_jorek_grimm", -- agent subtype_key from agent_subtypes
art_set_key = "wh2_dlc13_art_set_emp_hunter_jorek_grimm_0", -- agent art_set_id from campaign_character_arts
unique_string = "wh2_dlc13_emp_hunter_jorek_grimm", -- unique agent string from unique_agents
saved_value = "unique_agent_enabled", -- saved_value string
trait = "wh2_dlc09_trait_benevolence" -- agent trait from character_traits
};

-- Monitor activated, listening for FactionTurnStart for The Huntmarshals Expedition
core:add_listener(
"unique_agent_setup",
"FactionTurnStart",
function(context)
return context:faction():name() == agent_details.faction_str;
end,
function(context)
-- Spawning Jorek as a unique agent next to Markus
local faction = cm:get_faction(agent_details.faction_str);
local faction_cqi = faction:command_queue_index();
local faction_leader_cqi = faction:faction_leader():command_queue_index();

cm:disable_event_feed_events(true, "wh_event_category_agent", "", "");
cm:spawn_unique_agent_at_character(
faction_cqi,
agent_details.unique_string,
faction_leader_cqi,
true
);
cm:callback(function()
cm:disable_event_feed_events(false, "wh_event_category_agent", "", "");
CampaignUI.ClearSelection();
end, 0.5);
out("UNIQ: Spawned Jorek next to Markus");

-- Looping through the character list for The Empire
local char_list = faction:character_list();

for i = 0, char_list:num_items() - 1 do
local current_char = char_list:item_at(i);
local char_str = cm:char_lookup_str(current_char);

-- Adding Joreks trait, replenishing AP and overriding the art set
if current_char:is_null_interface() == false and current_char:character_subtype_key() == agent_details.subtype_key then

-- Adding trait
cm:force_add_trait(char_str, agent_details.trait, false);
out("UNIQ: Adding " .. agent_details.trait .. " to Jorek");

-- Replenishing action points
cm:replenish_action_points(char_str);
out("UNIQ: Replenishing the action points of Jorek");

-- Failsafe for the random chance that the art_set doesn't apply properly
cm:add_unit_model_overrides(char_str, agent_details.art_set_key);
out("UNIQ: Adding unit model override for Jorek");
end;
end;

-- Setting saved value, so that the script doesn't run again when reloaded from a saved game
cm:set_saved_value(agent_details.saved_value, true);
out("UNIQ: Setting saved value " .. agent_details.saved_value);
end,
false
);
end;

cm:add_first_tick_callback(function() add_unique_agent() end);</nowiki>

Example Scripts

2021-02-03T12:23:32Z

Aexrael:

A list of example scripts that can easily be copied, edited and then put into a [[Mods|mod]].

== Using Example Scripts ==
Unless otherwise stated these scripts go into a .pack file at `script/campaign/mod/?.lua`, replace ? with whatever your file name is.

Each script listed is self-contained - so you can use multiple of the example scripts in a single .lua file.

When using the scripts, please keep the credits at the top and don't remove comments. Comments are the text following -- or in a comment block denoted by --[[ Text here ]].

Typically an example script will have a list of variables that should be changed to tailor the script to your particular mod, these will often have comments next to them explaining where you will find the keys or values from.

Example in the Replace Starting General example script, you have a line that reads 'local faction_name = "wh_main_emp_empire";'

This could instead be changed to 'local faction_name = "wh2_dlc11_vmp_the_barrow_legion";' to affect the Barrow Legion faction instead of The Empire.

If there are out() calls within the example script, you are encouraged to insert a unique text identifier, so you can find your unique output in the [[Script logging|script logs]] using ctrl+f.

Example in the Replacing Starting General Script, replace REPLAC: with your unique identifier, maybe the starting letters of your discord username, or the mod name or the name of your cat, or something else unique to you.

== Contributing new scripts ==
If you have some generic scripted functionality you think would be useful for the wider community, please consider adding it to the wiki here, or bring attention to it via Modding Discord in the channel for the wiki.

Add a new Sub-Heading 1 within the Example Scripts section below, give it a meaningful title and a short description. Include what games it is valid for and any specific notes necessary, ie. has to go in this directory, has to be done this way etc.

Avoid using global variables in the example scripts, use local variables and local functions to avoid incidents involving scripts that have overlapping names. Make sure to use comments explaining what the various parts of the script is doing or when referring to specific keys from the database, like where to find them. Context and explanation goes a long way towards helping make sense of the scripts for beginners.

If your script runs through a single init function that's triggered through a first tick callback, give the local function a meaningful name and implement the first-tick-callback, and leave it at that. No need to have the modder replace the local function name in their own replication.

Mind that plopping something in this page leaves it open for collaboration, so someone in the future may come in and add more comments, change anything necessary for an update, make an extra version for another game, or much else. If you're editing the original script, leave the credits the same, or add your name to the credits if you think the addition is meaningful. Don't remove the OG author for sure.

== Example Scripts ==

=== Replacing a Starting General ===

<nowiki>
--[[
Script by Aexrael Dex
Replaces the starting general for a specific faction
]]

local function replace_starting_general()
if cm:is_new_game() then
-- The Empire
local faction_name = "wh_main_emp_empire"; -- Faction key from Factions table
local faction = cm:get_faction(faction_name);

if faction:is_null_interface() == false and faction:is_dead() == false then

-- Creating replacement for Karl Franz with a regular Empire General
local general_details = {
general_faction = faction_name,
unit_list = "wh_main_emp_cav_reiksguard,wh_main_emp_cav_reiksguard,wh_main_emp_cav_reiksguard"; -- unit keys from main_units table
region_key = faction:home_region():name(),
type = "general", -- Agent type
subtype = "emp_lord", -- Agent subtype
forename = "names_name_1904032251", -- From local_en names table, Bernhoff the Butcher is now ruler of Reikland
clanname = "", -- From local_en names table
surname = "names_name_151217003", -- From local_en names table
othername = "", -- From local_en names table
is_faction_leader = true, -- Bool for whether the general being replaced is the new faction leader
trait = "wh2_dlc09_trait_benevolence" -- The trait key you want to assign to the new General from character traits table
};

local general_x_pos, general_y_pos = cm:find_valid_spawn_location_for_character_from_settlement(general_details.general_faction, general_details.region_key, false, true, 8);
out(faction_name .. " home region name is " .. general_details.region_key);

cm:create_force_with_general(
general_details.general_faction,
general_details.unit_list,
general_details.region_key,
general_x_pos,
general_y_pos,
general_details.type,
general_details.subtype,
general_details.forename,
general_details.clanname,
general_details.surname,
general_details.othername,
general_details.is_faction_leader,

-- Generals created this way does not come with a trait normally
function(cqi)
local char_str = cm:char_lookup_str(cqi);

-- Adding a new trait to the above general
cm:force_add_trait(char_str, general_details.trait, true);
out("Adding Replacement General's trait");
end
);
out("Created replacement Lord " .. general_details.forename .. " for " .. faction_name);

-- Killing Karl Franz permanently
local char_list = faction:character_list();
local char_subtype = "emp_karl_franz"; -- Karl Franz's agent subtype
local char_forename = "names_name_2147343849"; -- Karl Franz's forename

for i = 0, char_list:num_items() - 1 do
local current_char = char_list:item_at(i);
local char_str = cm:char_lookup_str(current_char);

if current_char:is_null_interface() == false and current_char:character_subtype_key() == char_subtype and current_char:get_forename() == char_forename and current_char:has_military_force() == true then
cm:set_character_immortality(char_str, false);
cm:disable_event_feed_events(true, "wh_event_category_character", "", "");
cm:kill_character(current_char:command_queue_index(), true, true);
cm:callback(function() cm:disable_event_feed_events(false, "wh_event_category_character", "", "") end, 0.5);
out("Killing original " .. char_subtype .. " with forename " .. char_forename .. " for " .. faction_name .. " permanently");
end;
end;
end;
end;
end;

cm:add_first_tick_callback(function() replace_starting_general() end);</nowiki>

=== Adding RoRs to mercenary pool ===

<nowiki>--[[
Script by Aexrael Dex
Adds custom Regiments of Reknown to specified factions
]]

local function add_custom_ror()

-- Checking whether the script has already run for saved games and if it has then the script doesn't need to run again
if cm:get_saved_value("custom_ror_enabled") == nil then

-- Table for faction, unit key and parameters for add_unit_to_faction_mercenary_pool
local cror_list = {
{faction_key = "wh_main_vmp_schwartzhafen", unit = "wh2_dlc11_cst_inf_zombie_deckhands_mob_ror_0", count = 1, rcp = 100, munits = 1, murpt = 0.1, xplevel = 0, frr = "", srr = "", trr = "", replen = true},
{faction_key = "wh_main_vmp_vampire_counts", unit = "wh2_dlc11_cst_inf_zombie_deckhands_mob_ror_0", count = 1, rcp = 100, munits = 1, murpt = 0.1, xplevel = 0, frr = "", srr = "", trr = "", replen = true}
};

-- Loop for the table above
for i = 1, #cror_list do
local faction_name = cror_list[i].faction_key; -- Faction whose pool the unit(s) should be added to
local faction = cm:get_faction(faction_name); -- FACTION_SCRIPT_INTERFACE
local unit_key = cror_list[i].unit; -- Key of unit to add to the mercenary pool, from the main_units table
local unit_count = cror_list[i].count; -- Number of units to add to the mercenary pool
local rcp = cror_list[i].rcp; -- Replenishment chance, as a percentage
local munits = cror_list[i].munits; -- The maximum number of units of the supplied type that the pool is allowed to contain.
local murpt = cror_list[i].murpt; -- The maximum number of units of the supplied type that may be added by replenishment per-turn
local xplevel = cror_list[i].xplevel; -- The experience level of the units when recruited
local frr = cror_list[i].frr; -- (may be empty) The key of the faction who can actually recruit the units, from the factions database table
local srr = cror_list[i].srr; -- (may be empty) The key of the subculture who can actually recruit the units, from the cultures_subcultures database table
local trr = cror_list[i].trr; -- (may be empty) The key of a technology that must be researched in order to recruit the units, from the technologies database table
local replen = cror_list[i].replen; -- Allow replenishment of partial units

-- Adding the listed unit to the listed faction in the above table
cm:add_unit_to_faction_mercenary_pool(faction, unit_key, unit_count, rcp, munits, murpt, xplevel, frr, srr, trr, replen);

-- Debug message for log
out("CROR: adding the custom ror unit " .. unit_key .. " to " .. faction_name);
end;

-- Setting saved value, so that the script doesn't run again when reloaded from a saved game
cm:set_saved_value("custom_ror_enabled", true);
end;
end;

cm:add_first_tick_callback(function() add_custom_ror() end);</nowiki>

=== Replacing Starting Armies ===

<nowiki>--[[
Script by Aexrael Dex
Replaces the starting units for specified starting Lords
]]

local function army_tweaks()

-- Checking whether it's a new game, we don't want to replace armies in the middle of a campaign
if cm:is_new_game() then

-- Creating a table with entries for the various starting Lords, their Faction key from Factions table, subtype key from agent_subtypes, Forename from names table and Unit List with keys from Main Units
local starting_army = {
-- Vlad, Carsteins
{faction_key = "wh_main_vmp_schwartzhafen", subtype = "dlc04_vmp_vlad_con_carstein", forename = "names_name_2147345130", units = {"wh_main_vmp_inf_skeleton_warriors_0", "wh_main_vmp_inf_skeleton_warriors_0", "wh_main_vmp_mon_fell_bats", "wh_main_vmp_mon_fell_bats", "wh_main_vmp_cav_black_knights_0", "wh_main_vmp_cav_black_knights_0"}},
-- Isabella, Carsteins
{faction_key = "wh_main_vmp_schwartzhafen", subtype = "pro02_vmp_isabella_von_carstein", forename = "names_name_2147345124", units = {"wh_main_vmp_inf_zombie", "wh_main_vmp_inf_zombie", "wh_main_vmp_mon_dire_wolves", "wh_main_vmp_mon_dire_wolves", "wh_main_vmp_mon_fell_bats", "wh_main_vmp_mon_vargheists"}}
};

for i = 1, #starting_army do
local faction_name = starting_army[i].faction_key;
local faction = cm:get_faction(faction_name);
local char_list = faction:character_list();
local general_subtype = starting_army[i].subtype;
local general_forename = starting_army[i].forename;
local unit_list = starting_army[i].units;

for j = 0, char_list:num_items() - 1 do
local current_char = char_list:item_at(j);
local char_str = cm:char_lookup_str(current_char);

if current_char:is_null_interface() == false and current_char:character_subtype_key() == general_subtype and current_char:get_forename() == general_forename and current_char:has_military_force() == true then

-- Removing all existing units from the General
cm:remove_all_units_from_general(current_char);
out("ARMY: Removing starting units from " .. general_subtype .. " with forename " .. general_forename);

for k = 1, #unit_list do
local unit = unit_list[k];

-- Granting new units to the General
cm:grant_unit_to_character(char_str, unit);
out("ARMY: Adding new starting units to " .. general_subtype .. " with forename " .. general_forename);
end;
end;
end;
end;
end;
end;

cm:add_first_tick_callback(function() army_tweaks() end);</nowiki>

=== Changing CAI based on chosen campaign difficulty ===

<nowiki>--[[
Script by Aexrael Dex
Replaces the Campaign AI Personality for specific factions depending on the chosen campaign difficulty level
]]

local function replace_cai_difficulty()
if cm:is_new_game() == true then
local difficulty_str = cm:get_difficulty(true);
local def_personality = "";
local hef_personality = "";
local wef_personality = "";

-- CAI personality to use for easy difficulty
if difficulty_str == "easy" then

def_personality = "wh2_darkelf_early_easy";
hef_personality = "wh2_highelf_early_easy";
wef_personality = "wh_dlc05_wood_elves_default_main";

-- CAI personality to use for normal difficulty
elseif difficulty_str == "normal" then

def_personality = "wh2_darkelf_early";
hef_personality = "wh2_highelf_early";
wef_personality = "wh_dlc05_wood_elves_default_main";

-- CAI personality to use for hard difficulty
elseif difficulty_str == "hard" then

def_personality = "wh2_darkelf_early_hard";
hef_personality = "wh2_highelf_early_hard";
wef_personality = "wh_dlc05_wood_elves_default_main";

-- CAI personality to use for very hard difficulty
elseif difficulty_str == "very hard" then

def_personality = "wh2_darkelf_early_hard";
hef_personality = "wh2_highelf_early_hard";
wef_personality = "wh_dlc05_wood_elves_default_main";

-- CAI personality to use for legendary difficulty
elseif difficulty_str == "legendary" then

def_personality = "wh2_darkelf_early_hard";
hef_personality = "wh2_highelf_early_hard";
wef_personality = "wh_dlc05_wood_elves_default_main";
end;

local faction_list = cm:model():world():faction_list();

for i = 0, faction_list:num_items() - 1 do
local faction = faction_list:item_at(i);
local faction_name = faction:name();
local faction_culture = faction:culture();

-- Checking whetether the faction exists and is alive
if faction:is_null_interface() == false and faction:is_dead() == false and faction:is_human() == false then

-- Dark Elves culture
if faction_culture == "wh2_main_def_dark_elves" then

-- Changing the CAI for all Dark Elf factions
cm:force_change_cai_faction_personality(faction_name, def_personality);
out("ELF: Changing CAI personality for " .. faction_name .. " to " .. def_personality .. " on " .. difficulty_str .. " difficulty");

-- High Elves culture
elseif faction_culture == "wh2_main_hef_high_elves" then

-- Changing the CAI for all High Elf factions
cm:force_change_cai_faction_personality(faction_name, hef_personality);
out("ELF: Changing CAI personality for " .. faction_name .. " to " .. hef_personality .. " on " .. difficulty_str .. " difficulty");

-- Wood Elves culture
elseif faction_culture == "wh_dlc05_wef_wood_elves" then

-- Changing the CAI for all Wood Elf factions
cm:force_change_cai_faction_personality(faction_name, wef_personality);
out("ELF: Changing CAI personality for " .. faction_name .. " to " .. wef_personality .. " on " .. difficulty_str .. " difficulty");
end;
end;
end;
end;
end;

cm:add_first_tick_callback(function() replace_cai_difficulty() end);</nowiki>

Example Scripts

2021-02-03T12:23:05Z

Aexrael:

A list of example scripts that can easily be copied, edited and then put into a [[Mods|mod]].

== Using Example Scripts ==
Unless otherwise stated these scripts go into a .pack file at `script/campaign/mod/?.lua`, replace ? with whatever your file name is.

Each script listed is self-contained - so you can use multiple of the example scripts in a single .lua file.

When using the scripts, please keep the credits at the top and don't remove comments. Comments are the text following -- or in a comment block denoted by --[[ Text here ]].

Typically an example script will have a list of variables that should be changed to tailor the script to your particular mod, these will often have comments next to them explaining where you will find the keys or values from.

Example in the Replace Starting General example script, you have a line that reads 'local faction_name = "wh_main_emp_empire";'

This could instead be changed to 'local faction_name = "wh2_dlc11_vmp_the_barrow_legion";' to affect the Barrow Legion faction instead of The Empire.

If there are out() calls within the example script, you are encouraged to insert a unique text identifier, so you can find your unique output in the [[Script logging|script logs]] using ctrl+f.

Example in the Replacing Starting General Script, replace REPLAC: with your unique identifier, maybe the starting letters of your discord username, or the mod name or the name of your cat, or something else unique to you.

== Contributing new scripts ==
If you have some generic scripted functionality you think would be useful for the wider community, please consider adding it to the wiki here, or bring attention to it via Modding Discord in the channel for the wiki.

Add a new Sub-Heading 1 within the Example Scripts section below, give it a meaningful title and a short description. Include what games it is valid for and any specific notes necessary, ie. has to go in this directory, has to be done this way etc.

Avoid using global variables in the example scripts, use local variables and local functions to avoid incidents involving scripts that have overlapping names. Make sure to use comments explaining what the various parts of the script is doing or when referring to specific keys from the database, like where to find them. Context and explanation goes a long way towards helping make sense of the scripts for beginners.

If your script runs through a single init function that's triggered through a first tick callback, give the local function a meaningful name and implement the first-tick-callback, and leave it at that. No need to have the modder replace the local function name in their own replication.

Mind that plopping something in this page leaves it open for collaboration, so someone in the future may come in and add more comments, change anything necessary for an update, make an extra version for another game, or much else. If you're editing the original script, leave the credits the same, or add your name to the credits if you think the addition is meaningful. Don't remove the OG author for sure.

== Example Scripts ==

=== Replacing a Starting General ===

<nowiki>
--[[
Script by Aexrael Dex
Replaces the starting general for a specific faction
]]

local function replace_starting_general()
if cm:is_new_game() then
-- The Empire
local faction_name = "wh_main_emp_empire"; -- Faction key from Factions table
local faction = cm:get_faction(faction_name);

if faction:is_null_interface() == false and faction:is_dead() == false then

-- Creating replacement for Karl Franz with a regular Empire General
local general_details = {
general_faction = faction_name,
unit_list = "wh_main_emp_cav_reiksguard,wh_main_emp_cav_reiksguard,wh_main_emp_cav_reiksguard"; -- unit keys from main_units table
region_key = faction:home_region():name(),
type = "general", -- Agent type
subtype = "emp_lord", -- Agent subtype
forename = "names_name_1904032251", -- From local_en names table, Bernhoff the Butcher is now ruler of Reikland
clanname = "", -- From local_en names table
surname = "names_name_151217003", -- From local_en names table
othername = "", -- From local_en names table
is_faction_leader = true, -- Bool for whether the general being replaced is the new faction leader
trait = "wh2_dlc09_trait_benevolence" -- The trait key you want to assign to the new General from character traits table
};

local general_x_pos, general_y_pos = cm:find_valid_spawn_location_for_character_from_settlement(general_details.general_faction, general_details.region_key, false, true, 8);
out(faction_name .. " home region name is " .. general_details.region_key);

cm:create_force_with_general(
general_details.general_faction,
general_details.unit_list,
general_details.region_key,
general_x_pos,
general_y_pos,
general_details.type,
general_details.subtype,
general_details.forename,
general_details.clanname,
general_details.surname,
general_details.othername,
general_details.is_faction_leader,

-- Generals created this way does not come with a trait normally
function(cqi)
local char_str = cm:char_lookup_str(cqi);

-- Adding a new trait to the above general
cm:force_add_trait(char_str, general_details.trait, true);
out("Adding Replacement General's trait");
end
);
out("Created replacement Lord " .. general_details.forename .. " for " .. faction_name);

-- Killing Karl Franz permanently
local char_list = faction:character_list();
local char_subtype = "emp_karl_franz"; -- Karl Franz's agent subtype
local char_forename = "names_name_2147343849"; -- Karl Franz's forename

for i = 0, char_list:num_items() - 1 do
local current_char = char_list:item_at(i);
local char_str = cm:char_lookup_str(current_char);

if current_char:is_null_interface() == false and current_char:character_subtype_key() == char_subtype and current_char:get_forename() == char_forename and current_char:has_military_force() == true then
cm:set_character_immortality(char_str, false);
cm:disable_event_feed_events(true, "wh_event_category_character", "", "");
cm:kill_character(current_char:command_queue_index(), true, true);
cm:callback(function() cm:disable_event_feed_events(false, "wh_event_category_character", "", "") end, 0.5);
out("Killing original " .. char_subtype .. " with forename " .. char_forename .. " for " .. faction_name .. " permanently");
end;
end;
end;
end;
end;

cm:add_first_tick_callback(function() replace_starting_general() end);</nowiki>

=== Adding custom RoRs to mercenary pool ===

<nowiki>--[[
Script by Aexrael Dex
Adds custom Regiments of Reknown to specified factions
]]

local function add_custom_ror()

-- Checking whether the script has already run for saved games and if it has then the script doesn't need to run again
if cm:get_saved_value("custom_ror_enabled") == nil then

-- Table for faction, unit key and parameters for add_unit_to_faction_mercenary_pool
local cror_list = {
{faction_key = "wh_main_vmp_schwartzhafen", unit = "wh2_dlc11_cst_inf_zombie_deckhands_mob_ror_0", count = 1, rcp = 100, munits = 1, murpt = 0.1, xplevel = 0, frr = "", srr = "", trr = "", replen = true},
{faction_key = "wh_main_vmp_vampire_counts", unit = "wh2_dlc11_cst_inf_zombie_deckhands_mob_ror_0", count = 1, rcp = 100, munits = 1, murpt = 0.1, xplevel = 0, frr = "", srr = "", trr = "", replen = true}
};

-- Loop for the table above
for i = 1, #cror_list do
local faction_name = cror_list[i].faction_key; -- Faction whose pool the unit(s) should be added to
local faction = cm:get_faction(faction_name); -- FACTION_SCRIPT_INTERFACE
local unit_key = cror_list[i].unit; -- Key of unit to add to the mercenary pool, from the main_units table
local unit_count = cror_list[i].count; -- Number of units to add to the mercenary pool
local rcp = cror_list[i].rcp; -- Replenishment chance, as a percentage
local munits = cror_list[i].munits; -- The maximum number of units of the supplied type that the pool is allowed to contain.
local murpt = cror_list[i].murpt; -- The maximum number of units of the supplied type that may be added by replenishment per-turn
local xplevel = cror_list[i].xplevel; -- The experience level of the units when recruited
local frr = cror_list[i].frr; -- (may be empty) The key of the faction who can actually recruit the units, from the factions database table
local srr = cror_list[i].srr; -- (may be empty) The key of the subculture who can actually recruit the units, from the cultures_subcultures database table
local trr = cror_list[i].trr; -- (may be empty) The key of a technology that must be researched in order to recruit the units, from the technologies database table
local replen = cror_list[i].replen; -- Allow replenishment of partial units

-- Adding the listed unit to the listed faction in the above table
cm:add_unit_to_faction_mercenary_pool(faction, unit_key, unit_count, rcp, munits, murpt, xplevel, frr, srr, trr, replen);

-- Debug message for log
out("CROR: adding the custom ror unit " .. unit_key .. " to " .. faction_name);
end;

-- Setting saved value, so that the script doesn't run again when reloaded from a saved game
cm:set_saved_value("custom_ror_enabled", true);
end;
end;

cm:add_first_tick_callback(function() add_custom_ror() end);</nowiki>

=== Replacing Starting Armies ===

<nowiki>--[[
Script by Aexrael Dex
Replaces the starting units for specified starting Lords
]]

local function army_tweaks()

-- Checking whether it's a new game, we don't want to replace armies in the middle of a campaign
if cm:is_new_game() then

-- Creating a table with entries for the various starting Lords, their Faction key from Factions table, subtype key from agent_subtypes, Forename from names table and Unit List with keys from Main Units
local starting_army = {
-- Vlad, Carsteins
{faction_key = "wh_main_vmp_schwartzhafen", subtype = "dlc04_vmp_vlad_con_carstein", forename = "names_name_2147345130", units = {"wh_main_vmp_inf_skeleton_warriors_0", "wh_main_vmp_inf_skeleton_warriors_0", "wh_main_vmp_mon_fell_bats", "wh_main_vmp_mon_fell_bats", "wh_main_vmp_cav_black_knights_0", "wh_main_vmp_cav_black_knights_0"}},
-- Isabella, Carsteins
{faction_key = "wh_main_vmp_schwartzhafen", subtype = "pro02_vmp_isabella_von_carstein", forename = "names_name_2147345124", units = {"wh_main_vmp_inf_zombie", "wh_main_vmp_inf_zombie", "wh_main_vmp_mon_dire_wolves", "wh_main_vmp_mon_dire_wolves", "wh_main_vmp_mon_fell_bats", "wh_main_vmp_mon_vargheists"}}
};

for i = 1, #starting_army do
local faction_name = starting_army[i].faction_key;
local faction = cm:get_faction(faction_name);
local char_list = faction:character_list();
local general_subtype = starting_army[i].subtype;
local general_forename = starting_army[i].forename;
local unit_list = starting_army[i].units;

for j = 0, char_list:num_items() - 1 do
local current_char = char_list:item_at(j);
local char_str = cm:char_lookup_str(current_char);

if current_char:is_null_interface() == false and current_char:character_subtype_key() == general_subtype and current_char:get_forename() == general_forename and current_char:has_military_force() == true then

-- Removing all existing units from the General
cm:remove_all_units_from_general(current_char);
out("ARMY: Removing starting units from " .. general_subtype .. " with forename " .. general_forename);

for k = 1, #unit_list do
local unit = unit_list[k];

-- Granting new units to the General
cm:grant_unit_to_character(char_str, unit);
out("ARMY: Adding new starting units to " .. general_subtype .. " with forename " .. general_forename);
end;
end;
end;
end;
end;
end;

cm:add_first_tick_callback(function() army_tweaks() end);</nowiki>

=== Changing CAI based on chosen campaign difficulty ===

<nowiki>--[[
Script by Aexrael Dex
Replaces the Campaign AI Personality for specific factions depending on the chosen campaign difficulty level
]]

local function replace_cai_difficulty()
if cm:is_new_game() == true then
local difficulty_str = cm:get_difficulty(true);
local def_personality = "";
local hef_personality = "";
local wef_personality = "";

-- CAI personality to use for easy difficulty
if difficulty_str == "easy" then

def_personality = "wh2_darkelf_early_easy";
hef_personality = "wh2_highelf_early_easy";
wef_personality = "wh_dlc05_wood_elves_default_main";

-- CAI personality to use for normal difficulty
elseif difficulty_str == "normal" then

def_personality = "wh2_darkelf_early";
hef_personality = "wh2_highelf_early";
wef_personality = "wh_dlc05_wood_elves_default_main";

-- CAI personality to use for hard difficulty
elseif difficulty_str == "hard" then

def_personality = "wh2_darkelf_early_hard";
hef_personality = "wh2_highelf_early_hard";
wef_personality = "wh_dlc05_wood_elves_default_main";

-- CAI personality to use for very hard difficulty
elseif difficulty_str == "very hard" then

def_personality = "wh2_darkelf_early_hard";
hef_personality = "wh2_highelf_early_hard";
wef_personality = "wh_dlc05_wood_elves_default_main";

-- CAI personality to use for legendary difficulty
elseif difficulty_str == "legendary" then

def_personality = "wh2_darkelf_early_hard";
hef_personality = "wh2_highelf_early_hard";
wef_personality = "wh_dlc05_wood_elves_default_main";
end;

local faction_list = cm:model():world():faction_list();

for i = 0, faction_list:num_items() - 1 do
local faction = faction_list:item_at(i);
local faction_name = faction:name();
local faction_culture = faction:culture();

-- Checking whetether the faction exists and is alive
if faction:is_null_interface() == false and faction:is_dead() == false and faction:is_human() == false then

-- Dark Elves culture
if faction_culture == "wh2_main_def_dark_elves" then

-- Changing the CAI for all Dark Elf factions
cm:force_change_cai_faction_personality(faction_name, def_personality);
out("ELF: Changing CAI personality for " .. faction_name .. " to " .. def_personality .. " on " .. difficulty_str .. " difficulty");

-- High Elves culture
elseif faction_culture == "wh2_main_hef_high_elves" then

-- Changing the CAI for all High Elf factions
cm:force_change_cai_faction_personality(faction_name, hef_personality);
out("ELF: Changing CAI personality for " .. faction_name .. " to " .. hef_personality .. " on " .. difficulty_str .. " difficulty");

-- Wood Elves culture
elseif faction_culture == "wh_dlc05_wef_wood_elves" then

-- Changing the CAI for all Wood Elf factions
cm:force_change_cai_faction_personality(faction_name, wef_personality);
out("ELF: Changing CAI personality for " .. faction_name .. " to " .. wef_personality .. " on " .. difficulty_str .. " difficulty");
end;
end;
end;
end;
end;

cm:add_first_tick_callback(function() replace_cai_difficulty() end);</nowiki>

Example Scripts

2021-02-03T12:14:57Z

Aexrael:

Example Scripts

2021-02-03T12:04:42Z

Aexrael:

Example Scripts

2021-02-03T11:54:34Z

Aexrael:

Example Scripts

2021-02-03T11:54:19Z

Aexrael:

Example Scripts

2021-02-03T11:00:32Z

Aexrael:

A list of example scripts that can be easily copied, edited, and then pasted into a [[Mods|mod]] for quick functionality. Typically will have a block of variables to edit the values of for your own version.

== Using Example Scripts ==
Unless otherwise stated, these scripts go into a .pack file at `script/campaign/mod/?.lua`, replace ? with whatever your file name is.

Each script is self-contained - so you can use multiple in a single .lua file.

When using the scripts, please keep the credits at the top, and don't remove comments.

Typically, an example script will have a list of variables that should have the value changed, that are more or less self-explanatory. For instance:

`local unit_health = 100`

If you'd like to change the unit_health from 100 to, say, 7000000 you would simply replace the 100:

`local unit_health = 7000000`

If there are out() calls within the example script, you are encouraged to replace the text within to something more relevant for you, so you can find your output in the [[Script logging|script logs]].

== Making Example Scripts ==
If you have some scripted functionality you think would be useful, please bring it here! Add a new Sub-Heading 1 within the Example Scropts section below, give it a meaningful title, and a short description. Include what games it is valid for, and any notes necessary - ie., has to go in this directory, has to be done this way.

Please don't use any global variables in the example script you put below - use local variables all around, and direct the modder to which sections should and shouldn't be edited. The more commented the example is, the better - that way we can provide some context and explanation while also offering a valuable tool!

And keep complications to a minimum - if your script runs through a single init function that's triggered through a first tick callback, give the local function a meaningful name and implement the first-tick-callback, and leave it at that. No need to have the modder replace the local function name in their own replication, that only adds complications.

Mind that plopping something in this page leaves it open for collaboration, so someone in the future may come in and add more comments, change anything necessary for an update, make an extra version for another game, or much else. '''If you're editing the original script, leave the credits the same, or add your name to the credits if you think the addition is meaningful'''. Don't remove the OG author for sure.

== Example Scripts ==

=== Replacing a Starting General ===

<nowiki>
--[[
Script by Aexrael Dex
Replaces the starting general for a specific faction
]]

-- Rename replace_starting_general
local function replace_starting_general()
if cm:is_new_game() then

-- Creating replacement for Karl Franz with a regular Empire General
local general_faction_str = "wh_main_emp_empire"; -- faction key from factions table
local general_faction_obj = cm:get_faction(general_faction_str);
local general_unit_list = "wh_main_emp_cav_reiksguard,wh_main_emp_cav_reiksguard,wh_main_emp_cav_reiksguard"; -- unit keys from main_units table
local general_region_key = general_faction_obj:home_region():name(); -- the replacement general will spawn adjacent to the settlement in the home region for the faction
local general_x_pos, general_y_pos = cm:find_valid_spawn_location_for_character_from_settlement(
general_faction_str,
general_region_key,
false,
true
);
local general_type = "general"; -- agent type
local general_subtype = "emp_lord"; -- agent subtype
local general_forename = "names_name_1904032251"; -- from local_en names table, Bernhoff the Butcher is now ruler of Reikland
local general_clanname = ""; -- from local_en names table
local general_surname = ""; -- from local_en names table
local general_othername = ""; -- from local_en names table
local general_is_faction_leader = true; -- bool for whether the general being replaced is the new faction leader

cm:create_force_with_general(
general_faction_str,
general_unit_list,
general_region_key,
general_x_pos,
general_y_pos,
general_type,
general_subtype,
general_forename,
general_clanname,
general_surname,
general_othername,
general_is_faction_leader,

-- Generals created this way does not come with a trait and aren't immortal
function(cqi)
local char_str = cm:char_lookup_str(cqi);
-- Adding a new trait to the above general
cm:force_add_trait(char_str, "wh2_dlc09_trait_benevolence", true);
out("Adding a trait to " .. general_forename);

-- Making the new general immortal (!!Use Skill based immortality instead!!)
cm:set_character_immortality(char_str, true);
out("Making general with forename " .. general_forename .. " immortal");
end
);
out("Creating Neo_Karl Franz for Reikland");

-- Killing original Karl Franz
local char_list = general_faction_obj:character_list();
local leader_subtype = "emp_karl_franz"; -- Karl Franz's agent subtype
local leader_forename = "names_name_2147343849"; -- Karl Franz's forename

for i = 0, char_list:num_items() - 1 do
local current_char = char_list:item_at(i);

if current_char:is_null_interface() == false and current_char:character_subtype_key() == leader_subtype and current_char:get_forename() == leader_forename and current_char:has_military_force() == true then
cm:set_character_immortality("character_cqi:"..current_char:command_queue_index(), false); -- Removing Karl Franz's immortality
cm:disable_event_feed_events(true, "wh_event_category_character", "", ""); -- Disabling event feed messages for character related events
cm:kill_character(current_char:command_queue_index(), true, true); -- Killing Karl Franz
cm:callback(function() cm:disable_event_feed_events(false, "wh_event_category_character", "", "") end, 1); -- Enabling event feed messages for character related events
out("Killing original " .. leader_subtype .. " with forename " .. leader_forename .. " for " .. general_faction_str .. " permanently");
end;
end;
end;
end;

-- Rename replace_starting_general to match the function name at the top
cm:add_first_tick_callback(function() replace_starting_general() end);</nowiki>

=== Adding custom RoRs to mercenary pool ===

<nowiki>--[[
Script by Aexrael Dex
Adds custom Regiments of Reknown to defined factions
]]

local function cror_initiator()
-- Checking whether the script has already run for saved games and if it has then the script doesn't need to run again
if cm:get_saved_value("custom_ror_enabled") == nil then

-- Table for faction, unit key and parameters for add_unit_to_faction_mercenary_pool
local cror_list = {
{faction = "wh_main_vmp_schwartzhafen", unit = "wh2_dlc11_cst_inf_zombie_deckhands_mob_ror_0", count = 1, rcp = 100, munits = 1, murpt = 0.1, xplevel = 0, frr = "", srr = "", trr = "", replen = false},
{faction = "wh_main_vmp_vampire_counts", unit = "wh2_dlc11_cst_inf_zombie_deckhands_mob_ror_0", count = 1, rcp = 100, munits = 1, murpt = 0.1, xplevel = 0, frr = "", srr = "", trr = "", replen = false}
};

-- Loop for the table above
for i = 1, #cror_list do
local faction_str = cror_list[i].faction; -- Faction whose pool the unit(s) should be added to
local faction_obj = cm:get_faction(faction_str); -- FACTION_SCRIPT_INTERFACE faction
local unit_key = cror_list[i].unit; -- Key of unit to add to the mercenary pool, from the main_units table
local unit_count = cror_list[i].count; -- Number of units to add to the mercenary pool
local rcp = cror_list[i].rcp; -- Replenishment chance, as a percentage
local munits = cror_list[i].munits; -- The maximum number of units of the supplied type that the pool is allowed to contain.
local murpt = cror_list[i].murpt; -- The maximum number of units of the supplied type that may be added by replenishment per-turn
local xplevel = cror_list[i].xplevel; -- The experience level of the units when recruited
local frr = cror_list[i].frr; -- (may be empty) The key of the faction who can actually recruit the units, from the factions database table
local srr = cror_list[i].srr; -- (may be empty) The key of the subculture who can actually recruit the units, from the cultures_subcultures database table
local trr = cror_list[i].trr; -- (may be empty) The key of a technology that must be researched in order to recruit the units, from the technologies database table
local replen = cror_list[i].replen; -- Allow replenishment of partial units

-- Adding the listed unit to the listed faction in the above table
cm:add_unit_to_faction_mercenary_pool(faction_obj, unit_key, unit_count, rcp, munits, murpt, xplevel, frr, srr, trr, replen);

-- Setting saved value, so that the script doesn't run again when reloaded from a saved game
cm:set_saved_value("custom_ror_enabled", true);

-- Debug message for log
out("adding the custom ror unit " .. unit_key .. " to " .. faction_str);
end;
end;
end;

cm:add_first_tick_callback(function() cror_initiator() end);</nowiki>

=== Replacing Starting Armies ===

<nowiki>--[[
Script by Aexrael Dex
Replaces the starting units for the designated characters
]]

-- Rename edit_starting_army
local function edit_starting_army()
if cm:is_new_game() then
local custom_starting_army = {
-- Vlad, Carsteins
{faction = "wh_main_vmp_schwartzhafen", subtype = "dlc04_vmp_vlad_con_carstein", forename = "names_name_2147345130", units = {"wh_main_vmp_inf_skeleton_warriors_0", "wh_main_vmp_inf_skeleton_warriors_0", "wh_main_vmp_mon_fell_bats", "wh_main_vmp_mon_fell_bats", "wh_main_vmp_cav_black_knights_0", "wh_main_vmp_cav_black_knights_0"}},
-- Isabella, Carsteins
{faction = "wh_main_vmp_schwartzhafen", subtype = "pro02_vmp_isabella_von_carstein", forename = "names_name_2147345124", units = {"wh_main_vmp_inf_zombie", "wh_main_vmp_inf_zombie", "wh_main_vmp_mon_dire_wolves", "wh_main_vmp_mon_dire_wolves", "wh_main_vmp_mon_fell_bats", "wh_main_vmp_mon_vargheists"}}
};

for i = 1, #custom_starting_army do
local faction_str = custom_starting_army[i].faction;
local faction_obj = cm:get_faction(faction_str);
local char_list = faction_obj:character_list();
local general_subtype = custom_starting_army[i].subtype;
local general_forename = custom_starting_army[i].forename;
local unit_list = custom_starting_army[i].units;

for j = 0, char_list:num_items() - 1 do
local current_char = char_list:item_at(j);

if current_char:is_null_interface() == false and current_char:character_subtype_key() == general_subtype and current_char:get_forename() == general_forename and current_char:has_military_force() == true then
cm:remove_all_units_from_general(current_char);
out("Removing starting units from " .. general_subtype .. " with forename " .. general_forename);

for k = 1, #unit_list do
local unit = unit_list[k];
cm:grant_unit_to_character(cm:char_lookup_str(current_char:cqi()), unit);
out("Granting new starting units to " .. general_subtype .. " with forename " .. general_forename);
end;
end;
end;
end;
end;
end;

-- Rename edit_starting_army to match the function name at the top
cm:add_first_tick_callback(function() edit_starting_army() end);</nowiki>

Technology Trees

2021-02-01T22:18:05Z

Aexrael:

Modding technologies is very similar to modding Skills for agents.

== Overview of the tables ==

technology_node_sets_tables

technologies_tables

technology_effects_junction_tables

technology_node_links_tables

technology_nodes_tables

=== Technology Node Sets ===

Technology Node Sets table junctions a Technology Node Set Key with a Culture or Subculture, this is start possed?

=== Technology Table ===

The Technologies table defines the Technology Key used in the other tables, the icon shown in the tech tree and it also contains a unique identifier.

=== Technology Effects ===

The Technology Effects table is where you junction the Technology Key from the Technologies Table with the Effect Key from the Effects table, alongside a scope and a value for the effect.

=== Technology Nodes and Node Links ===

Technology nodes is where the technology key from the Technologies Table is junctioned to a faction’s technology node set key which defines.

The technology node set key is sadly, at this point of writing, locked behind the compiled startpos and it is not possible to change it, or assign different keys to different cultures or factions.
This poses a problem if you were interested in editing technology trees in such a way that different factions, within the same culture, have a different tree. There are some workarounds for this which will be described later on in the guide.

Technology nodes is also where we junction the technology key to a unique node key, which is used for the technology node links and technology ui groups to node junction table.

Technology node links is where we link technology node keys together, to create dependencies between various technologies in the tree.

As an example if we look at the vanilla technology tech_vmp_bones_02a we can see that in the local_en.pack it is the Risen Standard Bearers technology, also further hinted at by the use of the icon wh_main_vmp_risen_standard_bearers.
If we look in the technology nodes table, we can see it is positioned in Indent -1, Tier 1.

[[File:Indenttiertechtree.jpg|center|frameless|768x768px]]

Similarly we can find tech_vmp_bones_06 aka Distribute Grave Gifts at 1,2.
If we look at the node links we can see tech_vmp_bones_06 points to tech_vmp_bones_05, with a Parent Link Position of 3 and a Child Link Position of 1, which in the image above creates that line between them.

The Link Positions goes from 1 on the top, 2 on the right, 3 on the bottom and 4 on the left.

If you start editing a technology tree, it’ll change for all factions which utilize that tree, because they are all sharing the same culture. That’s how it is defined in technology_node_sets_tables.

As an example if we look at the vanilla technology tech_vmp_bones_02a we can see that in the local_en.pack it is the Risen Standard Bearers technology, also further hinted at by the use of the icon wh_main_vmp_risen_standard_bearers.
If we look in the technology nodes table, we can see it is positioned in Indent -1, Tier 1.

== Changing the effect of an existing technology ==

Let us say we wanted to tweak or change the effect of the Vampire Counts technology Risen Champions.
After verifying that it is tech_vmp_bones_08, we can look in the technology effects junction table and see that it has the effect wh_main_effect_tech_unit_xp_levels_skeletons assigned, with an effect scope of faction_to_character_own_unseen and a value of 2.
If we look through the effect we can see that it matches up with the in game description, that it increases the Recruit Rank for a specific unit_set of units with the value of +2.
If we were to change the value to +5, those particular units would start at a subsequent higher rank when recruited.
We could also insert a different effect all together, with a different scope and change the outcome of that technology all together.

== Adding a new technology to an existing technology tree ==

So adding a new technology is as previously mentioned, fairly similar to adding a new skill to an Agent.
We’ll start in the technologies table and define a key first.
We’ll call it vmp_tech_example, we’ll find an icon for it in the UI\campaign ui\technologies folder and we’ll pick tech_cst_command_02.
We’ll further give it a unique index number and fill in the remainder of the details as the vanilla technologies use.

It should look similar to this.

[[File:technology_example1.jpg|center|frameless|768x768px]]

For the sake of simplicity we’ll repurpose the same effect used for tech_vmp_bones_08.

[[File:technology_example2.jpg|center|frameless|768x768px]]

Now we need to figure out where on the tech tree we are going to position this new skill. We do so in a similar fashion as is done with the agent skill tree, using Indent and Tier positioning. We’ll need to find a location on the existing vanilla tree that isn’t currently occupied.
By looking at what is used in the technology nodes table we can see there is an empty spot in Indent 5, Tier 5.
We’ll set Research Points Required to 100, this corresponds to 1 turn, at a default research rate of 100%. If we set it to 500, it’ll be 5 turns, at 100% research rate.

[[File:technology_example3.jpg|center|frameless|768x768px]]

Next we’ll add the corresponding loc files, in the technologies loc table, with three keys, technologies_onscreen_name_vmp_tech_example technologies_short_description_vmp_tech_example and technologies_long_description_vmp_tech_example.

Note: Long description isn’t used, but for the sake of the future and following vanilla strictly, it’s better to include it.

If we load up the game we can see that the new custom tech shows up on the vampire counts technology tree, in position 5,5.

[[File:technology_example4.jpg|center|frameless|768x768px]]

We could position it elsewhere, say 0,4 and use the technology node links table to make it dependent on the Risen Champions technology.

[[File:technology_example5.jpg|center|frameless|768x768px]]

It would look like this in game…

[[File:technology_example6.jpg|center|frameless|768x768px]]

== Clean Slate ==
So while we cannot create a new node set key and overwrite the vanilla technology trees in that fashion, there is a workaround we can employ which produces a similar result.

Firstly we’ll clean out technology nodes except for all the vanilla vampire count technologies.
Then we are going to assign them all the same Indent and Tier coordinates at 0,0.
Then we’ll assign them all the custom technology we created earlier, while we delete the assigned effect from the technology effects junction table.

[[File:technology_example7.jpg|center|frameless|768x768px]]

[[File:technology_example8.jpg|center|frameless|768x768px]]

Further more we can lock the technology behind a building using technology required building levels junction table.

[[File:technology_example9.jpg|center|frameless|768x768px]]

In game it shows up like this, with the building required shown in the banner above the technology.

[[File:technology_example10.jpg|center|frameless|768x768px]]

This is obviously an imperial building, which Vampire Counts will never have access to, effectively making this technology unavailable.
Similarly you could use technology required building levels junction table to create a fully custom tech tree which, in this example’s use of the vampire counts, would create dependencies for their buildings to unlock the technologies.

It could look something like this.

[[File:technology_example11.jpg|center|frameless|768x768px]]

Here all the vanilla technologies are masked under Master of the Putrid Horde. It’s a simpler tech tree, because there are no node links used at all.
Under this setup, the custom Master of the Putrid Horde technology key is used across all the vanilla technologies with the same Indent, Tier coordinates and cost for all the technology nodes. Furthermore, the various technologies in the tree are restricted to various vampire counts buildings.

It gets a little trickier if you want to do this in a technology tree with node links attached.

[[File:technology_example12.jpg|center|frameless|768x768px]]

Here Master of the Swarm hides all the vanilla technology nodes.
All vanilla technologies shares the same Indent, Tier, they were all assigned the same technology key for Master of the Swarm and all are linked to Corruptor of the Forests in the node links table.

It looks something like this in the DB…

[[File:technology_example13.jpg|center|frameless|768x768px]]

[[File:technology_example14.jpg|center|frameless|768x768px]]

This method also effectively removes the necessity for a separate rogue dummy technology node on the tree.
It’s unfortunately essential that all the vanilla technologies share the same technology key, because otherwise it wouldn’t be possible to mask them like this.
If you were to put a dummy blank technology key on all the vanilla nodes, under an actual custom technology, chances are one of the multitude of vanilla technologies would be the one that comes out on top, regardless of table or technology key naming conventions. Doing it this way does however not appear to have any adverse effects in terms of gameplay.

== Separate trees for factions within the same culture ==
As mentioned earlier under overview, if you start rearranging the vanilla technology nodes around, it changes the tree for all factions of the same race because they all share the same culture and thus the same technology node set. There is however a way around that.

First we’ll rearrange all the vanilla techs in 0,0 coordinates and assign them a dummy technology key, with no effects and zero out their cost.

It’ll look something like this…

[[File:technology_example15.jpg|center|frameless|768x768px]]

Then we’ll create new custom technologies and arrange them like so…

[[File:technology_example23.jpg|center|frameless|768x768px]]

But we’ll assign them to a specific faction, in this example we’ll use wh_main_vmp_schwartzhafen aka the Carsteins.

[[File:technology_example17.jpg|center|frameless|768x768px]]

Then we’ll do something similar for another faction, say wh_main_vmp_vampire_counts aka Vampire Counts lead by Mannfred. We’ll repurpose the vanilla technologies for him.

In game this will then look like this…

Carsteins/Vlad…

[[File:technology_example23.jpg|center|frameless|768x768px]]

Vampire Counts/Mannfred…

[[File:technology_example19.jpg|center|frameless|768x768px]]

Barrow Legion/Old man Heinrich…

[[File:technology_example24.jpg|center|frameless|768x768px]]

This way you effectively have different technology trees for separate factions. This however requires setting up a technology tree for all factions of the same culture in the game, otherwise some will be left without technologies.

This method also sadly requires the dummy technology being shown, because attempts to mask it in coordinates other than 0,0 causes inexplicable crashes.

== Technology UI groups & Watermarks ==
Some of the later added or changed technology trees uses technology UI groupings to group a selection of technologies together.

As seen here…

[[File:technology_example16.jpg|center|frameless|768x768px]]

This can be done with two tables…
technology_ui_groups_tables and technology_ui_groups_to_technology_nodes_junctions_tables

And looks something like this…

[[File:technology_example20.jpg|center|frameless|768x768px]]

[[File:technology_example21.jpg|center|frameless|768x768px]]

It uses the top left and bottom right technologies in the tree to define the bounding.

Note: That the colors aren’t standard RGB, it is not known precisely what color coding they follow.

Some of the vanilla technology trees like Tomb Kings also have watermarks in their technology ui groupings, they can look like this obelisk…

[[File:technology_example22.jpg|center|frameless|768x768px]]

With images stored in ui\skins\default and configured as Optional Background Image in technology_ui_groups_tables.

Technology Trees

2021-02-01T22:17:58Z

Aexrael: Technology tables

File:Technology example1.jpg

2021-02-01T16:23:19Z

Aexrael:

File:Indenttiertechtree.jpg

2021-02-01T16:22:37Z

Aexrael:

File:Technology example5.jpg

2021-02-01T16:21:25Z

Aexrael:

File:Technology example3.jpg

2021-02-01T16:21:18Z

Aexrael:

Technology Trees

2021-02-01T16:20:43Z

Aexrael:

THIS ENTRY IS WORK IN PROGRESS

Modding technologies in TWW is very similar to modding Skills for agents.

== Overview of the tables ==

technology_node_sets_tables

technologies_tables

technology_effects_junction_tables

technology_node_links_tables

technology_nodes_tables

=== Technology Node Sets ===

Technology Node Sets table junctions a Technology Node Set Key with a Culture or Subculture, this is start possed?

=== Technology Table ===

The Technologies table defines the Technology Key used in the other tables, the icon shown in the tech tree and it also contains a unique identifier.

=== Technology Effects ===

The Technology Effects table is where you junction the Technology Key from the Technologies Table with the Effect Key from the Effects table, alongside a scope and a value for the effect.

=== Technology Nodes and Node Links ===

Technology nodes is where the technology key from the Technologies Table is junctioned to a faction’s technology node set key which defines.

The technology node set key is sadly, at this point of writing, locked behind the compiled startpos and it is not possible to change it, or assign different keys to different cultures or factions.
This poses a problem if you were interested in editing technology trees in such a way that different factions, within the same culture, have a different tree. There are some workarounds for this which will be described later on in the guide.

Technology nodes is also where we junction the technology key to a unique node key, which is used for the technology node links and technology ui groups to node junction table.

Technology node links is where we link technology node keys together, to create dependencies between various technologies in the tree.

As an example if we look at the vanilla technology tech_vmp_bones_02a we can see that in the local_en.pack it is the Risen Standard Bearers technology, also further hinted at by the use of the icon wh_main_vmp_risen_standard_bearers.
If we look in the technology nodes table, we can see it is positioned in Indent -1, Tier 1.

[[File:Indenttiertechtree.jpg|center|frameless|768x768px]]

Similarly we can find tech_vmp_bones_06 aka Distribute Grave Gifts at 1,2.
If we look at the node links we can see tech_vmp_bones_06 points to tech_vmp_bones_05, with a Parent Link Position of 3 and a Child Link Position of 1, which in the image above creates that line between them.

The Link Positions goes from 1 on the top, 2 on the right, 3 on the bottom and 4 on the left.

If you start editing a technology tree, it’ll change for all factions which utilize that tree, because they are all sharing the same culture. That’s how it is defined in technology_node_sets_tables.

As an example if we look at the vanilla technology tech_vmp_bones_02a we can see that in the local_en.pack it is the Risen Standard Bearers technology, also further hinted at by the use of the icon wh_main_vmp_risen_standard_bearers.
If we look in the technology nodes table, we can see it is positioned in Indent -1, Tier 1.

== Changing the effect of an existing technology ==

Let us say we wanted to tweak or change the effect of the Vampire Counts technology Risen Champions.
After verifying that it is tech_vmp_bones_08, we can look in the technology effects junction table and see that it has the effect wh_main_effect_tech_unit_xp_levels_skeletons assigned, with an effect scope of faction_to_character_own_unseen and a value of 2.
If we look through the effect we can see that it matches up with the in game description, that it increases the Recruit Rank for a specific unit_set of units with the value of +2.
If we were to change the value to +5, those particular units would start at a subsequent higher rank when recruited.
We could also insert a different effect all together, with a different scope and change the outcome of that technology all together.

== Adding a new technology to an existing technology tree ==

So adding a new technology is as previously mentioned, fairly similar to adding a new skill to an Agent.
We’ll start in the technologies table and define a key first.
We’ll call it vmp_tech_example, we’ll find an icon for it in the UI\campaign ui\technologies folder and we’ll pick tech_cst_command_02.
We’ll further give it a unique index number and fill in the remainder of the details as the vanilla technologies use.

It should look similar to this.

[[File:technology_example1.jpg|center|frameless|768x768px]]

For the sake of simplicity we’ll repurpose the same effect used for tech_vmp_bones_08.

[[File:technology_example2.jpg|center|frameless|768x768px]]

Now we need to figure out where on the tech tree we are going to position this new skill. We do so in a similar fashion as is done with the agent skill tree, using Indent and Tier positioning. We’ll need to find a location on the existing vanilla tree that isn’t currently occupied.
By looking at what is used in the technology nodes table we can see there is an empty spot in Indent 5, Tier 5.
We’ll set Research Points Required to 100, this corresponds to 1 turn, at a default research rate of 100%. If we set it to 500, it’ll be 5 turns, at 100% research rate.

[[File:technology_example3.jpg|center|frameless|768x768px]]

Next we’ll add the corresponding loc files, in the technologies loc table, with three keys, technologies_onscreen_name_vmp_tech_example technologies_short_description_vmp_tech_example and technologies_long_description_vmp_tech_example.

Note: Long description isn’t used, but for the sake of the future and following vanilla strictly, it’s better to include it.

If we load up the game we can see that the new custom tech shows up on the vampire counts technology tree, in position 5,5.

[[File:technology_example4.jpg|center|frameless|768x768px]]

We could position it elsewhere, say 0,4 and use the technology node links table to make it dependent on the Risen Champions technology.

[[File:technology_example5.jpg|center|frameless|768x768px]]

It would look like this in game…

[[File:technology_example6.jpg|center|frameless|768x768px]]

== Clean Slate ==
So while we cannot create a new node set key and overwrite the vanilla technology trees in that fashion, there is a workaround we can employ which produces a similar result.

Firstly we’ll clean out technology nodes except for all the vanilla vampire count technologies.
Then we are going to assign them all the same Indent and Tier coordinates at 0,0.
Then we’ll assign them all the custom technology we created earlier, while we delete the assigned effect from the technology effects junction table.

[[File:technology_example7.jpg|center|frameless|768x768px]]

[[File:technology_example8.jpg|center|frameless|768x768px]]

Further more we can lock the technology behind a building using technology required building levels junction table.

[[File:technology_example9.jpg|center|frameless|768x768px]]

In game it shows up like this, with the building required shown in the banner above the technology.

[[File:technology_example10.jpg|center|frameless|768x768px]]

This is obviously an imperial building, which Vampire Counts will never have access to, effectively making this technology unavailable.
Similarly you could use technology required building levels junction table to create a fully custom tech tree which, in this example’s use of the vampire counts, would create dependencies for their buildings to unlock the technologies.

It could look something like this.

[[File:technology_example11.jpg|center|frameless|768x768px]]

Here all the vanilla technologies are masked under Master of the Putrid Horde. It’s a simpler tech tree, because there are no node links used at all.
Under this setup, the custom Master of the Putrid Horde technology key is used across all the vanilla technologies with the same Indent, Tier coordinates and cost for all the technology nodes. Furthermore, the various technologies in the tree are restricted to various vampire counts buildings.

It gets a little trickier if you want to do this in a technology tree with node links attached.

[[File:technology_example12.jpg|center|frameless|768x768px]]

Here Master of the Swarm hides all the vanilla technology nodes.
All vanilla technologies shares the same Indent, Tier, they were all assigned the same technology key for Master of the Swarm and all are linked to Corruptor of the Forests in the node links table.

It looks something like this in the DB…

[[File:technology_example13.jpg|center|frameless|768x768px]]

[[File:technology_example14.jpg|center|frameless|768x768px]]

This method also effectively removes the necessity for a separate rogue dummy technology node on the tree.
It’s unfortunately essential that all the vanilla technologies share the same technology key, because otherwise it wouldn’t be possible to mask them like this.
If you were to put a dummy blank technology key on all the vanilla nodes, under an actual custom technology, chances are one of the multitude of vanilla technologies would be the one that comes out on top, regardless of table or technology key naming conventions. Doing it this way does however not appear to have any adverse effects in terms of gameplay.

== Separate trees for factions within the same culture ==
As mentioned earlier under overview, if you start rearranging the vanilla technology nodes around, it changes the tree for all factions of the same race because they all share the same culture and thus the same technology node set. There is however a way around that.

First we’ll rearrange all the vanilla techs in 0,0 coordinates and assign them a dummy technology key, with no effects and zero out their cost.

It’ll look something like this…

[[File:technology_example15.jpg|center|frameless|768x768px]]

Then we’ll create new custom technologies and arrange them like so…

[[File:technology_example23.jpg|center|frameless|768x768px]]

But we’ll assign them to a specific faction, in this example we’ll use wh_main_vmp_schwartzhafen aka the Carsteins.

[[File:technology_example17.jpg|center|frameless|768x768px]]

Then we’ll do something similar for another faction, say wh_main_vmp_vampire_counts aka Vampire Counts lead by Mannfred. We’ll repurpose the vanilla technologies for him.

In game this will then look like this…

Carsteins/Vlad…

[[File:technology_example23.jpg|center|frameless|768x768px]]

Vampire Counts/Mannfred…

[[File:technology_example19.jpg|center|frameless|768x768px]]

Barrow Legion/Old man Heinrich…

[[File:technology_example24.jpg|center|frameless|768x768px]]

This way you effectively have different technology trees for separate factions. This however requires setting up a technology tree for all factions of the same culture in the game, otherwise some will be left without technologies.

This method also sadly requires the dummy technology being shown, because attempts to mask it in coordinates other than 0,0 causes inexplicable crashes.

== Technology UI groups & Watermarks ==
Some of the later added or changed technology trees uses technology UI groupings to group a selection of technologies together.

As seen here…

[[File:technology_example16.jpg|center|frameless|768x768px]]

This can be done with two tables…
technology_ui_groups_tables and technology_ui_groups_to_technology_nodes_junctions_tables

And looks something like this…

[[File:technology_example20.jpg|center|frameless|768x768px]]

[[File:technology_example21.jpg|center|frameless|768x768px]]

It uses the top left and bottom right technologies in the tree to define the bounding.

Note: That the colors aren’t standard RGB, it is not known precisely what color coding they follow.

Some of the vanilla technology trees like Tomb Kings also have watermarks in their technology ui groupings, they can look like this obelisk…

[[File:technology_example22.jpg|center|frameless|768x768px]]

With images stored in ui\skins\default and configured as Optional Background Image in technology_ui_groups_tables.

Technology Trees

2021-02-01T16:19:43Z

Aexrael:

THIS ENTRY IS WORK IN PROGRESS

Modding technologies in TWW is very similar to modding Skills for agents.

== Overview of the tables ==

technology_node_sets_tables

technologies_tables

technology_effects_junction_tables

technology_node_links_tables

technology_nodes_tables

=== Technology Node Sets ===

Technology Node Sets table junctions a Technology Node Set Key with a Culture or Subculture, this is start possed?

=== Technology Table ===

The Technologies table defines the Technology Key used in the other tables, the icon shown in the tech tree and it also contains a unique identifier.

=== Technology Effects ===

The Technology Effects table is where you junction the Technology Key from the Technologies Table with the Effect Key from the Effects table, alongside a scope and a value for the effect.

=== Technology Nodes and Node Links ===

Technology nodes is where the technology key from the Technologies Table is junctioned to a faction’s technology node set key which defines.

The technology node set key is sadly, at this point of writing, locked behind the compiled startpos and it is not possible to change it, or assign different keys to different cultures or factions.
This poses a problem if you were interested in editing technology trees in such a way that different factions, within the same culture, have a different tree. There are some workarounds for this which will be described later on in the guide.

Technology nodes is also where we junction the technology key to a unique node key, which is used for the technology node links and technology ui groups to node junction table.

Technology node links is where we link technology node keys together, to create dependencies between various technologies in the tree.

As an example if we look at the vanilla technology tech_vmp_bones_02a we can see that in the local_en.pack it is the Risen Standard Bearers technology, also further hinted at by the use of the icon wh_main_vmp_risen_standard_bearers.
If we look in the technology nodes table, we can see it is positioned in Indent -1, Tier 1.

[[File:Indenttiertechtree.jpg|center|frameless|768x768px]]

Similarly we can find tech_vmp_bones_06 aka Distribute Grave Gifts at 1,2.
If we look at the node links we can see tech_vmp_bones_06 points to tech_vmp_bones_05, with a Parent Link Position of 3 and a Child Link Position of 1, which in the image above creates that line between them.

The Link Positions goes from 1 on the top, 2 on the right, 3 on the bottom and 4 on the left.

If you start editing a technology tree, it’ll change for all factions which utilize that tree, because they are all sharing the same culture. That’s how it is defined in technology_node_sets_tables.

As an example if we look at the vanilla technology tech_vmp_bones_02a we can see that in the local_en.pack it is the Risen Standard Bearers technology, also further hinted at by the use of the icon wh_main_vmp_risen_standard_bearers.
If we look in the technology nodes table, we can see it is positioned in Indent -1, Tier 1.

== Changing the effect of an existing technology ==

Let us say we wanted to tweak or change the effect of the Vampire Counts technology Risen Champions.
After verifying that it is tech_vmp_bones_08, we can look in the technology effects junction table and see that it has the effect wh_main_effect_tech_unit_xp_levels_skeletons assigned, with an effect scope of faction_to_character_own_unseen and a value of 2.
If we look through the effect we can see that it matches up with the in game description, that it increases the Recruit Rank for a specific unit_set of units with the value of +2.
If we were to change the value to +5, those particular units would start at a subsequent higher rank when recruited.
We could also insert a different effect all together, with a different scope and change the outcome of that technology all together.

== Adding a new technology to an existing technology tree ==

So adding a new technology is as previously mentioned, fairly similar to adding a new skill to an Agent.
We’ll start in the technologies table and define a key first.
We’ll call it vmp_tech_example, we’ll find an icon for it in the UI\campaign ui\technologies folder and we’ll pick tech_cst_command_02.
We’ll further give it a unique index number and fill in the remainder of the details as the vanilla technologies use.

It should look similar to this.

[[File:technology_example1.jpg|center|frameless|768x768px]]

For the sake of simplicity we’ll repurpose the same effect used for tech_vmp_bones_08.

[[File:technology_example2.jpg|center|frameless|768x768px]]

Now we need to figure out where on the tech tree we are going to position this new skill. We do so in a similar fashion as is done with the agent skill tree, using Indent and Tier positioning. We’ll need to find a location on the existing vanilla tree that isn’t currently occupied.
By looking at what is used in the technology nodes table we can see there is an empty spot in Indent 5, Tier 5.
We’ll set Research Points Required to 100, this corresponds to 1 turn, at a default research rate of 100%. If we set it to 500, it’ll be 5 turns, at 100% research rate.

[[File:technology_example3.jpg|center|frameless|768x768px]]

Next we’ll add the corresponding loc files, in the technologies loc table, with three keys, technologies_onscreen_name_vmp_tech_example technologies_short_description_vmp_tech_example and technologies_long_description_vmp_tech_example.

Note: Long description isn’t used, but for the sake of the future and following vanilla strictly, it’s better to include it.

If we load up the game we can see that the new custom tech shows up on the vampire counts technology tree, in position 5,5.

[[File:technology_example4.jpg|center|frameless|768x768px]]

We could position it elsewhere, say 0,4 and use the technology node links table to make it dependent on the Risen Champions technology.

[[File:technology_example5.jpg|center|frameless|768x768px]]

It would look like this in game…

[[File:technology_example6.jpg|center|frameless|768x768px]]

== Clean Slate ==
So while we cannot create a new node set key and overwrite the vanilla technology trees in that fashion, there is a workaround we can employ which produces a similar result.

Firstly we’ll clean out technology nodes except for all the vanilla vampire count technologies.
Then we are going to assign them all the same Indent and Tier coordinates at 0,0.
Then we’ll assign them all the custom technology we created earlier, while we delete the assigned effect from the technology effects junction table.

[[File:technology_example7.jpg|center|frameless|768x768px]]

[[File:technology_example8.jpg|center|frameless|768x768px]]

Further more we can lock the technology behind a building using technology required building levels junction table.

[[File:technology_example9.jpg|center|frameless|768x768px]]

In game it shows up like this, with the building required shown in the banner above the technology.

[[File:technology_example10.jpg|center|frameless|768x768px]]

This is obviously an imperial building, which Vampire Counts will never have access to, effectively making this technology unavailable.
Similarly you could use technology required building levels junction table to create a fully custom tech tree which, in this example’s use of the vampire counts, would create dependencies for their buildings to unlock the technologies.

It could look something like this.

[[File:technology_example11.jpgg|center|frameless|768x768px]]

Here all the vanilla technologies are masked under Master of the Putrid Horde. It’s a simpler tech tree, because there are no node links used at all.
Under this setup, the custom Master of the Putrid Horde technology key is used across all the vanilla technologies with the same Indent, Tier coordinates and cost for all the technology nodes. Furthermore, the various technologies in the tree are restricted to various vampire counts buildings.

It gets a little trickier if you want to do this in a technology tree with node links attached.

[[File:technology_example12.jpg|center|frameless|768x768px]]

Here Master of the Swarm hides all the vanilla technology nodes.
All vanilla technologies shares the same Indent, Tier, they were all assigned the same technology key for Master of the Swarm and all are linked to Corruptor of the Forests in the node links table.

It looks something like this in the DB…

[[File:technology_example13.jpg|center|frameless|768x768px]]

[[File:technology_example14.jpg|center|frameless|768x768px]]

This method also effectively removes the necessity for a separate rogue dummy technology node on the tree.
It’s unfortunately essential that all the vanilla technologies share the same technology key, because otherwise it wouldn’t be possible to mask them like this.
If you were to put a dummy blank technology key on all the vanilla nodes, under an actual custom technology, chances are one of the multitude of vanilla technologies would be the one that comes out on top, regardless of table or technology key naming conventions. Doing it this way does however not appear to have any adverse effects in terms of gameplay.

== Separate trees for factions within the same culture ==
As mentioned earlier under overview, if you start rearranging the vanilla technology nodes around, it changes the tree for all factions of the same race because they all share the same culture and thus the same technology node set. There is however a way around that.

First we’ll rearrange all the vanilla techs in 0,0 coordinates and assign them a dummy technology key, with no effects and zero out their cost.

It’ll look something like this…

[[File:technology_example15.jp|center|frameless|768x768px]]

Then we’ll create new custom technologies and arrange them like so…

[[File:technology_example23.jpg|center|frameless|768x768px]]

But we’ll assign them to a specific faction, in this example we’ll use wh_main_vmp_schwartzhafen aka the Carsteins.

[[File:technology_example17.jpg|center|frameless|768x768px]]

Then we’ll do something similar for another faction, say wh_main_vmp_vampire_counts aka Vampire Counts lead by Mannfred. We’ll repurpose the vanilla technologies for him.

In game this will then look like this…

Carsteins/Vlad…

[[File:technology_example23.jpg|center|frameless|768x768px]]

Vampire Counts/Mannfred…

[[File:technology_example19.jpg|center|frameless|768x768px]]

Barrow Legion/Old man Heinrich…

[[File:technology_example24.jpg|center|frameless|768x768px]]

This way you effectively have different technology trees for separate factions. This however requires setting up a technology tree for all factions of the same culture in the game, otherwise some will be left without technologies.

This method also sadly requires the dummy technology being shown, because attempts to mask it in coordinates other than 0,0 causes inexplicable crashes.

== Technology UI groups & Watermarks ==
Some of the later added or changed technology trees uses technology UI groupings to group a selection of technologies together.

As seen here…

[[File:technology_example16.jpg|center|frameless|768x768px]]

This can be done with two tables…
technology_ui_groups_tables and technology_ui_groups_to_technology_nodes_junctions_tables

And looks something like this…

[[File:technology_example20.jpg|center|frameless|768x768px]]

[[File:technology_example21.jpg|center|frameless|768x768px]]

It uses the top left and bottom right technologies in the tree to define the bounding.

Note: That the colors aren’t standard RGB, it is not known precisely what color coding they follow.

Some of the vanilla technology trees like Tomb Kings also have watermarks in their technology ui groupings, they can look like this obelisk…

[[File:technology_example22.jpg|center|frameless|768x768px]]

With images stored in ui\skins\default and configured as Optional Background Image in technology_ui_groups_tables.

File:Technology example17.jpg

2021-02-01T16:18:56Z

Aexrael:

File:Technology example24.jpg

2021-02-01T16:18:49Z

Aexrael:

File:Technology example23.jpg

2021-02-01T16:18:42Z

Aexrael:

File:Technology example22.jpg

2021-02-01T16:18:37Z

Aexrael:

File:Technology example21.jpg

2021-02-01T16:18:33Z

Aexrael:

File:Technology example20.jpg

2021-02-01T16:18:27Z

Aexrael:

File:Technology example19.jpg

2021-02-01T16:18:22Z

Aexrael:

File:Technology example16.jpg

2021-02-01T16:18:13Z

Aexrael:

File:Technology example15.jpg

2021-02-01T16:17:57Z

Aexrael:

File:Technology example14.jpg

2021-02-01T16:17:52Z

Aexrael:

File:Technology example13.jpg

2021-02-01T16:17:48Z

Aexrael:

File:Technology example12.jpg

2021-02-01T16:17:37Z

Aexrael:

File:Technology example11.jpg

2021-02-01T16:17:34Z

Aexrael:

File:Technology example10.jpg

2021-02-01T16:17:29Z

Aexrael:

File:Technology example9.jpg

2021-02-01T16:17:25Z

Aexrael:

File:Technology example8.jpg

2021-02-01T16:17:20Z

Aexrael:

File:Technology example7.jpg

2021-02-01T16:17:10Z

Aexrael:

File:Technology example6.jpg

2021-02-01T15:58:33Z

Aexrael:

File:Technology example5-1024x120.jpg

2021-02-01T15:58:23Z

Aexrael:

File:Technology example4.jpg

2021-02-01T15:58:17Z

Aexrael:

File:Technology example3-1024x123.jpg

2021-02-01T15:58:09Z

Aexrael:

File:Technology example2.jpg

2021-02-01T15:58:01Z

Aexrael:

File:Technology example1-1024x45.jpg

2021-02-01T15:57:48Z

Aexrael: Technology Tree Guide image 2

== Summary ==
Technology Tree Guide image 2

File:Indenttiertechtree-1024x576.jpg

2021-02-01T15:57:26Z

Aexrael: Technology Tree Guide image 1

== Summary ==
Technology Tree Guide image 1

Example Scripts

2021-02-01T15:53:32Z

Aexrael: Created page with "== Replacing a Starting General == <nowiki> -- Script by Aexrael Dex Replaces the starting general for a specific faction -- Rename replace_starting_general local..."

== Replacing a Starting General ==

<nowiki>
--[[
Script by Aexrael Dex
Replaces the starting general for a specific faction
]]

-- Rename replace_starting_general
local function replace_starting_general()
if cm:is_new_game() then

-- Creating replacement for Karl Franz with a regular Empire General
local general_faction_str = "wh_main_emp_empire"; -- faction key from factions table
local general_faction_obj = cm:get_faction(general_faction_str);
local general_unit_list = "wh_main_emp_cav_reiksguard,wh_main_emp_cav_reiksguard,wh_main_emp_cav_reiksguard"; -- unit keys from main_units table
local general_region_key = general_faction_obj:home_region():name(); -- the replacement general will spawn adjacent to the settlement in the home region for the faction
local general_x_pos, general_y_pos = cm:find_valid_spawn_location_for_character_from_settlement(
general_faction_str,
general_region_key,
false,
true
);
local general_type = "general"; -- agent type
local general_subtype = "emp_lord"; -- agent subtype
local general_forename = "names_name_1904032251"; -- from local_en names table, Bernhoff the Butcher is now ruler of Reikland
local general_clanname = ""; -- from local_en names table
local general_surname = ""; -- from local_en names table
local general_othername = ""; -- from local_en names table
local general_is_faction_leader = true; -- bool for whether the general being replaced is the new faction leader

cm:create_force_with_general(
general_faction_str,
general_unit_list,
general_region_key,
general_x_pos,
general_y_pos,
general_type,
general_subtype,
general_forename,
general_clanname,
general_surname,
general_othername,
general_is_faction_leader,

-- Generals created this way does not come with a trait and aren't immortal
function(cqi)
local char_str = cm:char_lookup_str(cqi);
-- Adding a new trait to the above general
cm:force_add_trait(char_str, "wh2_dlc09_trait_benevolence", true);
out("Adding a trait to " .. general_forename);

-- Making the new general immortal (!!Use Skill based immortality instead!!)
cm:set_character_immortality(char_str, true);
out("Making general with forename " .. general_forename .. " immortal");
end
);
out("Creating Neo_Karl Franz for Reikland");

-- Killing original Karl Franz
local char_list = general_faction_obj:character_list();
local leader_subtype = "emp_karl_franz"; -- Karl Franz's agent subtype
local leader_forename = "names_name_2147343849"; -- Karl Franz's forename

for i = 0, char_list:num_items() - 1 do
local current_char = char_list:item_at(i);

if current_char:is_null_interface() == false and current_char:character_subtype_key() == leader_subtype and current_char:get_forename() == leader_forename and current_char:has_military_force() == true then
cm:set_character_immortality("character_cqi:"..current_char:command_queue_index(), false); -- Removing Karl Franz's immortality
cm:disable_event_feed_events(true, "wh_event_category_character", "", ""); -- Disabling event feed messages for character related events
cm:kill_character(current_char:command_queue_index(), true, true); -- Killing Karl Franz
cm:callback(function() cm:disable_event_feed_events(false, "wh_event_category_character", "", "") end, 1); -- Enabling event feed messages for character related events
out("Killing original " .. leader_subtype .. " with forename " .. leader_forename .. " for " .. general_faction_str .. " permanently");
end;
end;
end;
end;

-- Rename replace_starting_general to match the function name at the top
cm:add_first_tick_callback(function() replace_starting_general() end);</nowiki>

== Adding custom RoRs to mercenary pool ==

<nowiki>--[[
Script by Aexrael Dex
Adds custom Regiments of Reknown to defined factions
]]

local function cror_initiator()
-- Checking whether the script has already run for saved games and if it has then the script doesn't need to run again
if cm:get_saved_value("custom_ror_enabled") == nil then

-- Table for faction, unit key and parameters for add_unit_to_faction_mercenary_pool
local cror_list = {
{faction = "wh_main_vmp_schwartzhafen", unit = "wh2_dlc11_cst_inf_zombie_deckhands_mob_ror_0", count = 1, rcp = 100, munits = 1, murpt = 0.1, xplevel = 0, frr = "", srr = "", trr = "", replen = false},
{faction = "wh_main_vmp_vampire_counts", unit = "wh2_dlc11_cst_inf_zombie_deckhands_mob_ror_0", count = 1, rcp = 100, munits = 1, murpt = 0.1, xplevel = 0, frr = "", srr = "", trr = "", replen = false}
};

-- Loop for the table above
for i = 1, #cror_list do
local faction_str = cror_list[i].faction; -- Faction whose pool the unit(s) should be added to
local faction_obj = cm:get_faction(faction_str); -- FACTION_SCRIPT_INTERFACE faction
local unit_key = cror_list[i].unit; -- Key of unit to add to the mercenary pool, from the main_units table
local unit_count = cror_list[i].count; -- Number of units to add to the mercenary pool
local rcp = cror_list[i].rcp; -- Replenishment chance, as a percentage
local munits = cror_list[i].munits; -- The maximum number of units of the supplied type that the pool is allowed to contain.
local murpt = cror_list[i].murpt; -- The maximum number of units of the supplied type that may be added by replenishment per-turn
local xplevel = cror_list[i].xplevel; -- The experience level of the units when recruited
local frr = cror_list[i].frr; -- (may be empty) The key of the faction who can actually recruit the units, from the factions database table
local srr = cror_list[i].srr; -- (may be empty) The key of the subculture who can actually recruit the units, from the cultures_subcultures database table
local trr = cror_list[i].trr; -- (may be empty) The key of a technology that must be researched in order to recruit the units, from the technologies database table
local replen = cror_list[i].replen; -- Allow replenishment of partial units

-- Adding the listed unit to the listed faction in the above table
cm:add_unit_to_faction_mercenary_pool(faction_obj, unit_key, unit_count, rcp, munits, murpt, xplevel, frr, srr, trr, replen);

-- Setting saved value, so that the script doesn't run again when reloaded from a saved game
cm:set_saved_value("custom_ror_enabled", true);

-- Debug message for log
out("adding the custom ror unit " .. unit_key .. " to " .. faction_str);
end;
end;
end;

cm:add_first_tick_callback(function() cror_initiator() end);</nowiki>

== Replacing Starting Armies ==

<nowiki>--[[
Script by Aexrael Dex
Replaces the starting units for the designated characters
]]

-- Rename edit_starting_army
local function edit_starting_army()
if cm:is_new_game() then
local custom_starting_army = {
-- Vlad, Carsteins
{faction = "wh_main_vmp_schwartzhafen", subtype = "dlc04_vmp_vlad_con_carstein", forename = "names_name_2147345130", units = {"wh_main_vmp_inf_skeleton_warriors_0", "wh_main_vmp_inf_skeleton_warriors_0", "wh_main_vmp_mon_fell_bats", "wh_main_vmp_mon_fell_bats", "wh_main_vmp_cav_black_knights_0", "wh_main_vmp_cav_black_knights_0"}},
-- Isabella, Carsteins
{faction = "wh_main_vmp_schwartzhafen", subtype = "pro02_vmp_isabella_von_carstein", forename = "names_name_2147345124", units = {"wh_main_vmp_inf_zombie", "wh_main_vmp_inf_zombie", "wh_main_vmp_mon_dire_wolves", "wh_main_vmp_mon_dire_wolves", "wh_main_vmp_mon_fell_bats", "wh_main_vmp_mon_vargheists"}}
};

for i = 1, #custom_starting_army do
local faction_str = custom_starting_army[i].faction;
local faction_obj = cm:get_faction(faction_str);
local char_list = faction_obj:character_list();
local general_subtype = custom_starting_army[i].subtype;
local general_forename = custom_starting_army[i].forename;
local unit_list = custom_starting_army[i].units;

for j = 0, char_list:num_items() - 1 do
local current_char = char_list:item_at(j);

if current_char:is_null_interface() == false and current_char:character_subtype_key() == general_subtype and current_char:get_forename() == general_forename and current_char:has_military_force() == true then
cm:remove_all_units_from_general(current_char);
out("Removing starting units from " .. general_subtype .. " with forename " .. general_forename);

for k = 1, #unit_list do
local unit = unit_list[k];
cm:grant_unit_to_character(cm:char_lookup_str(current_char:cqi()), unit);
out("Granting new starting units to " .. general_subtype .. " with forename " .. general_forename);
end;
end;
end;
end;
end;
end;

-- Rename edit_starting_army to match the function name at the top
cm:add_first_tick_callback(function() edit_starting_army() end);</nowiki>

Mods

2021-02-01T15:40:02Z

Aexrael:

A mod is any alteration to the base game, through [[modding]].

Mods are made up of a single .pack file, which contains all the changes for that mod, and a single .png file of the same name - which is just used as the thumbnail within Steam and the Total War Launcher.

== Finding Mods ==
Most mods that you will find can be discovered on the Steam Workshop page, for each Total War game.

* [https://steamcommunity.com/app/594570/workshop/ Total War: Warhammer 2 Steam Workshop]
* Etc.

Point of assistance here - you'll have a better time either Googling for the mods you're looking for (ie., "total war warhammer 2 greenskin units mods"), or searching for a collection on the Workshop. Steam Workshop is... a subpar searching service. Ironically.

== Installation ==
When you find a mod you like in the Steam Workshop, you simply press the "Subscribe" button - '''making sure to download all required items for that mod!''' - and let Steam download it in the background. Next time you load up the game, you will see it available in the launcher's mod manager. Simply tick the mod in the manager, and it will be enabled next time you press play!

Important note here: Don't faff around with [[load order]]. Mods are sorted alphanumerically by default, and modders are aware of the priorities needed between mods most of the time, when it comes to [[submods]] or similar.

== Troubleshooting ==

If a mod doesn't appear to work or update, you can try to unsubscribe and re-subscribe, though in some instances this may not be enough and you may need to Clear the Steam Download Cache, see this [https://support.steampowered.com/kb_article.php?ref=3134-TIAL-4638 article]

== Compatibility ==

Technology Trees

2021-01-22T14:09:59Z

Aexrael:

THIS ENTRY IS WORK IN PROGRESS

Modding technologies in TWW is very similar to modding Skills for agents.

== Overview of the tables ==

technology_node_sets_tables

technologies_tables

technology_effects_junction_tables

technology_node_links_tables

technology_nodes_tables

=== Technology Node Sets ===

Technology Node Sets table junctions a Technology Node Set Key with a Culture or Subculture, this is start possed?

=== Technology Table ===

The Technologies table defines the Technology Key used in the other tables, the icon shown in the tech tree and it also contains a unique identifier.

=== Technology Effects ===

The Technology Effects table is where you junction the Technology Key from the Technologies Table with the Effect Key from the Effects table, alongside a scope and a value for the effect.

=== Technology Nodes and Node Links ===

Technology nodes is where the technology key from the Technologies Table is junctioned to a faction’s technology node set key which defines.

The technology node set key is sadly, at this point of writing, locked behind the compiled startpos and it is not possible to change it, or assign different keys to different cultures or factions.
This poses a problem if you were interested in editing technology trees in such a way that different factions, within the same culture, have a different tree. There are some workarounds for this which will be described later on in the guide.

Technology nodes is also where we junction the technology key to a unique node key, which is used for the technology node links and technology ui groups to node junction table.

Technology node links is where we link technology node keys together, to create dependencies between various technologies in the tree.

As an example if we look at the vanilla technology tech_vmp_bones_02a we can see that in the local_en.pack it is the Risen Standard Bearers technology, also further hinted at by the use of the icon wh_main_vmp_risen_standard_bearers.
If we look in the technology nodes table, we can see it is positioned in Indent -1, Tier 1.

[https://tw-modding.com/wp-content/uploads/2019/09/indenttiertechtree-1024x576.jpg]

Similarly we can find tech_vmp_bones_06 aka Distribute Grave Gifts at 1,2.
If we look at the node links we can see tech_vmp_bones_06 points to tech_vmp_bones_05, with a Parent Link Position of 3 and a Child Link Position of 1, which in the image above creates that line between them.

The Link Positions goes from 1 on the top, 2 on the right, 3 on the bottom and 4 on the left.

If you start editing a technology tree, it’ll change for all factions which utilize that tree, because they are all sharing the same culture. That’s how it is defined in technology_node_sets_tables.

As an example if we look at the vanilla technology tech_vmp_bones_02a we can see that in the local_en.pack it is the Risen Standard Bearers technology, also further hinted at by the use of the icon wh_main_vmp_risen_standard_bearers.
If we look in the technology nodes table, we can see it is positioned in Indent -1, Tier 1.

== Changing the effect of an existing technology ==

Let us say we wanted to tweak or change the effect of the Vampire Counts technology Risen Champions.
After verifying that it is tech_vmp_bones_08, we can look in the technology effects junction table and see that it has the effect wh_main_effect_tech_unit_xp_levels_skeletons assigned, with an effect scope of faction_to_character_own_unseen and a value of 2.
If we look through the effect we can see that it matches up with the in game description, that it increases the Recruit Rank for a specific unit_set of units with the value of +2.
If we were to change the value to +5, those particular units would start at a subsequent higher rank when recruited.
We could also insert a different effect all together, with a different scope and change the outcome of that technology all together.

== Adding a new technology to an existing technology tree ==

So adding a new technology is as previously mentioned, fairly similar to adding a new skill to an Agent.
We’ll start in the technologies table and define a key first.
We’ll call it vmp_tech_example, we’ll find an icon for it in the UI\campaign ui\technologies folder and we’ll pick tech_cst_command_02.
We’ll further give it a unique index number and fill in the remainder of the details as the vanilla technologies use.

It should look similar to this.

[https://tw-modding.com/wp-content/uploads/2019/09/technology_example1-1024x45.jpg]

For the sake of simplicity we’ll repurpose the same effect used for tech_vmp_bones_08.

[https://tw-modding.com/wp-content/uploads/2019/09/technology_example2.jpg]

Now we need to figure out where on the tech tree we are going to position this new skill. We do so in a similar fashion as is done with the agent skill tree, using Indent and Tier positioning. We’ll need to find a location on the existing vanilla tree that isn’t currently occupied.
By looking at what is used in the technology nodes table we can see there is an empty spot in Indent 5, Tier 5.
We’ll set Research Points Required to 100, this corresponds to 1 turn, at a default research rate of 100%. If we set it to 500, it’ll be 5 turns, at 100% research rate.

[https://tw-modding.com/wp-content/uploads/2019/09/technology_example3-1024x123.jpg]

Next we’ll add the corresponding loc files, in the technologies loc table, with three keys, technologies_onscreen_name_vmp_tech_example technologies_short_description_vmp_tech_example and technologies_long_description_vmp_tech_example.

Note: Long description isn’t used, but for the sake of the future and following vanilla strictly, it’s better to include it.

If we load up the game we can see that the new custom tech shows up on the vampire counts technology tree, in position 5,5.

[https://tw-modding.com/wp-content/uploads/2019/09/technology_example4.jpg]

We could position it elsewhere, say 0,4 and use the technology node links table to make it dependent on the Risen Champions technology.

[https://tw-modding.com/wp-content/uploads/2019/09/technology_example5-1024x120.jpg]

It would look like this in game…

[https://tw-modding.com/wp-content/uploads/2019/09/technology_example6.jpg]

== Clean Slate ==
So while we cannot create a new node set key and overwrite the vanilla technology trees in that fashion, there is a workaround we can employ which produces a similar result.

Firstly we’ll clean out technology nodes except for all the vanilla vampire count technologies.
Then we are going to assign them all the same Indent and Tier coordinates at 0,0.
Then we’ll assign them all the custom technology we created earlier, while we delete the assigned effect from the technology effects junction table.

[https://tw-modding.com/wp-content/uploads/2019/09/technology_example7-1024x109.jpg]

[https://tw-modding.com/wp-content/uploads/2019/09/technology_example8.jpg]

Further more we can lock the technology behind a building using technology required building levels junction table.

[https://tw-modding.com/wp-content/uploads/2019/09/technology_example9.jpg]

In game it shows up like this, with the building required shown in the banner above the technology.

[https://tw-modding.com/wp-content/uploads/2019/09/technology_example10.jpg]

This is obviously an imperial building, which Vampire Counts will never have access to, effectively making this technology unavailable.
Similarly you could use technology required building levels junction table to create a fully custom tech tree which, in this example’s use of the vampire counts, would create dependencies for their buildings to unlock the technologies.

It could look something like this.

[https://tw-modding.com/wp-content/uploads/2019/09/technology_example11-1024x576.jpg]

Here all the vanilla technologies are masked under Master of the Putrid Horde. It’s a simpler tech tree, because there are no node links used at all.
Under this setup, the custom Master of the Putrid Horde technology key is used across all the vanilla technologies with the same Indent, Tier coordinates and cost for all the technology nodes. Furthermore, the various technologies in the tree are restricted to various vampire counts buildings.

It gets a little trickier if you want to do this in a technology tree with node links attached.

[https://tw-modding.com/wp-content/uploads/2019/09/technology_example12.jpg]

Here Master of the Swarm hides all the vanilla technology nodes.
All vanilla technologies shares the same Indent, Tier, they were all assigned the same technology key for Master of the Swarm and all are linked to Corruptor of the Forests in the node links table.

It looks something like this in the DB…

[https://tw-modding.com/wp-content/uploads/2019/09/technology_example13-1024x152.jpg]
[https://tw-modding.com/wp-content/uploads/2019/09/technology_example14-1024x211.jpg]

This method also effectively removes the necessity for a separate rogue dummy technology node on the tree.
It’s unfortunately essential that all the vanilla technologies share the same technology key, because otherwise it wouldn’t be possible to mask them like this.
If you were to put a dummy blank technology key on all the vanilla nodes, under an actual custom technology, chances are one of the multitude of vanilla technologies would be the one that comes out on top, regardless of table or technology key naming conventions. Doing it this way does however not appear to have any adverse effects in terms of gameplay.

== Separate trees for factions within the same culture ==
As mentioned earlier under overview, if you start rearranging the vanilla technology nodes around, it changes the tree for all factions of the same race because they all share the same culture and thus the same technology node set. There is however a way around that.

First we’ll rearrange all the vanilla techs in 0,0 coordinates and assign them a dummy technology key, with no effects and zero out their cost.

It’ll look something like this…

[https://tw-modding.com/wp-content/uploads/2019/09/technology_example15-1-1024x85.jpg]

Then we’ll create new custom technologies and arrange them like so…

[https://tw-modding.com/wp-content/uploads/2019/09/technology_example23-1024x444.jpg]

But we’ll assign them to a specific faction, in this example we’ll use wh_main_vmp_schwartzhafen aka the Carsteins.

[https://tw-modding.com/wp-content/uploads/2019/09/technology_example17-1024x91.jpg]

Then we’ll do something similar for another faction, say wh_main_vmp_vampire_counts aka Vampire Counts lead by Mannfred. We’ll repurpose the vanilla technologies for him.

In game this will then look like this…

Carsteins/Vlad…

[https://tw-modding.com/wp-content/uploads/2019/09/technology_example23-1024x444.jpg]

Vampire Counts/Mannfred…

[https://tw-modding.com/wp-content/uploads/2019/09/technology_example19-1024x380.jpg]

Barrow Legion/Old man Heinrich…

[https://tw-modding.com/wp-content/uploads/2019/09/technology_example24-1024x432.jpg]

This way you effectively have different technology trees for separate factions. This however requires setting up a technology tree for all factions of the same culture in the game, otherwise some will be left without technologies.

This method also sadly requires the dummy technology being shown, because attempts to mask it in coordinates other than 0,0 causes inexplicable crashes.

== Technology UI groups & Watermarks ==
Some of the later added or changed technology trees uses technology UI groupings to group a selection of technologies together.

As seen here…

[https://tw-modding.com/wp-content/uploads/2019/09/technology_example16-1024x408.jpg]

This can be done with two tables…
technology_ui_groups_tables and technology_ui_groups_to_technology_nodes_junctions_tables

And looks something like this…

[https://tw-modding.com/wp-content/uploads/2019/09/technology_example20.jpg]

[https://tw-modding.com/wp-content/uploads/2019/09/technology_example21-1024x186.jpg]

It uses the top left and bottom right technologies in the tree to define the bounding.

Note: That the colors aren’t standard RGB, it is not known precisely what color coding they follow.

Some of the vanilla technology trees like Tomb Kings also have watermarks in their technology ui groupings, they can look like this obelisk…

[https://tw-modding.com/wp-content/uploads/2019/09/technology_example22.jpg]

With images stored in ui\skins\default and configured as Optional Background Image in technology_ui_groups_tables.

Technology Trees

2021-01-22T14:02:19Z

Aexrael:

THIS ENTRY IS WORK IN PROGRESS

Modding technologies in TWW is very similar to modding Skills for agents.

== Overview of the tables ==

technology_node_sets_tables

technologies_tables

technology_effects_junction_tables

technology_node_links_tables

technology_nodes_tables

=== Technology Node Sets ===

Technology Node Sets table junctions a Technology Node Set Key with a Culture or Subculture, this is start possed?

=== Technology Table ===

The Technologies table defines the Technology Key used in the other tables, the icon shown in the tech tree and it also contains a unique identifier.

=== Technology Effects ===

The Technology Effects table is where you junction the Technology Key from the Technologies Table with the Effect Key from the Effects table, alongside a scope and a value for the effect.

=== Technology Nodes and Node Links ===

Technology nodes is where the technology key from the Technologies Table is junctioned to a faction’s technology node set key which defines.

The technology node set key is sadly, at this point of writing, locked behind the compiled startpos and it is not possible to change it, or assign different keys to different cultures or factions.
This poses a problem if you were interested in editing technology trees in such a way that different factions, within the same culture, have a different tree. There are some workarounds for this which will be described later on in the guide.

Technology nodes is also where we junction the technology key to a unique node key, which is used for the technology node links and technology ui groups to node junction table.

Technology node links is where we link technology node keys together, to create dependencies between various technologies in the tree.

As an example if we look at the vanilla technology tech_vmp_bones_02a we can see that in the local_en.pack it is the Risen Standard Bearers technology, also further hinted at by the use of the icon wh_main_vmp_risen_standard_bearers.
If we look in the technology nodes table, we can see it is positioned in Indent -1, Tier 1.

[[File:https://i.imgur.com/PGrUFDh.jpg|thumb|Indent & Tier overview]]

Similarly we can find tech_vmp_bones_06 aka Distribute Grave Gifts at 1,2.
If we look at the node links we can see tech_vmp_bones_06 points to tech_vmp_bones_05, with a Parent Link Position of 3 and a Child Link Position of 1, which in the image above creates that line between them.

The Link Positions goes from 1 on the top, 2 on the right, 3 on the bottom and 4 on the left.

If you start editing a technology tree, it’ll change for all factions which utilize that tree, because they are all sharing the same culture. That’s how it is defined in technology_node_sets_tables.

As an example if we look at the vanilla technology tech_vmp_bones_02a we can see that in the local_en.pack it is the Risen Standard Bearers technology, also further hinted at by the use of the icon wh_main_vmp_risen_standard_bearers.
If we look in the technology nodes table, we can see it is positioned in Indent -1, Tier 1.

Indent & Tier overview
Similarly we can find tech_vmp_bones_06 aka Distribute Grave Gifts at 1,2.
If we look at the node links we can see tech_vmp_bones_06 points to tech_vmp_bones_05, with a Parent Link Position of 3 and a Child Link Position of 1, which in the image above creates that line between them.

The Link Positions goes from 1 on the top, 2 on the right, 3 on the bottom and 4 on the left.

If you start editing a technology tree, it’ll change for all factions which utilize that tree, because they are all sharing the same culture. That’s how it is defined in technology_node_sets_tables.

Changing the effect of an existing technology
Let us say we wanted to tweak or change the effect of the Vampire Counts technology Risen Champions.
After verifying that it is tech_vmp_bones_08, we can look in the technology effects junction table and see that it has the effect wh_main_effect_tech_unit_xp_levels_skeletons assigned, with an effect scope of faction_to_character_own_unseen and a value of 2.
If we look through the effect we can see that it matches up with the in game description, that it increases the Recruit Rank for a specific unit_set of units with the value of +2.
If we were to change the value to +5, those particular units would start at a subsequent higher rank when recruited.
We could also insert a different effect all together, with a different scope and change the outcome of that technology all together.

Adding a new technology to an existing technology tree
So adding a new technology is as previously mentioned, fairly similar to adding a new skill to an Agent.
We’ll start in the technologies table and define a key first.
We’ll call it vmp_tech_example, we’ll find an icon for it in the UI\campaign ui\technologies folder and we’ll pick tech_cst_command_02.
We’ll further give it a unique index number and fill in the remainder of the details as the vanilla technologies use.

It should look similar to this.

For the sake of simplicity we’ll repurpose the same effect used for tech_vmp_bones_08.

Now we need to figure out where on the tech tree we are going to position this new skill. We do so in a similar fashion as is done with the agent skill tree, using Indent and Tier positioning. We’ll need to find a location on the existing vanilla tree that isn’t currently occupied.
By looking at what is used in the technology nodes table we can see there is an empty spot in Indent 5, Tier 5.
We’ll set Research Points Required to 100, this corresponds to 1 turn, at a default research rate of 100%. If we set it to 500, it’ll be 5 turns, at 100% research rate.

Next we’ll add the corresponding loc files, in the technologies loc table, with three keys, technologies_onscreen_name_vmp_tech_example technologies_short_description_vmp_tech_example and technologies_long_description_vmp_tech_example.

Note: Long description isn’t used, but for the sake of the future and following vanilla strictly, it’s better to include it.

If we load up the game we can see that the new custom tech shows up on the vampire counts technology tree, in position 5,5.

We could position it elsewhere, say 0,4 and use the technology node links table to make it dependent on the Risen Champions technology.

It would look like this in game…

Clean Slate
So while we cannot create a new node set key and overwrite the vanilla technology trees in that fashion, there is a workaround we can employ which produces a similar result.

Firstly we’ll clean out technology nodes except for all the vanilla vampire count technologies.
Then we are going to assign them all the same Indent and Tier coordinates at 0,0.
Then we’ll assign them all the custom technology we created earlier, while we delete the assigned effect from the technology effects junction table.

Further more we can lock the technology behind a building using technology required building levels junction table.

In game it shows up like this, with the building required shown in the banner above the technology.

This is obviously an imperial building, which Vampire Counts will never have access to, effectively making this technology unavailable.
Similarly you could use technology required building levels junction table to create a fully custom tech tree which, in this example’s use of the vampire counts, would create dependencies for their buildings to unlock the technologies.

It could look something like this.

Here all the vanilla technologies are masked under Master of the Putrid Horde. It’s a simpler tech tree, because there are no node links used at all.
Under this setup, the custom Master of the Putrid Horde technology key is used across all the vanilla technologies with the same Indent, Tier coordinates and cost for all the technology nodes. Furthermore, the various technologies in the tree are restricted to various vampire counts buildings.

It gets a little trickier if you want to do this in a technology tree with node links attached.

Here Master of the Swarm hides all the vanilla technology nodes.
All vanilla technologies shares the same Indent, Tier, they were all assigned the same technology key for Master of the Swarm and all are linked to Corruptor of the Forests in the node links table.

It looks something like this in the DB…

This method also effectively removes the necessity for a separate rogue dummy technology node on the tree.
It’s unfortunately essential that all the vanilla technologies share the same technology key, because otherwise it wouldn’t be possible to mask them like this.
If you were to put a dummy blank technology key on all the vanilla nodes, under an actual custom technology, chances are one of the multitude of vanilla technologies would be the one that comes out on top, regardless of table or technology key naming conventions. Doing it this way does however not appear to have any adverse effects in terms of gameplay.

Separate trees for factions within the same culture
As mentioned earlier under overview, if you start rearranging the vanilla technology nodes around, it changes the tree for all factions of the same race because they all share the same culture and thus the same technology node set. There is however a way around that.

First we’ll rearrange all the vanilla techs in 0,0 coordinates and assign them a dummy technology key, with no effects and zero out their cost.

It’ll look something like this…

Then we’ll create new custom technologies and arrange them like so…

But we’ll assign them to a specific faction, in this example we’ll use wh_main_vmp_schwartzhafen aka the Carsteins.

Then we’ll do something similar for another faction, say wh_main_vmp_vampire_counts aka Vampire Counts lead by Mannfred. We’ll repurpose the vanilla technologies for him.

In game this will then look like this…

Carsteins/Vlad…

Vampire Counts/Mannfred…

Barrow Legion/Old man Heinrich…

This way you effectively have different technology trees for separate factions. This however requires setting up a technology tree for all factions of the same culture in the game, otherwise some will be left without technologies.

This method also sadly requires the dummy technology being shown, because attempts to mask it in coordinates other than 0,0 causes inexplicable crashes.

Technology UI groups & Watermarks
Some of the later added or changed technology trees uses technology UI groupings to group a selection of technologies together.

As seen here…

This can be done with two tables…
technology_ui_groups_tables and technology_ui_groups_to_technology_nodes_junctions_tables

And looks something like this…

It uses the top left and bottom right technologies in the tree to define the bounding.

Note: That the colors aren’t standard RGB, it is not known precisely what color coding they follow.

Some of the vanilla technology trees like Tomb Kings also have watermarks in their technology ui groupings, they can look like this obelisk…

With images stored in ui\skins\default and configured as Optional Background Image in technology_ui_groups_tables.

Technology Trees

2021-01-22T13:51:29Z

Aexrael:

Technology Trees

2021-01-22T13:50:13Z

Aexrael:

Technology Trees

2021-01-21T21:18:29Z

Aexrael: Modding Technology Trees in the TWW trilogy