1. Epic GamesDeveloper
  3. UAnimNextComponent

UAnimNextComponent

API > API/Plugins > API/Plugins/AnimNext

   
Name UAnimNextComponent
Type class
Header File /Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/Component/AnimNextComponent.h
Include Path #include "Component/AnimNextComponent.h"

Syntax

UCLASS (MinimalAPI, Meta=(BlueprintSpawnableComponent))  
class UAnimNextComponent :  
    public UActorComponent ,  
    public IAnimNextVariableProxyHost

Inheritance Hierarchy

Implements Interfaces

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bShowDebugDrawing uint8 When checked, the module's debug drawing instructions are drawn in the viewport Component/AnimNextComponent.h
  • EditAnywhere
  • Category="Rendering"
InitMethod EAnimNextModuleInitMethod How to initialize the module. Component/AnimNextComponent.h
  • EditAnywhere
  • Category="Module"
Module TObjectPtr< UAnimNextModule > The AnimNext module that this component will run. Component/AnimNextComponent.h
  • EditAnywhere
  • Category="Module"
ModuleHandle UE::AnimNext::FModuleHandle Handle to the registered module. Component/AnimNextComponent.h  
PublicVariablesLock FRWLock Lock for public variables proxy. Component/AnimNextComponent.h  
PublicVariablesProxy FAnimNextPublicVariablesProxy Proxy public variables. Component/AnimNextComponent.h  
PublicVariablesProxyMap TMap< FName, int32 > Map from name->proxy variable index. Component/AnimNextComponent.h  
Subsystem TObjectPtr< UAnimNextComponentWorldSubsystem >   Component/AnimNextComponent.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddComponentPrerequisite ( UActorComponent* Component,
FName EventName
)

 Add a prerequisite dependency on the component's primary tick function to the specified event The component will tick before the event Component/AnimNextComponent.h
  • BlueprintCallable
  • Category="UAF"

void AddComponentSubsequent ( UActorComponent* Component,
FName EventName
)

 Add a subsequent dependency on the component's primary tick function to the specified event The component will tick after the event Component/AnimNextComponent.h
  • BlueprintCallable
  • Category="UAF"

void AddModuleEventPrerequisite ( FName InEventName,
UAnimNextComponent* OtherAnimNextComponent,
FName OtherEventName
)

 Add a prerequisite anim next event dependency to the specified event Component/AnimNextComponent.h
  • BlueprintCallable
  • Category="UAF"

void AddModuleEventSubsequent ( FName InEventName,
UAnimNextComponent* OtherAnimNextComponent,
FName OtherEventName
)

 Add a subsequent anim next event dependency to the specified event Component/AnimNextComponent.h
  • BlueprintCallable
  • Category="UAF"

void AddPrerequisite ( UObject* InObject,
FTickFunction& InTickFunction,
FName InEventName
)

 Add a prerequisite tick function dependency to the specified event Component/AnimNextComponent.h  

void AddSubsequent ( UObject* InObject,
FTickFunction& InTickFunction,
FName InEventName
)

 Add a subsequent tick function dependency to the specified event Component/AnimNextComponent.h  

FAnimNextModuleHandle BlueprintGetModuleHandle()

   Component/AnimNextComponent.h
  • BlueprintCallable
  • Category="UAF"
  • Meta=(DisplayName="Get Module Handle")

const FTickFunction * FindTickFunction ( FName InEventName
) const

 Find the tick function for the specified event Component/AnimNextComponent.h  

UE::AnimNext::FModuleHandle GetModuleHandle()

 Get the handle to the registered module. Component/AnimNextComponent.h  

TOptional< bool > GetVariableBool ( const FName Name
) const

 Module variable value getters. Component/AnimNextComponent.h  

TOptional< uint8 > GetVariableByte ( const FName Name
) const

   Component/AnimNextComponent.h  

TOptional< const UClass * > GetVariableClass ( const FName Name
) const

   Component/AnimNextComponent.h  

TOptional< double > GetVariableDouble ( const FName Name
) const

   Component/AnimNextComponent.h  

TOptional< T > GetVariableEnum ( const FName Name
) const

   Component/AnimNextComponent.h  

TOptional< uint8 > GetVariableEnum ( const FName Name,
const UEnum* RequestedEnum
) const

   Component/AnimNextComponent.h  

TOptional< float > GetVariableFloat ( const FName Name
) const

   Component/AnimNextComponent.h  

TOptional< int32 > GetVariableInt32 ( const FName Name
) const

   Component/AnimNextComponent.h  

TOptional< int64 > GetVariableInt64 ( const FName Name
) const

   Component/AnimNextComponent.h  

TOptional< FName > GetVariableName ( const FName Name
) const

   Component/AnimNextComponent.h  

TOptional< const T * > GetVariableObject ( const FName Name
) const

   Component/AnimNextComponent.h  

TOptional< const UObject * > GetVariableObject ( const FName Name,
const UClass* RequestedClass
) const

   Component/AnimNextComponent.h  

TOptional< FSoftObjectPath > GetVariableSoftPath ( const FName Name
) const

   Component/AnimNextComponent.h  

TOptional< FString > GetVariableString ( const FName Name
) const

   Component/AnimNextComponent.h  

TOptional< const T * > GetVariableStruct ( const FName Name
) const

   Component/AnimNextComponent.h  

TOptional< FConstStructView > GetVariableStruct ( const FName Name,
const UScriptStruct* RequestedStruct
) const

   Component/AnimNextComponent.h  

TOptional< uint32 > GetVariableUInt32 ( const FName Name
) const

   Component/AnimNextComponent.h  

TOptional< uint64 > GetVariableUInt64 ( const FName Name
) const

   Component/AnimNextComponent.h  

bool IsEnabled()

 Whether this component is currently updating. Component/AnimNextComponent.h
  • BlueprintCallable
  • Category="UAF"

void QueueInputTraitEvent ( FAnimNextTraitEventPtr Event
)

 Queues an input trait event Input events will be processed in the next graph update after they are queued Component/AnimNextComponent.h  

void QueueTask ( FName InModuleEventName,
TUniqueFunction< void(const UE::AnimNext::FModuleTaskContext&)>&& InTaskFunction,
UE::AnimNext::ETaskRunLocation InLocation
)

 Queue a task to run during execution. Component/AnimNextComponent.h  

void RemoveComponentPrerequisite ( UActorComponent* Component,
FName EventName
)

 Remove a prerequisite on the component's primary tick function from the specified event Component/AnimNextComponent.h
  • BlueprintCallable
  • Category="UAF"

void RemoveComponentSubsequent ( UActorComponent* Component,
FName EventName
)

 Remove a subsequent dependency on the component's primary tick function from the specified event Component/AnimNextComponent.h
  • BlueprintCallable
  • Category="UAF"

void RemoveModuleEventPrerequisite ( FName InEventName,
UAnimNextComponent* OtherAnimNextComponent,
FName OtherEventName
)

 Remove a prerequisite anim next event dependency from the specified event Component/AnimNextComponent.h
  • BlueprintCallable
  • Category="UAF"

void RemoveModuleEventSubsequent ( FName InEventName,
UAnimNextComponent* OtherAnimNextComponent,
FName OtherEventName
)

 Remove a subsequent anim next event dependency from the specified event Component/AnimNextComponent.h
  • BlueprintCallable
  • Category="UAF"

void RemovePrerequisite ( UObject* InObject,
FTickFunction& InTickFunction,
FName InEventName
)

 Remove a prerequisite tick function dependency from the specified event Component/AnimNextComponent.h  

void RemoveSubsequent ( UObject* InObject,
FTickFunction& InTickFunction,
FName InEventName
)

 Remove a prerequisite tick function dependency from the specified event Component/AnimNextComponent.h  

void SetEnabled ( bool bEnabled
)

 Enable or disable this component's update. Component/AnimNextComponent.h
  • BlueprintCallable
  • Category="UAF"

void SetVariable ( FName Name,
int32 Value
)

 Sets a module variable's value. Component/AnimNextComponent.h
  • BlueprintCallable
  • Category="UAF"
  • CustomThunk
  • Meta=(CustomStructureParam=Value, UnsafeDuringActorConstruction)

bool SetVariableArrayRef ( const FName Name,
TFunctionRef< void(FPropertyBagArrayRef&)> InArrayRefSetter
)

   Component/AnimNextComponent.h  

bool SetVariableBool ( const FName Name,
const bool bInValue
)

 Module variable value setters. Component/AnimNextComponent.h  

bool SetVariableByte ( const FName Name,
const uint8 InValue
)

   Component/AnimNextComponent.h  

bool SetVariableClass ( const FName Name,
UClass* InValue
)

   Component/AnimNextComponent.h  

bool SetVariableDouble ( const FName Name,
const double InValue
)

   Component/AnimNextComponent.h  

bool SetVariableEnum ( const FName Name,
const uint8 InValue,
const UEnum* Enum
)

   Component/AnimNextComponent.h  

bool SetVariableEnum ( const FName Name,
const T InValue
)

 Sets enum variable with specified type. Component/AnimNextComponent.h  

bool SetVariableFloat ( const FName Name,
const float InValue
)

   Component/AnimNextComponent.h  

bool SetVariableInt32 ( const FName Name,
const int32 InValue
)

   Component/AnimNextComponent.h  

bool SetVariableInt64 ( const FName Name,
const int64 InValue
)

   Component/AnimNextComponent.h  

bool SetVariableName ( const FName Name,
const FName InValue
)

   Component/AnimNextComponent.h  

bool SetVariableObject ( const FName Name,
UObject* InValue
)

   Component/AnimNextComponent.h  

bool SetVariableObject ( const FName Name,
T* InValue
)

 Sets object pointer variable with specified type. Component/AnimNextComponent.h  

bool SetVariableObjectRef ( const FName Name,
TFunctionRef< void(UObject*)> InObjectRefSetter,
const UClass* RequestedClass
)

   Component/AnimNextComponent.h  

bool SetVariableSoftPath ( const FName Name,
const FSoftObjectPath& InValue
)

   Component/AnimNextComponent.h  

bool SetVariableString ( const FName Name,
const FString& InValue
)

   Component/AnimNextComponent.h  

bool SetVariableStruct ( const FName Name,
const T& InValue
)

 Sets struct variable with specified type. Component/AnimNextComponent.h  

bool SetVariableStruct ( const FName Name,
FConstStructView InValue
)

   Component/AnimNextComponent.h  

bool SetVariableStructRef ( const FName Name,
TFunctionRef< void(FStructView)> InStructRefSetter,
const UScriptStruct* RequestedStruct
)

   Component/AnimNextComponent.h  

bool SetVariableUInt32 ( const FName Name,
const uint32 InValue
)

   Component/AnimNextComponent.h  

bool SetVariableUInt64 ( const FName Name,
const uint64 InValue
)

   Component/AnimNextComponent.h  

void ShowDebugDrawing ( bool bShowDebugDrawing
)

 Enable or disable debug drawing. Note only works in builds with UE_ENABLE_DEBUG_DRAWING enabled. Component/AnimNextComponent.h
  • BlueprintCallable
  • Category="UAF"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page