1. Epic GamesDeveloper
  3. FStateTreeInstanceData

FStateTreeInstanceData

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

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 FStateTreeInstanceData

Remarks

StateTree instance data is used to store the runtime state of a StateTree. The layout of the data is described in a FStateTreeInstanceDataLayout.

Note: If FStateTreeInstanceData is placed on an struct, you must call AddStructReferencedObjects() manually, as it is not automatically called recursively. Note: Serialization is supported only for FArchive::IsModifyingWeakAndStrongReferences(), that is replacing object references.

Variables

  Type Name Description
Protected variable TSharedRef< FStateTreeInstanceStorage > InstanceStorage Storage for the actual instance data, always stores FStateTreeInstanceStorage.

Constructors

  Type Name Description
Public function    
Public function    
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

AddStructReferencedObjects ( FReferenceCollector& Collector
)

  
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 void

Append ( UObject& InOwner,
TConstArrayView< FConstStructView > InStructs,
TConstArrayView< FInstancedStruct* > InInstancesToMove
)

 Appends new items to the instance, and moves existing data into the allocated instances.
Public function void

Append ( UObject& InOwner,
TConstArrayView< FInstancedStruct > InStructs,
TConstArrayView< const UObject* > InObjects
)

  
Public function void

Append ( UObject& InOwner,
TConstArrayView< FConstStructView > InStructs,
TConstArrayView< const UObject* > InObjects
)

  
Public function void

Append ( UObject& InOwner,
TConstArrayView< FConstStructView > InStructs
)

  
Public function void

Append ( UObject& InOwner,
TConstArrayView< FInstancedStruct > InStructs
)

 Appends new items to the instance.
Public function Const bool  
Public function void

CopyFrom ( UObject& InOwner,
const FStateTreeInstanceData& InOther
)

 Shares the layout from another instance data, and copies the data over.
Public function Const int32  
Public function Const const FStateTreeEventQueue &  
Public function Const const FStateTreeExecutionState *  
Public function FStateTreeEventQueue &  
Public function FStateTreeExecutionState *  
Public function UObject *

GetMutableObject ( const int32 Index
)

  
Public function FStateTreeInstanceStorage &  
Public function FStructView

GetMutableStruct ( const int32 Index
)

  
Public function UObject *  
Public function FStructView  
Public function Const int32  
Public function Const const UObject *

GetObject ( const int32 Index
)

  
Public function void

GetPreloadDependencies ( TArray< UObject* >& OutDeps
)

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

GetStruct ( const int32 Index
)

  
Public function Const TConstArrayView< FStateTreeTransitionRequest >  
Public function TWeakPtr< FStateTreeInstanceStorage >  
Public function Const TWeakPtr< const FStateTreeInstanceStorage >  
Public function Const bool

Identical ( const FStateTreeInstanceData* Other,
uint32 PortFlags
)

 Type traits
Public function void

Init ( UObject& InOwner,
TConstArrayView< FInstancedStruct > InStructs,
TConstArrayView< const UObject* > InObjects
)

  
Public function void

Init ( UObject& InOwner,
TConstArrayView< FConstStructView > InStructs
)

  
Public function void

Init ( UObject& InOwner,
TConstArrayView< FInstancedStruct > InStructs
)

 Initializes the array with specified items.
Public function void

Init ( UObject& InOwner,
TConstArrayView< FConstStructView > InStructs,
TConstArrayView< const UObject* > InObjects
)

  
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 data to empty.
Public function void Empties the temporary instances.
Public function void Reset all pending transition requests.
Public function bool

Serialize ( FArchive& Ar
)

  
Public function void

SetSharedEventQueue ( const TSharedRef< FStateTreeEventQueue >& InSharedEventQueue
)

 Sets event queue from another instance data. Marks the event queue not owned.
Public function void

ShrinkTo ( const int32 Num
)

 Shrinks the array sizes to specified lengths. Sizes must be small or equal than current size.
Public function void

ShrinkTo ( const int32 NumStructs,
const int32 NumObjects
)

  

Operators

  Type Name Description
Public function FStateTreeInstanceData &  
Public function FStateTreeInstanceData &  

Deprecated Variables

  Type Name Description
Protected variable UProperty PRAGMA_DISABLE_DEPRECATION_WARNINGS TInstancedStruct< FStateTreeInstanceStorage > InstanceStorage_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page