Structural File Reference - Revision history

Colen: /* Structural Composition */

2014-12-08T06:15:08Z

Structural Composition

← Older revision		Revision as of 06:15, 8 December 2014
Line 28:		Line 28:

	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|{{flalt\|EnMasse Element (Data)\|enmasse}}		\|class="leftnormal"\|{{flalt\|LoadOnce Element (Data)\|loadonce}}
			\|A single "loadonce" element may appear as defined by the given link. This element allows you to conditionally exclude files from being loaded if a similar file has already been loaded.
			\|-
			\|{{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.		\|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.
	\|-		\|-

Rob: /* Overview */

2008-12-04T05:14:21Z

Overview

← Older revision		Revision as of 05:14, 4 December 2008
Line 9:		Line 9:
	This section outlines the structure and mechanics for writing a structural file.		This section outlines the structure and mechanics for writing a structural file.

	{{important}}This section utilizes [[~~Conventions Used in~~ Reference ~~Section~~\|critical notational conventions]] that should be reviewed.		{{important}}This section utilizes [[Kit Reference#conventions\|critical notational conventions]] that should be reviewed.

	{{important}}Just because you '''can''' put numerous 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.		{{important}}Just because you '''can''' put numerous 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.

Rob: /* Overview */

2008-12-01T00:49:50Z

Overview

← Older revision		Revision as of 00:49, 1 December 2008
Line 9:		Line 9:
	This section outlines the structure and mechanics for writing a structural file.		This section outlines the structure and mechanics for writing a structural file.

	{{important}}This section utilizes ~~critical notational conventions that can be found in~~ [[Conventions Used in Reference Section\|~~over here~~]].		{{important}}This section utilizes [[Conventions Used in Reference Section\|critical notational conventions]] that should be reviewed.

	{{important}}Just because you '''can''' put numerous 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.		{{important}}Just because you '''can''' put numerous 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.

Rob: /* Structural Composition */

2008-11-24T12:53:23Z

Structural Composition

← Older revision		Revision as of 12:53, 24 November 2008
Line 37:		Line 37:
	\|Zero or more "autoadd" elements may appear as defined by the given link. This element identifies choices that are pre-selected for every actor.		\|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~~}}		\|{{flalt\|UsagePool Element (Data)\|usagepool}}
	\|Zero or more "usagepool" elements may appear as defined by the given link. This element specifies usage pools for use by the game system.		\|Zero or more "usagepool" elements may appear as defined by the given link. This element specifies usage pools for use by the game system.
	\|-		\|-

Rob: /* Structural Composition */

2008-11-22T23:49:04Z

Structural Composition

← Older revision		Revision as of 23:49, 22 November 2008
Line 28:		Line 28:

	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|{{fl\|EnMasse Element (Data)\|enmasse}}		\|class="leftnormal"\|{{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.		\|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.
	\|-		\|-

Rob: /* Structural Composition */

2008-11-22T23:48:45Z

Structural Composition

← Older revision		Revision as of 23:48, 22 November 2008
Line 28:		Line 28:

	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|EnMasse Element (Data)\|enmasse}}		\|class="leftnormal"\|{{fl\|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.		\|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.
	\|-		\|-

Rob at 23:48, 22 November 2008

2008-11-22T23:48:10Z

← Older revision		Revision as of 23:48, 22 November 2008
Line 3:		Line 3:
	==Overview==		==Overview==

	~~The ".1st"~~ files ~~are structural files, so they~~ are where you'll be defining all of the pieces that provide the underlying framework for the game system~~. The Kit supports four different structural files that share the identical contents. Of the four, the ".1st" files are loaded first, as implied by the file extension~~. They are loaded immediately after the definition file.		Structural files are where you'll be defining all of the pieces that provide the underlying framework for the game system. They are loaded immediately after the definition file.

	This section outlines the structure and mechanics for writing a ~~definition~~ file.		The Kit supports four different structural file types that share the identical contents. They possess the file extensions ".1st", "core", ".str", and ".aug". These files are always loaded in that same order.

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

	{{important}}This section utilizes critical notational conventions that can be found in [[Conventions Used in Reference Section\|over here]].		{{important}}This section utilizes critical notational conventions that can be found in [[Conventions Used in Reference Section\|over here]].
Line 13:		Line 15:
	==Structural Composition==		==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 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 Structure".

	The following table defines the attributes for a "document" element.		The following table defines the attributes for a "document" element.
Line 19:		Line 21:
	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|signature		\|class="leftnormal"\|signature
	\|Text – Must be the value "Hero Lab ~~Definition~~".		\|Text – Must be the value "Hero Lab Structure".
	\|-		\|-
	\|}		\|}

	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 structural file possesses the following child elements, appearing in the sequence given and with the names specified.

	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"~~\|{{flalt\|Game Element (Data)\|game}}~~		\|class="leftnormal"\|EnMasse Element (Data)\|enmasse}}
	~~\|A single "game" element must appear as defined by the given link. This element contains basic game system information.~~
	\|-
	~~\|{{flalt\|Author Element (Data)\|author}}~~
	~~\|An optional "author" element may appear as defined by the given link. This element contains information about the author of the data files.~~
	\|-
	~~\|{{flalt\|Release Element (Data)\|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.~~
	\|-
	~~\|{{flalt\|Structure Element (Data)\|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.~~
	\|-
	~~\|{{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.~~
	\|-
	~~\|{{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.~~
	\|-
	~~\|{{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.		\|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.
	\|-		\|-
Line 64:		Line 48:
	\|{{flalt\|Source Element (Data)\|source}}		\|{{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.		\|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}}~~
	~~\|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}}		\|{{flalt\|Resource Element (Data)\|resource}}
Line 73:		Line 54:
	\|{{flalt\|Style Element (Data)\|style}}		\|{{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.		\|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}}		\|{{flalt\|Component Element (Data)\|component}}

Rob: The ".1st" File moved to Structural File Reference

2008-11-22T23:37:37Z

The ".1st" File moved to Structural File Reference

← Older revision	Revision as of 23:37, 22 November 2008
(No difference)

Rob at 23:35, 22 November 2008

2008-11-22T23:35:16Z

← Older revision		Revision as of 23:35, 22 November 2008
Line 3:		Line 3:
	==Overview==		==Overview==

	~~The Kit supports four different files that share~~		The ".1st" files are structural files, so they are where you'll be defining all of the pieces that provide the underlying framework for the game system. The Kit supports four different structural files that share the identical contents. Of the four, the ".1st" files are loaded first, as implied by the file extension. They are loaded immediately after the definition file.

	The ".1st" files are ~~loaded immediately after 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 section outlines the structure and mechanics for writing a definition file.		This section outlines the structure and mechanics for writing a definition file.

Rob at 23:25, 22 November 2008

2008-11-22T23:25:05Z

← Older revision		Revision as of 23:25, 22 November 2008
Line 3:		Line 3:
	==Overview==		==Overview==

	The		The Kit supports four different files that share

			The ".1st" files are loaded immediately after 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.		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.