Template:Action page/doc: Difference between revisions
HiddenDragon (talk | contribs) No edit summary |
HiddenDragon (talk | contribs) (Updated doc to remove deprecated cost fields) |
||
Line 7: | Line 7: | ||
| image = | | image = | ||
| cost = | | cost = | ||
| hit cost = | | hit cost = | ||
| concentration = | | concentration = | ||
| damage = | | damage = | ||
Line 107: | Line 99: | ||
}, | }, | ||
"cost": { | "cost": { | ||
"description": " | "description": "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.", | ||
"example": "action", | "example": "action, ki:2", | ||
"suggestedvalues": [ | "suggestedvalues": [ | ||
"action", | "action", | ||
"bonus", | "bonus", | ||
"reaction", | "reaction", | ||
" | "movement", | ||
"half movement", | |||
"ki", | "ki", | ||
"supdie" | "supdie" | ||
Line 119: | Line 112: | ||
"suggested": true, | "suggested": true, | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
"hit cost": { | "hit cost": { | ||
"description": " | "description": "A comma separated list of resources used only if the action is successful. Any resource defined in [[Template:Resource]] can be used", | ||
"example": "ki, bonus", | "example": "ki, bonus", | ||
"suggestedvalues": [ | "suggestedvalues": [ | ||
Line 217: | Line 125: | ||
"suggested": true, | "suggested": true, | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
"attack roll": { | "attack roll": { | ||
Line 772: | Line 669: | ||
"image", | "image", | ||
"cost", | "cost", | ||
"hit cost", | "hit cost", | ||
"damage", | "damage", | ||
"damage2", | "damage2", |
Revision as of 23:13, 8 December 2023
Usage
{{ActionPage | this is an example = | summary = | description = | image = | cost = | hit cost = | concentration = | damage = | damage2 = | recharge = | duration = | save = | attack roll = | range = | range m = | range ft = | aoe = | aoe m = | aoe ft = | additional = | higherlevels = | variants = | variant of = | condition = | condition duration = | condition save = | condition dc = | condition2 = | condition2 duration = | condition2 save = | condition2 dc = | area = | area category = | area shape = | area range m = | area range ft = | area duration = | area turn start damage = | area turn start damage type = | area turn start damage save = | area turn start damage save effect = | area turn end damage = | area turn end damage type = | area turn end damage save = | area turn end damage save effect = | area condition = | area condition save = | area condition2 = | area condition2 save = | area condition3 = | area condition3 save = | area condition4 = | area condition4 save = | X learns at level X = | granted by feats = | granted by items = | granted by spells = | used by creatures = | notes = | video = }}
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.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Action summary | summary | The summary of the action and its effects. This goes at the top of the article. Use description for the in-game text description.
| Content | required |
Action description | description | The raw in-game description of the action. Use summary for summarizing the action and its effects.
| String | required |
Action image/icon | image | The page's main image. [[File:NoImage Icon.webp|x40px]] will be used if empty.
| String | suggested |
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.
| 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
| 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 |
attack roll | attack roll | Whether the action is reliant on a attack roll. 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 | Whether or not the action requires concentration. Blank = No, otherwise = Yes.
| String | optional |
range | range | The range of the action.
| 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.
| 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.
| 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 action's aoe shape, in meters.
| Number | optional |
aoe ft | aoe ft | This indicates the range of the action's aoe shape, in feet.
| Number | optional |
additional properties | 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 |
condition dc | condition dc | The optional fixed DC of the condition that targets have to pass to apply it
| Number | optional |
condition2 | condition2 | The full name of the condition (if any) that is applied if there is a second condition.
| String | optional |
condition2 duration | condition2 duration | The duration in turns of the action's second condition. Leave blank if the duration is unlimited.
| 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"
| String | optional |
condition2 dc | condition2 dc | The optional fixed DC of the second condition that targets have to pass to apply it
| Number | optional |
Action area name | area | Indicates the name of a special area/field/surface/cloud created by the action (if any). Leave blank if there is none.
| String | optional |
area category | area category | This indicates the type of area created by the action.
| String | optional |
area shape | area shape | This indicates the shape that the special area created by the action takes.
| String | optional |
area range m | area range m | Indicates the range of the area created by action, in meters.
| Number | optional |
area range ft | area range ft | Indicates the range of the area created by action, in feet.
| Number | optional |
area duration | area duration | This indicates how long the area created by the action lasts, in turns.
| Number | optional |
area turn start damage | area turn start damage | How much damage this area does to an entity starting its turn in it.
| String | optional |
area turn start damage type | area turn start damage type | The type of damage dealt to a creature starting its turn in the area created by this action.
| String | optional |
area turn start damage save | area turn start damage save | The saving throw an entity starting its turn in the area created by this action must roll in order to reduce or negate its damage.
| String | optional |
area turn start damage save effect | area turn start damage save effect | This indicates what effect a successful saving throw has on the damage applied to a creature starting its turn in this action's area. Leave blank to default to "negate".
| String | optional |
area turn end damage | area turn end damage | How much damage this area does to an entity ending its turn in it.
| String | optional |
area turn end damage type | area turn end damage type | The type of damage dealt to a creature ending its turn in the area created by this action.
| String | optional |
area turn end damage save | area turn end damage save | The saving throw an entity ending its turn in the area created by this action must roll in order to reduce or negate its damage.
| String | optional |
area turn end damage save effect | area turn end damage save effect | This indicates what effect a successful saving throw has on the damage applied to a creature ending its turn in this action's area. Leave blank to default to "negate".
| String | optional |
area condition | area condition | The full name of the condition applied by this action's area, leave blank if no condition is applied.
| String | optional |
area condition save | area 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 |
area condition2 | area condition2 | The full name of the second condition applied by this action's area, leave blank if no second condition is applied.
| String | optional |
area condition2 save | area condition2 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 |
area condition3 | area condition3 | The full name of the third condition applied by this action's area, leave blank if no third condition is applied.
| String | optional |
area condition3 save | area condition3 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 |
area condition4 | area condition4 | The full name of the fourth condition applied by this action's area, leave blank if no fourth condition is applied.
| String | optional |
area condition4 save | area condition4 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 action 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 |
variant of | variant of | The spell that is the parent of this spell
| 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.
| 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.
| 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.
| 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.
| 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.
| 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.
| 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.
| 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.
| 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.
| 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.
| 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.
| 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.
| String | optional |
race learns at level 1 | race learns at level 1 | This specifies what level the races get access to this action at level 1. You can use subrace names such as "Wood Elf" or "Seldarine Drow" as well.
| String | optional |
race learns at level 2 | race learns at level 2 | This specifies what level the races get access to this action at level 2. You can use subrace names such as "Wood Elf" or "Seldarine Drow" as well.
| String | optional |
race learns at level 3 | race learns at level 3 | This specifies what level the races get access to this action at level 3. You can use subrace names such as "Wood Elf" or "Seldarine Drow" as well.
| String | optional |
race learns at level 4 | race learns at level 4 | This specifies what level the races get access to this action at level 4. You can use subrace names such as "Wood Elf" or "Seldarine Drow" as well.
| String | optional |
race learns at level 5 | race learns at level 5 | This specifies what level the races get access to this action at level 5. You can use subrace names such as "Wood Elf" or "Seldarine Drow" as well.
| String | optional |
race learns at level 6 | race learns at level 6 | This specifies what level the races get access to this action at level 6. You can use subrace names such as "Wood Elf" or "Seldarine Drow" as well.
| String | optional |
race learns at level 7 | race learns at level 7 | This specifies what level the races get access to this action at level 7. You can use subrace names such as "Wood Elf" or "Seldarine Drow" as well.
| String | optional |
race learns at level 8 | race learns at level 8 | This specifies what level the races get access to this action at level 8. You can use subrace names such as "Wood Elf" or "Seldarine Drow" as well.
| String | optional |
race learns at level 9 | race learns at level 9 | This specifies what level the races get access to this action at level 9. You can use subrace names such as "Wood Elf" or "Seldarine Drow" as well.
| String | optional |
race learns at level 10 | race learns at level 10 | This specifies what level the races get access to this action at level 10. You can use subrace names such as "Wood Elf" or "Seldarine Drow" as well.
| String | optional |
race learns at level 11 | race learns at level 11 | This specifies what level the races get access to this action at level 11. You can use subrace names such as "Wood Elf" or "Seldarine Drow" as well.
| String | optional |
race learns at level 12 | race learns at level 12 | This specifies what level the races get access to this action at level 12. You can use subrace names such as "Wood Elf" or "Seldarine Drow" as well.
| String | optional |
granted by feats | granted by feats | This specifies what feats get access to this action. Similar to the class and race arguments, this list can be comma-separated as well.
| String | optional |
granted by items | granted by items | This specifies what items get access to this action. Similar to the class and race arguments, this list can be comma-separated as well.
| String | optional |
granted by spells | granted by spells | This specifies what spells get access to or trigger this action. Similar to the class and race arguments, this list can be comma-separated as well.
| String | optional |
used by creatures | used by creatures | This specifies which creatures use this action.
| String | optional |
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 |
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 |
higherlevels | higherlevels | no description | Unknown | 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 |
Example
{{ActionPage| this is an example = yes | description = abc | image = Fly Icon.png | summary = fly you fools | cost = action | hit cost = ki | hit cost amount = 2 | damage = amounttext: 1d4+1, type:Bludgeoning | damage2 = amount: 1d6, per:beam, type: Fire | recharge = Long Rest | range = melee | duration = LR | save = DEX, abc | additional = * abcd | higherlevels = go far | condition = Flight | condition duration = 1 | area = Darkness | area category = cloud | area shape = Radius | area range m = 5 | area range ft = 17 | area duration = 10 | area condition = Blinded | area condition save = STR | class learns at level 3 = Monk | race learns at level 5 = Wood Elf | notes = * bar | video = Fireball-showcase.mp4 }}
fly you fools
Description
abc
Properties
- Cost:
- Ki Point
- Cost on hit:
- Sorcery Point
- Damage:
- 1d4+1 Bludgeoning
- + 1d6 (1~6) Fire per beam
- Details:
- Melee: 1.5 m / 5 ft
- Creates Area: Darkness
- Recharge: Long rest
- Duration: LR turns
- DEX, abc Save
- abcd
Condition: Flight
Duration: 1 turn
- Fly up to target position, up to 18 m / 60 ft each turn using your Movement Speed.
Area: Darkness
Duration: 10 turns
AoE: 5 m / 17 ft (Radius)
A shroud of magical darkness that Heavily Obscures and Blinds creatures within. Creatures cannot make ranged attacks into or out of the darkness.
- Type: Cloud
Condition: Blinded
- Ranged attacks and spells have a range of 3 m / 10 ft and Attack Rolls suffer Disadvantage.
- Attack Rolls against Blinded creatures have Advantage.
How to learn
Classes:
- Class level 3: Monk
Races:
- Character level 5: Wood Elf
(Character level is the sum of all class levels for a multi-classed character.)
Notes
- bar
Visuals
another example
fly you fools 2
Description
abc
Properties
- Cost:
- Action
- Damage:
- 1d4+1 Bludgeoning
- Details:
- Melee: 1.5 m / 5 ft
- Recharge: Long rest
- Duration: LR turns
- DEX, abc Save
- abcd
How to learn
Other ways to learn:
- By ticking a giant space hamster
- Carameldansen under the Mouth of Bhaal