1. Epic GamesDeveloper
  3. FStateTreeInstanceStorage

FStateTreeInstanceStorage

State Tree instance data is used to store the runtime state of a State Tree.

API > API/Plugins > API/Plugins/StateTreeModule

References

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

Syntax

USTRUCT ()  
struct FStateTreeInstanceStorage

Remarks

State Tree instance data is used to store the runtime state of a State Tree. It is used together with FStateTreeExecution context to tick the state tree. You are supposed to use FStateTreeInstanceData as a property to store the instance data. That ensures that any UObject references will get GC'd correctly.

The FStateTreeInstanceData wraps FStateTreeInstanceStorage, where the data is actually stored. This indirection is done in order to allow the FStateTreeInstanceData to be bitwise relocatable (e.g. you can put it in an array), and we can still allow delegates to bind to the instance data of individual tasks.

Since the tasks in the instance data are stored in a array that may get resized you will need to use TStateTreeInstanceDataStructRef to reference a struct based task instance data. It is defined below, and has example how to use it. Storage for the actual instance data.

Variables

  Type Name Description
Protected variable bool bIsOwningEventQueue True if the storage owns the event queue.
Protected variable TSharedRef< FStateTreeEventQueue > EventQueue Events (Transient)
Protected variable UProperty Transient FStateTreeExecutionState ExecutionState Execution state of the state tree instance.
Protected variable UProperty Transient FInstancedPropertyBag GlobalParameters Global parameters
Protected variable UProperty FInstancedStructContainer InstanceStructs Struct instances (Not transient, as we use FStateTreeInstanceData to store default values for instance data)
Protected variable UProperty Transient TArray< FStateTreeTemporaryInstanceData > TemporaryInstances Temporary instances
Protected variable UProperty Transient TArray< FStateTreeTransitionRequest > TransitionRequests Requested transitions

Constructors

  Type Name Description
Public function    
Public function    
Public function    

Functions

  Type Name Description
Public function void

AddStructReferencedObjects ( FReferenceCollector& Collector
)

 Note, called by FStateTreeInstanceData.
Public function FStructView

AddTemporaryInstance ( UObject& InOwner,
const FStateTreeExecutionFrame& Frame,
const FStateTreeIndex16 OwnerNodeIndex,
const FStateTreeDataHandle DataHandle,
FConstStructView NewInstanceData
)

 Adds temporary instance data associated with specified frame and data handle.
Public function void

AddTransitionRequest ( const UObject* Owner,
const FStateTreeTransitionRequest& Request
)

 Buffers a transition request to be sent to the State Tree.
Public function Const bool  
Public function Const const FStateTreeEventQueue &  
Public function Const const FStateTreeExecutionState &  
Public function Const FConstStructView  
Public function FStateTreeEventQueue &  
Public function FStateTreeExecutionState &  
Public function FStructView  
Public function Const UObject *

GetMutableObject ( const int32 Index
)

  
Public function FStructView

GetMutableStruct ( const int32 Index
)

  
Public function TArrayView< FStateTreeTemporaryInstanceData >  
Public function UObject *  
Public function FStructView  
Public function Const const UObject *

GetObject ( const int32 Index
)

  
Public function const TSharedRef< FStateTreeEventQueue > &  
Public function Const FConstStructView

GetStruct ( const int32 Index
)

  
Public function Const TConstArrayView< FStateTreeTransitionRequest >  
Public function Const bool

IsObject ( const int32 Index
)

  
Public function Const bool  
Public function Const bool

IsValid ()

  
Public function Const bool

IsValidIndex ( const int32 Index
)

  
Public function Const bool

IsValidStructIndex ( const int32 Index
)

  
Public function Const int32

Num ()

  
Public function Const int32  
Public function Const int32  
Public function void

Reset ()

 Resets the storage to initial state.
Public function void Empties the temporary instances.
Public function void Reset all pending transition requests.
Public function void

SetGlobalParameters ( const FInstancedPropertyBag& Parameters
)

 Stores copy of provided parameters as State Tree global parameters.
Public function void

SetSharedEventQueue ( const TSharedRef< FStateTreeEventQueue >& InSharedEventQueue
)

 Sets event queue from another storage. Marks the event queue not owned.

Operators

  Type Name Description
Public function FStateTreeInstanceStorage &  
Public function FStateTreeInstanceStorage &  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page