Template:Location Card/doc: Difference between revisions
Plaguerized (talk | contribs) No edit summary |
Plaguerized (talk | contribs) (Added TemplateData) |
||
Line 1: | Line 1: | ||
{{doc/start}} | {{doc/start}} | ||
{{ | {{Location Card | ||
|color= | | name = Name Goes Here | ||
|image=File:Autumn's Rise.png | | color = {{Loc color|orange}} | ||
|description= | | image = File:Autumn's Rise.png | ||
|room_count=16 | | description = Description goes here. | ||
| | | room_count = 16 | ||
| | | trader_count = 10 | ||
| | | quest_count = | ||
|treasure_bronze= | | treasure_default = 4 | ||
|treasure_silver=0 | | treasure_bronze = 7 | ||
|treasure_gold=2 | | treasure_silver = 0 | ||
| treasure_gold = 2 | |||
}} | |||
This template is for use at the top of every [[location]] article to provide basic stats and info, as well as a location navbox. | |||
==Usage== | |||
Here is the basic code for the template which can be copied into the editor: | |||
<pre>{{Location Card | |||
| name = | |||
| color = {{Loc color|???}} | |||
| image = File:???.png | |||
| description = | |||
| room_count = | |||
| trader_count = | |||
| quest_count = | |||
| treasure_default = | |||
| treasure_bronze = | |||
| treasure_silver = | |||
| treasure_gold = | |||
| treasure_key = | |||
| treasure_masterkey = | |||
}}</pre> | |||
<pre>{{ | Below is the code for the location card seen on this page: | ||
|color= | <pre>{{Location Card | ||
|image=File:Autumn's Rise.png | | name = Name Goes Here | ||
|description= | | color = {{Loc color|orange}} | ||
|room_count=16 | | image = File:Autumn's Rise.png | ||
| | | description = Description goes here. | ||
| | | room_count = 16 | ||
| | | trader_count = 10 | ||
|treasure_bronze= | | quest_count = | ||
|treasure_silver=0 | | treasure_default = 4 | ||
|treasure_gold=2 | | treasure_bronze = 7 | ||
| treasure_silver = 0 | |||
| treasure_gold = 2 | |||
}}</pre> | |||
==TemplateData== | |||
{{TemplateData | |||
| {{TemplateData/entry | |||
{| | | name = Name | ||
| | | param = name | ||
| | | desc = Name of the location | ||
| | | def = NULL | ||
| | | type = String | ||
| | | status = Required}} | ||
| | {{TemplateData/entry | ||
|} | | name = Color | ||
| param = color | |||
| desc = value of the background color for the header. Can be done using either {{tl|Loc color}} or HTML syntax. | |||
| def = NULL | |||
| example = <code>#00FF00</code>, <code><nowiki>{{Loc color|green}}</nowiki></code> | |||
| type = String | |||
| status = Required | |||
}} | |||
{{TemplateData/entry | |||
| name = Image | |||
| param = image | |||
| desc = Filename of a representative image of the location. | |||
| def = NULL | |||
| example = File:Autumn's Rise.png | |||
| type = String | |||
| status = Required | |||
}} | |||
{{TemplateData/entry | |||
| name = Description | |||
| param = description | |||
| desc = Description of the location shown on the in-game world map. | |||
| def = NULL | |||
| type = String | |||
| status = Required | |||
}} | |||
{{TemplateData/entry | |||
| name = Room count | |||
| param = room_count | |||
| desc = Number of rooms in the location. | |||
| def = ??? | |||
| type = Number | |||
| status = Recommended | |||
}} | |||
{{TemplateData/entry | |||
| name = Trader count | |||
| param = trader_count | |||
| desc = Number of traders in the location. Hidden if no value is assigned. | |||
| def = NULL | |||
| type = Number | |||
| status = Optional | |||
}} | |||
{{TemplateData/entry | |||
| name = Quest count | |||
| param = quest_count | |||
| desc = Number of quests that are started in the location. Hidden if no value is assigned. | |||
| def = NULL | |||
| type = Number | |||
| status = Optional | |||
}} | |||
{{TemplateData/entry | |||
| name = Normal chest count | |||
| param = treasure_default | |||
| desc = Number of regular chests in the location. Hidden if no value is assigned. | |||
| def = NULL | |||
| type = Number | |||
| status = Optional | |||
}} | |||
{{TemplateData/entry | |||
| name = Bronze chest count | |||
| param = treasure_bronze | |||
| desc = Number of bronze chests in the location. Hidden if no value is assigned. | |||
| def = NULL | |||
| type = Number | |||
| status = Optional | |||
}} | |||
{{TemplateData/entry | |||
| name = Silver chest count | |||
| param = treasure_silver | |||
| desc = Number of silver chests in the location. Hidden if no value is assigned. | |||
| def = NULL | |||
| type = Number | |||
| status = Optional | |||
}} | |||
{{TemplateData/entry | |||
| name = Gold chest count | |||
| param = treasure_gold | |||
| desc = Number of gold chests in the location. Hidden if no value is assigned. | |||
| def = NULL | |||
| type = Number | |||
| status = Optional | |||
}} | |||
{{TemplateData/entry | |||
| name = Key chest count | |||
| param = treasure_key | |||
| desc = Number of Key chests in the location. Hidden if no value is assigned. | |||
| def = NULL | |||
| type = Number | |||
| status = Optional | |||
}} | |||
{{TemplateData/entry | |||
| name = Master Key chest count | |||
| param = treasure_masterkey | |||
| desc = Number of Master Key chests in the location. Hidden if no value is assigned. | |||
| def = NULL | |||
| type = Number | |||
| status = Optional | |||
}} | |||
}} | |||
{{doc/end}} | {{doc/end}} |
Revision as of 21:06, 9 September 2019
This template is for use at the top of every location article to provide basic stats and info, as well as a location navbox.
Usage
Here is the basic code for the template which can be copied into the editor:
{{Location Card | name = | color = {{Loc color|???}} | image = File:???.png | description = | room_count = | trader_count = | quest_count = | treasure_default = | treasure_bronze = | treasure_silver = | treasure_gold = | treasure_key = | treasure_masterkey = }}
Below is the code for the location card seen on this page:
{{Location Card | name = Name Goes Here | color = {{Loc color|orange}} | image = File:Autumn's Rise.png | description = Description goes here. | room_count = 16 | trader_count = 10 | quest_count = | treasure_default = 4 | treasure_bronze = 7 | treasure_silver = 0 | treasure_gold = 2 }}
TemplateData
Do not use named parameter for 1
... x
. The first Parameter will be automatically marked as 1
, the second as 2
and so on.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Name | name
|
Name of the location
|
String | Required |
Color | color
|
value of the background color for the header. Can be done using either
|
String | Required |
Image | image
|
Filename of a representative image of the location.
|
String | Required |
Description | description
|
Description of the location shown on the in-game world map.
|
String | Required |
Room count | room_count
|
Number of rooms in the location.
|
Number | Recommended |
Trader count | trader_count
|
Number of traders in the location. Hidden if no value is assigned.
|
Number | Optional |
Quest count | quest_count
|
Number of quests that are started in the location. Hidden if no value is assigned.
|
Number | Optional |
Normal chest count | treasure_default
|
Number of regular chests in the location. Hidden if no value is assigned.
|
Number | Optional |
Bronze chest count | treasure_bronze
|
Number of bronze chests in the location. Hidden if no value is assigned.
|
Number | Optional |
Silver chest count | treasure_silver
|
Number of silver chests in the location. Hidden if no value is assigned.
|
Number | Optional |
Gold chest count | treasure_gold
|
Number of gold chests in the location. Hidden if no value is assigned.
|
Number | Optional |
Key chest count | treasure_key
|
Number of Key chests in the location. Hidden if no value is assigned.
|
Number | Optional |
Master Key chest count | treasure_masterkey
|
Number of Master Key chests in the location. Hidden if no value is assigned.
|
Number | Optional |
See Template:TemplateData and Template:TemplateData/entry for more information about the parameter list and DDNCode for more information about types and the DDN Notation
No description.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Name | name | Name of the location | String | required |
Color | color | value of the background color for the header. Can be done using either <code>{{[[Template:Loc color|Loc color]]}}</code> or HTML syntax.
| String | required |
Image | image | Filename of a representative image of the location.
| String | required |
Description | description | Description of the location shown on the in-game world map. | String | required |
Room count | room_count | Number of rooms in the location.
| Number | suggested |
Trader count | trader_count | Number of traders in the location. Hidden if no value is assigned. | Number | optional |
Quest count | quest_count | Number of quests that are started in the location. Hidden if no value is assigned. | Number | optional |
Normal chest count | treasure_default | Number of regular chests in the location. Hidden if no value is assigned. | Number | optional |
Bronze chest count | treasure_bronze | Number of bronze chests in the location. Hidden if no value is assigned. | Number | optional |
Silver chest count | treasure_silver | Number of silver chests in the location. Hidden if no value is assigned. | Number | optional |
Gold chest count | treasure_gold | Number of gold chests in the location. Hidden if no value is assigned. | Number | optional |
Key chest count | treasure_key | Number of Key chests in the location. Hidden if no value is assigned. | Number | optional |
Master Key chest count | treasure_masterkey | Number of Master Key chests in the location. Hidden if no value is assigned. | Number | optional |