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 | ||||||
---|---|---|---|---|---|---|
| ||||||
ProcessesProcess("myProcess").activate(quiet); |
Parameters
Parameter | Type | Mandatory | Notes | Pulse Version |
---|---|---|---|---|
quiet | Boolean | If Default: | 0.1 |
Return value
Value | Type | Notes | Process Version | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
<instance> | Process Instance | The process instance is returned, so you can chain more instance methods, eg:
| 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 ProcessesProcess(), 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 ProcessesProcess().
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 ProcessesProcess().
Div | ||
---|---|---|
| ||
AvailabilityRequires:
|
Div | ||||
---|---|---|---|---|
| ||||
ContentsJump to:
|
Div | ||
---|---|---|
| ||
See alsoRelated documentation:
|
Div | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| Process Instances – everything you wanted to know about process instances
| |||||||||
Process InstancesRelated articles:
|