wp kit

10 tools. Generated from the plugin source; do not edit by hand.

Tools

Legend. risk 0 = read-only, 1 = harmless editor op, 2 = modifies asset, 3 = deletes/replaces asset, 4 = project/config/build op, 5 = potentially destructive (calls above MaxAutoRisk need "_confirm": true). mutates = runs in a transaction (edit.undo reverts). requires PIE / requires world = refused without a PIE session / an open level. requires plugin = unavailable while the plugin is disabled. dryRun = honours the dryRun argument. smoke = covered by edit.self_test.

wp.audit_hlod_assignments (risk 0, UE 5.0+, requires world, smoke)

Counts loaded actors assigned to each HLOD layer and flags assignments that need review.

No arguments.

Returns: actorCount, actorsWithHlodLayer, externalActorCount, layerActors, warnings.

wp.audit_spatial_actors (risk 0, UE 5.0+, requires world, smoke)

Reports spatial versus always-loaded actors and their named runtime-grid distribution.

No arguments.

Returns: spatiallyLoadedActorCount, alwaysLoadedActorCount, runtimeGrids, defaultGridActorCount, warnings.

wp.generate_streaming (risk 4, mutates, UE 5.3+, requires world, smoke)

Runs World Partition streaming generation on the open world as a validation pass (the engine writes a generation log under Saved/Logs/WorldPartition), then flushes the generated cells so the editor world is unchanged.

No arguments.

Returns: partitioned, streamingEnabled, canGenerateStreaming, message.

wp.get_hlod_layer_settings (risk 0, UE 5.0+, requires world, smoke)

Reads one HLOD layer's public generation and runtime-grid settings.

Argument	Type	Description
layer	string	required. HLOD layer asset path.

Returns: layer, layerType, builderClass, parentLayer, spatiallyLoaded, cellSize, loadingRange, message.

wp.get_overview (risk 0, UE 5.0+, requires world, smoke)

Reports World Partition implementation and loaded-actor streaming distribution without changing the level.

No arguments.

Returns: world, partitioned, streamingEnabled, streamingEnabledInEditor, partitionClass, loadedActorCount, externalActorCount, spatiallyLoadedActorCount, alwaysLoadedActorCount, runtimeGridActors, message.

wp.get_runtime_data_layer (risk 0, UE 5.3+, requires PIE, requires world)

Gets the PIE effective runtime state of one data layer without changing its editor configuration.

Argument	Type	Description
dataLayer	string	required. Runtime data layer instance name in the PIE world.
includeEffectiveSets	boolean	Include active and loaded effective-name sets in the reply. Default true.

Returns: dataLayer, runtime, requestedState, currentState, effectiveState, effectiveActive, effectiveLoaded, message.

wp.get_streaming (risk 0, UE 5.3+, requires world, smoke)

Reports runtime streaming state and whether streaming data can be regenerated.

No arguments.

Returns: partitioned, streamingEnabled, canGenerateStreaming, message.

wp.list_runtime_data_layers (risk 0, UE 5.3+, requires PIE, requires world, smoke)

Lists requested and effective states for all runtime and editor data-layer instances in PIE.

No arguments.

Returns: dataLayers, effectiveActive, effectiveLoaded, count.

wp.set_runtime_data_layer_state (risk 1, mutates, UE 5.3+, requires PIE, requires world)

Changes a runtime data layer state in PIE; the change is transient and does not edit the data-layer asset.

Argument	Type	Description
dataLayer	string	required. Runtime data layer instance name in the PIE world.
state	string	required. "unloaded", "loaded", or "activated".
recursive	boolean	Also apply the state to child data layers. Default false.

Returns: dataLayer, runtime, requestedState, currentState, effectiveState, effectiveActive, effectiveLoaded, message.

wp.set_streaming (risk 1, mutates, UE 5.3+, requires world, smoke)

Enables or disables streaming on the open World Partition world; this changes the map setting.

Argument	Type	Description
enabled	boolean	required. Enable or disable World Partition streaming for the editor world.

Returns: partitioned, streamingEnabled, canGenerateStreaming, message.