Template:LocLine/Sandbox/doc: Difference between revisions
< Template:LocLine | Sandbox
Content added Content deleted
(Created page with "{{Documentation}} {{ToC|right}} The '''LocLine''' templates are used to list a monster's locations. Three templates are used to form the locations table: * {{T|LocTableHead}} - Contains table headers for the top of the locations table * {{T|LocLine}} - Template for all of the individual location lines * {{T|LocTableBottom}} - Contains table footers for the bottom of the locations table ==See also== This template should be used for NPC and Monster locations. Location lis...") |
(Replaced content with "{{No documentation}}") Tag: Replaced |
||
| Line 1: | Line 1: | ||
{{No documentation}} |
|||
{{Documentation}} |
|||
{{ToC|right}} |
|||
The '''LocLine''' templates are used to list a monster's locations. Three templates are used to form the locations table: |
|||
* {{T|LocTableHead}} - Contains table headers for the top of the locations table |
|||
* {{T|LocLine}} - Template for all of the individual location lines |
|||
* {{T|LocTableBottom}} - Contains table footers for the bottom of the locations table |
|||
==See also== |
|||
This template should be used for NPC and Monster locations. Location lists for other entities include: |
|||
* {{T|ItemSpawnLine}} - Used for item spawns |
|||
* {{T|ObjectLocLine}} - Used for object/scenery locations |
|||
* {{T|ShopLocLine}} - Used for shops or other places |
|||
==Usage== |
|||
<pre> |
|||
{{LocTableHead}} |
|||
{{LocLine |
|||
|name = <!-- (Optional) Name of monster, defaults to article's title --> |
|||
|location = <!-- Location --> |
|||
|levels = <!-- Level(s) of the monster spawns at this location --> |
|||
|members = <!-- (Optional) "yes" if location is members-only, defaults to "no" --> |
|||
|mapID = <!-- (Optional) The interactive map ID; see Template:Map for more info --> |
|||
|plane = <!-- (Optional) The interactive map plane; see Template:Map for more info --> |
|||
|(coordN) <!-- One or more coordinates given as unnamed parameters; see Template:Map for more info --> |
|||
|mtype = <!-- (Semi-required) Tells the map what style of map the coordinates will show up as (pin, polygon, square, circle) --> |
|||
|icon = <!-- (Optional) Icon to override this line's symbol (greenPin, redPin, bluePin, etc) --> |
|||
}} |
|||
{{LocTableBottom}} |
|||
</pre> |
|||
===Unfilled location lines for quick copy-paste=== |
|||
<pre>{{LocTableHead}} |
|||
{{LocLine |
|||
|location = |
|||
|levels = |
|||
|members = |
|||
|mapID = |
|||
|plane = |
|||
|mtype = |
|||
}} |
|||
{{LocTableBottom}}</pre> |
|||
==Parameter details== |
|||
===name=== |
|||
Optional. Name of the monster/NPC. Defaults to the title of the page on which the template is placed. Used as a title in the tooltips that appear when clicking on the pins of the interactive map. |
|||
===location=== |
|||
Text, typically an article link, used to name a given location row. |
|||
===levels=== |
|||
The level or levels (typically given as a comma-separated list of numbers and/or ranges) of the monster spawns at the given location. |
|||
===members=== |
|||
Optional. A "yes" or "no" value indicating whether or not the given location is members-only. Defaults to "no". |
|||
===mapID=== |
|||
Optional. The interactive [[RuneScape:Map/mapIDs|map ID]]. See {{T|Template:Map}} for more info. |
|||
===plane=== |
|||
Optional. The inteactive map plane. See {{T|Template:Map}} for more info. |
|||
===mtype=== |
|||
Semi-required. Type of map design with coordinates. (pin, circle, square, polygon) |
|||
===icon=== |
|||
Optional. The symbol name to override this line's appearance on the map (e.g. bluePin, redPin, greenPin). Can be used to distinguish NPC spawns in the same location, e.g. [[Araxyte]]. |
|||
===Unnamed parameters=== |
|||
One or more coordinates given as unnamed parameters. See {{T|Template:Map}} for more info. Note that both the (x,y) form (e.g. <code>|1234,4567</code>) and the key-value pair form (e.g. <code>|desc:A description for the pin,x:1234,y:4567</code>) are accepted. |
|||
'''Note:''' When using the key-value pair form, passing an <code>npcid</code> value without specifying a pin description (via a <code>desc</code> value) will generate a pin description in the form of: ''NPC ID: 1234''. This mirrors the behaviour used by {{T|Monster map}} and {{T|NPC map}}. |
|||
Latest revision as of 00:35, 17 October 2024
 | This is a documentation subpage for Template:No documentation. It contains usage information, categories, and other content that is not part of the original template page. |
This template does not have any documentation. Please consider adding documentation at Template:LocLine/Sandbox/doc. [edit]
Template:LocLine/Sandbox invokes function main in Module:LocLine/Sandbox using Lua.