UPlayerInput Class Reference

#include <PlayerInput.h>

Inheritance diagram for UPlayerInput:

Public Member Functions
ENGINE_API	UPlayerInput ()
ENGINE_API bool	GetAxisProperties (const FKey AxisKey, FInputAxisProperties &AxisProperties)
ENGINE_API void	SetAxisProperties (const FKey AxisKey, const FInputAxisProperties &AxisProperties)
ENGINE_API void	SetMouseSensitivity (const float SensitivityX, const float SensitivityY)
void	SetMouseSensitivity (const float Sensitivity)
ENGINE_API void	SetBind (FName BindName, const FString &Command)
ENGINE_API float	GetMouseSensitivityX ()
ENGINE_API float	GetMouseSensitivityY ()
ENGINE_API bool	GetInvertAxisKey (const FKey AxisKey)
ENGINE_API bool	GetInvertAxis (const FName AxisName)
ENGINE_API void	InvertAxisKey (const FKey AxisKey)
ENGINE_API void	InvertAxis (const FName AxisName)
ENGINE_API void	ClearSmoothing ()
ENGINE_API void	AddActionMapping (const FInputActionKeyMapping &KeyMapping)
ENGINE_API void	RemoveActionMapping (const FInputActionKeyMapping &KeyMapping)
ENGINE_API void	AddAxisMapping (const FInputAxisKeyMapping &KeyMapping)
ENGINE_API void	RemoveAxisMapping (const FInputAxisKeyMapping &KeyMapping)
ENGINE_API void	ForceRebuildingKeyMaps (const bool bRestoreDefaults=false)
ENGINE_API APlayerController *	GetOuterAPlayerController () const
ENGINE_API ULocalPlayer *	GetOwningLocalPlayer () const
virtual ENGINE_API void	PostInitProperties () override
virtual ENGINE_API UWorld *	GetWorld () const override
virtual ENGINE_API void	FlushPressedKeys ()
ENGINE_API void	FlushPressedActionBindingKeys (FName ActionName)
PRAGMA_DISABLE_DEPRECATION_WARNINGS virtual ENGINE_API bool	InputKey (const FInputKeyParams &Params) final
PRAGMA_ENABLE_DEPRECATION_WARNINGS virtual ENGINE_API bool	InputKey (const FInputKeyEventArgs &Params)
ENGINE_API bool	InputTouch (uint32 Handle, ETouchType::Type Type, const FVector2D &TouchLocation, float Force, FDateTime DeviceTimestamp, uint32 TouchpadIndex)
ENGINE_API bool	InputTouch (const FInputDeviceId DeviceId, uint32 Handle, ETouchType::Type Type, const FVector2D &TouchLocation, float Force, uint32 TouchpadIndex, const uint64 Timestamp)
ENGINE_API bool	InputMotion (const FVector &Tilt, const FVector &RotationRate, const FVector &Gravity, const FVector &Acceleration)
ENGINE_API bool	InputMotion (const FInputDeviceId DeviceId, const FVector &Tilt, const FVector &RotationRate, const FVector &Gravity, const FVector &Acceleration, const uint64 Timestamp)
ENGINE_API bool	InputGesture (const FKey Gesture, const EInputEvent Event, const float Value)
ENGINE_API bool	InputGesture (const FInputDeviceId DeviceId, const FKey Gesture, const EInputEvent Event, const float Value, const uint64 Timestamp)
ENGINE_API void	UpdatePinchStartDistance ()
ENGINE_API void	Tick (float DeltaTime)
virtual ENGINE_API void	ProcessInputStack (const TArray< UInputComponent * > &InputComponentStack, const float DeltaTime, const bool bGamePaused)
ENGINE_API void	DiscardPlayerInput ()
virtual ENGINE_API float	SmoothMouse (float aMouse, uint8 &SampleCount, int32 Index)
virtual ENGINE_API void	DisplayDebug (class UCanvas *Canvas, const FDebugDisplayInfo &DebugDisplay, float &YL, float &YPos)
FKeyState *	GetKeyState (FKey InKey)
const FKeyState *	GetKeyState (FKey InKey) const
ENGINE_API bool	IsPressed (FKey InKey) const
ENGINE_API bool	WasJustPressed (FKey InKey) const
ENGINE_API bool	WasJustReleased (FKey InKey) const
ENGINE_API float	GetTimeDown (FKey InKey) const
ENGINE_API float	GetKeyValue (FKey InKey) const
ENGINE_API float	GetRawKeyValue (FKey InKey) const
ENGINE_API FVector	GetProcessedVectorKeyValue (FKey InKey) const
ENGINE_API FVector	GetRawVectorKeyValue (FKey InKey) const
ENGINE_API bool	IsAltPressed () const
ENGINE_API bool	IsCtrlPressed () const
ENGINE_API bool	IsShiftPressed () const
ENGINE_API bool	IsCmdPressed () const
uint32	GetKeyMapBuildIndex () const
ENGINE_API bool	Exec (UWorld *UInWorld, const TCHAR *Cmd, FOutputDevice &Ar)
ENGINE_API FString	GetBind (FKey Key)
ENGINE_API FKeyBind	GetExecBind (FString const &ExecCommand)
ENGINE_API bool	ExecInputCommands (UWorld *InWorld, const TCHAR *Cmd, class FOutputDevice &Ar)
virtual ENGINE_API const TArray< FInputActionKeyMapping > &	GetKeysForAction (const FName ActionName) const
virtual ENGINE_API const TArray< FInputAxisKeyMapping > &	GetKeysForAxis (const FName AxisName) const
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 UObject *	CreateDefaultSubobject (FName SubobjectFName, UClass *ReturnType, UClass *ClassToCreateByDefault, bool bIsRequired, bool bIsTransient)
template<class TReturnType >
TReturnType *	CreateEditorOnlyDefaultSubobject (FName SubobjectName, bool bTransient=false)
template<class TReturnType >
TReturnType *	CreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
template<class TReturnType , class TClassToConstructByDefault >
TReturnType *	CreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
template<class TReturnType >
TReturnType *	CreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
template<class TReturnType , class TClassToConstructByDefault >
TReturnType *	CreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
COREUOBJECT_API void	GetDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects)
COREUOBJECT_API UObject *	GetDefaultSubobjectByName (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	PostLoad ()
virtual COREUOBJECT_API void	PostLoadSubobjects (FObjectInstancingGraph *OuterInstanceGraph)
virtual COREUOBJECT_API void	BeginDestroy ()
virtual bool	IsReadyForFinishDestroy ()
virtual COREUOBJECT_API void	FinishDestroy ()
virtual COREUOBJECT_API void	Serialize (FArchive &Ar)
virtual COREUOBJECT_API void	Serialize (FStructuredArchive::FRecord Record)
virtual void	ShutdownAfterError ()
virtual void	PostInterpChange (FProperty *PropertyThatChanged)
virtual COREUOBJECT_API void	PostRename (UObject *OldOuter, const FName OldName)
virtual void	PreDuplicate (FObjectDuplicationParameters &DupParams)
virtual void	PostDuplicate (bool bDuplicateForPIE)
virtual void	PostDuplicate (EDuplicateMode::Type DuplicateMode)
virtual COREUOBJECT_API bool	NeedsLoadForClient () const
virtual COREUOBJECT_API bool	NeedsLoadForServer () const
virtual COREUOBJECT_API bool	NeedsLoadForTargetPlatform (const class ITargetPlatform *TargetPlatform) const
virtual bool	NeedsLoadForEditorGame () 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 COREUOBJECT_API bool	Rename (const TCHAR *NewName=nullptr, UObject *NewOuter=nullptr, ERenameFlags Flags=REN_None)
virtual FString	GetDesc ()
COREUOBJECT_API UScriptStruct *	GetSparseClassDataStruct () 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 FRestoreForUObjectOverwrite *	GetRestoreForUObjectOverwrite ()
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	GetLifetimeReplicatedProps (TArray< class FLifetimeProperty > &OutLifetimeProps) const
virtual COREUOBJECT_API void	GetReplicatedCustomConditionState (FCustomPropertyConditionState &OutActiveState) const
virtual COREUOBJECT_API void	RegisterReplicationFragments (UE::Net::FFragmentRegistrationContext &Context, UE::Net::EFragmentRegistrationFlags RegistrationFlags)
virtual COREUOBJECT_API bool	IsNameStableForNetworking () const
virtual COREUOBJECT_API bool	IsFullNameStableForNetworking () const
virtual COREUOBJECT_API bool	IsSupportedForNetworking () 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 UFunction *	FindFunction (FName InName) const
COREUOBJECT_API UFunction *	FindFunctionChecked (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 TCHAR *	GetConfigOverridePlatform () 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 UObject *	GetArchetype () 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)
virtual int32	GetFunctionCallspace (UFunction *Function, FFrame *Stack)
virtual bool	CallRemoteFunction (UFunction *Function, void *Parms, struct FOutParmRec *OutParms, FFrame *Stack)
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 UClass *	RegenerateClass (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 UObject *	GetOutermostObject () const
COREUOBJECT_API UPackage *	GetPackage () const
UE_INTERNAL virtual COREUOBJECT_API UE::Core::FVersePath	GetVersePath () const
COREUOBJECT_API UPackage *	GetOutermost () const
COREUOBJECT_API bool	MarkPackageDirty () const
COREUOBJECT_API bool	IsTemplate (EObjectFlags TemplateTypes=RF_ArchetypeObject|RF_ClassDefaultObject) const
COREUOBJECT_API UObject *	GetTypedOuter (UClass *Target) const
template<typename T >
T *	GetTypedOuter () const
template<typename InterfaceClassType >
InterfaceClassType *	GetImplementingOuter () const
COREUOBJECT_API UObjectBaseUtility *	GetImplementingOuterObject (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 UClass *	FindNearestCommonBaseClass (const UClass *TestClass) const
COREUOBJECT_API void *	GetInterfaceAddress (UClass *InterfaceClass)
COREUOBJECT_API void *	GetNativeInterfaceAddress (UClass *InterfaceClass)
const void *	GetNativeInterfaceAddress (UClass *InterfaceClass) const
COREUOBJECT_API bool	IsTemplateForSubobjects (EObjectFlags TemplateTypes=RF_ClassDefaultObject|RF_DefaultSubObject|RF_InheritableComponentTemplate) const
COREUOBJECT_API bool	IsDefaultSubobject () const
COREUOBJECT_API class FLinkerLoad *	GetLinker () 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 UClass *	GetClass () const
FORCEINLINE UObject *	GetOuter () const
FORCEINLINE FName	GetFName () const
virtual COREUOBJECT_API FName	GetFNameForStatID () const
COREUOBJECT_API UPackage *	GetExternalPackage () const
COREUOBJECT_API void	SetExternalPackage (UPackage *InPackage)
COREUOBJECT_API UPackage *	GetExternalPackageInternal () 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)

Static Public Member Functions
static ENGINE_API void	AddEngineDefinedActionMapping (const FInputActionKeyMapping &ActionMapping)
static ENGINE_API void	AddEngineDefinedAxisMapping (const FInputAxisKeyMapping &AxisMapping)
static const TArray< FInputActionKeyMapping > &	GetEngineDefinedActionMappings ()
static const TArray< FInputAxisKeyMapping > &	GetEngineDefinedAxisMappings ()
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 FName &	SourceFileTagName ()
static COREUOBJECT_API UObject *	GetArchetypeFromRequiredInfo (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)

Public Attributes
FVector	Touches [EKeys::NUM_TOUCH_KEYS]
TMap< uint32, FVector >	TouchEventLocations
float	ZeroTime [2]
float	SmoothedMouse [2]
int32	MouseSamples
float	MouseSamplingTotal
TArray< struct FKeyBind >	DebugExecBindings
TArray< struct FInputAxisConfigEntry >	AxisConfig
TArray< struct FInputActionKeyMapping >	ActionMappings
TArray< struct FInputAxisKeyMapping >	AxisMappings
TArray< FName >	InvertedAxis

Protected Member Functions
virtual ENGINE_API void	EvaluateKeyMapState (const float DeltaTime, const bool bGamePaused, OUT TArray< TPair< FKey, FKeyState * > > &KeysWithEvents)
virtual ENGINE_API void	EvaluateInputDelegates (const TArray< UInputComponent * > &InputComponentStack, const float DeltaTime, const bool bGamePaused, const TArray< TPair< FKey, FKeyState * > > &KeysWithEvents)
virtual void	PrepareInputDelegatesForEvaluation (const TArray< UInputComponent * > &InputComponentStack, const float DeltaTime, const bool bGamePaused, const TArray< TPair< FKey, FKeyState * > > &KeysWithEvents)
virtual ENGINE_API bool	EvaluateInputComponentDelegates (UInputComponent *const IC, const TArray< TPair< FKey, FKeyState * > > &KeysWithEvents, const float DeltaTime, const bool bGamePaused)
virtual ENGINE_API void	EvaluateBlockedInputComponent (UInputComponent *InputComponent)
TMap< FKey, FKeyState > &	GetKeyStateMap ()
virtual ENGINE_API FVector	MassageVectorAxisInput (FKey Key, FVector RawValue)
virtual ENGINE_API float	MassageAxisInput (FKey Key, float RawValue)
ENGINE_API void	ConditionalInitAxisProperties ()
virtual ENGINE_API bool	IsKeyHandledByAction (FKey Key) const
ENGINE_API void	GetActionsBoundToKey (UInputComponent *InputComponent, FKey Key, TArray< TSharedPtr< FInputActionBinding > > &Actions)
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)

Friends
class	UEnhancedPlayerInput

Additional Inherited Members
Public Types inherited from UObject
enum class	ENetFields_Private { NETFIELD_REP_START = 0 , NETFIELD_REP_END = -1 }
typedef UObject	WithinClass

Detailed Description

Object within PlayerController that processes player input. Only exists on the client in network games.

See also

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

Constructor & Destructor Documentation

UPlayerInput()

UPlayerInput::UPlayerInput

(

)

Member Function Documentation

AddActionMapping()

void UPlayerInput::AddActionMapping

(

const FInputActionKeyMapping &

KeyMapping

)

Add a player specific action mapping.

AddAxisMapping()

void UPlayerInput::AddAxisMapping

(

const FInputAxisKeyMapping &

KeyMapping

)

Add a player specific axis mapping.

AddEngineDefinedActionMapping()

void UPlayerInput::AddEngineDefinedActionMapping ( const FInputActionKeyMapping &  ActionMapping )

static

Add an engine defined action mapping that cannot be remapped.

AddEngineDefinedAxisMapping()

void UPlayerInput::AddEngineDefinedAxisMapping ( const FInputAxisKeyMapping &  AxisMapping )

static

Add an engine defined axis mapping that cannot be remapped.

ClearSmoothing()

void UPlayerInput::ClearSmoothing

(

)

Exec function to reset mouse smoothing values

ConditionalInitAxisProperties()

void UPlayerInput::ConditionalInitAxisProperties ( )

protected

Initialized axis properties (i.e deadzone values) if needed

DiscardPlayerInput()

void UPlayerInput::DiscardPlayerInput

(

)

Rather than processing input, consume it and discard without doing anything useful with it. Like calling ProcessInputStack() and ignoring all results.

DisplayDebug()

void UPlayerInput::DisplayDebug ( class UCanvas *  Canvas, const FDebugDisplayInfo &  DebugDisplay, float &  YL, float &  YPos  )

virtual

Draw important PlayerInput variables on canvas. HUD will call DisplayDebug() on the current ViewTarget when the ShowDebug exec is used

Parameters

Canvas	- Canvas to draw on
DebugDisplay	- Contains information about what debug data to display
YL	- Height of the current font
YPos	- Y position on Canvas. YPos += YL, gives position to draw text for next debug line.

EvaluateBlockedInputComponent()

void UPlayerInput::EvaluateBlockedInputComponent ( UInputComponent *  InputComponent )

protectedvirtual

Called on any input component which was not evaluated due to the input being blocked by another component earlier in the stack. These input components will not have had the EvaluateInputComponentDelegates flow executed, because they are blocked. This is a good spot to reset any delegate values if desired to reflect that they didn't execute for next frame.

EvaluateInputComponentDelegates()

bool UPlayerInput::EvaluateInputComponentDelegates ( UInputComponent *const  IC, const TArray< TPair< FKey, FKeyState * > > &  KeysWithEvents, const float  DeltaTime, const bool  bGamePaused  )

protectedvirtual

Evaluates a single input component on the component stack and executes its bound delegates.

Returns

True if this input component should BLOCK the rest of the input stack, preventing further components from evaluating their delegates.

EvaluateInputDelegates()

void UPlayerInput::EvaluateInputDelegates ( const TArray< UInputComponent * > &  InputComponentStack, const float  DeltaTime, const bool  bGamePaused, const TArray< TPair< FKey, FKeyState * > > &  KeysWithEvents  )

protectedvirtual

Evaluates the state of any bound input delegates on the given Input Component Stack. This should only be called from UPlayerInput::ProcessInputStack

EvaluateKeyMapState()

void UPlayerInput::EvaluateKeyMapState ( const float  DeltaTime, const bool  bGamePaused, OUT TArray< TPair< FKey, FKeyState * > > &  KeysWithEvents  )

protectedvirtual

Evaluates the current state of the KeyStateMap this tick. Should only be called from UPlayerInput::ProcessInputStack

Exec()

bool UPlayerInput::Exec	(	UWorld *	UInWorld,
		const TCHAR *	Cmd,
		FOutputDevice &	Ar
	)

Exec handler

ExecInputCommands()

bool UPlayerInput::ExecInputCommands	(	UWorld *	InWorld,
		const TCHAR *	Cmd,
		class FOutputDevice &	Ar
	)

Execute input commands within the legacy key binding system.

FlushPressedActionBindingKeys()

void UPlayerInput::FlushPressedActionBindingKeys

(

FName

ActionName

)

Flushes the current key state of the keys associated with the action name passed in

FlushPressedKeys()

void UPlayerInput::FlushPressedKeys ( )

virtual

Flushes the current key state.

ForceRebuildingKeyMaps()

void UPlayerInput::ForceRebuildingKeyMaps

(

const bool

bRestoreDefaults = false

)

Clear the current cached key maps and rebuild from the source arrays.

GetActionsBoundToKey()

void UPlayerInput::GetActionsBoundToKey ( UInputComponent *  InputComponent, FKey  Key, TArray< TSharedPtr< FInputActionBinding > > &  Actions  )

protected

Retrieves the actions bound to the given input component which are triggered by a given key.

GetAxisProperties()

bool UPlayerInput::GetAxisProperties	(	const FKey	AxisKey,
		FInputAxisProperties &	AxisProperties
	)

Gets the axis properties for a given AxisKey. Returns if true if AxisKey was found in the AxisConfig array.

GetBind()

FString UPlayerInput::GetBind

(

FKey

Key

)

Returns the command for a given key in the legacy binding system

GetEngineDefinedActionMappings()

static const TArray< FInputActionKeyMapping > & UPlayerInput::GetEngineDefinedActionMappings ( )

inlinestatic

GetEngineDefinedAxisMappings()

static const TArray< FInputAxisKeyMapping > & UPlayerInput::GetEngineDefinedAxisMappings ( )

inlinestatic

GetExecBind()

FKeyBind UPlayerInput::GetExecBind

(

FString const &

ExecCommand

)

Get the legacy Exec key binding for the given command.

GetInvertAxis()

bool UPlayerInput::GetInvertAxis

(

const FName

AxisName

)

Returns whether an Axis Mapping is inverted

GetInvertAxisKey()

bool UPlayerInput::GetInvertAxisKey

(

const FKey

AxisKey

)

Returns whether an Axis Key is inverted

GetKeyMapBuildIndex()

uint32 UPlayerInput::GetKeyMapBuildIndex ( ) const

inline

GetKeysForAction()

const TArray< FInputActionKeyMapping > & UPlayerInput::GetKeysForAction ( const FName  ActionName ) const

virtual

Returns the list of keys mapped to the specified Action Name

GetKeysForAxis()

const TArray< FInputAxisKeyMapping > & UPlayerInput::GetKeysForAxis ( const FName  AxisName ) const

virtual

Returns the list of keys mapped to the specified Axis Name

GetKeyState() [1/2]

FKeyState * UPlayerInput::GetKeyState ( FKey  InKey )

inline

Returns

key state of the InKey

GetKeyState() [2/2]

const FKeyState * UPlayerInput::GetKeyState ( FKey  InKey ) const

inline

GetKeyStateMap()

TMap< FKey, FKeyState > & UPlayerInput::GetKeyStateMap ( )

inlineprotected

GetKeyValue()

float UPlayerInput::GetKeyValue

(

FKey

InKey

)

const

Returns

current state of the InKey

GetMouseSensitivityX()

float UPlayerInput::GetMouseSensitivityX

(

)

Returns the mouse sensitivity along the X-axis, or the Y-axis, or 1.0 if none are known.

GetMouseSensitivityY()

float UPlayerInput::GetMouseSensitivityY

(

)

Returns the mouse sensitivity along the Y-axis, or 1.0 if none are known.

GetOuterAPlayerController()

APlayerController * UPlayerInput::GetOuterAPlayerController

(

)

const

Return's this object casted to a player controller. This can be null if there is no player controller.

GetOwningLocalPlayer()

ULocalPlayer * UPlayerInput::GetOwningLocalPlayer

(

)

const

Returns the owning local player of this Input Object. This will only be valid if there is a current outer player controller.

GetProcessedVectorKeyValue()

FVector UPlayerInput::GetProcessedVectorKeyValue

(

FKey

InKey

)

const

Returns

processed value of the InKey

GetRawKeyValue()

float UPlayerInput::GetRawKeyValue

(

FKey

InKey

)

const

Returns

current state of the InKey

GetRawVectorKeyValue()

FVector UPlayerInput::GetRawVectorKeyValue

(

FKey

InKey

)

const

Returns

raw value of the InKey

GetTimeDown()

float UPlayerInput::GetTimeDown

(

FKey

InKey

)

const

Returns

how long the key has been held down, or 0.f if not down.

GetWorld()

class UWorld * UPlayerInput::GetWorld ( ) const

overridevirtual

InputGesture() [1/2]

PRAGMA_ENABLE_DEPRECATION_WARNINGS bool UPlayerInput::InputGesture	(	const FInputDeviceId	DeviceId,
		const FKey	Gesture,
		const EInputEvent	Event,
		const float	Value,
		const uint64	Timestamp
	)

Handles a gesture input event. Returns true.

InputGesture() [2/2]

PRAGMA_DISABLE_DEPRECATION_WARNINGS bool UPlayerInput::InputGesture	(	const FKey	Gesture,
		const EInputEvent	Event,
		const float	Value
	)

Handles a gesture input event. Returns true.

InputKey() [1/2]

PRAGMA_ENABLE_DEPRECATION_WARNINGS bool UPlayerInput::InputKey ( const FInputKeyEventArgs &  Params )

virtual

Handles a key input event. Returns true if there is an action that handles the specified key.

InputKey() [2/2]

PRAGMA_DISABLE_DEPRECATION_WARNINGS bool UPlayerInput::InputKey ( const FInputKeyParams &  Params )

finalvirtual

Handles a key input event. Returns true if there is an action that handles the specified key.

InputMotion() [1/2]

PRAGMA_ENABLE_DEPRECATION_WARNINGS bool UPlayerInput::InputMotion	(	const FInputDeviceId	DeviceId,
		const FVector &	Tilt,
		const FVector &	RotationRate,
		const FVector &	Gravity,
		const FVector &	Acceleration,
		const uint64	Timestamp
	)

Handles a motion input event. Returns true.

InputMotion() [2/2]

PRAGMA_DISABLE_DEPRECATION_WARNINGS bool UPlayerInput::InputMotion	(	const FVector &	Tilt,
		const FVector &	RotationRate,
		const FVector &	Gravity,
		const FVector &	Acceleration
	)

Handles a motion input event. Returns true.

InputTouch() [1/2]

PRAGMA_ENABLE_DEPRECATION_WARNINGS bool UPlayerInput::InputTouch	(	const FInputDeviceId	DeviceId,
		uint32	Handle,
		ETouchType::Type	Type,
		const FVector2D &	TouchLocation,
		float	Force,
		uint32	TouchpadIndex,
		const uint64	Timestamp
	)

Handles a touch input event. Returns true.

InputTouch() [2/2]

PRAGMA_DISABLE_DEPRECATION_WARNINGS bool UPlayerInput::InputTouch	(	uint32	Handle,
		ETouchType::Type	Type,
		const FVector2D &	TouchLocation,
		float	Force,
		FDateTime	DeviceTimestamp,
		uint32	TouchpadIndex
	)

Handles a touch input event. Returns true.

InvertAxis()

void UPlayerInput::InvertAxis

(

const FName

AxisName

)

Exec function to invert an axis mapping

InvertAxisKey()

void UPlayerInput::InvertAxisKey

(

const FKey

AxisKey

)

Exec function to invert an axis key

IsAltPressed()

bool UPlayerInput::IsAltPressed

(

)

const

Returns

true if alt key is pressed

IsCmdPressed()

bool UPlayerInput::IsCmdPressed

(

)

const

Returns

true if cmd key is pressed

IsCtrlPressed()

bool UPlayerInput::IsCtrlPressed

(

)

const

Returns

true if ctrl key is pressed

IsKeyHandledByAction()

bool UPlayerInput::IsKeyHandledByAction ( FKey  Key ) const

protectedvirtual

Returns

True if a key is handled by an action binding

IsPressed()

bool UPlayerInput::IsPressed

(

FKey

InKey

)

const

Returns

true if InKey is currently held

IsShiftPressed()

bool UPlayerInput::IsShiftPressed

(

)

const

Returns

true if shift key is pressed

MassageAxisInput()

float UPlayerInput::MassageAxisInput ( FKey  Key, float  RawValue  )

protectedvirtual

Given raw keystate value, returns the "massaged" value. Override for any custom behavior, such as input changes dependent on a particular game state.

MassageVectorAxisInput()

FVector UPlayerInput::MassageVectorAxisInput ( FKey  Key, FVector  RawValue  )

protectedvirtual

Given raw keystate value of a vector axis, returns the "massaged" value. Override for any custom behavior, such as input changes dependent on a particular game state.

PostInitProperties()

void UPlayerInput::PostInitProperties ( )

overridevirtual

Called after the C++ constructor and after the properties have been initialized, including those loaded from config. This is called before any serialization or other setup has happened.

Reimplemented from UObject.

PrepareInputDelegatesForEvaluation()

virtual void UPlayerInput::PrepareInputDelegatesForEvaluation ( const TArray< UInputComponent * > &  InputComponentStack, const float  DeltaTime, const bool  bGamePaused, const TArray< TPair< FKey, FKeyState * > > &  KeysWithEvents  )

inlineprotectedvirtual

Called just before iteration every input component on the stack to process their bound listener delegates. This provides an extension point to handle modifying the current input state before determining which input delegates should be fired.

ProcessInputStack()

void UPlayerInput::ProcessInputStack ( const TArray< UInputComponent * > &  InputComponentStack, const float  DeltaTime, const bool  bGamePaused  )

virtual

Process the frame's input events given the current input component stack.

RemoveActionMapping()

void UPlayerInput::RemoveActionMapping

(

const FInputActionKeyMapping &

KeyMapping

)

Remove a player specific action mapping.

RemoveAxisMapping()

void UPlayerInput::RemoveAxisMapping

(

const FInputAxisKeyMapping &

KeyMapping

)

Remove a player specific axis mapping.

SetAxisProperties()

void UPlayerInput::SetAxisProperties	(	const FKey	AxisKey,
		const FInputAxisProperties &	AxisProperties
	)

Gets the axis properties for a given AxisKey. Returns if true if AxisKey was found in the AxisConfig array.

SetBind()

void UPlayerInput::SetBind	(	FName	BindName,
		const FString &	Command
	)

Exec function to add a debug exec command. Use + to addmodifiers; do not include any spaces between modifiers, so that it is not conflated with the command to be bound. example usage: SetBind k serverexec slomo 0.1 SetBind shift+k serverexec slomo 1

SetMouseSensitivity() [1/2]

void UPlayerInput::SetMouseSensitivity ( const float  Sensitivity )

inline

Sets both X and Y axis sensitivity to the supplied value.

SetMouseSensitivity() [2/2]

void UPlayerInput::SetMouseSensitivity	(	const float	SensitivityX,
		const float	SensitivityY
	)

Exec function to change the mouse sensitivity

SmoothMouse()

float UPlayerInput::SmoothMouse ( float  aMouse, uint8 &  SampleCount, int32  Index  )

virtual

Smooth mouse movement, because mouse sampling doesn't match up with tick time.

Note

: if we got sample event for zero mouse samples (so we didn't have to guess whether a 0 was caused by no sample occuring during the tick (at high frame rates) or because the mouse actually stopped)

Parameters

	aMouse is the mouse axis movement received from DirectInput
	SampleCount is the number of mouse samples received from DirectInput
	Index is 0 for X axis, 1 for Y axis

Returns

the smoothed mouse axis movement

Tick()

void UPlayerInput::Tick

(

float

DeltaTime

)

Per frame tick function. Primarily for gesture recognition

UpdatePinchStartDistance()

void UPlayerInput::UpdatePinchStartDistance

(

)

Manually update the GestureRecognizer AnchorDistance using the current locations of the touches

WasJustPressed()

bool UPlayerInput::WasJustPressed

(

FKey

InKey

)

const

Returns

true if InKey went from up to down since player input was last processed.

WasJustReleased()

bool UPlayerInput::WasJustReleased

(

FKey

InKey

)

const

return true if InKey went from down to up since player input was last processed.

Friends And Related Symbol Documentation

UEnhancedPlayerInput

friend class UEnhancedPlayerInput

friend

Member Data Documentation

ActionMappings

TArray<struct FInputActionKeyMapping> UPlayerInput::ActionMappings

This player's version of the Action Mappings

AxisConfig

TArray<struct FInputAxisConfigEntry> UPlayerInput::AxisConfig

This player's version of the Axis Properties

AxisMappings

TArray<struct FInputAxisKeyMapping> UPlayerInput::AxisMappings

This player's version of Axis Mappings

DebugExecBindings

TArray<struct FKeyBind> UPlayerInput::DebugExecBindings

Generic bindings of keys to Exec()-compatible strings for development purposes only

InvertedAxis

TArray<FName> UPlayerInput::InvertedAxis

List of Axis Mappings that have been inverted

MouseSamples

int32 UPlayerInput::MouseSamples

Current average mouse movement/sample

MouseSamplingTotal

float UPlayerInput::MouseSamplingTotal

Number of mouse samples since mouse movement has been zero

SmoothedMouse

float UPlayerInput::SmoothedMouse[2]

How long received mouse movement has been zero.

Touches

FVector UPlayerInput::Touches[EKeys::NUM_TOUCH_KEYS]

TouchEventLocations

TMap<uint32, FVector> UPlayerInput::TouchEventLocations

Used to store paired touch locations for event ids during the frame and flushed when processed.

ZeroTime

float UPlayerInput::ZeroTime[2]

---

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

• Engine/Source/Runtime/Engine/Classes/GameFramework/PlayerInput.h
• Engine/Source/Runtime/Engine/Private/UserInterface/PlayerInput.cpp