unreal.StateTreeTransitionResult

class unreal.StateTreeTransitionResult(source=[[], StateTreeRunStatus.UNSET], target=[], next=[], current=[])

Bases: unreal.StructBase

Describes a state tree transition. Source is the state where the transition started, Target describes the state where the transition pointed at, and Next describes the selected state. The reason Transition and Next are different is that Transition state can be a selector state, in which case the children will be visited until a leaf state is found, which will be the next state.

C++ Source:

  • Plugin: StateTree

  • Module: StateTreeModule

  • File: StateTreeTypes.h

Editor Properties: (see get_editor_property/set_editor_property)

  • current (StateTreeHandle): [Read-Write] Current: Current state, update as we execute the tree.

  • next (StateTreeHandle): [Read-Write] Next: Selected state, can be different from Transition, if Transition is a selector state.

  • source (StateTreeStateStatus): [Read-Write] Source: State where the transition started.

  • target (StateTreeHandle): [Read-Write] Target: Transition target state

property current

[Read-Only] Current: Current state, update as we execute the tree.

Type

(StateTreeHandle)

property next

[Read-Only] Next: Selected state, can be different from Transition, if Transition is a selector state.

Type

(StateTreeHandle)

property source

[Read-Only] Source: State where the transition started.

Type

(StateTreeStateStatus)

property target

[Read-Only] Target: Transition target state

Type

(StateTreeHandle)