Difference between revisions of "Template:GateMap/doc"

Revision as of 19:09, 30 July 2015

Usage

To create a visual representation of depths that might be encountered when endeavoring to explore the clockworks, particularly for missions.

Code

{{GateMap
|name        = White Collar Captives
|floor       = First
|floor icon  = Generic Lobby
|floor depth = 0
|floor name  = Mission Lobby
|floor area  = A standard lobby.
}}
{{GateMap
|name        = 
|floor       = Second
|icon 1      = 
|floor depth = 
|floor name  = 
|floor area  = 
}}

Or if the floor rotates:

{{GateMap
|name        = 
|floor       = Second
|icon 1      = 
|icon 2      = 
|icon 3      = 
|icon 4      = 
|icon 5      = 
|floor depth = 
|floor name  = 
|floor area  = 
}}<noinclude>[[Category:Gate Maps]]</noinclude>

Parameters

|name

The name of the area. Please use the name of the mission page if the gate map is of a mission. Be careful to link to the right page - as with "shroud of the apocrea" vs. "shroud of the apocrea (mission)." This allows direct linking to the desired floor through the gate map, assuming consistent ToC subsection naming is maintained on individual mission pages.

|floor

The floor in sequence. Please enter "First" or "Second" or "Third" and so on, not 1st, 2nd, 3rd etc. This allows direct linking to the desired floor through the gate map, assuming consistent ToC subsection naming is maintained on individual mission pages. Make sure the word is capitalized for this entry.

|icon 1

The file name of the icon to be used to represent the floor depth. There might be more than one - see "optional" parameters.

|floor depth

The depth of the floor. It might be numeric (0, 1, 2, etc.) or Depends on rank.

|floor name

The name of the floor as shown in the gate map.

|floor area

A phrase describing the floor. Please keep phrasing consistent with other Gate Maps. Please link to the appropriate arcade area/set of levels. Example:

• If the floor rotates between areas:

Areas are similar to the relevant theme of <br> ''[[Clockwork Tunnels|Infernal Passage]].''

• If the floor is one area:

An area similar to <br> ''[[Clockwork Tunnels|Cooling Chamber: Slimeway]].''

Optional

|icon 2

The file name of the second icon to be used to represent an area in the floor's rotation.

Use only if the floor rotates between levels. This will slightly rearrange the appearance of the Gate Map cell to make room for more icons.

|icon 3
|icon 4
|icon 5
|icon 6
|icon 7

Use only if icon 2 parameter has been used.

Examples

See what links here for examples of this template in action.

Notes

Please always include the lobby information as the "First" floor. Certain missions have special lobbies, or very unconventional lobbies. The majority will have the generic lobby.

Be extra aware of whitespace, and avoid it. Do not space out each call of the GateMap template - see above code.

Implement a gate map like so:

{{:NAME/Gate Map}}

Where NAME is most likely the name of a mission - be very careful with disambiguation here.