Template:Sandbox/User:Speeddymon/LocLine/doc

This is a documentation subpage for Template:Sandbox/User:Speeddymon/LocLine. It contains usage information, categories, and other content that is not part of the original template page.

Template:Sandbox/User:Speeddymon/LocLine invokes function main in Module:Sandbox/User:Speeddymon/LocLineNew using Lua.

The LocLine templates are used to list a monster's locations. Three templates are used to form the locations table:

• {{LocTableHead}} - Contains table headers for the top of the locations table
• {{LocLine}} - Template for all of the individual location lines
• {{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:

• {{ItemSpawnLine}} - Used for item spawns
• {{ObjectLocLine}} - Used for object/scenery locations
• {{ShopLocLine}} - Used for shops or other places

Usage

{{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) -->
}}
{{LocTableBottom}}

Unfilled location lines for quick copy-paste

{{LocTableHead}}
{{LocLine
|location = 
|levels = 
|members = 
|mapID = 
|plane = 
|mtype = 

}}
{{LocTableBottom}}

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 map ID. See {{Template:Map}} for more info.

plane

Optional. The inteactive map plane. See {{Template:Map}} for more info.

mtype

Semi-required. Type of map design with coordinates. (pin, circle, square, polygon)

Unnamed parameters

One or more coordinates given as unnamed parameters. See {{Template:Map}} for more info. Note that both the (x,y) form (e.g. |1234,4567) and the key-value pair form (e.g. |desc:A description for the pin,x:1234,y:4567) are accepted.

Note: When using the key-value pair form, passing an npcid value without specifying a pin description (via a desc value) will generate a pin description in the form of: NPC ID: 1234. This mirrors the behaviour used by {{Monster map}} and {{NPC map}}.