1. Epic GamesDeveloper
  3. FStateTreeActiveStates

FStateTreeActiveStates

Describes an array of active states in a State Tree.

API > API/Plugins > API/Plugins/StateTreeModule

References

   
Module StateTreeModule
Header /Engine/Plugins/Runtime/StateTree/Source/StateTreeModule/Public/StateTreeExecutionTypes.h
Include #include "StateTreeExecutionTypes.h"

Syntax

USTRUCT (BlueprintType )  
struct FStateTreeActiveStates

Remarks

Describes an array of active states in a State Tree.

Variables

  Type Name Description
Public variable UProperty Category, EditDefaultsOnly uint8 NumStates  
Public variable UProperty Category, EditDefaultsOnly FStateTreeStateHandle[MaxStates] States  

Constructors

  Type Name Description
Public function    
Public function    

Functions

  Type Name Description
Public function FStateTreeStateHandle *

begin ()

 DO NOT USE DIRECTLY STL-like iterators to enable range-based for loop support.
Public function Const const FStateTreeStateHandle *

begin ()

  
Public function Const bool

Contains ( const FStateTreeStateHandle StateHandle,
const uint8 MaxNumStatesToCheck
)

 Returns true of the array contains specified state within MaxNumStatesToCheck states.
Public function Const bool

Contains ( const FStateTreeStateHandle StateHandle
)

 Returns true of the array contains specified state.
Public function Const const FStateTreeStateHandle *

end ()

  
Public function FStateTreeStateHandle *

end ()

  
Public function Const FStateTreeStateHandle

GetStateSafe ( const int32 Index
)

 Returns a specified state in the array, or FStateTreeStateHandle::Invalid if Index is out of array bounds.
Public function Const int32

IndexOfReverse ( const FStateTreeStateHandle StateHandle
)

 Returns index of a state, searching in reverse order.
Public function Const bool

IsEmpty ()

 Returns true if the array is empty.
Public function Const bool

IsValidIndex ( const int32 Index
)

 Returns true if the index is within array bounds.
Public function Const FStateTreeStateHandle

Last ()

 Returns last state in the array, or invalid state if the array is empty.
Public function Const int32

Num ()

 Returns number of states in the array.
Public function FStateTreeStateHandle

Pop ()

 Pops a state from the back of the array and returns the popped value, or invalid handle if the array was empty.
Public function bool

Push ( const FStateTreeStateHandle StateHandle
)

 Pushes new state at the back of the array and returns true if there was enough space.
Public function bool

PushFront ( const FStateTreeStateHandle StateHandle
)

 Pushes new state at the front of the array and returns true if there was enough space.
Public function void

Reset ()

 Resets the active state array to empty.
Public function void

SetNum ( const int32 NewNum
)

 Sets the number of states, new states are set to invalid state.

Operators

  Type Name Description
Public function FStateTreeStateHandle &

operator[] ( const int32 Index
)

 Returns mutable reference to a specified state in the array.
Public function Const const FStateTreeStateHandle &

operator[] ( const int32 Index
)

 Returns a specified state in the array.

Constants

Name Description
MaxStates  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page