editor.worldpartition

World Partition grid and cell management

← API Reference

editor.worldpartition.getInfo

Returns world partition status, streaming info, and world bounds.

No parameters.

Returns:

Name Type Description
is_enabledboolWhether world partition is enabled
is_initializedboolWhether world partition is initialized
is_streaming_enabledboolWhether streaming is enabled
num_streaming_sourcesnumberNumber of streaming sources
is_streaming_completedboolWhether all streaming is complete
world_bounds_xnumberWorld bounds X extent
world_bounds_ynumberWorld bounds Y extent
world_bounds_znumberWorld bounds Z extent

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.worldpartition.getInfo" }

editor.worldpartition.isStreamingCompleted

Checks if all world partition streaming is complete.

No parameters.

Returns:

Name Type Description
is_completedboolWhether streaming is complete
has_world_partitionboolWhether world partition exists

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.worldpartition.isStreamingCompleted" }

editor.worldpartition.getStreamingSources

Returns all active streaming sources with locations and priorities.

No parameters.

Returns:

Name Type Description
sourcesarrayEach: {source_name, location, priority, target_state}
countnumberNumber of sources

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.worldpartition.getStreamingSources" }

editor.worldpartition.getLevelInstances

Returns all level instances in the world with their asset paths and runtime behaviors.

No parameters.

Returns:

Name Type Description
level_instancesarrayEach: {actor_name, actor_class, level_asset_path, runtime_behavior, is_loaded}
countnumberNumber of level instances

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.worldpartition.getLevelInstances" }