UUAFComponent

API > API/Plugins > API/Plugins/UAF

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

Syntax

UCLASS (MinimalAPI, Meta=(BlueprintSpawnableComponent))  
class UUAFComponent :  
    public UActorComponent ,  
    public UE::UAF::ISystemOutputAdapter

Inheritance Hierarchy

Implements Interfaces

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AssetData TInstancedStruct< FUAFSystemFactoryAsset >   Component/AnimNextComponent.h
  • EditAnywhere
  • Category="Animation"
  • Meta=(ExcludeBaseStruct)
bCharacterMovementDependencyHasBeenSet uint8   Component/AnimNextComponent.h
  • EditAnywhere
  • Category="Animation"
bSetupCharacterMovementDependency uint8 When set, this component automatically adds a tick prerequisite to ensure the owning character's movement component ticks before this system. Component/AnimNextComponent.h
  • EditAnywhere
  • Category="Animation"
bShowDebugDrawing uint8 When checked, the system's debug drawing instructions are drawn in the viewport Component/AnimNextComponent.h
  • EditAnywhere
  • Category="Animation"
CachedSkeletalMeshComponent TObjectPtr< USkeletalMeshComponent >   Component/AnimNextComponent.h  
InitMethod EAnimNextModuleInitMethod How to initialize the system. Component/AnimNextComponent.h
  • EditAnywhere
  • Category="Animation"
Inputs TArray< FUAFComponentInputDesc > The inputs to this UAF system. Component/AnimNextComponent.h
  • EditDefaultsOnly
  • Category="Input"
InputToComponentMappings TMap< FAnimNextVariableReference, TWeakObjectPtr< UActorComponent > > Cached mapping between publicly exposed FValueBundle variables and their currently bound actor-components. Component/AnimNextComponent.h
  • Transient
OutputComponent FComponentReference The skeletal mesh component that this UAF system will animate against. Component/AnimNextComponent.h
  • EditDefaultsOnly
  • Category="Output"
  • Meta=(UseComponentPicker, AllowedClasses="/Script/Engine.SkeletalMeshComponent")
SerialNumber uint32 Serial number, updated on worker threads when output is written. Component/AnimNextComponent.h  
SkeletalMeshComponentOutputMode EUAFSkeletalMeshComponentOutputMode The operation to perform when outputting values with respect to a skeletal mesh component. Component/AnimNextComponent.h
  • EditDefaultsOnly
  • Category="Output"
SystemReference UE::UAF::FSystemReference Owning reference to the registered system. Component/AnimNextComponent.h  

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,
UUAFComponent* OtherAnimNextComponent,
FName OtherEventName
)

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

void AddModuleEventSubsequent ( FName InEventName,
UUAFComponent* 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  

void BlueprintGetVariableReference ( const FAnimNextVariableReference& Variable,
int32& Value
)

 Gets a system variable's value. Component/AnimNextComponent.h
  • BlueprintCallable
  • BlueprintInternalUseOnly
  • Category="UAF"
  • DisplayName="Get Variable"
  • CustomThunk
  • Meta=(CustomStructureParam=Value, AutoCreateRefTerm="Variable, Value", UnsafeDuringActorConstruction)

void BlueprintSetInputBinding ( const FAnimNextVariableReference& Variable,
UActorComponent* Component
)

 Sets a system's (of FValueBundle type) variable. Component/AnimNextComponent.h
  • BlueprintCallable
  • BlueprintInternalUseOnly
  • Category="UAF"
  • DisplayName="Set Input Binding"
  • Meta=(AutoCreateRefTerm="Variable, Component", UnsafeDuringActorConstruction)

void BlueprintSetVariable ( FName Name,
int32 Value
)

 Sets a system variable's value. Component/AnimNextComponent.h
  • BlueprintCallable
  • Category="UAF"
  • DisplayName="Set Variable"
  • CustomThunk
  • Meta=(CustomStructureParam=Value, UnsafeDuringActorConstruction, DeprecatedFunction, DeprecationMessage="This function has been deprecated, please use Set Variable that takes a variable reference instead")

void BlueprintSetVariableReference ( const FAnimNextVariableReference& Variable,
const int32& Value
)

 Sets a system variable's value. Component/AnimNextComponent.h
  • BlueprintCallable
  • BlueprintInternalUseOnly
  • Category="UAF"
  • DisplayName="Set Variable"
  • CustomThunk
  • Meta=(CustomStructureParam=Value, AutoCreateRefTerm="Variable, Value", UnsafeDuringActorConstruction)

const FTickFunction * FindTickFunction ( FName InEventName
) const

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

FUAFWeakSystemReference GetSystemReference()

 Get a reference to the registered system. Component/AnimNextComponent.h
  • BlueprintCallable
  • Category="UAF"

bool GetVariable ( const FAnimNextVariableReference& InVariable,
ValueType& OutValue
)

 Get a variable. Component/AnimNextComponent.h  

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::UAF::FModuleTaskContext&)>&& InTaskFunction,
UE::UAF::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,
UUAFComponent* OtherAnimNextComponent,
FName OtherEventName
)

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

void RemoveModuleEventSubsequent ( FName InEventName,
UUAFComponent* 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 SetAsset ( TInstancedStruct< FUAFSystemFactoryAsset >&& AssetData
)

 Can only be called when component is not registered Component/AnimNextComponent.h  

bool SetVariable ( const FAnimNextVariableReference& InVariable,
const ValueType& InValue
)

 Set a variable. 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"

bool WriteVariable ( const FAnimNextVariableReference& InVariable,
TFunctionRef< void(ValueType&)> InFunction
)

 Accesses a variable for writing. Component/AnimNextComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page