[*Back to Index*](index.md.html)
Game Rule
=================
This mod item allows you to define a game rule. It can be selected in the new game menu and has a significant effect over gameplay.
Gameplay effects for the game rules can be defiened using [Effects](ModItemEffect.md.html).
Properties
----------
Id (self.id)
: This is the internal unique id of the game rule. It is not visible by users.
Display Name (self.display_name)
: This is the user-visible name of the commander profile, visible when choose commander in game combo.
Challenge Mod (%) (self.challenge_mod)
: Challenge difficulty bonus (in percent) apply to calculate map difficulty bonus.
Description (self.description)
: Short, user-visible description of that commander profile and its effects.
Flavor (self.flavor)
: Short flavor text
Filter (self.filter)
: Lua expression that will be evaluated to check whether to show this game rule in game combo.
Exclusion List (self.exclusion_list)
: A list of the IDs of all the game rules which are not compatibatible the current game rule. All characters, including space, are allowed as separators, except for letters.
Param 1 (self.param1)
: Here can be stored a parameter used in the definition of the game rule.
Param1_desc (self.param1_desc)
: This is used to describe what role does the parameter have in this game rule.
(insert footer.md.html here)