Template:Area page/doc: Difference between revisions

Jump to navigation Jump to search
Updated doc
(Moved doc to own page)
 
(Updated doc)
Line 5: Line 5:
|name=
|name=
|image=
|image=
|controller icon=
|icon =
|summary=
|summary=
|description=
|description=
|type=<!--surface,cloud,or omit-->
|type=<!--surface,cloud,or omit-->
|difficult terrain=
|movement multiplier=
|condition1=
|condition=
|condition1 no save=
|condition save=
|condition dc=
|condition2=
|condition2=
|condition2 no save=
|condition2 save=
|condition2 dc=
|created by items=
|created by items=
|created by spells=
|created by spells=
Line 55: Line 59:
"params": {
"params": {
"image": {
"image": {
"description": "A file without the File: prefix. ",
"description": "A 380x380 image without the File: prefix. ",
"type": "wiki-file-name",
"suggested": true
},
"controller icon": {
"description": "A 144x144 image without the File: prefix. ",
"type": "wiki-file-name",
"suggested": true
},
"icon": {
"description": "A 64x64 icon without the File: prefix. ",
"type": "wiki-file-name",
"type": "wiki-file-name",
"suggested": true
"suggested": true
Line 67: Line 81:
"type": "content",
"type": "content",
"suggested": true
"suggested": true
},
"difficult terrain": {
"description": "If specified, marks the area as Difficult Terrain.",
"type": "boolean"
},
},
"description": {
"description": {
Line 83: Line 93:
"suggestedvalues": [
"suggestedvalues": [
"cloud",
"cloud",
"surface"
"surface",
                "summoned"
],
            "default": "surface"
},
"movement multiplier": {
"description": "The multiplier to movement costs when inside this area",
"type": "number",
"suggested": true,
            "default": "1"
},
"condition": {
"description": "The full name of the condition (if any) that this area applies to its target/s. Leave blank if there is no condition.",
"example": "Hastened",
"type": "string"
},
"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"
]
]
},
},
"condition1": {
"condition dc": {
"description": "The first condition inflicted by this area",
"description": "The optional fixed DC of the condition that targets have to pass to apply it",
"type": "wiki-page-name"
"example": "12",
"type": "number"
},
},
"condition1 no save": {
"condition2": {
"description": "If specified, notes that the condition is applied while in area",
"description": "The full name of the condition (if any) that is applied if there is a second condition.",
"type": "boolean"
"example": "Hastened",
"type": "string"
},
},
"condition2": {
"condition2 save": {
"description": "The second condition inflicted by this area",
"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\"",
"type": "wiki-page-name"
"example": "WIS",
},  
"type": "string",
"condition2 no save": {
"suggestedvalues": [
"description": "If specified, notes that the condition is applied while in area"
"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"
},
},
"created by items": {
"created by items": {
Line 122: Line 171:
"name",
"name",
"image",
"image",
        "controller icon",
        "icon",
"summary",
"summary",
"difficult terrain",
"description",
"description",
"type",
"type",
"condition1",
        "movement multiplier",
"condition1 no save",
"condition",
"condition save",
        "condition dc",
"condition2",
"condition2",
"condition2 no save",
"condition2 save",
        "condition2 dc",
"created by items",
"created by items",
"created by spells",
"created by spells",

Navigation menu