Difference between revisions of "Template:SetProp/doc"
From Salem Wiki
m (→Supported propname's: added new propnames) |
m (→Syntax: updated with info on Boolean types.) |
||
Line 15: | Line 15: | ||
:*:It defaults to a comma '''','''' | :*:It defaults to a comma '''','''' | ||
===Supported propname's=== | ===Supported propname's=== | ||
+ | Some properties are fit to assign multiple values to using a '''sep''', but those of type [[Special:Types/Boolean|Boolean]] are obviously not... | ||
:It currently supports these properties: | :It currently supports these properties: | ||
− | :*[[Property:IsGameMenu|IsGameMenu]] | + | :*[[Property:IsGameMenu|IsGameMenu]] ('''Boolean''') |
:*[[Property:IsinGameMenu|IsinGameMenu]] ⇐ Default separator is a '''^''' when no over-ride is used in '''sep''', be careful this property can use a comma in its valid value! | :*[[Property:IsinGameMenu|IsinGameMenu]] ⇐ Default separator is a '''^''' when no over-ride is used in '''sep''', be careful this property can use a comma in its valid value! | ||
:*[[Property:RequiresTech|RequiresTech]] | :*[[Property:RequiresTech|RequiresTech]] | ||
:*[[Property:RequiresObj|RequiresObj]] | :*[[Property:RequiresObj|RequiresObj]] | ||
− | :*[[Property:IsLiftable|IsLiftable]] / [[Property:IsLiftableWhenEmpty|IsLiftableWhenEmpty]] | + | :*[[Property:IsLiftable|IsLiftable]] / [[Property:IsLiftableWhenEmpty|IsLiftableWhenEmpty]] ('''Boolean''') |
==Examples== | ==Examples== |
Revision as of 04:03, 28 June 2012
Description
- This is a wrapper-template that calls {{SetProp/single}} to automatically set property values.
- It has a fixed-set of properties it supports, and can be expanded when needed in code...
Syntax
- Type the below code somewhere on a page:
{{SetProp |propname=propvalues |propname=propvalues |... }}
- It supports this optional named-parameter:
- sep
- The default separator used in the propvalues to separate single-values from each other.
- It defaults to a comma ','
- sep
Supported propname's
Some properties are fit to assign multiple values to using a sep, but those of type Boolean are obviously not...
- It currently supports these properties:
- IsGameMenu (Boolean)
- IsinGameMenu ⇐ Default separator is a ^ when no over-ride is used in sep, be careful this property can use a comma in its valid value!
- RequiresTech
- RequiresObj
- IsLiftable / IsLiftableWhenEmpty (Boolean)
Examples
See the example(s) in the documentation of {{SetProp/single}}, this template just passes known properties with their values to it.