FUAFAssetInstance

Base struct for instances of UAF assets.

API > API/Plugins > API/Plugins/UAF

Base struct for instances of UAF assets.

   
Name FUAFAssetInstance
Type struct
Header File /Engine/Plugins/Experimental/UAF/UAF/Source/UAF/Public/UAFAssetInstance.h
Include Path #include "UAFAssetInstance.h"

Syntax

USTRUCT ()  
struct FUAFAssetInstance

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FUAFAssetInstance ( UScriptStruct* InScriptStruct
)

   UAFAssetInstance.h  
  UAFAssetInstance.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

EPropertyBagResult AccessVariable ( const FAnimNextVariableReference& InVariable,
TFunctionRef< void(ValueType&)> InFunction
) const

 Access a variable's value given its name. Type must match strictly, no conversions are performed. UAFAssetInstance.h  

bool AccessVariablesStruct ( const UScriptStruct* InStruct,
TFunctionRef< void(FStructView)> InFunction
) const

 Access the memory of the shared variable struct directly. UAFAssetInstance.h  

bool AccessVariablesStruct ( TFunctionRef< void(StructType&)> InFunction
) const

 Access the memory of the shared variable struct directly. UAFAssetInstance.h  

const DerivedType & As ()

 Returns this instance as the specified derived type. Asserts if our type is not a child type. UAFAssetInstance.h  

DerivedType & As ()

 Returns this instance as the specified derived type. Asserts if our type is not a child type. UAFAssetInstance.h  

DerivedType * AsPtr ()

 Returns this instance as the specified derived type, if our struct type is a child type. UAFAssetInstance.h  

const DerivedType * AsPtr ()

 Returns this instance as the specified derived type, if our struct type is a child type. UAFAssetInstance.h  

bool ExecuteParameterlessFunction ( const FAnimNextFunctionReference& InFunction,
void* OutReturnValue,
int32 ReturnValueSize
)

 Execute a bound parameterless function and copy the return value into OutReturnValue. UAFAssetInstance.h  

void ForEachComponent ( TFunctionRef< bool(ComponentType&)> InFunction
)

 Iterates all components, calling the supplied predicate. If the predicate returns false, iteration stops. UAFAssetInstance.h  

void ForEachVariablesStruct ( TFunctionRef< void(FStructView)> InFunction
) const

 Access the memory of the shared variable struct directly. UAFAssetInstance.h  

void GetAllVariablesOfType ( TArray< FAnimNextVariableReference >& OutVariables
) const

 Find references to all variables of the specified type UAFAssetInstance.h  

const AssetType * GetAsset()

 Get the asset that this instance represents. UAFAssetInstance.h  

FName GetAssetName()

 Safely get the name of the asset that this host provides. UAFAssetInstance.h  

FUAFAssetInstance * GetHost()

 Get the instance (graph, module etc.) that owns/hosts us. UAFAssetInstance.h  
Returns an instance component of the requested type, creating it lazily the first time it is queried. UAFAssetInstance.h  

ComponentType & GetOrAddComponent ()

 Returns a typed instance component, creating it lazily the first time it is queried. UAFAssetInstance.h  

FAnimNextModuleInstance * GetRootInstance()

 Get the root module instance that owns us. Can be nullptr in some cases, such as automated tests. UAFAssetInstance.h  

const UScriptStruct * GetScriptStruct()

 Get the struct type of this instance. UAFAssetInstance.h  

uint64 GetUniqueId()

   UAFAssetInstance.h  

EPropertyBagResult GetVariable ( const FAnimNextVariableReference& InVariable,
ValueType& OutResult
) const

 Get a variable's value given its name, copying the value to OutResult. UAFAssetInstance.h  

EPropertyBagResult GetVariable ( const FAnimNextVariableReference& InVariable,
const FAnimNextParamType& InType,
TArrayView< uint8 > OutResult
) const

 Get a variable's value given its name, copying the value to OutResult. UAFAssetInstance.h  
  UAFAssetInstance.h  
  UAFAssetInstance.h  

bool LayoutMatches ( const FInstancedPropertyBag& InPropertyBag
) const

 Validate that the supplied property bag is of the same layout as this instance's variables. UAFAssetInstance.h  

void SetDebugName ( FName Name
)

 Sets the debug name for the instance, used for tracing etc. UAFAssetInstance.h  

EPropertyBagResult SetVariable ( const FAnimNextVariableReference& InVariable,
const ValueType& InNewValue
) const

 Set a variable's value given a reference. UAFAssetInstance.h  

EPropertyBagResult SetVariable ( const FAnimNextVariableReference& InVariable,
const FAnimNextParamType& InType,
TConstArrayView< uint8 > InNewValue
) const

 Set a variable's value given a reference. UAFAssetInstance.h  

ComponentType * TryGetComponent ()

 Returns a typed instance component pointer if found or nullptr otherwise. UAFAssetInstance.h  

const ComponentType * TryGetComponent ()

 Returns a typed instance component pointer if found or nullptr otherwise (const). UAFAssetInstance.h  
Returns a typed instance component pointer if found or nullptr otherwise. UAFAssetInstance.h  

Protected

Name Remarks Include Path Unreal Specifiers

void AccessVariablePropertyByIndex ( int32 InIndex,
TFunctionRef< void(const FProperty*, TArrayView< uint8 >)> InFunction
)

 Access the variable by index directly. UAFAssetInstance.h  

void BindDefaultComponents()

 Binds all components during initialization (once instance has been set up, variables created etc.) UAFAssetInstance.h  

void CopyDefaultComponents()

 Used on instance initialization to copy default components from the asset. UAFAssetInstance.h  

FName GetDebugName()

   UAFAssetInstance.h  

void InitializeVariables ( const TSharedPtr< const UE::UAF::FVariableOverridesCollection >& InOverrides
)

   UAFAssetInstance.h  

void MigrateVariables()

   UAFAssetInstance.h  

void ReleaseComponents()

 Releases any components this instance hosts. UAFAssetInstance.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page