Navigation
API > API/Plugins > API/Plugins/UAFAnimNode
Contains the necessary machinery for traversal during the update pass.
| Name | FUAFAnimGraphUpdateContext |
| Type | class |
| Header File | /Engine/Plugins/Experimental/UAF/UAFAnimNode/Source/UAFAnimNode/Public/UAF/AnimNodeCore/UAFAnimNodeUpdate.h |
| Include Path | #include "UAF/AnimNodeCore/UAFAnimNodeUpdate.h" |
Syntax
class FUAFAnimGraphUpdateContext
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FUAFAnimGraphUpdateContext
(
UObject* HostObject, |
UAF/AnimNodeCore/UAFAnimNodeUpdate.h | ||
| UAF/AnimNodeCore/UAFAnimNodeUpdate.h | |||
| UAF/AnimNodeCore/UAFAnimNodeUpdate.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FUAFAnimGraphUpdateContext() |
UAF/AnimNodeCore/UAFAnimNodeUpdate.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CurrentPlayRate | float | The currently active play rate. | UAF/AnimNodeCore/UAFAnimNodeUpdate.h | |
| DeltaTime | float | The delta time as currently scaled by the play rate. | UAF/AnimNodeCore/UAFAnimNodeUpdate.h | |
| FUAFAnimNode | friend | UAF/AnimNodeCore/UAFAnimNodeUpdate.h | ||
| GCReferences | FUAFAnimNodeReferenceCollector & | UAF/AnimNodeCore/UAFAnimNodeUpdate.h | ||
| HostObject | UObject * | UAF/AnimNodeCore/UAFAnimNodeUpdate.h | ||
| NodesPendingDestruction | TArray< FUAFAnimNode * > | UAF/AnimNodeCore/UAFAnimNodeUpdate.h | ||
| PreviousContext | FUAFAnimGraphUpdateContext * | UAF/AnimNodeCore/UAFAnimNodeUpdate.h | ||
| PreviousPlayRateStack | TArray< float > | A stack of previous play rates. | UAF/AnimNodeCore/UAFAnimNodeUpdate.h | |
| UpdateCounter | uint32 | Debug counter used to enforce invariants. | UAF/AnimNodeCore/UAFAnimNodeUpdate.h | |
| UpdateDeltaTime | float | The unscaled delta time used by the update pass. | UAF/AnimNodeCore/UAFAnimNodeUpdate.h | |
| VariablesOwner | FUAFAssetInstance * | UAF/AnimNodeCore/UAFAnimNodeUpdate.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
float GetDeltaTime() |
Returns how much time should the update pass advance by factoring in the current play rate scaling. | UAF/AnimNodeCore/UAFAnimNodeUpdate.h | |
FUAFAnimNodeReferenceCollector & GetGCReferences() |
Returns a reference collector for anim nodes that need exposure to GC. | UAF/AnimNodeCore/UAFAnimNodeUpdate.h | |
UObject * GetHostObject() |
Returns the object that hosts the current graph. | UAF/AnimNodeCore/UAFAnimNodeUpdate.h | |
float GetPlayRate() |
Returns the currently applied play rate when computing the delta time. | UAF/AnimNodeCore/UAFAnimNodeUpdate.h | |
uint32 GetUpdateCounter() |
Debug counter used to enforce invariants. | UAF/AnimNodeCore/UAFAnimNodeUpdate.h | |
float GetUpdateDeltaTime() |
Returns how much time should the update pass advance by. | UAF/AnimNodeCore/UAFAnimNodeUpdate.h | |
FUAFAssetInstance * GetVariablesOwner() |
Returns the UAF asset that owns the shared variables. | UAF/AnimNodeCore/UAFAnimNodeUpdate.h | |
void PopPlayRate() |
Pops the most recent play rate scale from the top of the stack. | UAF/AnimNodeCore/UAFAnimNodeUpdate.h | |
void PushPlayRate
(
float PlayRate |
Pushes a new play rate scale on top of the stack. | UAF/AnimNodeCore/UAFAnimNodeUpdate.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FUAFAnimGraphUpdateContext * GetCurrentFromTLS() |
Returns the current update context in use on this thread or nullptr if none are within our current scope. | UAF/AnimNodeCore/UAFAnimNodeUpdate.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| UAF/AnimNodeCore/UAFAnimNodeUpdate.h | |||
| UAF/AnimNodeCore/UAFAnimNodeUpdate.h |