Script Types

Context: HL Kit … 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 scripts have been grouped into general categories for improved utility.

Pick Manipulation

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

• Eval Script
• Gear Script

Field Manipulation

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

• Bound Script
• Calculate Script
• Finalize Script

Validation

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

• EvalRule Script
• Validate Script
• Integrity Script

Creation/Deletion

These scripts perform appropriate setup and cleanup of specialized objects.

• Creation Script
• Deletion Script

Visual Positioning

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

• Position Script
• 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.

• Description Script
• MouseInfo Script
• Label Script
• TitleBar Script
• HeaderTitle Script
• AddItem Script
• Chosen Script
• LeadSummary Script
• 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.

• Trigger Script
• Integrate Script
• NewCombat Script
• NewTurn Script
• Initiative Script
• Merge Script
• Split Script
• Change Script

Transaction

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

• TransactSetup Script
• TransactBuy Script
• TransactSell Script

Mode Transition

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

• CanAdvance Script
• Transition Script

Release Changes

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

• LoadError Script
• LoadFixup Script