Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

Fired immediately before a new process run starts.

 

Syntax

Code Block
themeRDark
languagejavascript
linenumberstrue
Processes("myProcess").onRun = function(processName, processData, runData) {
  // event handling code here
}

Parameters

ParameterTypeNotesProcess Version
processNameStringThe name of the instance that has been activatedis about to run.0.1
processDataObjectThe data object associated with the activated instance.0.1
runDataVariant

The data associated with the process run that is about to start.

Defaults to an empty object if nothing specified when the run is was triggered.

0.1

Return values

The return value of the event handler is ignored.

Div
classbox

Availability

Requires:

  • Warzone 3.1 or above
  • Process 0.1 or above

Future changes may include allowing a return value to abort the run.