unreal.IsPropertyValidParams

class unreal.IsPropertyValidParams(snapshot_actor: Actor = Ellipsis, level_actor: Actor = Ellipsis, snapshot_property_container: PropertyContainerHandle = [], level_property_containers: PropertyContainerHandle = [], property_: FieldPath = Ellipsis, property_path: None = [])

Bases: StructBase

Is Property Valid Params

C++ Source:

  • Plugin: LevelSnapshots

  • Module: LevelSnapshotFilters

  • File: LevelSnapshotFilterParams.h

Editor Properties: (see get_editor_property/set_editor_property)

  • level_actor (Actor): [Read-Write] The actor equivalent to LevelActor: it exists in the world

  • level_property_containers (PropertyContainerHandle): [Read-Write] For passing to FProperty::ContainerPtrToValuePtr. This is either LevelPropertyContainers or a subobject thereof.

  • property_ (FieldPath): [Read-Write] The property that we may want to rollback.

  • property_path (Array[str]): [Read-Write] Each elements is the name of a subobject name leading to this property. The last element is the property name. The first element is either the name of a component or a struct/subobject in the root actor.

    Examples:

    • MyCustomComponent -> MyCustomStructPropertyName -> PropertyName

    • MyCustomComponent -> MyCustomStructPropertyName

      • StructPropertyNameInActor -> PropertyName

  • snapshot_actor (Actor): [Read-Write] The actor saved in the snapshot

  • snapshot_property_container (PropertyContainerHandle): [Read-Write] For passing to FProperty::ContainerPtrToValuePtr. This is either SnapshotActor or a subobject thereof.

property level_actor: Actor

it exists in the world

Type:

(Actor)

Type:

[Read-Only] The actor equivalent to LevelActor

property level_property_containers: PropertyContainerHandle

[Read-Only] For passing to FProperty::ContainerPtrToValuePtr. This is either LevelPropertyContainers or a subobject thereof.

Type:

(PropertyContainerHandle)

property property_: FieldPath

[Read-Only] The property that we may want to rollback.

Type:

(FieldPath)

property property_path: None

[Read-Only] Each elements is the name of a subobject name leading to this property. The last element is the property name. The first element is either the name of a component or a struct/subobject in the root actor.

Examples

  • MyCustomComponent -> MyCustomStructPropertyName -> PropertyName

  • MyCustomComponent -> MyCustomStructPropertyName

    • StructPropertyNameInActor -> PropertyName

Type:

(Array[str])

property snapshot_actor: Actor

[Read-Only] The actor saved in the snapshot

Type:

(Actor)

property snapshot_property_container: PropertyContainerHandle

[Read-Only] For passing to FProperty::ContainerPtrToValuePtr. This is either SnapshotActor or a subobject thereof.

Type:

(PropertyContainerHandle)