Editing Mod API Reference:IncomeMod

'''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.
* '''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]]
Latest revision		Your text
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. 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.