Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

UForceFeedbackComponent

ForceFeedbackComponent allows placing a rumble effect in to the world and having it apply to player characters who come near it

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UForceFeedbackComponent

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Components/ForceFeedbackComponent.h
Include	#include "Components/ForceFeedbackComponent.h"

Syntax

class UForceFeedbackComponent : public USceneComponent

Remarks

ForceFeedbackComponent allows placing a rumble effect in to the world and having it apply to player characters who come near it

Variables

	Name	Description
FForceFeedbackA...	AttenuationOverrides	If bOverrideSettings is true, the attenuation properties to use for effects generated by this component
UForceFeedbackA...	AttenuationSettings	If bOverrideSettings is false, the asset to use to determine attenuation properties for effects generated by this component
uint8: 1	bAutoDestroy	Auto destroy this component on completion
uint8: 1	bIgnoreTimeDilation	Should the playback of the forcefeedback pattern ignore time dilation and use the app's delta time
uint8: 1	bLooping
uint8: 1	bOverrideAttenuation	Should the Attenuation Settings asset be used (false) or should the properties set directly on the component be used for attenuation properties
uint8: 1	bStopWhenOwnerDestroyed	Stop effect when owner is destroyed
UForceFeedbackE...	ForceFeedbackEffect	The feedback effect to be played
float	IntensityMultiplier	The intensity multiplier to apply to effects generated by this component
FOnForceFeedbac...	OnForceFeedbackFinished	Called when we finish playing audio, either because it played to completion or because a Stop() call turned it off early

Constructors

	Name	Description
	UForceFeedbackComponent ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	AdjustAttenuation ( const FForceFeedbackAttenuationSett... )	Modify the attenuation settings of the component
bool	BP_GetAttenuationSettingsToApply ( FForceFeedbackAttenuationSettings&... )
void	CollectAttenuationShapesForVisualization ( TMultiMap< EAttenuationShape::Type,... )	Collects the various attenuation shapes that may be applied to the effect played by the component for visualization in the editor.
const FForce...	GetAttenuationSettingsToApply()	Returns a pointer to the attenuation settings to be used (if any) for this audio component dependent on the ForceFeedbackEffectAttenuation asset or overrides set.
void	Play ( float StartTime )	Start a feedback effect playing
void	SetForceFeedbackEffect ( UForceFeedbackEffect* NewForce... )	Set what force feedback effect is played by this component
void	SetIntensityMultiplier ( float NewIntensityMultiplier )	Set a new intensity multiplier
void	Stop()	Stop playing the feedback effect

Overridden from UActorComponent

	Name	Description
void	Activate ( bool bReset )	Activates the SceneComponent, should be overridden by native child classes.
const UObjec...	AdditionalStatObject()	Give a readable name for this component, including asset name if applicable
void	Deactivate()	Deactivates the SceneComponent.
bool	IsReadyForOwnerToAutoDestroy()	Overridable check for a component to indicate to its Owner that it should prevent the Actor from auto destroying when finished
void	OnRegister()	Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
void	OnUnregister()	Called when a component is unregistered.

Overridden from UObject

		Name	Description
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss