Modes

CombatMode

Table defining a combat mode.

Fields

use : function or true
Determines if combat mode is usable. If this field is true the mode is always usable if the feat used to apply it is usable.
modifier : function
Determines what the attack modifier is for a particular ATTACK_MODIFIER_* type. The function must accept two parameters an ATTACK_MODIFIER_* and a Creature instance. Returning nil indicates the ATTACK_MODIFIER_* is not applicable to the given mode.
GetCanUseMode(mode, cre)
Parameters:
  • mode (int) – COMBAT_MODE_*
  • cre (Creature) – Creature.
Return type:

boolean

GetModeModifier(mode, modifier, cre)
Parameters:
  • mode (int) – COMBAT_MODE_*
  • modifier (int) – ATTACK_MODIFIER_*
  • cre (Creature) – Creature.
Return type:

Dependent on modifier type.

RegisterMode(mode, ...)
Parameters:
  • mode (CombatMode) – Combat mode interface.
  • ... – COMBAT_MODE_* constant(s).