Page Comparison

Excerpt
Tasks are functions that Processes process during a trigger Process Instances execute in sequence when they run.

Creating a task

Create a function, then add it to a trigger like Process Instance like so:

Code Block

theme	RDark
language	javascript
linenumbers	true

var myTaskFuncmyTask1 = function(params...taskData,processData,runData,processName,taskName,alert) {
  // task code here
}
 
function anotherTaskFuncmyTask2(...params...) {
  // task code here
}
 
// add two tasks to "myTriggerfoo" process instance:
PulseProcesses("myTriggerfoo").addTask(myTaskFuncmyTask1).addTask(anotherTaskFuncmyTask2);
 
// Note: See triggerinstance.addTask() for more info on the .addTask() params
 
// You can also just add anonymous functions
PulseProcesses("myTriggerfoo").addTask(function(...params...) {
  // task code here
});

Note: Tasks are processed in the order in which they're added to the process instance.

There are several parameters to the triggerinstance.addTask() function that you should check out, such as defining the task name and setting a task scope and indicating that tasks should be player-iterated.

Task parameters

When the trigger processes process instance executes a task, it passes in a bunch of parameters as followsthe following parameters:

0.1

Parameter

Type

Notes

Pulse Version

player

Number

The player ID the task is to process, see Task Iteration for more info.

taskData

Object

A container where a task can store data to access next time it runsdata container associated with the current task, useful if you want to store data for subsequent executions of the task.

Does not get saved when user saves a game.

0.1

triggerDataprocessData

Object

A trigger-level data container , allowing tasks within that trigger to share data between themselvesassociated with the process instance, useful if you want to share information between tasks.

Does not get saved when user saves a game.

0.1

runData

Variant

Any data that is passed in when a trigger run starts - see trigger() for more info.

0.1

timeRemaining

Number

The number of millisecods remaining on this game tick before game lag will be noticed by end users. Not an exact figure, but usually fairly accurate

A data container associated with the current process instance run. For example, it could contain information from the event that triggered the run.

Tasks can also store information specific to the current run in this data container and then have instance.onEnd() event send the runData off to some other process or function.

The runData object is deleted after each run, immediately after instance.onEnd() is fired.

0.1

triggerNameprocessName

String

The name of the trigger process isntance that's processing executing the task.

0.1

taskName

String

The name of the task (specified or determined during triggerinstance.addTask())

0.1

alert

Function

A function that lets you send a descriptive alert message, useful for debugging.

Code Block

theme	RDark
language	javascript
title	Create alert messages from within a task
linenumbers	true

alert(msg, format);

Parameters:

msg – string containing the message to send
format – constant defining output format:
- PROCESS_ALERT_CONSOLE – send msg to console() (default)
- PROCESS_ALERT_DEBUG – send msg to debug()
- PROCESS_ALERT_ERROR – throw an error message, also aborts the current run.

0.1

Task return values

Tasks can optionally return 'true' to indicate they're not finished yet.

null

false

If that or returns something that equates to false, the task is deemed to be complete for this run and the trigger will move on to processing the next task

Value	Type	Notes	Pulse Version
`undefined`	Anything that equates to Boolean `false`	Undefined	If the task function does not return anything,	PROCESS_STATE_IDLE is assumed (see below).	0.1
PROCESS_STATE_IDLE	Constant	Indicate that the task is complete.	0.1
`true`	Boolean	If the task returns `true` (or anything that equates to true), the trigger will deem the task to be incomplete, eg. not finished due to time constraints.PROCESS_STATE_RUNNING	Constant	Indicate that the task is incomplete. In this scenario, the trigger will stop processing any additional tasks on the current game tick, and on a subsequent game tick will resume processing tasks starting with the one that was incomplete.Your task can store where it was up to, etc., on the taskData object so that it can pick up where it left off next time it runs. Just remember to clear down that info after the task completesprocess run will be paused until a later game tick, at which time the task will be run again. See notes below for more info.	0.1
PROCESS_STATE_ABORT	Constant	Indicate that the current process run should be aborted.	0.1
<error>	Any exception	The trigger will abort the current run.	Planned for 0.2	Error	If the task causes an exception, the current process run will be aborted and a warning message displayed.	0.1

Notes

When a trigger runs (see trigger()) it will run process instance runs it will execute each of its tasks in the order they were added to the trigger. If there isn't enough time left in the current game tick, some tasks may be deferred to a later game tick.

If game objects (anything derived from Base object Game objects) are stored in taskData, triggerData processData or runData, it's possible those objects have been destroyed before a task gets round to processing them so – so ensure you have good Error Handling around any code that processes game objects within a task.

Div

class	box

Availability

Requires:

Warzone 3.1 or above
Pulse Process 0.1 2 or above
Yeast 0.1 or above

Some changes to return values are planned for Pulse v0.2.

Versions Compared

Old Version 5

New Version Current

Key

Creating a task

Task parameters

Task return values

Notes

Availability