Versions Compared

Key

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

Change the timer interval for a process instance.

 

Syntax

Code Block
themeRDark
languagejavascript
linenumberstrue
Processes("myProcess").changeInterval(interval);

Parameters

ParameterTypeMandatoryNotesPulse Version

interval

Number

(error)

Define the new interval to use for the process instance.

If the process is currently active, it will be silently deactivated then reactivated to make the new interval take effect immediately.

Defaults to PROCESS_INTERVAL_MIN if no value specified or if the stated interval is too small.

The interval time will have a random offset between 1 and PROCESS_INTERVAL_RAND added to it – this helps reduce collisions when processes are running in multiple player scripts.

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
Processes("foo").activate(...).addTask(...).run();
0.1
Div
classbox

Availability

Requires:

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

See also

Related documentation: