environment.get_simulation
Overview
- Returns time simulation state: speed, pause status, real-seconds-per-game-minute ratio.
Metadata
| Field | Value |
|---|---|
| Display | Get Simulation Info |
| Category | environment |
| Access | Public |
| Scope | B2Authority |
| Tags | — |
| Aliases | world.get_simulation |
Parameters
- This command takes no parameters.
Returns
Returns a JSON object with the following fields:
| Field | Type | Required | Description |
|---|---|---|---|
time_scale | float | yes | Raw time scale multiplier |
effective_time_scale | float | yes | Effective (applied) time scale |
is_paused | bool | yes | Whether time is paused |
time_state | string | yes | Time state name (Paused/Normal/Fast/VeryFast) |
real_seconds_per_game_minute | float | yes | Real seconds per in-game minute |
relative_time_scale | float | yes | Relative time scale |
Usage
await inzoi.cli.execute('environment.get_simulation');
Back to Command FinderSearch and filter all 318 CLI documents