Difference between revisions of "Template:Level/doc"

From SpiralKnights

Jump to: navigation, search
m (Optional)
m (Notes: not since GateMap fusion project)
 
(18 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
==Usage==
 
==Usage==
To put information in a consistent manner on mission pages.
+
To display information about a [[:Category:Levels|level]].  
 
__NOTOC__
 
__NOTOC__
 
==Code==
 
==Code==
 
<pre>
 
<pre>
{{Floor
+
{{Level
|icon 1      =  
+
|area        =
 
|name        =
 
|name        =
 +
|icon 1      =
 
|depth      =
 
|depth      =
 
|monsters    =
 
|monsters    =
Line 16: Line 17:
 
==Parameters==
 
==Parameters==
 
===Required===
 
===Required===
 +
|area =
 +
*The name of the region, such as "Wolver Den" or "Scarlet Fortress."
 +
 +
OR
 +
 +
|mission
 +
*Use only if the level is unique to a mission. Area should be used instead of mission whenever possible.
 +
----
 
|icon 1 =  
 
|icon 1 =  
*name of the icon of the floor. There might be more than 1, especially for certain prestige missions. See optional parameters. Be careful with typos here. If the icon isn't showing up, do not immediately upload a new one, as the icon you want is probably already available - even if the area is new! Gates love to use simple icons for monster and status themes. Check for capitalization, hyphens, spacing issues, etc.
+
*name of the icon of the level. There might be more than 1, especially for certain prestige missions. See optional parameters. Be careful with typos here. If the icon isn't showing up, do not immediately upload a new one, as the icon you want is probably already available - even if the area is new! Gates love to use simple icons for monster and status themes. Check for capitalization, hyphens, spacing issues, etc.
  
 
|name  =
 
|name  =
*name of the floor. For rank missions, this is frequently a unique name, but it's likely still a standard tileset that should be linked to in Exploration. If it is a simple, non unique name, link to its basic level. For example, ''"Cooling Chamber: Haunted Passage"'' would just link to Clockwork Tunnels.
+
*name of the level. For rank missions, this is frequently a unique name, but it's likely still a standard tileset that should be linked to in Exploration.  
  
 
|depth  =
 
|depth  =
*The depth of the floor. Might depend on [[Player Rank]], especially for certain prestige missions.
+
*The depth of the level. Might depend on [[Player Rank]], especially for certain prestige missions.
  
 
|monsters    =
 
|monsters    =
 
*Please use established templates in a bulleted list like so:
 
*Please use established templates in a bulleted list like so:
:<nowiki>{{Monster_Icons|Construct}} {{status|fire}} [[Gun Puppy#Red Rover|Red Rover]]</nowiki>  
+
:<nowiki>{{Monster|Red Rover}}</nowiki>  
:This makes: {{Monster_Icons|Construct}} {{status|fire}} [[Gun Puppy#Red Rover|Red Rover]]
+
:This makes: {{Monster|Red Rover}}
  
 
|exploration =
 
|exploration =
*A bulleted list of basic areas and important/unique scenery and hazards like traps. Some areas have special puzzle mechanics.
+
*A bulleted list of basic areas and important/unique scenery and hazards like traps. Some areas have special puzzle mechanics. Mention the location of any significant NPCs (friendly or otherwise).
 +
*Use <nowiki>{{exploration|Entity}}</nowiki> to link to entities that do not have complex data, so users don't have to load the giant exploration page every time, and can quickly just see an image of the visual.
 +
*Link to the entity's page if it has one, such as [[Treasure Box]] or [[Mecha Turret]]. Do not use <nowiki>{{exploration|Entity}}</nowiki> in this case.
  
 
|floor notes =
 
|floor notes =
Line 43: Line 54:
 
|icon 5      =  
 
|icon 5      =  
 
</pre>
 
</pre>
*Use only if the floor rotates between levels. Certain prestige missions do this. Same input format as "icon 1."
+
*Use only if the depth rotates between levels. Certain prestige missions do this. Same input format as "icon 1."
 
:There are a few format changes that occur if the "icon 2" parameter is used. Higher numbers should only be used after 2 is used, in order.
 
:There are a few format changes that occur if the "icon 2" parameter is used. Higher numbers should only be used after 2 is used, in order.
 +
 +
|depth
 +
*Use to specify depth. Is often "depth 1 and below." Compounds and boss stratum do not behave this way.
 +
 +
|gallery
 +
*Use only if the level has a fixed map and/or unique scenery. Follow the <nowiki><gallery></nowiki> format.
  
 
==Examples==
 
==Examples==
See [http://wiki.spiralknights.com/index.php?title=Special%3AWhatLinksHere&target=Template%3AFloor&namespace=0 What Links Here] to see examples of this template in action.
+
See [http://wiki.spiralknights.com/index.php?title=Special%3AWhatLinksHere&target=Template%3ALevel&namespace=0 What Links Here] to see examples of this template in action.
 +
 
 +
==Notes==
 +
Use the Gate Map to determine which icons to use, not the social panel. If there is no Gate Map accessible in-game, use each level's elevator icon. If even this is not available, use [[:File:Gate-Generic 1.png|the generic icon]] or the social panel, whichever is most prudent.

Latest revision as of 18:25, 20 January 2016

Usage

To display information about a level.

Code

{{Level
|area        =
|name        =
|icon 1      = 
|depth       =
|monsters    =
|exploration =
|floor notes =
}}

Parameters

Required

|area =

  • The name of the region, such as "Wolver Den" or "Scarlet Fortress."

OR

|mission

  • Use only if the level is unique to a mission. Area should be used instead of mission whenever possible.

|icon 1 =

  • name of the icon of the level. There might be more than 1, especially for certain prestige missions. See optional parameters. Be careful with typos here. If the icon isn't showing up, do not immediately upload a new one, as the icon you want is probably already available - even if the area is new! Gates love to use simple icons for monster and status themes. Check for capitalization, hyphens, spacing issues, etc.

|name =

  • name of the level. For rank missions, this is frequently a unique name, but it's likely still a standard tileset that should be linked to in Exploration.

|depth =

  • The depth of the level. Might depend on Player Rank, especially for certain prestige missions.

|monsters =

  • Please use established templates in a bulleted list like so:
{{Monster|Red Rover}}
This makes: Gate Icon-Construct.png Icon status fire.png Red Rover

|exploration =

  • A bulleted list of basic areas and important/unique scenery and hazards like traps. Some areas have special puzzle mechanics. Mention the location of any significant NPCs (friendly or otherwise).
  • Use {{exploration|Entity}} to link to entities that do not have complex data, so users don't have to load the giant exploration page every time, and can quickly just see an image of the visual.
  • Link to the entity's page if it has one, such as Treasure Box or Mecha Turret. Do not use {{exploration|Entity}} in this case.

|floor notes =

  • state the player goal. The provided mission objective is not always clear and is sometimes more for lore than the actual gaming. A quick strategy (some areas are very repetitive), and a gallery if the area is not randomly generated and/or has very interesting scenery. This section might be quite large for more unique areas. Try to keep it simple - link to a boss for strategy, don't outline the boss strategy here, and so on. Overall level strategy should be included in the Notes section of the Mission Page or Area itself, not in this template. This applies to areas that have the same themes throughout, like Firestorm Citadel.

Optional

|icon 2      = 
|icon 3      = 
|icon 4      = 
|icon 5      = 
  • Use only if the depth rotates between levels. Certain prestige missions do this. Same input format as "icon 1."
There are a few format changes that occur if the "icon 2" parameter is used. Higher numbers should only be used after 2 is used, in order.

|depth

  • Use to specify depth. Is often "depth 1 and below." Compounds and boss stratum do not behave this way.

|gallery

  • Use only if the level has a fixed map and/or unique scenery. Follow the <gallery> format.

Examples

See What Links Here to see examples of this template in action.

Notes

Use the Gate Map to determine which icons to use, not the social panel. If there is no Gate Map accessible in-game, use each level's elevator icon. If even this is not available, use the generic icon or the social panel, whichever is most prudent.

Personal tools