Difference between revisions of "Definition File Reference"

From HLKitWiki
Jump to: navigation, search
(Structural Composition)
 
(10 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
Each game system has a single definition file that describes the fundamental, non-changing characteristics of the game. HL uses the definition file to configure itself for each game system, reading in the definition file before any other files. All of the contents of the other data files are given meaningful interpretation by the contents of the definition file.
 
Each game system has a single definition file that describes the fundamental, non-changing characteristics of the game. HL uses the definition file to configure itself for each game system, reading in the definition file before any other files. All of the contents of the other data files are given meaningful interpretation by the contents of the definition file.
  
This documentation outlines all the structure and mechanics for writing a definition file. Examples are provided in some cases.  
+
The definition file must have the file extension ".def". By convention, the file is always named "definition.def" so that it can always be readily identified.
  
{{important}}This section utilizes critical notational conventions that can be found in [[Conventions Used in Reference Section|over here]].
+
This section outlines the structure and mechanics for writing a definition file.
 +
 
 +
{{important}}This section utilizes [[Kit Reference#conventions|critical notational conventions]] that should be reviewed.
  
 
==Structural Composition==
 
==Structural Composition==
Line 22: Line 24:
  
 
Within the document element, every definition file possesses the following child elements, appearing in the sequence given and with the names specified.
 
Within the document element, every definition file possesses the following child elements, appearing in the sequence given and with the names specified.
 
{{important}}Just because you '''can''' put all of these different elements in the same file does not mean you '''should''' do so. Keeping your data files small and focused will also keep them much more manageable, so break up all the information across files where appropriate. See the Skeleton data files for examples of this.
 
  
 
:{| class="infotable"
 
:{| class="infotable"
Line 40: Line 40:
 
|{{flalt|Behavior Element (Data)|behavior}}
 
|{{flalt|Behavior Element (Data)|behavior}}
 
|A single "behavior" element must appear as defined by the given link. This element details behavioral aspects for the game system and data files.
 
|A single "behavior" element must appear as defined by the given link. This element details behavioral aspects for the game system and data files.
 +
|-
 +
|{{flalt|ScriptMacro Element (Data)|scriptmacro}}
 +
|Zero or more "scriptmacro" elements may appear as defined by the given link. This element defines macros for use within scripts.
 
|-
 
|-
 
|{{flalt|Advancement Element (Data)|advancement}}
 
|{{flalt|Advancement Element (Data)|advancement}}
 
|An optional "advancement" element may appear as defined by the given link. This element contains details regarding the advancement works within the data files.
 
|An optional "advancement" element may appear as defined by the given link. This element contains details regarding the advancement works within the data files.
|-
 
|{{flalt|EnMasse Element (Data)|enmasse}}
 
|Zero or more "enmasse" elements may appear as defined by the given link. This element specifies categories of things to automatically add to every actor.
 
|-
 
|{{flalt|Bootstrap Element (Data)|bootstrap}}
 
|Zero or more "bootstrap" elements may appear as defined by the given link. This element specifies specific things to automatically add to every actor.
 
|-
 
|{{flalt|AutoAdd Element (Data)|autoadd}}
 
|Zero or more "autoadd" elements may appear as defined by the given link. This element identifies choices that are pre-selected for every actor.
 
|-
 
|{{flalt|UsagePool Element (Data)|autoadd}}
 
|Zero or more "usagepool" elements may appear as defined by the given link. This element specifies usage pools for use by the game system.
 
|-
 
|{{flalt|Reference Element (Data)|reference}}
 
|Zero or more "reference" elements may appear as defined by the given link. This element details references used throughout the data files.
 
|-
 
|{{flalt|Group Element (Data)|group}}
 
|Zero or more "group" elements may appear as defined by the given link. This element defines a collection of tag groups and their tags.
 
|-
 
|{{flalt|Source Element (Data)|source}}
 
|Zero or more "source" elements may appear as defined by the given link. This element specifies sources that can be configured by the user for each actor.
 
 
|-
 
|-
 
|{{flalt|Phase Element (Data)|phase}}
 
|{{flalt|Phase Element (Data)|phase}}
 
|Zero or more "phase" elements may appear as defined by the given link. This element dictates the set of evaluation phases that will exist for the game system.
 
|Zero or more "phase" elements may appear as defined by the given link. This element dictates the set of evaluation phases that will exist for the game system.
|-
 
|{{flalt|Resource Element (Data)|resource}}
 
|Zero or more "resource" elements may appear as defined by the given link. This element defines resources like fonts and bitmaps used by styles for visual display.
 
|-
 
|{{flalt|Style Element (Data)|style}}
 
|Zero or more "style" elements may appear as defined by the given link. This element specifies an assortment of visual styles that can be used by portals.
 
|-
 
|{{flalt|Portal Element (Data)|portal}}
 
|Zero or more "portal" elements may appear as defined by the given link. This element specifies an assortment of portals for use within layouts.
 
|-
 
|{{flalt|Template Element (Data)|template}}
 
|Zero or more "template" elements may appear as defined by the given link. This element specifies an assortment of templates for use within layouts.
 
|-
 
|{{flalt|Component Element (Data)|component}}
 
|Zero or more "component" elements may appear as defined by the given link. This element specifies a variety of components that can be used by component sets.
 
|-
 
|{{flalt|Component Set Element (Data)|compset}}
 
|Zero or more "compset" elements may appear as defined by the given link. This element defines various component sets that can be used to define things.
 
|-
 
|{{flalt|Entity Element (Data)|entity}}
 
|Zero or more "entity" elements may appear as defined by the given link. This element defines entities that can be used within the game system.
 
|-
 
|{{flalt|Sort Set Element (Data)|sortset}}
 
|Zero or more "sortset" elements may appear as defined by the given link. This element defines various sort sets that can be used by the game system.
 
 
|-
 
|-
 
|}
 
|}

Latest revision as of 19:00, 8 December 2008

Context: HL KitKit Reference 

Overview

Each game system has a single definition file that describes the fundamental, non-changing characteristics of the game. HL uses the definition file to configure itself for each game system, reading in the definition file before any other files. All of the contents of the other data files are given meaningful interpretation by the contents of the definition file.

The definition file must have the file extension ".def". By convention, the file is always named "definition.def" so that it can always be readily identified.

This section outlines the structure and mechanics for writing a definition file.

IMPORTANT! This section utilizes critical notational conventions that should be reviewed.

Structural Composition

The overall file structure is that of a standard XML file. The file must start with an XML version element in the form: "<?xml version="1.0"?>". Following this, the top-level XML element must be a "document" and it must have a "signature" attribute containing the explicit value "Hero Lab Definition".

The following table defines the attributes for a "document" element.

signature Text – Must be the value "Hero Lab Definition".

Within the document element, every definition file possesses the following child elements, appearing in the sequence given and with the names specified.

game A single "game" element must appear as defined by the given link. This element contains basic game system information.
author An optional "author" element may appear as defined by the given link. This element contains information about the author of the data files.
release A single "release" element must appear as defined by the given link. This element provides details about the current release of the data files.
structure A single "structure" element must appear as defined by the given link. This element specifies structural details about the game system and its behavior.
behavior A single "behavior" element must appear as defined by the given link. This element details behavioral aspects for the game system and data files.
scriptmacro Zero or more "scriptmacro" elements may appear as defined by the given link. This element defines macros for use within scripts.
advancement An optional "advancement" element may appear as defined by the given link. This element contains details regarding the advancement works within the data files.
phase Zero or more "phase" elements may appear as defined by the given link. This element dictates the set of evaluation phases that will exist for the game system.