Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Excerpt |
---|
Change the timer interval for a process instance. |
Syntax
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Processes("myProcess").changeInterval(interval); |
Parameters
Parameter | Type | Mandatory | Notes | Pulse Version |
---|---|---|---|---|
interval | Number | 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
Value | Type | Notes | Process Version | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
<instance> | Process Instance | The process instance is returned, so you can chain more instance methods, eg:
| 0.1 |
Div | ||
---|---|---|
| ||
AvailabilityRequires:
|
Div | ||
---|---|---|
| ||
See alsoRelated documentation:
|