Navigation
API > API/Plugins > API/Plugins/UAFAnimGraph
Represents an instance of an AnimNext graph This struct uses UE reflection because we wish for the GC to keep the graph alive while we own a reference to it. It is not intended to be serialized on disk with a live instance.
| Name | FAnimNextGraphInstance |
| Type | struct |
| Header File | /Engine/Plugins/Experimental/UAF/UAFAnimGraph/Source/UAFAnimGraph/Public/Graph/AnimNextGraphInstance.h |
| Include Path | #include "Graph/AnimNextGraphInstance.h" |
Syntax
USTRUCT ()
struct FAnimNextGraphInstance : public FUAFAssetInstance
Inheritance Hierarchy
- FUAFAssetInstance → FAnimNextGraphInstance
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Creates an empty graph instance that doesn't reference anything. | Graph/AnimNextGraphInstance.h | ||
FAnimNextGraphInstance
(
const FAnimNextGraphInstance& |
No copying, no moving. | Graph/AnimNextGraphInstance.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FAnimNextGraphInstance() |
If the graph instance is allocated, we release it during destruction. | Graph/AnimNextGraphInstance.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bHasUpdatedOnce | bool | Whether or not this graph has updated once. | Graph/AnimNextGraphInstance.h | |
| EntryPoint | FName | The entry point in Graph that this instance corresponds to. | Graph/AnimNextGraphInstance.h | |
| FAnimNextModuleInjectionComponent | friend | Graph/AnimNextGraphInstance.h | ||
| FAnimNextStateTreeRigVMConditionBase | friend | Graph/AnimNextGraphInstance.h | ||
| FAnimNextStateTreeRigVMTaskBase | friend | Graph/AnimNextGraphInstance.h | ||
| FRigUnit_AnimNextGraphEvaluator | friend | Graph/AnimNextGraphInstance.h | ||
| FRigUnit_AnimNextRunAnimationGraph_v1 | friend | Graph/AnimNextGraphInstance.h | ||
| FRigUnit_AnimNextRunAnimationGraph_v2 | friend | Graph/AnimNextGraphInstance.h | ||
| GraphInstancePtr | UE::UAF::FTraitPtr | Hard reference to the graph instance data, we own it. | Graph/AnimNextGraphInstance.h | |
| ModuleInstance | FAnimNextModuleInstance * | The module instance that owns the root, us and the components. | Graph/AnimNextGraphInstance.h | |
| RootGraphInstance | FAnimNextGraphInstance * | The root graph instance that owns us and the components. | Graph/AnimNextGraphInstance.h | |
| UAnimNextAnimationGraph | friend | Graph/AnimNextGraphInstance.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const UAnimNextAnimationGraph * GetAnimationGraph() |
Returns the animation graph used by this instance or nullptr if the instance is invalid. | Graph/AnimNextGraphInstance.h | |
FName GetEntryPoint() |
Returns the entry point in Graph that this instance corresponds to. | Graph/AnimNextGraphInstance.h | |
UE::UAF::FWeakTraitPtr GetGraphRootPtr() |
Returns a weak handle to the root trait instance. | Graph/AnimNextGraphInstance.h | |
FAnimNextModuleInstance * GetModuleInstance() |
Returns the module instance that owns us or nullptr if we are invalid. | Graph/AnimNextGraphInstance.h | |
FAnimNextGraphInstance * GetParentGraphInstance() |
Returns the parent graph instance that owns us or nullptr for the root graph instance or if we are invalid. | Graph/AnimNextGraphInstance.h | |
FAnimNextGraphInstance * GetRootGraphInstance() |
Returns the root graph instance that owns us and the components or nullptr if we are invalid. | Graph/AnimNextGraphInstance.h | |
bool HasUpdated() |
Returns whether or not this graph instance has updated at least once. | Graph/AnimNextGraphInstance.h | |
bool IsRoot() |
Returns whether or not this graph instance is the root graph instance or false otherwise. | Graph/AnimNextGraphInstance.h | |
bool IsValid() |
Returns true if we have a live graph instance, false otherwise. | Graph/AnimNextGraphInstance.h | |
void MarkAsUpdated() |
Called each time the graph updates to mark the instance as updated. | Graph/AnimNextGraphInstance.h | |
void Release() |
Releases the graph instance and frees all corresponding memory. | Graph/AnimNextGraphInstance.h | |
bool UsesAnimationGraph
(
const UAnimNextAnimationGraph* InAnimationGraph |
Check to see if this instance data matches the provided animation graph. | Graph/AnimNextGraphInstance.h | |
bool UsesEntryPoint
(
FName InEntryPoint |
Check to see if this instance data matches the provided graph entry point. | Graph/AnimNextGraphInstance.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FAnimNextGraphInstance & operator=
(
const FAnimNextGraphInstance& |
Graph/AnimNextGraphInstance.h |