Difference between revisions of "Script Types"

From HLKitWiki
Jump to: navigation, search
(Trigger)
 
(10 intermediate revisions by the same user not shown)
Line 2: Line 2:
  
 
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.
 
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.
 
 
*{{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|MouseInfo Script}}
 
*{{fl|Titlebar Script}}
 
*{{fl|HeaderTitle Script}}
 
*{{fl|AddItem Script}}
 
*{{fl|Chosen Script}}
 
*{{fl|LeadSummary Script}}
 
*{{fl|Synthesize Script}}
 
  
 
==Pick Manipulation==
 
==Pick Manipulation==
Line 40: Line 17:
 
*{{fl|Calculate Script}}
 
*{{fl|Calculate Script}}
 
*{{fl|Finalize Script}}
 
*{{fl|Finalize Script}}
 +
*{{fl|InitFinalize Script}}
  
 
==Validation==
 
==Validation==
Line 46: Line 24:
  
 
*{{fl|EvalRule Script}}
 
*{{fl|EvalRule Script}}
*{{fl|Integrity Script}}
 
 
*{{fl|Validate Script}}
 
*{{fl|Validate Script}}
 +
*{{fl|Integrity Script}}
  
 
==Creation/Deletion==
 
==Creation/Deletion==
Line 56: Line 34:
 
*{{fl|Deletion Script}}
 
*{{fl|Deletion Script}}
  
==Transaction==
+
==Visual Positioning==
  
These scripts are associated with the buying and selling of equipment.
+
These scripts manage the size and positioning of visual elements within panels and sheets.
  
*{{fl|TransactSetup Script}}
+
*{{fl|Position Script}}
*{{fl|TransactBuy Script}}
+
*{{fl|Header Script}}
*{{fl|TransactSell Script}}
+
  
==Mode Transition==
+
==Synthesis & Presentation==
  
These scripts associated with the transition into and out of advancement mode.
+
These scripts synthesize information for display to the user in some fashion, including labels, descriptions, mouse-over information, and stat blocks.
  
*{{fl|CanAdvance Script}}
+
*{{fl|Description Script}}
*{{fl|Transition Script}}
+
*{{fl|MouseInfo Script}}
 +
*{{fl|Label Script}}
 +
*{{fl|TitleBar Script}}
 +
*{{fl|HeaderTitle Script}}
 +
*{{fl|AddItem Script}}
 +
*{{fl|Chosen Script}}
 +
*{{fl|LeadSummary Script}}
 +
*{{fl|Synthesize Script}}
  
 
==Trigger==
 
==Trigger==
Line 78: Line 62:
 
*{{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|Initiative Script}}
Line 84: Line 69:
 
*{{fl|Change Script}}
 
*{{fl|Change Script}}
  
==Fixup==
+
==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|Transition Script}}
 +
 
 +
==Release Changes==
  
 
These scripts are used to accommodate changes between data file releases and potential loading errors of portfolios.
 
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}}

Latest revision as of 00: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.