Example Scripts - Revision history

Vandy at 03:59, 28 November 2022

2022-11-28T03:59:44Z

Vandy: /* Warhammer III Example Scripts */

2022-11-28T03:59:16Z

Warhammer III Example Scripts

← Older revision		Revision as of 23:59, 27 November 2022
Line 408:		Line 408:
	== Warhammer III Example Scripts ==		== Warhammer III Example Scripts ==

	=== Adding RoRs to mercenary pool~~, Wh3 version~~ ===		=== Adding RoRs to mercenary pool ===
	<nowiki>--[[		<nowiki>--[[
	Script by Aexrael Dex		Script by Aexrael Dex

Vandy at 03:58, 28 November 2022

2022-11-28T03:58:50Z

← Older revision		Revision as of 23:58, 27 November 2022
Line 405:		Line 405:

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

			== Warhammer III Example Scripts ==

	=== Adding RoRs to mercenary pool, Wh3 version ===		=== Adding RoRs to mercenary pool, Wh3 version ===
Line 414:		Line 416:

	local function add_custom_ror()		local function add_custom_ror()
			-- Easy data table for faction info and unit info

	-- ~~Checking whether~~ the ~~script has already run for saved games and if it has then the script doesn~~'~~t need~~ to ~~run again~~		local ror_table = { -- A table of many RoR's ---- BEGIN REWRITE
	~~if cm:get_saved_value(~~"~~custom_ror_enabled~~") == ~~nil then~~		{ -- This is the first RoR we wish to spawn
			faction_key = "wh_main_vmp_schwartzhafen", -- The faction we're adding this RoR to; from `factions`
			unit_key = "wh2_dlc11_cst_inf_zombie_deckhands_mob_ror_0", -- The unit key; from `main_units`
			merc_pool = "renown", -- The mercenary pool we're adding this RoR to; from `recruitment_sources`
			merc_group = "wh2_dlc11_cst_inf_zombie_deckhands_mob_ror_0", -- The mercenary pool group this unit belongs to; in `mercenary_unit_groups`
			count = 1, -- The number of RoRs we're adding; this will be 1 by default, only put this line if you're seeking to change the number added
			}, -- and you can make a new table for each other RoR you're seeking to add!
			} -- Closing out the ror_table variable!

	-- ~~Table for faction, unit key and parameters for add_unit_to_faction_mercenary_pool. Every entry must have a "," at the end except the last~~		---- END REWRITE.
	~~local cror_list = {~~
	{faction_key = "wh_main_vmp_schwartzhafen", unit = "wh2_dlc11_cst_inf_zombie_deckhands_mob_ror_0", merc_pool = "renown", count = 1, rcp = 100, munits = 1, murpt = 0.1, xplevel = 0, frr = "", srr = "", trr = "", replen = true, merc_group = "wh2_dlc11_cst_inf_zombie_deckhands_mob_ror_0"},
	~~{faction_key = "wh_main_vmp_vampire_counts", unit = "wh2_dlc11_cst_inf_zombie_deckhands_mob_ror_0", merc_pool = "renown", count = 1, rcp = 100, munits = 1, murpt = 0~~.~~1, xplevel = 0, frr = "", srr = "", trr = "", replen = true, merc_group = "wh2_dlc11_cst_inf_zombie_deckhands_mob_ror_0"}~~
	};

	-- ~~Loop for~~ the ~~table above~~		-- List of default values to shove into the function before; shouldn't need to be changed, usecase may vary.
	~~for i = 1~~, ~~#cror_list do~~		local defaults = {
	~~local faction_name = cror_list[i]~~.~~faction_key; -- Faction whose pool the unit(s) should be added to~~		replen_chance = 100,
	local ~~faction~~ = ~~cm:get_faction(faction_name); -- FACTION_SCRIPT_INTERFACE~~		max = 1,
	~~local unit_key~~ = ~~cror_list[i].unit; -- Key of unit to add to the mercenary pool~~, ~~from the main_units table~~		max_per_turn = 0.1,
	~~local pool~~ = ~~cror_list[i].merc_pool; --NEW~~, ~~found in "ui_mercenary_recruitment_infos_tables" table, or in "mercenary_pools_tables" beneath UI recruitment info~~		xp_level = 0,
	~~local unit_count~~ = ~~cror_list[i]~~.~~count; -- Number of units to add to the mercenary pool~~		faction_restriction = "",
	~~local rcp~~ = ~~cror_list[i].rcp; -- Replenishment chance~~, ~~as a percentage~~		subculture_restriction = "",
	~~local munits~~ = ~~cror_list[i].munits; -- The maximum number of units of the supplied type that the pool is allowed to contain.~~		tech_restriction = "",
	~~local murpt~~ = ~~cror_list[i].murpt; -- The maximum number of units of the supplied type that may be added by replenishment per-turn~~		partial_replenishment = true,
	~~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~~
	~~local merc_grup_key = cror_list[i].merc_group; --NEW, key used in mercenary_unit_groups_tables can most of the time be the same has main_unit key~~

	~~-- Adding the listed unit to the listed faction~~ in ~~the above table~~		for i, ror in pairs(ror_table) do
	~~cm:add_unit_to_faction_mercenary_pool(faction~~, unit_key, ~~pool~~, ~~unit_count~~, ~~rcp~~, ~~munits, murpt, frr, srr, trr, replen, merc_grup_key);~~		local faction_key, unit_key = ror.faction_key, ror.unit_key
			local merc_pool, merc_group = ror.merc_pool, ror.merc_group
			local count = ror.count or 1 -- if ror.count is undefined, we'll just use the default of 1!

	~~-- Debug message for log~~		local faction = cm:get_faction(faction_key)
	~~out~~(~~"CROR: adding the custom ror unit "~~ .. ~~unit_key~~ .. ~~" to "~~ .. ~~faction_name~~);		if faction then
	end;		cm:add_unit_to_faction_mercenary_pool(
			faction,
			unit_key,
			merc_pool,
			count,
			defaults.replen_chance,
			defaults.max,
			defaults.max_per_turn,
			defaults.faction_restriction,
			defaults.subculture_restriction,
			defaults.tech_restriction,
			defaults.partial_replenishment,
			merc_group
			)
			end
			end
			end

	~~-- Setting saved value, so that the script doesn't run again when reloaded from a saved game~~		cm:add_first_tick_callback(function()
	cm:~~set_saved_value~~("~~custom_ror_enabled~~", ~~true)~~;		core:call_once(
	~~end;~~		"my_custom_function", -- RENAME this to a unique string; this is what the game uses to determine if the below code has been run before, must be unique per instance!
	~~end;~~		add_custom_ror -- Run the above function, rename if you've changed the name of the function above!
			)
	~~cm:add_first_tick_callback(function() add_custom_ror()~~ end);</nowiki>		end);</nowiki>

	~~== Warhammer III Example Scripts ==~~

Vandy: /* Using Example Scripts */

2022-11-28T03:43:59Z

Using Example Scripts

@@ Line 29: / Line 29: @@
 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 ==
+== Global Example Scripts ==
 === Replacing a Starting General ===
@@ Line 440: / Line 454: @@
 cm:add_first_tick_callback(function() add_custom_ror() end);</nowiki>

Not All is Dust: /* Example Scripts */

2022-09-12T22:07:59Z

Example Scripts

← Older revision		Revision as of 18:07, 12 September 2022
Line 391:		Line 391:

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

			=== Adding RoRs to mercenary pool, Wh3 version ===
			<nowiki>--[[
			Script by Aexrael Dex
			Adds custom Regiments of Renown to specified factions
			]]
			--Edited to function with total war warhammer 3, by All is Dust

			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. Every entry must have a "," at the end except the last
			local cror_list = {
			{faction_key = "wh_main_vmp_schwartzhafen", unit = "wh2_dlc11_cst_inf_zombie_deckhands_mob_ror_0", merc_pool = "renown", count = 1, rcp = 100, munits = 1, murpt = 0.1, xplevel = 0, frr = "", srr = "", trr = "", replen = true, merc_group = "wh2_dlc11_cst_inf_zombie_deckhands_mob_ror_0"},
			{faction_key = "wh_main_vmp_vampire_counts", unit = "wh2_dlc11_cst_inf_zombie_deckhands_mob_ror_0", merc_pool = "renown", count = 1, rcp = 100, munits = 1, murpt = 0.1, xplevel = 0, frr = "", srr = "", trr = "", replen = true, merc_group = "wh2_dlc11_cst_inf_zombie_deckhands_mob_ror_0"}
			};

			-- 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 pool = cror_list[i].merc_pool; --NEW, found in "ui_mercenary_recruitment_infos_tables" table, or in "mercenary_pools_tables" beneath UI recruitment info
			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
			local merc_grup_key = cror_list[i].merc_group; --NEW, key used in mercenary_unit_groups_tables can most of the time be the same has main_unit key

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

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

Fenriswolf: Fixed the broken link

2022-01-18T21:42:41Z

Fixed the broken link

← Older revision		Revision as of 17:42, 18 January 2022
Line 14:		Line 14:
	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.		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.		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 [[Lua:Debugging\|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.		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.

Fenriswolf: Set a space between the [[ of the example as it was getting picked up as a link and not as the symbols (as it should since you want to show how to comment in portuguese moon)

2021-03-29T17:44:17Z

Set a space between the [[ of the example as it was getting picked up as a link and not as the symbols (as it should since you want to show how to comment in portuguese moon)

← Older revision		Revision as of 13:44, 29 March 2021
Line 6:		Line 6:
	Each script listed is self-contained - so you can use multiple of the example scripts in a single .lua file.		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 ]].		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.		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.

Aexrael at 12:47, 3 February 2021

2021-02-03T12:47:38Z

← Older revision		Revision as of 08:47, 3 February 2021
Line 358:		Line 358:
	out("UNIQ: Spawned Jorek next to Markus");		out("UNIQ: Spawned Jorek next to Markus");

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

Aexrael at 12:46, 3 February 2021

2021-02-03T12:46:37Z

← Older revision		Revision as of 08:46, 3 February 2021
Line 213:		Line 213:
	cm:add_first_tick_callback(function() army_tweaks() end);</nowiki>		cm:add_first_tick_callback(function() army_tweaks() end);</nowiki>

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

	<nowiki>--[[		<nowiki>--[[

Aexrael at 12:46, 3 February 2021

2021-02-03T12:46:11Z

← Older revision		Revision as of 08:46, 3 February 2021
Line 300:		Line 300:

	cm:add_first_tick_callback(function() replace_cai_difficulty() end);</nowiki>		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>