Toggle menu
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Template:Ability

Template page
Revision as of 03:11, 27 December 2024 by Gpe (talk | contribs)

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.

Power Sources

  • divine: bool (optional, defaults to 0)
    Indicates whether the ability is associated with the Divine power source.
  • magic: bool (optional, defaults to 0)
    Indicates whether the ability is associated with the Magic 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.

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.

Usage

  • 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.

Delivery

  • delivery: str (optional)
    Use to override the default delivery method.
  • 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.
  • 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.
  • 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.
  • 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.
  • vitals: bool (optional, defaults to 0)
    Indicates if the ability is a vitals attack.
  • leg: bool (optional, defaults to 0)
    Indicates if the ability is a leg attack.
  • arm: bool (optional, defaults to 0)
    Indicates if the ability is an arm attack.
  • passive: bool (optional, defaults to 0)
    Indicates if the ability is passive.

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).

Range

  • range: str (optional)
    Use to override the default range description.
  • rangeDist: int (optional, defaults varies by delivery)
    Specifies the range distance in feet.

Duration

  • duration: str (optional)
    Use to override the default duration description.
  • 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.

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.