unreal.StateTreeEditorData

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

Bases: Object

Edit time data for StateTree asset. This data gets baked into runtime format before being used by the StateTreeInstance.

C++ Source:

  • Plugin: StateTree

  • Module: StateTreeEditorModule

  • File: StateTreeEditorData.h

Editor Properties: (see get_editor_property/set_editor_property)

  • colors (Set[StateTreeEditorColor]): [Read-Write] Color Options to assign to a State

  • evaluators (Array[StateTreeEditorNode]): [Read-Write]

  • extensions (Array[StateTreeEditorDataExtension]): [Read-Write] The editor data extensions. A place to add extra information for plugins.

  • global_tasks (Array[StateTreeEditorNode]): [Read-Write]

  • global_tasks_completion (StateTreeTaskCompletionType): [Read-Write]

  • root_parameter_property_bag (InstancedPropertyBag): [Read-Write] Public parameters property bag that could be used for bindings within the Tree.

  • root_parameters (StateTreeStateParameters): [Read-Write] deprecated: Property ‘RootParameters’ is deprecated.

  • schema (StateTreeSchema): [Read-Write] Schema describing which inputs, evaluators, and tasks a StateTree can contain.

  • sub_trees (Array[StateTreeState]): [Read-Write] Top level States.

property evaluators: None

[Read-Only]

Type:

(Array[StateTreeEditorNode])

classmethod get_editor_data(state_tree) StateTreeEditorData
Parameters:

state_tree (StateTree)

Returns:

The editor data for a StateTree asset, or nullptr if unavailable.

Return type:

StateTreeEditorData

get_node_description(node, formatting=StateTreeNodeFormatting.TEXT) Text

Returns the description for the node for UI. Handles the name override logic, figures out required data for the GetDescription() call, and handles the fallbacks.

Parameters:
Returns:

description for the node.

Return type:

Text

property global_tasks: None

[Read-Only]

Type:

(Array[StateTreeEditorNode])

k2_get_extension(extension_type) StateTreeEditorDataExtension

Find the first extension of the requested type.

Parameters:

extension_type (type(Class))

Return type:

StateTreeEditorDataExtension

property root_parameters: StateTreeStateParameters

[Read-Write] deprecated: Property ‘RootParameters’ is deprecated.

Type:

(StateTreeStateParameters)

property routines: None

‘routines’ was renamed to ‘sub_trees’.

Type:

deprecated

property sub_trees: None

[Read-Only] Top level States.

Type:

(Array[StateTreeState])