unreal.PCGBlueprintHelpers

class unreal.PCGBlueprintHelpers(outer: Object | None = None, name: Name | str = 'None')

Bases: BlueprintFunctionLibrary

PCGBlueprint Helpers

C++ Source:

• Plugin: PCG

• Module: PCG

• File: PCGBlueprintHelpers.h

classmethod compute_seed_from_position(position) → int32

Compute Seed from Position

Parameters:

position (Vector)

Return type:

int32

classmethod create_pcg_data_from_actor(actor, parse_actor=True) → PCGData

Create PCGData from Actor

Parameters:

• actor (Actor)

• parse_actor (bool)

Return type:

PCGData

classmethod duplicate_data(data, context, initialize_metadata=True) -> (PCGData, context=PCGContext)

Prefer using DuplicateDataWithContext

Parameters:

• data (PCGData)

• context (PCGContext)

• initialize_metadata (bool)

Returns:

context (PCGContext):

Return type:

PCGContext

classmethod duplicate_data_with_context(data, context_handle, initialize_metadata=True) → PCGData

Return a copy of the data, with Metadata inheritance for spatial data.

Parameters:

• data (PCGData)

• context_handle (PCGBlueprintContextHandle)

• initialize_metadata (bool)

Return type:

PCGData

classmethod flush_pcg_cache() → bool

Flush the cache, to be used if you have changed something PCG depends on at runtime. Same as pcg.FlushCache command. Returns true if it succeeded.

Return type:

bool

classmethod get_actor_bounds_pcg(actor, ignore_pcg_created_components=True) → Box

Get Actor Bounds PCG

Parameters:

• actor (Actor)

• ignore_pcg_created_components (bool)

Return type:

Box

classmethod get_actor_data(context) -> (PCGData, context=PCGContext)

Prefer using GetActorDataWithContext

Parameters:

context (PCGContext)

Returns:

context (PCGContext):

Return type:

PCGContext

classmethod get_actor_data_with_context(context_handle) → PCGData

Get Actor Data with Context

Parameters:

context_handle (PCGBlueprintContextHandle)

Return type:

PCGData

classmethod get_actor_local_bounds_pcg(actor, ignore_pcg_created_components=True) → Box

Get Actor Local Bounds PCG

Parameters:

• actor (Actor)

• ignore_pcg_created_components (bool)

Return type:

Box

classmethod get_component(context) -> (PCGComponent, context=PCGContext)

Prefer using GetComponentWithContext

Parameters:

context (PCGContext)

Returns:

context (PCGContext):

Return type:

PCGContext

classmethod get_component_with_context(context_handle) → PCGComponent

Get Component with Context

Parameters:

context_handle (PCGBlueprintContextHandle)

Return type:

PCGComponent

classmethod get_extents(point) → Vector

Get Extents

Parameters:

point (PCGPoint)

Return type:

Vector

classmethod get_input_data(context) -> (PCGData, context=PCGContext)

Prefer using GetInputDataWithContext

Parameters:

context (PCGContext)

Returns:

context (PCGContext):

Return type:

PCGContext

classmethod get_input_data_with_context(context_handle) → PCGData

Get Input Data with Context

Parameters:

context_handle (PCGBlueprintContextHandle)

Return type:

PCGData

classmethod get_interpolated_pcg_landscape_layer_weights(world_context_object, location) → Array[PCGLandscapeLayerWeight]

Get Interpolated PCGLandscape Layer Weights

Parameters:

• world_context_object (Object)

• location (Vector)

Return type:

Array[PCGLandscapeLayerWeight]

classmethod get_local_center(point) → Vector

Get Local Center

Parameters:

point (PCGPoint)

Return type:

Vector

classmethod get_original_component(context) -> (PCGComponent, context=PCGContext)

Prefer using GetOriginalComponentWithContext

Parameters:

context (PCGContext)

Returns:

context (PCGContext):

Return type:

PCGContext

classmethod get_original_component_with_context(context_handle) → PCGComponent

Get Original Component with Context

Parameters:

context_handle (PCGBlueprintContextHandle)

Return type:

PCGComponent

classmethod get_random_stream(point: PCGPoint, optional_settings: PCGSettings = Ellipsis, optional_component: PCGComponent = Ellipsis) → RandomStream

deprecated: ‘get_random_stream’ was renamed to ‘get_random_stream_from_point’.

classmethod get_random_stream_from_point(point, optional_settings=None, optional_component=None) → RandomStream

Creates a random stream from a point’s seed and settings/component’s seed (optional)

Parameters:

• point (PCGPoint)

• optional_settings (PCGSettings)

• optional_component (PCGComponent)

Return type:

RandomStream

classmethod get_random_stream_from_two_points(point_a, point_b, optional_settings=None, optional_component=None) → RandomStream

Creates a random stream from using the random seeds from two points, as well as settings/component’s seed (optional)

Parameters:

• point_a (PCGPoint)

• point_b (PCGPoint)

• optional_settings (PCGSettings)

• optional_component (PCGComponent)

Return type:

RandomStream

classmethod get_settings(context) -> (PCGSettings, context=PCGContext)

Prefer using GetSettingsWithContext

Parameters:

context (PCGContext)

Returns:

context (PCGContext):

Return type:

PCGContext

classmethod get_settings_with_context(context_handle) → PCGSettings

Get Settings with Context

Parameters:

context_handle (PCGBlueprintContextHandle)

Return type:

PCGSettings

classmethod get_target_actor(context, spatial_data) -> (Actor, context=PCGContext)

Prefer using GetTargetActorWithContext

Parameters:

• context (PCGContext)

• spatial_data (PCGSpatialData)

Returns:

context (PCGContext):

Return type:

PCGContext

classmethod get_target_actor_with_context(context_handle, spatial_data) → Actor

Get Target Actor with Context

Parameters:

• context_handle (PCGBlueprintContextHandle)

• spatial_data (PCGSpatialData)

Return type:

Actor

classmethod get_task_id(context) -> (int64, context=PCGContext)

Prefer using GetTaskIdWithContext

Parameters:

context (PCGContext)

Returns:

context (PCGContext):

Return type:

PCGContext

classmethod get_task_id_with_context(context_handle) → int64

Get Task Id with Context

Parameters:

context_handle (PCGBlueprintContextHandle)

Return type:

int64

classmethod get_transformed_bounds(point) → Box

Get Transformed Bounds

Parameters:

point (PCGPoint)

Return type:

Box

classmethod refresh_pcg_runtime_component(component, flush_cache=False) → None

Refresh a component set to Generate At Runtime, if some parameters changed. Can also flush the cache.

Parameters:

• component (PCGComponent)

• flush_cache (bool)

classmethod set_extents(point, extents) → PCGPoint

Set Extents

Parameters:

• point (PCGPoint)

• extents (Vector)

Returns:

point (PCGPoint):

Return type:

PCGPoint

classmethod set_local_center(point, local_center) → PCGPoint

Set Local Center

Parameters:

• point (PCGPoint)

• local_center (Vector)

Returns:

point (PCGPoint):

Return type:

PCGPoint

classmethod set_seed_from_position(point) → PCGPoint

Set Seed from Position

Parameters:

point (PCGPoint)

Returns:

point (PCGPoint):

Return type:

PCGPoint