Structure Element (Data): Difference between revisions
From HLKitWiki
Jump to navigationJump to search
No edit summary |
|||
| (10 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{context|Kit Reference|Definition File Reference}} | {{context|Kit Reference|Definition File Reference}} | ||
==The "structure" Element== | |||
Every game system will have an assortment of structural details that must be specified, and these are all grouped together within a "structure" element. The complete list of attributes for a structure element is below. | Every game system will have an assortment of structural details that must be specified, and these are all grouped together within a "structure" element. The complete list of attributes for a structure element is below. | ||
| Line 5: | Line 7: | ||
:{| class="infotable" | :{| class="infotable" | ||
|class="leftnormal"|folder | |class="leftnormal"|folder | ||
|Text – | |Text – Unique name to be used for the folder in which all data files for this game system are placed. The name may consist only of alphanumeric characters (i.e. letters and digits), with no spaces or punctuation other than "_" allowed. Maximum length is 25 characters. | ||
{{warning}} | {{warning}}The [[Creating the New Game System|folder name has critical implications]] and must be chosen carefully. | ||
|- | |- | ||
|editwidth | |editwidth | ||
| Line 31: | Line 33: | ||
|} | |} | ||
The "structure" element also possesses child elements that describe additional facets of the game system. The list of child elements | The "structure" element also possesses child elements that describe additional facets of the game system. 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. | ||
:{| class="infotable" | :{| class="infotable" | ||
|class="leftnormal"|[[#datetime|datetime]] | |class="leftnormal"|[[#datetime|datetime]] | ||
|Zero or more "datetime" elements may appear as defined by the given link. This element | |Zero or more "datetime" elements may appear as defined by the given link. This element defines rules for date and time composition. | ||
|- | |- | ||
|} | |} | ||
{{anchor|datetime}} | ==The "datetime" Element{{anchor|datetime}}== | ||
The "datetime" element | The "datetime" element dictates the structure of dates and times for the game system. The sequence in which the "datetime" elements are defined dictates the composition used within HL. By default, the date and time structures for gamespace are assumed to be those used in realspace. The complete list of attributes for a "datetime" element is below. | ||
:{| class="infotable" | :{| class="infotable" | ||
| Line 56: | Line 57: | ||
|} | |} | ||
The following example demonstrates the | ==Example== | ||
The following example demonstrates what a "structure" element might look like. All default values are assumed for optional attributes. Within this example, the composition of a game date is defined as if it were a date in realspace. | |||
<pre> | <pre> | ||
<datetime name="month" digits="2 | <structure | ||
<datetime name="day" digits="2 | folder="skeleton" | ||
<datetime name="year" digits="4" | editwidth="520" | ||
combatturnterm="round"> | |||
<datetime name="month" digits="2"/> | |||
<datetime name="day" digits="2"/> | |||
<datetime name="year" digits="4"/> | |||
</structure> | |||
</pre> | </pre> | ||
Latest revision as of 01:51, 24 February 2010
Context: HL Kit … Kit Reference … Definition File Reference
The "structure" Element
Every game system will have an assortment of structural details that must be specified, and these are all grouped together within a "structure" element. The complete list of attributes for a structure element is below.
folder Text – Unique name to be used for the folder in which all data files for this game system are placed. The name may consist only of alphanumeric characters (i.e. letters and digits), with no spaces or punctuation other than "_" allowed. Maximum length is 25 characters. WARNING! The folder name has critical implications and must be chosen carefully.
editwidth (Optional) Integer – Specifies the fixed width to use for all edit (i.e. tab-based) panels within HL. The value is given in units of pixels. Default: "500". summarymin (Optional) Integer – Specifies the minimum width that will be allowed for all summary panels within HL. The value is given in units of pixels. Default: "135". summarymax (Optional) Integer – Specifies the maximum width that will be allowed for all summary panels within HL. The value is given in units of pixels. Default: "165". heroterm (Optional) Text – Name to be used when referring to a hero for this game system. Maximum length is 25 characters. Default: "hero". thingterm (Optional) Text – Name to be used when referring to a thing for this game system. Maximum length is 25 characters. Default: "thing". entityterm (Optional) Text – Name to be used when referring to an entity for this game system. Maximum length is 25 characters. Default: "entity". combatturnterm (Optional) Text – Name to be used when referring to a combat turn for this game system. Maximum length is 25 characters. Default: "turn".
The "structure" element also possesses child elements that describe additional facets of the game system. 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.
datetime Zero or more "datetime" elements may appear as defined by the given link. This element defines rules for date and time composition.
The "datetime" Element
The "datetime" element dictates the structure of dates and times for the game system. The sequence in which the "datetime" elements are defined dictates the composition used within HL. By default, the date and time structures for gamespace are assumed to be those used in realspace. The complete list of attributes for a "datetime" element is below.
name Text – Name to be used for the component of the date or time. Maximum length is 20 characters. digits Integer – Specifies the number of digits used to specify the date/time component. istime Boolean – Indicates whether this is a component of the game system's time or date.
Example
The following example demonstrates what a "structure" element might look like. All default values are assumed for optional attributes. Within this example, the composition of a game date is defined as if it were a date in realspace.
<structure folder="skeleton" editwidth="520" combatturnterm="round"> <datetime name="month" digits="2"/> <datetime name="day" digits="2"/> <datetime name="year" digits="4"/> </structure>
