Skip to content

Enums

A table containing all enums used in the game.

Can be accessed as follows:

game.enums

An enum value used to represent an adjective.

An adjective describes a type of damage. Units may deal specific types of damage, such as physical or poison. Units may also be resistant or particularly vulnerable to certain adjectives.

Values

  • physical
  • poison

An enum value used to represent an allegiance.

An allegiance describes a relationship between two units. Units may be opponent or ally to each other: player’s units are ally to each other, but opponent to the enemy’s units.

Use the any allegiance when you want to ignore the allegiance of a unit, for example if an attack can hit both opponents and allies.

Values

  • any
  • opponent
  • ally

An enum value used to represent whether a unit is a corpse (i.e. dead).

Values

  • no
  • yes

An enum value used to represent the “family” of a unit.

Families can be used, for example, to implement abilities that only affect units of the same family.

Values

  • skeleton

An enum value used to represent a targetting priority.

Used when selecting a target for an ability.

Values

  • closest

An enum value used to represent an attribute of a unit.

Used when retreiving or buffing stats.

Values

  • attack

Adjectives

A table containing all members of the Adjectives enum.

An adjective can be accessed as follows:

game.enums.Adjective.physical

Allegiances

A table containing all members of the Allegiances enum.

An allegiance can be accessed as follows:

game.enums.Allegiance.opponent

CorpseStatus

A table containing all members of the CorpseStatus enum.

A corpse status can be accessed as follows:

game.enums.Corpse.yes

Families

A table containing all members of the Families enum.

A family can be accessed as follows:

game.enums.Family.skeleton

TargetPriorities

A table containing all members of the TargetPriorities enum.

A target priority can be accessed as follows:

game.enums.TargetPriority.closest

Stats

A table containing all members of the Stats enum.

A stat can be accessed as follows:

game.enums.Stats.attack