FActiveStatePath | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/StateTreeModule

Describe the state list used to get to a specific state. Since a state can be a subtree and can be linked to other states, the path to activate the subtree can be different. A state can enter, then exit, then reenter. It is considered the same state path but not the same unique state path. For a tree like RootA(0) StateA(1) StateB(2) LinkedStateA(3) StateC(4) LinkedStateA(5) SubTreeA(6) StateD(7) The path to get to StateD can be RootA.StateB.LinkedStateA.SubTreeA.StateD(0.2.3.6.7)


Name	FActiveStatePath
Type	class
Header File	/Engine/Plugins/Runtime/StateTree/Source/StateTreeModule/Public/StateTreeStatePath.h
Include Path	#include "StateTreeStatePath.h"

Syntax

class FActiveStatePath

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FActiveStatePath ()		StateTreeStatePath.h
FActiveStatePath ( TNotNull< const UStateTree* > InStateTree, const TArrayView< const FActiveState > InElements )		StateTreeStatePath.h
FActiveStatePath ( TNotNull< const UStateTree* > InStateTree, TArray< FActiveState > InElements )		StateTreeStatePath.h

Variables

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
States	TArray< FActiveState >		StateTreeStatePath.h
StateTree	TWeakObjectPtr< const UStateTree >		StateTreeStatePath.h

Functions

Public

Name	Remarks	Include Path	Unreal Specifiers
bool Contains ( FActiveState Other ) const		StateTreeStatePath.h
bool Contains ( FActiveStateID Other ) const		StateTreeStatePath.h
TValueOrError< FString, void > Describe ()		StateTreeStatePath.h
const TArrayView< const FActiveState > GetView()		StateTreeStatePath.h
int32 IndexOf ( FActiveStateID Other ) const		StateTreeStatePath.h
int32 IndexOf ( FActiveState Other ) const		StateTreeStatePath.h
const TArrayView< const FActiveState > Intersect ( const FActiveStatePath& Other ) const		StateTreeStatePath.h
bool Matches ( const FActiveStatePath& Other ) const		StateTreeStatePath.h
bool Matches ( FActiveState Other ) const		StateTreeStatePath.h
bool Matches ( FActiveStateID Other ) const		StateTreeStatePath.h
int32 Num()		StateTreeStatePath.h
bool StartsWith ( const FActiveStatePath& Other ) const		StateTreeStatePath.h

Static

Name	Remarks	Include Path	Unreal Specifiers
static bool Contains ( const TArrayView< const FActiveState >& Path, FActiveState Other )		StateTreeStatePath.h
static bool Contains ( const TArrayView< const FActiveState >& Path, FActiveStateID Other )		StateTreeStatePath.h
static TValueOrError< FString, void > Describe ( TNotNull< const UStateTree* > StateTree, const TArrayView< const FActiveState >& Path )		StateTreeStatePath.h
static int32 IndexOf ( const TArrayView< const FActiveState >& Path, FActiveStateID Other )		StateTreeStatePath.h
static int32 IndexOf ( const TArrayView< const FActiveState >& Path, FActiveState Other )		StateTreeStatePath.h
static const TArrayView< const FActiveState > Intersect ( const TArrayView< const FActiveState >& A, const TArrayView< const FActiveState >& B )		StateTreeStatePath.h
static bool Matches ( const TArrayView< const FActiveState >& A, const TArrayView< const FActiveState >& B )		StateTreeStatePath.h
static bool Matches ( const TArrayView< const FActiveState >& Path, FActiveState Other )		StateTreeStatePath.h
static bool Matches ( const TArrayView< const FActiveState >& Path, FActiveStateID Other )		StateTreeStatePath.h
static bool StartsWith ( const TArrayView< const FActiveState >& Path, const TArrayView< const FActiveState >& B )		StateTreeStatePath.h

Navigation