Template:Weapon action page: Difference between revisions

Revision as of 20:36, 20 October 2024

Template documentation

Usage

{{Weapon action page
| this is an example = 
| summary =
| weapons =
| weapon types =
| description =
| extra description = 
| image =
| controller icon =
| icon =
| cost =
| hit cost =
| damage =
| damage type =
| damage modifier =
| extra damge = 
| extra damage type = 
| extra damage modifier = 
| extra damge 2 = 
| extra damage type 2 = 
| extra damage modifier 2 = 
| recharge =
| duration =
| save =
| save dc =
| on save =
| attack roll = 
| on miss =
| range =
| range m = 
| range ft = 
| aoe =
| aoe m =
| aoe ft =
| variants =
| variant of =
| condition =
| condition duration = 
| condition save = 
| condition dc =
| condition2 =
| condition2 duration = 
| condition2 save = 
| condition2 dc =
| area =
| area shape = 
| area range m =
| area range ft =
| area duration =
| X learns at level X =
| granted by feats =
| used by creatures =
| other ways to learn =
| warning =
| notes =
| bugs =
}}

This generates pages that don't fit other generators, automatically formatting and categorizing the page. Don't be daunted by the number of parameters/options and fill in what you need.

Template parameters
This template prefers block formatting of parameters.
Parameter		Description	Type	Status
Weapon Action summary	`summary`	The summary of the weapon action and its effects. This goes at the top of the article. If not specified, this will be auto-generated based on the 'weapons' and weapon types' parameters. Example This weapon action allows the use to strike all targets within melee range.	Content	optional
Weapons	`weapons`	Specifies the weapons that grant this weapon action. Will be used to auto-generate the summary above. Example The Undead Bane	String	optional
Weapon types	`weapon types`	Specifies the weapon types that grant this weapon action. Used for common weapon actions that appear based on the base weapon type Example Daggers, Pikes, Rapiers, Shortswords, Tridents	String	optional
Weapon Action description	`description`	The raw in-game description of the action. Use summary for summarizing the action and its effects. Example Spend a superiority die to deal {{C\|Weapon Damage + 1d8 Physical damage}} and possibly {{Cond\|Frightened\|Frighten}} the target.	Content	optional
Extra description	`extra description`	The extra in-game description of the weapon action, shown when the tooltip is locked on screen.	String	optional
Tooltip Image	`image`	The page's main image used for the tooltip in-game. This should be 380x380 Example Zephyr Flash Faded.webp	String	suggested
Controller Icon	`controller icon`	The weapon action's controller icon, used for controller interfaces. This should be the 144x144. Example Zephyr Flash Unfaded.webp	String	suggested
Icon	`icon`	The weapon action's small icon, used for the hotbar. This should be the 64x64. Example Zephyr Flash Unfaded Icon.webp	String	required
cost	`cost`	A comma separated list of resources used to perform the action. Use a colon and a number to specify > 1 cost. Valid resources are any resource available in the Resource Template. Suggested values `action` `bonus` `reaction` `movement` `half movement` `ki` `supdie` Example action, ki:2	String	suggested
hit cost	`hit cost`	A comma separated list of resources used only if the action is successful. Any resource defined in [[Template:Resource]] can be used Suggested values `action` `bonus` `reaction` `supdie` `ki` Example ki, bonus	String	suggested
damage	`damage`	The damage of the action, expressed as a number, damage dice, or in text Suggested values `1d4` `20` `Weapon Damage` Example 3d6	String	optional
damage type	`damage type`	The type of damage being dealt Suggested values `Slashing` `Piercing` `Bludgeoning` `Acid` `Fire` `Cold` `Lightning` `Thunder` `Necrotic` `Poison` `Healing` Example Acid	String	optional
damage modifier	`damage modifier`	Any modifiers to the damage, found after the plus sign in the damage tooltip. Often a flexible value that scales with the source's ability scores. Suggested values `STR` `DEX` `Spellcasting` Example STR	String	optional
extra damage	`extra damage`	The secondary damage of the action, if applicable. Will be output as damage + damage2. Same parameters as damage. Extra damage can be added up to six times by adding and incrementing the parameters each additional time, i.e. extra damage 2, extra damage type 2 etc. Suggested values `1d4` `20` `Weapon Damage` Example 3d6	String	optional
extra damage type	`extra damage type`	The type of damage being dealt Suggested values `Slashing` `Piercing` `Bludgeoning` `Acid` `Fire` `Cold` `Lightning` `Thunder` `Necrotic` `Poison` `Healing` Example Acid	String	optional
extra damage modifier	`extra damage modifier`	Any modifiers to the damage, found after the plus sign in the damage tooltip. Often a flexible value that scales with the source's ability scores. Suggested values `STR` `DEX` `Spellcasting` Example STR	String	optional
recharge	`recharge`	Action recharge time, if applicable Example Long Rest	String	optional
duration	`duration`	Duration in turns of the action. Generally you will use condition duration instead. Example 10	String	optional
attack roll	`attack roll`	Whether the action is reliant on a attack roll and it's type. Leave blank if no attack roll is made. Suggested values `yes` `melee weapon` `melee spell` `melee unarmed` `melee off-hand weapon` `ranged weapon` `ranged spell` `ranged unarmed` `ranged off-hand weapon` Default No	String	optional
on miss	`on miss`	Used in conjunction with 'attack roll' describes what happens if the action misses its attack roll. Suggested values `Targets still take half damage.` Example Targets still take half damage.	String	optional
save	`save`	The save (if any) that a target must roll against the damage effect of the action, with the result after the comma. Suggested values `Strength, half damage` `Dexterity, negated` `Constitution` `Intelligence` `Wisdom` `Charisma` Example Dexterity	String	optional
on save	`on save`	Used in conjunction with 'save', describes what happens when the target successfully makes their saving throw. Suggested values `Targets still take half damage.` Example Targets still take half damage.	String	optional
range	`range`	The range of the action. Suggested values `ranged` `melee` `self` Example ranged	String	optional
range m	`range m`	Use this parameter if the action's range does not fit into one of the presets, "melee", "ranged", or "self". Indicates the range in meters. Example 5	Number	optional
range ft	`range ft`	Use this parameter if the action's range does not fit into one of the presets, "melee", "ranged", or "self". Indicates the range in feet. Example 35	Number	optional
aoe	`aoe`	Indicates if the action affects an area, and what type of shape its effect is. Suggested values `radius` `cone` `cube` `line` Example cone	String	optional
aoe m	`aoe m`	This indicates the range of the action's aoe shape, in meters. Example 5	Number	optional
aoe ft	`aoe ft`	This indicates the range of the action's aoe shape, in feet. Example 15	Number	optional
condition	`condition`	The full name of the condition (if any) that this action applies to its target/s. Leave blank if there is no condition. Example Hastened	String	optional
condition duration	`condition duration`	The duration in turns of the action's applied condition. Leave blank if the duration is unlimited. Example 5	Number	optional
condition save	`condition save`	The save that the action's target must roll to avoid or reduce its effects. Can use short or long name, e.g: "STR" or "Strength" Suggested values `Strength` `Dexterity` `Constitution` `Intelligence` `Wisdom` `Charisma` Example WIS	String	optional
condition dc	`condition dc`	The optional fixed DC of the condition that targets have to pass to apply it Example 12	Number	optional
condition2	`condition2`	The full name of the condition (if any) that is applied if there is a second condition. Example Hastened	String	optional
condition2 duration	`condition2 duration`	The duration in turns of the action's second condition. Leave blank if the duration is unlimited. Example 5	Number	optional
condition2 save	`condition2 save`	The save that the action's target must roll to avoid or reduce the effects of the second condition. Can use short or long name, e.g: "STR" or "Strength" Suggested values `Strength` `Dexterity` `Constitution` `Intelligence` `Wisdom` `Charisma` Example WIS	String	optional
condition2 dc	`condition2 dc`	The optional fixed DC of the second condition that targets have to pass to apply it Example 12	Number	optional
Area name	`area`	Indicates the page of a special area/field/surface/cloud created by the action (if any). Leave blank if there is none. Example Hunger of Hadar (area)	String	optional
area shape	`area shape`	This indicates the shape that the special area created by the action takes. Suggested values `Radius` `Cone` `Cube` Example Radius	String	optional
area range m	`area range m`	Indicates the range of the area created by the action, in meters. Example 5	Number	optional
area range ft	`area range ft`	Indicates the range of the area created by the action, in feet. Example 12	Number	optional
area duration	`area duration`	This indicates how long the area created by the action lasts, in turns. Example 6	Number	optional
variants	`variants`	Comma-separated list of variants of the action, like the element types of Divine Strike. Example Divine Strike: Fire, Divine Strike: Ice, Divine Strike: Cold, ...	String	optional
variant of	`variant of`	The weapon action that is the parent of this weapon action Example Divine Strike	String	optional
class learns at level 1	`class learns at level 1`	This specifies what level the classes get access to this action at level 1. You can use subclass names such as "Fiend" or "Light Domain" to indicate that Fiend Warlocks or Light Domain clerics gain access. Example Sorcerer, Wizard, Fiend, Light Domain	String	optional
class learns at level 2	`class learns at level 2`	This specifies what level the classes get access to this action at level 2. You can use subclass names such as "Fiend" or "Light Domain" to indicate that Fiend Warlocks or Light Domain clerics gain access. Example Sorcerer, Wizard, Fiend, Light Domain	String	optional
class learns at level 3	`class learns at level 3`	This specifies what level the classes get access to this action at level 3. You can use subclass names such as "Fiend" or "Light Domain" to indicate that Fiend Warlocks or Light Domain clerics gain access. Example Sorcerer, Wizard, Fiend, Light Domain	String	optional
class learns at level 4	`class learns at level 4`	This specifies what level the classes get access to this action at level 4. You can use subclass names such as "Fiend" or "Light Domain" to indicate that Fiend Warlocks or Light Domain clerics gain access. Example Sorcerer, Wizard, Fiend, Light Domain	String	optional
class learns at level 5	`class learns at level 5`	This specifies what level the classes get access to this action at level 5. You can use subclass names such as "Fiend" or "Light Domain" to indicate that Fiend Warlocks or Light Domain clerics gain access. Example Sorcerer, Wizard, Fiend, Light Domain	String	optional
class learns at level 6	`class learns at level 6`	This specifies what level the classes get access to this action at level 6. You can use subclass names such as "Fiend" or "Light Domain" to indicate that Fiend Warlocks or Light Domain clerics gain access. Example Sorcerer, Wizard, Fiend, Light Domain	String	optional
class learns at level 7	`class learns at level 7`	This specifies what level the classes get access to this action at level 7. You can use subclass names such as "Fiend" or "Light Domain" to indicate that Fiend Warlocks or Light Domain clerics gain access. Example Sorcerer, Wizard, Fiend, Light Domain	String	optional
class learns at level 8	`class learns at level 8`	This specifies what level the classes get access to this action at level 8. You can use subclass names such as "Fiend" or "Light Domain" to indicate that Fiend Warlocks or Light Domain clerics gain access. Example Sorcerer, Wizard, Fiend, Light Domain	String	optional
class learns at level 9	`class learns at level 9`	This specifies what level the classes get access to this action at level 9. You can use subclass names such as "Fiend" or "Light Domain" to indicate that Fiend Warlocks or Light Domain clerics gain access. Example Sorcerer, Wizard, Fiend, Light Domain	String	optional
class learns at level 10	`class learns at level 10`	This specifies what level the classes get access to this action at level 10. You can use subclass names such as "Fiend" or "Light Domain" to indicate that Fiend Warlocks or Light Domain clerics gain access. Example Sorcerer, Wizard, Fiend, Light Domain	String	optional
class learns at level 11	`class learns at level 11`	This specifies what level the classes get access to this action at level 11. You can use subclass names such as "Fiend" or "Light Domain" to indicate that Fiend Warlocks or Light Domain clerics gain access. Example Sorcerer, Wizard, Fiend, Light Domain	String	optional
class learns at level 12	`class learns at level 12`	This specifies what level the classes get access to this action at level 12. You can use subclass names such as "Fiend" or "Light Domain" to indicate that Fiend Warlocks or Light Domain clerics gain access. Example Sorcerer, Wizard, Fiend, Light Domain	String	optional
warning	`warning`	Warning text for the tooltip that doesn't belong in the description.	String	optional
granted by feats	`granted by feats`	This specifies what feats get access to this weapon action. Similar to the class and race arguments, this list can be comma-separated as well. Example Magic Initiate: Druid	String	optional
used by creatures	`used by creatures`	This specifies which creatures use this action. Example Magma Mephit	String	optional
notes	`notes`	Any extra or related information about the action.	Content	optional
bugs	`bugs`	Any known bugs about the action.	Content	optional
If this is an example	`this is an example`	If this is an example and you don't want the page to be categorized and related. Example yes	String	optional
other ways to learn	`other ways to learn`	Other ways to learn. These will be inserted as-is at the end of the how to learn field.	String	optional