Template:Coords: Difference between revisions

From bg3.wiki
Jump to navigation Jump to search
(add templatedata)
(Updated documentation)
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
<includeonly><onlyinclude>{{#if: {{{3|}}} | [[{{{3}}}]] }} <span class="bg3wiki-coordinates">X:&nbsp;{{{1}}}&nbsp;Y:&nbsp;{{{2}}}</span></onlyinclude></includeonly><noinclude>__NOTOC__
<includeonly><onlyinclude>{{#if: {{{3|}}} | [[{{{3}}}]] }}<span class="bg3wiki-coordinates">X:&nbsp;{{{1}}}&nbsp;Y:&nbsp;{{{2}}}</span></onlyinclude></includeonly><noinclude>__NOTOC__
[[File:Minimap Example.png|thumb|An example of a minimap. The coordinates {{coords|-456|-22}} can be seen near the bottom.]]
[[File:Minimap Example.png|thumb|An example of a minimap. The coordinates {{coords|-456|-22}} can be seen near the bottom.]]


Line 6: Line 6:
This template accepts three parameters. In order, the X coordinate, the Y coordinate, and (optionally) the map/location.
This template accepts three parameters. In order, the X coordinate, the Y coordinate, and (optionally) the map/location.


<h2>Usage Example 1: Basic Coordinates</h2>
== Examples ==
<pre><nowiki>{{Coords|25|-10}}</nowiki></pre>
{{Template demo
| <nowiki>{{Coords|25|-10}}</nowiki>
| <nowiki>{{Coords|25|-10|Ravaged Beach}}</nowiki>
}}


Result:<br>{{coords|25|-10}}
== Template data ==
 
<templatedata>
<h2>Usage Example 2: Coordinates & Location</h2>
<pre><nowiki>{{Coords|25|-10|Ravaged Beach}}</nowiki></pre>
 
Result:<br>{{coords|25|-10|Ravaged Beach}}
 
[[Category:Templates]]<templatedata>
{
{
"params": {
"params": {
Line 22: Line 19:
"description": "An X coordinate, as seen on the Minimap.",
"description": "An X coordinate, as seen on the Minimap.",
"example": "-312",
"example": "-312",
            "type": "number",
"required": true
"required": true
},
},
Line 27: Line 25:
"description": "A Y coordinate, as seen on the minimap.",
"description": "A Y coordinate, as seen on the minimap.",
"example": "750",
"example": "750",
            "type": "number",
"required": true
"required": true
},
},
Line 43: Line 42:
"format": "inline"
"format": "inline"
}
}
</templatedata></noinclude>
</templatedata>
[[Category:Templates]]
</noinclude>

Revision as of 07:00, 20 July 2024

An example of a minimap. The coordinates X: -456 Y: -22 can be seen near the bottom.

The Coords template is for generating a preformatted coordinates block for a character, item, point of interest, or anything else noteworthy. Coordinates can be found in-game at the bottom of the minimap (see example).

This template accepts three parameters. In order, the X coordinate, the Y coordinate, and (optionally) the map/location.

Examples

Markup Renders as
{{Coords|25|-10}}
X: 25 Y: -10
{{Coords|25|-10|Ravaged Beach}}
Ravaged BeachX: 25 Y: -10

Template data

Formats a pair of X, Y coords and an optional Location.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
11

An X coordinate, as seen on the Minimap.

Example
-312
Numberrequired
22

A Y coordinate, as seen on the minimap.

Example
750
Numberrequired
33

The name of a Location

Example
Ravaged Beach
Page nameoptional