Template:Passive feature page/doc: Difference between revisions

Jump to navigation Jump to search
m
no edit summary
(transclusion notice unneeded, can use documentation template)
mNo edit summary
(17 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Usage==
==Usage==
<pre>
<pre>
{{PassiveFeaturePage
{{Passive feature page
| this is an example =  
| this is an example =  
| summary =
| summary =
| description =
| description =
| extra description =
| image =
| image =
| icon =
| cost =
| recharge =
| additional =  
| additional =  
| toggleable =
| toggleable =
| condition =
| condition duration =
| condition save =
| condition dc =
| condition2 =
| condition2 duration =
| condition2 save =
| condition2 dc =
| condition3 =
| condition3 duration =
| condition3 save =
| condition3 dc =
| area =
| area shape =
| area range m =
| area range ft =
| area duration =
| X learns at level X =
| X learns at level X =
| granted by feats =
| granted by feats =
| granted by items =  
| granted by items =  
| granted by spells =  
| granted by spells =  
| grants =
| higher levels =
| used by creatures =
| used by creatures =
| other ways to learn =
| other ways to learn =
| notes =
| notes =
| bugs =
| video =
| video =
}}
}}
Line 32: Line 56:
},
},
"summary": {
"summary": {
"label": "Action summary",
"label": "Passive summary",
"description": "The summary of the action and its effects. This goes at the top of the article. Use description for the in-game text description.",
"description": "The summary of the passive feature and its effects. This goes at the top of the article. Use description for the in-game text description.",
"example": "This action allows the caster to unleash a streak of fire from their hands that ignites into a large explosion at a chosen point within range.",
"example": "This action 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",
"type": "content",
Line 39: Line 63:
},
},
"description": {
"description": {
"label": "Action description",
"label": "Passive description",
"description": "The raw in-game description of the action. Use summary for summarizing the action and its effects.",
"description": "The raw in-game passive description of the action. Use summary for summarizing the action and its effects.",
"example": "Shoot a bright flame from your fingers that explodes upon contact, torching everything in the vicinity for 8d6 Fire damage.",
"example": "Shoot a bright flame from your fingers that explodes upon contact, torching everything in the vicinity for 8d6 Fire damage.",
"type": "string",
"type": "string",
"required": true
"required": true
},
"extra description": {
"label": "Extra description",
"description": "The extra in-game description of the passive feature, shown when the tooltip is locked on screen.",
"type": "string"
},
},
"image": {
"image": {
"label": "Action image/icon",
"label": "Passive image",
"description": "The page's main image. [[File:NoImage Icon.webp|x40px]] will be used if empty.",
"description": "The page's main image. [[File:NoImage Icon.webp|x40px]] will be used if empty.",
"example": "Fireball Icon.png",
"example": "Defence.webp",
"type": "string",
"type": "string",
"suggested": true
"suggested": true
},
"icon": {
"label": "Passive icon",
"description": "The page's main icon.",
"example": "Defence Icon.webp",
"type": "string",
"suggested": true
},
"cost": {
"description": "Cost to use, in the case of a reaction",
"example": "action",
"type": "string"
},
"recharge": {
"description": "Action recharge time, if applicable",
"example": "Long Rest",
"type": "string"
},
},
"additional": {
"additional": {
Line 56: Line 102:
"description": "Any additional properties about the skill that are not covered by template go here, which goes under damage in properties",
"description": "Any additional properties about the skill that are not covered by template go here, which goes under damage in properties",
"type": "content"
"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"
]
},
"condition dc": {
"description": "The optional fixed DC of the condition that targets have to pass to apply it",
"example": "12",
"type": "number"
},
"condition2": {
"description": "The full name of the condition (if any) that is applied if there is a second condition.",
"example": "Hastened",
"type": "string"
},
"condition2 duration": {
"description": "The duration in turns of the action's second condition. Leave blank if the duration is unlimited.",
"example": "5",
"type": "number"
},
"condition2 save": {
"description": "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\"",
"example": "WIS",
"type": "string",
"suggestedvalues": [
"Strength",
"Dexterity",
"Constitution",
"Intelligence",
"Wisdom",
"Charisma"
]
},
"condition2 dc": {
"description": "The optional fixed DC of the second condition that targets have to pass to apply it",
"example": "12",
"type": "number"
},
"condition3": {
"description": "The full name of the condition (if any) that is applied if there is a third condition.",
"example": "Hastened",
"type": "string"
},
"condition3 duration": {
"description": "The duration in turns of the action's third condition. Leave blank if the duration is unlimited.",
"example": "5",
"type": "number"
},
"condition3 save": {
"description": "The save that the action's target must roll to avoid or reduce the effects of the third condition. Can use short or long name, e.g: \"STR\" or \"Strength\"",
"example": "WIS",
"type": "string",
"suggestedvalues": [
"Strength",
"Dexterity",
"Constitution",
"Intelligence",
"Wisdom",
"Charisma"
]
},
"condition3 dc": {
"description": "The optional fixed DC of the third condition that targets have to pass to apply it",
"example": "12",
"type": "number"
},
"toggleable": {
"toggleable": {
"label": "toggleable",
"label": "toggleable",
Line 222: Line 352:
"description": "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.",
"description": "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.",
"example": "Poisoner's Ring",
"example": "Poisoner's Ring",
"type": "string",
"suggested": false
},
        "grants": {
"description": "This specifies what spells/actions are granted to the user of this passive feature",
"example": "Heart of the Storm",
"type": "string",
"type": "string",
"suggested": false
"suggested": false
Line 230: Line 366:
"type": "string",
"type": "string",
"suggested": false
"suggested": false
},
"higher levels": {
"description": "If this feature changes at higher levels, list the changes here.",
"type": "string"
},
},
"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 related to the feature.",
"type": "content"
"type": "content"
},
},
Line 242: Line 386:
"description": "Other ways to learn. These will be inserted as-is at the end of the how to learn field.",
"description": "Other ways to learn. These will be inserted as-is at the end of the how to learn field.",
"type": "string"
"type": "string"
}
},
        "area": {},
        "area shape": {},
        "area range m": {},
        "area range ft": {},
        "area duration": {}
},
},
"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 249: Line 398:
"summary",
"summary",
"description",
"description",
        "extra description",
"image",
"image",
        "icon",
        "cost",
        "recharge",
         "toggleable",
         "toggleable",
"additional",
"additional",
"condition",
"condition duration",
"condition save",
        "condition dc",
"condition2",
"condition2 duration",
"condition2 save",
        "condition2 dc",
"condition3",
"condition3 duration",
"condition3 save",
        "condition3 dc",
        "area",
        "area shape",
        "area range m",
        "area range ft",
        "area duration",
"class learns at level 1",
"class learns at level 1",
"class learns at level 2",
"class learns at level 2",
Line 279: Line 449:
"granted by items",
"granted by items",
"granted by spells",
"granted by spells",
        "grants",
"used by creatures",
"used by creatures",
        "higher levels",
"notes",
"notes",
"bugs",
"video",
"video",
"this is an example",
"this is an example",
Line 288: Line 461:
</templatedata>
</templatedata>


==Example==
== Example ==
<pre>{{PassiveFeaturePage| this is an example = yes
 
| description = abc
<pre>
{{Passive feature page
| this is an example = yes
| description = Lets you fly all the way to Mount Doom.
| image = Fly Icon.png
| image = Fly Icon.png
| summary = fly you fools
| summary = Fly you fools!
| toggleable = yes
| toggleable = yes
| additional = * abcd
| warning = Spooky warning!
| recharge = Long Rest
| additional =
* Some additional info goes here.
| condition = Flight
| condition duration = 1
| 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 =
* Taking notes is very important.
| bugs =
* Caught a ladybug!
| video = Fireball-showcase.mp4
| video = Fireball-showcase.mp4
}}</pre>
| uid = foobar
{{PassiveFeaturePage| this is an example = yes
}}
| description = abc
</pre>
 
{{Passive feature page
| this is an example = yes
| description = Lets you fly all the way to Mount Doom.
| image = Fly Icon.png
| image = Fly Icon.png
| summary = fly you fools
| summary = Fly you fools!
| toggleable = yes
| toggleable = yes
| additional = * abcd
| warning = Spooky warning!
| recharge = Long Rest
| additional =
* Some additional info goes here.
| condition = Flight
| condition duration = 1
| 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 =
* Taking notes is very important.
| bugs =
* Caught a ladybug!
| video = Fireball-showcase.mp4
| video = Fireball-showcase.mp4
| uid = foobar
}}
}}


=== another example ===
=== Example 2 ===
{{PassiveFeaturePage| this is an example = yes
 
| description = abc
{{Passive feature page
| image = Fly Icon.png
| this is an example = yes
| summary = fly you fools 2
| description = Lets you fly all the way to Mount Doom.
| icon = Fly Icon.png
| summary = Fly again you fools!
| toggleable = yes
| additional =
* Some additional info goes here.
| higherlevels = go far
| other ways to learn =
* By ticking a giant space hamster
* Carameldansen under the Mouth of Bhaal
| uid = foobar
}}
 
=== Example 3 ===
 
{{Passive feature page
| this is an example = yes
| description = Lets you fly all the way to Mount Doom.
| summary = Keep flying you fools!
| toggleable = yes
| toggleable = yes
| additional = * abcd
| higherlevels = go far
| higherlevels = go far
| other ways to learn =  
| other ways to learn =  
* By ticking a giant space hamster
* By ticking a giant space hamster
* Carameldansen under the Mouth of Bhaal
* Carameldansen under the Mouth of Bhaal
| uid = foobar
}}
}}

Navigation menu