Bootstrap Element (Data)

From HLKitWiki
Revision as of 10:55, 24 November 2008 by Rob (talk | contribs)
Jump to navigationJump to search

Context: HL Kit … Kit Reference  … Multiple Sources

The "bootstrap" Element

In a variety of situations, you will be able to specify individual things that should be automatically added to a container as picks. This process is called bootstrapping and has a diverse set of special rules that must be observed. Each bootstrapped thing is specified through the use of a "bootstrap" element. The complete list of attributes for this element is below.

thing Id – Specifies the unique id of the thing that is to be automatically added to the container.
index (Optional) Integer – Specifies a unique index value for this bootstrap entry. Only global bootstraps that add things to all actors require this attribute and it can be omitted in all other situations. Default: "0".

WARNING! The index is used to uniquely identify this specific bootstrap within saved portfolios. Consequently, it must never be changed or re-used within differnt versions of the data files. If you eliminate a bootstrap entry, simply leave that index value unused, replacing the old "bootstrap" element with a comment explaining why the hole in numbering is left.

The "bootstrap" element also possesses child elements that pertain to the automatically added things. The list of these child elements is below and must appear in the order shown. Click on the link to access the details for each element.

autotag A single "autotag" element may appear as defined by the given link. This element specifies a tag that is automatically assigned to each added thing.


-Condition tests are not allowed for bootstraps on entities and rulesets

Example

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

<autotag group="TheGroup" tag="TheTag"/>