Difference between revisions of "User:Alistaire/Template:DefsStdTemplate/doc"

From RimWorld Wiki
Jump to navigation Jump to search
(contents -> type in examples)
(Added typeInfo, typeDefault)
Line 15: Line 15:
 
|-
 
|-
 
| type || ''(required):'' A [[User:Alistaire/Template:DefsStdContentSwitch]] -style content name. Accepted values are shown on the template page.
 
| type || ''(required):'' A [[User:Alistaire/Template:DefsStdContentSwitch]] -style content name. Accepted values are shown on the template page.
 +
|-
 +
| typeDefault || ''(optional):'' A [[User:Alistaire/Template:DefsStdContentSwitch]] -style default value. Shows up as (default: {{{typeDefault}}}), before typeInfo.
 +
|-
 +
| typeInfo || ''(optional):'' A [[User:Alistaire/Template:DefsStdContentSwitch]] -style extra info. Shows up as ({{{typeInfo}}}), behind typeDefault.
 
|-
 
|-
 
|}<br/>
 
|}<br/>

Revision as of 15:00, 12 April 2015

Example documentation

Parameters

Parameter Explanation
attribute (required1): The attribute, e.g <parent attribute=""/>, you are describing in this row.
link (optional): Overwrites what attribute/tag links to.
notes (required): An explanation on the tag/attribute described in this row.
tag (required1): The tag, e.g <parent><tag/></parent>, you are describing in this row.
type (required): A User:Alistaire/Template:DefsStdContentSwitch -style content name. Accepted values are shown on the template page.
typeDefault (optional): A User:Alistaire/Template:DefsStdContentSwitch -style default value. Shows up as (default: {{{typeDefault}}}), before typeInfo.
typeInfo (optional): A User:Alistaire/Template:DefsStdContentSwitch -style extra info. Shows up as ({{{typeInfo}}}), behind typeDefault.


  1. Only one of attribute and tag is shown.

Examples

Input Output
{{User:Alistaire/Template:DefsStdTemplateHeader}}
{{User:Alistaire/Template:DefsStdTemplate}}
|}
Parents: none specified
<>Alistaire/Template:DefsStdTemplate/doc
Element Contents Notes
none specified
{{User:Alistaire/Template:DefsStdTemplateHeader
|tag=thingDef
|parents={{User:Alistaire/Template:DefsStdFormatter|ThingDefs|Defs}}}}
{{User:Alistaire/Template:DefsStdTemplate
|tag=defName
|type=string
|notes=The in-script defName of this thing, referenced by recipes for example.}}
{{User:Alistaire/Template:DefsStdTemplate
|attribute=Name
|type=bool
|notes=The tag's Name that other tags have to reference to with ParentName to get the same contents.}}
|}
Parents: <>ThingDefs
<>thingDef
Element Contents Notes
<>defName string The in-script defName of this thing, referenced by recipes for example.
@Name boolean The tag's Name that other tags have to reference to with ParentName to get the same contents.