Kit Reference

Context: HL Kit

This section details all of the specific formats and mechanisms used within the Kit. This encompasses all of the different file formats, all the scripting contexts and transitions, required and pre-defined elements, and anything else that requires specification. Click on the various topics below to delve into the details for that facet of the Kit.

IMPORTANT! This section of the documentation is not yet complete. Topics that have been written will be found at the top of the list below and possess live links. Other topics are simply identified by name, sometimes along with a few notes about what the topic will contain. These topics will be added over time to complete the documentation.

Conventions Used in Reference Section

A number of important conventions are used throughout the various reference topics below. Be sure to review this section before perusing the other reference topics.

XML Details

The basics of XML files have already been outlined. This section outlines additional XML details that may be of use.

The ".def" File

The definition file provides the Kit with the most fundamental information it needs to know about the structure of a game system. All other files are built upon the definition file.

The ".1st" File

The "first" files are loaded immediately after the definition file and before any other files. They define structural elements that the rest of the data files build upon.

The ".core" File

The "core" files are loaded after the ".1st" files and define additional structural elements that build upon the files that have been loaded previously.

The ".str" File

All ".str" files are loaded after the ".core" files and define additional structural elements that build upon the files that have been loaded previously.

The ".aug" File

All ".aug" files are loaded after the ".str" files and define additional structural elements that build upon the files that have been loaded previously.

The ".dat" File

The ".dat" files are loaded last, after all other data files have been loaded. These data files define all of the major elements the user sees, including things and panels.

---

[TBD] 

---

• Evaluation cycle
  • Relative timing of Leads vs. masters vs. minions
  • Rules for sequencing of tasks with the same phase and priority

• Scripting
  • Links back to reference info covered in Basic Concepts section
  • Language Intrinsic Functions
  • What about declaring variables? Currently in basic concepts
  • Compiler error messages
  • Miscellaneous notes

• Script Data Access
  • List of Contexts
  • List of Transitions
  • List of Target References
  • Script types (i.e. list of different scripts)
  • Script Macros

• Tag expressions
  • List of tag expressions used throughout Kit
  • Annotate when and how to use them

• Visual Elements
  • Rules for auto-sizing and default sizing

• Pre-Defined Elements
  • Tags and Tag Groups
  • Components (journal, transact, stackable, gear, etc.)
  • Component Sets
  • Fields
  • Pseudo-fields
  • Sort Sets
  • Things
  • Built-in Resources
  • System Resources

• Required Elements
  • Components
  • Component Sets

• Auto-Defined Tags

• Timing report contents and structure

• Skeleton Data Files
  • What's provided
  • How things work
  • Why elements are provided