Template:TreasureList/entry/doc: Difference between revisions

From CrossCode Wiki
Jump to navigation Jump to search
(Created page with "{{doc/start}} {| class="wikitable sortable" ! Acc. ! Type ! Contains ! Location ! class="unsortable" | Info {{TreasureList/entry|acc=1|type=default|item=Hi-Sandwich|amount=...")
 
 
(4 intermediate revisions by one other user not shown)
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=Name override|param=showName|desc=Specify a custom name|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}}
}}


{| class="wikitable sortable"
== Examples ==
! Acc.
 
! Type
{{TreasureList|
! Contains
{{TreasureList/entry|acc=1|type=default|item=Hi-Sandwich|amount=3|loc=Location|info=Info}}
! Location
{{TreasureList/entry|acc=2|type=bronze|item=Hi-Sandwich|amount=3|loc=Location}}
! class="unsortable" | Info
{{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=3|type=silver|item=Hi-Sandwich|showName=Other name|amount=3|info=Info}}
{{TreasureList/entry|acc=6|type=masterkey|item=Hi-Sandwich|amount=3}}
}}
 
<pre>
{{TreasureList|
{{TreasureList/entry|acc=1|type=default|item=Hi-Sandwich|amount=3|loc=Location|info=Info}}
{{TreasureList/entry|acc=1|type=default|item=Hi-Sandwich|amount=3|loc=Location|info=Info}}
{{TreasureList/entry|acc=2|type=default|item=Hi-Sandwich|amount=3|loc=Location}}
{{TreasureList/entry|acc=2|type=bronze|item=Hi-Sandwich|amount=3|loc=Location}}
{{TreasureList/entry|acc=3|type=default|item=Hi-Sandwich|amount=3|info=Info}}
{{TreasureList/entry|acc=3|type=silver|item=Hi-Sandwich|amount=3|info=Info}}
{{TreasureList/entry|acc=3|type=default|item=Hi-Sandwich|amount=3}}
{{TreasureList/entry|acc=4|type=gold|item=Hi-Sandwich|amount=3}}
|}
{{TreasureList/entry|acc=5|type=key|item=Hi-Sandwich|amount=3}}
{{doc/end}}
{{TreasureList/entry|acc=3|type=silver|item=Hi-Sandwich|showName=Other name|amount=3|info=Info}}
{{TreasureList/entry|acc=6|type=masterkey|item=Hi-Sandwich|amount=3}}
}}
</pre>
{{Doc/end}}
<includeonly>
[[Category:Table templates]]
</includeonly>

Latest revision as of 06:38, 17 April 2021

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
Name override showName

Specify a custom name

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
Name overrideshowName

Specify a custom name

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
3 Silver 3 × Other name Info
6 Master Key 3 × Hi-Sandwich
{{TreasureList|
{{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=3|type=silver|item=Hi-Sandwich|showName=Other name|amount=3|info=Info}}
{{TreasureList/entry|acc=6|type=masterkey|item=Hi-Sandwich|amount=3}}
}}