Mod API Reference:IncomeMod - Revision history

Fizzer at 15:24, 12 February 2025

2025-02-12T15:24:14Z

← Older revision		Revision as of 15:24, 12 February 2025
Line 1:		Line 1:
	'''IncomeMod''': Used to modify a player's income. Added in [[Mod_API_Reference:IsVersionOrHigher\|5.17.0]]. Income is defined as the number of armies the player receives in a turn (or gold in a [[commerce]] game). For these to have an effect, they should be passed to a [[Mod API Reference:GameOrderEvent\|GameOrderEvent]].		'''IncomeMod''': Used to modify a player's income. Added in [[Mod_API_Reference:IsVersionOrHigher\|5.17.0]]. Income is defined as the number of armies the player receives in a turn (or gold in a [[commerce]] game). For these to have an effect, they should be passed to a [[Mod API Reference:GameOrderEvent\|GameOrderEvent]].

			Income modifications are only good for one turn. After the turn ends, each player's income will revert to the default. If you want it to affect a player for additional turns, your mod will have to create it again for each turn.

	* '''Message''' ''string'': The message displayed to the player whose income is modified. This will be displayed in the Income Breakdown Dialog.		* '''Message''' ''string'': The message displayed to the player whose income is modified. This will be displayed in the Income Breakdown Dialog.

Fizzer at 23:53, 11 January 2022

2022-01-11T23:53:11Z

← Older revision		Revision as of 23:53, 11 January 2022
Line 1:		Line 1:
	'''IncomeMod''': Used to modify a player's income. Income is defined as the number of armies the player receives in a turn (or gold in a [[commerce]] game). For these to have an effect, they should be passed to a [[Mod API Reference:GameOrderEvent\|GameOrderEvent]].		'''IncomeMod''': Used to modify a player's income. Added in [[Mod_API_Reference:IsVersionOrHigher\|5.17.0]]. Income is defined as the number of armies the player receives in a turn (or gold in a [[commerce]] game). For these to have an effect, they should be passed to a [[Mod API Reference:GameOrderEvent\|GameOrderEvent]].

	* '''Message''' ''string'': The message displayed to the player whose income is modified. This will be displayed in the Income Breakdown Dialog.		* '''Message''' ''string'': The message displayed to the player whose income is modified. This will be displayed in the Income Breakdown Dialog.

Fizzer at 23:52, 11 January 2022

2022-01-11T23:52:39Z

← Older revision		Revision as of 23:52, 11 January 2022
Line 1:		Line 1:
	'''IncomeMod''': Used to modify a player's income. Income is defined as the number of armies the player receives in a turn (or gold in a [[commerce]] game).		'''IncomeMod''': Used to modify a player's income. Income is defined as the number of armies the player receives in a turn (or gold in a [[commerce]] game). For these to have an effect, they should be passed to a [[Mod API Reference:GameOrderEvent\|GameOrderEvent]].

	* '''Message''' ''string'': The message displayed to the player whose income is modified. This will be displayed in the Income Breakdown Dialog.		* '''Message''' ''string'': The message displayed to the player whose income is modified. This will be displayed in the Income Breakdown Dialog.

Fizzer: Created page with "'''IncomeMod''': Used to modify a player's income. Income is defined as the number of armies the player receives in a turn (or gold in a commerce game). * '''Message''' ..."

2022-01-11T23:50:17Z

Created page with "'''IncomeMod''': Used to modify a player's income. Income is defined as the number of armies the player receives in a turn (or gold in a commerce game). * '''Message''' ..."

New page

'''IncomeMod''': Used to modify a player's income. Income is defined as the number of armies the player receives in a turn (or gold in a [[commerce]] game).

* '''Message''' ''string'': The message displayed to the player whose income is modified. This will be displayed in the Income Breakdown Dialog.
* '''Mod''' ''integer'': The number of armies (or gold) to add, or subtract if negative.
* '''PlayerID''' ''[[Mod API Reference:PlayerID|PlayerID]]'': The ID of the player whose income is being modified. This must be an ID of a player in the current game.
* '''BonusID''' ''[[Mod API Reference:Nullable|Nullable]]<[[Mod API Reference:BonusID|BonusID]]>'': Optionally, a bonus ID. If specified, these armies/gold can only be only deployed within a single bonus, like in a Local Deployment game. Or if Mod is negative, this will reduce armies that were required to be deployed to this bonus.

== Functions ==

* '''WL.IncomeMod.Create'''('''pid''' ''[[Mod API Reference:PlayerID|PlayerID]]'', '''mod''' ''integer'', '''msg''' ''string'', '''bonusIDOpt''' ''[[Mod API Reference:Nullable|Nullable]]<[[Mod API Reference:BonusID|BonusID]]>'') (static) returns [[Mod API Reference:IncomeMod|IncomeMod]]:

[[Category:Mod API Reference]]