Template:Area page/doc: Difference between revisions

From bg3.wiki
Jump to navigation Jump to search
(Moved doc to own page)
 
mNo edit summary
 
(One intermediate revision by the same user not shown)
Line 3: Line 3:
Copy-ready: <pre>
Copy-ready: <pre>
{{Area page
{{Area page
|name=
| name =
|image=
| image =
|summary=
| controller icon =
|description=
| icon =
|type=<!--surface,cloud,or omit-->
| summary =
|difficult terrain=
| description =
|condition1=
| type = <!--surface,cloud,or omit-->
|condition1 no save=
| dippable =
|condition2=
| movement multiplier =
|condition2 no save=
| condition =
|created by items=
| condition save =
|created by spells=
| condition dc =
|interactions=
| condition2 =
|notes=
| condition2 save =
| condition2 dc =
| created by items =
| created by spells =
| interactions =
| notes =
}}
}}
</pre>
</pre>
Line 22: Line 27:
== Grease ==
== Grease ==
{{Area page
{{Area page
|name=Grease
| name=Grease
|image=Surface Grease Image.png
| image=Surface Grease Image.png
|type=surface
| type=surface
|difficult terrain=true
| dippable = no
|summary=a slippery surface that has a chance to knock a creature {{cond|Prone}}.
| difficult terrain=true
|condition1=Prone
| summary=a slippery surface that has a chance to knock a creature {{cond|Prone}}.
|created by items = Grease Bottle
| condition1=Prone
|created by spells = Grease
| created by items = Grease Bottle
|interactions =
| created by spells = Grease
| interactions =
* Turns into [[Fire (surface)]] when touched by fire.
* Turns into [[Fire (surface)]] when touched by fire.
}}
}}
Line 55: Line 61:
"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 83:
"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 95:
"suggestedvalues": [
"suggestedvalues": [
"cloud",
"cloud",
"surface"
"surface",
                "summoned"
],
            "default": "surface"
},
"dippable": {
"description": "Whether or not this area (usually a surface) is dippable",
"type": "boolean",
"default": "no",
"suggested": true
},
"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 173:
"name",
"name",
"image",
"image",
        "controller icon",
        "icon",
"summary",
"summary",
"difficult terrain",
"description",
"description",
"type",
"type",
"condition1",
        "dippable",
"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",

Latest revision as of 22:37, 2 May 2024

Template that generates an entire page for areas. Use Template:Area for displaying on a page.

Copy-ready:
{{Area page
| name =
| image =
| controller icon =
| icon =
| summary =
| description =
| type = <!--surface,cloud,or omit-->
| dippable =
| movement multiplier =
| condition =
| condition save =
| condition dc =
| condition2 =
| condition2 save =
| condition2 dc =
| created by items =
| created by spells =
| interactions =
| notes =
}}

Grease

Area page/doc image

Grease is a slippery surface that has a chance to knock a creature Prone Prone.


Properties

Type: Surface
Dippable Dippable

Creation

This area can be created by the following:

Items:

Spells and actions:

Interactions

Hunger of Hadar

Area page/doc image

Hunger of Hadar is an area created by Hunger of Hadar Hunger of Hadar. It creates an area of magical darkness that impedes movement and deals damage at the beginning and end of each turn.

Description

A sphere of cold blackness, teeming with unknown horrors.

Creatures starting their turn in the area take 2d6Damage TypesCold damage. Creatures ending their turn in the area possibly take 2d6Damage TypesAcid damage.

The area is Difficult Terrain and creatures within are Blinded Blinded.

Properties

Type: Summoned

Creation

This area can be created by the following:

Spells and actions:

Template data

Generates an entire page for representing areas.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
namename

The name of the area. Defaults to the page name.

Unknownsuggested
imageimage

A 380x380 image without the File: prefix.

Filesuggested
controller iconcontroller icon

A 144x144 image without the File: prefix.

Filesuggested
iconicon

A 64x64 icon without the File: prefix.

Filesuggested
summarysummary

A short summary of the area. Not the in-game description.

Contentsuggested
descriptiondescription

The in-game description of the area, if it exists.

Contentsuggested
typetype

If the area has the cloud or surface property.

Suggested values
cloud surface summoned
Default
surface
Stringsuggested
dippabledippable

Whether or not this area (usually a surface) is dippable

Default
no
Booleansuggested
conditioncondition

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
Stringoptional
condition savecondition 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"

Suggested values
Strength Dexterity Constitution Intelligence Wisdom Charisma
Example
WIS
Stringoptional
condition dccondition dc

The optional fixed DC of the condition that targets have to pass to apply it

Example
12
Numberoptional
condition2condition2

The full name of the condition (if any) that is applied if there is a second condition.

Example
Hastened
Stringoptional
condition2 savecondition2 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"

Suggested values
Strength Dexterity Constitution Intelligence Wisdom Charisma
Example
WIS
Stringoptional
condition2 dccondition2 dc

The optional fixed DC of the second condition that targets have to pass to apply it

Example
12
Numberoptional
created by itemscreated by items

List of items that create this area. Be sure to separate multiple items with a comma.

Example
Acid Vial, Arrow of Acid
Contentoptional
created by spellscreated by spells

List of spells that create this area. Be sure to separate multiple spells with a comma.

Example
Melf's Acid Arrow, Chromatic Orb: Acid
Contentoptional
interactionsinteractions

A description of interactions that the area has that can turn it into something else. Note that this does NOT include being erased by other areas of the same surface/cloud type.

Unknownoptional
notesnotes

Any extra or related information about the spell. Please use * for bullet points.

Contentoptional