Active Pause | Parallel 42 Documentation

Flow APIFlow Pro scriptingSimulator data

This article covers the following platforms

Use the Active Pause commands to read or change the simulator’s Active Pause state.

`get_active_pause()`

Read the current Active Pause state.

SignatureTypeScript contract

get_active_pause(): boolean

ExampleJavaScript

const isPaused = this.$api.command.get_active_pause();
console.log(isPaused);

Returns

booleanCurrent Active Pause state.

Enable or disable Active Pause.

SignatureTypeScript contract

set_active_pause(state: boolean): void

Parameters

Name	Type	Required	Description
`state`	`boolean`	Yes	Desired Active Pause state.

ExampleJavaScript

this.$api.command.set_active_pause(true);

Returns

voidNo direct return value is documented.