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...)
 
(Trigger)
 
(11 intermediate revisions by the same user not shown)
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}}
+
==Pick Manipulation==
 +
 
 +
These scripts manipulate the contents of picks during the evaluation cycle.
  
*{{fl|Position Script}}
 
*{{fl|Description Script}}
 
 
*{{fl|Eval Script}}
 
*{{fl|Eval Script}}
 +
*{{fl|Gear Script}}
 +
 +
==Field Manipulation==
 +
 +
These scripts manipulate the contents of fields for both display and constraint.
 +
 +
*{{fl|Bound Script}}
 +
*{{fl|Calculate Script}}
 +
*{{fl|Finalize Script}}
 +
*{{fl|InitFinalize Script}}
 +
 +
==Validation==
 +
 +
These scripts apply validation tests to objects with integrated reporting of errors.
 +
 
*{{fl|EvalRule Script}}
 
*{{fl|EvalRule Script}}
*{{fl|HeaderTitle Script}}
+
*{{fl|Validate Script}}
*{{fl|Trigger Script}}
+
*{{fl|Integrity Script}}
 +
 
 +
==Creation/Deletion==
 +
 
 +
These scripts perform appropriate setup and cleanup of specialized objects.
 +
 
 +
*{{fl|Creation Script}}
 +
*{{fl|Deletion Script}}
 +
 
 +
==Visual Positioning==
 +
 
 +
These scripts manage the size and positioning of visual elements within panels and sheets.
 +
 
 +
*{{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|Description Script}}
 
*{{fl|MouseInfo Script}}
 
*{{fl|MouseInfo Script}}
*{{fl|Titlebar Script}}
 
 
*{{fl|Label Script}}
 
*{{fl|Label Script}}
 +
*{{fl|TitleBar Script}}
 +
*{{fl|HeaderTitle Script}}
 +
*{{fl|AddItem Script}}
 +
*{{fl|Chosen Script}}
 +
*{{fl|LeadSummary Script}}
 +
*{{fl|Synthesize 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|Integrate Script}}
 
*{{fl|NewCombat Script}}
 
*{{fl|NewCombat Script}}
 +
*{{fl|EndCombat Script}}
 
*{{fl|NewTurn Script}}
 
*{{fl|NewTurn Script}}
 +
*{{fl|Initiative Script}}
 +
*{{fl|Merge Script}}
 +
*{{fl|Split Script}}
 
*{{fl|Change Script}}
 
*{{fl|Change Script}}
*{{fl|Chosen Script}}
+
 
*{{fl|Creation Script}}
+
==Transaction==
 +
 
 +
These scripts are associated with the buying and selling of equipment.
 +
 
 
*{{fl|TransactSetup Script}}
 
*{{fl|TransactSetup Script}}
 
*{{fl|TransactBuy Script}}
 
*{{fl|TransactBuy Script}}
 
*{{fl|TransactSell Script}}
 
*{{fl|TransactSell Script}}
*{{fl|Bound Script}}
+
 
*{{fl|Calculate Script}}
+
==Mode Transition==
*{{fl|Finalize Script}}
+
 
*{{fl|Validate Script}}
+
These scripts associated with the transition into and out of advancement mode.
*{{fl|AddItem Script}}
+
 
 
*{{fl|CanAdvance Script}}
 
*{{fl|CanAdvance Script}}
 
*{{fl|Transition Script}}
 
*{{fl|Transition Script}}
*{{fl|Initiative Script}}
+
 
*{{fl|LeadSummary Script}}
+
==Release Changes==
*{{fl|Deletion Script}}
+
 
 +
These scripts are used to accommodate changes between data file releases and potential loading errors of portfolios.
 +
 
 +
*{{fl|LoadError Script}}
 
*{{fl|LoadFixup Script}}
 
*{{fl|LoadFixup Script}}
*{{fl|Merge Script}}
 
*{{fl|Split Script}}
 
*{{fl|Synthesize Script}}
 
*{{fl|Integrity Script}}
 
*{{fl|Dossier Script}}
 
*{{fl|Header Script}}
 
*{{fl|Gear Script}}
 

Latest revision as of 01:15, 12 May 2009

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.

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.

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.

Trigger

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

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.

Release Changes

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