Action Script Events

   

 

Each Action in FinalBuilder has BeforeAction, AfterAction, and OnStatusMessage script events. Some Actions (such as Iterators) define more script events.

 

The action Script Events are shown at the bottom of the FinalBuilder IDE in the Script Editor tab, see screenshot.

 

scripteditor

 

The following script events are common to all actions:

 

BeforeAction Event

Description: called before the action is executed.

Parameters:

Action parameter allows access to the action properties and methods (see Action Properties and Methods).
SkipAction parameter allows the script to return true for the action to be skipped during a build.

 

AfterAction Event

Description: called after the action has executed.

Parameters:

Action parameter allows access to the action properties and methods (see Action Properties and Methods).
ActionResult parameter - indicates if the action succeeded or failed.  This may also be set to override the action status.
Continue parameter - return false to stop the build, return true to continue the build ignoring the ActionResult

 

 

OnStatusMessage Event

Description: called whenever the action generates a log message

Parameters:

Action parameter allows access to the action properties and methods (see Action Properties and Methods).
StatusMessage - the status message object contains the information of the status message (Lines, MessageText, MessageTitle, and Progress)

 

Execute Condition

 

In addition, each action has an Execute Condition property which is a Boolean expression which should return true for the action to execute. See Action Reference for more information.  The Condition property is displayed in the Property dialog for the action, in the Properties tab (Execute Condition section).