Difference between revisions of "Script Types"

From HLKitWiki
Jump to: navigation, search
(Validation)
Line 6: Line 6:
  
 
==Visual Positioning==
 
==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|Label Script}}
 
*{{fl|TitleBar Script}}
 
*{{fl|HeaderTitle Script}}
 
*{{fl|AddItem Script}}
 
*{{fl|Chosen Script}}
 
*{{fl|LeadSummary Script}}
 
*{{fl|Synthesize Script}}
 
  
 
==Pick Manipulation==
 
==Pick Manipulation==
Line 56: Line 37:
 
*{{fl|Deletion Script}}
 
*{{fl|Deletion Script}}
  
==Transaction==
+
These scripts manage the size and positioning of visual elements within panels and sheets.
  
These scripts are associated with the buying and selling of equipment.
+
*{{fl|Position Script}}
 +
*{{fl|Header Script}}
  
*{{fl|TransactSetup Script}}
+
==Synthesis & Presentation==
*{{fl|TransactBuy Script}}
+
*{{fl|TransactSell Script}}
+
  
==Mode Transition==
+
These scripts synthesize information for display to the user in some fashion, including labels, descriptions, mouse-over information, and stat blocks.
  
These scripts associated with the transition into and out of advancement mode.
+
*{{fl|Description Script}}
 
+
*{{fl|MouseInfo Script}}
*{{fl|CanAdvance Script}}
+
*{{fl|Label Script}}
*{{fl|Transition Script}}
+
*{{fl|TitleBar Script}}
 +
*{{fl|HeaderTitle Script}}
 +
*{{fl|AddItem Script}}
 +
*{{fl|Chosen Script}}
 +
*{{fl|LeadSummary Script}}
 +
*{{fl|Synthesize Script}}
  
 
==Trigger==
 
==Trigger==
Line 83: Line 68:
 
*{{fl|Split Script}}
 
*{{fl|Split Script}}
 
*{{fl|Change Script}}
 
*{{fl|Change 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|Transition Script}}
  
 
==Fixup==
 
==Fixup==

Revision as of 02:28, 14 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

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.

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.

Fixup

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