Difference between revisions of "Template:SetProp/doc"
From Salem Wiki
m (→Supported propname's: re-arranged order, split them into 2 parts) |
m (→Supported propname's: its better to mention type of single value props...) |
||
| Line 17: | Line 17: | ||
:*:It defaults to a comma '''','''' | :*:It defaults to a comma '''','''' | ||
===Supported propname's=== | ===Supported propname's=== | ||
| − | *It currently supports these multi-value properties: | + | *It currently supports these '''multi-value''' properties: |
**[[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:RepairedWith|RepairedWith]] | **[[Property:RepairedWith|RepairedWith]] | ||
| − | *It currently supports these ''' | + | *It currently supports these '''single-value''' properties: |
| − | **[[Property:IsGameMenu|IsGameMenu]] | + | **[[Property:IsGameMenu|IsGameMenu]] (Boolean) |
| − | **[[Property:IsLiftable|IsLiftable]] | + | **[[Property:IsLiftable|IsLiftable]] (Boolean) |
| + | **[[Property:IsLiftableWhenEmpty|IsLiftableWhenEmpty]] (Boolean) ⇐ Will auto-set [[Property:IsLiftable|IsLiftable]]='true' when used with '''any''' value, so only use it to assign a true! | ||
==Examples== | ==Examples== | ||
Revision as of 14:21, 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...
- Some properties are fit to assign multiple values to, using a sep, but those of type Boolean are obviously not...
- Supported properties of type Boolean will always automatically be set to "false" as default when not explicitly set.
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
- It currently supports these multi-value properties:
- 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
- RepairedWith
- It currently supports these single-value properties:
- IsGameMenu (Boolean)
- IsLiftable (Boolean)
- IsLiftableWhenEmpty (Boolean) ⇐ Will auto-set IsLiftable='true' when used with any value, so only use it to assign a true!
Examples
See the example(s) in the documentation of {{SetProp/single}}, this template just passes known properties with their values to it.
