Phase Element (Data)

From HLKitWiki
Jump to: navigation, search

Context: HL KitKit Reference … Definition File Reference 

The "phase" Element

Each phase within the evaluation cycle must be individually specified and the sequence in which the phase elements are defined dictates the sequence in which phases are processed during evaluation. The XML element name is "phase" and the complete list of attributes is below.

id Id – Specifies the unique id assigned to this phase. This id is used to reference the phase throughout the data files.
name Text – Common name for the phase is displayed in various situations. Maximum length is 25 characters.
description (Optional) Text – Textual description of the role the phase serves within the game system. Default: Empty.
interleave (Optional) Boolean – Indicates whether all tasks within this phase are either (a) interleaved across masters and minions or (b) processed hierarchically, with masters always being evaluated before minions. This works the exact same way as the "interleave" attribute within the "behavior" element, except that it only applies to tasks within this specific phase. Default: "yes".

IMPORTANT! This attribute is only applicable when interleaving is enabled for the game system. It provides a means of forcing individual phases to be non-interleaved, which makes it possible to safely control dependencies of minions upon their masters for enablement conditions and the like. The default is "yes" so that all phases are interleaved by default if the game system behavior is designated as interleaved.


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

  description="Anything that has to happen before everything else">