Template:Ability

Template Frontend

This template is designed for tagging and categorizing abilities, spells, and related game elements. It supports a wide range of parameters to provide detailed metadata, such as the type of ability, its delivery method, associated elements, power sources, and more.

Parameters

• 1: str (required)

  The main content or description of the ability.

• name: str (required)

  The name of the ability or spell, used for categorization.

• flavor: str (optional)

  Flavor text for the ability.

Power Sources

• divine: bool (optional, defaults to 0)

  Indicates whether the ability is associated with the Divine power source.

• magical: bool (optional, defaults to 0)

  Indicates whether the ability is associated with the Magical power source.

• primal: bool (optional, defaults to 0)

  Indicates whether the ability is associated with the Primal power source.

• spiritual: bool (optional, defaults to 0)

  Indicates whether the ability is associated with the Spirit power source.

• martial: bool (optional, defaults to 0)

  Indicates whether the ability is associated with the Martial power source.

• alchemical: bool (optional, defaults to 0)

  Indicates whether the ability is associated with the Alchemical power source.

• psionic: bool (optional, defaults to 0)

  Indicates whether the ability is associated with the Psionic power source.

• technologic: bool (optional, defaults to 0)

  Indicates whether the ability is associated with the Technologic power source.

Elements

• life: bool (optional, defaults to 0)

  Indicates whether the ability is associated with the Life element.

• storm: bool (optional, defaults to 0)

  Indicates whether the ability is associated with the Storm element.

• necro: bool (optional, defaults to 0)

  Indicates whether the ability is associated with the Necromancy element.

• flame: bool (optional, defaults to 0)

  Indicates whether the ability is associated with the Flame element.

• nature: bool (optional, defaults to 0)

  Indicates whether the ability is associated with the Nature element.

Effect Types

• mental: bool (optional, defaults to 0)

  Indicates if the ability is a mental effect.

• control: bool (optional, defaults to 0)

  Indicates if the ability is a control effect.

• movement: bool (optional, defaults to 0)

  Indicates if the ability is a movement effect.

• displacement: bool (optional, defaults to 0)

  Indicates if the ability is a displacement effect.

• transformation: bool (optional, defaults to 0)

  Indicates if the ability is a transformation effect.

Delivery

• delivery: str (optional)

  Use to override the default delivery method.

• passive: bool (optional, defaults to 0)

  Indicates if the ability is passive.

• self: bool (optional, defaults to 0)

  Indicates if the ability is self-targeted.

• strike: bool (optional, defaults to 0)

  Indicates if the ability is a strike attack (requires a weapon).

• bite: bool (optional, defaults to 0)

  Indicates if the ability is a bite ability.

• blood: bool (optional, defaults to 0)

  Indicates if the ability is a blood ability.

• sight: bool (optional, defaults to 0)

  Indicates if the ability is a sight ability.

• ritual: bool (optional, defaults to 0)

  Indicates if the ability is delivered through a ritual.

• ray: bool (optional, defaults to 0)

  Indicates if the ability is delivered as a ray.

• ball: bool (optional, defaults to 0)

  Indicates if the ability is delivered as a ball.

• touch: bool (optional, defaults to 0)

  Indicates if the ability is delivered through touch.

• aura: bool (optional, defaults to 0)

  Indicates if the ability is delivered as an aura.

• tag: bool (optional, defaults to 0)

  Indicates if the ability is a tag ability.

• cone: bool (optional, defaults to 0)

  Indicates if the ability is a cone ability.

• field: bool (optional, defaults to 0)

  Indicates if the ability is some other field.

Delivery Modifiers

• deliveryMod: str (optional)

  Use to override the default delivery modifier description.

• av0: bool (optional, defaults to 0, or 1 for rays)

  Use if the ability is an AV0 attack.

  This can be forcibly set to 0.

• ub: bool (optional, defaults to 0, or 1 for balls and touches)

  Use if the ability is a UB attack.

  This can be forcibly set to 0.

• vitals: bool (optional, defaults to 0)

  Indicates if the ability is a vitals attack.

• arm: bool (optional, defaults to 0)

  Indicates if the ability is an arm attack.

• leg: bool (optional, defaults to 0)

  Indicates if the ability is a leg attack.

Delivery Extensions

• ripple: bool (optional, defaults to 0)

  Indicates if the ability is a ripple ability.

• detonate: bool (optional, defaults to 0)

  Indicates if the ability is a detonate ability.

• cascade: bool (optional, defaults to 0)

  Indicates if the ability is a cascade ability.

• fork: bool (optional, defaults to 0)

  Indicates if the ability is a fork ability.

Usage Requirements

• oc: bool (optional, defaults to 0)

  Indicates if the ability is usable out of combat.

• bc: bool (optional, defaults to 0)

  Indicates if the ability is usable before combat.

• ic: bool (optional, defaults to 0)

  Indicates if the ability is usable in combat.

Casting/Execution Time

• time: str (optional)

  Use to override the default casting or execution time.

• re: bool (optional, defaults to 0)

  Indicates if the ability is reactive.

• num: int (optional, defaults to na)

  Specifies the number of actions (or reactions) required to cast or execute the ability.

  Use 0 for free actions (or free reactions).

  Possible values: 0, 1, 2, 3, na.

Cost

• cost: str (optional)

  Use to override the default cost description.

• invoke: bool (optional, defaults to 0)

  Indicates if the ability requires invoking.

• mana: int (optional, defaults to 0)

  Specifies the number of mana needed to use the ability.

• upcast: str (optional)

  Defines what happens when you Heighten this ability.

Target

• target: str (optional)

  Use to override the default target description.

• targetType: str (optional, defaults to creature)

  Specifies the type of target (e.g., creature, item).

• targetMax: int (optional, defaults to 0)

  Specifies the max number of targets.

  When the value is 0, there is no specified maximum number.

Range

• range: str (optional)

  Use to override the default range description.

• rangeDist: int (optional, defaults varies by delivery)

  Specifies the range distance in feet.

• rangeRad: int (optional, defaults varies by delivery)

  Specifies the range radius in feet.

Duration

• duration: str (optional)

  Use to override the default duration description.

• durationTime: int (optional, defaults to 1)

  Sets a numerical duration time.

• durationUnit: str (optional)

  Sets a unit for the duration time.

• durationReq: str (optional, defaults to alive)

  Sets a condition that must be met for duration to continue

  Common conditions are alive and up

• sustained: bool (optional, defaults to 0)

  Indicates if the ability is sustained.

• end: bool (optional, defaults to 0)

  Indicates if the ability has some other end condition.

Flags Completion

• stat: str (optional)

  Flags the ability as improving this stat.

  The possible values are: int, str, mov, per, snk

• statVal: int (optional, defaults to 0)

  Flags the value that the ability sets the stat to.

• statProf: bool (optional, defaults to 0)

  Flags the ability giving proficiency in the specified stat.

• statFlu: bool (optional, defaults to 0)

  Flags the ability giving fluency in the specified stat.

Text Completion

• noText: bool (optional), defaults to 1)

  Enable to turn off the automatic filler text.

  This is not yet implemented.

• trigger: str (optional)

  Triggering condition for ability.

• critHit: str (optional)

  Effects that occur on a Critical Hit.

• hit: str (optional)

  Effects that occur on a Hit.

• critMiss: str (optional)

  Effects that occur on a Critical Miss.

• miss: str (optional)

  Effects that occur on a Miss.

• critFail: str (optional)

  Effects that occur on a Critically Failed Save.

• fail: str (optional)

  Effects that occur on a Failed Save.

• save: str (optional)

  Effects that occur on a Successful Save.

• critSave: str (optional)

  Effects that occur on a Critically Successful Save.

End Condition Text Completion

• rollEnd: bool (optional, defaults to 0)

  Specifies that a condition created by this spell ends on a d4 roll.

• rollTime: str (optional, defaults to start)

  Specifies when in the turn to roll the d4.

• rollWho: str (optional, defaults to the target's

  Specifies who's turn has the d4 roll.

  Recommended values are the target's and your

Class Ranks

• class: str (optional)

  Specifies what standard class this ability is from.

  Options are: ber, bar, due, sam, vet, kni, pal, ass, cor, ama, arc, thi, ran, fla, sto, lif, nec, nat

  Note that several options are synonyms for the same class.

• rank>: int (optional, defaults to nr)

  Specifies what standard class rank this ability belongs to.

• warrior: bool (optional, defaults to 0

  Forcibly specify this as a Warrior ability.

• mage: bool (optional, defaults to 0

  Forcibly specify this as a Mage ability.

• semi: bool (optional, defaults to 0

  Forcibly specify this as a Semi ability.

Additional Information

The template supports numerous parameters for categorizing abilities into various categories automatically. Boolean parameters (e.g., life, storm) trigger their respective tags and categories when set to a truthy value.

Template Backend

The backend utilizes nested logic and conditional structures to generate tags and categories dynamically based on the provided parameters. This approach ensures flexibility and reduces the need for manual categorization.

Key features include:

• Tagging elements, power sources, and delivery methods using the {{{1}}} sub-template.
• Categorizing abilities dynamically based on the combination of parameters (e.g., elements, power sources, combat phases).
• Supporting fallback values and default behaviors for missing parameters.

For optimal usage, ensure that all required parameters are supplied and optional parameters are set thoughtfully to achieve desired categorizations.