UForceFeedbackEffect | Unreal Engine 5.7 Documentation

A predefined force-feedback effect to be played on a controller


Name	UForceFeedbackEffect
Type	class
Header File	/Engine/Source/Runtime/Engine/Classes/GameFramework/ForceFeedbackEffect.h
Include Path	#include "GameFramework/ForceFeedbackEffect.h"

Syntax

UCLASS (BlueprintType, MinimalAPI)  
class UForceFeedbackEffect : public UObject

Name	Remarks	Include Path	Unreal Specifiers
UForceFeedbackEffect ( const FObjectInitializer& ObjectInitializer )		GameFramework/ForceFeedbackEffect.h

Name	Type	Remarks	Include Path	Unreal Specifiers
ChannelDetails	TArray< FForceFeedbackChannelDetails >		GameFramework/ForceFeedbackEffect.h	EditAnywhere Category="ForceFeedbackEffect"
DeviceProperties	TArray< TObjectPtr< UInputDeviceProperty > >	A map of input device properties that we want to set while this effect is playing	GameFramework/ForceFeedbackEffect.h	EditAnywhere Instanced Category="ForceFeedbackEffect"
Duration	float	Duration of force feedback pattern in seconds.	GameFramework/ForceFeedbackEffect.h	Category=Info AssetRegistrySearchable VisibleAnywhere BlueprintReadOnly
PerDeviceOverrides	TMap< FName, FForceFeedbackEffectOverridenChannelDetails >	A map of platform name -> ForceFeedback channel details	GameFramework/ForceFeedbackEffect.h	EditAnywhere Category="ForceFeedbackEffect" Meta=(GetOptions="Engine.InputPlatformSettings.GetAllHardwareDeviceNames")

Name	Remarks	Include Path
const TArray< FForceFeedbackChannelDetails > & GetCurrentChannelDetails ( const FPlatformUserId PlatformUser ) const	Returns the channel details that should currently be used for the given platform.	GameFramework/ForceFeedbackEffect.h
float GetDuration()		GameFramework/ForceFeedbackEffect.h
float GetTotalDevicePropertyDuration()	Returns the longest duration of any active UInputDeviceProperty's that this effect has on it.	GameFramework/ForceFeedbackEffect.h
void GetValues ( const float EvalTime, FForceFeedbackValues& Values, const FPlatformUserId PlatformUser, float ValueMultiplier ) const		GameFramework/ForceFeedbackEffect.h

Name	Remarks	Include Path	Unreal Specifiers
virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedEvent )		GameFramework/ForceFeedbackEffect.h