Resource Element (Data)

Context: HL Kit … Kit Reference … Structural File Reference 

The "resource" Element

Everything associated with fonts, colors, bitmaps and borders is managed via resources. Each visual attribute used within your data files is specified through the use of a "resource" element. The complete list of attributes for this element is below.

id	Id – Specifies the unique id of the resource. This id is used in all references to the resource.
isbuiltin	(Optional) Boolean – Indicates whether the resource is a "built-in" resource provided by HL for easy re-use. Only bitmaps and borders can be built-in resources, since fonts and colors can be freely defined at any time. Default: "no".
issystem	(Optional) Boolean – Indicates whether the resource is intended to replace a "system" resource utilized by HL. When you want to completely change the visual look of your data files and have that new look integrated into HL's own forms, you will need to specify system resources. Only specific resource ids can be replaced as system resources. Default: "no".

The "resource" element also possesses child elements that define the specifics of the resource. 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.

IMPORTANT! Exactly one of these child elements may be specified for each resource. If multiple are given, a compiler error will be reported.

color	An optional "color" element may appear as defined by the given link. This element specifies the details of a color resource.
font	An optional "font" element may appear as defined by the given link. This element specifies the details of a font resource.
bitmap	An optional "bitmap" element may appear as defined by the given link. This element specifies the details of a bitmap resource.
border	An optional "border" element may appear as defined by the given link. This element specifies the details of a bitmap-based border resource.
solid	An optional "solid" element may appear as defined by the given link. This element specifies the details of a solid-color border resource.

The "value" Element

The "value" element defines a tag for the containing tag group. The complete list of attributes for this element is below.

id	Id – Specifies the unique id of the tag within the group. This id is used in all references to the tag.
name	(Optional) Text – Name assigned to the tag. If empty, the unique id is used as the name. Maximum length is 100 characters. Default: Empty.
order	(Optional) Integer – Specifies the explicit order value to be used when sorting this tag against others within the tag group. This attribute only applies when the tag group is assigned the "explicit" sequence.

Example

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

<group id="Equipment" dynamic="yes">
  <value id="Hand" name="Requires one or more hands"/>
  <value id="TwoHand" name="Requires two hands"/>
  <value id="AutoEquip" name="Gear is auto-equipped"/>
  <value id="Natural" name="Natural weapon/armor/etc."/>
  <value id="CustomGear" name="Custom Gear"/>
  </group>