Template:Spell info/doc: Difference between revisions
mNo edit summary |
mNo edit summary |
||
(13 intermediate revisions by the same user not shown) | |||
Line 3: | Line 3: | ||
<templatedata> | <templatedata> | ||
{ | { | ||
"description": "Creates a spell info table.", | "description": "Creates a spell info table. if the nocat parameter is omitted, the page will automatically be categorized into categories for the spell level, spell school, and each class spell list.", | ||
"params": { | "params": { | ||
"name": { | "name": { | ||
Line 21: | Line 21: | ||
"cast": { | "cast": { | ||
"label": "cast time", | "label": "cast time", | ||
"description": "Action or time required to cast the spell. You can use \"BA\" or \"A\" for Bonus Action or Action.", | "description": "Action or time required to cast the spell. You can use \"BA\" or \"A\" for Bonus Action or Action, and \"R\" for Reaction.", | ||
"required": true, | "required": true, | ||
"type": "string", | "type": "string", | ||
"example": "BA" | "example": "BA" | ||
}, | |||
"trigger": { | |||
"label": "reaction trigger condition", | |||
"description": "The trigger to use for reaction spells.", | |||
"type": "string", | |||
"example": "", | |||
"default": "(omitted)" | |||
}, | |||
"ritual": { | |||
"label": "ritual flag", | |||
"description": "Whether the spell can be cast as a ritual (adding 10 minutes to the cast time in order to cast it without using a spell slot).", | |||
"type": "string", | |||
"example": "", | |||
"default": "(omitted)" | |||
}, | }, | ||
"range": { | "range": { | ||
Line 125: | Line 139: | ||
"lists": { | "lists": { | ||
"label": "spell lists", | "label": "spell lists", | ||
"description": "The spell lists which contain the spell.", | "description": "The spell lists which contain the spell. Classes on this list will not be automatically categorized, but it can be used to add the spell to subclass lists.", | ||
"required": true, | "required": true, | ||
"type": "string", | "type": "string", | ||
"example": "<li>Bard</li><li>Sorcerer</li><li>Warlock</li><li>Wizard</li>" | "example": "<li>Bard</li><li>Sorcerer</li><li>Warlock</li><li>Wizard</li>" | ||
}, | |||
"artificer": { | |||
"label": "on artificer spell list", | |||
"description": "Whether this spell is on the Artificer spell list.", | |||
"type": "string", | |||
"example": "", | |||
"default": "(omitted)" | |||
}, | |||
"bard": { | |||
"label": "on bard spell list", | |||
"description": "Whether this spell is on the Bard spell list.", | |||
"type": "string", | |||
"example": "", | |||
"default": "(omitted)" | |||
}, | |||
"cleric": { | |||
"label": "on cleric spell list", | |||
"description": "Whether this spell is on the Cleric spell list.", | |||
"type": "string", | |||
"example": "", | |||
"default": "(omitted)" | |||
}, | |||
"druid": { | |||
"label": "on druid spell list", | |||
"description": "Whether this spell is on the Druid spell list.", | |||
"type": "string", | |||
"example": "", | |||
"default": "(omitted)" | |||
}, | |||
"paladin": { | |||
"label": "on paladin spell list", | |||
"description": "Whether this spell is on the Paladin spell list.", | |||
"type": "string", | |||
"example": "", | |||
"default": "(omitted)" | |||
}, | |||
"ranger": { | |||
"label": "on ranger spell list", | |||
"description": "Whether this spell is on the Ranger spell list.", | |||
"type": "string", | |||
"example": "", | |||
"default": "(omitted)" | |||
}, | |||
"sorcerer": { | |||
"label": "on sorcerer spell list", | |||
"description": "Whether this spell is on the Sorcerer spell list.", | |||
"type": "string", | |||
"example": "", | |||
"default": "(omitted)" | |||
}, | |||
"warlock": { | |||
"label": "on warlock spell list", | |||
"description": "Whether this spell is on the Warlock spell list.", | |||
"type": "string", | |||
"example": "", | |||
"default": "(omitted)" | |||
}, | |||
"wizard": { | |||
"label": "on wizard spell list", | |||
"description": "Whether this spell is on the Wizard spell list.", | |||
"type": "string", | |||
"example": "", | |||
"default": "(omitted)" | |||
}, | }, | ||
"tooltip": { | "tooltip": { | ||
Line 135: | Line 212: | ||
"type": "string", | "type": "string", | ||
"example": "", | "example": "", | ||
"default": "(omitted)" | |||
}, | |||
"nocat": { | |||
"label": "remove automatic categories", | |||
"description": "Whether the template will automatically add certain categories to the page.", | |||
"type": "string", | |||
"example": "", | |||
"default": "(omitted)" | |||
}, | |||
"source": { | |||
"label": "source book", | |||
"description": "The third party / homebrew source which the spell comes from. Used for Cargo data purposes, and is not displayed.", | |||
"type": "string", | |||
"example": "The Crooked Moon", | |||
"default": "(omitted)" | "default": "(omitted)" | ||
} | } | ||
Line 153: | Line 244: | ||
|effect=Foreknowledge | |effect=Foreknowledge | ||
|description=You point a finger at a target in range. Your magic grants you a brief insight into the target's defenses. The next attack roll you make before the spell ends has advantage. | |description=You point a finger at a target in range. Your magic grants you a brief insight into the target's defenses. The next attack roll you make before the spell ends has advantage. | ||
| | |bard=true | ||
|sorcerer=true | |||
|warlock=true | |||
|wizard=true}}</pre> | |||
{{spell info | {{spell info | ||
|name=True Strike | |name=True Strike | ||
Line 164: | Line 258: | ||
|effect=Foreknowledge | |effect=Foreknowledge | ||
|description=You point a finger at a target in range. Your magic grants you a brief insight into the target's defenses. The next attack roll you make before the spell ends has advantage. | |description=You point a finger at a target in range. Your magic grants you a brief insight into the target's defenses. The next attack roll you make before the spell ends has advantage. | ||
| | |bard=true | ||
|sorcerer=true | |||
|warlock=true | |||
|wizard=true | |||
|nocat=true}} | |||
<includeonly>[[Category:homebrew templates]]</includeonly> | <includeonly>[[Category:homebrew templates]]</includeonly> |
Latest revision as of 12:42, 8 August 2025
This is a documentation subpage for Template:Spell info. It contains usage information, categories and other content that is not part of the original Template page. |
Parameters
Creates a spell info table. if the nocat parameter is omitted, the page will automatically be categorized into categories for the spell level, spell school, and each class spell list.
Parameter | Description | Type | Status | |
---|---|---|---|---|
spell name | name | The name of the spell.
| String | required |
spell level | level | The level of the spell. Use 0 for cantrips.
| Number | required |
cast time | cast | Action or time required to cast the spell. You can use "BA" or "A" for Bonus Action or Action, and "R" for Reaction.
| String | required |
reaction trigger condition | trigger | The trigger to use for reaction spells.
| String | optional |
ritual flag | ritual | Whether the spell can be cast as a ritual (adding 10 minutes to the cast time in order to cast it without using a spell slot).
| String | optional |
spell range | range | The range and area of the spell effect.
| String | required |
verbal flag | verbal | Whether the spell has a verbal component. Leave empty for false.
| String | optional |
somatic flag | somatic | Whether the spell has a somatic component. Leave empty for false.
| String | optional |
material flag | material | Whether the spell has material components. Leave empty for false.
| String | optional |
material components | components | Material components for the spell. Should be included if material is set
| String | optional |
spell duration | duration | How long the spell lasts.
| String | required |
concentration required | concentration | Set to true if the spell requires concentration.
| String | optional |
spell school | school | The school of magic to which the spell belongs. Must be one of Abjuration, Conjuration, Divination, Enchantment, Evocation, Illusion, Necromancy, or Transmutation.
| String | required |
attack type | attack | The type of attack made with the spell. Must be one of Ranged or Melee.
| String | optional |
save type | save | The saving throw made against the spell. Must be one of Strength, Constitution, Dexterity, Intelligence, Wisdom, or Charisma.
| String | optional |
damage type | damage | The type of damage dealt by the spell when it his or the target fails a save. Must be one of Bludgeoning, Piercing, Slashing, Acid, Cold, Fire, Force, Lightning, Necrotic, Poison, Psychic, Radiant, or Thunder.
| String | optional |
spell effect | effect | A category to place a non-damaging spell effect in. Required if damage parameter is omitted.
| String | optional |
has additional spell effects | additional | Set to true if the spell has additional damage types or effects beyond the first.
| String | optional |
spell description | description | The full text of the spell.
| String | required |
spell lists | lists | The spell lists which contain the spell. Classes on this list will not be automatically categorized, but it can be used to add the spell to subclass lists.
| String | required |
on artificer spell list | artificer | Whether this spell is on the Artificer spell list.
| String | optional |
on bard spell list | bard | Whether this spell is on the Bard spell list.
| String | optional |
on cleric spell list | cleric | Whether this spell is on the Cleric spell list.
| String | optional |
on druid spell list | druid | Whether this spell is on the Druid spell list.
| String | optional |
on paladin spell list | paladin | Whether this spell is on the Paladin spell list.
| String | optional |
on ranger spell list | ranger | Whether this spell is on the Ranger spell list.
| String | optional |
on sorcerer spell list | sorcerer | Whether this spell is on the Sorcerer spell list.
| String | optional |
on warlock spell list | warlock | Whether this spell is on the Warlock spell list.
| String | optional |
on wizard spell list | wizard | Whether this spell is on the Wizard spell list.
| String | optional |
toggle tooltip version | tooltip | Whether the spell info block is being used in a tooltip.
| String | optional |
remove automatic categories | nocat | Whether the template will automatically add certain categories to the page.
| String | optional |
source book | source | The third party / homebrew source which the spell comes from. Used for Cargo data purposes, and is not displayed.
| String | optional |
Examples
{{spell info |name=True Strike |level=0 |cast=BA |range=30 ft |somatic=true |duration=1 Round |school=Divination |effect=Foreknowledge |description=You point a finger at a target in range. Your magic grants you a brief insight into the target's defenses. The next attack roll you make before the spell ends has advantage. |bard=true |sorcerer=true |warlock=true |wizard=true}}

Level | Casting time | Range/Area | Components |
---|---|---|---|
Cantrip | 1 Bonus Action | 30 ft | S |
Duration | School | Attack/Save | Damage/Effect |
1 Round | Divination | None | Foreknowledge |
You point a finger at a target in range. Your magic grants you a brief insight into the target's defenses. The next attack roll you make before the spell ends has advantage.
- Bard
- Sorcerer
- Warlock
- Wizard