Build.BlitzBuild - script

Description

The script task is used to run a section of Blitz code from within a build file. This is more useful for doing small tasks such as generating images.

There is currently no support for scripts to access build file properties, but this may come later.

Parameters

Table 6. Parameters

Attribute Type Description Required
source string If set, will load the source from a file instead of the task node. false
mainFunction string The function to run within the script. If not passed, defaults to "Main". false
if bool If true, the task will be executed, otherwise it will be skipped. The default is true. False
unless bool The opposite of if. If false, the task will be executed, otherwise it will be skipped. The default is false. False

Return Values

True if the script ran or false if there was an error.