Difference between revisions of "Script Types"

From HLKitWiki
Jump to: navigation, search
(New page: {{context|Kit Reference}} The Kit leverages a diverse assortment of scripts for a wide range of purposes. The topics below provide a brief discussion of both the role and behavior of each...)
 
Line 1: Line 1:
 
{{context|Kit Reference}}
 
{{context|Kit Reference}}
  
The Kit leverages a diverse assortment of scripts for a wide range of purposes. The topics below provide a brief discussion of both the role and behavior of each different type of script.
+
The Kit leverages a diverse assortment of scripts for a wide range of purposes. The topics below provide a brief discussion of both the role and behavior of each different type of script. The scripts have been grouped into general categories for improved utility.
  
 
{{tbd}}
 
{{tbd}}
 +
 +
==Visual Positioning==
 +
 +
These scripts manage the size and positioning of visual elements within panels and sheets.
  
 
*{{fl|Position Script}}
 
*{{fl|Position Script}}
 +
*{{fl|Header Script}}
 +
 +
==Synthesis & Presentation==
 +
 +
These scripts synthesize information for display to the user in some fashion, including labels, descriptions, mouse-over information, and stat blocks.
 +
 +
*{{fl|Label Script}}
 
*{{fl|Description Script}}
 
*{{fl|Description Script}}
*{{fl|Eval Script}}
 
*{{fl|EvalRule Script}}
 
*{{fl|HeaderTitle Script}}
 
*{{fl|Trigger Script}}
 
 
*{{fl|MouseInfo Script}}
 
*{{fl|MouseInfo Script}}
 
*{{fl|Titlebar Script}}
 
*{{fl|Titlebar Script}}
*{{fl|Label Script}}
+
*{{fl|HeaderTitle Script}}
*{{fl|Integrate Script}}
+
*{{fl|AddItem Script}}
*{{fl|NewCombat Script}}
+
*{{fl|NewTurn Script}}
+
*{{fl|Change Script}}
+
 
*{{fl|Chosen Script}}
 
*{{fl|Chosen Script}}
*{{fl|Creation Script}}
+
*{{fl|LeadSummary Script}}
*{{fl|TransactSetup Script}}
+
*{{fl|Synthesize Script}}
*{{fl|TransactBuy Script}}
+
 
*{{fl|TransactSell Script}}
+
==Pick Manipulation==
 +
 
 +
These scripts manipulate the contents of picks during the evaluation cycle.
 +
 
 +
*{{fl|Eval Script}}
 +
*{{fl|Gear Script}}
 +
 
 +
==Field Manipulation==
 +
 
 +
These scripts manipulate the contents of fields for both display and constraint.
 +
 
 
*{{fl|Bound Script}}
 
*{{fl|Bound Script}}
 
*{{fl|Calculate Script}}
 
*{{fl|Calculate Script}}
 
*{{fl|Finalize Script}}
 
*{{fl|Finalize Script}}
 +
 +
==Validation==
 +
 +
These scripts apply validation tests to objects with integrated reporting of errors.
 +
 +
*{{fl|EvalRule Script}}
 +
*{{fl|Integrity Script}}
 
*{{fl|Validate Script}}
 
*{{fl|Validate Script}}
*{{fl|AddItem Script}}
+
 
 +
==Creation/Deletion==
 +
 
 +
These scripts perform appropriate setup and cleanup of specialized objects.
 +
 
 +
*{{fl|Creation Script}}
 +
*{{fl|Deletion Script}}
 +
 
 +
==Transaction==
 +
 
 +
These scripts are associated with the buying and selling of equipment.
 +
 
 +
*{{fl|TransactSetup Script}}
 +
*{{fl|TransactBuy Script}}
 +
*{{fl|TransactSell Script}}
 +
 
 +
==Mode Transition==
 +
 
 +
These scripts associated with the transition into and out of advancement mode.
 +
 
 
*{{fl|CanAdvance Script}}
 
*{{fl|CanAdvance Script}}
 
*{{fl|Transition Script}}
 
*{{fl|Transition Script}}
 +
 +
==Trigger==
 +
 +
These scripts are invoked in direct response to user actions, such as merging and splitting stackable gear, controlling combat and turns, etc.
 +
 +
*{{fl|Trigger Script}}
 +
*{{fl|Integrate Script}}
 +
*{{fl|NewCombat Script}}
 +
*{{fl|NewTurn Script}}
 
*{{fl|Initiative Script}}
 
*{{fl|Initiative Script}}
*{{fl|LeadSummary Script}}
 
*{{fl|Deletion Script}}
 
*{{fl|LoadFixup Script}}
 
 
*{{fl|Merge Script}}
 
*{{fl|Merge Script}}
 
*{{fl|Split Script}}
 
*{{fl|Split Script}}
*{{fl|Synthesize Script}}
+
*{{fl|Change Script}}
*{{fl|Integrity Script}}
+
 
*{{fl|Dossier Script}}
+
==Fixup==
*{{fl|Header Script}}
+
 
*{{fl|Gear Script}}
+
These scripts are used to accommodate changes between data file releases and potential loading errors of portfolios.
 +
 
 +
*{{fl|LoadFixup Script}}

Revision as of 05:06, 7 December 2008

Context: HL KitKit Reference 

The Kit leverages a diverse assortment of scripts for a wide range of purposes. The topics below provide a brief discussion of both the role and behavior of each different type of script. The scripts have been grouped into general categories for improved utility.

[TBD] 

Visual Positioning

These scripts manage the size and positioning of visual elements within panels and sheets.

Synthesis & Presentation

These scripts synthesize information for display to the user in some fashion, including labels, descriptions, mouse-over information, and stat blocks.

Pick Manipulation

These scripts manipulate the contents of picks during the evaluation cycle.

Field Manipulation

These scripts manipulate the contents of fields for both display and constraint.

Validation

These scripts apply validation tests to objects with integrated reporting of errors.

Creation/Deletion

These scripts perform appropriate setup and cleanup of specialized objects.

Transaction

These scripts are associated with the buying and selling of equipment.

Mode Transition

These scripts associated with the transition into and out of advancement mode.

Trigger

These scripts are invoked in direct response to user actions, such as merging and splitting stackable gear, controlling combat and turns, etc.

Fixup

These scripts are used to accommodate changes between data file releases and potential loading errors of portfolios.