Skip to main content

Combatant Entry

A Combatant Entry is a special type of resource generate an encounter. It is used in conjunction with EncounterTemplate. These resources essentially represent a potential combatant that could be included in the combat, as well as a small set of constraints. These resources MUST comply with a very specific interface, containing some specific stats that must always be present.

Required stats

All combatant entries must have the following stats defined (either as base or calc stats):

  • integer min
  • integer max
  • decimal weight
  • resource combatant

The min, max, weight and difficulty_rating stats are all constraints that will be used by the app's encounter generator engine to produce a valid encounter for a specific difficulty level.

In particular, the app will ensure that no less than min combatants and no more than max combatants of this type are included in the combat. min will force a certain amount of this type of combatant to appear, and max will make sure to limit the maximum amount that can appear.

weight will be used to prioritize some combatants over others, increasing or decreasing the likelihood of a combatant showing up in the encounter. A higher weight means higher probability of appearing. For example, a weight of 1 vs a weight of 2 would mean that 2 is twice as likely to appear compared to 1.

Finally, the combatant resource will contain the actual reference to the instance of combatant that should be included in the combat. This resource, in and of its own, is just a wrapper.

IMPORTANT: the combatant resource type MUST be registered as a valid combatant in the system's combat_system definition. Otherwise the app will not know how to use it.