Kit Reference: Difference between revisions
| (14 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{context}} | {{context}} | ||
[[Category:Kit Reference]] | [[Category:Kit Reference]] | ||
==Overview== | |||
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. | 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. | ||
==Revision History== | |||
The Authoring Kit is an evolving toolset. A detailed summary of the changes and enhancements made within each new version after the initial V3.0 release is accessible via the links below. | |||
*{{flalt|Functionality Revision History|Functionality Changes and Enhancements}} | |||
*{{flalt|Skeleton Data File Revision History|Skeleton Data File Changes and Enhancements}} | |||
==XML Details== | ==XML Details== | ||
| Line 20: | Line 27: | ||
*{{fl|Optional Attributes in Data Files}} | *{{fl|Optional Attributes in Data Files}} | ||
==Tags and Tag Expressions== | ==Tags and Tag Expressions{{anchor|tagexprs}}== | ||
Tags are a fundamental building block that a wide range of mechanisms leverage through the Kit. Tags are utilized to identify and classify objects through tag expressions. The following topics delve into the various facets of using tags. | Tags are a fundamental building block that a wide range of mechanisms leverage through the Kit. Tags are utilized to identify and classify objects through tag expressions. The following topics delve into the various facets of using tags. | ||
| Line 27: | Line 34: | ||
*{{fl|Tag Expression Types}} | *{{fl|Tag Expression Types}} | ||
==Scripting Language== | ==Scripting Language{{anchor|scripts}}== | ||
The types of behaviors that exist within the realm of RPGs is limitless. As such, it's impossible for HL to anticipate everything, so the Kit provides a versatile scripting language that enables data files to adapt to virtually any game system. The scripting language has many facets that you should be familiar with, and the topics below outline the information you'll need. | The types of behaviors that exist within the realm of RPGs is limitless. As such, it's impossible for HL to anticipate everything, so the Kit provides a versatile scripting language that enables data files to adapt to virtually any game system. The scripting language has many facets that you should be familiar with, and the topics below outline the information you'll need. | ||
| Line 39: | Line 46: | ||
*{{fl|Language Intrinsics}} | *{{fl|Language Intrinsics}} | ||
*{{fl|Special Symbols}} | *{{fl|Special Symbols}} | ||
*[[Encoded Text|Formatting with Encoded Text]] | |||
*{{fl|Script Macros}} | *{{fl|Script Macros}} | ||
*{{fl|Re-usable Procedures}} | *{{fl|Re-usable Procedures}} | ||
*{{fl|Debugging Mechanisms}} | |||
*{{fl|Compiler Error Messages}} | *{{fl|Compiler Error Messages}} | ||
==Script Data Access== | ==Script Data Access== | ||
The majority of your scripts will focus on accessing and manipulating the data managed within HL. This will involving identifying both the structural and visual elements throughout the data hierarchy. The following topics detail the various pieces involved in data access. | The majority of your scripts will focus on accessing and manipulating the data managed within HL. This will involving identifying both the structural and visual elements throughout the data hierarchy. The following topics detail the various pieces involved in data access. | ||
{{important}}Be sure you are familiar with the [[Data Manipulation Basics|basics of data manipulation]] before reviewing this content. | |||
*{{fl|Script Contexts}} | *{{fl|Script Contexts}} | ||
| Line 62: | Line 73: | ||
*{{fl|Data File Reference}} | *{{fl|Data File Reference}} | ||
== | ==Auto-Defined Elements== | ||
The Kit automatically defines a variety of different structural and visual elements for use in common situations. These auto-defined elements help to streamline and simplify the authoring process, and they are detailed in the topics below. | |||
* | *{{fl|Pseudo-Fields}} | ||
** | *{{fl|Auto-Defined Tags and Tag Groups}} | ||
** | *{{fl|Auto-Defined Components and Fields}} | ||
**journal, transact, stackable, gear, shortname, etc. | |||
*{{fl|Auto-Defined Component Sets}} | |||
*{{fl|Auto-Defined Things}} | |||
*{{fl|Auto-Defined Sort Sets}} | |||
*{{fl|Built-in Resources}} | |||
*{{fl|System Resources}} | |||
==Required Elements== | |||
There are an assortment of structural and visual elements that every set of data files is required to define. By standardizing on a core set of objects, everything becomes simpler to manage for the data file author. To make the process as easy as possible, the Skeleton data files pre-define these necessary pieces, which you can leave as is or modify if you wish. | |||
*Required | *{{fl|Required Panels}} | ||
**Components | *{{fl|Required Forms}} | ||
* | *{{fl|Required Components and Fields}} | ||
*{{fl|Required Component Sets}} | |||
*{{fl|Required Things}} | |||
==Other File Formats== | |||
In addition to the various data files, HL utilizes a few other types of files. The contents of these files is documented in the topics below. | |||
* | *{{fl|Timing Report File Reference}} | ||
* | *{{fl|Portfolio File Reference}} | ||
Latest revision as of 00:36, 26 June 2009
Context: HL Kit
Overview
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.
Revision History
The Authoring Kit is an evolving toolset. A detailed summary of the changes and enhancements made within each new version after the initial V3.0 release is accessible via the links below.
XML Details
Most of the basics regarding the Kit's use of XML files and their implications can be found in the section on XML Files. Additional reference details are outlined in the topics below.
Conventions Used Below
The reference section of this documentation utilizes a variety of notational conventions for presenting how things work. This includes the syntax used for data files, as well as the formats for other types of files, which are outlined in the topics below.
Tags and Tag Expressions
Tags are a fundamental building block that a wide range of mechanisms leverage through the Kit. Tags are utilized to identify and classify objects through tag expressions. The following topics delve into the various facets of using tags.
Scripting Language
The types of behaviors that exist within the realm of RPGs is limitless. As such, it's impossible for HL to anticipate everything, so the Kit provides a versatile scripting language that enables data files to adapt to virtually any game system. The scripting language has many facets that you should be familiar with, and the topics below outline the information you'll need.
- Scripting Language Overview
- Language Syntax
- Declaring Variables
- Basic Language Mechanisms
- Flow Control
- Other Language Statements
- Language Intrinsics
- Special Symbols
- Formatting with Encoded Text
- Script Macros
- Re-usable Procedures
- Debugging Mechanisms
- Compiler Error Messages
Script Data Access
The majority of your scripts will focus on accessing and manipulating the data managed within HL. This will involving identifying both the structural and visual elements throughout the data hierarchy. The following topics detail the various pieces involved in data access.
IMPORTANT! Be sure you are familiar with the basics of data manipulation before reviewing this content.
- Script Contexts
- Context Transitions
- Target References
- Data Access Examples
- Employing Script Macros
- Script Types
Structure of Data Files
There are a number of different types of files that comprise the data files for a game system. Each of the topics below describes the structure of one of these file types.
Auto-Defined Elements
The Kit automatically defines a variety of different structural and visual elements for use in common situations. These auto-defined elements help to streamline and simplify the authoring process, and they are detailed in the topics below.
- Pseudo-Fields
- Auto-Defined Tags and Tag Groups
- Auto-Defined Components and Fields
- journal, transact, stackable, gear, shortname, etc.
- Auto-Defined Component Sets
- Auto-Defined Things
- Auto-Defined Sort Sets
- Built-in Resources
- System Resources
Required Elements
There are an assortment of structural and visual elements that every set of data files is required to define. By standardizing on a core set of objects, everything becomes simpler to manage for the data file author. To make the process as easy as possible, the Skeleton data files pre-define these necessary pieces, which you can leave as is or modify if you wish.
- Required Panels
- Required Forms
- Required Components and Fields
- Required Component Sets
- Required Things
Other File Formats
In addition to the various data files, HL utilizes a few other types of files. The contents of these files is documented in the topics below.
