Incrementer Element (Data)

From HLKitWiki
Jump to: navigation, search

Context: HL KitKit Reference … Data File Reference … Portal Element (Data) 

The "incrementer" Element

The "incrementer" element comes into play when you want to allow the user to modify a value via "plus" and "minus" adjustments. This approach is ideal for managing attributes, skill ratings, consumption of resources, and a variety of other situations. The complete list of attributes for this element is below.

field Id – Specifies the unique id of the field whose contents dictate the value displayed within the portal. The field must be a value-based field and the field must exist within the pick/thing associated with the containing template. If this portal is not defined within a template, an incrementer is not allowed.
interval (Optional) Integer – Specifies the adjustment to be applied whenever the user clicks on the '+' and '-' buttons for the incrementer. Default: "1".

Example

The following example demonstrates what an incrementer portal might look like. All default values are assumed for optional attributes.

<portal id="adjust" style="incrSimple">
  <incrementer field="adjUser"/>
  </portal>