UsagePool Element (Data)

From HLKitWiki
Jump to: navigation, search

Context: HL KitKit Reference … Structural File Reference 

The "usagepool" Element

Usage pools provide a convenient way to manage resources that have built-in history tracking of all changes. You define each usage pool via the "usagepool" element. The complete list of attributes for this element is below.

id Id – Specifies the unique id to utilize for this usage pool.
name Text – Name to be used in reference to this usage pool. Maximum length is 25 characters.
abbrev Text – Abbreviation to be used for the usage pool. If empty, the name is also used as the abbreviation. Maximum length is 25 characters. Default: Empty.
quantity Integer – Specifies the starting quantity to be used for the usage pool. Default: "0".
maximum Integer – Specifies the maximum history size to be tracked for the pool. A value of zero indicates no limit on the history. Default: "0".
ishero Boolean – Indicates whether the usage pool is intended for use on each hero/actor or with individual picks. Default: "yes".
persist Boolean – Indicates whether the history information is saved within the portfolio and restored when it is reloaded. If not persistent, only the latest value is preserved. Default: "no".


The following example demonstrates what a "usagepool" element might look like. All default values are assumed for optional attributes.

  name="Total XP"