Template:Action page: Difference between revisions
m (update docs) |
(move docs over to templatedata) |
||
Line 263: | Line 263: | ||
</pre> | </pre> | ||
[[Category:Page Generating Templates]] | |||
{{HorizontalRuleImage}} | |||
{ | <templatedata> | ||
{ | |||
"params": { | |||
"this is an example": { | |||
"label": "If this is an example", | |||
"description": "If this is an example and you don't want the page to be categorized and related.", | |||
"example": "yes", | |||
"type": "string" | |||
}, | |||
"summary": { | |||
"label": "Action description summary", | |||
"description": "The summary of the action. This will be used as the wiki's description as well as the SEO text.", | |||
"example": "This spell allows the caster to unleash a streak of fire from their hands that ignites into a large explosion at a chosen point within range.", | |||
"type": "content", | |||
"required": true | |||
}, | |||
"description": { | |||
"label": "Action description", | |||
"description": "The in-game description of the action. This description is NOT for SEO 'See: summary'.", | |||
"example": "Shoot a bright flame from your fingers that explodes upon contact, torching everything in the vicinity for 8d6 Fire damage.", | |||
"type": "string", | |||
"required": true | |||
}, | |||
"image": { | |||
"label": "Action image/icon", | |||
"description": "The image that will be used in the page's SEO and be the page's main image.<br/>IF THIS IS LEFT EMPTY, [[File:NoImage Icon.webp|x40px]] WILL BE USED INSTEAD!", | |||
"example": "Fireball Icon.png", | |||
"type": "string", | |||
* Arcane Recovery: barins | "suggested": true | ||
* Channel Divinity: chadiv | }, | ||
* Channel Oath: chaoat | "cost": { | ||
* Ki: ki | "description": "The resource cost of the action. Format is {Resource}:{Amount}, {\"action\" if action etc.}. Resource types: \n* Arcane Recovery: barins \n* Channel Divinity: chadiv \n* Channel Oath: chaoat \n* Ki: ki \n* Lay On Hands: layonh \n* Natural Recovery: natrec \n* Rage: rage \n* Superiority Die: supdie \n* War Priest: warpri \n* Wild Shape: wldshp", | ||
* Lay On Hands: layonh | "example": "action", | ||
* Natural Recovery: natrec | "suggestedvalues": [ | ||
* Rage: rage | "ki:1, action", | ||
* Superiority Die: supdie | "supdie:1, bonus", | ||
* War Priest: warpri | "reaction" | ||
* Wild Shape: wldshp | ], | ||
"suggested": true, | |||
"type": "string" | |||
}, | |||
"level": { | |||
"label": "Spell level", | |||
"description": "Spell level if a spell. This overrides the resource portion of the cost parameter. Use \"cantrip\" to indicate a 0th level or cantrip spell.", | |||
"example": "2", | |||
"type": "string", | |||
"suggestedvalues": [ | |||
"cantrip", | |||
"1", | |||
"2", | |||
"3", | |||
"4", | |||
"5", | |||
"6" | |||
] | |||
}, | |||
"school": { | |||
"label": "Spell school", | |||
"description": "The school of magic that the spell belongs to.", | |||
"example": "Evocation", | |||
"type": "string", | |||
"suggestedvalues": [ | |||
"Abjuration", | |||
"Conjuration", | |||
"Divination", | |||
"Enchantment", | |||
"Evocation", | |||
"Illusion", | |||
"Necromancy", | |||
"Transmutation" | |||
] | |||
}, | |||
"ritual": { | |||
"description": "Indicates whether the spell is a ritual spell or not. Leave blank if not a ritual spell.", | |||
"example": "yes", | |||
"type": "string" | |||
}, | |||
"attack roll": { | |||
"description": "Whether the spell creates an attack roll or not. Leave blank if no attack roll is made.", | |||
"example": "Yes", | |||
"type": "string", | |||
"suggestedvalues": [ | |||
"Yes" | |||
], | |||
"default": "No" | |||
}, | |||
"damage": { | |||
"description": "The damage of the action. \n* amount: amount in number or die like 1d8 \n* amounttext: if your amount is text instead of a number or die you need to do this instead \n* type: damage type, i.e. Healing", | |||
"example": "amount:3d6, type:Acid", | |||
"type": "string" | |||
}, | |||
"damage2": { | |||
"description": "The secondary damage of the action. Will be output as damage + damage2. Same params as damage.", | |||
"example": "amount:6d20, type:Radiant", | |||
"type": "string" | |||
}, | |||
"recharge": { | |||
"description": "Action recharge time, if applicable", | |||
"example": "Long Rest", | |||
"type": "string" | |||
}, | |||
"duration": { | |||
"description": "Duration in turns of the action. Generally you will use condition duration instead.", | |||
"example": "10", | |||
"type": "string" | |||
}, | |||
"save": { | |||
"description": "The save (if any) that a target must roll against the damage effect of the action, with the result after the comma.", | |||
"example": "Dexterity", | |||
"suggestedvalues": [ | |||
"Strength, half damage", | |||
"Dexterity, negated", | |||
"Constitution", | |||
"Intelligence", | |||
"Wisdom", | |||
"Charisma" | |||
], | |||
"type": "string" | |||
}, | |||
"concentration": { | |||
"description": "If this skill is a concentration, type something here. Can be any value you want. Otherwise, leave it blank or delete the field entirely.", | |||
"example": "Yes", | |||
"type": "string", | |||
"suggestedvalues": [ | |||
"Yes", | |||
"No" | |||
], | |||
"default": "No" | |||
}, | |||
"range": { | |||
"description": "The range of the action.", | |||
"example": "ranged", | |||
"suggestedvalues": [ | |||
"ranged", | |||
"melee", | |||
"self" | |||
], | |||
"type": "string" | |||
}, | |||
"range m": { | |||
"description": "Use this parameter if the spell's range does not fit into one of the presets, \"melee\", \"ranged\", or \"self\". Indicates the range in meters.", | |||
"example": "5", | |||
"type": "number" | |||
}, | |||
"range ft": { | |||
"description": "Use this parameter if the spell's range does not fit into one of the presets, \"melee\", \"ranged\", or \"self\". Indicates the range in feet.", | |||
"example": "35", | |||
"type": "number" | |||
}, | |||
"aoe": { | |||
"description": "Indicates if the action affects an area, and what type of shape its effect is.", | |||
"example": "cone", | |||
"type": "string", | |||
"suggestedvalues": [ | |||
"radius", | |||
"cone", | |||
"cube", | |||
"line" | |||
] | |||
}, | |||
"aoe m": { | |||
"description": "This indicates the range of the spell's aoe shape, in meters.", | |||
"example": "5", | |||
"type": "number" | |||
}, | |||
"aoe ft": { | |||
"description": "This indicates the range of the spell's aoe shape, in feet.", | |||
"example": "15", | |||
"type": "number" | |||
}, | |||
"additional": { | |||
"description": "Any additional properties about the skill that are not covered by template go here, which goes under damage in properties", | |||
"example": "", | |||
"type": "content" | |||
}, | |||
"higher levels": { | |||
"description": "If the skills changes at higher levels, put info about that here", | |||
"example": "When the spell is cast at 2nd Level or higher, the damage increases 1d6 Fire damage for each spell slot level above 1st.", | |||
"type": "content" | |||
}, | |||
"condition": { | |||
"description": "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", | |||
"type": "string" | |||
}, | |||
"condition duration": { | |||
"description": "The duration in turns of the action's applied condition. Leave blank if the duration is unlimited.", | |||
"example": "5", | |||
"type": "number" | |||
}, | |||
"condition save": { | |||
"description": "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\"", | |||
"example": "WIS", | |||
"type": "string", | |||
"suggestedvalues": [ | |||
"Strength", | |||
"Dexterity", | |||
"Constitution", | |||
"Intelligence", | |||
"Wisdom", | |||
"Charisma" | |||
] | |||
}, | |||
"variants": { | |||
"description": "Comma-separated list of variants of the action, like the element types of Chromatic Orb.", | |||
"example": "Chromatic Orb: Fire, Chromatic Orb: Ice, Chromatic Orb: Acid, ...", | |||
"type": "string" | |||
}, | |||
"class learns at level X": { | |||
"description": "This specifies what level the classes get access to this action. Use e.g. \"class learns at level 5\" with a comma-separated list of classes to specify classes that learn this spell at class 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", | |||
"type": "string", | |||
"suggested": true | |||
}, | |||
"race learns at level X": { | |||
"description": "This specifies what level the races get access to this action. Use e.g. \"race learns at level 5\" with a comma-separated list of races to specify which races learn this spell at level 5. You can use subrace names such as \"Wood Elf\" or \"Seldarine Drow\" as well.", | |||
"example": "Elf, Seldarine Drow", | |||
"type": "string", | |||
"suggested": true | |||
}, | |||
"notes": { | |||
"description": "Any extra or related information about the action.", | |||
"type": "content" | |||
}, | |||
"video": { | |||
"description": "Name of an uploaded video file showcasing the action.", | |||
"type": "wiki-file-name" | |||
} | |||
}, | |||
"description": "This is a page to transclude to generate action pages. It is generally for pages that do not fit Template:SpellPage", | |||
"format": "block", | |||
"paramOrder": [ | |||
"this is an example", | |||
"summary", | |||
"description", | |||
"image", | |||
"level", | |||
"school", | |||
"cost", | |||
"damage", | |||
"damage2", | |||
"recharge", | |||
"duration", | |||
"ritual", | |||
"attack roll", | |||
"save", | |||
"concentration", | |||
"range", | |||
"range m", | |||
"range ft", | |||
"aoe", | |||
"aoe m", | |||
"aoe ft", | |||
"additional", | |||
"condition", | |||
"condition duration", | |||
"condition save", | |||
"higher levels", | |||
"variants", | |||
"class learns at level X", | |||
"race learns at level X", | |||
"notes", | |||
"video" | |||
] | |||
} | |||
</templatedata> | |||
=Example= | =Example= |
Revision as of 17:39, 6 September 2023
This is a page to transclude to generate action pages. It is generally for pages that do not fit the {{SpellPage}} Template
Usage
{{User:MetalPlateMage/ActionTemplate | this is an example = | summary = | description = | image = | level = | cost = | concentration = | damage = | damage2 = | recharge = | duration = | save = | attack roll = | ritual = | range = | range m = | range ft = | aoe = | aoe m = | aoe ft = | condition = | condition duration = | condition save = | additional = | higherlevels = | X learns at level X = | notes = }}
This is a page to transclude to generate action pages. It is generally for pages that do not fit Template:SpellPage
Parameter | Description | Type | Status | |
---|---|---|---|---|
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.
| String | optional |
Action description summary | summary | The summary of the action. This will be used as the wiki's description as well as the SEO text.
| Content | required |
Action description | description | The in-game description of the action. This description is NOT for SEO 'See: summary'.
| String | required |
Action image/icon | image | The image that will be used in the page's SEO and be the page's main image.<br/>IF THIS IS LEFT EMPTY, [[File:NoImage Icon.webp|x40px]] WILL BE USED INSTEAD!
| String | suggested |
Spell level | level | Spell level if a spell. This overrides the resource portion of the cost parameter. Use "cantrip" to indicate a 0th level or cantrip spell.
| String | optional |
Spell school | school | The school of magic that the spell belongs to.
| String | optional |
cost | cost | The resource cost of the action. Format is {Resource}:{Amount}, {"action" if action etc.}. Resource types:
| String | suggested |
damage | damage | The damage of the action.
| String | optional |
damage2 | damage2 | The secondary damage of the action. Will be output as damage + damage2. Same params as damage.
| String | optional |
recharge | recharge | Action recharge time, if applicable
| String | optional |
duration | duration | Duration in turns of the action. Generally you will use condition duration instead.
| String | optional |
ritual | ritual | Indicates whether the spell is a ritual spell or not. Leave blank if not a ritual spell.
| String | optional |
attack roll | attack roll | Whether the spell creates an attack roll or not. Leave blank if no attack roll is made.
| 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.
| String | optional |
concentration | concentration | If this skill is a concentration, type something here. Can be any value you want. Otherwise, leave it blank or delete the field entirely.
| String | optional |
range | range | The range of the action.
| String | optional |
range m | range m | Use this parameter if the spell's range does not fit into one of the presets, "melee", "ranged", or "self". Indicates the range in meters.
| Number | optional |
range ft | range ft | Use this parameter if the spell's range does not fit into one of the presets, "melee", "ranged", or "self". Indicates the range in feet.
| Number | optional |
aoe | aoe | Indicates if the action affects an area, and what type of shape its effect is.
| String | optional |
aoe m | aoe m | This indicates the range of the spell's aoe shape, in meters.
| Number | optional |
aoe ft | aoe ft | This indicates the range of the spell's aoe shape, in feet.
| Number | optional |
additional | additional | Any additional properties about the skill that are not covered by template go here, which goes under damage in properties
| Content | 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.
| String | optional |
condition duration | condition duration | The duration in turns of the action's applied condition. Leave blank if the duration is unlimited.
| 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"
| String | optional |
higher levels | higher levels | If the skills changes at higher levels, put info about that here
| Content | optional |
variants | variants | Comma-separated list of variants of the action, like the element types of Chromatic Orb.
| String | optional |
class learns at level X | class learns at level X | This specifies what level the classes get access to this action. Use e.g. "class learns at level 5" with a comma-separated list of classes to specify classes that learn this spell at class level 5. You can use subclass names such as "Fiend" or "Light Domain" to indicate that Fiend Warlocks or Light Domain clerics gain access.
| String | suggested |
race learns at level X | race learns at level X | This specifies what level the races get access to this action. Use e.g. "race learns at level 5" with a comma-separated list of races to specify which races learn this spell at level 5. You can use subrace names such as "Wood Elf" or "Seldarine Drow" as well.
| String | suggested |
notes | notes | Any extra or related information about the action. | Content | optional |
video | video | Name of an uploaded video file showcasing the action. | File | optional |
Example
{{User:MetalPlateMage/ActionTemplate | this is an example = yes | description = abc | image = Fly Icon.png | summary = fly you fools | cost = ki:2, action | damage = amounttext: 1d4+1, type:Bludgeoning | damage2 = amount: 1d6, type: Fire | recharge = Long Rest | range = melee | duration = LR | save = DEX, abc | additional = * abcd | condition = Flight | condition duration = 1 | higherlevels = go far | notes = * bar | class learns at level 3 = Monk | race learns at level 5 = Wood Elf }}
fly you fools
Description
abc
Properties
- Cost:
- Action + 2Ki Points
- Damage:
- 1d4+1 Bludgeoning + 1d6 (1~6) Fire
- Details:
- Melee: 1.5 m / 5 ft
- Recharge: Long rest
- Duration: LR turns
- DEX Save (On Save: abc)
- abcd
At Higher Levels
go far
Condition: Flight
Duration: 1 turn
- Fly up to target position, up to 18 m / 60 ft each turn using your Movement Speed.
How to Learn
Classes:
- Class Level 3:
Races:
- Character Level 5:
(Character Level is the sum of all Class Levels for a multi-classed character.)
Notes
- bar