`unreal.PCGMetadataAccessorHelpers`¶

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

Bases: BlueprintFunctionLibrary

PCGMetadata Accessor Helpers

C++ Source:

Plugin: PCG
Module: PCG
File: PCGMetadataAccessor.h

classmethod copy_point(point, copy_metadata=True, metadata=None, out_metadata=None) → PCGPoint¶

Point functions

Parameters:

point (PCGPoint) –
copy_metadata (bool) –
metadata (PCGMetadata) –
out_metadata (PCGMetadata) –

Returns:

out_point (PCGPoint):

Return type:

PCGPoint

classmethod get_bool_attribute(point, metadata, attribute_name) → bool¶

Get Bool Attribute

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

bool

classmethod get_bool_attribute_by_metadata_key(key, metadata, attribute_name) → bool¶

Get Bool Attribute by Metadata Key

Parameters:

key (int64) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

bool

classmethod get_double_attribute(point, metadata, attribute_name) → double¶

Get Double Attribute

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

double

classmethod get_double_attribute_by_metadata_key(key, metadata, attribute_name) → double¶

Get Double Attribute by Metadata Key

Parameters:

key (int64) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

double

classmethod get_float_attribute(point, metadata, attribute_name) → float¶

Get Float Attribute

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

float

classmethod get_float_attribute_by_metadata_key(key, metadata, attribute_name) → float¶

Get Float Attribute by Metadata Key

Parameters:

key (int64) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

float

classmethod get_integer32_attribute(point, metadata, attribute_name) → int32¶

Get Integer 32Attribute

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

int32

classmethod get_integer32_attribute_by_metadata_key(key, metadata, attribute_name) → int32¶

Id-based metadata functions

Parameters:

key (int64) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

int32

classmethod get_integer64_attribute(point, metadata, attribute_name) → int64¶

Get Integer 64Attribute

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

int64

classmethod get_integer64_attribute_by_metadata_key(key, metadata, attribute_name) → int64¶

Get Integer 64Attribute by Metadata Key

Parameters:

key (int64) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

int64

classmethod get_name_attribute(point, metadata, attribute_name) → Name¶

Get Name Attribute

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

Name

classmethod get_quat_attribute(point, metadata, attribute_name) → Quat¶

Get Quat Attribute

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

Quat

classmethod get_quat_attribute_by_metadata_key(key, metadata, attribute_name) → Quat¶

Get Quat Attribute by Metadata Key

Parameters:

key (int64) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

Quat

classmethod get_rotator_attribute(point, metadata, attribute_name) → Rotator¶

Get Rotator Attribute

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

Rotator

classmethod get_rotator_attribute_by_metadata_key(key, metadata, attribute_name) → Rotator¶

Get Rotator Attribute by Metadata Key

Parameters:

key (int64) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

Rotator

classmethod get_soft_class_path_attribute(point, metadata, attribute_name) → SoftClassPath¶

Get Soft Class Path Attribute

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

SoftClassPath

classmethod get_soft_class_path_attribute_by_metadata_key(key, metadata, attribute_name) → SoftClassPath¶

Get Soft Class Path Attribute by Metadata Key

Parameters:

key (int64) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

SoftClassPath

classmethod get_soft_object_path_attribute(point, metadata, attribute_name) → SoftObjectPath¶

Get Soft Object Path Attribute

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

SoftObjectPath

classmethod get_soft_object_path_attribute_by_metadata_key(key, metadata, attribute_name) → SoftObjectPath¶

Get Soft Object Path Attribute by Metadata Key

Parameters:

key (int64) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

SoftObjectPath

classmethod get_string_attribute(point, metadata, attribute_name) → str¶

Get String Attribute

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

str

classmethod get_string_attribute_by_metadata_key(key, metadata, attribute_name) → str¶

Get String Attribute by Metadata Key

Parameters:

key (int64) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

str

classmethod get_transform_attribute(point, metadata, attribute_name) → Transform¶

Get Transform Attribute

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

Transform

classmethod get_transform_attribute_by_metadata_key(key, metadata, attribute_name) → Transform¶

Get Transform Attribute by Metadata Key

Parameters:

key (int64) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

Transform

classmethod get_vector2_attribute(point, metadata, attribute_name) → Vector2D¶

Get Vector 2Attribute

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

Vector2D

classmethod get_vector2_attribute_by_metadata_key(key, metadata, attribute_name) → Vector2D¶

Get Vector 2Attribute by Metadata Key

Parameters:

key (int64) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

Vector2D

classmethod get_vector4_attribute(point, metadata, attribute_name) → Vector4¶

Get Vector 4Attribute

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

Vector4

classmethod get_vector4_attribute_by_metadata_key(key, metadata, attribute_name) → Vector4¶

Get Vector 4Attribute by Metadata Key

Parameters:

key (int64) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

Vector4

classmethod get_vector_attribute(point, metadata, attribute_name) → Vector¶

Get Vector Attribute

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

Vector

classmethod get_vector_attribute_by_metadata_key(key, metadata, attribute_name) → Vector¶

Get Vector Attribute by Metadata Key

Parameters:

key (int64) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

Vector

classmethod has_attribute_set(point, metadata, attribute_name) → bool¶

Has Attribute Set

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

bool

classmethod has_attribute_set_by_metadata_key(key, metadata, attribute_name) → bool¶

Has Attribute Set by Metadata Key

Parameters:

key (int64) –
metadata (PCGMetadata) –
attribute_name (Name) –

Return type:

bool

classmethod initialize_metadata(point, metadata, parent_point, parent_metadata=None) → PCGPoint¶

Assigns a metadata entry key and will copy attribute values if from an unrelated metadata. Note: a null ParentMetadata assumes this is the same as Metadata

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
parent_point (PCGPoint) –
parent_metadata (PCGMetadata) –

Returns:

point (PCGPoint):

Return type:

PCGPoint

classmethod set_attribute_from_property_by_metadata_key(key, metadata, attribute_name, object, property_name) → int64 or None¶

Set Attribute from Property by Metadata Key

Parameters:

key (int64) –
metadata (PCGMetadata) –
attribute_name (Name) –
object (Object) –
property_name (Name) –

Returns:

key (int64):

Return type:

int64 or None

classmethod set_bool_attribute(point, metadata, attribute_name, value) → PCGPoint¶

Set Bool Attribute

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –
value (bool) –

Returns:

point (PCGPoint):

Return type:

PCGPoint

classmethod set_bool_attribute_by_metadata_key(key, metadata, attribute_name, value) → int64¶

Set Bool Attribute by Metadata Key

Parameters:

key (int64) –
metadata (PCGMetadata) –
attribute_name (Name) –
value (bool) –

Returns:

key (int64):

Return type:

int64

classmethod set_double_attribute(point, metadata, attribute_name, value) → PCGPoint¶

Set Double Attribute

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –
value (double) –

Returns:

point (PCGPoint):

Return type:

PCGPoint

classmethod set_double_attribute_by_metadata_key(key, metadata, attribute_name, value) → int64¶

Set Double Attribute by Metadata Key

Parameters:

key (int64) –
metadata (PCGMetadata) –
attribute_name (Name) –
value (double) –

Returns:

key (int64):

Return type:

int64

classmethod set_float_attribute(point, metadata, attribute_name, value) → PCGPoint¶

Set Float Attribute

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –
value (float) –

Returns:

point (PCGPoint):

Return type:

PCGPoint

classmethod set_float_attribute_by_metadata_key(key, metadata, attribute_name, value) → int64¶

Set Float Attribute by Metadata Key

Parameters:

key (int64) –
metadata (PCGMetadata) –
attribute_name (Name) –
value (float) –

Returns:

key (int64):

Return type:

int64

classmethod set_integer32_attribute(point, metadata, attribute_name, value) → PCGPoint¶

Set Integer 32Attribute

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –
value (int32) –

Returns:

point (PCGPoint):

Return type:

PCGPoint

classmethod set_integer32_attribute_by_metadata_key(key, metadata, attribute_name, value) → int64¶

Set Integer 32Attribute by Metadata Key

Parameters:

key (int64) –
metadata (PCGMetadata) –
attribute_name (Name) –
value (int32) –

Returns:

key (int64):

Return type:

int64

classmethod set_integer64_attribute(point, metadata, attribute_name, value) → PCGPoint¶

Set Integer 64Attribute

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –
value (int64) –

Returns:

point (PCGPoint):

Return type:

PCGPoint

classmethod set_integer64_attribute_by_metadata_key(key, metadata, attribute_name, value) → int64¶

Set Integer 64Attribute by Metadata Key

Parameters:

key (int64) –
metadata (PCGMetadata) –
attribute_name (Name) –
value (int64) –

Returns:

key (int64):

Return type:

int64

classmethod set_name_attribute(point, metadata, attribute_name, value) → PCGPoint¶

Set Name Attribute

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –
value (Name) –

Returns:

point (PCGPoint):

Return type:

PCGPoint

classmethod set_quat_attribute(point, metadata, attribute_name, value) → PCGPoint¶

Set Quat Attribute

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –
value (Quat) –

Returns:

point (PCGPoint):

Return type:

PCGPoint

classmethod set_quat_attribute_by_metadata_key(key, metadata, attribute_name, value) → int64¶

Set Quat Attribute by Metadata Key

Parameters:

key (int64) –
metadata (PCGMetadata) –
attribute_name (Name) –
value (Quat) –

Returns:

key (int64):

Return type:

int64

classmethod set_rotator_attribute(point, metadata, attribute_name, value) → PCGPoint¶

Set Rotator Attribute

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –
value (Rotator) –

Returns:

point (PCGPoint):

Return type:

PCGPoint

classmethod set_rotator_attribute_by_metadata_key(key, metadata, attribute_name, value) → int64¶

Set Rotator Attribute by Metadata Key

Parameters:

key (int64) –
metadata (PCGMetadata) –
attribute_name (Name) –
value (Rotator) –

Returns:

key (int64):

Return type:

int64

classmethod set_soft_class_path_attribute(point, metadata, attribute_name, value) → PCGPoint¶

Set Soft Class Path Attribute

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –
value (SoftClassPath) –

Returns:

point (PCGPoint):

Return type:

PCGPoint

classmethod set_soft_class_path_attribute_by_metadata_key(key, metadata, attribute_name, value) → int64¶

Set Soft Class Path Attribute by Metadata Key

Parameters:

key (int64) –
metadata (PCGMetadata) –
attribute_name (Name) –
value (SoftClassPath) –

Returns:

key (int64):

Return type:

int64

classmethod set_soft_object_path_attribute(point, metadata, attribute_name, value) → PCGPoint¶

Set Soft Object Path Attribute

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –
value (SoftObjectPath) –

Returns:

point (PCGPoint):

Return type:

PCGPoint

classmethod set_soft_object_path_attribute_by_metadata_key(key, metadata, attribute_name, value) → int64¶

Set Soft Object Path Attribute by Metadata Key

Parameters:

key (int64) –
metadata (PCGMetadata) –
attribute_name (Name) –
value (SoftObjectPath) –

Returns:

key (int64):

Return type:

int64

classmethod set_string_attribute(point, metadata, attribute_name, value) → PCGPoint¶

Set String Attribute

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –
value (str) –

Returns:

point (PCGPoint):

Return type:

PCGPoint

classmethod set_string_attribute_by_metadata_key(key, metadata, attribute_name, value) → int64¶

Set String Attribute by Metadata Key

Parameters:

key (int64) –
metadata (PCGMetadata) –
attribute_name (Name) –
value (str) –

Returns:

key (int64):

Return type:

int64

classmethod set_transform_attribute(point, metadata, attribute_name, value) → PCGPoint¶

Set Transform Attribute

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –
value (Transform) –

Returns:

point (PCGPoint):

Return type:

PCGPoint

classmethod set_transform_attribute_by_metadata_key(key, metadata, attribute_name, value) → int64¶

Set Transform Attribute by Metadata Key

Parameters:

key (int64) –
metadata (PCGMetadata) –
attribute_name (Name) –
value (Transform) –

Returns:

key (int64):

Return type:

int64

classmethod set_vector2_attribute(point, metadata, attribute_name, value) → PCGPoint¶

Set Vector 2Attribute

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –
value (Vector2D) –

Returns:

point (PCGPoint):

Return type:

PCGPoint

classmethod set_vector2_attribute_by_metadata_key(key, metadata, attribute_name, value) → int64¶

Set Vector 2Attribute by Metadata Key

Parameters:

key (int64) –
metadata (PCGMetadata) –
attribute_name (Name) –
value (Vector2D) –

Returns:

key (int64):

Return type:

int64

classmethod set_vector4_attribute(point, metadata, attribute_name, value) → PCGPoint¶

Set Vector 4Attribute

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –
value (Vector4) –

Returns:

point (PCGPoint):

Return type:

PCGPoint

classmethod set_vector4_attribute_by_metadata_key(key, metadata, attribute_name, value) → int64¶

Set Vector 4Attribute by Metadata Key

Parameters:

key (int64) –
metadata (PCGMetadata) –
attribute_name (Name) –
value (Vector4) –

Returns:

key (int64):

Return type:

int64

classmethod set_vector_attribute(point, metadata, attribute_name, value) → PCGPoint¶

Set Vector Attribute

Parameters:

point (PCGPoint) –
metadata (PCGMetadata) –
attribute_name (Name) –
value (Vector) –

Returns:

point (PCGPoint):

Return type:

PCGPoint

classmethod set_vector_attribute_by_metadata_key(key, metadata, attribute_name, value) → int64¶

Set Vector Attribute by Metadata Key

Parameters:

key (int64) –
metadata (PCGMetadata) –
attribute_name (Name) –
value (Vector) –

Returns:

key (int64):

Return type:

int64

`unreal.PCGMetadataAccessorHelpers`¶

Table of Contents

Previous topic

Next topic

unreal.PCGMetadataAccessorHelpers¶

`unreal.PCGMetadataAccessorHelpers`¶