unreal.GameplayStateTreeLibrary

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

Bases: BlueprintFunctionLibrary

Gameplay State Tree Blueprint Function Library

C++ Source:

  • Plugin: GameplayStateTree

  • Module: GameplayStateTreeModule

  • File: GameplayStateTreeBlueprintFunctionLibrary.h

classmethod run_state_tree(actor, state_tree_asset) → bool

Starts executing an instance of the provided state tree asset on the specified actor. This will use the existing required component if present or add it if missing.

Parameters:

  • actor (Actor) – The actor on which the StateTree must be executed.

  • state_tree_asset (StateTree) – The state tree asset to execute

Returns:

Whether a state tree instance was successfully started

Return type:

bool