Template:TreasureList/entry/doc: Difference between revisions

From CrossCode Wiki
Jump to navigation Jump to search
m (types added)
No edit summary
Line 1: Line 1:
{{doc/start}}
{{doc/start}}
Entry element for [[Template:TreasureList]]


== About ==
Generates an entry for the [[Template:TreasureList]]


== Parameter ==
{{TemplateData|
{{TemplateData/entry|name=Access number|param=acc|desc=Accessibility position|def=NULL|example=|type=Number|status=Required}}
{{TemplateData/entry|name=Chest type|param=type|desc=Set the chest type for this entry|def=NULL|example=|type=<nowiki>["normal"|"default"|"bronze"|"silver"|"gold"|"key"|"masterkey"]</nowiki>|status=Required}}
{{TemplateData/entry|name=Item|param=item|desc=Contained Item|def=NULL|example=|type=String|status=Required}}
{{TemplateData/entry|name=Amount|param=amount|desc=Amount of the contained Item|def=NULL|example=|type=Number|status=Required}}
{{TemplateData/entry|name=Location|param=loc|desc=Chest Location|def=NULL|example=|type=WikiCode|status=Optional}}
{{TemplateData/entry|name=Info|param=info|desc=Chest info|def=NULL|example=|type=WikiCode|status=Optional}}
}}


== Examples ==
{| class="wikitable sortable"
! Acc.
! Type
! Contains
! Location
! class="unsortable" | Info
{{TreasureList/entry|acc=1|type=default|item=Hi-Sandwich|amount=3|loc=Location|info=Info}}
{{TreasureList/entry|acc=2|type=bronze|item=Hi-Sandwich|amount=3|loc=Location}}
{{TreasureList/entry|acc=3|type=silver|item=Hi-Sandwich|amount=3|info=Info}}
{{TreasureList/entry|acc=4|type=gold|item=Hi-Sandwich|amount=3}}
{{TreasureList/entry|acc=5|type=key|item=Hi-Sandwich|amount=3}}
{{TreasureList/entry|acc=6|type=masterkey|item=Hi-Sandwich|amount=3}}
|}
<pre>
{| class="wikitable sortable"
{| class="wikitable sortable"
! Acc.
! Acc.
Line 16: Line 45:
{{TreasureList/entry|acc=6|type=masterkey|item=Hi-Sandwich|amount=3}}
{{TreasureList/entry|acc=6|type=masterkey|item=Hi-Sandwich|amount=3}}
|}
|}
</pre>
{{doc/end}}
{{doc/end}}

Revision as of 12:15, 15 January 2017

File:Template-info.svg Template Documentation

Entry element for Template:TreasureList

About

Generates an entry for the Template:TreasureList

Parameter

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
Access number acc

Accessibility position

Default:
NULL
Example:
no example
Number Required
Chest type type

Set the chest type for this entry

Default:
NULL
Example:
no example
["normal"|"default"|"bronze"|"silver"|"gold"|"key"|"masterkey"] Required
Item item

Contained Item

Default:
NULL
Example:
no example
String Required
Amount amount

Amount of the contained Item

Default:
NULL
Example:
no example
Number Required
Location loc

Chest Location

Default:
NULL
Example:
no example
WikiCode Optional
Info info

Chest info

Default:
NULL
Example:
no example
WikiCode 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

Test of raw TemplateData output:

No description.

Template parameters

ParameterDescriptionTypeStatus
Access numberacc

Accessibility position

Numberrequired
Chest typetype

Set the chest type for this entry

Contentrequired
Itemitem

Contained Item

Stringrequired
Amountamount

Amount of the contained Item

Numberrequired
Locationloc

Chest Location

Contentoptional
Infoinfo

Chest info

Contentoptional

Examples

Acc. Type Contains Location Info
1 Normal 3 × Hi-Sandwich Location Info
2 Bronze 3 × Hi-Sandwich Location
3 Silver 3 × Hi-Sandwich Info
4 Gold 3 × Hi-Sandwich
5 Key 3 × Hi-Sandwich
6 Master Key 3 × Hi-Sandwich
{| class="wikitable sortable"
! Acc.
! Type
! Contains
! Location
! class="unsortable" | Info
{{TreasureList/entry|acc=1|type=default|item=Hi-Sandwich|amount=3|loc=Location|info=Info}}
{{TreasureList/entry|acc=2|type=bronze|item=Hi-Sandwich|amount=3|loc=Location}}
{{TreasureList/entry|acc=3|type=silver|item=Hi-Sandwich|amount=3|info=Info}}
{{TreasureList/entry|acc=4|type=gold|item=Hi-Sandwich|amount=3}}
{{TreasureList/entry|acc=5|type=key|item=Hi-Sandwich|amount=3}}
{{TreasureList/entry|acc=6|type=masterkey|item=Hi-Sandwich|amount=3}}
|}