UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UInputComponent Class Reference

#include <InputComponent.h>

+ Inheritance diagram for UInputComponent:

Public Member Functions

virtual ENGINE_API void ClearBindingsForObject (UObject *InOwner)
 
ENGINE_API void ConditionalBuildKeyMap (UPlayerInput *PlayerInput)
 
ENGINE_API float GetAxisValue (const FName AxisName) const
 
ENGINE_API float GetAxisKeyValue (const FKey AxisKey) const
 
ENGINE_API FVector GetVectorAxisValue (const FKey AxisKey) const
 
virtual ENGINE_API bool HasBindings () const
 
ENGINE_API FInputActionBindingAddActionBinding (FInputActionBinding Binding)
 
virtual ENGINE_API void ClearActionBindings ()
 
FInputActionBindingGetActionBinding (const int32 BindingIndex) const
 
int32 GetNumActionBindings () const
 
ENGINE_API void RemoveActionBinding (const int32 BindingIndex)
 
ENGINE_API void RemoveActionBinding (FName ActionName, EInputEvent KeyEvent)
 
ENGINE_API void RemoveActionBindingForHandle (const int32 Handle)
 
ENGINE_API void RemoveActionBinding (const FInputActionBinding &BindingToRemove, const int32 BindingIndex)
 
ENGINE_API void ClearBindingValues ()
 
template<class UserClass >
FInputActionBindingBindAction (const FName ActionName, const EInputEvent KeyEvent, UserClass *Object, typename FInputActionHandlerSignature::TMethodPtr< UserClass > Func)
 
template<class UserClass >
FInputActionBindingBindAction (const FName ActionName, const EInputEvent KeyEvent, UserClass *Object, typename FInputActionHandlerWithKeySignature::TMethodPtr< UserClass > Func)
 
template<class DelegateType , class UserClass , typename... VarTypes>
FInputActionBindingBindAction (const FName ActionName, const EInputEvent KeyEvent, UserClass *Object, typename DelegateType::template TMethodPtr< UserClass > Func, VarTypes... Vars)
 
template<class UserClass >
FInputAxisBindingBindAxis (const FName AxisName, UserClass *Object, typename FInputAxisHandlerSignature::TMethodPtr< UserClass > Func)
 
ENGINE_API void RemoveAxisBinding (const FName AxisName)
 
ENGINE_API void ClearAxisBindings ()
 
FInputAxisBindingBindAxis (const FName AxisName)
 
template<class UserClass >
FInputAxisKeyBindingBindAxisKey (const FKey AxisKey, UserClass *Object, typename FInputAxisHandlerSignature::TMethodPtr< UserClass > Func)
 
FInputAxisKeyBindingBindAxisKey (const FKey AxisKey)
 
ENGINE_API void RemoveAxisKeyBinding (const FKey AxisKey)
 
template<class UserClass >
FInputVectorAxisBindingBindVectorAxis (const FKey AxisKey, UserClass *Object, typename FInputVectorAxisHandlerSignature::TMethodPtr< UserClass > Func)
 
FInputVectorAxisBindingBindVectorAxis (const FKey AxisKey)
 
template<class UserClass >
FInputKeyBindingBindKey (const FInputChord Chord, const EInputEvent KeyEvent, UserClass *Object, typename FInputActionHandlerSignature::TMethodPtr< UserClass > Func)
 
template<class UserClass >
FInputKeyBindingBindKey (const FKey Key, const EInputEvent KeyEvent, UserClass *Object, typename FInputActionHandlerSignature::TMethodPtr< UserClass > Func)
 
template<class UserClass >
FInputKeyBindingBindKey (const FKey Key, const EInputEvent KeyEvent, UserClass *Object, typename FInputActionHandlerWithKeySignature::TMethodPtr< UserClass > Func)
 
template<class UserClass >
FInputTouchBindingBindTouch (const EInputEvent KeyEvent, UserClass *Object, typename FInputTouchHandlerSignature::TMethodPtr< UserClass > Func)
 
template<class UserClass >
FInputGestureBindingBindGesture (const FKey GestureKey, UserClass *Object, typename FInputGestureHandlerSignature::TMethodPtr< UserClass > Func)
 
- Public Member Functions inherited from UActorComponent
ENGINE_API UActorComponent (const FObjectInitializer &ObjectInitializer=FObjectInitializer::Get())
 
int32 GetUCSSerializationIndex () const
 
bool IsAsyncCreatePhysicsStateRunning () const
 
bool IsAsyncDestroyPhysicsStateRunning () const
 
uint32 GetMarkedForEndOfFrameUpdateState () const
 
uint32 GetMarkedForPreEndOfFrameSync () const
 
ENGINE_API void DetermineUCSModifiedProperties ()
 
ENGINE_API void GetUCSModifiedProperties (TSet< const FProperty * > &ModifiedProperties) const
 
ENGINE_API void RemoveUCSModifiedProperties (const TArray< FProperty * > &Properties)
 
ENGINE_API void ClearUCSModifiedProperties ()
 
ENGINE_API bool IsEditableWhenInherited () const
 
bool HasBeenCreated () const
 
bool HasBeenInitialized () const
 
bool IsReadyForReplication () const
 
bool HasBegunPlay () const
 
bool IsBeingDestroyed () const
 
ENGINE_API bool IsCreatedByConstructionScript () const
 
virtual ENGINE_API void OnRep_IsActive ()
 
AActorGetOwner () const
 
template<class T >
T * GetOwner () const
 
virtual UWorldGetWorld () const override final
 
ENGINE_API bool ComponentHasTag (FName Tag) const
 
virtual ENGINE_API void Activate (bool bReset=false)
 
virtual ENGINE_API void Deactivate ()
 
virtual ENGINE_API void SetActive (bool bNewActive, bool bReset=false)
 
virtual ENGINE_API void ToggleActive ()
 
bool IsActive () const
 
virtual ENGINE_API void SetAutoActivate (bool bNewAutoActivate)
 
ENGINE_API void SetTickableWhenPaused (bool bTickableWhenPaused)
 
ENGINE_API void CreatePhysicsState (bool bAllowDeferral=false)
 
ENGINE_API void DestroyPhysicsState ()
 
ENGINE_API void SetNetAddressable ()
 
ENGINE_API void SetIsReplicated (bool ShouldReplicate)
 
bool GetIsReplicated () const
 
virtual ENGINE_API bool ReplicateSubobjects (class UActorChannel *Channel, class FOutBunch *Bunch, FReplicationFlags *RepFlags)
 
bool IsUsingRegisteredSubObjectList () const
 
virtual ELifetimeCondition GetReplicationCondition () const
 
virtual void PreReplication (IRepChangedPropertyTracker &ChangedPropertyTracker)
 
virtual ENGINE_API bool GetComponentClassCanReplicate () const
 
ENGINE_API void AddReplicatedSubObject (UObject *SubObject, ELifetimeCondition NetCondition=COND_None)
 
ENGINE_API void RemoveReplicatedSubObject (UObject *SubObject)
 
ENGINE_API void DestroyReplicatedSubObjectOnRemotePeers (UObject *SubObject)
 
ENGINE_API void TearOffReplicatedSubObjectOnRemotePeers (UObject *SubObject)
 
ENGINE_API bool IsReplicatedSubObjectRegistered (const UObject *SubObject) const
 
bool IsNetSimulating () const
 
ENGINE_API ENetRole GetOwnerRole () const
 
ENetMode GetNetMode () const
 
bool IsNetMode (ENetMode Mode) const
 
bool IsNetStartupComponent () const
 
void SetIsNetStartupComponent (const bool bInIsNetStartupComponent)
 
virtual void OnEndOfFrameUpdateDuringTick ()
 
virtual void OnPreEndOfFrameSync ()
 
virtual ENGINE_API void RegisterReplicationFragments (UE::Net::FFragmentRegistrationContext &Context, UE::Net::EFragmentRegistrationFlags RegistrationFlags) override
 
virtual ENGINE_API void OnReplicationStartedForIris (const FOnReplicationStartedParams &)
 
virtual ENGINE_API void OnStopReplicationForIris (const FOnStopReplicationParams &)
 
virtual ENGINE_API void BeginReplication ()
 
virtual ENGINE_API void EndReplication ()
 
virtual ENGINE_API bool ShouldIncrementalPreRegister (UWorld *WorldContext) const
 
virtual ENGINE_API bool ShouldIncrementalPreUnregister () const
 
virtual bool AllowsAsyncPhysicsStateCreation () const
 
virtual bool AllowsAsyncPhysicsStateDestruction () const
 
virtual ENGINE_API bool IsAsyncPhysicsStateCreated () const override final
 
virtual ENGINE_API UObjectGetAsyncPhysicsStateObject () const override final
 
virtual ENGINE_API bool OnAsyncCreatePhysicsState (const UE::FTimeout &Timeout) override
 
virtual ENGINE_API void OnAsyncCreatePhysicsStateEnd_GameThread () override
 
virtual bool OnAsyncDestroyPhysicsState (const UE::FTimeout &Timeout) override
 
virtual ENGINE_API void OnAsyncDestroyPhysicsStateBegin_GameThread () override
 
virtual ENGINE_API void OnAsyncDestroyPhysicsStateEnd_GameThread () override
 
virtual ENGINE_API void InitializeComponent ()
 
virtual ENGINE_API void ReadyForReplication ()
 
virtual ENGINE_API void BeginPlay ()
 
ENGINE_API void ReceiveBeginPlay ()
 
virtual ENGINE_API void EndPlay (const EEndPlayReason::Type EndPlayReason)
 
virtual ENGINE_API void UninitializeComponent ()
 
ENGINE_API void ReceiveEndPlay (EEndPlayReason::Type EndPlayReason)
 
ENGINE_API void RegisterAllComponentTickFunctions (bool bRegister)
 
virtual ENGINE_API void TickComponent (float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction *ThisTickFunction)
 
virtual void AsyncPhysicsTickComponent (float DeltaTime, float SimTime)
 
ENGINE_API bool SetupActorComponentTickFunction (struct FTickFunction *TickFunction)
 
virtual ENGINE_API void SetComponentTickEnabled (bool bEnabled)
 
virtual ENGINE_API void SetComponentTickEnabledAsync (bool bEnabled)
 
virtual ENGINE_API bool IsComponentTickEnabled () const
 
ENGINE_API void SetComponentTickInterval (float TickInterval)
 
ENGINE_API void SetComponentTickIntervalAndCooldown (float TickInterval)
 
ENGINE_API float GetComponentTickInterval () const
 
ENGINE_API void PreRegisterComponentWithWorld (UWorld *InWorld)
 
ENGINE_API void PreUnregisterComponentFromWorld ()
 
ENGINE_API void RegisterComponentWithWorld (UWorld *InWorld, FRegisterComponentContext *Context=nullptr)
 
virtual bool IsReadyForOwnerToAutoDestroy () const
 
ENGINE_API bool IsOwnerSelected () const
 
bool IsRenderTransformDirty () const
 
bool IsRenderInstancesDirty () const
 
bool IsRenderStateDirty () const
 
void InvalidateLightingCache ()
 
virtual void InvalidateLightingCacheDetailed (bool bInvalidateBuildEnqueuedLighting, bool bTranslationOnly)
 
ENGINE_API void DoDeferredRenderUpdates_Concurrent ()
 
virtual void UpdateComponentToWorld (EUpdateTransformFlags UpdateTransformFlags=EUpdateTransformFlags::None, ETeleportType Teleport=ETeleportType::None)
 
ENGINE_API void MarkRenderStateDirty ()
 
ENGINE_API void MarkRenderDynamicDataDirty ()
 
ENGINE_API void MarkRenderTransformDirty ()
 
ENGINE_API void MarkRenderInstancesDirty ()
 
ENGINE_API void MarkForNeededEndOfFrameUpdate (bool bReadyForEarlyUpdate=false)
 
ENGINE_API void MarkForNeededEndOfFrameRecreate ()
 
bool IsReadyForEarlyEndOfFrameUpdate () const
 
void ClearNeedEndOfFrameUpdate ()
 
virtual ENGINE_API bool RequiresGameThreadEndOfFrameUpdates () const
 
virtual ENGINE_API bool RequiresGameThreadEndOfFrameRecreate () const
 
virtual ENGINE_API bool RequiresPreEndOfFrameSync () const
 
ENGINE_API void RecreateRenderState_Concurrent ()
 
ENGINE_API void RecreatePhysicsState ()
 
bool IsRenderStateCreated () const
 
bool IsRenderStateRecreating () const
 
bool IsPhysicsStateCreated () const
 
bool IsRenderStateUpdating () const
 
ENGINE_API class FSceneInterfaceGetScene () const
 
ENGINE_API ULevelGetComponentLevel () const
 
ENGINE_API bool ComponentIsInLevel (const class ULevel *TestLevel) const
 
ENGINE_API bool ComponentIsInPersistentLevel (bool bIncludeLevelStreamingPersistent) const
 
virtual void OnActorVisibilityChanged ()
 
virtual void OnActorEnableCollisionChanged ()
 
virtual ENGINE_API FString GetReadableName () const
 
virtual UObject const * AdditionalStatObject () const
 
virtual ENGINE_API TStructOnScope< FActorComponentInstanceDataGetComponentInstanceData () const
 
virtual ENGINE_API void PostApplyToComponent ()
 
virtual void GetComponentChildElements (TArray< FTypedElementHandle > &OutElementHandles, const bool bAllowCreate=true)
 
virtual ENGINE_API void BeginDestroy () override
 
virtual ENGINE_API bool NeedsLoadForClient () const override
 
virtual ENGINE_API bool NeedsLoadForServer () const override
 
virtual ENGINE_API bool NeedsLoadForEditorGame () const override
 
virtual ENGINE_API bool IsNameStableForNetworking () const override
 
virtual ENGINE_API bool IsSupportedForNetworking () const override
 
virtual ENGINE_API void GetLifetimeReplicatedProps (TArray< FLifetimeProperty > &OutLifetimeProps) const override
 
virtual ENGINE_API int32 GetFunctionCallspace (UFunction *Function, FFrame *Stack) override
 
virtual ENGINE_API bool CallRemoteFunction (UFunction *Function, void *Parameters, FOutParmRec *OutParms, FFrame *Stack) override
 
virtual ENGINE_API void PostInitProperties () override
 
virtual ENGINE_API void PostLoad () override
 
virtual ENGINE_API bool Rename (const TCHAR *NewName=NULL, UObject *NewOuter=NULL, ERenameFlags Flags=REN_None) override
 
virtual ENGINE_API void PostRename (UObject *OldOuter, const FName OldName) override
 
virtual ENGINE_API void Serialize (FArchive &Ar) override
 
virtual ENGINE_API void AddAssetUserData (UAssetUserData *InUserData) override
 
virtual ENGINE_API void RemoveUserDataOfClass (TSubclassOf< UAssetUserData > InUserDataClass) override
 
virtual ENGINE_API UAssetUserDataGetAssetUserDataOfClass (TSubclassOf< UAssetUserData > InUserDataClass) override
 
virtual ENGINE_API const TArray< UAssetUserData * > * GetAssetUserDataArray () const override
 
ENGINE_API void OnCreatedFromReplication ()
 
ENGINE_API void OnDestroyedFromReplication ()
 
ENGINE_API bool IsOwnerRunningUserConstructionScript () const
 
bool IsPreRegistering () const
 
bool IsPreRegistered () const
 
bool IsPreUnregistering () const
 
bool IsPreUnregistered () const
 
bool IsRegistered () const
 
bool AllowReregistration () const
 
ENGINE_API void RegisterComponent ()
 
ENGINE_API void UnregisterComponent ()
 
virtual ENGINE_API void DestroyComponent (bool bPromoteChildren=false)
 
virtual ENGINE_API void OnComponentCreated ()
 
virtual ENGINE_API void OnComponentDestroyed (bool bDestroyingHierarchy)
 
ENGINE_API void K2_DestroyComponent (UObject *Object)
 
ENGINE_API void ReregisterComponent ()
 
ENGINE_API void SetTickGroup (ETickingGroup NewTickGroup)
 
virtual ENGINE_API void AddTickPrerequisiteActor (AActor *PrerequisiteActor)
 
virtual ENGINE_API void AddTickPrerequisiteComponent (UActorComponent *PrerequisiteComponent)
 
virtual ENGINE_API void RemoveTickPrerequisiteActor (AActor *PrerequisiteActor)
 
virtual ENGINE_API void RemoveTickPrerequisiteComponent (UActorComponent *PrerequisiteComponent)
 
ENGINE_API void ReceiveTick (float DeltaSeconds)
 
ENGINE_API void ReceiveAsyncPhysicsTick (float DeltaSeconds, float SimSeconds)
 
virtual void ApplyWorldOffset (const FVector &InOffset, bool bWorldShift)
 
bool CanEverAffectNavigation () const
 
ENGINE_API void SetCanEverAffectNavigation (bool bRelevant)
 
virtual bool IsNavigationRelevant () const
 
virtual bool IsHLODRelevant () const
 
 DECLARE_MULTICAST_DELEGATE_OneParam (FOnMarkRenderStateDirty, UActorComponent &)
 
ENGINE_API void SetActiveFlag (const bool bNewIsActive)
 
- Public Member Functions inherited from UObject
COREUOBJECT_API UObject ()
 
COREUOBJECT_API UObject (const FObjectInitializer &ObjectInitializer)
 
COREUOBJECT_API UObject (EStaticConstructor, EObjectFlags InFlags)
 
COREUOBJECT_API UObject (FVTableHelper &Helper)
 
COREUOBJECT_API UObjectCreateDefaultSubobject (FName SubobjectFName, UClass *ReturnType, UClass *ClassToCreateByDefault, bool bIsRequired, bool bIsTransient)
 
template<class TReturnType >
TReturnTypeCreateEditorOnlyDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
COREUOBJECT_API void GetDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects)
 
COREUOBJECT_API UObjectGetDefaultSubobjectByName (FName ToFind)
 
virtual COREUOBJECT_API void PostReinitProperties ()
 
virtual void PostCDOContruct ()
 
virtual COREUOBJECT_API void PreSaveRoot (FObjectPreSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PostSaveRoot (FObjectPostSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PreSave (FObjectPreSaveContext SaveContext)
 
virtual COREUOBJECT_API void CollectSaveOverrides (FObjectCollectSaveOverridesContext SaveContext)
 
UE_FORCEINLINE_HINT bool Modify (bool bAlwaysMarkDirty=true)
 
UE_FORCEINLINE_HINT bool IsCapturingAsRootObjectForTransaction () const
 
virtual bool ResolveSubobject (const TCHAR *SubObjectPath, UObject *&OutObject, bool bLoadIfExists)
 
virtual bool IsReadyForAsyncPostLoad () const
 
virtual COREUOBJECT_API void PostLoadSubobjects (FObjectInstancingGraph *OuterInstanceGraph)
 
virtual bool IsReadyForFinishDestroy ()
 
virtual COREUOBJECT_API void FinishDestroy ()
 
virtual COREUOBJECT_API void Serialize (FStructuredArchive::FRecord Record)
 
virtual void ShutdownAfterError ()
 
virtual void PostInterpChange (FProperty *PropertyThatChanged)
 
virtual void PreDuplicate (FObjectDuplicationParameters &DupParams)
 
virtual void PostDuplicate (bool bDuplicateForPIE)
 
virtual void PostDuplicate (EDuplicateMode::Type DuplicateMode)
 
virtual COREUOBJECT_API bool NeedsLoadForTargetPlatform (const class ITargetPlatform *TargetPlatform) const
 
virtual bool IsEditorOnly () const
 
virtual bool HasNonEditorOnlyReferences () const
 
virtual bool IsPostLoadThreadSafe () const
 
virtual COREUOBJECT_API bool IsDestructionThreadSafe () const
 
virtual COREUOBJECT_API void GetPreloadDependencies (TArray< UObject * > &OutDeps)
 
virtual void GetPrestreamPackages (TArray< UObject * > &OutPrestream)
 
virtual void ExportCustomProperties (FOutputDevice &Out, uint32 Indent)
 
virtual void ImportCustomProperties (const TCHAR *SourceText, FFeedbackContext *Warn)
 
virtual void PostEditImport ()
 
virtual void PostReloadConfig (class FProperty *PropertyThatWasLoaded)
 
virtual FString GetDesc ()
 
COREUOBJECT_API UScriptStructGetSparseClassDataStruct () const
 
virtual bool GetNativePropertyValues (TMap< FString, FString > &out_PropertyValues, uint32 ExportFlags=0) const
 
virtual COREUOBJECT_API void GetResourceSizeEx (FResourceSizeEx &CumulativeResourceSize)
 
SIZE_T GetResourceSizeBytes (EResourceSizeMode::Type Mode)
 
virtual FName GetExporterName (void)
 
COREUOBJECT_API void CallAddReferencedObjects (FReferenceCollector &Collector)
 
virtual FRestoreForUObjectOverwriteGetRestoreForUObjectOverwrite ()
 
virtual bool AreNativePropertiesIdenticalTo (UObject *Other) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (TArray< FAssetRegistryTag > &OutTags) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetData &Out) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context, FAssetData &Out) const
 
virtual COREUOBJECT_API bool IsAsset () const
 
virtual COREUOBJECT_API FPrimaryAssetId GetPrimaryAssetId () const
 
virtual COREUOBJECT_API bool IsLocalizedResource () const
 
virtual COREUOBJECT_API bool IsSafeForRootSet () const
 
virtual COREUOBJECT_API void TagSubobjects (EObjectFlags NewFlags)
 
virtual COREUOBJECT_API void GetReplicatedCustomConditionState (FCustomPropertyConditionState &OutActiveState) const
 
virtual COREUOBJECT_API bool IsFullNameStableForNetworking () const
 
virtual void GetSubobjectsWithStableNamesForNetworking (TArray< UObject * > &ObjList)
 
virtual COREUOBJECT_API void PreNetReceive ()
 
virtual COREUOBJECT_API void PostNetReceive ()
 
virtual void PostRepNotifies ()
 
virtual COREUOBJECT_API void PreDestroyFromReplication ()
 
COREUOBJECT_API bool IsSelected () const
 
COREUOBJECT_API void SerializeScriptProperties (FArchive &Ar) const
 
COREUOBJECT_API void SerializeScriptProperties (FStructuredArchive::FSlot Slot) const
 
COREUOBJECT_API void ReinitializeProperties (UObject *SourceObject=NULL, struct FObjectInstancingGraph *InstanceGraph=NULL)
 
COREUOBJECT_API FString GetDetailedInfo () const
 
COREUOBJECT_API bool ConditionalBeginDestroy ()
 
COREUOBJECT_API bool ConditionalFinishDestroy ()
 
COREUOBJECT_API void ConditionalPostLoad ()
 
COREUOBJECT_API void ConditionalPreload ()
 
COREUOBJECT_API void ConditionalPostLoadSubobjects (struct FObjectInstancingGraph *OuterInstanceGraph=NULL)
 
bool IsBasedOnArchetype (const UObject *const SomeObject) const
 
COREUOBJECT_API UFunctionFindFunction (FName InName) const
 
COREUOBJECT_API UFunctionFindFunctionChecked (FName InName) const
 
virtual COREUOBJECT_API void BuildSubobjectMapping (UObject *OtherObject, TMap< UObject *, UObject * > &ObjectMapping) const
 
COREUOBJECT_API void CollectDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects, bool bIncludeNestedSubobjects=false) const
 
COREUOBJECT_API bool CheckDefaultSubobjects (bool bForceCheck=false) const
 
COREUOBJECT_API void SaveConfig (uint64 RequiredPropertyFlags=CPF_Config, const TCHAR *Filename=nullptr, FConfigCacheIni *Config=GConfig, bool bAllowCopyToDefaultObject=true)
 
COREUOBJECT_API void SaveConfig (const FSaveConfigContext &Context)
 
COREUOBJECT_API void UpdateDefaultConfigFile (const FString &SpecificFileLocation="")
 
COREUOBJECT_API bool TryUpdateDefaultConfigFile (const FString &SpecificFileLocation="", bool bWarnIfFail=true)
 
COREUOBJECT_API void UpdateGlobalUserConfigFile ()
 
COREUOBJECT_API void UpdateProjectUserConfigFile ()
 
COREUOBJECT_API void UpdateSinglePropertyInConfigFile (const FProperty *InProperty, const FString &InConfigIniName)
 
COREUOBJECT_API FString GetDefaultConfigFilename () const
 
COREUOBJECT_API FString GetGlobalUserConfigFilename () const
 
COREUOBJECT_API FString GetProjectUserConfigFilename () const
 
virtual const TCHARGetConfigOverridePlatform () const
 
virtual void OverrideConfigSection (FString &SectionName)
 
virtual void OverridePerObjectConfigSection (FString &SectionName)
 
COREUOBJECT_API void LoadConfig (UClass *ConfigClass=nullptr, const TCHAR *Filename=nullptr, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=nullptr, TArray< UE::ConfigAccessTracking::FConfigAccessData > *OutAccessedKeys=nullptr)
 
COREUOBJECT_API void ReloadConfig (UClass *ConfigClass=NULL, const TCHAR *Filename=NULL, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=NULL)
 
COREUOBJECT_API void ParseParms (const TCHAR *Parms)
 
COREUOBJECT_API void OutputReferencers (FOutputDevice &Ar, FReferencerInformationList *Referencers=NULL)
 
COREUOBJECT_API void RetrieveReferencers (TArray< FReferencerInformation > *OutInternalReferencers, TArray< FReferencerInformation > *OutExternalReferencers)
 
COREUOBJECT_API void SetLinker (FLinkerLoad *LinkerLoad, int32 LinkerIndex, bool bShouldDetachExisting=true, bool bSilenceLogs=false)
 
COREUOBJECT_API UObjectGetArchetype () const
 
COREUOBJECT_API void GetArchetypeInstances (TArray< UObject * > &Instances)
 
COREUOBJECT_API void InstanceSubobjectTemplates (struct FObjectInstancingGraph *InstanceGraph=NULL)
 
template<class T >
bool Implements () const
 
virtual COREUOBJECT_API void ProcessEvent (UFunction *Function, void *Parms)
 
COREUOBJECT_API bool CallFunctionByNameWithArguments (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor, bool bForceCallWithNonExec=false)
 
COREUOBJECT_API void CallFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
 DECLARE_FUNCTION (ProcessInternal)
 
virtual bool ProcessConsoleExec (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor)
 
COREUOBJECT_API void SkipFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
virtual UClassRegenerateClass (UClass *ClassToRegenerate, UObject *PreviousCDO)
 
COREUOBJECT_API bool IsInBlueprint () const
 
COREUOBJECT_API void DestroyNonNativeProperties ()
 
virtual void MarkAsEditorOnlySubobject ()
 
COREUOBJECT_API void AbortInsideMemberFunction () const
 
 DECLARE_FUNCTION (execUndefined)
 
 DECLARE_FUNCTION (execLocalVariable)
 
 DECLARE_FUNCTION (execInstanceVariable)
 
 DECLARE_FUNCTION (execDefaultVariable)
 
 DECLARE_FUNCTION (execLocalOutVariable)
 
 DECLARE_FUNCTION (execInterfaceVariable)
 
 DECLARE_FUNCTION (execClassSparseDataVariable)
 
 DECLARE_FUNCTION (execInterfaceContext)
 
 DECLARE_FUNCTION (execArrayElement)
 
 DECLARE_FUNCTION (execBoolVariable)
 
 DECLARE_FUNCTION (execClassDefaultVariable)
 
 DECLARE_FUNCTION (execEndFunctionParms)
 
 DECLARE_FUNCTION (execNothing)
 
 DECLARE_FUNCTION (execNothingInt32)
 
 DECLARE_FUNCTION (execNothingOp4a)
 
 DECLARE_FUNCTION (execBreakpoint)
 
 DECLARE_FUNCTION (execTracepoint)
 
 DECLARE_FUNCTION (execWireTracepoint)
 
 DECLARE_FUNCTION (execInstrumentation)
 
 DECLARE_FUNCTION (execEndOfScript)
 
 DECLARE_FUNCTION (execReturnNothing)
 
 DECLARE_FUNCTION (execEmptyParmValue)
 
 DECLARE_FUNCTION (execJump)
 
 DECLARE_FUNCTION (execJumpIfNot)
 
 DECLARE_FUNCTION (execAssert)
 
 DECLARE_FUNCTION (execPushExecutionFlow)
 
 DECLARE_FUNCTION (execPopExecutionFlow)
 
 DECLARE_FUNCTION (execComputedJump)
 
 DECLARE_FUNCTION (execPopExecutionFlowIfNot)
 
 DECLARE_FUNCTION (execLet)
 
 DECLARE_FUNCTION (execLetObj)
 
 DECLARE_FUNCTION (execLetWeakObjPtr)
 
 DECLARE_FUNCTION (execLetBool)
 
 DECLARE_FUNCTION (execLetDelegate)
 
 DECLARE_FUNCTION (execLetMulticastDelegate)
 
 DECLARE_FUNCTION (execAddMulticastDelegate)
 
 DECLARE_FUNCTION (execClearMulticastDelegate)
 
 DECLARE_FUNCTION (execEatReturnValue)
 
 DECLARE_FUNCTION (execRemoveMulticastDelegate)
 
 DECLARE_FUNCTION (execSelf)
 
 DECLARE_FUNCTION (execContext)
 
 DECLARE_FUNCTION (execContext_FailSilent)
 
 DECLARE_FUNCTION (execStructMemberContext)
 
 DECLARE_FUNCTION (execVirtualFunction)
 
 DECLARE_FUNCTION (execFinalFunction)
 
 DECLARE_FUNCTION (execLocalVirtualFunction)
 
 DECLARE_FUNCTION (execLocalFinalFunction)
 
 DECLARE_FUNCTION (execStructCmpEq)
 
 DECLARE_FUNCTION (execStructCmpNe)
 
 DECLARE_FUNCTION (execStructMember)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execNotEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execNotEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execIntConst)
 
 DECLARE_FUNCTION (execInt64Const)
 
 DECLARE_FUNCTION (execUInt64Const)
 
 DECLARE_FUNCTION (execSkipOffsetConst)
 
 DECLARE_FUNCTION (execFloatConst)
 
 DECLARE_FUNCTION (execDoubleConst)
 
 DECLARE_FUNCTION (execStringConst)
 
 DECLARE_FUNCTION (execUnicodeStringConst)
 
 DECLARE_FUNCTION (execTextConst)
 
 DECLARE_FUNCTION (execPropertyConst)
 
 DECLARE_FUNCTION (execObjectConst)
 
 DECLARE_FUNCTION (execSoftObjectConst)
 
 DECLARE_FUNCTION (execFieldPathConst)
 
 DECLARE_FUNCTION (execInstanceDelegate)
 
 DECLARE_FUNCTION (execNameConst)
 
 DECLARE_FUNCTION (execByteConst)
 
 DECLARE_FUNCTION (execIntZero)
 
 DECLARE_FUNCTION (execIntOne)
 
 DECLARE_FUNCTION (execTrue)
 
 DECLARE_FUNCTION (execFalse)
 
 DECLARE_FUNCTION (execNoObject)
 
 DECLARE_FUNCTION (execNullInterface)
 
 DECLARE_FUNCTION (execIntConstByte)
 
 DECLARE_FUNCTION (execRotationConst)
 
 DECLARE_FUNCTION (execVectorConst)
 
 DECLARE_FUNCTION (execVector3fConst)
 
 DECLARE_FUNCTION (execTransformConst)
 
 DECLARE_FUNCTION (execStructConst)
 
 DECLARE_FUNCTION (execSetArray)
 
 DECLARE_FUNCTION (execSetSet)
 
 DECLARE_FUNCTION (execSetMap)
 
 DECLARE_FUNCTION (execArrayConst)
 
 DECLARE_FUNCTION (execSetConst)
 
 DECLARE_FUNCTION (execMapConst)
 
 DECLARE_FUNCTION (execBitFieldConst)
 
 DECLARE_FUNCTION (execNew)
 
 DECLARE_FUNCTION (execClassContext)
 
 DECLARE_FUNCTION (execNativeParm)
 
 DECLARE_FUNCTION (execCast)
 
 DECLARE_FUNCTION (execDynamicCast)
 
 DECLARE_FUNCTION (execMetaCast)
 
 DECLARE_FUNCTION (execInterfaceCast)
 
 DECLARE_FUNCTION (execDoubleToFloatCast)
 
 DECLARE_FUNCTION (execFloatToDoubleCast)
 
 DECLARE_FUNCTION (execObjectToBool)
 
 DECLARE_FUNCTION (execInterfaceToBool)
 
 DECLARE_FUNCTION (execObjectToInterface)
 
 DECLARE_FUNCTION (execInterfaceToInterface)
 
 DECLARE_FUNCTION (execInterfaceToObject)
 
 DECLARE_FUNCTION (execGetDynArrayElement)
 
 DECLARE_FUNCTION (execSetDynArrayElement)
 
 DECLARE_FUNCTION (execGetDynArrayLength)
 
 DECLARE_FUNCTION (execSetDynArrayLength)
 
 DECLARE_FUNCTION (execDynArrayInsert)
 
 DECLARE_FUNCTION (execDynArrayRemove)
 
 DECLARE_FUNCTION (execDynArrayFind)
 
 DECLARE_FUNCTION (execDynArrayFindStruct)
 
 DECLARE_FUNCTION (execDynArrayAdd)
 
 DECLARE_FUNCTION (execDynArrayAddItem)
 
 DECLARE_FUNCTION (execDynArrayInsertItem)
 
 DECLARE_FUNCTION (execDynArrayRemoveItem)
 
 DECLARE_FUNCTION (execDynArraySort)
 
 DECLARE_FUNCTION (execBindDelegate)
 
 DECLARE_FUNCTION (execCallMulticastDelegate)
 
 DECLARE_FUNCTION (execLetValueOnPersistentFrame)
 
 DECLARE_FUNCTION (execCallMathFunction)
 
 DECLARE_FUNCTION (execSwitchValue)
 
 DECLARE_FUNCTION (execArrayGetByRef)
 
 DECLARE_FUNCTION (execAutoRtfmTransact)
 
 DECLARE_FUNCTION (execAutoRtfmStopTransact)
 
 DECLARE_FUNCTION (execAutoRtfmAbortIfNot)
 
void ExecuteUbergraph (int32 EntryPoint)
 
virtual void ValidateGeneratedRepEnums (const TArray< struct FRepRecord > &ClassReps) const
 
virtual uint64 GetNetPushIdDynamic () const
 
- Public Member Functions inherited from UObjectBaseUtility
 UObjectBaseUtility ()
 
 UObjectBaseUtility (EObjectFlags InFlags)
 
void SetFlags (EObjectFlags NewFlags)
 
void ClearFlags (EObjectFlags FlagsToClear)
 
bool HasAnyFlags (EObjectFlags FlagsToCheck) const
 
bool HasAllFlags (EObjectFlags FlagsToCheck) const
 
UE_FORCEINLINE_HINT EObjectFlags GetMaskedFlags (EObjectFlags Mask=RF_AllFlags) const
 
UE_FORCEINLINE_HINT void Mark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT void UnMark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAnyMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAllMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT EObjectMark GetAllMarks () const
 
void MarkAsGarbage ()
 
void ClearGarbage ()
 
UE_FORCEINLINE_HINT void AddToRoot ()
 
UE_FORCEINLINE_HINT void RemoveFromRoot ()
 
UE_FORCEINLINE_HINT bool IsRooted () const
 
UE_FORCEINLINE_HINT int32 GetRefCount () const
 
bool ThisThreadAtomicallyClearedRFUnreachable ()
 
UE_FORCEINLINE_HINT bool IsUnreachable () const
 
UE_FORCEINLINE_HINT bool IsNative () const
 
void SetInternalFlags (EInternalObjectFlags FlagsToSet) const
 
UE_FORCEINLINE_HINT EInternalObjectFlags GetInternalFlags () const
 
UE_FORCEINLINE_HINT bool HasAnyInternalFlags (EInternalObjectFlags FlagsToCheck) const
 
void ClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
bool AtomicallyClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
COREUOBJECT_API FString GetFullName (const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (const UObject *StopOuter, FString &ResultString, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (FStringBuilderBase &ResultString, const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API FString GetPathName (const UObject *StopOuter=NULL) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FString &ResultString) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FStringBuilderBase &ResultString) const
 
virtual bool CanBeClusterRoot () const
 
virtual COREUOBJECT_API bool CanBeInCluster () const
 
virtual COREUOBJECT_API void CreateCluster ()
 
virtual void OnClusterMarkedAsPendingKill ()
 
COREUOBJECT_API void AddToCluster (UObjectBaseUtility *ClusterRootOrObjectFromCluster, bool bAddAsMutableObject=false)
 
COREUOBJECT_API FString GetFullGroupName (bool bStartWithOuter) const
 
UE_FORCEINLINE_HINT FString GetName () const
 
UE_FORCEINLINE_HINT void GetName (FString &ResultString) const
 
UE_FORCEINLINE_HINT void AppendName (FString &ResultString) const
 
COREUOBJECT_API bool IsPackageExternal () const
 
COREUOBJECT_API void DetachExternalPackage ()
 
COREUOBJECT_API void ReattachExternalPackage ()
 
COREUOBJECT_API UObjectGetOutermostObject () const
 
COREUOBJECT_API UPackageGetPackage () const
 
UE_INTERNAL virtual COREUOBJECT_API UE::Core::FVersePath GetVersePath () const
 
COREUOBJECT_API UPackageGetOutermost () const
 
COREUOBJECT_API bool MarkPackageDirty () const
 
COREUOBJECT_API bool IsTemplate (EObjectFlags TemplateTypes=RF_ArchetypeObject|RF_ClassDefaultObject) const
 
COREUOBJECT_API UObjectGetTypedOuter (UClass *Target) const
 
template<typename T >
T * GetTypedOuter () const
 
template<typename InterfaceClassType >
InterfaceClassTypeGetImplementingOuter () const
 
COREUOBJECT_API UObjectBaseUtilityGetImplementingOuterObject (const UClass *InInterfaceClass) const
 
COREUOBJECT_API bool IsIn (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsIn (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInOuter (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsInPackage (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInA (const UClass *SomeBaseClass) const
 
COREUOBJECT_API bool RootPackageHasAnyFlags (uint32 CheckFlagMask) const
 
template<typename OtherClassType >
bool IsA (OtherClassType SomeBase) const
 
template<class T >
bool IsA () const
 
COREUOBJECT_API const UClassFindNearestCommonBaseClass (const UClass *TestClass) const
 
COREUOBJECT_API voidGetInterfaceAddress (UClass *InterfaceClass)
 
COREUOBJECT_API voidGetNativeInterfaceAddress (UClass *InterfaceClass)
 
const voidGetNativeInterfaceAddress (UClass *InterfaceClass) const
 
COREUOBJECT_API bool IsTemplateForSubobjects (EObjectFlags TemplateTypes=RF_ClassDefaultObject|RF_DefaultSubObject|RF_InheritableComponentTemplate) const
 
COREUOBJECT_API bool IsDefaultSubobject () const
 
COREUOBJECT_API class FLinkerLoadGetLinker () const
 
COREUOBJECT_API int32 GetLinkerIndex () const
 
COREUOBJECT_API FPackageFileVersion GetLinkerUEVersion () const
 
int32 GetLinkerUE4Version () const
 
COREUOBJECT_API int32 GetLinkerLicenseeUEVersion () const
 
int32 GetLinkerLicenseeUE4Version () const
 
COREUOBJECT_API int32 GetLinkerCustomVersion (FGuid CustomVersionKey) const
 
UE_FORCEINLINE_HINT bool operator< (const UObjectBaseUtility &Other) const
 
TStatId GetStatID (bool bForDeferredUse=false) const
 
- Public Member Functions inherited from UObjectBase
COREUOBJECT_API UObjectBase (UClass *InClass, EObjectFlags InFlags, EInternalObjectFlags InInternalFlags, UObject *InOuter, FName InName, int32 InInternalIndex=-1, int32 InSerialNumber=0, FRemoteObjectId InRemoteId=FRemoteObjectId())
 
virtual COREUOBJECT_API ~UObjectBase ()
 
COREUOBJECT_API bool IsValidLowLevel () const
 
COREUOBJECT_API bool IsValidLowLevelFast (bool bRecursive=true) const
 
FORCEINLINE uint32 GetUniqueID () const
 
FORCEINLINE UClassGetClass () const
 
FORCEINLINE UObjectGetOuter () const
 
FORCEINLINE FName GetFName () const
 
virtual COREUOBJECT_API FName GetFNameForStatID () const
 
COREUOBJECT_API UPackageGetExternalPackage () const
 
COREUOBJECT_API void SetExternalPackage (UPackage *InPackage)
 
COREUOBJECT_API UPackageGetExternalPackageInternal () const
 
COREUOBJECT_API void MarkAsReachable () const
 
COREUOBJECT_API void AddRef () const
 
COREUOBJECT_API void ReleaseRef () const
 
FORCEINLINE EObjectFlags GetFlags () const
 
FORCENOINLINE void AtomicallySetFlags (EObjectFlags FlagsToAdd)
 
FORCENOINLINE void AtomicallyClearFlags (EObjectFlags FlagsToClear)
 
- Public Member Functions inherited from IAsyncPhysicsStateProcessor
virtual void CollectBodySetupsWithPhysicsMeshesToCreate (TSet< UBodySetup * > &OutBodySetups) const
 
virtual void OnAsyncCreatePhysicsStateBegin_GameThread ()
 

Public Attributes

int32 Priority
 
uint8 bBlockInput:1
 
- Public Attributes inherited from UActorComponent
struct FActorComponentTickFunction PrimaryComponentTick
 
TArray< FNameComponentTags
 
uint8 bAutoRegister:1
 
uint8 bTickInEditor:1
 
uint8 bNeverNeedsRenderUpdate:1
 
uint8 bAllowConcurrentTick:1
 
uint8 bAllowAnyoneToDestroyMe:1
 
uint8 bAutoActivate:1
 
uint8 bEditableWhenInherited:1
 
uint8 bNavigationRelevant: 1
 
uint8 bWantsInitializeComponent:1
 
uint8 bIsEditorOnly:1
 
EComponentCreationMethod CreationMethod
 
FActorComponentActivatedSignature OnComponentActivated
 
FActorComponentDeactivateSignature OnComponentDeactivated
 

Friends

struct FGetActionsBoundToKey
 
class UEnhancedInputComponent
 

Additional Inherited Members

- Public Types inherited from UObject
enum class  ENetFields_Private { NETFIELD_REP_START = 0 , NETFIELD_REP_END = -1 }
 
typedef UObject WithinClass
 
- Static Public Member Functions inherited from UActorComponent
static ENGINE_API void AddReferencedObjects (UObject *InThis, FReferenceCollector &Collector)
 
- Static Public Member Functions inherited from UObject
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedServer (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedClient (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API bool CanCreateInCurrentContext (UObject *Template)
 
static COREUOBJECT_API void AddReferencedObjects (UObject *InThis, FReferenceCollector &Collector)
 
static COREUOBJECT_API const FNameSourceFileTagName ()
 
static COREUOBJECT_API UObjectGetArchetypeFromRequiredInfo (const UClass *Class, const UObject *Outer, FName Name, EObjectFlags ObjectFlags)
 
- Static Public Member Functions inherited from UObjectBaseUtility
static bool IsGarbageEliminationEnabled ()
 
static bool IsPendingKillEnabled ()
 
static void SetGarbageEliminationEnabled (bool bEnabled)
 
static COREUOBJECT_API void ReloadObjectsFromModifiedConfigSections (const class FConfigModificationTracker *ChangeTracker)
 
- Static Public Member Functions inherited from UObjectBase
static COREUOBJECT_API FString RemoveClassPrefix (const TCHAR *ClassName)
 
static void PrefetchClass (UObject *Object)
 
static void PrefetchOuter (UObject *Object)
 
- Static Public Attributes inherited from UActorComponent
static ENGINE_API FActorComponentGlobalCreatePhysicsSignature GlobalCreatePhysicsDelegate
 
static ENGINE_API FActorComponentGlobalDestroyPhysicsSignature GlobalDestroyPhysicsDelegate
 
static ENGINE_API FTransactionallySafeRWLock AllUCSModifiedPropertiesLock
 
static ENGINE_API TMap< UActorComponent *, TArray< FSimpleMemberReference > > AllUCSModifiedProperties
 
static ENGINE_API const FString ComponentTemplateNameSuffix
 
static ENGINE_API FOnMarkRenderStateDirty MarkRenderStateDirtyEvent
 
- Protected Types inherited from UActorComponent
enum class  EComponentRegistrationState {
  None , PreRegistering , PreRegistered , PreUnregistering ,
  PreUnregistered
}
 
- Protected Member Functions inherited from UActorComponent
virtual ENGINE_API bool ShouldActivate () const
 
virtual ENGINE_API bool ShouldAsyncCreatePhysicsState (UWorld *WorldContext) const
 
virtual ENGINE_API bool ShouldAsyncDestroyPhysicsState () const
 
virtual ENGINE_API void OnPreRegister ()
 
virtual ENGINE_API void OnPreRegistered ()
 
virtual ENGINE_API void OnPreUnregister ()
 
virtual ENGINE_API void OnPreUnregistered ()
 
virtual ENGINE_API void OnRegister ()
 
virtual ENGINE_API void OnUnregister ()
 
virtual void PrecachePSOs ()
 
virtual bool ShouldCreateRenderState () const
 
virtual ENGINE_API void CreateRenderState_Concurrent (FRegisterComponentContext *Context)
 
virtual ENGINE_API void SendRenderTransform_Concurrent ()
 
virtual ENGINE_API void SendRenderDynamicData_Concurrent ()
 
virtual ENGINE_API void SendRenderInstanceData_Concurrent ()
 
virtual ENGINE_API void DestroyRenderState_Concurrent ()
 
virtual ENGINE_API void OnCreatePhysicsState ()
 
virtual ENGINE_API void OnDestroyPhysicsState ()
 
virtual bool ShouldCreatePhysicsState () const
 
virtual bool HasValidPhysicsState () const
 
virtual ENGINE_API void RegisterComponentTickFunctions (bool bRegister)
 
ENGINE_API void HandleCanEverAffectNavigationChange (bool bForceUpdate=false)
 
ENGINE_API void SetAsyncPhysicsTickEnabled (bool bEnabled)
 
ENGINE_API void DeferRemoveAsyncPhysicsTick ()
 
ENGINE_API void SetIsReplicatedByDefault (const bool bNewReplicates)
 
ENGINE_API bool OwnerNeedsInitialization () const
 
ENGINE_API bool NeedsInitialization () const
 
- Protected Member Functions inherited from UObject
virtual FString GetDetailedInfoInternal () const
 
COREUOBJECT_API bool CanCheckDefaultSubObjects (bool bForceCheck, bool &bResult) const
 
virtual COREUOBJECT_API bool CheckDefaultSubobjectsInternal () const
 
- Protected Member Functions inherited from UObjectBase
 UObjectBase ()
 
COREUOBJECT_API UObjectBase (EObjectFlags InFlags)
 
COREUOBJECT_API void LowLevelRename (FName NewName, UObject *NewOuter=NULL)
 
virtual void RegisterDependencies ()
 
COREUOBJECT_API void Register (class UClass *(*StaticClassFn)(), const TCHAR *PackageName, const TCHAR *Name)
 
COREUOBJECT_API void Register (const TCHAR *PackageName, const TCHAR *Name)
 
virtual COREUOBJECT_API void DeferredRegister (UClass *UClassStaticClass, const TCHAR *PackageName, const TCHAR *Name)
 
FORCEINLINE void SetFlagsTo (EObjectFlags NewFlags)
 
- Static Protected Member Functions inherited from UActorComponent
static ENGINE_API bool CanBeHLODRelevant (const UActorComponent *ActorComponent)
 
static const FName GetReplicatesPropertyName ()
 
- Protected Attributes inherited from UActorComponent
TArray< TObjectPtr< UAssetUserData > > AssetUserData
 
EComponentRegistrationState RegistrationState
 
uint8 bRegistered:1
 
uint8 bRenderStateCreated:1
 
uint8 bRenderStateRecreating:1
 
uint8 bPhysicsStateCreated:1
 
uint8 bCallAsyncPhysicsStateCreatedDelegate:1
 
uint8 bNetAddressable:1
 
uint8 bReplicateUsingRegisteredSubObjectList: 1
 
uint8 bAllowReregistration:1
 
uint8 bCanEverAffectNavigation: 1
 

Detailed Description

Implement an Actor component for input bindings.

An Input Component is a transient component that enables an Actor to bind various forms of input events to delegate functions.
Input components are processed from a stack managed by the PlayerController and processed by the PlayerInput. Each binding can consume the input event preventing other components on the input stack from processing the input.

See also
https://docs.unrealengine.com/latest/INT/Gameplay/Input/index.html

Member Function Documentation

◆ AddActionBinding()

FInputActionBinding & UInputComponent::AddActionBinding ( FInputActionBinding  Binding)

Adds the specified action binding.

Parameters
BindingThe binding to add.
Returns
The last binding in the list.
See also
ClearActionBindings, GetActionBinding, GetNumActionBindings, RemoveActionBinding

◆ BindAction() [1/3]

template<class DelegateType , class UserClass , typename... VarTypes>
FInputActionBinding & UInputComponent::BindAction ( const FName  ActionName,
const EInputEvent  KeyEvent,
UserClass *  Object,
typename DelegateType::template TMethodPtr< UserClass >  Func,
VarTypes...  Vars 
)
inline

Binds a delegate function to an Action defined in the project settings. Returned reference is only guaranteed to be valid until another action is bound.

◆ BindAction() [2/3]

template<class UserClass >
FInputActionBinding & UInputComponent::BindAction ( const FName  ActionName,
const EInputEvent  KeyEvent,
UserClass *  Object,
typename FInputActionHandlerSignature::TMethodPtr< UserClass >  Func 
)
inline

Binds a delegate function to an Action defined in the project settings. Returned reference is only guaranteed to be valid until another action is bound.

◆ BindAction() [3/3]

template<class UserClass >
FInputActionBinding & UInputComponent::BindAction ( const FName  ActionName,
const EInputEvent  KeyEvent,
UserClass *  Object,
typename FInputActionHandlerWithKeySignature::TMethodPtr< UserClass >  Func 
)
inline

Binds a delegate function to an Action defined in the project settings. Returned reference is only guaranteed to be valid until another action is bound.

◆ BindAxis() [1/2]

FInputAxisBinding & UInputComponent::BindAxis ( const FName  AxisName)
inline

Indicates that the InputComponent is interested in knowing the Axis value (via GetAxisValue) but does not want a delegate function called each frame. Returned reference is only guaranteed to be valid until another axis is bound.

◆ BindAxis() [2/2]

template<class UserClass >
FInputAxisBinding & UInputComponent::BindAxis ( const FName  AxisName,
UserClass *  Object,
typename FInputAxisHandlerSignature::TMethodPtr< UserClass >  Func 
)
inline

Binds a delegate function an Axis defined in the project settings. Returned reference is only guaranteed to be valid until another axis is bound.

◆ BindAxisKey() [1/2]

FInputAxisKeyBinding & UInputComponent::BindAxisKey ( const FKey  AxisKey)
inline

Indicates that the InputComponent is interested in knowing/consuming an axis key's value (via GetAxisKeyValue) but does not want a delegate function called each frame. Returned reference is only guaranteed to be valid until another axis key is bound.

◆ BindAxisKey() [2/2]

template<class UserClass >
FInputAxisKeyBinding & UInputComponent::BindAxisKey ( const FKey  AxisKey,
UserClass *  Object,
typename FInputAxisHandlerSignature::TMethodPtr< UserClass >  Func 
)
inline

Binds a delegate function for an axis key (e.g. Mouse X). Returned reference is only guaranteed to be valid until another axis key is bound.

◆ BindGesture()

template<class UserClass >
FInputGestureBinding & UInputComponent::BindGesture ( const FKey  GestureKey,
UserClass *  Object,
typename FInputGestureHandlerSignature::TMethodPtr< UserClass >  Func 
)
inline

Binds a gesture event to a delegate function. Returned reference is only guaranteed to be valid until another gesture event is bound.

◆ BindKey() [1/3]

template<class UserClass >
FInputKeyBinding & UInputComponent::BindKey ( const FInputChord  Chord,
const EInputEvent  KeyEvent,
UserClass *  Object,
typename FInputActionHandlerSignature::TMethodPtr< UserClass >  Func 
)
inline

Binds a chord event to a delegate function. Returned reference is only guaranteed to be valid until another input key is bound.

◆ BindKey() [2/3]

template<class UserClass >
FInputKeyBinding & UInputComponent::BindKey ( const FKey  Key,
const EInputEvent  KeyEvent,
UserClass *  Object,
typename FInputActionHandlerSignature::TMethodPtr< UserClass >  Func 
)
inline

Binds a key event to a delegate function. Returned reference is only guaranteed to be valid until another input key is bound.

◆ BindKey() [3/3]

template<class UserClass >
FInputKeyBinding & UInputComponent::BindKey ( const FKey  Key,
const EInputEvent  KeyEvent,
UserClass *  Object,
typename FInputActionHandlerWithKeySignature::TMethodPtr< UserClass >  Func 
)
inline

Binds a key event to a delegate function with key signature. Returned reference is only guaranteed to be valid until another input key is bound.

◆ BindTouch()

template<class UserClass >
FInputTouchBinding & UInputComponent::BindTouch ( const EInputEvent  KeyEvent,
UserClass *  Object,
typename FInputTouchHandlerSignature::TMethodPtr< UserClass >  Func 
)
inline

Binds this input component to touch events. Returned reference is only guaranteed to be valid until another touch event is bound.

◆ BindVectorAxis() [1/2]

FInputVectorAxisBinding & UInputComponent::BindVectorAxis ( const FKey  AxisKey)
inline

Indicates that the InputComponent is interested in knowing/consuming a vector axis key's value (via GetVectorAxisKeyValue) but does not want a delegate function called each frame. Returned reference is only guaranteed to be valid until another vector axis key is bound.

◆ BindVectorAxis() [2/2]

template<class UserClass >
FInputVectorAxisBinding & UInputComponent::BindVectorAxis ( const FKey  AxisKey,
UserClass *  Object,
typename FInputVectorAxisHandlerSignature::TMethodPtr< UserClass >  Func 
)
inline

Binds a delegate function to a vector axis key (e.g. Tilt) Returned reference is only guaranteed to be valid until another vector axis key is bound.

◆ ClearActionBindings()

void UInputComponent::ClearActionBindings ( )
virtual

◆ ClearAxisBindings()

void UInputComponent::ClearAxisBindings ( )

Removes all axis bindings.

◆ ClearBindingsForObject()

void UInputComponent::ClearBindingsForObject ( UObject InOwner)
virtual

Clears any input callback delegates from the given UObject

◆ ClearBindingValues()

void UInputComponent::ClearBindingValues ( )

Clears all cached binding values.

◆ ConditionalBuildKeyMap()

void UInputComponent::ConditionalBuildKeyMap ( UPlayerInput PlayerInput)

◆ GetActionBinding()

FInputActionBinding & UInputComponent::GetActionBinding ( const int32  BindingIndex) const
inline

Gets the action binding with the specified index.

Parameters
BindingIndexThe index of the binding to get.
See also
AddActionBinding, ClearActionBindings, GetNumActionBindings, RemoveActionBinding

◆ GetAxisKeyValue()

float UInputComponent::GetAxisKeyValue ( const FKey  AxisKey) const

Gets the current value of the axis with the specified key.

Parameters
AxisKeyThe key of the axis.
Returns
Axis value.
See also
GetAxisKeyValue, GetVectorAxisValue

◆ GetAxisValue()

float UInputComponent::GetAxisValue ( const FName  AxisName) const

Gets the current value of the axis with the specified name.

Parameters
AxisNameThe name of the axis.
Returns
Axis value.
See also
GetAxisKeyValue, GetVectorAxisValue

◆ GetNumActionBindings()

int32 UInputComponent::GetNumActionBindings ( ) const
inline

Gets the number of action bindings.

Returns
Number of bindings.
See also
AddActionBinding, ClearActionBindings, GetActionBinding, RemoveActionBinding

◆ GetVectorAxisValue()

FVector UInputComponent::GetVectorAxisValue ( const FKey  AxisKey) const

Gets the current vector value of the axis with the specified key.

Parameters
AxisKeyThe key of the axis.
Returns
Axis value.
See also
GetAxisValue, GetAxisKeyValue

◆ HasBindings()

bool UInputComponent::HasBindings ( ) const
virtual

Checks whether this component has any input bindings.

Returns
true if any bindings are set, false otherwise.

◆ RemoveActionBinding() [1/3]

void UInputComponent::RemoveActionBinding ( const FInputActionBinding BindingToRemove,
const int32  BindingIndex 
)

Removes the action binding (index need for multi-name fixups).

Parameters
BindingToRemoveThe binding to remove.
BindingIndexThe binding's index for actions with the same name to fixup their data.
See also
AddActionBinding, ClearActionBindings, GetActionBinding, GetNumActionBindings

◆ RemoveActionBinding() [2/3]

void UInputComponent::RemoveActionBinding ( const int32  BindingIndex)

Removes the action binding at the specified index.

Parameters
BindingIndexThe index of the binding to remove.
See also
AddActionBinding, ClearActionBindings, GetActionBinding, GetNumActionBindings

◆ RemoveActionBinding() [3/3]

void UInputComponent::RemoveActionBinding ( FName  ActionName,
EInputEvent  KeyEvent 
)

◆ RemoveActionBindingForHandle()

void UInputComponent::RemoveActionBindingForHandle ( const int32  Handle)

Removes the action binding at the specified handle.

Parameters
HandleThe handle of the binding to remove.
See also
AddActionBinding, ClearActionBindings, GetActionBinding, GetNumActionBindings

◆ RemoveAxisBinding()

void UInputComponent::RemoveAxisBinding ( const FName  AxisName)

Removes the axis binding with the specified name.

Parameters
AxisNamethe name of the axis to remove.

◆ RemoveAxisKeyBinding()

void UInputComponent::RemoveAxisKeyBinding ( const FKey  AxisKey)

Removes the axis key binding with the specified key.

Parameters
AxisKeythe key of the axis to remove.

Friends And Related Symbol Documentation

◆ FGetActionsBoundToKey

◆ UEnhancedInputComponent

friend class UEnhancedInputComponent
friend

Member Data Documentation

◆ bBlockInput

uint8 UInputComponent::bBlockInput

Whether any components lower on the input stack should be allowed to receive input.

◆ Priority

int32 UInputComponent::Priority

The priority of this input component when pushed in to the stack.


The documentation for this class was generated from the following files: