Navigation
API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Animation
Inheritance Hierarchy
- FAnimNode_Base
- FAnimNode_AssetPlayerRelevancyBase
- FAnimNode_AssetPlayerBase
- FAnimNode_SequencePlayerBase
- FAnimNode_SequencePlayer
- FAnimNode_SequencePlayer_Standalone
References
| Module | Engine |
| Header | /Engine/Source/Runtime/Engine/Classes/Animation/AnimNode_AssetPlayerBase.h |
| Include | #include "Animation/AnimNode_AssetPlayerBase.h" |
Syntax
USTRUCT (BlueprintInternalUseOnly)
struct FAnimNode_AssetPlayerBase : public FAnimNode_AssetPlayerRelevancyBase
Remarks
Base class for any asset playing anim node
Variables
| Type | Name | Description | |
|---|---|---|---|
| bool | bHasBeenFullWeight | Track whether we have been full weight previously. Reset when we reach 0 weight | |
| float | BlendWeight | Last encountered blendweight for this node | |
| FDeltaTimeRecord | DeltaTimeRecord | Previous frame InternalTimeAccumulator value and effective delta time leading into the current frame | |
| float | InternalTimeAccumulator | Accumulated time used to reference the asset in this node | |
| FMarkerTickRecord | MarkerTickRecord | Store data about current marker position when using marker based syncing |
Constructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | CreateTickRecordForNode
(
const FAnimationUpdateContext& Context, |
Create a tick record for this node. | |
| EAnimSyncMethod | Get the sync group method we are using. | ||
| FName | GetGroupName () |
Get the sync group name we are using. | |
| EAnimGroupRole::Type | GetGroupRole () |
Get the sync group role we are using. | |
| bool | Get the flag that determines if this asset player will not sync to the previous leader's sync position when joining a sync group and before becoming the leader but instead force everyone else to match its position. | ||
| UE::Anim::FAnimSyncParams | GetSyncParams
(
bool bRequestedInertialization |
Get sync parameters for the tick record produced by this asset player | |
| bool | SetGroupMethod
(
EAnimSyncMethod InMethod |
Set the sync group method we are using. | |
| bool | SetGroupName
(
FName InGroupName |
Set the sync group name we are using. | |
| bool | SetGroupRole
(
EAnimGroupRole::Type InRole |
Set the sync group role we are using. | |
| bool | SetOverridePositionWhenJoiningSyncGroupAsLeader
(
bool InOverridePositionWhenJoiningSyncGroupAsLeader |
Set the flag that determines if this asset player will not sync to the previous leader's sync position when joining a sync group and before becoming the leader but instead force everyone else to match its position. | |
| void | UpdateAssetPlayer
(
const FAnimationUpdateContext& Context |
Update method for the asset player, to be implemented by derived classes |
Overridden from FAnimNode_AssetPlayerRelevancyBase
| Type | Name | Description | |
|---|---|---|---|
| void | Set the cached blendweight to zero | ||
| float | FAnimNode_RelevantAssetPlayerBase | ||
| float | Get the last encountered blend weight for this node | ||
| float | |||
| const FDeltaTimeRecord * | Get the delta time record owned by this asset player (or null) | ||
| void | SetAccumulatedTime
(
float NewTime |
Override the currently accumulated time |
Overridden from FAnimNode_Base
| Type | Name | Description | |
|---|---|---|---|
| void | Initialize_AnyThread
(
const FAnimationInitializeContext& Context |
Initialize function for setup purposes | |
| void | Update_AnyThread
(
const FAnimationUpdateContext& Context |
Update the node, marked final so we can always handle blendweight caching. |