Difference between revisions of "Template:SetProp/doc"

Revision as of 16:36, 28 June 2012

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.

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 ','

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)
- Has icon (Page)
  Only supply the filename, it will automatically prepend the final property-value with Image:
  
  When not used, it will auto-set this property to Image:{{SUBPAGENAME}} icon.png
- Has fullview (Page)
  Only supply the filename, it will automatically prepend the final property-value with Image:
- IsLiftable (Boolean)
- IsLiftableWhenEmpty (Boolean)
  Will auto-set IsLiftable='true' when used with any value, so only use it to assign a true!
- HP (Number)
- Soak (Number)

See the example(s) in the documentation of {{SetProp/single}}, this template just passes known properties with their values to it.

@@ Line 24: / Line 24: @@
 *It currently supports these '''single-value''' properties:
 **[[Property:IsGameMenu|IsGameMenu]] (Boolean)
+**[[Property:Has icon|Has icon]] (Page)
+**:Only supply the filename, it will automatically prepend the final property-value with <code><nowiki>Image:</nowiki></code>
+**:When not used, it will auto-set this property to <code><nowiki>Image:{{SUBPAGENAME}} icon.png</nowiki></code>
+**[[Property:Has fullview|Has fullview]] (Page)
+**:Only supply the filename, it will automatically prepend the final property-value with <code><nowiki>Image:</nowiki></code>
 **[[Property:IsLiftable|IsLiftable]] (Boolean)
-**[[Property:IsLiftableWhenEmpty|IsLiftableWhenEmpty]] (Boolean) &lArr; Will auto-set [[Property:IsLiftable|IsLiftable]]='true' when used with '''any''' value, so only use it to assign a true!
+**[[Property:IsLiftableWhenEmpty|IsLiftableWhenEmpty]] (Boolean)
+**:Will auto-set [[Property:IsLiftable|IsLiftable]]='true' when used with '''any''' value, so only use it to assign a true!
 **[[Property:HP|HP]] (Number)
 **[[Property:Soak|Soak]] (Number)