Skip to main content

environment.get_simulation

Overview

  • Returns time simulation state: speed, pause status, real-seconds-per-game-minute ratio.

Metadata

FieldValue
DisplayGet Simulation Info
Categoryenvironment
AccessPublic
ScopeB2Authority
Tags
Aliasesworld.get_simulation

Parameters

  • This command takes no parameters.

Returns

Returns a JSON object with the following fields:

FieldTypeRequiredDescription
time_scalefloatyesRaw time scale multiplier
effective_time_scalefloatyesEffective (applied) time scale
is_pausedboolyesWhether time is paused
time_statestringyesTime state name (Paused/Normal/Fast/VeryFast)
real_seconds_per_game_minutefloatyesReal seconds per in-game minute
relative_time_scalefloatyesRelative time scale

Usage

await inzoi.cli.execute('environment.get_simulation');