HLKitWiki - User contributions [en]

Behavior Element (Data)

2014-04-15T15:22:12Z

Michele: /* The "encounterinfo" Element{{anchor|encounterinfo}} */

{{context|Kit Reference|Definition File Reference}}

==The "behavior" Element==

Each game system has a variety of behaviors that will need to be defined. These behaviors are collectively specified within a "behavior" element. The complete list of attributes for a "behavior" element is below.

:{| class="infotable"
|class="leftnormal"|defaultname
|(Optional) Text – Default name to be used for all actor that have not been explicitly named by the user. Maximum length is 50 characters. Default: "Unnamed".
|-
|secondaryphase
|(Optional) Id – Specifies the unique id of the phase to be used as the default for all [[Secondary Tag Expression|Secondary tag expressions]] assigned by tables and choosers. If no explicit phase is assigned for a Secondary tag expression, this one is used. Default: "Setup".
|-
|secondarypriority
|(Optional) Integer – Specifies the priority to be used as the default for all [[Secondary Tag Expression|Secondary tag expressions]] assigned by tables and choosers. If no explicit priority is assigned for a Secondary tag expression, this one is used. Default: "5000".
|-
|existencephase
|(Optional) Id – Specifies the unique id of the phase to be used as the default for all [[Existence Tag Expression|Existence tag expressions]] assigned by tables and choosers. If no explicit phase is assigned for an Existence tag expression, this one is used. Default: "Setup".
|-
|existencepriority
|(Optional) Integer – Specifies the priority to be used as the default for all [[Existence Tag Expression|Existence tag expressions]] assigned by tables and choosers. If no explicit priority is assigned for an Existence tag expression, this one is used. Default: "5000".
|-
|gearphase
|(Optional) Id – Specifies the unique id of the phase during which all [[Gear Weight Determination|built-in gear processing]] is performed. This includes the calculation of gear weights throughout all gear holders. Default: "Effects".
|-
|gearpriority
|(Optional) Integer – Specifies the priority at which all [[Gear Weight Determination|built-in gear processing]] is performed. Default: "5000".
|-
|mouseinfo
|(Optional) Id – Specifies the unique id of the procedure to automatically invoke as the [[MouseInfo Script|MouseInfo script]] within portals. Default: "MouseInfo".
|-
|description
|(Optional) Id – Specifies the unique id of the procedure to automatically invoke as the [[Description Script|Description script]] within portals. Default: "Descript".
|-
|initascend
|(Optional) Boolean – Indicates whether initiative order ascends or descends. When it ascends, lower numbers take their actions first, and vice versa. Default: "no".
|-
|initperturn
|(Optional) Boolean – Indicates whether to re-generate new initiative values at the start of every turn instead of at the start of every combat. Default: "no".
|-
|initsimultaneous
|(Optional) Boolean – Indicates whether it is valid for two actors to have identical initiatives and act simultaneously. If not, HL will automatically generate a tie-breaker value. Default: "no".
|-
|initminimum
|(Optional) Boolean – Specifies the minimum value allowed for the initiative value when the user is adjusting the value on the Tactical Console. Default: "-99".
|-
|initmaximum
|(Optional) Boolean – Specifies the maximum value allowed for the initiative value when the user is adjusting the value on the Tactical Console. Default: "99".
|-
|interleave
|(Optional) Boolean – Indicates whether the evaluation cycles of all actors within the context of the same lead are interleaved, which governs the [[Minion and Master Relationships|behavior of minions and masters]]. If enabled, masters can influence changes upon their minions and minions can also influence changes upon their masters. If not enabled, masters all fully evaluated before minions, so the influence can only occur in the downward direction. Default: "no".
|-
|}

The "behavior" 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 links to access the details for each element.

:{| class="infotable"
|class="leftnormal"|[[#diceroller|diceroller]]
|A single "diceroller" element must appear as defined by the given link. This element customizes the integrated Dice Roller.
|-
|[[#leadsummary|leadsummary]]
|An optional "leadsummary" element may appear as defined by the given link. This element defines the [[LeadSummary Script]]. If omitted, default handling is employed.
|-
|[[#newcombat|newcombat]]
|An optional "newcombat" element may appear as defined by the given link. This element defines the [[NewCombat Script]]. If omitted, default handling is employed.
|-
|[[#newturn|newturn]]
|An optional "newturn" element may appear as defined by the given link. This element defines the [[NewTurn Script]]. If omitted, default handling is employed.
|-
|[[#integrate|integrate]]
|An optional "integrate" element may appear as defined by the given link. This element defines the [[Integrate Script]]. If omitted, default handling is employed.
|-
|[[#initiative|initiative]]
|An optional "initiative" element may appear as defined by the given link. This element defines the [[Initiative Script]]. If omitted, default handling is employed.
|-
|[[#initfinalize|initfinalize]]
|An optional "initfinalize" element may appear as defined by the given link. This element defines the [[InitFinalize Script]]. If omitted, default handling is employed.
|-
|[[#loaderror|loaderror]]
|An optional "loaderror" element may appear as defined by the given link. This element defines the [[LoadError Script]]. If omitted, default handling is employed.
|-
|[[#encounter|encounter]]
|An optional "encounter" element may appear as defined by the given link. This element defines fields used by the encounter builder. If omitted, default values are used.
|-
|}

==The "diceroller" Element{{anchor|diceroller}}==

The "diceroller" element defines characteristics of the [[Configuring the Dice Roller|integrated Dice Roller]] mechanisms when used with the game system. The complete list of attributes for a "diceroller" element is below.

:{| class="infotable"
|class="leftnormal"|mode
|(Optional) Set – Specifies the initial dice rolling mode to start out in for the game system. Must be one of the following:
<ul class="sets">
<li>totals – The dice rolled are added and that total is displayed.</li>
<li>successes – Each die rolled is compared against the threshold for declaring a success and the number of successes is displayed.</li>
<li>Default: "totals".</li>
</ul>
|-
|dietype
|Integer – Specifies the default die type to be rolled.
|-
|quantity
|(Optional) Integer – Specifies the default number of dice to be rolled. Default: "1".
|-
|success
|(Optional) Integer – Specifies the threshold value at which a success result is achieved. Game systems like World of Darkness and Shadowrun utilizes successes instead of adding the dice results. Default: "1".
|-
|explode
|(Optional) Integer – Specifies the threshold value at which a success result "explodes" by allowing a re-roll. If a value of zero is given, no explosion occurs. Default: "0".
|-
|maxexplode
|(Optional) Integer – Specifies the maximum number of times that a single roll may explode. A value of zero indicates that explosion is unlimited. Default: "0".
|-
|}

==The "leadsummary" Element{{anchor|leadsummary}}==

The "leadsummary" element defines the [[LeadSummary Script|LeadSummary script]] that is used to synthesize summary information for each actor. This summary is displayed when the user previews the available actors for import into the current portfolio.
The complete list of attributes for a "scriptmacro" element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the LeadSummary script.
|-
|}

==The "newcombat" Element{{anchor|newcombat}}==

The "newcombat" element defines the [[NewCombat Script|NewCombat script]] that is invoked whenever the user begins a new combat within the Tactical Console. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the NewCombat script.
|-
|}

==The "newturn" Element{{anchor|newturn}}==

The "newturn" element defines the [[NewTurn Script|NewTurn script]] that is invoked whenever the user starts a new turn of combat within the Tactical Console. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the NewTurn script.
|-
|}

==The "integrate" Element{{anchor|integrate}}==

The "integrate" element defines the [[Integrate Script|Integrate script]] that is invoked whenever the user integrates pending actors into an existing combat within the Tactical Console. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the Integrate script.
|-
|}

==The "initiative" Element{{anchor|initiative}}==

The "initiative" element defines the [[Initiative Script|Initiative script]] that is used to calculate the initiative score for each actor during combat. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the Initiative script.
|-
|}

==The "initfinalize" Element{{anchor|initfinalize}}==

The "initfinalize" element defines the [[InitFinalize Script|InitFinalize script]] that is used to tailor the final displayed text for the initiative score of each actor during combat. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the InitFinalize script.
|-
|}

==The "loaderror" Element{{anchor|loaderror}}==

The "loaderror" element defines the [[LoadError Script|LoadError script]] that is used to provide helpful information to the user about changes across releases of your data files and errors that can be safely ignored. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the LoadError script.
|-
|}

==The "encounter" Element{{anchor|encounter}}==

The "encounter" element defines game specific information for use within the encounter builder. The encounter element contains one or more encounterinfo elements. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|ratingterm
|(Optional) Text – Defines the term used for the rating or difficulty of a monster. This is used in the encounter builder form in the rating filter label. If there is no rating term defined then the rating filter controls are hidden. If there is a rating term defined then there must also be an encounterinfo element with type="ratingval" to define the location of the rating value in the portfolio.
|-
|}

The encounter element contains one or more encounterinfo elements. The list of these child elements is below. Click on the links to access the details for each element.

:{| class="infotable"
|class="leftnormal"|[[#encounterinfo|encounterinfo]]
|One or more "encounterinfo" elements must appear as defined by the given link. This element gives a location in a stock portfolio to find a specific piece of data
|-
|}

==The "encounterinfo" Element{{anchor|encounterinfo}}==
The encounterinfo element is a child of the encounter element and contains locations to data in stock portfolios. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|type
|(Required) Text – indicates what the data is and should be one of the following:
<ul class="sets">
<li>pointsval – The number of "points" for a character. e.g. 2000</li>
<li>pointstext – The textual representation of the points value. e.g. "2,000 XP"</li>
<li>ratingval – The difficulty for a character. e.g. 4</li>
<li>ratingtext – The textual representation of the rating value. e.g. "CR 4"</li>
<li>sourcebooks – The books where a character originates.</li>
</ul>

|-
|xpath
|(Required) Text – The xpath should give a location of the element that contains a specific piece of data in the custom output XML for a stock portfolio. This should only be used in game systems with custom output XML.
|-
|attribute
|(Required) Text – Specifies the attribute of the node given in xpath that contains the data.
|-
|}

==Example==

The following example demonstrates what a "behavior" element might look like. All default values are assumed for omitted optional attributes.

<pre>
<behavior
defaultname="Nobody"
interleave="yes">
<diceroller mode="totals" dietype="6" quantity="1"/>

<leadsummary><![CDATA[
~start with the race
var txt as string
txt = hero.firstchild["Race.?"].field[name].text
if (empty(txt) <> 0) then
txt = "No Race"
endif
@text &= txt

~append the CP rating of the character
@text &= " - CP: " & hero.child[resCP].field[resMax].value
]]></leadsummary>

<initiative><![CDATA[
~calculate the secondary initiative rating
@secondary = 0
~calculate the primary initiative rating
@initiative = random(10) + 1
]]></initiative>

<encounter ratingterm="CR">
<encounterinfo type="pointsval"
xpath="/document/public/character/xpaward"
attribute="value"/>
<encounterinfo type="pointstext"
xpath="/document/public/character/xpaward"
attribute="text"/>
<encounterinfo type="ratingval"
xpath="/document/public/character/challengerating"
attribute="value"/>
<encounterinfo type="ratingtext"
xpath="/document/public/character/challengerating"
attribute="text"/>
<encounterinfo type="sourcebooks"
xpath="/document/public/character/bookinfo"
attribute="name"/>
</encounter>

</behavior>
</pre>

Behavior Element (Data)

2014-04-15T15:21:03Z

Michele: /* The "encounter" Element{{anchor|encounter}} */

{{context|Kit Reference|Definition File Reference}}

==The "behavior" Element==

Each game system has a variety of behaviors that will need to be defined. These behaviors are collectively specified within a "behavior" element. The complete list of attributes for a "behavior" element is below.

:{| class="infotable"
|class="leftnormal"|defaultname
|(Optional) Text – Default name to be used for all actor that have not been explicitly named by the user. Maximum length is 50 characters. Default: "Unnamed".
|-
|secondaryphase
|(Optional) Id – Specifies the unique id of the phase to be used as the default for all [[Secondary Tag Expression|Secondary tag expressions]] assigned by tables and choosers. If no explicit phase is assigned for a Secondary tag expression, this one is used. Default: "Setup".
|-
|secondarypriority
|(Optional) Integer – Specifies the priority to be used as the default for all [[Secondary Tag Expression|Secondary tag expressions]] assigned by tables and choosers. If no explicit priority is assigned for a Secondary tag expression, this one is used. Default: "5000".
|-
|existencephase
|(Optional) Id – Specifies the unique id of the phase to be used as the default for all [[Existence Tag Expression|Existence tag expressions]] assigned by tables and choosers. If no explicit phase is assigned for an Existence tag expression, this one is used. Default: "Setup".
|-
|existencepriority
|(Optional) Integer – Specifies the priority to be used as the default for all [[Existence Tag Expression|Existence tag expressions]] assigned by tables and choosers. If no explicit priority is assigned for an Existence tag expression, this one is used. Default: "5000".
|-
|gearphase
|(Optional) Id – Specifies the unique id of the phase during which all [[Gear Weight Determination|built-in gear processing]] is performed. This includes the calculation of gear weights throughout all gear holders. Default: "Effects".
|-
|gearpriority
|(Optional) Integer – Specifies the priority at which all [[Gear Weight Determination|built-in gear processing]] is performed. Default: "5000".
|-
|mouseinfo
|(Optional) Id – Specifies the unique id of the procedure to automatically invoke as the [[MouseInfo Script|MouseInfo script]] within portals. Default: "MouseInfo".
|-
|description
|(Optional) Id – Specifies the unique id of the procedure to automatically invoke as the [[Description Script|Description script]] within portals. Default: "Descript".
|-
|initascend
|(Optional) Boolean – Indicates whether initiative order ascends or descends. When it ascends, lower numbers take their actions first, and vice versa. Default: "no".
|-
|initperturn
|(Optional) Boolean – Indicates whether to re-generate new initiative values at the start of every turn instead of at the start of every combat. Default: "no".
|-
|initsimultaneous
|(Optional) Boolean – Indicates whether it is valid for two actors to have identical initiatives and act simultaneously. If not, HL will automatically generate a tie-breaker value. Default: "no".
|-
|initminimum
|(Optional) Boolean – Specifies the minimum value allowed for the initiative value when the user is adjusting the value on the Tactical Console. Default: "-99".
|-
|initmaximum
|(Optional) Boolean – Specifies the maximum value allowed for the initiative value when the user is adjusting the value on the Tactical Console. Default: "99".
|-
|interleave
|(Optional) Boolean – Indicates whether the evaluation cycles of all actors within the context of the same lead are interleaved, which governs the [[Minion and Master Relationships|behavior of minions and masters]]. If enabled, masters can influence changes upon their minions and minions can also influence changes upon their masters. If not enabled, masters all fully evaluated before minions, so the influence can only occur in the downward direction. Default: "no".
|-
|}

The "behavior" 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 links to access the details for each element.

:{| class="infotable"
|class="leftnormal"|[[#diceroller|diceroller]]
|A single "diceroller" element must appear as defined by the given link. This element customizes the integrated Dice Roller.
|-
|[[#leadsummary|leadsummary]]
|An optional "leadsummary" element may appear as defined by the given link. This element defines the [[LeadSummary Script]]. If omitted, default handling is employed.
|-
|[[#newcombat|newcombat]]
|An optional "newcombat" element may appear as defined by the given link. This element defines the [[NewCombat Script]]. If omitted, default handling is employed.
|-
|[[#newturn|newturn]]
|An optional "newturn" element may appear as defined by the given link. This element defines the [[NewTurn Script]]. If omitted, default handling is employed.
|-
|[[#integrate|integrate]]
|An optional "integrate" element may appear as defined by the given link. This element defines the [[Integrate Script]]. If omitted, default handling is employed.
|-
|[[#initiative|initiative]]
|An optional "initiative" element may appear as defined by the given link. This element defines the [[Initiative Script]]. If omitted, default handling is employed.
|-
|[[#initfinalize|initfinalize]]
|An optional "initfinalize" element may appear as defined by the given link. This element defines the [[InitFinalize Script]]. If omitted, default handling is employed.
|-
|[[#loaderror|loaderror]]
|An optional "loaderror" element may appear as defined by the given link. This element defines the [[LoadError Script]]. If omitted, default handling is employed.
|-
|[[#encounter|encounter]]
|An optional "encounter" element may appear as defined by the given link. This element defines fields used by the encounter builder. If omitted, default values are used.
|-
|}

==The "diceroller" Element{{anchor|diceroller}}==

The "diceroller" element defines characteristics of the [[Configuring the Dice Roller|integrated Dice Roller]] mechanisms when used with the game system. The complete list of attributes for a "diceroller" element is below.

:{| class="infotable"
|class="leftnormal"|mode
|(Optional) Set – Specifies the initial dice rolling mode to start out in for the game system. Must be one of the following:
<ul class="sets">
<li>totals – The dice rolled are added and that total is displayed.</li>
<li>successes – Each die rolled is compared against the threshold for declaring a success and the number of successes is displayed.</li>
<li>Default: "totals".</li>
</ul>
|-
|dietype
|Integer – Specifies the default die type to be rolled.
|-
|quantity
|(Optional) Integer – Specifies the default number of dice to be rolled. Default: "1".
|-
|success
|(Optional) Integer – Specifies the threshold value at which a success result is achieved. Game systems like World of Darkness and Shadowrun utilizes successes instead of adding the dice results. Default: "1".
|-
|explode
|(Optional) Integer – Specifies the threshold value at which a success result "explodes" by allowing a re-roll. If a value of zero is given, no explosion occurs. Default: "0".
|-
|maxexplode
|(Optional) Integer – Specifies the maximum number of times that a single roll may explode. A value of zero indicates that explosion is unlimited. Default: "0".
|-
|}

==The "leadsummary" Element{{anchor|leadsummary}}==

The "leadsummary" element defines the [[LeadSummary Script|LeadSummary script]] that is used to synthesize summary information for each actor. This summary is displayed when the user previews the available actors for import into the current portfolio.
The complete list of attributes for a "scriptmacro" element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the LeadSummary script.
|-
|}

==The "newcombat" Element{{anchor|newcombat}}==

The "newcombat" element defines the [[NewCombat Script|NewCombat script]] that is invoked whenever the user begins a new combat within the Tactical Console. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the NewCombat script.
|-
|}

==The "newturn" Element{{anchor|newturn}}==

The "newturn" element defines the [[NewTurn Script|NewTurn script]] that is invoked whenever the user starts a new turn of combat within the Tactical Console. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the NewTurn script.
|-
|}

==The "integrate" Element{{anchor|integrate}}==

The "integrate" element defines the [[Integrate Script|Integrate script]] that is invoked whenever the user integrates pending actors into an existing combat within the Tactical Console. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the Integrate script.
|-
|}

==The "initiative" Element{{anchor|initiative}}==

The "initiative" element defines the [[Initiative Script|Initiative script]] that is used to calculate the initiative score for each actor during combat. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the Initiative script.
|-
|}

==The "initfinalize" Element{{anchor|initfinalize}}==

The "initfinalize" element defines the [[InitFinalize Script|InitFinalize script]] that is used to tailor the final displayed text for the initiative score of each actor during combat. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the InitFinalize script.
|-
|}

==The "loaderror" Element{{anchor|loaderror}}==

The "loaderror" element defines the [[LoadError Script|LoadError script]] that is used to provide helpful information to the user about changes across releases of your data files and errors that can be safely ignored. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the LoadError script.
|-
|}

==The "encounter" Element{{anchor|encounter}}==

The "encounter" element defines game specific information for use within the encounter builder. The encounter element contains one or more encounterinfo elements. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|ratingterm
|(Optional) Text – Defines the term used for the rating or difficulty of a monster. This is used in the encounter builder form in the rating filter label. If there is no rating term defined then the rating filter controls are hidden. If there is a rating term defined then there must also be an encounterinfo element with type="ratingval" to define the location of the rating value in the portfolio.
|-
|}

The encounter element contains one or more encounterinfo elements. The list of these child elements is below. Click on the links to access the details for each element.

:{| class="infotable"
|class="leftnormal"|[[#encounterinfo|encounterinfo]]
|One or more "encounterinfo" elements must appear as defined by the given link. This element gives a location in a stock portfolio to find a specific piece of data
|-
|}

==The "encounterinfo" Element{{anchor|encounterinfo}}==
The encounterinfo element is a child of the encounter element and contains locations to data in stock portfolios. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|type
|(Required) Text - indicates what the data is and should be one of the following:
<ul class="sets">
<li>pointsval - The number of "points" for a character. e.g. 2000</li>
<li>pointstext - The textual representation of the points value. e.g. "2,000 XP"</li>
<li>ratingval - The difficulty for a character. e.g. 4</li>
<li>ratingtext - The textual representation of the rating value. e.g. "CR 4"</li>
<li>sourcebooks - The books where a character originates.</li>
</ul>

|-
|xpath
|(Required) Text – The xpath should give a location of the element that contains a specific piece of data in the custom output XML for a stock portfolio. This should only be used in game systems with custom output XML.
|-
|attribute
|(Required) Text – specify the attribute of the node given in xpath that contains the data.
|-
|}

==Example==

The following example demonstrates what a "behavior" element might look like. All default values are assumed for omitted optional attributes.

<pre>
<behavior
defaultname="Nobody"
interleave="yes">
<diceroller mode="totals" dietype="6" quantity="1"/>

<leadsummary><![CDATA[
~start with the race
var txt as string
txt = hero.firstchild["Race.?"].field[name].text
if (empty(txt) <> 0) then
txt = "No Race"
endif
@text &= txt

~append the CP rating of the character
@text &= " - CP: " & hero.child[resCP].field[resMax].value
]]></leadsummary>

<initiative><![CDATA[
~calculate the secondary initiative rating
@secondary = 0
~calculate the primary initiative rating
@initiative = random(10) + 1
]]></initiative>

<encounter ratingterm="CR">
<encounterinfo type="pointsval"
xpath="/document/public/character/xpaward"
attribute="value"/>
<encounterinfo type="pointstext"
xpath="/document/public/character/xpaward"
attribute="text"/>
<encounterinfo type="ratingval"
xpath="/document/public/character/challengerating"
attribute="value"/>
<encounterinfo type="ratingtext"
xpath="/document/public/character/challengerating"
attribute="text"/>
<encounterinfo type="sourcebooks"
xpath="/document/public/character/bookinfo"
attribute="name"/>
</encounter>

</behavior>
</pre>

Behavior Element (Data)

2014-04-15T15:18:37Z

Michele: /* The "encounterinfo" Element{{anchor|encounterinfo}} */

{{context|Kit Reference|Definition File Reference}}

==The "behavior" Element==

Each game system has a variety of behaviors that will need to be defined. These behaviors are collectively specified within a "behavior" element. The complete list of attributes for a "behavior" element is below.

:{| class="infotable"
|class="leftnormal"|defaultname
|(Optional) Text – Default name to be used for all actor that have not been explicitly named by the user. Maximum length is 50 characters. Default: "Unnamed".
|-
|secondaryphase
|(Optional) Id – Specifies the unique id of the phase to be used as the default for all [[Secondary Tag Expression|Secondary tag expressions]] assigned by tables and choosers. If no explicit phase is assigned for a Secondary tag expression, this one is used. Default: "Setup".
|-
|secondarypriority
|(Optional) Integer – Specifies the priority to be used as the default for all [[Secondary Tag Expression|Secondary tag expressions]] assigned by tables and choosers. If no explicit priority is assigned for a Secondary tag expression, this one is used. Default: "5000".
|-
|existencephase
|(Optional) Id – Specifies the unique id of the phase to be used as the default for all [[Existence Tag Expression|Existence tag expressions]] assigned by tables and choosers. If no explicit phase is assigned for an Existence tag expression, this one is used. Default: "Setup".
|-
|existencepriority
|(Optional) Integer – Specifies the priority to be used as the default for all [[Existence Tag Expression|Existence tag expressions]] assigned by tables and choosers. If no explicit priority is assigned for an Existence tag expression, this one is used. Default: "5000".
|-
|gearphase
|(Optional) Id – Specifies the unique id of the phase during which all [[Gear Weight Determination|built-in gear processing]] is performed. This includes the calculation of gear weights throughout all gear holders. Default: "Effects".
|-
|gearpriority
|(Optional) Integer – Specifies the priority at which all [[Gear Weight Determination|built-in gear processing]] is performed. Default: "5000".
|-
|mouseinfo
|(Optional) Id – Specifies the unique id of the procedure to automatically invoke as the [[MouseInfo Script|MouseInfo script]] within portals. Default: "MouseInfo".
|-
|description
|(Optional) Id – Specifies the unique id of the procedure to automatically invoke as the [[Description Script|Description script]] within portals. Default: "Descript".
|-
|initascend
|(Optional) Boolean – Indicates whether initiative order ascends or descends. When it ascends, lower numbers take their actions first, and vice versa. Default: "no".
|-
|initperturn
|(Optional) Boolean – Indicates whether to re-generate new initiative values at the start of every turn instead of at the start of every combat. Default: "no".
|-
|initsimultaneous
|(Optional) Boolean – Indicates whether it is valid for two actors to have identical initiatives and act simultaneously. If not, HL will automatically generate a tie-breaker value. Default: "no".
|-
|initminimum
|(Optional) Boolean – Specifies the minimum value allowed for the initiative value when the user is adjusting the value on the Tactical Console. Default: "-99".
|-
|initmaximum
|(Optional) Boolean – Specifies the maximum value allowed for the initiative value when the user is adjusting the value on the Tactical Console. Default: "99".
|-
|interleave
|(Optional) Boolean – Indicates whether the evaluation cycles of all actors within the context of the same lead are interleaved, which governs the [[Minion and Master Relationships|behavior of minions and masters]]. If enabled, masters can influence changes upon their minions and minions can also influence changes upon their masters. If not enabled, masters all fully evaluated before minions, so the influence can only occur in the downward direction. Default: "no".
|-
|}

The "behavior" 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 links to access the details for each element.

:{| class="infotable"
|class="leftnormal"|[[#diceroller|diceroller]]
|A single "diceroller" element must appear as defined by the given link. This element customizes the integrated Dice Roller.
|-
|[[#leadsummary|leadsummary]]
|An optional "leadsummary" element may appear as defined by the given link. This element defines the [[LeadSummary Script]]. If omitted, default handling is employed.
|-
|[[#newcombat|newcombat]]
|An optional "newcombat" element may appear as defined by the given link. This element defines the [[NewCombat Script]]. If omitted, default handling is employed.
|-
|[[#newturn|newturn]]
|An optional "newturn" element may appear as defined by the given link. This element defines the [[NewTurn Script]]. If omitted, default handling is employed.
|-
|[[#integrate|integrate]]
|An optional "integrate" element may appear as defined by the given link. This element defines the [[Integrate Script]]. If omitted, default handling is employed.
|-
|[[#initiative|initiative]]
|An optional "initiative" element may appear as defined by the given link. This element defines the [[Initiative Script]]. If omitted, default handling is employed.
|-
|[[#initfinalize|initfinalize]]
|An optional "initfinalize" element may appear as defined by the given link. This element defines the [[InitFinalize Script]]. If omitted, default handling is employed.
|-
|[[#loaderror|loaderror]]
|An optional "loaderror" element may appear as defined by the given link. This element defines the [[LoadError Script]]. If omitted, default handling is employed.
|-
|[[#encounter|encounter]]
|An optional "encounter" element may appear as defined by the given link. This element defines fields used by the encounter builder. If omitted, default values are used.
|-
|}

==The "diceroller" Element{{anchor|diceroller}}==

The "diceroller" element defines characteristics of the [[Configuring the Dice Roller|integrated Dice Roller]] mechanisms when used with the game system. The complete list of attributes for a "diceroller" element is below.

:{| class="infotable"
|class="leftnormal"|mode
|(Optional) Set – Specifies the initial dice rolling mode to start out in for the game system. Must be one of the following:
<ul class="sets">
<li>totals – The dice rolled are added and that total is displayed.</li>
<li>successes – Each die rolled is compared against the threshold for declaring a success and the number of successes is displayed.</li>
<li>Default: "totals".</li>
</ul>
|-
|dietype
|Integer – Specifies the default die type to be rolled.
|-
|quantity
|(Optional) Integer – Specifies the default number of dice to be rolled. Default: "1".
|-
|success
|(Optional) Integer – Specifies the threshold value at which a success result is achieved. Game systems like World of Darkness and Shadowrun utilizes successes instead of adding the dice results. Default: "1".
|-
|explode
|(Optional) Integer – Specifies the threshold value at which a success result "explodes" by allowing a re-roll. If a value of zero is given, no explosion occurs. Default: "0".
|-
|maxexplode
|(Optional) Integer – Specifies the maximum number of times that a single roll may explode. A value of zero indicates that explosion is unlimited. Default: "0".
|-
|}

==The "leadsummary" Element{{anchor|leadsummary}}==

The "leadsummary" element defines the [[LeadSummary Script|LeadSummary script]] that is used to synthesize summary information for each actor. This summary is displayed when the user previews the available actors for import into the current portfolio.
The complete list of attributes for a "scriptmacro" element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the LeadSummary script.
|-
|}

==The "newcombat" Element{{anchor|newcombat}}==

The "newcombat" element defines the [[NewCombat Script|NewCombat script]] that is invoked whenever the user begins a new combat within the Tactical Console. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the NewCombat script.
|-
|}

==The "newturn" Element{{anchor|newturn}}==

The "newturn" element defines the [[NewTurn Script|NewTurn script]] that is invoked whenever the user starts a new turn of combat within the Tactical Console. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the NewTurn script.
|-
|}

==The "integrate" Element{{anchor|integrate}}==

The "integrate" element defines the [[Integrate Script|Integrate script]] that is invoked whenever the user integrates pending actors into an existing combat within the Tactical Console. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the Integrate script.
|-
|}

==The "initiative" Element{{anchor|initiative}}==

The "initiative" element defines the [[Initiative Script|Initiative script]] that is used to calculate the initiative score for each actor during combat. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the Initiative script.
|-
|}

==The "initfinalize" Element{{anchor|initfinalize}}==

The "initfinalize" element defines the [[InitFinalize Script|InitFinalize script]] that is used to tailor the final displayed text for the initiative score of each actor during combat. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the InitFinalize script.
|-
|}

==The "loaderror" Element{{anchor|loaderror}}==

The "loaderror" element defines the [[LoadError Script|LoadError script]] that is used to provide helpful information to the user about changes across releases of your data files and errors that can be safely ignored. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the LoadError script.
|-
|}

==The "encounter" Element{{anchor|encounter}}==

The "encounter" element defines game specific information for use within the encounter builder. The encounter element contains one or more encounterinfo elements. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|ratingterm
|(Optional) Text - Defines the term used for the rating or difficulty of a monster. This is used in the encounter builder form in the rating filter label. If there is no rating term defined then the rating filter controls are hidden. If there is a rating term defined then there must also be an encounterinfo element with type="ratingval" to define the location of the rating value in the portfolio.
|-
|}

The encounter element contains one or more encounterinfo elements. The list of these child elements is below. Click on the links to access the details for each element.

:{| class="infotable"
|class="leftnormal"|[[#encounterinfo|encounterinfo]]
|One or more "encounterinfo" elements must appear as defined by the given link. This element gives a location in a stock portfolio to find a specific piece of data
|-
|}

==The "encounterinfo" Element{{anchor|encounterinfo}}==
The encounterinfo element is a child of the encounter element and contains locations to data in stock portfolios. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|type
|(Required) Text - indicates what the data is and should be one of the following:
<ul class="sets">
<li>pointsval - The number of "points" for a character. e.g. 2000</li>
<li>pointstext - The textual representation of the points value. e.g. "2,000 XP"</li>
<li>ratingval - The difficulty for a character. e.g. 4</li>
<li>ratingtext - The textual representation of the rating value. e.g. "CR 4"</li>
<li>sourcebooks - The books where a character originates.</li>
</ul>

|-
|xpath
|(Required) Text – The xpath should give a location of the element that contains a specific piece of data in the custom output XML for a stock portfolio. This should only be used in game systems with custom output XML.
|-
|attribute
|(Required) Text – specify the attribute of the node given in xpath that contains the data.
|-
|}

==Example==

The following example demonstrates what a "behavior" element might look like. All default values are assumed for omitted optional attributes.

<pre>
<behavior
defaultname="Nobody"
interleave="yes">
<diceroller mode="totals" dietype="6" quantity="1"/>

<leadsummary><![CDATA[
~start with the race
var txt as string
txt = hero.firstchild["Race.?"].field[name].text
if (empty(txt) <> 0) then
txt = "No Race"
endif
@text &= txt

~append the CP rating of the character
@text &= " - CP: " & hero.child[resCP].field[resMax].value
]]></leadsummary>

<initiative><![CDATA[
~calculate the secondary initiative rating
@secondary = 0
~calculate the primary initiative rating
@initiative = random(10) + 1
]]></initiative>

<encounter ratingterm="CR">
<encounterinfo type="pointsval"
xpath="/document/public/character/xpaward"
attribute="value"/>
<encounterinfo type="pointstext"
xpath="/document/public/character/xpaward"
attribute="text"/>
<encounterinfo type="ratingval"
xpath="/document/public/character/challengerating"
attribute="value"/>
<encounterinfo type="ratingtext"
xpath="/document/public/character/challengerating"
attribute="text"/>
<encounterinfo type="sourcebooks"
xpath="/document/public/character/bookinfo"
attribute="name"/>
</encounter>

</behavior>
</pre>

Behavior Element (Data)

2014-04-15T15:11:04Z

Michele: /* The "encounterinfo" Element{{anchor|encounterinfo}} */

{{context|Kit Reference|Definition File Reference}}

==The "behavior" Element==

Each game system has a variety of behaviors that will need to be defined. These behaviors are collectively specified within a "behavior" element. The complete list of attributes for a "behavior" element is below.

:{| class="infotable"
|class="leftnormal"|defaultname
|(Optional) Text – Default name to be used for all actor that have not been explicitly named by the user. Maximum length is 50 characters. Default: "Unnamed".
|-
|secondaryphase
|(Optional) Id – Specifies the unique id of the phase to be used as the default for all [[Secondary Tag Expression|Secondary tag expressions]] assigned by tables and choosers. If no explicit phase is assigned for a Secondary tag expression, this one is used. Default: "Setup".
|-
|secondarypriority
|(Optional) Integer – Specifies the priority to be used as the default for all [[Secondary Tag Expression|Secondary tag expressions]] assigned by tables and choosers. If no explicit priority is assigned for a Secondary tag expression, this one is used. Default: "5000".
|-
|existencephase
|(Optional) Id – Specifies the unique id of the phase to be used as the default for all [[Existence Tag Expression|Existence tag expressions]] assigned by tables and choosers. If no explicit phase is assigned for an Existence tag expression, this one is used. Default: "Setup".
|-
|existencepriority
|(Optional) Integer – Specifies the priority to be used as the default for all [[Existence Tag Expression|Existence tag expressions]] assigned by tables and choosers. If no explicit priority is assigned for an Existence tag expression, this one is used. Default: "5000".
|-
|gearphase
|(Optional) Id – Specifies the unique id of the phase during which all [[Gear Weight Determination|built-in gear processing]] is performed. This includes the calculation of gear weights throughout all gear holders. Default: "Effects".
|-
|gearpriority
|(Optional) Integer – Specifies the priority at which all [[Gear Weight Determination|built-in gear processing]] is performed. Default: "5000".
|-
|mouseinfo
|(Optional) Id – Specifies the unique id of the procedure to automatically invoke as the [[MouseInfo Script|MouseInfo script]] within portals. Default: "MouseInfo".
|-
|description
|(Optional) Id – Specifies the unique id of the procedure to automatically invoke as the [[Description Script|Description script]] within portals. Default: "Descript".
|-
|initascend
|(Optional) Boolean – Indicates whether initiative order ascends or descends. When it ascends, lower numbers take their actions first, and vice versa. Default: "no".
|-
|initperturn
|(Optional) Boolean – Indicates whether to re-generate new initiative values at the start of every turn instead of at the start of every combat. Default: "no".
|-
|initsimultaneous
|(Optional) Boolean – Indicates whether it is valid for two actors to have identical initiatives and act simultaneously. If not, HL will automatically generate a tie-breaker value. Default: "no".
|-
|initminimum
|(Optional) Boolean – Specifies the minimum value allowed for the initiative value when the user is adjusting the value on the Tactical Console. Default: "-99".
|-
|initmaximum
|(Optional) Boolean – Specifies the maximum value allowed for the initiative value when the user is adjusting the value on the Tactical Console. Default: "99".
|-
|interleave
|(Optional) Boolean – Indicates whether the evaluation cycles of all actors within the context of the same lead are interleaved, which governs the [[Minion and Master Relationships|behavior of minions and masters]]. If enabled, masters can influence changes upon their minions and minions can also influence changes upon their masters. If not enabled, masters all fully evaluated before minions, so the influence can only occur in the downward direction. Default: "no".
|-
|}

The "behavior" 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 links to access the details for each element.

:{| class="infotable"
|class="leftnormal"|[[#diceroller|diceroller]]
|A single "diceroller" element must appear as defined by the given link. This element customizes the integrated Dice Roller.
|-
|[[#leadsummary|leadsummary]]
|An optional "leadsummary" element may appear as defined by the given link. This element defines the [[LeadSummary Script]]. If omitted, default handling is employed.
|-
|[[#newcombat|newcombat]]
|An optional "newcombat" element may appear as defined by the given link. This element defines the [[NewCombat Script]]. If omitted, default handling is employed.
|-
|[[#newturn|newturn]]
|An optional "newturn" element may appear as defined by the given link. This element defines the [[NewTurn Script]]. If omitted, default handling is employed.
|-
|[[#integrate|integrate]]
|An optional "integrate" element may appear as defined by the given link. This element defines the [[Integrate Script]]. If omitted, default handling is employed.
|-
|[[#initiative|initiative]]
|An optional "initiative" element may appear as defined by the given link. This element defines the [[Initiative Script]]. If omitted, default handling is employed.
|-
|[[#initfinalize|initfinalize]]
|An optional "initfinalize" element may appear as defined by the given link. This element defines the [[InitFinalize Script]]. If omitted, default handling is employed.
|-
|[[#loaderror|loaderror]]
|An optional "loaderror" element may appear as defined by the given link. This element defines the [[LoadError Script]]. If omitted, default handling is employed.
|-
|[[#encounter|encounter]]
|An optional "encounter" element may appear as defined by the given link. This element defines fields used by the encounter builder. If omitted, default values are used.
|-
|}

==The "diceroller" Element{{anchor|diceroller}}==

The "diceroller" element defines characteristics of the [[Configuring the Dice Roller|integrated Dice Roller]] mechanisms when used with the game system. The complete list of attributes for a "diceroller" element is below.

:{| class="infotable"
|class="leftnormal"|mode
|(Optional) Set – Specifies the initial dice rolling mode to start out in for the game system. Must be one of the following:
<ul class="sets">
<li>totals – The dice rolled are added and that total is displayed.</li>
<li>successes – Each die rolled is compared against the threshold for declaring a success and the number of successes is displayed.</li>
<li>Default: "totals".</li>
</ul>
|-
|dietype
|Integer – Specifies the default die type to be rolled.
|-
|quantity
|(Optional) Integer – Specifies the default number of dice to be rolled. Default: "1".
|-
|success
|(Optional) Integer – Specifies the threshold value at which a success result is achieved. Game systems like World of Darkness and Shadowrun utilizes successes instead of adding the dice results. Default: "1".
|-
|explode
|(Optional) Integer – Specifies the threshold value at which a success result "explodes" by allowing a re-roll. If a value of zero is given, no explosion occurs. Default: "0".
|-
|maxexplode
|(Optional) Integer – Specifies the maximum number of times that a single roll may explode. A value of zero indicates that explosion is unlimited. Default: "0".
|-
|}

==The "leadsummary" Element{{anchor|leadsummary}}==

The "leadsummary" element defines the [[LeadSummary Script|LeadSummary script]] that is used to synthesize summary information for each actor. This summary is displayed when the user previews the available actors for import into the current portfolio.
The complete list of attributes for a "scriptmacro" element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the LeadSummary script.
|-
|}

==The "newcombat" Element{{anchor|newcombat}}==

The "newcombat" element defines the [[NewCombat Script|NewCombat script]] that is invoked whenever the user begins a new combat within the Tactical Console. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the NewCombat script.
|-
|}

==The "newturn" Element{{anchor|newturn}}==

The "newturn" element defines the [[NewTurn Script|NewTurn script]] that is invoked whenever the user starts a new turn of combat within the Tactical Console. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the NewTurn script.
|-
|}

==The "integrate" Element{{anchor|integrate}}==

The "integrate" element defines the [[Integrate Script|Integrate script]] that is invoked whenever the user integrates pending actors into an existing combat within the Tactical Console. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the Integrate script.
|-
|}

==The "initiative" Element{{anchor|initiative}}==

The "initiative" element defines the [[Initiative Script|Initiative script]] that is used to calculate the initiative score for each actor during combat. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the Initiative script.
|-
|}

==The "initfinalize" Element{{anchor|initfinalize}}==

The "initfinalize" element defines the [[InitFinalize Script|InitFinalize script]] that is used to tailor the final displayed text for the initiative score of each actor during combat. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the InitFinalize script.
|-
|}

==The "loaderror" Element{{anchor|loaderror}}==

The "loaderror" element defines the [[LoadError Script|LoadError script]] that is used to provide helpful information to the user about changes across releases of your data files and errors that can be safely ignored. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the LoadError script.
|-
|}

==The "encounter" Element{{anchor|encounter}}==

The "encounter" element defines game specific information for use within the encounter builder. The encounter element contains one or more encounterinfo elements. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|ratingterm
|(Optional) Text - Defines the term used for the rating or difficulty of a monster. This is used in the encounter builder form in the rating filter label. If there is no rating term defined then the rating filter controls are hidden. If there is a rating term defined then there must also be an encounterinfo element with type="ratingval" to define the location of the rating value in the portfolio.
|-
|}

The encounter element contains one or more encounterinfo elements. The list of these child elements is below. Click on the links to access the details for each element.

:{| class="infotable"
|class="leftnormal"|[[#encounterinfo|encounterinfo]]
|One or more "encounterinfo" elements must appear as defined by the given link. This element gives a location in a stock portfolio to find a specific piece of data
|-
|}

==The "encounterinfo" Element{{anchor|encounterinfo}}==
The encounterinfo element is a child of the encounter element and contains locations to data in stock portfolios. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|type
|(Required) Text - indicates what the data is and should be one of the following:
pointsval - The number of "points" for a character. e.g. 2000
pointstext - The textual representation of the points value. e.g. "2,000 XP"
ratingval - The difficulty for a character. e.g. 4
ratingtext - The textual representation of the rating value. e.g. "CR 4"
sourcebooks - The books where a character originates.
|-
|xpath
|(Required) Text – The xpath should give a location of the element that contains a specific piece of data in the custom output XML for a stock portfolio. This should only be used in game systems with custom output XML.
|-
|attribute
|(Required) Text – specify the attribute of the node given in xpath that contains the data.
|-
|}

==Example==

The following example demonstrates what a "behavior" element might look like. All default values are assumed for omitted optional attributes.

<pre>
<behavior
defaultname="Nobody"
interleave="yes">
<diceroller mode="totals" dietype="6" quantity="1"/>

<leadsummary><![CDATA[
~start with the race
var txt as string
txt = hero.firstchild["Race.?"].field[name].text
if (empty(txt) <> 0) then
txt = "No Race"
endif
@text &= txt

~append the CP rating of the character
@text &= " - CP: " & hero.child[resCP].field[resMax].value
]]></leadsummary>

<initiative><![CDATA[
~calculate the secondary initiative rating
@secondary = 0
~calculate the primary initiative rating
@initiative = random(10) + 1
]]></initiative>

<encounter ratingterm="CR">
<encounterinfo type="pointsval"
xpath="/document/public/character/xpaward"
attribute="value"/>
<encounterinfo type="pointstext"
xpath="/document/public/character/xpaward"
attribute="text"/>
<encounterinfo type="ratingval"
xpath="/document/public/character/challengerating"
attribute="value"/>
<encounterinfo type="ratingtext"
xpath="/document/public/character/challengerating"
attribute="text"/>
<encounterinfo type="sourcebooks"
xpath="/document/public/character/bookinfo"
attribute="name"/>
</encounter>

</behavior>
</pre>

Behavior Element (Data)

2014-04-11T19:37:49Z

Michele: /* Example */

{{context|Kit Reference|Definition File Reference}}

==The "behavior" Element==

Each game system has a variety of behaviors that will need to be defined. These behaviors are collectively specified within a "behavior" element. The complete list of attributes for a "behavior" element is below.

:{| class="infotable"
|class="leftnormal"|defaultname
|(Optional) Text – Default name to be used for all actor that have not been explicitly named by the user. Maximum length is 50 characters. Default: "Unnamed".
|-
|secondaryphase
|(Optional) Id – Specifies the unique id of the phase to be used as the default for all [[Secondary Tag Expression|Secondary tag expressions]] assigned by tables and choosers. If no explicit phase is assigned for a Secondary tag expression, this one is used. Default: "Setup".
|-
|secondarypriority
|(Optional) Integer – Specifies the priority to be used as the default for all [[Secondary Tag Expression|Secondary tag expressions]] assigned by tables and choosers. If no explicit priority is assigned for a Secondary tag expression, this one is used. Default: "5000".
|-
|existencephase
|(Optional) Id – Specifies the unique id of the phase to be used as the default for all [[Existence Tag Expression|Existence tag expressions]] assigned by tables and choosers. If no explicit phase is assigned for an Existence tag expression, this one is used. Default: "Setup".
|-
|existencepriority
|(Optional) Integer – Specifies the priority to be used as the default for all [[Existence Tag Expression|Existence tag expressions]] assigned by tables and choosers. If no explicit priority is assigned for an Existence tag expression, this one is used. Default: "5000".
|-
|gearphase
|(Optional) Id – Specifies the unique id of the phase during which all [[Gear Weight Determination|built-in gear processing]] is performed. This includes the calculation of gear weights throughout all gear holders. Default: "Effects".
|-
|gearpriority
|(Optional) Integer – Specifies the priority at which all [[Gear Weight Determination|built-in gear processing]] is performed. Default: "5000".
|-
|mouseinfo
|(Optional) Id – Specifies the unique id of the procedure to automatically invoke as the [[MouseInfo Script|MouseInfo script]] within portals. Default: "MouseInfo".
|-
|description
|(Optional) Id – Specifies the unique id of the procedure to automatically invoke as the [[Description Script|Description script]] within portals. Default: "Descript".
|-
|initascend
|(Optional) Boolean – Indicates whether initiative order ascends or descends. When it ascends, lower numbers take their actions first, and vice versa. Default: "no".
|-
|initperturn
|(Optional) Boolean – Indicates whether to re-generate new initiative values at the start of every turn instead of at the start of every combat. Default: "no".
|-
|initsimultaneous
|(Optional) Boolean – Indicates whether it is valid for two actors to have identical initiatives and act simultaneously. If not, HL will automatically generate a tie-breaker value. Default: "no".
|-
|initminimum
|(Optional) Boolean – Specifies the minimum value allowed for the initiative value when the user is adjusting the value on the Tactical Console. Default: "-99".
|-
|initmaximum
|(Optional) Boolean – Specifies the maximum value allowed for the initiative value when the user is adjusting the value on the Tactical Console. Default: "99".
|-
|interleave
|(Optional) Boolean – Indicates whether the evaluation cycles of all actors within the context of the same lead are interleaved, which governs the [[Minion and Master Relationships|behavior of minions and masters]]. If enabled, masters can influence changes upon their minions and minions can also influence changes upon their masters. If not enabled, masters all fully evaluated before minions, so the influence can only occur in the downward direction. Default: "no".
|-
|}

The "behavior" 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 links to access the details for each element.

:{| class="infotable"
|class="leftnormal"|[[#diceroller|diceroller]]
|A single "diceroller" element must appear as defined by the given link. This element customizes the integrated Dice Roller.
|-
|[[#leadsummary|leadsummary]]
|An optional "leadsummary" element may appear as defined by the given link. This element defines the [[LeadSummary Script]]. If omitted, default handling is employed.
|-
|[[#newcombat|newcombat]]
|An optional "newcombat" element may appear as defined by the given link. This element defines the [[NewCombat Script]]. If omitted, default handling is employed.
|-
|[[#newturn|newturn]]
|An optional "newturn" element may appear as defined by the given link. This element defines the [[NewTurn Script]]. If omitted, default handling is employed.
|-
|[[#integrate|integrate]]
|An optional "integrate" element may appear as defined by the given link. This element defines the [[Integrate Script]]. If omitted, default handling is employed.
|-
|[[#initiative|initiative]]
|An optional "initiative" element may appear as defined by the given link. This element defines the [[Initiative Script]]. If omitted, default handling is employed.
|-
|[[#initfinalize|initfinalize]]
|An optional "initfinalize" element may appear as defined by the given link. This element defines the [[InitFinalize Script]]. If omitted, default handling is employed.
|-
|[[#loaderror|loaderror]]
|An optional "loaderror" element may appear as defined by the given link. This element defines the [[LoadError Script]]. If omitted, default handling is employed.
|-
|[[#encounter|encounter]]
|An optional "encounter" element may appear as defined by the given link. This element defines fields used by the encounter builder. If omitted, default values are used.
|-
|}

==The "diceroller" Element{{anchor|diceroller}}==

The "diceroller" element defines characteristics of the [[Configuring the Dice Roller|integrated Dice Roller]] mechanisms when used with the game system. The complete list of attributes for a "diceroller" element is below.

:{| class="infotable"
|class="leftnormal"|mode
|(Optional) Set – Specifies the initial dice rolling mode to start out in for the game system. Must be one of the following:
<ul class="sets">
<li>totals – The dice rolled are added and that total is displayed.</li>
<li>successes – Each die rolled is compared against the threshold for declaring a success and the number of successes is displayed.</li>
<li>Default: "totals".</li>
</ul>
|-
|dietype
|Integer – Specifies the default die type to be rolled.
|-
|quantity
|(Optional) Integer – Specifies the default number of dice to be rolled. Default: "1".
|-
|success
|(Optional) Integer – Specifies the threshold value at which a success result is achieved. Game systems like World of Darkness and Shadowrun utilizes successes instead of adding the dice results. Default: "1".
|-
|explode
|(Optional) Integer – Specifies the threshold value at which a success result "explodes" by allowing a re-roll. If a value of zero is given, no explosion occurs. Default: "0".
|-
|maxexplode
|(Optional) Integer – Specifies the maximum number of times that a single roll may explode. A value of zero indicates that explosion is unlimited. Default: "0".
|-
|}

==The "leadsummary" Element{{anchor|leadsummary}}==

The "leadsummary" element defines the [[LeadSummary Script|LeadSummary script]] that is used to synthesize summary information for each actor. This summary is displayed when the user previews the available actors for import into the current portfolio.
The complete list of attributes for a "scriptmacro" element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the LeadSummary script.
|-
|}

==The "newcombat" Element{{anchor|newcombat}}==

The "newcombat" element defines the [[NewCombat Script|NewCombat script]] that is invoked whenever the user begins a new combat within the Tactical Console. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the NewCombat script.
|-
|}

==The "newturn" Element{{anchor|newturn}}==

The "newturn" element defines the [[NewTurn Script|NewTurn script]] that is invoked whenever the user starts a new turn of combat within the Tactical Console. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the NewTurn script.
|-
|}

==The "integrate" Element{{anchor|integrate}}==

The "integrate" element defines the [[Integrate Script|Integrate script]] that is invoked whenever the user integrates pending actors into an existing combat within the Tactical Console. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the Integrate script.
|-
|}

==The "initiative" Element{{anchor|initiative}}==

The "initiative" element defines the [[Initiative Script|Initiative script]] that is used to calculate the initiative score for each actor during combat. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the Initiative script.
|-
|}

==The "initfinalize" Element{{anchor|initfinalize}}==

The "initfinalize" element defines the [[InitFinalize Script|InitFinalize script]] that is used to tailor the final displayed text for the initiative score of each actor during combat. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the InitFinalize script.
|-
|}

==The "loaderror" Element{{anchor|loaderror}}==

The "loaderror" element defines the [[LoadError Script|LoadError script]] that is used to provide helpful information to the user about changes across releases of your data files and errors that can be safely ignored. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the LoadError script.
|-
|}

==The "encounter" Element{{anchor|encounter}}==

The "encounter" element defines game specific information for use within the encounter builder. The encounter element contains one or more encounterinfo elements. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|ratingterm
|(Optional) Text - Defines the term used for the rating or difficulty of a monster. This is used in the encounter builder form in the rating filter label. If there is no rating term defined then the rating filter controls are hidden. If there is a rating term defined then there must also be an encounterinfo element with type="ratingval" to define the location of the rating value in the portfolio.
|-
|}

The encounter element contains one or more encounterinfo elements. The list of these child elements is below. Click on the links to access the details for each element.

:{| class="infotable"
|class="leftnormal"|[[#encounterinfo|encounterinfo]]
|One or more "encounterinfo" elements must appear as defined by the given link. This element gives a location in a stock portfolio to find a specific piece of data
|-
|}

==The "encounterinfo" Element{{anchor|encounterinfo}}==
The encounterinfo element is a child of the encounter element and contains locations to data in stock portfolios. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|type
|(Required) Text - indicates what the data is and should be one of the following:
pointsval - The number of "points" for a character. ie 2000
pointstext - The textual representation of the points value. ie "2,000 XP"
ratingval - The difficulty for a character. ie 4
ratingtext - The textual representation of the rating value. ie "CR 4"
sourcebooks - The books where a character originates.
|-
|xpath
|(Required) Text – The xpath should give a location of the element that contains a specific piece of data in the custom output XML for a stock portfolio. This should only be used in game systems with custom output XML.
|-
|attribute
|(Required) Text – specify the attribute of the node given in xpath that contains the data.
|-
|}

==Example==

The following example demonstrates what a "behavior" element might look like. All default values are assumed for omitted optional attributes.

<pre>
<behavior
defaultname="Nobody"
interleave="yes">
<diceroller mode="totals" dietype="6" quantity="1"/>

<leadsummary><![CDATA[
~start with the race
var txt as string
txt = hero.firstchild["Race.?"].field[name].text
if (empty(txt) <> 0) then
txt = "No Race"
endif
@text &= txt

~append the CP rating of the character
@text &= " - CP: " & hero.child[resCP].field[resMax].value
]]></leadsummary>

<initiative><![CDATA[
~calculate the secondary initiative rating
@secondary = 0
~calculate the primary initiative rating
@initiative = random(10) + 1
]]></initiative>

<encounter ratingterm="CR">
<encounterinfo type="pointsval"
xpath="/document/public/character/xpaward"
attribute="value"/>
<encounterinfo type="pointstext"
xpath="/document/public/character/xpaward"
attribute="text"/>
<encounterinfo type="ratingval"
xpath="/document/public/character/challengerating"
attribute="value"/>
<encounterinfo type="ratingtext"
xpath="/document/public/character/challengerating"
attribute="text"/>
<encounterinfo type="sourcebooks"
xpath="/document/public/character/bookinfo"
attribute="name"/>
</encounter>

</behavior>
</pre>

Behavior Element (Data)

2014-04-11T19:28:55Z

Michele: /* The "encounterinfo" Element{{anchor|encounterinfo}} */

{{context|Kit Reference|Definition File Reference}}

==The "behavior" Element==

Each game system has a variety of behaviors that will need to be defined. These behaviors are collectively specified within a "behavior" element. The complete list of attributes for a "behavior" element is below.

:{| class="infotable"
|class="leftnormal"|defaultname
|(Optional) Text – Default name to be used for all actor that have not been explicitly named by the user. Maximum length is 50 characters. Default: "Unnamed".
|-
|secondaryphase
|(Optional) Id – Specifies the unique id of the phase to be used as the default for all [[Secondary Tag Expression|Secondary tag expressions]] assigned by tables and choosers. If no explicit phase is assigned for a Secondary tag expression, this one is used. Default: "Setup".
|-
|secondarypriority
|(Optional) Integer – Specifies the priority to be used as the default for all [[Secondary Tag Expression|Secondary tag expressions]] assigned by tables and choosers. If no explicit priority is assigned for a Secondary tag expression, this one is used. Default: "5000".
|-
|existencephase
|(Optional) Id – Specifies the unique id of the phase to be used as the default for all [[Existence Tag Expression|Existence tag expressions]] assigned by tables and choosers. If no explicit phase is assigned for an Existence tag expression, this one is used. Default: "Setup".
|-
|existencepriority
|(Optional) Integer – Specifies the priority to be used as the default for all [[Existence Tag Expression|Existence tag expressions]] assigned by tables and choosers. If no explicit priority is assigned for an Existence tag expression, this one is used. Default: "5000".
|-
|gearphase
|(Optional) Id – Specifies the unique id of the phase during which all [[Gear Weight Determination|built-in gear processing]] is performed. This includes the calculation of gear weights throughout all gear holders. Default: "Effects".
|-
|gearpriority
|(Optional) Integer – Specifies the priority at which all [[Gear Weight Determination|built-in gear processing]] is performed. Default: "5000".
|-
|mouseinfo
|(Optional) Id – Specifies the unique id of the procedure to automatically invoke as the [[MouseInfo Script|MouseInfo script]] within portals. Default: "MouseInfo".
|-
|description
|(Optional) Id – Specifies the unique id of the procedure to automatically invoke as the [[Description Script|Description script]] within portals. Default: "Descript".
|-
|initascend
|(Optional) Boolean – Indicates whether initiative order ascends or descends. When it ascends, lower numbers take their actions first, and vice versa. Default: "no".
|-
|initperturn
|(Optional) Boolean – Indicates whether to re-generate new initiative values at the start of every turn instead of at the start of every combat. Default: "no".
|-
|initsimultaneous
|(Optional) Boolean – Indicates whether it is valid for two actors to have identical initiatives and act simultaneously. If not, HL will automatically generate a tie-breaker value. Default: "no".
|-
|initminimum
|(Optional) Boolean – Specifies the minimum value allowed for the initiative value when the user is adjusting the value on the Tactical Console. Default: "-99".
|-
|initmaximum
|(Optional) Boolean – Specifies the maximum value allowed for the initiative value when the user is adjusting the value on the Tactical Console. Default: "99".
|-
|interleave
|(Optional) Boolean – Indicates whether the evaluation cycles of all actors within the context of the same lead are interleaved, which governs the [[Minion and Master Relationships|behavior of minions and masters]]. If enabled, masters can influence changes upon their minions and minions can also influence changes upon their masters. If not enabled, masters all fully evaluated before minions, so the influence can only occur in the downward direction. Default: "no".
|-
|}

The "behavior" 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 links to access the details for each element.

:{| class="infotable"
|class="leftnormal"|[[#diceroller|diceroller]]
|A single "diceroller" element must appear as defined by the given link. This element customizes the integrated Dice Roller.
|-
|[[#leadsummary|leadsummary]]
|An optional "leadsummary" element may appear as defined by the given link. This element defines the [[LeadSummary Script]]. If omitted, default handling is employed.
|-
|[[#newcombat|newcombat]]
|An optional "newcombat" element may appear as defined by the given link. This element defines the [[NewCombat Script]]. If omitted, default handling is employed.
|-
|[[#newturn|newturn]]
|An optional "newturn" element may appear as defined by the given link. This element defines the [[NewTurn Script]]. If omitted, default handling is employed.
|-
|[[#integrate|integrate]]
|An optional "integrate" element may appear as defined by the given link. This element defines the [[Integrate Script]]. If omitted, default handling is employed.
|-
|[[#initiative|initiative]]
|An optional "initiative" element may appear as defined by the given link. This element defines the [[Initiative Script]]. If omitted, default handling is employed.
|-
|[[#initfinalize|initfinalize]]
|An optional "initfinalize" element may appear as defined by the given link. This element defines the [[InitFinalize Script]]. If omitted, default handling is employed.
|-
|[[#loaderror|loaderror]]
|An optional "loaderror" element may appear as defined by the given link. This element defines the [[LoadError Script]]. If omitted, default handling is employed.
|-
|[[#encounter|encounter]]
|An optional "encounter" element may appear as defined by the given link. This element defines fields used by the encounter builder. If omitted, default values are used.
|-
|}

==The "diceroller" Element{{anchor|diceroller}}==

The "diceroller" element defines characteristics of the [[Configuring the Dice Roller|integrated Dice Roller]] mechanisms when used with the game system. The complete list of attributes for a "diceroller" element is below.

:{| class="infotable"
|class="leftnormal"|mode
|(Optional) Set – Specifies the initial dice rolling mode to start out in for the game system. Must be one of the following:
<ul class="sets">
<li>totals – The dice rolled are added and that total is displayed.</li>
<li>successes – Each die rolled is compared against the threshold for declaring a success and the number of successes is displayed.</li>
<li>Default: "totals".</li>
</ul>
|-
|dietype
|Integer – Specifies the default die type to be rolled.
|-
|quantity
|(Optional) Integer – Specifies the default number of dice to be rolled. Default: "1".
|-
|success
|(Optional) Integer – Specifies the threshold value at which a success result is achieved. Game systems like World of Darkness and Shadowrun utilizes successes instead of adding the dice results. Default: "1".
|-
|explode
|(Optional) Integer – Specifies the threshold value at which a success result "explodes" by allowing a re-roll. If a value of zero is given, no explosion occurs. Default: "0".
|-
|maxexplode
|(Optional) Integer – Specifies the maximum number of times that a single roll may explode. A value of zero indicates that explosion is unlimited. Default: "0".
|-
|}

==The "leadsummary" Element{{anchor|leadsummary}}==

The "leadsummary" element defines the [[LeadSummary Script|LeadSummary script]] that is used to synthesize summary information for each actor. This summary is displayed when the user previews the available actors for import into the current portfolio.
The complete list of attributes for a "scriptmacro" element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the LeadSummary script.
|-
|}

==The "newcombat" Element{{anchor|newcombat}}==

The "newcombat" element defines the [[NewCombat Script|NewCombat script]] that is invoked whenever the user begins a new combat within the Tactical Console. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the NewCombat script.
|-
|}

==The "newturn" Element{{anchor|newturn}}==

The "newturn" element defines the [[NewTurn Script|NewTurn script]] that is invoked whenever the user starts a new turn of combat within the Tactical Console. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the NewTurn script.
|-
|}

==The "integrate" Element{{anchor|integrate}}==

The "integrate" element defines the [[Integrate Script|Integrate script]] that is invoked whenever the user integrates pending actors into an existing combat within the Tactical Console. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the Integrate script.
|-
|}

==The "initiative" Element{{anchor|initiative}}==

The "initiative" element defines the [[Initiative Script|Initiative script]] that is used to calculate the initiative score for each actor during combat. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the Initiative script.
|-
|}

==The "initfinalize" Element{{anchor|initfinalize}}==

The "initfinalize" element defines the [[InitFinalize Script|InitFinalize script]] that is used to tailor the final displayed text for the initiative score of each actor during combat. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the InitFinalize script.
|-
|}

==The "loaderror" Element{{anchor|loaderror}}==

The "loaderror" element defines the [[LoadError Script|LoadError script]] that is used to provide helpful information to the user about changes across releases of your data files and errors that can be safely ignored. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the LoadError script.
|-
|}

==The "encounter" Element{{anchor|encounter}}==

The "encounter" element defines game specific information for use within the encounter builder. The encounter element contains one or more encounterinfo elements. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|ratingterm
|(Optional) Text - Defines the term used for the rating or difficulty of a monster. This is used in the encounter builder form in the rating filter label. If there is no rating term defined then the rating filter controls are hidden. If there is a rating term defined then there must also be an encounterinfo element with type="ratingval" to define the location of the rating value in the portfolio.
|-
|}

The encounter element contains one or more encounterinfo elements. The list of these child elements is below. Click on the links to access the details for each element.

:{| class="infotable"
|class="leftnormal"|[[#encounterinfo|encounterinfo]]
|One or more "encounterinfo" elements must appear as defined by the given link. This element gives a location in a stock portfolio to find a specific piece of data
|-
|}

==The "encounterinfo" Element{{anchor|encounterinfo}}==
The encounterinfo element is a child of the encounter element and contains locations to data in stock portfolios. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|type
|(Required) Text - indicates what the data is and should be one of the following:
pointsval - The number of "points" for a character. ie 2000
pointstext - The textual representation of the points value. ie "2,000 XP"
ratingval - The difficulty for a character. ie 4
ratingtext - The textual representation of the rating value. ie "CR 4"
sourcebooks - The books where a character originates.
|-
|xpath
|(Required) Text – The xpath should give a location of the element that contains a specific piece of data in the custom output XML for a stock portfolio. This should only be used in game systems with custom output XML.
|-
|attribute
|(Required) Text – specify the attribute of the node given in xpath that contains the data.
|-
|}

==Example==

The following example demonstrates what a "behavior" element might look like. All default values are assumed for omitted optional attributes.

<pre>
<behavior
defaultname="Nobody"
interleave="yes">
<diceroller mode="totals" dietype="6" quantity="1"/>

<leadsummary><![CDATA[
~start with the race
var txt as string
txt = hero.firstchild["Race.?"].field[name].text
if (empty(txt) <> 0) then
txt = "No Race"
endif
@text &= txt

~append the CP rating of the character
@text &= " - CP: " & hero.child[resCP].field[resMax].value
]]></leadsummary>

<initiative><![CDATA[
~calculate the secondary initiative rating
@secondary = 0
~calculate the primary initiative rating
@initiative = random(10) + 1
]]></initiative>

</behavior>
</pre>

Behavior Element (Data)

2014-04-11T16:06:18Z

Michele: /* The "encounter" Element{{anchor|encounter}} */

{{context|Kit Reference|Definition File Reference}}

==The "behavior" Element==

Each game system has a variety of behaviors that will need to be defined. These behaviors are collectively specified within a "behavior" element. The complete list of attributes for a "behavior" element is below.

:{| class="infotable"
|class="leftnormal"|defaultname
|(Optional) Text – Default name to be used for all actor that have not been explicitly named by the user. Maximum length is 50 characters. Default: "Unnamed".
|-
|secondaryphase
|(Optional) Id – Specifies the unique id of the phase to be used as the default for all [[Secondary Tag Expression|Secondary tag expressions]] assigned by tables and choosers. If no explicit phase is assigned for a Secondary tag expression, this one is used. Default: "Setup".
|-
|secondarypriority
|(Optional) Integer – Specifies the priority to be used as the default for all [[Secondary Tag Expression|Secondary tag expressions]] assigned by tables and choosers. If no explicit priority is assigned for a Secondary tag expression, this one is used. Default: "5000".
|-
|existencephase
|(Optional) Id – Specifies the unique id of the phase to be used as the default for all [[Existence Tag Expression|Existence tag expressions]] assigned by tables and choosers. If no explicit phase is assigned for an Existence tag expression, this one is used. Default: "Setup".
|-
|existencepriority
|(Optional) Integer – Specifies the priority to be used as the default for all [[Existence Tag Expression|Existence tag expressions]] assigned by tables and choosers. If no explicit priority is assigned for an Existence tag expression, this one is used. Default: "5000".
|-
|gearphase
|(Optional) Id – Specifies the unique id of the phase during which all [[Gear Weight Determination|built-in gear processing]] is performed. This includes the calculation of gear weights throughout all gear holders. Default: "Effects".
|-
|gearpriority
|(Optional) Integer – Specifies the priority at which all [[Gear Weight Determination|built-in gear processing]] is performed. Default: "5000".
|-
|mouseinfo
|(Optional) Id – Specifies the unique id of the procedure to automatically invoke as the [[MouseInfo Script|MouseInfo script]] within portals. Default: "MouseInfo".
|-
|description
|(Optional) Id – Specifies the unique id of the procedure to automatically invoke as the [[Description Script|Description script]] within portals. Default: "Descript".
|-
|initascend
|(Optional) Boolean – Indicates whether initiative order ascends or descends. When it ascends, lower numbers take their actions first, and vice versa. Default: "no".
|-
|initperturn
|(Optional) Boolean – Indicates whether to re-generate new initiative values at the start of every turn instead of at the start of every combat. Default: "no".
|-
|initsimultaneous
|(Optional) Boolean – Indicates whether it is valid for two actors to have identical initiatives and act simultaneously. If not, HL will automatically generate a tie-breaker value. Default: "no".
|-
|initminimum
|(Optional) Boolean – Specifies the minimum value allowed for the initiative value when the user is adjusting the value on the Tactical Console. Default: "-99".
|-
|initmaximum
|(Optional) Boolean – Specifies the maximum value allowed for the initiative value when the user is adjusting the value on the Tactical Console. Default: "99".
|-
|interleave
|(Optional) Boolean – Indicates whether the evaluation cycles of all actors within the context of the same lead are interleaved, which governs the [[Minion and Master Relationships|behavior of minions and masters]]. If enabled, masters can influence changes upon their minions and minions can also influence changes upon their masters. If not enabled, masters all fully evaluated before minions, so the influence can only occur in the downward direction. Default: "no".
|-
|}

The "behavior" 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 links to access the details for each element.

:{| class="infotable"
|class="leftnormal"|[[#diceroller|diceroller]]
|A single "diceroller" element must appear as defined by the given link. This element customizes the integrated Dice Roller.
|-
|[[#leadsummary|leadsummary]]
|An optional "leadsummary" element may appear as defined by the given link. This element defines the [[LeadSummary Script]]. If omitted, default handling is employed.
|-
|[[#newcombat|newcombat]]
|An optional "newcombat" element may appear as defined by the given link. This element defines the [[NewCombat Script]]. If omitted, default handling is employed.
|-
|[[#newturn|newturn]]
|An optional "newturn" element may appear as defined by the given link. This element defines the [[NewTurn Script]]. If omitted, default handling is employed.
|-
|[[#integrate|integrate]]
|An optional "integrate" element may appear as defined by the given link. This element defines the [[Integrate Script]]. If omitted, default handling is employed.
|-
|[[#initiative|initiative]]
|An optional "initiative" element may appear as defined by the given link. This element defines the [[Initiative Script]]. If omitted, default handling is employed.
|-
|[[#initfinalize|initfinalize]]
|An optional "initfinalize" element may appear as defined by the given link. This element defines the [[InitFinalize Script]]. If omitted, default handling is employed.
|-
|[[#loaderror|loaderror]]
|An optional "loaderror" element may appear as defined by the given link. This element defines the [[LoadError Script]]. If omitted, default handling is employed.
|-
|[[#encounter|encounter]]
|An optional "encounter" element may appear as defined by the given link. This element defines fields used by the encounter builder. If omitted, default values are used.
|-
|}

==The "diceroller" Element{{anchor|diceroller}}==

The "diceroller" element defines characteristics of the [[Configuring the Dice Roller|integrated Dice Roller]] mechanisms when used with the game system. The complete list of attributes for a "diceroller" element is below.

:{| class="infotable"
|class="leftnormal"|mode
|(Optional) Set – Specifies the initial dice rolling mode to start out in for the game system. Must be one of the following:
<ul class="sets">
<li>totals – The dice rolled are added and that total is displayed.</li>
<li>successes – Each die rolled is compared against the threshold for declaring a success and the number of successes is displayed.</li>
<li>Default: "totals".</li>
</ul>
|-
|dietype
|Integer – Specifies the default die type to be rolled.
|-
|quantity
|(Optional) Integer – Specifies the default number of dice to be rolled. Default: "1".
|-
|success
|(Optional) Integer – Specifies the threshold value at which a success result is achieved. Game systems like World of Darkness and Shadowrun utilizes successes instead of adding the dice results. Default: "1".
|-
|explode
|(Optional) Integer – Specifies the threshold value at which a success result "explodes" by allowing a re-roll. If a value of zero is given, no explosion occurs. Default: "0".
|-
|maxexplode
|(Optional) Integer – Specifies the maximum number of times that a single roll may explode. A value of zero indicates that explosion is unlimited. Default: "0".
|-
|}

==The "leadsummary" Element{{anchor|leadsummary}}==

The "leadsummary" element defines the [[LeadSummary Script|LeadSummary script]] that is used to synthesize summary information for each actor. This summary is displayed when the user previews the available actors for import into the current portfolio.
The complete list of attributes for a "scriptmacro" element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the LeadSummary script.
|-
|}

==The "newcombat" Element{{anchor|newcombat}}==

The "newcombat" element defines the [[NewCombat Script|NewCombat script]] that is invoked whenever the user begins a new combat within the Tactical Console. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the NewCombat script.
|-
|}

==The "newturn" Element{{anchor|newturn}}==

The "newturn" element defines the [[NewTurn Script|NewTurn script]] that is invoked whenever the user starts a new turn of combat within the Tactical Console. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the NewTurn script.
|-
|}

==The "integrate" Element{{anchor|integrate}}==

The "integrate" element defines the [[Integrate Script|Integrate script]] that is invoked whenever the user integrates pending actors into an existing combat within the Tactical Console. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the Integrate script.
|-
|}

==The "initiative" Element{{anchor|initiative}}==

The "initiative" element defines the [[Initiative Script|Initiative script]] that is used to calculate the initiative score for each actor during combat. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the Initiative script.
|-
|}

==The "initfinalize" Element{{anchor|initfinalize}}==

The "initfinalize" element defines the [[InitFinalize Script|InitFinalize script]] that is used to tailor the final displayed text for the initiative score of each actor during combat. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the InitFinalize script.
|-
|}

==The "loaderror" Element{{anchor|loaderror}}==

The "loaderror" element defines the [[LoadError Script|LoadError script]] that is used to provide helpful information to the user about changes across releases of your data files and errors that can be safely ignored. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the LoadError script.
|-
|}

==The "encounter" Element{{anchor|encounter}}==

The "encounter" element defines game specific information for use within the encounter builder. The encounter element contains one or more encounterinfo elements. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|ratingterm
|(Optional) Text - Defines the term used for the rating or difficulty of a monster. This is used in the encounter builder form in the rating filter label. If there is no rating term defined then the rating filter controls are hidden. If there is a rating term defined then there must also be an encounterinfo element with type="ratingval" to define the location of the rating value in the portfolio.
|-
|}

The encounter element contains one or more encounterinfo elements. The list of these child elements is below. Click on the links to access the details for each element.

:{| class="infotable"
|class="leftnormal"|[[#encounterinfo|encounterinfo]]
|One or more "encounterinfo" elements must appear as defined by the given link. This element gives a location in a stock portfolio to find a specific piece of data
|-
|}

==The "encounterinfo" Element{{anchor|encounterinfo}}==
The encounterinfo element is a child of the encounter element and contains locations to data in stock portfolios. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|type
|(Required) Text - indicates what the data is and should be one of the following: pointsval, pointstext, ratingval, ratingtext, or sourcebooks.
|-
|xpath
|(Required) Text – The xpath should give a location of the element in a stock portfolio to find a specific piece of data.
|-
|attribute
|(Required) Text – specify the attribute of the node given in xpath that contains the data.
|-
|}

==Example==

The following example demonstrates what a "behavior" element might look like. All default values are assumed for omitted optional attributes.

<pre>
<behavior
defaultname="Nobody"
interleave="yes">
<diceroller mode="totals" dietype="6" quantity="1"/>

<leadsummary><![CDATA[
~start with the race
var txt as string
txt = hero.firstchild["Race.?"].field[name].text
if (empty(txt) <> 0) then
txt = "No Race"
endif
@text &= txt

~append the CP rating of the character
@text &= " - CP: " & hero.child[resCP].field[resMax].value
]]></leadsummary>

<initiative><![CDATA[
~calculate the secondary initiative rating
@secondary = 0
~calculate the primary initiative rating
@initiative = random(10) + 1
]]></initiative>

</behavior>
</pre>

Behavior Element (Data)

2014-04-11T16:04:12Z

Michele: Added encounter and encounterinfo elements

{{context|Kit Reference|Definition File Reference}}

==The "behavior" Element==

Each game system has a variety of behaviors that will need to be defined. These behaviors are collectively specified within a "behavior" element. The complete list of attributes for a "behavior" element is below.

:{| class="infotable"
|class="leftnormal"|defaultname
|(Optional) Text – Default name to be used for all actor that have not been explicitly named by the user. Maximum length is 50 characters. Default: "Unnamed".
|-
|secondaryphase
|(Optional) Id – Specifies the unique id of the phase to be used as the default for all [[Secondary Tag Expression|Secondary tag expressions]] assigned by tables and choosers. If no explicit phase is assigned for a Secondary tag expression, this one is used. Default: "Setup".
|-
|secondarypriority
|(Optional) Integer – Specifies the priority to be used as the default for all [[Secondary Tag Expression|Secondary tag expressions]] assigned by tables and choosers. If no explicit priority is assigned for a Secondary tag expression, this one is used. Default: "5000".
|-
|existencephase
|(Optional) Id – Specifies the unique id of the phase to be used as the default for all [[Existence Tag Expression|Existence tag expressions]] assigned by tables and choosers. If no explicit phase is assigned for an Existence tag expression, this one is used. Default: "Setup".
|-
|existencepriority
|(Optional) Integer – Specifies the priority to be used as the default for all [[Existence Tag Expression|Existence tag expressions]] assigned by tables and choosers. If no explicit priority is assigned for an Existence tag expression, this one is used. Default: "5000".
|-
|gearphase
|(Optional) Id – Specifies the unique id of the phase during which all [[Gear Weight Determination|built-in gear processing]] is performed. This includes the calculation of gear weights throughout all gear holders. Default: "Effects".
|-
|gearpriority
|(Optional) Integer – Specifies the priority at which all [[Gear Weight Determination|built-in gear processing]] is performed. Default: "5000".
|-
|mouseinfo
|(Optional) Id – Specifies the unique id of the procedure to automatically invoke as the [[MouseInfo Script|MouseInfo script]] within portals. Default: "MouseInfo".
|-
|description
|(Optional) Id – Specifies the unique id of the procedure to automatically invoke as the [[Description Script|Description script]] within portals. Default: "Descript".
|-
|initascend
|(Optional) Boolean – Indicates whether initiative order ascends or descends. When it ascends, lower numbers take their actions first, and vice versa. Default: "no".
|-
|initperturn
|(Optional) Boolean – Indicates whether to re-generate new initiative values at the start of every turn instead of at the start of every combat. Default: "no".
|-
|initsimultaneous
|(Optional) Boolean – Indicates whether it is valid for two actors to have identical initiatives and act simultaneously. If not, HL will automatically generate a tie-breaker value. Default: "no".
|-
|initminimum
|(Optional) Boolean – Specifies the minimum value allowed for the initiative value when the user is adjusting the value on the Tactical Console. Default: "-99".
|-
|initmaximum
|(Optional) Boolean – Specifies the maximum value allowed for the initiative value when the user is adjusting the value on the Tactical Console. Default: "99".
|-
|interleave
|(Optional) Boolean – Indicates whether the evaluation cycles of all actors within the context of the same lead are interleaved, which governs the [[Minion and Master Relationships|behavior of minions and masters]]. If enabled, masters can influence changes upon their minions and minions can also influence changes upon their masters. If not enabled, masters all fully evaluated before minions, so the influence can only occur in the downward direction. Default: "no".
|-
|}

The "behavior" 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 links to access the details for each element.

:{| class="infotable"
|class="leftnormal"|[[#diceroller|diceroller]]
|A single "diceroller" element must appear as defined by the given link. This element customizes the integrated Dice Roller.
|-
|[[#leadsummary|leadsummary]]
|An optional "leadsummary" element may appear as defined by the given link. This element defines the [[LeadSummary Script]]. If omitted, default handling is employed.
|-
|[[#newcombat|newcombat]]
|An optional "newcombat" element may appear as defined by the given link. This element defines the [[NewCombat Script]]. If omitted, default handling is employed.
|-
|[[#newturn|newturn]]
|An optional "newturn" element may appear as defined by the given link. This element defines the [[NewTurn Script]]. If omitted, default handling is employed.
|-
|[[#integrate|integrate]]
|An optional "integrate" element may appear as defined by the given link. This element defines the [[Integrate Script]]. If omitted, default handling is employed.
|-
|[[#initiative|initiative]]
|An optional "initiative" element may appear as defined by the given link. This element defines the [[Initiative Script]]. If omitted, default handling is employed.
|-
|[[#initfinalize|initfinalize]]
|An optional "initfinalize" element may appear as defined by the given link. This element defines the [[InitFinalize Script]]. If omitted, default handling is employed.
|-
|[[#loaderror|loaderror]]
|An optional "loaderror" element may appear as defined by the given link. This element defines the [[LoadError Script]]. If omitted, default handling is employed.
|-
|[[#encounter|encounter]]
|An optional "encounter" element may appear as defined by the given link. This element defines fields used by the encounter builder. If omitted, default values are used.
|-
|}

==The "diceroller" Element{{anchor|diceroller}}==

The "diceroller" element defines characteristics of the [[Configuring the Dice Roller|integrated Dice Roller]] mechanisms when used with the game system. The complete list of attributes for a "diceroller" element is below.

:{| class="infotable"
|class="leftnormal"|mode
|(Optional) Set – Specifies the initial dice rolling mode to start out in for the game system. Must be one of the following:
<ul class="sets">
<li>totals – The dice rolled are added and that total is displayed.</li>
<li>successes – Each die rolled is compared against the threshold for declaring a success and the number of successes is displayed.</li>
<li>Default: "totals".</li>
</ul>
|-
|dietype
|Integer – Specifies the default die type to be rolled.
|-
|quantity
|(Optional) Integer – Specifies the default number of dice to be rolled. Default: "1".
|-
|success
|(Optional) Integer – Specifies the threshold value at which a success result is achieved. Game systems like World of Darkness and Shadowrun utilizes successes instead of adding the dice results. Default: "1".
|-
|explode
|(Optional) Integer – Specifies the threshold value at which a success result "explodes" by allowing a re-roll. If a value of zero is given, no explosion occurs. Default: "0".
|-
|maxexplode
|(Optional) Integer – Specifies the maximum number of times that a single roll may explode. A value of zero indicates that explosion is unlimited. Default: "0".
|-
|}

==The "leadsummary" Element{{anchor|leadsummary}}==

The "leadsummary" element defines the [[LeadSummary Script|LeadSummary script]] that is used to synthesize summary information for each actor. This summary is displayed when the user previews the available actors for import into the current portfolio.
The complete list of attributes for a "scriptmacro" element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the LeadSummary script.
|-
|}

==The "newcombat" Element{{anchor|newcombat}}==

The "newcombat" element defines the [[NewCombat Script|NewCombat script]] that is invoked whenever the user begins a new combat within the Tactical Console. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the NewCombat script.
|-
|}

==The "newturn" Element{{anchor|newturn}}==

The "newturn" element defines the [[NewTurn Script|NewTurn script]] that is invoked whenever the user starts a new turn of combat within the Tactical Console. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the NewTurn script.
|-
|}

==The "integrate" Element{{anchor|integrate}}==

The "integrate" element defines the [[Integrate Script|Integrate script]] that is invoked whenever the user integrates pending actors into an existing combat within the Tactical Console. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the Integrate script.
|-
|}

==The "initiative" Element{{anchor|initiative}}==

The "initiative" element defines the [[Initiative Script|Initiative script]] that is used to calculate the initiative score for each actor during combat. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the Initiative script.
|-
|}

==The "initfinalize" Element{{anchor|initfinalize}}==

The "initfinalize" element defines the [[InitFinalize Script|InitFinalize script]] that is used to tailor the final displayed text for the initiative score of each actor during combat. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the InitFinalize script.
|-
|}

==The "loaderror" Element{{anchor|loaderror}}==

The "loaderror" element defines the [[LoadError Script|LoadError script]] that is used to provide helpful information to the user about changes across releases of your data files and errors that can be safely ignored. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the LoadError script.
|-
|}

==The "encounter" Element{{anchor|encounter}}==

The "encounter" element defines game specific locations into the stock character data files for use within the encounter builder. The encounter element contains one or more encounterinfo elements. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|ratingterm
|(Optional) Text - Defines the term used for the rating or difficulty of a monster. This is used in the encounter builder form in the rating filter label. If there is no rating term defined then the rating filter controls are hidden. If there is a rating term defined then there must also be an encounterinfo element with type="ratingval" to define the location of the rating value in the portfolio.
|-
|}

The encounter element contains one or more encounterinfo elements. The list of these child elements is below. Click on the links to access the details for each element.

:{| class="infotable"
|class="leftnormal"|[[#encounterinfo|encounterinfo]]
|One or more "encounterinfo" elements must appear as defined by the given link. This element gives a location in a stock portfolio to find a specific piece of data
|-
|}

==The "encounterinfo" Element{{anchor|encounterinfo}}==
The encounterinfo element is a child of the encounter element and contains locations to data in stock portfolios. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|type
|(Required) Text - indicates what the data is and should be one of the following: pointsval, pointstext, ratingval, ratingtext, or sourcebooks.
|-
|xpath
|(Required) Text – The xpath should give a location of the element in a stock portfolio to find a specific piece of data.
|-
|attribute
|(Required) Text – specify the attribute of the node given in xpath that contains the data.
|-
|}

==Example==

The following example demonstrates what a "behavior" element might look like. All default values are assumed for omitted optional attributes.

<pre>
<behavior
defaultname="Nobody"
interleave="yes">
<diceroller mode="totals" dietype="6" quantity="1"/>

<leadsummary><![CDATA[
~start with the race
var txt as string
txt = hero.firstchild["Race.?"].field[name].text
if (empty(txt) <> 0) then
txt = "No Race"
endif
@text &= txt

~append the CP rating of the character
@text &= " - CP: " & hero.child[resCP].field[resMax].value
]]></leadsummary>

<initiative><![CDATA[
~calculate the secondary initiative rating
@secondary = 0
~calculate the primary initiative rating
@initiative = random(10) + 1
]]></initiative>

</behavior>
</pre>

Behavior Element (Data)

2014-04-08T20:57:30Z

Michele: /* The "behavior" Element */

{{context|Kit Reference|Definition File Reference}}

==The "behavior" Element==

Each game system has a variety of behaviors that will need to be defined. These behaviors are collectively specified within a "behavior" element. The complete list of attributes for a "behavior" element is below.

:{| class="infotable"
|class="leftnormal"|defaultname
|(Optional) Text – Default name to be used for all actor that have not been explicitly named by the user. Maximum length is 50 characters. Default: "Unnamed".
|-
|secondaryphase
|(Optional) Id – Specifies the unique id of the phase to be used as the default for all [[Secondary Tag Expression|Secondary tag expressions]] assigned by tables and choosers. If no explicit phase is assigned for a Secondary tag expression, this one is used. Default: "Setup".
|-
|secondarypriority
|(Optional) Integer – Specifies the priority to be used as the default for all [[Secondary Tag Expression|Secondary tag expressions]] assigned by tables and choosers. If no explicit priority is assigned for a Secondary tag expression, this one is used. Default: "5000".
|-
|existencephase
|(Optional) Id – Specifies the unique id of the phase to be used as the default for all [[Existence Tag Expression|Existence tag expressions]] assigned by tables and choosers. If no explicit phase is assigned for an Existence tag expression, this one is used. Default: "Setup".
|-
|existencepriority
|(Optional) Integer – Specifies the priority to be used as the default for all [[Existence Tag Expression|Existence tag expressions]] assigned by tables and choosers. If no explicit priority is assigned for an Existence tag expression, this one is used. Default: "5000".
|-
|gearphase
|(Optional) Id – Specifies the unique id of the phase during which all [[Gear Weight Determination|built-in gear processing]] is performed. This includes the calculation of gear weights throughout all gear holders. Default: "Effects".
|-
|gearpriority
|(Optional) Integer – Specifies the priority at which all [[Gear Weight Determination|built-in gear processing]] is performed. Default: "5000".
|-
|mouseinfo
|(Optional) Id – Specifies the unique id of the procedure to automatically invoke as the [[MouseInfo Script|MouseInfo script]] within portals. Default: "MouseInfo".
|-
|description
|(Optional) Id – Specifies the unique id of the procedure to automatically invoke as the [[Description Script|Description script]] within portals. Default: "Descript".
|-
|initascend
|(Optional) Boolean – Indicates whether initiative order ascends or descends. When it ascends, lower numbers take their actions first, and vice versa. Default: "no".
|-
|initperturn
|(Optional) Boolean – Indicates whether to re-generate new initiative values at the start of every turn instead of at the start of every combat. Default: "no".
|-
|initsimultaneous
|(Optional) Boolean – Indicates whether it is valid for two actors to have identical initiatives and act simultaneously. If not, HL will automatically generate a tie-breaker value. Default: "no".
|-
|initminimum
|(Optional) Boolean – Specifies the minimum value allowed for the initiative value when the user is adjusting the value on the Tactical Console. Default: "-99".
|-
|initmaximum
|(Optional) Boolean – Specifies the maximum value allowed for the initiative value when the user is adjusting the value on the Tactical Console. Default: "99".
|-
|interleave
|(Optional) Boolean – Indicates whether the evaluation cycles of all actors within the context of the same lead are interleaved, which governs the [[Minion and Master Relationships|behavior of minions and masters]]. If enabled, masters can influence changes upon their minions and minions can also influence changes upon their masters. If not enabled, masters all fully evaluated before minions, so the influence can only occur in the downward direction. Default: "no".
|-
|}

The "behavior" 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 links to access the details for each element.

:{| class="infotable"
|class="leftnormal"|[[#diceroller|diceroller]]
|A single "diceroller" element must appear as defined by the given link. This element customizes the integrated Dice Roller.
|-
|[[#leadsummary|leadsummary]]
|An optional "leadsummary" element may appear as defined by the given link. This element defines the [[LeadSummary Script]]. If omitted, default handling is employed.
|-
|[[#newcombat|newcombat]]
|An optional "newcombat" element may appear as defined by the given link. This element defines the [[NewCombat Script]]. If omitted, default handling is employed.
|-
|[[#newturn|newturn]]
|An optional "newturn" element may appear as defined by the given link. This element defines the [[NewTurn Script]]. If omitted, default handling is employed.
|-
|[[#integrate|integrate]]
|An optional "integrate" element may appear as defined by the given link. This element defines the [[Integrate Script]]. If omitted, default handling is employed.
|-
|[[#initiative|initiative]]
|An optional "initiative" element may appear as defined by the given link. This element defines the [[Initiative Script]]. If omitted, default handling is employed.
|-
|[[#initfinalize|initfinalize]]
|An optional "initfinalize" element may appear as defined by the given link. This element defines the [[InitFinalize Script]]. If omitted, default handling is employed.
|-
|[[#loaderror|loaderror]]
|An optional "loaderror" element may appear as defined by the given link. This element defines the [[LoadError Script]]. If omitted, default handling is employed.
|-
|[[#encounter|encounter]]
|An optional "encounter" element may appear as defined by the given link. This element defines fields used by the encounter builder. If omitted, default values are used.
|-
|}

==The "diceroller" Element{{anchor|diceroller}}==

The "diceroller" element defines characteristics of the [[Configuring the Dice Roller|integrated Dice Roller]] mechanisms when used with the game system. The complete list of attributes for a "diceroller" element is below.

:{| class="infotable"
|class="leftnormal"|mode
|(Optional) Set – Specifies the initial dice rolling mode to start out in for the game system. Must be one of the following:
<ul class="sets">
<li>totals – The dice rolled are added and that total is displayed.</li>
<li>successes – Each die rolled is compared against the threshold for declaring a success and the number of successes is displayed.</li>
<li>Default: "totals".</li>
</ul>
|-
|dietype
|Integer – Specifies the default die type to be rolled.
|-
|quantity
|(Optional) Integer – Specifies the default number of dice to be rolled. Default: "1".
|-
|success
|(Optional) Integer – Specifies the threshold value at which a success result is achieved. Game systems like World of Darkness and Shadowrun utilizes successes instead of adding the dice results. Default: "1".
|-
|explode
|(Optional) Integer – Specifies the threshold value at which a success result "explodes" by allowing a re-roll. If a value of zero is given, no explosion occurs. Default: "0".
|-
|maxexplode
|(Optional) Integer – Specifies the maximum number of times that a single roll may explode. A value of zero indicates that explosion is unlimited. Default: "0".
|-
|}

==The "leadsummary" Element{{anchor|leadsummary}}==

The "leadsummary" element defines the [[LeadSummary Script|LeadSummary script]] that is used to synthesize summary information for each actor. This summary is displayed when the user previews the available actors for import into the current portfolio.
The complete list of attributes for a "scriptmacro" element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the LeadSummary script.
|-
|}

==The "newcombat" Element{{anchor|newcombat}}==

The "newcombat" element defines the [[NewCombat Script|NewCombat script]] that is invoked whenever the user begins a new combat within the Tactical Console. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the NewCombat script.
|-
|}

==The "newturn" Element{{anchor|newturn}}==

The "newturn" element defines the [[NewTurn Script|NewTurn script]] that is invoked whenever the user starts a new turn of combat within the Tactical Console. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the NewTurn script.
|-
|}

==The "integrate" Element{{anchor|integrate}}==

The "integrate" element defines the [[Integrate Script|Integrate script]] that is invoked whenever the user integrates pending actors into an existing combat within the Tactical Console. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the Integrate script.
|-
|}

==The "initiative" Element{{anchor|initiative}}==

The "initiative" element defines the [[Initiative Script|Initiative script]] that is used to calculate the initiative score for each actor during combat. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the Initiative script.
|-
|}

==The "initfinalize" Element{{anchor|initfinalize}}==

The "initfinalize" element defines the [[InitFinalize Script|InitFinalize script]] that is used to tailor the final displayed text for the initiative score of each actor during combat. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the InitFinalize script.
|-
|}

==The "loaderror" Element{{anchor|loaderror}}==

The "loaderror" element defines the [[LoadError Script|LoadError script]] that is used to provide helpful information to the user about changes across releases of your data files and errors that can be safely ignored. The complete list of attributes for the element is below.

:{| class="infotable"
|class="leftnormal"|PCDATA
|Script – Specifies the code comprising the LoadError script.
|-
|}

==Example==

The following example demonstrates what a "behavior" element might look like. All default values are assumed for omitted optional attributes.

<pre>
<behavior
defaultname="Nobody"
interleave="yes">
<diceroller mode="totals" dietype="6" quantity="1"/>

<leadsummary><![CDATA[
~start with the race
var txt as string
txt = hero.firstchild["Race.?"].field[name].text
if (empty(txt) <> 0) then
txt = "No Race"
endif
@text &= txt

~append the CP rating of the character
@text &= " - CP: " & hero.child[resCP].field[resMax].value
]]></leadsummary>

<initiative><![CDATA[
~calculate the secondary initiative rating
@secondary = 0
~calculate the primary initiative rating
@initiative = random(10) + 1
]]></initiative>

</behavior>
</pre>

Style Element (Data)

2013-11-05T00:54:59Z

Michele: /* The "style_edit" Element{{anchor|edit}} */

{{context|Kit Reference|Structural File Reference}}

==The "style" Element==

All of the basic visual look and behaviors of portals is encapsulated in a [[Managing Styles|collection of styles]]. Each distinct category of portal has its own type of style, and you can only associate styles with portals of the corresponding type. Each separate style is specified through the use of a "style" element. The complete list of attributes for this element is below.

:{| class="infotable"
|class="leftnormal"|id
|Id – Specifies the unique id of the style. This id is used in all references to the style.
|-
|border
|(Optional) Id – Identifies the border to used in conjunction with this style. All portals may have a border drawn around them, and the border is controlled via the style. You can specify the unique id of the border to use or "none" to indicate no border. Default: "none"
|-
|}

The "style" element also possesses child elements that define the specifics of the style. 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.

{{important}}With the exception of the "resource" element, exactly '''one''' of these child elements may be specified for each style. If multiple are given, a compiler error will be reported. The chosen child element dictates the type of style that is being defined. You may include as many "resource" elements as you wish after the single child element that specifies the style.

:{| class="infotable"
|class="leftnormal"|[[#label|style_label]]
|An optional "style_label" element may appear as defined by the given link. This element specifies the details of a style for use with label portals.
|-
|[[#image|style_image]]
|An optional "style_image" element may appear as defined by the given link. This element specifies the details of a style for use with image portals.
|-
|[[#edit|style_edit]]
|An optional "style_edit" element may appear as defined by the given link. This element specifies the details of a style for use with edit portals.
|-
|[[#checkbox|style_checkbox]]
|An optional "style_checkbox" element may appear as defined by the given link. This element specifies the details of a style for use with checkbox portals.
|-
|[[#menu|style_menu]]
|An optional "style_menu" element may appear as defined by the given link. This element specifies the details of a style for use with menu portals.
|-
|[[#action|style_action]]
|An optional "style_action" element may appear as defined by the given link. This element specifies the details of a style for use with action portals.
|-
|[[#x|style_incrementer]]
|An optional "style_incrementer" element may appear as defined by the given link. This element specifies the details of a style for use with incrementer portals.
|-
|[[#chooser|style_chooser]]
|An optional "style_chooser" element may appear as defined by the given link. This element specifies the details of a style for use with chooser portals.
|-
|[[#region|style_region]]
|An optional "style_region" element may appear as defined by the given link. This element specifies the details of a style for use with region portals.
|-
|[[#table|style_table]]
|An optional "style_table" element may appear as defined by the given link. This element specifies the details of a style for use with table portals.
|-
|[[#separator|style_separator]]
|An optional "style_separator" element may appear as defined by the given link. This element specifies the details of a style for use with separator portals.
|-
|[[#special|style_special]]
|An optional "style_special" element may appear as defined by the given link. This element specifies the details of a style for use with special portals.
|-
|[[#output|style_output]]
|An optional "style_output" element may appear as defined by the given link. This element specifies the details of a style for use with output portals.
|-
|[[Resource Element (Data)|resource]]
|Zero or more "resource" elements may appear as defined by the given link. This element specifies new resources that are used in conjunction with the style.
|-
|}

==Colors in Styles{{anchor|colors}}==

Many styles allow you to directly specify a color value in the format "xxxxxx". The format for the color uses standard HTML color syntax, with each character representing a hexadecimal digit. The first two characters define the Red color value, the next two Green, and the last two Blue. For example, the color "ff0080" specifies a Red value of "ff", a Green value of "00", and a Blue value of "80".

For additional details on specifying colors via the HTML syntax, please refer to one of the many websites that provide this information, such as
[http://www.w3schools.com/Html/html_colors.asp http://www.w3schools.com/Html/html_colors.asp].

==Scaling of Images{{anchor|scaling}}==

When encoded text is supported within a category of portal, you will typically be given control over the scaling of images within the corresponding style. When enabled, image scaling is applied to all bitmaps that are inserted into the encoded text that is rendered into the portal. The scaling ratio is based on the difference between the initial font size for the portal and the current font size at which the text is now being rendered. Scaling is valuable for when you want to ensure that the bitmaps remain proportionally sized relative to the font size of the text, which is important when text and bitmaps are interleaved within the encoded text.

==The "style_label" Element{{anchor|label}}==

The "style_label" element defines the facets of a style for label portals. The complete list of attributes for this element is below.

:{| class="infotable"
|class="leftnormal"|font
|Id – Unique id of the font resource to be used for the style.
|-
|textcolor
|(Optional) Text – Color value to be used for drawing text in the format "xxxxxx" ([[#colors|see above]]). If omitted, the "textcolorid" attribute must be specified. Default: Empty.
|-
|textcolorid
|(Optional) Id – Unique id of the color resource to be used for drawing text. If omitted, the "textcolor" attribute must be specified. Default: Empty.
|-
|background
|(Optional) Id – Unique id of the bitmap resource to use as the background. If omitted, the text is drawn transparently on the existing background region. Default: Empty.
|-
|alignment
|(Optional) Set – Specifies how the text should be horizontally aligned within the portal width. Must be one of these values:
<ul class="sets">
<li>left – Text is left-aligned.</li>
<li>center – Text is centered within the portal.</li>
<li>right – Text is right-aligned.</li>
<li>Default: "left".</li>
</ul>
|-
|ispattern
|(Optional) Boolean – Indicates whether the background bitmap should be centered within the portal dimensions or tiled to fill the entire portal. Default: "yes".
|-
|scaleimage
|(Optional) Boolean – Indicates whether bitmaps included within encoded text are scaled ([[#scaling|see above]]). Default: "no".
|-
|}

==The "style_image" Element{{anchor|image}}==

The "style_image" element defines the facets of a style for image portals. Since image portals simply contain the image and nothing else, there are no special attributes for this element.

==The "style_edit" Element{{anchor|edit}}==

The "style_edit" element defines the facets of a style for edit portals. The complete list of attributes for this element is below.

:{| class="infotable"
|class="leftnormal"|font
|Id – Unique id of the font resource to be used for the style.
|-
|textcolor
|(Optional) Text – Color value to be used for drawing text in the format "xxxxxx" ([[#colors|see above]]). If omitted, the "textcolorid" attribute must be specified. Default: Empty.
|-
|textcolorid
|(Optional) Id – Unique id of the color resource to be used for drawing text. If omitted, the "textcolor" attribute must be specified. Default: Empty.
|-
|backcolor
|(Optional) Text – Color value to be used as the background in the format "xxxxxx" ([[#colors|see above]]). If omitted, the "backcolorid" attribute must be specified. Default: Empty.
|-
|backcolorid
|(Optional) Id – Unique id of the color resource to be used as the background. If omitted, the "backcolor" attribute must be specified. Default: Empty.
|-
|placeholdercolorid
|(Optional) Id – Unique id of the color resource to be used for the placeholder text. If omitted, the system "Disabled" color will be used.
|-
|alignment
|(Optional) Set – Specifies how the text should be horizontally aligned within the portal width. Must be one of these values:
<ul class="sets">
<li>left – Text is left-aligned.</li>
<li>center – Text is centered within the portal.</li>
<li>right – Text is right-aligned.</li>
<li>Default: "left".</li>
</ul>
|-
|autoselect
|(Optional) Set – Indicates whether to automatically select the entire text contents of the portal when it gains the focus. Must be one of the following:
<ul class="sets">
<li>yes – Contents are always automatically selected when focus is gained.</li>
<li>no – Contents are never selected when focus is gained.</li>
<li>default – Default handling is performed. If the edit portal contains a numeric field, the contents are automatically selected, but no selection is performed for text-based fields.</li>
<li>Default: "default".</li>
|-
|itemborder
|(Optional) Id – Unique id of the border resource to draw around each individual edit cell for an "edit_date" portal. If "none", no border is drawn. Default: "none".<br>
{{note}}An "edit_date" portal can be assigned '''either''' an item border '''or''' a border around the entire portal, but never both.
|-
|septext
|(Optional) Text – Specifies the text to be drawn between each individual edit cell for an "edit_date" portal. Default: "/".
|-
|sepfont
|(Optional) Id – Unique id of the font resource to be used for drawing the separator text between individual cells for an "edit_date" portal. If empty, the resource specified by the "font" attribute is assumed. Default: Empty.
|-
|sepcolor
|(Optional) Text – Color value to be used for drawing the separator text in the format "xxxxxx" ([[#colors|see above]]). If omitted, the "sepcolorid" attribute must be specified. Default: Empty.
|-
|sepcolorid
|(Optional) Id – Unique id of the color resource to be used for drawing the separator text. If omitted, the "sepcolor" attribute must be specified. Default: Empty.
|-
|}

==The "style_checkbox" Element{{anchor|checkbox}}==

The "style_checkbox" element defines the facets of a style for checkbox portals. The complete list of attributes for this element is below.

:{| class="infotable"
|class="leftnormal"|font
|Id – Unique id of the font resource to be used for the style.
|-
|textcolor
|(Optional) Text – Color value to be used for drawing text in the format "xxxxxx" ([[#colors|see above]]). If omitted, the "textcolorid" attribute must be specified. Default: Empty.
|-
|textcolorid
|(Optional) Id – Unique id of the color resource to be used for drawing text. If omitted, the "textcolor" attribute must be specified. Default: Empty.
|-
|scaleimage
|(Optional) Boolean – Indicates whether bitmaps included within encoded text are scaled ([[#scaling|see above]]). Default: "no".
|-
|check
|(Optional) Id – Unique id of the bitmap resource used to indicate the box is checked. If omitted, a default bitmap it used. Default: Empty.
|-
|checkoff
|(Optional) Id – Unique id of the bitmap resource used to indicate the box is checked when the portal is disabled. If omitted, a default bitmap it used. Default: Empty.
|-
|uncheck
|(Optional) Id – Unique id of the bitmap resource used to indicate the box is not checked. If omitted, a default bitmap it used. Default: Empty.
|-
|uncheckoff
|(Optional) Id – Unique id of the bitmap resource used to indicate the box is not checked when the portal is disabled. If omitted, a default bitmap it used. Default: Empty.
|-
|}

==The "style_menu" Element{{anchor|menu}}==

The "style_menu" element defines the facets of a style for menu portals. The complete list of attributes for this element is below.

:{| class="infotable"
|class="leftnormal"|font
|Id – Unique id of the font resource to be used for the style.
|-
|textcolor
|(Optional) Text – Color value to be used for drawing text in the format "xxxxxx" ([[#colors|see above]]). If omitted, the "textcolorid" attribute must be specified. Default: Empty.
|-
|textcolorid
|(Optional) Id – Unique id of the color resource to be used for drawing text. If omitted, the "textcolor" attribute must be specified. Default: Empty.
|-
|backcolor
|(Optional) Text – Color value to be used as the background in the format "xxxxxx" ([[#colors|see above]]). If omitted, the "backcolorid" attribute must be specified. Default: Empty.
|-
|backcolorid
|(Optional) Id – Unique id of the color resource to be used as the background. If omitted, the "backcolor" attribute must be specified. Default: Empty.
|-
|selecttext
|(Optional) Text – Color value to be used for drawing text of the selected item when the menu is "dropped" in the format "xxxxxx" ([[#colors|see above]]). If omitted, the "selecttextid" attribute must be specified. Default: Empty.
|-
|selecttextid
|(Optional) Id – Unique id of the color resource to be used for drawing text of the selected item when the menu is "dropped". If omitted, the "textcolor" attribute must be specified. Default: Empty.
|-
|selectback
|(Optional) Text – Color value to be used as the background of the selected item when the menu is "dropped" in the format "xxxxxx" ([[#colors|see above]]). If omitted, the "selectbackid" attribute must be specified. Default: Empty.
|-
|selectbackid
|(Optional) Id – Unique id of the color resource to be used as the background of the selected item when the menu is "dropped". If omitted, the "backcolor" attribute must be specified. Default: Empty.
|-
|activetext
|(Optional) Text – Color value to be used for drawing text of the selected item in the format "xxxxxx" ([[#colors|see above]]). This color is only used within the "non-dropped" region of the menu and allows the color highlighting of invalid menu items without impacting the behavior of the "dropped" menu. If omitted, the "selectbackid" attribute may be specified. If neither color is specified, the "selecttext" color is used. Default: Empty.
|-
|activetextid
|(Optional) Id – Unique id of the color resource to be used as the background of the selected item. See the "activetext" attribute above for further details. If omitted, the "activetext" attribute may be specified. Default: Empty.
|-
|droplist
|(Optional) Id – Unique id of the bitmap to be used for the drop arrow on the right when the menu is enabled. If omitted, the system default bitmap is used. Default: Empty.
|-
|droplistoff
|(Optional) Id – Unique id of the bitmap to be used for the drop arrow on the right when the menu is disabled. If omitted, the system default bitmap is used. Default: Empty.
|-
|scaleimage
|(Optional) Boolean – Indicates whether bitmaps included within encoded text are scaled ([[#scaling|see above]]). Default: "no".
|-
|}

==The "style_action" Element{{anchor|action}}==

The "style_action" element defines the facets of a style for action portals (typically used as clickable buttons). The complete list of attributes for this element is below.

:{| class="infotable"
|class="leftnormal"|font
|Id – Unique id of the font resource to be used for the style.
|-
|textcolor
|(Optional) Text – Color value to be used for drawing text in the format "xxxxxx" ([[#colors|see above]]). If omitted, the "textcolorid" attribute must be specified. Default: Empty.
|-
|textcolorid
|(Optional) Id – Unique id of the color resource to be used for drawing text. If omitted, the "textcolor" attribute must be specified. Default: Empty.
|-
|up
|Id – Unique id of the bitmap resource to be used as the "up" state of the action portal.
|-
|down
|Id – Unique id of the bitmap resource to be used as the "down" state of the action portal.
|-
|off
|Id – Unique id of the bitmap resource to be used as the "up" state of the action portal when the portal is disabled.
|-
|xoffset
|(Optional) Integer – Specifies the offset adjustment of any text along the horizontal X axis. The text is centered along the axis and can be shifted left or right via this attribute, with positive values shifting to the right and negative values shifting left. Default: "0".
|-
|yoffset
|(Optional) Integer – Specifies the offset adjustment of any text along the vertical Y axis. The text is centered along the axis and can be shifted up or down via this attribute, with positive values shifting downward and negative values shifting upward. Default: "0".
|-
|}

==The "style_incrementer" Element{{anchor|incrementer}}==

The "style_incrementer" element defines the facets of a style for incrementer portals. The complete list of attributes for this element is below.

:{| class="infotable"
|class="leftnormal"|font
|Id – Unique id of the font resource to be used for the style.
|-
|textcolor
|(Optional) Text – Color value to be used for drawing text in the format "xxxxxx" ([[#colors|see above]]). If omitted, the "textcolorid" attribute must be specified. Default: Empty.
|-
|textcolorid
|(Optional) Id – Unique id of the color resource to be used for drawing text. If omitted, the "textcolor" attribute must be specified. Default: Empty.
|-
|(Optional) background
|Id – Unique id of the bitmap resource to be used as the background. If empty, the portal has no background and is drawn transparently. Default: Empty.
{{note}}If a background bitmap is specified, the incrementer size is dictated by the dimensions of the bitmap. If not specified, then the dimensions must be specified via the "fullwidth" and "fullheight" attributes.
|-
|fullwidth
|(Optional) Integer – Specifies the fixed width to utilize for all incrementers assigned this style. If "0", a background must be specified to dictate the dimensions. Default: "0".
|-
|fullheight
|(Optional) Integer – Specifies the fixed height to utilize for all incrementers assigned this style. If "0", a background must be specified to dictate the dimensions. Default: "0".
|-
|textleft
|Integer – Specifies the left edge of the region in which text is drawn within the incrementer.
|-
|texttop
|Integer – Specifies the top edge of the region in which text is drawn within the incrementer.
|-
|textwidth
|Integer – Specifies the width of the region in which text is drawn within the incrementer.
|-
|textheight
|Integer – Specifies the height of the region in which text is drawn within the incrementer.
|-
|plusup
|Id – Unique id of the bitmap resource to be used for the "+" button in its "up" state.
|-
|plusdown
|Id – Unique id of the bitmap resource to be used for the "+" button in its "down" state.
|-
|plusoff
|Id – Unique id of the bitmap resource to be used for the "+" button in its "up" state when the incrementer is disabled.
|-
|plusx
|Integer – Specifies the offset along the horizontal X axis where the "+" button is positioned within the overall incrementer portal.
|-
|plusy
|Integer – Specifies the offset along the vertical Y axis where the "+" button is positioned within the overall incrementer portal.
|-
|minusup
|Id – Unique id of the bitmap resource to be used for the "-" button in its "up" state.
|-
|minusdown
|Id – Unique id of the bitmap resource to be used for the "-" button in its "down" state.
|-
|minusoff
|Id – Unique id of the bitmap resource to be used for the "-" button in its "up" state when the incrementer is disabled.
|-
|minusx
|Integer – Specifies the offset along the horizontal X axis where the "-" button is positioned within the overall incrementer portal.
|-
|minusy
|Integer – Specifies the offset along the vertical Y axis where the "-" button is positioned within the overall incrementer portal.
|-
|editable
|(Optional) Boolean – Indicates whether the incrementer value can be directly user-edited by clicking within the value region. Disabling this can be useful when the value does not correspond to what is displayed, such as when selecting a die type (e.g. d6, d8, d10). Default: "yes".
|-
|scaleimage
|(Optional) Boolean – Indicates whether bitmaps included within encoded text are scaled ([[#scaling|see above]]). Default: "no".
|-
|}

==The "style_chooser" Element{{anchor|chooser}}==

The "style_chooser" element defines the facets of a style for chooser portals. The complete list of attributes for this element is below.

:{| class="infotable"
|class="leftnormal"|font
|Id – Unique id of the font resource to be used for the style.
|-
|textcolor
|(Optional) Text – Color value to be used for drawing text in the format "xxxxxx" ([[#colors|see above]]). If omitted, the "textcolorid" attribute must be specified. Default: Empty.
|-
|textcolorid
|(Optional) Id – Unique id of the color resource to be used for drawing text. If omitted, the "textcolor" attribute must be specified. Default: Empty.
|-
|backcolor
|(Optional) Text – Color value to be used as the background in the format "xxxxxx" ([[#colors|see above]]). If omitted, the "backcolorid" attribute must be specified. Default: Empty.
|-
|backcolorid
|(Optional) Id – Unique id of the color resource to be used as the background. If omitted, the "backcolor" attribute must be specified. Default: Empty.
|-
|scaleimage
|(Optional) Boolean – Indicates whether bitmaps included within encoded text are scaled ([[#scaling|see above]]). Default: "no".
|-
|}

==The "style_region" Element{{anchor|region}}==

The "style_region" element defines the facets of a style for region portals. The complete list of attributes for this element is below.

:{| class="infotable"
|class="leftnormal"|(Optional) background
|Id – Unique id of the bitmap resource to be used as the background for the region. If empty, the portal has no background and is drawn transparently. Default: Empty.
|-
|}

==The "style_table" Element{{anchor|table}}==

The "style_table" element defines the facets of a style for table portals. The complete list of attributes for this element is below.

:{| class="infotable"
|class="leftnormal"|(Optional) background
|Id – Unique id of the bitmap resource to be used as the background for the table. If empty, the portal has no background and is drawn transparently. Default: Empty.
|-
|itemborder
|(Optional) Id – Unique id of the bitmap resource to be used as a border around each individual item inside the table. If empty, no border is drawn. Default: Empty.
|-
|showgridhorz
|(Optional) Boolean – Indicates whether horizontal grid lines should be drawn between each item within the table. Default: "no".
|-
|showgridvert
|(Optional) Boolean – Indicates whether vertical grid lines should be drawn between each item within the table. Default: "no".
|-
|gridwidth
|(Optional) Integer – Thickness of the grid lines drawn between items within the table (in pixels). The thickness of both horizontal and vertical grid lines is always the same. Default: "1".
|-
|gridcolor
|(Optional) Text – Color value to be used for drawing grid lines in the format "xxxxxx" ([[#colors|see above]]). Default: "888888".
|-
|gridcolorid
|(Optional) Id – Unique id of the color resource to be used for drawing grid lines. If specified, the default value for the "gridcolor" attribute is ignored. Default: Empty.
|-
|}

==The "style_separator" Element{{anchor|separator}}==

The "style_separator" element defines the facets of a style for separator portals. The complete list of attributes for this element is below.

:{| class="infotable"
|class="leftnormal"|isvertical
|(Optional) Boolean – Indicates whether the separator is oriented vertically or horizontally. Default: "no".
|-
|start
|Id – Unique id of the bitmap resource to be used at the left/top end of the separator.
|-
|end
|Id – Unique id of the bitmap resource to be used at the right/bottom end of the separator.
|-
|center
|Id – Unique id of the bitmap resource to be used in the middle of the separator. This bitmap is tiled as necessary to fill the entire span of the separator.
|-
|}

==The "style_special" Element{{anchor|special}}==

The "style_special" element defines the facets of a style for special portals. Due to its nature, there are no attributes for this element.

==The "style_output" Element{{anchor|output}}==

The "style_output" element defines the facets of a style for output portals. The complete list of attributes for this element is below.

:{| class="infotable"
|class="leftnormal"|font
|Id – Unique id of the font resource to be used for the style.
|-
|textcolor
|(Optional) Text – Color value to be used for drawing text in the format "xxxxxx" ([[#colors|see above]]). If omitted, the "textcolorid" attribute must be specified. Default: Empty.
|-
|textcolorid
|(Optional) Id – Unique id of the color resource to be used for drawing text. If omitted, the "textcolor" attribute must be specified. Default: Empty.
|-
|backcolor
|(Optional) Text – Color value to be used as the background in the format "xxxxxx" ([[#colors|see above]]). If omitted, the "backcolorid" attribute must be specified. Default: Empty.
|-
|backcolorid
|(Optional) Id – Unique id of the color resource to be used as the background. If omitted, the "backcolor" attribute must be specified. Default: Empty.
|-
|alignment
|(Optional) Set – Specifies how the text should be horizontally aligned within the portal width (for labels). Must be one of these values:
<ul class="sets">
<li>left – Text is left-aligned.</li>
<li>center – Text is centered within the portal.</li>
<li>right – Text is right-aligned.</li>
<li>Default: "left".</li>
</ul>
|-
|(Optional) background
|Id – Unique id of the bitmap resource to be used as the background for tables. If empty, the portal has no background and is drawn transparently. Default: Empty.
|-
|itemborder
|(Optional) Id – Unique id of the bitmap resource to be used as a border around each individual item inside a table. If empty, no border is drawn. Default: Empty.
|-
|showgridhorz
|(Optional) Boolean – Indicates whether horizontal grid lines should be drawn between each item within a table. Default: "no".
|-
|showgridvert
|(Optional) Boolean – Indicates whether vertical grid lines should be drawn between each item within a table. Default: "no".
|-
|gridwidth
|(Optional) Integer – Thickness of the grid lines drawn between items within a table (in pixels). The thickness of both horizontal and vertical grid lines is always the same. Default: "1".
|-
|gridcolor
|(Optional) Text – Color value to be used for drawing grid lines in the format "xxxxxx" ([[#colors|see above]]). Default: "888888".
|-
|gridcolorid
|(Optional) Id – Unique id of the color resource to be used for drawing grid lines. If specified, the default value for the "gridcolor" attribute is ignored. Default: Empty.
|-
|}

==Example==

The following example demonstrates what various "style" elements might look like. All default values are assumed for optional attributes.

<pre>
<style id="label">
<style_label textcolor="f0f0f0" font="fntnormal" alignment="center"/>
</style>

<style id="edit" border="sunken">
<style_edit textcolor="d2d2d2" backcolor="000000" font="fntedit" alignment="center"/>
</style>

<style id="increment">
<style_incrementer textcolor="f0f0f0" font="fntincrsim"
textleft="13" texttop="0" textwidth="24" textheight="20"
fullwidth="50" fullheight="20"
plusup="incplusup" plusdown="incplusdn" plusoff="incplusof"
plusx="39" plusy="0"
minusup="incminusup" minusdown="incminusdn" minusoff="incminusof"
minusx="0" minusy="0">
</style_incrementer>
</style>

<style id="action">
<style_action textcolor="000088" font="fntactbig"
up="actbigup" down="actbigdn" off="actbigof">
</style_action>
<resource id="actbigup" isbuiltin="yes">
<bitmap bitmap="button_big_up.bmp"/>
</resource>
<resource id="actbigdn" isbuiltin="yes">
<bitmap bitmap="button_big_down.bmp"/>
</resource>
<resource id="actbigof" isbuiltin="yes">
<bitmap bitmap="button_big_off.bmp"/>
</resource>
</style>

<style id="table" border="brdsystem">
<style_table itemborder="sunken" showgridhorz="yes" gridcolor="808080"/>
</style>

<style id="checkbox">
<style_checkbox textcolor="f0f0f0" font="fntcheck"/>
</style>

<style id="image" border="brdsystem">
<style_image/>
</style>

<style id="menu" border="sunken">
<style_menu font="fntmenu" textcolor="84c8f7" backcolor="2a2c47"
selecttext="1414f7" selectback="f0f0f0"/>
</style>

<style id="separator">
<style_separator isvertical="no"
start="sephorzsta" center="sephorzmid" end="sephorzend"/>
<resource id="sephorzsta" isbuiltin="yes">
<bitmap bitmap="sep_horz_start.bmp"/>
</resource>
<resource id="sephorzmid" isbuiltin="yes">
<bitmap bitmap="sep_horz_middle.bmp"/>
</resource>
<resource id="sephorzend" isbuiltin="yes">
<bitmap bitmap="sep_horz_end.bmp"/>
</resource>
</style>

<style id="region" border="brdsystem">
<style_region/>
</style>

</pre>

Edit Element (Data)

2013-11-05T00:49:07Z

Michele: /* The "edit" Element */

{{context|Kit Reference|Data File Reference|Portal Element (Data)}}

==The "edit" Element==

The "edit" element is used to allow the user to directly enter a value or text that is then saved into a field. This portal is ideal for allowing the user to enter names or descriptions, as well as entering a wide-ranging or arbitrary value. The complete list of attributes for this element is below.

:{| class="infotable"
|class="leftnormal"|field
|Id – Specifies the unique id of the field where the contents to be edited are both retrieved and stored. The field must exist within the pick/thing associated with the containing template. If this portal is not defined within a template, an edit portal is not allowed.
|-
|maxlength
|(Optional) Integer – Specifies the maximum number of characters that can be entered for this field. If zero, a numeric value will be edited. Default: "0".
|-
|ismultiline
|(Optional) Boolean – Indicates whether the field should be edited as if it contains multi-line text. This attribute only applies to text-based edit portals. Default: "no".
|-
|readonly
|(Optional) Boolean – Indicates whether the information within the portal can be edited by the user or is displayed as read-only. Default: "no".
|-
|format
|(Optional) Set – Designates any special numeric formatting to be enforced for a value-based field. Must be one of these values:
<ul class="sets">
<li>integer – The contents are edited as an integer value.</li>
<li>float – The contents are edited as a floating-point value.</li>
<li>any – No restrictions are imposed on the contents.</li>
<li>Default: "any".</li>
</ul>
|-
|signed
|(Optional) Boolean – Indicates whether the user can specify a negative value when a value-based field is being edited. Default: "no".
|-
|placeholdertext
|(Optional) – A hint describing what the user should enter. It will appear in the edit control when the control is empty.
|-
|}

==Example==

The following example demonstrates what an edit portal might look like. All default values are assumed for optional attributes.

<pre>
<portal id="hair" style="editNormal">
<edit field="perHair"/>
</portal>
</pre>