unreal.StateTreeTransitionResult

class unreal.StateTreeTransitionResult(current_active_states: StateTreeActiveStates = [], current_run_status: StateTreeRunStatus = Ellipsis, target_state: StateTreeStateHandle = [], next_active_states: StateTreeActiveStates = [], current_state: StateTreeStateHandle = [], change_type: StateTreeStateChangeType = Ellipsis)

Bases: 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)

  • change_type (StateTreeStateChangeType): [Read-Write] Change Type: If the change type is Sustained, then the CurrentState was reselected, or if Changed then the state was just activated.

  • current_active_states (StateTreeActiveStates): [Read-Write] Current Active States: Current active states, where the transition started.

  • current_run_status (StateTreeRunStatus): [Read-Write] Current Run Status: Current Run status.

  • current_state (StateTreeStateHandle): [Read-Write] Current State: The current state being executed. On enter/exit callbacks this is the state of the task or evaluator.

  • next_active_states (StateTreeActiveStates): [Read-Write] Next Active States: States selected as result of the transition.

  • target_state (StateTreeStateHandle): [Read-Write] Target State: Transition target state

property change_type: StateTreeStateChangeType

[Read-Only] Change Type: If the change type is Sustained, then the CurrentState was reselected, or if Changed then the state was just activated.

Type:

(StateTreeStateChangeType)

property current_active_states: StateTreeActiveStates

[Read-Only] Current Active States: Current active states, where the transition started.

Type:

(StateTreeActiveStates)

property current_run_status: StateTreeRunStatus

[Read-Only] Current Run Status: Current Run status.

Type:

(StateTreeRunStatus)

property current_state: StateTreeStateHandle

[Read-Only] Current State: The current state being executed. On enter/exit callbacks this is the state of the task or evaluator.

Type:

(StateTreeStateHandle)

property next_active_states: StateTreeActiveStates

[Read-Only] Next Active States: States selected as result of the transition.

Type:

(StateTreeActiveStates)

property target_state: StateTreeStateHandle

[Read-Only] Target State: Transition target state

Type:

(StateTreeStateHandle)