Class ForceFeedbackComponent

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

Inheritance
System.Object
UObject
ActorComponent
SceneComponent
ForceFeedbackComponent
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.Engine
Assembly: UE4DotNet.dll
Syntax
public class ForceFeedbackComponent : SceneComponent

Properties

| Improve this Doc View Source

AttenuationOverrides

If bOverrideSettings is true, the attenuation properties to use for effects generated by this component

Declaration
public ForceFeedbackAttenuationSettings AttenuationOverrides { get; set; }
Property Value
Type Description
ForceFeedbackAttenuationSettings
| Improve this Doc View Source

AttenuationSettings

If bOverrideSettings is false, the asset to use to determine attenuation properties for effects generated by this component

Declaration
public ForceFeedbackAttenuation AttenuationSettings { get; set; }
Property Value
Type Description
ForceFeedbackAttenuation
| Improve this Doc View Source

bAutoDestroy

Declaration
public bool bAutoDestroy { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bIgnoreTimeDilation

Declaration
public bool bIgnoreTimeDilation { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bLooping

Declaration
public bool bLooping { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bOverrideAttenuation

Declaration
public bool bOverrideAttenuation { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bStopWhenOwnerDestroyed

Declaration
public bool bStopWhenOwnerDestroyed { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static ForceFeedbackComponent DefaultObject { get; }
Property Value
Type Description
ForceFeedbackComponent
| Improve this Doc View Source

ForceFeedbackEffect

The feedback effect to be played

Declaration
public ForceFeedbackEffect ForceFeedbackEffect { get; }
Property Value
Type Description
ForceFeedbackEffect
| Improve this Doc View Source

IntensityMultiplier

The intensity multiplier to apply to effects generated by this component

Declaration
public float IntensityMultiplier { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class

Methods

| Improve this Doc View Source

AdjustAttenuation(ForceFeedbackAttenuationSettings)

Modify the attenuation settings of the component

Declaration
public void AdjustAttenuation(ForceFeedbackAttenuationSettings InAttenuationSettings)
Parameters
Type Name Description
ForceFeedbackAttenuationSettings InAttenuationSettings
| Improve this Doc View Source

BP_GetAttenuationSettingsToApply()

BP Get Attenuation Settings to Apply

Declaration
public (ForceFeedbackAttenuationSettings, bool) BP_GetAttenuationSettingsToApply()
Returns
Type Description
System.ValueTuple<ForceFeedbackAttenuationSettings, System.Boolean>
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static ForceFeedbackComponent New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
ForceFeedbackComponent
| Improve this Doc View Source

Play(Single)

Start a feedback effect playing

Declaration
public void Play(float StartTime)
Parameters
Type Name Description
System.Single StartTime
| Improve this Doc View Source

SetForceFeedbackEffect(ForceFeedbackEffect)

Set what force feedback effect is played by this component

Declaration
public void SetForceFeedbackEffect(ForceFeedbackEffect NewForceFeedbackEffect)
Parameters
Type Name Description
ForceFeedbackEffect NewForceFeedbackEffect
| Improve this Doc View Source

SetIntensityMultiplier(Single)

Set a new intensity multiplier

Declaration
public void SetIntensityMultiplier(float NewIntensityMultiplier)
Parameters
Type Name Description
System.Single NewIntensityMultiplier
| Improve this Doc View Source

Stop()

Stop playing the feedback effect

Declaration
public void Stop()

Operators

| Improve this Doc View Source

Implicit(IntPtr to ForceFeedbackComponent)

Convert from IntPtr to UObject

Declaration
public static implicit operator ForceFeedbackComponent(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
ForceFeedbackComponent