Template:Area page: Difference between revisions

From bg3.wiki
Jump to navigation Jump to search
m (Capitalized area types and added type to Hunger of Hadar example.)
m (Eliminate extra spacing)
 
(14 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<includeonly>{{main namespace only|{{PageSeo
<includeonly>{{main namespace only|{{PageSeo
|title = {{{name|{{PAGENAME}} }}}
|title = {{{name | {{#titleparts: {{PAGENAME}} }} }}}
|image = File:{{{image}}}
|image = {{#if:{{{controller icon|}}}|{{{controller icon}}}|{{#if:{{{image|}}}|{{{image}}}|{{{icon|}}}}}}}
|description = {{{name|{{PAGENAME}} }}} is {{{summary|a type of Area}}}
|description = {{{name|{{PAGENAME}} }}} is {{{summary|a type of Area}}}
}} }}<div style="min-height: 200px" class="bg3wiki-tooltip-box bg3wiki-tooltip-gradient-common">__NOTOC__
}} }}__NOTOC__<div style="min-height: 200px" class="bg3wiki-tooltip-box bg3wiki-tooltip-gradient-common"
{{#if:{{{image|}}}|[[File:{{{image}}}|180px|frameless|right]]}}
><!--Extract name and icon from the page title-->{{#lvardef: name | {{{name | {{#explode: {{#titleparts: {{PAGENAME}} }} | ( | 0 }} }}} }}{{#lvardef: icon | {{#if: {{{icon|}}} | {{{icon}}} | {{#explode: {{#titleparts: {{PAGENAME}} }} | ( | 0 }} Icon.webp }} }}{{#lvardef: controllericon | {{#if: {{{controller icon|}}} | {{{controller icon}}} | {{#explode: {{#titleparts: {{PAGENAME}} }} | ( | 0 }} Controller Icon.webp }} }}
'''{{{name|{{PAGENAME}}}}}''' is {{{summary|a type of [[Area]].}}}{{#if:{{{difficult terrain|}}}|&nbsp;It is considered {{Difficult terrain}}.}}
{{#if: {{{image|}}} | [[File:{{{image}}}|frameless|right|alt={{PAGENAME}} image]] | {{#if:{{{controller icon|}}} | [[File:{{{controller icon}}}|frameless|right|alt={{PAGENAME}} controller icon]] | {{#if:{{{icon|}}} | [[File:{{{icon}}}|frameless|right|alt={{PAGENAME}} icon]] | }} }} }}
'''{{{name | {{#titleparts: {{PAGENAME}} }} }}}''' is {{{summary|{{#switch:{{lc:{{{type|}}}}}|surface=a [[surface]]|cloud=a [[cloud]].|summoned=a [[summonable area]]|an [[area]].}}}}}
 
{{#if:{{{description|}}}|
{{#if:{{{description|}}}|
<h2>Description</h2>
<h2>Description</h2>
Line 12: Line 14:
<h2>Properties</h2>
<h2>Properties</h2>
<dl class="bg3wiki-property-list">
<dl class="bg3wiki-property-list">
{{#if:{{{type|}}}|<dd>{{SmallIcon|Condition Type Icon.png}} Type: [[{{ucfirst:{{{type}}}}}]]</dd>}}
{{#if:{{{type|}}}|<dd>{{SmallIcon|Condition Type Icon.png}} Type: [[Area#{{ucfirst:{{{type}}}}}|{{ucfirst:{{{type}}}}}]]</dd>}}
{{#if:{{{difficult terrain|}}}|<dd>{{Difficult terrain}}</dd> }}
{{#if: {{{dippable|}}} | <dd>{{Dippable}}</dd> }}
{{#if:{{{condition1|}}}|<dd>{{#if:{{{condition1 no save|}}}|Inflicts {{cond|{{{condition1}}} }} while in area.|May inflict {{cond|{{{condition1}}} }} }}</dd> }}
{{#if:{{{condition2|}}}|<dd>{{#if:{{{condition2 no save|}}}|Inflicts {{cond|{{{condition2}}} }} while in area.|May inflict {{cond|{{{condition2}}} }} }}</dd> }}
</dl>
</dl>
</div>
</div>
{{#if: {{{condition1|}}}{{{condition2|}}} |
{{#if: {{{condition|}}} |
 
<h2> Condition: {{{condition}}} </h2>


<h2> Conditions </h2>
{{#if: {{{condition1|}}}|
<div class="bg3wiki-tooltip-box bg3wiki-tooltip-gradient-common">
<div class="bg3wiki-tooltip-box bg3wiki-tooltip-gradient-common">
{{Condition | {{{condition1}}}
{{Condition | {{{condition}}}
| save = {{{condition save|}}}
| dc = {{{condition dc|}}}
| duration = {{{condition duration|}}}
}}
}}
{{Main namespace only|{{Inflicts|{{{condition1|}}}|SAI }} }}
{{Main namespace only|{{Inflicts|{{{condition|}}}|area|type=area|save={{{condition save|}}}|dc={{{condition dc|}}}|duration={{{condition duration|}}}}} }}
</div>
</div>
}}
}} {{#if: {{{condition2|}}} |
{{#if: {{{condition2|}}}|
 
<div class="bg3wiki-tooltip-box">
<h2> Condition: {{{condition2}}} </h2>
 
<div class="bg3wiki-tooltip-box bg3wiki-tooltip-gradient-common">
{{Condition | {{{condition2}}}
{{Condition | {{{condition2}}}
| save = {{{condition2 save|}}}
| dc = {{{condition2 dc|}}}
| duration = {{{condition2 duration|}}}
}}
}}
{{Main namespace only|{{Inflicts|{{{condition2|}}}|SAI }} }}
{{Main namespace only|{{Inflicts|{{{condition2|}}}|area|type=area|save={{{condition save|}}}|dc={{{condition dc|}}}|duration={{{condition2 duration|}}}}} }}
</div>
</div>
}}
}} {{#if:{{{created by items|}}}{{{created by spells|}}}|
}}
{{#if:{{{created by items|}}}{{{created by spells|}}}|


<h2>Creation</h2>
<h2>Creation</h2>
Line 47: Line 53:
Spells and actions:
Spells and actions:
{{#invoke: ParseList | main | {{{created by spells}}} | useTemplate = MdSAI | type = htmlList }}
{{#invoke: ParseList | main | {{{created by spells}}} | useTemplate = MdSAI | type = htmlList }}
}}}}{{#if:{{{interactions|}}}|
}}}} {{#if:{{{interactions|}}}|
{{blank}}
{{blank}}
<h2>Interactions</h2>
<h2>Interactions</h2>
{{{interactions}}}
{{{interactions}}}
}}{{main namespace only|
}} {{#if: {{{notes|}}} |
{{#switch:{{{type|}}}
|surface = [[Category:Surfaces]]
|cloud = [[Category:Clouds]]
|summoned = [[Category:Summoned areas]]
}}
[[Category:Areas]]
}}
{{#if: {{{notes|}}} |


<h2> Notes </h2>
<h2> Notes </h2>


<div class="bg3wiki-tooltip-box">
{{{notes}}}
{{{notes}}}
</div>
}}


</includeonly><noinclude>{{documentation|content=
}} {{main namespace only|
Template that generates an entire page for areas. Use [[Template:Area]] for displaying on a page.
{{#switch:{{{type|}}}
 
|surface = [[Category:Surfaces]]
Copy-ready: <pre>
|cloud = [[Category:Clouds]]
{{Area page
|summoned = [[Category:Summoned areas]]
|name=
|image=
|summary=
|description=
|type=<!--surface,cloud,or omit-->
|difficult terrain=
|condition1=
|condition1 no save=
|condition2=
|condition2 no save=
|created by items=
|created by spells=
|interactions=
|notes=
}}
</pre>
 
== Grease ==
{{Area page
|name=Grease
|image=Surface Grease Image.png
|type=surface
|difficult terrain=true
|summary=a slippery surface that has a chance to knock a creature {{cond|Prone}}.
|condition1=Prone
|created by items = Grease Bottle
|created by spells = Grease
|interactions =
* Turns into [[Fire (surface)]] when touched by fire.
}}
}}
== Hunger of Hadar ==
[[Category:Areas]]{{#cargo_store: _table = areas
{{Area page
| name = {{{name | {{#titleparts: {{PAGENAME}} }} }}}
| name = Hunger of Hadar
| image = {{{image|}}}
| image = Hunger of Hadar.webp
| controller_icon = {{#lvar:controllericon}}
| summary = an [[area]] created by {{SAI|Hunger of Hadar}}. It creates an area of magical darkness that impedes movement and deals damage at the beginning and end of each turn.
| icon = {{#lvar:icon}}
| difficult terrain = yes
| description = {{{description|}}}
| description = A sphere of cold blackness, teeming with unknown horrors.
| type = {{{type|surface}}}
 
| dippable = {{IfEmpty | {{{dippable|}}} | no }}
Creatures starting their turn in the area take {{DamageText|2d6|Cold}} damage. Creatures ending their turn in the area possibly take {{DamageText|2d6|Acid}} damage.
| condition_name = {{{condition|}}}
 
| condition_save = {{{condition save|}}}
The area is Difficult Terrain and creatures within are {{cond|Blinded}}.
| condition_dc = {{{condition dc|}}}
| type = summoned
| condition2_name = {{{condition2|}}}
| condition1 = Hunger of Hadar
| condition2_save = {{{condition2 save|}}}
| condition1 no save = yes
| condition2_dc = {{{condition2 dc|}}}
| created by spells = Hunger of Hadar
}}
 
==Template data==
<templatedata>
{
"params": {
"image": {
"description": "A file without the File: prefix. ",
"type": "wiki-file-name",
"suggested": true
},
"name": {
"description": "The name of the area. Defaults to the page name.",
"suggested": true
},
"summary": {
"description": "A short summary of the area. Not the in-game description.",
"type": "content",
"suggested": true
},
"difficult terrain": {
"description": "If specified, marks the area as Difficult Terrain.",
"type": "boolean"
},
"description": {
"description": "The in-game description of the area, if it exists.",
"type": "content",
"suggested": true
},
"type": {
"description": "If the area has the cloud or surface property.",
"type": "string",
            "suggested": true,
"suggestedvalues": [
"cloud",
"surface"
]
},
"condition1": {
"description": "The first condition inflicted by this area",
"type": "wiki-page-name"
},
"condition1 no save": {
"description": "If specified, notes that the condition is applied while in area",
"type": "boolean"
},
"condition2": {
"description": "The second condition inflicted by this area",
"type": "wiki-page-name"
},
"condition2 no save": {
"description": "If specified, notes that the condition is applied while in area"
},
"created by items": {
"description": "List of items that create this area. Be sure to separate multiple items with a comma.",
"example": "Acid Vial, Arrow of Acid",
"type": "content"
},
"created by spells": {
"description": "List of spells that create this area. Be sure to separate multiple spells with a comma.",
"example": "Melf's Acid Arrow, Chromatic Orb: Acid",
"type": "content"
},
"interactions": {
"description": "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."
},
"notes": {
"description": "Any extra or related information about the spell. Please use * for bullet points.",
"type": "content"
}
},
"paramOrder": [
"name",
"image",
"summary",
"difficult terrain",
"description",
"type",
"condition1",
"condition1 no save",
"condition2",
"condition2 no save",
"created by items",
"created by spells",
"interactions",
"notes"
],
"description": "Generates an entire page for representing areas.",
"format": "block"
}
</templatedata>
 
}}
}}
[[Category:Page generating templates]]</noinclude>
}}</includeonly><noinclude>{{documentation}}{{#cargo_declare: _table = areas
| name = String (unique, mandatory)
| image = File
| controller_icon = File
| icon = File
| description = Wikitext
| type = String (allowed values = surface, cloud, summoned)
| dippable = Boolean
| condition_name = String
| condition_save = String
| condition_dc = String
| condition2_name = String
| condition2_save = String
| condition2_dc = String
}}</noinclude>

Latest revision as of 23:56, 14 August 2024

Template documentation

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 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 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
This template defines the table "areas". View table.