Template:Action page/doc: Difference between revisions

Jump to navigation Jump to search

Template:Action page/doc (view source)

Revision as of 00:00, 5 May 2024

2,104 bytes removed ,  5 May
Updated area doc
m (sp)
(Updated area doc)
(21 intermediate revisions by 6 users not shown)
Line 1: Line 1:
<includeonly>{{hatnote|The following documentation was transcluded from [[Template:Action Page/doc]].}}</includeonly>
==Usage==
 
=Usage=
<pre>
<pre>
{{ActionPage
{{ActionPage
Line 7: Line 5:
| summary =
| summary =
| description =
| description =
| extra description =
| image =
| image =
| level =
| controller icon =
| school =
| icon =
| cost =
| cost =
| hit cost =
| concentration =
| concentration =
| damage =
| damage =
| damage2 =
| damage type =
| damage modifier =
| extra damge =
| extra damage type =
| extra damage modifier =  
| recharge =
| recharge =
| duration =
| duration =
| save =
| save =
| on save =
| attack roll =  
| attack roll =  
| ritual =
| on miss =
| range =
| range =
| range m =  
| range m =  
Line 26: Line 31:
| aoe ft =
| aoe ft =
| additional =  
| additional =  
| higherlevels =
| higher levels =
| variants =
| variants =
| variant of =
| condition =
| condition =
| condition duration =  
| condition duration =  
| condition save =  
| condition save =  
| condition dc =
| condition2 =
| condition2 =
| condition2 duration =  
| condition2 duration =  
| condition2 save =  
| condition2 save =  
| condition2 dc =
| area =
| area =
| area category =
| area shape =
| area shape =
| area range m =
| area range m =
| area range ft =
| area range ft =
| area duration =
| 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 =
| X learns at level X =
| granted by feats =
| granted by feats =
Line 61: Line 52:
| granted by spells =  
| granted by spells =  
| used by creatures =
| used by creatures =
| warning =
| notes =
| notes =
| bugs =
| video =
| video =
}}
}}
</pre>
</pre>


[[Category:Page Generating Templates]]
[[Category:Page generating templates]]
{{HorizontalRuleImage}}
{{HorizontalRuleImage}}


Line 91: Line 84:
"type": "string",
"type": "string",
"required": true
"required": true
},
"extra description": {
"label": "Extra description",
"description": "The extra in-game description of the action, shown when the tooltip is locked on screen.",
"type": "string"
},
},
"image": {
"image": {
"label": "Action image/icon",
"label": "Tooltip image",
"description": "The page's main image. [[File:NoImage Icon.webp|x40px]] will be used if empty.",
"description": "The page's main tool image, used in the in-game tooltips. Should be 380x380.",
"example": "Fireball Icon.png",
"example": "Fireball.webp",
"type": "string",
"suggested": true
},
"controller icon": {
"label": "Controller icon",
"description": "The class action's controller icon, used in the controller only interface. Should be 144x144.",
"example": "Fireball Icon.webp",
"type": "string",
"suggested": true
},
"icon": {
"label": "icon",
"description": "The class action's small icon, used in the hotkey bar. Should be 64x64.",
"example": "Fireball Icon.webp",
"type": "string",
"type": "string",
"suggested": true
"suggested": true
},
},
"cost": {
"cost": {
"description": "The resource cost of the action. \"action\", \"bonus\", \"reaction\", and \"freeaction\" are acceptable by themselves or in combination with a resource in the format {Resource}:{Amount}. Resource types: Arcane Recovery: arcrec, Bardic Inspiration: barins, Channel Divinity: chadiv, Channel Oath: chaoat, Fungal Infestation: fnginf, Ki: ki, Lay On Hands: layonh, Natural Recovery: natrec, Rage: rage, Superiority Die: supdie, Tides of Chaos: toc, War Priest: warpri, and Wild Shape: wldshp.",
"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": "ki:1, action",
"example": "action, ki:2",
"suggestedvalues": [
"suggestedvalues": [
"action",
"action",
"bonus",
"bonus",
"reaction",
"reaction",
"freeaction",
"movement",
"ki:1, action",
                "half movement",
"supdie:1, bonus"
"ki",
"supdie"
],
],
"suggested": true,
"suggested": true,
"type": "string"
"type": "string"
},
},
"level": {
        "hit cost": {
"label": "Spell level",
"description": "A comma separated list of resources used only if the action is successful. Any resource defined in [[Template:Resource]] can be used",
"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": "ki, bonus",
"example": "2",
"suggestedvalues": [
"action",
"bonus",
"reaction",
"supdie",
"ki"
],
"suggested": true,
"type": "string"
},
"attack roll": {
"description": "Whether the action is reliant on a attack roll and it's type. Leave blank if no attack roll is made.",
"type": "string",
"suggestedvalues": [
"yes",
"melee weapon",
"melee spell",
"melee unarmed",
"melee off-hand weapon",
"ranged weapon",
"ranged spell",
"ranged unarmed",
"ranged off-hand weapon"
],
"default": "No"
},
        "on miss": {
"description": "Used in conjunction with 'attack roll' describes what happens if the action misses its attack roll.",
"example": "Targets still take half damage.",
"type": "string",
"suggestedvalues": [
"Targets still take half damage."
]
},
"damage": {
"description": "The damage of the action, expressed as a number, damage dice, or in text",
"example": "3d6",
"type": "string",
"type": "string",
"suggestedvalues": [
"suggestedvalues": [
"cantrip",
"1d4",
"1",
                "20",
"2",
                "Weapon Damage"
"3",
"4",
"5",
"6"
]
]
},
},
"school": {
"damage type": {
"label": "Spell school",
"description": "The type of damage being dealt",
"description": "The school of magic that the spell belongs to.",
"example": "Acid",
"example": "Evocation",
"type": "string",
"type": "string",
"suggestedvalues": [
"suggestedvalues": [
"Abjuration",
"Slashing",
"Conjuration",
                "Piercing",
"Divination",
                "Bludgeoning",
"Enchantment",
                "Acid",
"Evocation",
                "Fire",
"Illusion",
                "Cold",
"Necromancy",
                "Lightning",
"Transmutation"
                "Thunder",
                "Necrotic",
                "Poison",
                "Healing"
]
]
},
},
"ritual": {
        "damage modifier": {
"description": "Indicates whether the action is a ritual spell or not. Leave blank if not a ritual spell.",
"description": "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.",
"example": "yes",
"example": "STR",
"type": "string"
"type": "string",
"suggestedvalues": [
"STR",
                "DEX",
                "Spellcasting"
]
},
},
"attack roll": {
        "extra damage": {
"description": "Whether the action is reliant on a attack roll. Leave blank if no attack roll is made.",
"description": "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.",
"example": "Yes",
"example": "3d6",
"type": "string",
"type": "string",
"suggestedvalues": [
"suggestedvalues": [
"Yes"
"1d4",
],
                "20",
"default": "No"
                "Weapon Damage"
]
},
},
"damage": {
"extra damage type": {
"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",
"description": "The type of damage being dealt",
"example": "amount:3d6, type:Acid",
"example": "Acid",
"type": "string",
"type": "string",
"suggestedvalues": [
"suggestedvalues": [
"amounttext:Weapon, type:Physical"
"Slashing",
                "Piercing",
                "Bludgeoning",
                "Acid",
                "Fire",
                "Cold",
                "Lightning",
                "Thunder",
                "Necrotic",
                "Poison",
                "Healing"
]
]
},
},
"damage2": {
        "extra damage modifier": {
"description": "The secondary damage of the action. Will be output as damage + damage2. Same params as damage.",
"description": "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.",
"example": "amount:6d20, type:Radiant",
"example": "STR",
"type": "string",
"type": "string",
"suggestedvalues": [
"suggestedvalues": [
"amounttext:Weapon, type:Physical"
"STR",
                "DEX",
                "Spellcasting"
]
]
},
},
Line 196: Line 261:
],
],
"type": "string"
"type": "string"
},
        "on save": {
"description": "Used in conjunction with 'save', describes what happens when the target successfully makes their saving throw.",
"example": "Targets still take half damage.",
"type": "string",
"suggestedvalues": [
"Targets still take half damage."
]
},
},
"concentration": {
"concentration": {
Line 280: Line 353:
"Charisma"
"Charisma"
]
]
},
"condition dc": {
"description": "The optional fixed DC of the condition that targets have to pass to apply it",
"example": "12",
"type": "number"
},
},
"condition2": {
"condition2": {
Line 303: Line 381:
"Charisma"
"Charisma"
]
]
},
"condition2 dc": {
"description": "The optional fixed DC of the second condition that targets have to pass to apply it",
"example": "12",
"type": "number"
},
},
"area": {
"area": {
Line 309: Line 392:
"example": "Hunger of Hadar",
"example": "Hunger of Hadar",
"type": "string"
"type": "string"
},
"area category": {
"description": "This indicates the type of area created by the action.",
"example": "surface",
"type": "string",
"suggestedvalues": [
"cloud",
"surface",
"area"
],
"default": "area"
},
},
"area shape": {
"area shape": {
Line 346: Line 418:
"type": "number"
"type": "number"
},
},
"area turn start damage": {
"warning": {
"description": "How much damage this area does to an entity starting its turn in it.",
"description": "Warning text for the tooltip that doesn't belong in the description.",
"example": "2d4",
"type": "string"
},
"area turn start damage type": {
"description": "The type of damage dealt to a creature starting its turn in the area created by this action.",
"example": "Cold",
"type": "string"
},
"area turn start damage save": {
"description": "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.",
"example": "Dexterity",
"type": "string",
"suggestedvalues": [
"Strength",
"Dexterity",
"Constitution",
"Intelligence",
"WIsdom",
"Charisma"
]
},
"area turn start damage save effect": {
"description": "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\".",
"example": "half",
"type": "string",
"suggestedvalues": [
"half",
"negate"
],
"default": "negate"
},
"area turn end damage": {
"description": "How much damage this area does to an entity ending its turn in it.",
"example": "2d4",
"type": "string"
},
"area turn end damage type": {
"description": "The type of damage dealt to a creature ending its turn in the area created by this action.",
"example": "Necrotic",
"type": "string"
},
"area turn end damage save": {
"description": "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.",
"example": "Dexterity",
"type": "string",
"suggestedvalues": [
"Strength",
"Dexterity",
"Constitution",
"Intelligence",
"Wisdom",
"Charisma"
]
},
"area turn end damage save effect": {
"description": "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\".",
"type": "string",
"suggestedvalues": [
"half",
"negate"
],
"default": "negate"
},
"area condition": {
"description": "The full name of the condition applied by this action's area, leave blank if no condition is applied.",
"example": "Burning",
"type": "string"
},
"area 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"
]
},
"area condition2": {
"description": "The full name of the second condition applied by this action's area, leave blank if no second condition is applied.",
"example": "Burning",
"type": "string"
},
"area condition2 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"
]
},
"area condition3": {
"description": "The full name of the third condition applied by this action's area, leave blank if no third condition is applied.",
"example": "Burning",
"type": "string"
"type": "string"
},
"area condition3 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"
]
},
"area condition4": {
"description": "The full name of the fourth condition applied by this action's area, leave blank if no fourth condition is applied.",
"example": "Burning",
"type": "string"
},
"area condition4 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": {
"variants": {
"description": "Comma-separated list of variants of the action, like the element types of Chromatic Orb.",
"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, ...",
"example": "Chromatic Orb: Fire, Chromatic Orb: Ice, Chromatic Orb: Acid, ...",
"type": "string"
},
"variant of": {
"description": "The spell that is the parent of this spell",
"example": "Chromatic Orb",
"type": "string"
"type": "string"
},
},
Line 658: Line 602:
"notes": {
"notes": {
"description": "Any extra or related information about the action.",
"description": "Any extra or related information about the action.",
"type": "content"
},
"bugs": {
"description": "Any known bugs about the action.",
"type": "content"
"type": "content"
},
},
Line 664: Line 612:
"type": "wiki-file-name"
"type": "wiki-file-name"
},
},
"plain summary": {},
"other ways to learn": {
"distance": {},
"description": "Other ways to learn. These will be inserted as-is at the end of the how to learn field.",
"no spell slot": {
"type": "string"
"description": "If defined, will hide the spell slot requirement,",
}
"type": "boolean"
},
"higherlevels": {}
},
},
"description": "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.",
"description": "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.",
Line 677: Line 622:
"summary",
"summary",
"description",
"description",
        "extra description",
"image",
"image",
"level",
"controller icon",
"school",
"icon",
"cost",
"cost",
        "hit cost",
"damage",
"damage",
"damage2",
"damage type",
        "damage modifier",
        "extra damage",
        "extra damage type",
        "extra damage modifier",
"recharge",
"recharge",
"duration",
"duration",
"ritual",
"attack roll",
"attack roll",
"on miss",
"save",
"save",
"on save",
"concentration",
"concentration",
"range",
"range",
Line 699: Line 651:
"condition duration",
"condition duration",
"condition save",
"condition save",
        "condition dc",
"condition2",
"condition2",
"condition2 duration",
"condition2 duration",
"condition2 save",
"condition2 save",
        "condition2 dc",
"area",
"area",
"area category",
"area shape",
"area shape",
"area range m",
"area range m",
"area range ft",
"area range ft",
"area duration",
"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",
"higher levels",
"higher levels",
"variants",
"variants",
        "variant of",
"class learns at level 1",
"class learns at level 1",
"class learns at level 2",
"class learns at level 2",
Line 750: Line 688:
"race learns at level 11",
"race learns at level 11",
"race learns at level 12",
"race learns at level 12",
"warning",
"granted by feats",
"granted by feats",
"granted by items",
"granted by items",
Line 755: Line 694:
"used by creatures",
"used by creatures",
"notes",
"notes",
"bugs",
"video",
"video",
"this is an example",
"this is an example",
"plain summary",
"other ways to learn"
"distance",
"no spell slot",
"higherlevels"
]
]
}
}
</templatedata>
</templatedata>


=Example=
==Example==
<pre>{{ActionPage| this is an example = yes
<pre>{{ActionPage| this is an example = yes
| description = abc
| description = abc
| image = Fly Icon.png
| image = Fly Icon.png
| summary = fly you fools
| summary = fly you fools
| cost = ki:2, action, sp:1
| cost = action
| hit cost = ki
| hit cost amount = 2
| damage = amounttext: 1d4+1, type:Bludgeoning
| damage = amounttext: 1d4+1, type:Bludgeoning
| damage2 = amount: 1d6, per:beam, type: Fire
| damage2 = amount: 1d6, per:beam, type: Fire
Line 778: Line 717:
| save = DEX, abc
| save = DEX, abc
| additional = * abcd
| additional = * abcd
| higherlevels = go far
| higher levels = go far
| condition = Flight
| condition = Flight
| condition duration = 1
| condition duration = 1
Line 791: Line 730:
| class learns at level 3 = Monk
| class learns at level 3 = Monk
| race learns at level 5 = Wood Elf
| race learns at level 5 = Wood Elf
| notes = * bar
| notes =
* Some note.
| bugs =
* Some known bug.
| video = Fireball-showcase.mp4
| video = Fireball-showcase.mp4
}}</pre>
}}</pre>
Line 798: Line 740:
| image = Fly Icon.png
| image = Fly Icon.png
| summary = fly you fools
| summary = fly you fools
| cost = ki:2, action, sp:1
| cost = ki
| cost amount = 2
| cost2 = action
| hit cost = sp
| damage = amounttext: 1d4+1, type:Bludgeoning
| damage = amounttext: 1d4+1, type:Bludgeoning
| damage2 = amount: 1d6, per:beam, type: Fire
| damage2 = amount: 1d6, per:beam, type: Fire
Line 806: Line 751:
| save = DEX, abc
| save = DEX, abc
| additional = * abcd
| additional = * abcd
| higherlevels = go far
| higher levels = go far
| condition = Flight
| condition = Flight
| condition duration = 1
| condition duration = 1
Line 819: Line 764:
| class learns at level 3 = Monk
| class learns at level 3 = Monk
| race learns at level 5 = Wood Elf
| race learns at level 5 = Wood Elf
| notes = * bar
| notes =
* Some note.
| bugs =
* Some known bug.
| video = Fireball-showcase.mp4
| video = Fireball-showcase.mp4
}}
}}
Line 828: Line 776:
| image = Fly Icon.png
| image = Fly Icon.png
| summary = fly you fools 2
| summary = fly you fools 2
| cost = action, toc:1
| cost = action
| cost2 = toc
| damage = amounttext: 1d4+1, type:Bludgeoning
| damage = amounttext: 1d4+1, type:Bludgeoning
| recharge = Long Rest
| recharge = Long Rest
Line 835: Line 784:
| save = DEX, abc
| save = DEX, abc
| additional = * abcd
| additional = * abcd
| higherlevels = go far
| higher levels = go far
| other ways to learn =
* By ticking a giant space hamster
* Carameldansen under the Mouth of Bhaal
}}
}}
Retrieved from "https://bg3.wiki/wiki/Special:MobileDiff/80390...182262"

Navigation menu