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

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.

   
Name FStateTreeInstanceData
Type struct
Header File /Engine/Plugins/Runtime/StateTree/Source/StateTreeModule/Public/StateTreeInstanceData.h
Include Path #include "StateTreeInstanceData.h"

Syntax

USTRUCT ()  
struct FStateTreeInstanceData

Constructors

Name Remarks Include Path Unreal Specifiers
  StateTreeInstanceData.h  
  StateTreeInstanceData.h  
  StateTreeInstanceData.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FStateTreeInstanceData()

   StateTreeInstanceData.h  

Structs

Name Remarks
FAddArgs  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddStructReferencedObjects ( FReferenceCollector& Collector
)

   StateTreeInstanceData.h  

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. StateTreeInstanceData.h  

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

 Buffers a transition request to be sent to the State Tree. StateTreeInstanceData.h  

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

 Appends new items to the instance, and moves existing data into the allocated instances. StateTreeInstanceData.h  

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

   StateTreeInstanceData.h  

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

 Appends new items to the instance. StateTreeInstanceData.h  

bool AreAllInstancesValid()

   StateTreeInstanceData.h  

void CopyFrom ( UObject& InOwner,
const FStateTreeInstanceData& InOther
)

 Shares the layout from another instance data, and copies the data over. StateTreeInstanceData.h  

int32 GetEstimatedMemoryUsage()

   StateTreeInstanceData.h  

const FStateTreeEventQueue & GetEventQueue()

   StateTreeInstanceData.h  

const FStateTreeExecutionState * GetExecutionState()

   StateTreeInstanceData.h  

FStateTreeEventQueue & GetMutableEventQueue()

   StateTreeInstanceData.h  

FStateTreeExecutionState * GetMutableExecutionState()

   StateTreeInstanceData.h  

UObject * GetMutableObject ( const int32 Index
)

   StateTreeInstanceData.h  

FStateTreeInstanceStorage & GetMutableStorage()

   StateTreeInstanceData.h  

FStructView GetMutableStruct ( const int32 Index
)

   StateTreeInstanceData.h  

UObject * GetMutableTemporaryObject ( const FStateTreeExecutionFrame& Frame,
const FStateTreeDataHandle DataHandle
)

   StateTreeInstanceData.h  

FStructView GetMutableTemporaryStruct ( const FStateTreeExecutionFrame& Frame,
const FStateTreeDataHandle DataHandle
)

   StateTreeInstanceData.h  

const UObject * GetObject ( const int32 Index
) const

   StateTreeInstanceData.h  

void GetPreloadDependencies ( TArray< UObject* >& OutDeps
)

   StateTreeInstanceData.h  
Get the data used at runtime to confirm the inner working of the StateTree. StateTreeInstanceData.h  

const TSharedRef< FStateTreeEventQueue > & GetSharedMutableEventQueue()

   StateTreeInstanceData.h  

const FStateTreeInstanceStorage & GetStorage()

   StateTreeInstanceData.h  

FConstStructView GetStruct ( const int32 Index
) const

   StateTreeInstanceData.h  

TConstArrayView< FStateTreeTransitionRequest > GetTransitionRequests()

   StateTreeInstanceData.h  

TWeakPtr< FStateTreeInstanceStorage > GetWeakMutableStorage()

   StateTreeInstanceData.h  

TWeakPtr< const FStateTreeInstanceStorage > GetWeakStorage()

   StateTreeInstanceData.h  

bool Identical ( const FStateTreeInstanceData* Other,
uint32 PortFlags
) const

 Type traits StateTreeInstanceData.h  

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

   StateTreeInstanceData.h  

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

 Initializes the array with specified items. StateTreeInstanceData.h  

bool IsObject ( const int32 Index
) const

   StateTreeInstanceData.h  

bool IsOwningEventQueue()

   StateTreeInstanceData.h  

bool IsValidIndex ( const int32 Index
) const

   StateTreeInstanceData.h  

int32 Num()

   StateTreeInstanceData.h  

void Reset()

 Resets the data to empty. StateTreeInstanceData.h  

void ResetTemporaryInstances()

 Empties the temporary instances. StateTreeInstanceData.h  

void ResetTransitionRequests()

 Reset all pending transition requests. StateTreeInstanceData.h  

bool Serialize ( FArchive& Ar
)

   StateTreeInstanceData.h  

void SetSharedEventQueue ( const TSharedRef< FStateTreeEventQueue >& InSharedEventQueue
)

 Sets event queue from another instance data. Marks the event queue not owned. StateTreeInstanceData.h  

void ShrinkTo ( const int32 Num
)

 Shrinks the array sizes to specified lengths. Sizes must be small or equal than current size. StateTreeInstanceData.h  

Operators

Name Remarks Include Path Unreal Specifiers
  StateTreeInstanceData.h  
  StateTreeInstanceData.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
InstanceStorage_DEPRECATED PRAGMA_DISABLE_DEPRECATION_WARNINGSTInstancedStruct< FStateTreeInstanceStorage >   StateTreeInstanceData.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page