Mod API Reference:PlayerIncome

PlayerIncome: Represents the income of a player (i.e. how many armies they're receiving per turn.) You can access the Total property to see the player's income as an integer. In a Local deployment game, you can access FreeArmies and BonusRestrictions to see where the income can be deployed.

• ArmyCapInEffect boolean: True if the player's income was reduced due to the army cap, otherwise false.
• BonusRestrictions Table<BonusID,integer>: In a Local deployment game, this is the number of armies that can be deployed on each specific bonus.
• FreeArmies integer: In a Local deployment game, this is the number of armies that can be deployed anywhere.
• Total integer: