Difference between revisions of "Template:Sprintbox/doc"
Jump to navigation
Jump to search
(Created page with "NOTE: This template is meant for Sprinting animation items For other types of items see: * Clothing - Template:Clothingbox * Pets - Template:Petbox * Talismans -...") |
|||
| Line 15: | Line 15: | ||
<pre>{{Sprintbox | <pre>{{Sprintbox | ||
| − | |name = | + | |content= |
| − | |colour = | + | |name= |
| − | |invicon = | + | |colour= |
| − | |guiicon = | + | |invicon= |
| − | |description = | + | |guiicon= |
| − | |type = | + | |description= |
| − | |source = | + | |type= |
| − | |invdesc = | + | |source= |
| − | |binds = | + | |invdesc= |
| − | |unique = | + | |binds= |
| + | |unique= | ||
}}</pre> | }}</pre> | ||
| Line 33: | Line 34: | ||
{| class="wikitable" | {| class="wikitable" | ||
! Parameter Name !! Required !! Description !! Accepted Values !! Default | ! Parameter Name !! Required !! Description !! Accepted Values !! Default | ||
| + | |- | ||
| + | | content || No || Is this item for [[The Secret World|TSW]] or [[Secret World Legends|SWL]] || tsw, swl || tsw | ||
|- | |- | ||
| '''name''' || '''Yes''' || Needs to be included in order to help with transclusion and use with other templates. || Name of item || | | '''name''' || '''Yes''' || Needs to be included in order to help with transclusion and use with other templates. || Name of item || | ||
|- | |- | ||
| − | | | + | | colour || No || Rarity Colour level of the item. || White, Green, Blue, Purple, Orange, Red || White |
|- | |- | ||
| − | | '''invicon''' || '''Yes''' || Inventory icon image. If this item never appears in your inventory, enter "no" || < | + | | '''invicon''' || '''Yes''' || Inventory icon image. If this item never appears in your inventory, enter "no" || no, <filename>.<extension> || |
|- | |- | ||
| '''guiicon''' || '''Yes''' || Pet/Sprint UI icon image. || <filename>.<extension> || | | '''guiicon''' || '''Yes''' || Pet/Sprint UI icon image. || <filename>.<extension> || | ||
| Line 44: | Line 47: | ||
| '''description''' || '''Yes''' || The description of the sprint from the Pet/Sprint UI || <text> || | | '''description''' || '''Yes''' || The description of the sprint from the Pet/Sprint UI || <text> || | ||
|- | |- | ||
| − | | '''type''' || '''Yes''' || Type of sprint item, as listed in the Pet/Sprint UI || | + | | '''type''' || '''Yes''' || Type of sprint item, as listed in the Pet/Sprint UI || Sprint, Mundane || |
|- | |- | ||
| − | | '''source''' || '''Yes''' || Item source, as listed in the Pet/Sprint UI. || <text>|| | + | | '''source''' || '''Yes''' || Item source, as listed in the Pet/Sprint UI. || <text> || |
|- | |- | ||
| − | | | + | | invdesc || No || Description on the item while it is in your inventory, if different than what the default displays || <text> || "Unlocks the <name>." |
|- | |- | ||
| − | | | + | | binds || No || If the inventory version of this item is NOT Bind-on-Pickup indicate it here || no || Bind of Pickup |
|- | |- | ||
| − | | | + | | unique || No || Is the inventory version of this item is NOT unique indicate it here || no || Unique |
|} | |} | ||
Latest revision as of 00:12, 14 October 2017
NOTE: This template is meant for Sprinting animation items
For other types of items see:
- Clothing - Template:Clothingbox
- Pets - Template:Petbox
- Talismans - Template:Talismanbox
- Weapons - Template:Weaponsbox
- All others - Template:Itembox
Also note that this template should rarely need to be used on it's own since the Boilerplate:Sprintpage boilerplate used to create articles for all of these types of items includes this template automatically.
Usage
Place this at the very top of your page, and fill in the information provided (variable descriptions follow the code). If some variables don't have info, just ignore it, and it will be hidden in the template.
{{Sprintbox
|content=
|name=
|colour=
|invicon=
|guiicon=
|description=
|type=
|source=
|invdesc=
|binds=
|unique=
}}
IMPORTANT - You should not need to add any categories to the page when using this template. They are automatically set by the template!
Parameters
| Parameter Name | Required | Description | Accepted Values | Default |
|---|---|---|---|---|
| content | No | Is this item for TSW or SWL | tsw, swl | tsw |
| name | Yes | Needs to be included in order to help with transclusion and use with other templates. | Name of item | |
| colour | No | Rarity Colour level of the item. | White, Green, Blue, Purple, Orange, Red | White |
| invicon | Yes | Inventory icon image. If this item never appears in your inventory, enter "no" | no, <filename>.<extension> | |
| guiicon | Yes | Pet/Sprint UI icon image. | <filename>.<extension> | |
| description | Yes | The description of the sprint from the Pet/Sprint UI | <text> | |
| type | Yes | Type of sprint item, as listed in the Pet/Sprint UI | Sprint, Mundane | |
| source | Yes | Item source, as listed in the Pet/Sprint UI. | <text> | |
| invdesc | No | Description on the item while it is in your inventory, if different than what the default displays | <text> | "Unlocks the <name>." |
| binds | No | If the inventory version of this item is NOT Bind-on-Pickup indicate it here | no | Bind of Pickup |
| unique | No | Is the inventory version of this item is NOT unique indicate it here | no | Unique |
