Template:SetProp/doc

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...

For more documentation on functions used see

• Help:Properties and types (Silent annotations using #set)

Syntax

Type the below code somewhere on a page:

{{SetProp
|propname=propvalues
|propname=propvalues
|...
}}

It supports this optional named-parameter for multi-value propname's:

• sep

  The default separator used in the propvalues to separate single-values from each other.

  It defaults to a comma ','

Supported propname's

It currently supports these properties in preferred sequence:

• IsGameMenu (Type: Boolean, single-value)

  Will always be set.

  Defaults to 'false'.

• IsinGameMenu (Type: String, multi-value)

  Default separator in this case is a ^ when no over-ride is used in sep, be careful this property can use a comma in its valid value!

• Has icon (Type: Page, single-value)

  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

• Caption (Type: Text, single-value)

  Can hold free text.

• Has fullview (Type: Page, single-value)

  Only supply the filename, it will automatically prepend the final property-value with Image:

• RequiresTech (Type: Page, multi-value)
• UnlocksTech (Type: Page, multi-value)
• RequiresObj (Type: String, multi-value)
• RepairedWith (Type: String, multi-value)
• RequiredBy (Type: Page, multi-value)

  This will be automatically set using {{SetProp/RequiredBy auto}}, after any eventual manual assignments using this propname.

• IsLiftable (Type: Boolean, single-value)
• IsLiftableWhenEmpty (Type: Boolean, single-value)

  When used will always be set to 'true', and auto-set IsLiftable='true'.

• HP (Type: Number, single-value)
• Soak (Type: Number, single-value)
• Skills (Type: Number, single-value)

  These are called Proficiencies ingame.

  If either one of the below Skills are set, then all will be set at same time.

  They will all default to '0', when not given a value explicitly.

  • arts = Arts & Crafts
  • cloak = Cloak & Dagger
  • faith = Faith & Wisdom
  • frontier = Frontier & Wilderness
  • hammer = Hammer & Nail
  • hunting = Hunting & Gathering
  • law = Law & Lore
  • mines = Mines & Mountains
  • pots = Pots & Pans
  • sparks = Sparks & Embers
  • stocks = Stocks & Cultivars
  • sugar = Sugar & Spice
  • thread = Thread & Needle
  • natural = Natural Philosophy
  • perennial = Perennial Philosophy

Examples

See the example(s) in the documentation of {{SetProp/single}}, this template just passes known multi-value properties with their values to it.
Or directly uses {{#set:propname=propvalue}} for single-value properties.