environment.get_state
Overview
- Returns current in-game environment state: time, day of week, season, weather, temperature, disaster, calendar event.
Metadata
| Field | Value |
|---|---|
| Display | Get Environment State |
| Category | environment |
| Access | Public |
| Scope | B2Authority |
| Tags | — |
| Aliases | environment.get_info, world.get_state |
Parameters
- This command takes no parameters.
Returns
Returns a JSON object with the following fields:
| Field | Type | Required | Description |
|---|---|---|---|
hour | int | yes | Current hour (0-23) |
minute | int | yes | Current minute (0-59) |
day | int | yes | Current day |
day_of_week | string | yes | Day of week name |
is_night_time | bool | yes | Whether it is night time |
season | string | yes | Current season |
weather | string | yes | Current weather |
temperature | int | yes | Current temperature |
is_disaster | bool | yes | Whether a disaster is active |
calendar_event | string | yes | Active world calendar event id (empty if none) |
season_length | int | yes | Configured season length |
Usage
await inzoi.cli.execute('environment.get_state');
Back to Command FinderSearch and filter all 318 CLI documents