unreal.PyTestStruct

class unreal.PyTestStruct(bool: bool = False, int: int = 0, float: float = 0.0, enum: PyTestEnum = Ellipsis, string: str = '', name: Name = 'None', text: Text = '', field_path: FieldPath = Ellipsis, struct_field_path: FieldPath = Ellipsis, string_array: None = [], string_set: None = [], string_int_map: None = {}, bool_mutable: bool = False)

Bases: StructBase

Struct to allow testing of the various UStruct features that are exposed to Python wrapped types.

C++ Source:

  • Plugin: PythonScriptPlugin

  • Module: PythonScriptPlugin

  • File: PyTest.h

Editor Properties: (see get_editor_property/set_editor_property)

  • bool (bool): [Read-Write]

  • bool_defaults_only (bool): [Read-Write]

  • bool_instance_only (bool): [Read-Write]

  • bool_mutable (bool): [Read-Only]

  • enum (PyTestEnum): [Read-Write]

  • field_path (FieldPath): [Read-Write]

  • float (float): [Read-Write]

  • int (int32): [Read-Write]

  • legacy_int (int32): [Read-Write] deprecated: LegacyInt is deprecated. Please use Int instead.

  • name (Name): [Read-Write]

  • string (str): [Read-Write]

  • string_array (Array[str]): [Read-Write]

  • string_int_map (Map[str, int32]): [Read-Write]

  • string_set (Set[str]): [Read-Write]

  • struct_field_path (FieldPath): [Read-Write]

  • text (Text): [Read-Write]

CONSTANT_VALUE: int

Get Constant Value

Type:

(int32)

__add__(other: PyTestStruct) None

Overloads:

  • str Add Str

  • int32 Add Int

  • float Add Float

__iadd__(other: PyTestStruct) None

Overloads:

  • str Add Str

  • int32 Add Int

  • float Add Float

add_float(value) None

Add Float

Parameters:

value (float) –

Return type:

PyTestStruct

add_int(value) None

Add Int

Parameters:

value (int32) –

Return type:

PyTestStruct

add_str(value) None

Add Str

Parameters:

value (str) –

Return type:

PyTestStruct

property bool: bool

[Read-Write]

Type:

(bool)

property bool_mutable: bool

[Read-Only]

Type:

(bool)

clear_bool_mutable() None

Clear Bool Mutable

clear_bool_mutable_via_ref() None

Clear Bool Mutable Via Ref

property enum: PyTestEnum

[Read-Write]

Type:

(PyTestEnum)

property field_path: FieldPath

[Read-Write]

Type:

(FieldPath)

property float: float

[Read-Write]

Type:

(float)

property int: int

[Read-Write]

Type:

(int32)

is_bool_set() bool

Is Bool Set

Return type:

bool

is_bool_set_old() bool

deprecated: ‘is_bool_set_old’ was renamed to ‘is_bool_set’.

property legacy_int: int

[Read-Write] deprecated: LegacyInt is deprecated. Please use Int instead.

Type:

(int32)

legacy_is_bool_set() bool

Legacy Is Bool Set deprecated: LegacyIsBoolSet is deprecated. Please use IsBoolSet instead.

Return type:

bool

property name: Name

[Read-Write]

Type:

(Name)

set_bool_mutable() None

Set Bool Mutable

set_bool_mutable_via_ref() None

Set Bool Mutable Via Ref

property string: str

[Read-Write]

Type:

(str)

property string_array: None

[Read-Write]

Type:

(Array[str])

property string_int_map: None

[Read-Write]

Type:

(Map[str, int32])

property string_set: None

[Read-Write]

Type:

(Set[str])

property struct_field_path: FieldPath

[Read-Write]

Type:

(FieldPath)

property text: Text

[Read-Write]

Type:

(Text)