Versions Compared

Key

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

Activate the interval timer for a process instance, causing the instance to be run at regular intervals until deactivated.

 

Syntax

Code Block
themeRDark
languagejavascript
linenumberstrue
Process("myProcess").activate(quiet);

Parameters

ParameterTypeMandatoryNotesPulse Version

quiet

Boolean

(error)

If true the instance.onActivate() event will not be fired.

Default: false

0.1

Return value

ValueTypeNotesProcess Version
<instance>Process Instance

The process instance is returned, so you can chain more instance methods, eg:

Code Block
themeRDark
languagejavascript
linenumberstrue
Process("foo").activate(...).addTask(...).run();
0.1

Notes

When you activate a process instance, a timer will be set that will run the instance on a set interval until the instance is deactivated.

The time interval is defined when creating instances using Process(), and can be later updated using instance.changeInteval().

If you want an instance to automatically become active when eventStartLevel() is fired, set autoActivate to true when creating it via Process().

Note: By default, all instances are deactivated when the player associated with the script (me) is killed. If you don't want this behaviour for a specific instance set the autoDeactivate to false when creating the instance via Process().

Div
classbox

Availability

Requires:

  • Warzone 3.1 or above
  • Process 0.1 or above
Div
classbox

Contents

Jump to:

Table of Contents
excludeContents

Div
classbox

See also

Related documentation:

Div
classbox

Process Instances

Related articles:

Child pages (Children Display)
alltrue
depthall
pageProcess Instances
excerpttrue