editor.worldpartition.getInfo
Returns world partition status, streaming info, and world bounds.
No parameters.
Returns:
| Name | Type | Description |
|---|---|---|
is_enabled | bool | Whether world partition is enabled |
is_initialized | bool | Whether world partition is initialized |
is_streaming_enabled | bool | Whether streaming is enabled |
num_streaming_sources | number | Number of streaming sources |
is_streaming_completed | bool | Whether all streaming is complete |
world_bounds_x | number | World bounds X extent |
world_bounds_y | number | World bounds Y extent |
world_bounds_z | number | World 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_completed | bool | Whether streaming is complete |
has_world_partition | bool | Whether 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 |
|---|---|---|
sources | array | Each: {source_name, location, priority, target_state} |
count | number | Number 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_instances | array | Each: {actor_name, actor_class, level_asset_path, runtime_behavior, is_loaded} |
count | number | Number of level instances |
Example Request:
{ "jsonrpc": "2.0", "id": 1, "method": "editor.worldpartition.getLevelInstances" }editor.worldpartition.getHLODLayers
Returns HLOD actors in the world.
No parameters.
Returns:
| Name | Type | Description |
|---|---|---|
hlod_actors | array | Each: {actor_name, actor_class, path, x, y, z} |
count | number | Number of HLOD actors |
has_world_partition | bool | Whether WP is enabled |
Example Request:
{ "jsonrpc": "2.0", "id": 1, "method": "editor.worldpartition.getHLODLayers" }editor.worldpartition.getWorldSettings
Returns world partition-related world settings.
No parameters.
Returns:
| Name | Type | Description |
|---|---|---|
has_world_partition | bool | WP enabled |
has_world_composition | bool | World Composition enabled |
world_name | string | World name |
map_name | string | Map name |
is_initialized | bool | WP initialized (if WP enabled) |
is_streaming_enabled | bool | Streaming enabled (if WP) |
bounds_size_x, bounds_size_y, bounds_size_z | number | Runtime bounds (if WP) |
enable_world_bounds_checks | bool | Bounds checks enabled |
kill_z | number | Kill Z height |
Example Request:
{ "jsonrpc": "2.0", "id": 1, "method": "editor.worldpartition.getWorldSettings" }editor.worldpartition.getActorGridInfo
Returns grid placement and spatial info for a specific actor.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
actor | string | Yes | Actor label or name |
Returns:
| Name | Type | Description |
|---|---|---|
actor_name | string | Actor label |
actor_class | string | Class name |
x, y, z | number | Actor location |
bounds_x, bounds_y, bounds_z | number | Bounding box size |
folder_path | string | Outliner folder |
is_spatially_loaded | bool | Whether spatially loaded |
Example Request:
{ "jsonrpc": "2.0", "id": 1, "method": "editor.worldpartition.getActorGridInfo", "params": { "actor": "BP_Enemy_0" } }editor.worldpartition.getContentBundles
Returns content bundle actors in the world.
No parameters.
Returns:
| Name | Type | Description |
|---|---|---|
content_bundles | array | Each: {actor_name, actor_class, path} |
count | number | Number of content bundles |
Example Request:
{ "jsonrpc": "2.0", "id": 1, "method": "editor.worldpartition.getContentBundles" }editor.worldpartition.getRegions
Returns volume/region actors with their bounds.
No parameters.
Returns:
| Name | Type | Description |
|---|---|---|
regions | array | Each: {actor_name, actor_class, origin_x, origin_y, origin_z, extent_x, extent_y, extent_z} |
count | number | Number of regions |
Example Request:
{ "jsonrpc": "2.0", "id": 1, "method": "editor.worldpartition.getRegions" }editor.worldpartition.getActorsByRegion
Returns all actors within a spatial bounding box.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
min | object | Yes | {x, y, z} -- minimum bounds |
max | object | Yes | {x, y, z} -- maximum bounds |
Returns:
| Name | Type | Description |
|---|---|---|
actors | array | Each: {label, class, x, y, z} |
count | number | Number of actors in region |
Example Request:
{ "jsonrpc": "2.0", "id": 1, "method": "editor.worldpartition.getActorsByRegion", "params": { "min": {"x": -5000, "y": -5000, "z": -1000}, "max": {"x": 5000, "y": 5000, "z": 5000} } }