DND Engine Registry

weapon_category

Registers under Weapon Categories · source: modules/weapon_category/v1

`relevant_stat` is which of the seven core stats drives ToHit/damage for this category. `base_essence_type`/`special_essence_type` are EssenceType ids (see essence_type module) — `special_essence_type` is only set for a hybrid category like Ranged (a Stamina-like base pool plus a separate "ammo" pool for tipped arrows).

Example Usage

resource "magic" {
  source: modules/weapon_category/v1
  id: "magic"
  relevant_stat: "wisdom"
  base_essence_type: "mana"
  description: "Magic weapons/spells."
}

Arguments Reference

The following arguments are supported:

  • id - (Required) The unique id this record is registered and referenced under — what a `.resource` file's own filename-independent identity is, and what any other content's foreign-key-style field (a dungeon node's `next`, a skill node's `parent_id`, and so on) points at. community
  • relevant_stat - (Required) `relevant_stat` is which of the seven core stats drives ToHit/damage for this category. Currently registered: strength, agility, evasiveness, luck, vitality, wisdom and charisma. community
  • base_essence_type - (Required) `base_essence_type`/`special_essence_type` are EssenceType ids (see essence_type module) — `special_essence_type` is only set for a hybrid category like Ranged (a Stamina-like base pool plus a separate "ammo" pool for tipped arrows). Currently registered: ammo, mana and stamina. community
  • special_essence_type - (Optional) Currently registered: ammo, mana and stamina. Defaults to None. community
  • description - (Optional) Flavor text shown to players — pure display data with no effect on game mechanics. community