1. Epic GamesDeveloper
  3. UForceFeedbackComponent

UForceFeedbackComponent

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

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Components

Inheritance Hierarchy

References

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

Syntax

UCLASS (ClassGroup=(Utility),  
       HideCategories=(Object, ActorComponent, Physics, Rendering, Mobility, LOD),  
       ShowCategories=Trigger, Meta=(BlueprintSpawnableComponent), MinimalAPI)  
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

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FForceFeedbackAttenuationSettings AttenuationOverrides If bOverrideSettings is true, the attenuation properties to use for effects generated by this component
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite TObjectPtr< class UForceFeedbackAttenuation > AttenuationSettings If bOverrideSettings is false, the asset to use to determine attenuation properties for effects generated by this component
Public variable UProperty uint8: 1 bAutoDestroy Auto destroy this component on completion
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint8: 1 bIgnoreTimeDilation Should the playback of the forcefeedback pattern ignore time dilation and use the app's delta time
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint8: 1 bLooping  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite 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
Public variable UProperty uint8: 1 bStopWhenOwnerDestroyed Stop effect when owner is destroyed
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TObjectPtr< UForceFeedbackEffect > ForceFeedbackEffect The feedback effect to be played
Public variable UProperty Category, EditAnywhere BlueprintReadWrite float IntensityMultiplier The intensity multiplier to apply to effects generated by this component
Public variable UProperty BlueprintAssignable FOnForceFeedbackFinished OnForceFeedbackFinished Called when we finish playing audio, either because it played to completion or because a Stop() call turned it off early

Constructors

  Type Name Description
Public function  

UForceFeedbackComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void

AdjustAttenuation ( const FForceFeedbackAttenuationSettings& InAttenuationSettings
)

 Modify the attenuation settings of the component
Public function Const UFunction BlueprintCallable, Category, Meta bool  
Public function Const void Collects the various attenuation shapes that may be applied to the effect played by the component for visualization in the editor.
Public function Const const FForceFeedbackAttenuationSettings * Returns a pointer to the attenuation settings to be used (if any) for this audio component dependent on the ForceFeedbackEffectAttenuation asset or overrides set.
Public function Virtual UFunction BlueprintCallable, Category void

Play ( float StartTime
)

 Start a feedback effect playing
Public function UFunction BlueprintCallable, Category void

SetForceFeedbackEffect ( UForceFeedbackEffect* NewForceFeedbackEffect
)

 Set what force feedback effect is played by this component
Public function UFunction BlueprintCallable, Category void

SetIntensityMultiplier ( float NewIntensityMultiplier
)

 Set a new intensity multiplier
Public function Virtual UFunction BlueprintCallable, Category void

Stop ()

 Stop playing the feedback effect

Overridden from UActorComponent

  Type Name Description
Public function Virtual void

Activate ( bool bReset
)

 Activates the SceneComponent, should be overridden by native child classes.
Public function Virtual Const const UObject * Give a readable name for this component, including asset name if applicable
Public function Virtual void Deactivates the SceneComponent.
Public function Virtual Const bool Overridable check for a component to indicate to its Owner that it should prevent the Actor from auto destroying when finished
Public function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
Public function Virtual void Called when a component is unregistered.

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page