Inheritance diagram for GamepadTriggerEffect:

[legend]

Public Member Functions
proto external GamepadTrigger	GetTriggerId ()
	Get TriggerId (Left, Right)

proto external GamepadTriggerEffect	GetEffectId ()
	Get TriggerEffectId (Rumble, Feedback)

proto external void	GetCurve (out notnull array< int > outCurve)
	Get trigger effect amplitude/strength curve.

proto external void	GetBaseCurve (out notnull array< int > outCurve)
	Get base amplitude/strength curve (without variable effects)

proto external int	GetFrequency ()
	Get Rumble frequency.

proto external int	GetBaseFrequency ()
	Get base Rumble frequency (without variable effects)

proto external bool	IsFrequencyVariable ()

proto external bool	IsAmplitudeVariable ()

proto external void	SetFrequencyDeltaAmount (float amount)
	Sets 'm_fFreqDeltaAmount'.

proto external void	SetAmplitudeDeltaAmount (float amount)
	Sets 'm_fAmplDeltaAmount'.

proto external float	GetFrequencyDeltaAmount ()

proto external float	GetAmplitudeDeltaAmount ()

Public Member Functions inherited from GamepadEffect
proto external IEntity	GetOwner ()

proto external bool	IsEnabled ()

proto external void	SetEnabled (bool val, float autoDisableTimeout=0.0, bool immediate=true)
	Disabled GamepadEffects are ignored.

proto external owned string	GetContext ()
	Name of GamepadEffectContext on which this GamepadEffect depends on.

proto external owned string	GetEffectName ()

proto external int	GetPriority ()
	GamepadEffect with higher priority is preferred.

proto external void	ApplyImmediate ()
	Apply this effect immediately. Normally it would be applied at next update of GamepadIOHandlerComponent.

Member Function Documentation

◆ GetAmplitudeDeltaAmount()

proto external float GamepadTriggerEffect.GetAmplitudeDeltaAmount ( )

◆ GetBaseCurve()

proto external void GamepadTriggerEffect.GetBaseCurve ( out notnull array< int > outCurve )

Get base amplitude/strength curve (without variable effects)

◆ GetBaseFrequency()

proto external int GamepadTriggerEffect.GetBaseFrequency ( )

Get base Rumble frequency (without variable effects)

◆ GetCurve()

proto external void GamepadTriggerEffect.GetCurve ( out notnull array< int > outCurve )

Get trigger effect amplitude/strength curve.

◆ GetEffectId()

proto external GamepadTriggerEffect GamepadTriggerEffect.GetEffectId ( )

Get TriggerEffectId (Rumble, Feedback)

◆ GetFrequency()

proto external int GamepadTriggerEffect.GetFrequency ( )

Get Rumble frequency.

◆ GetFrequencyDeltaAmount()

proto external float GamepadTriggerEffect.GetFrequencyDeltaAmount ( )

◆ GetTriggerId()

proto external GamepadTrigger GamepadTriggerEffect.GetTriggerId ( )

Get TriggerId (Left, Right)

◆ IsAmplitudeVariable()

proto external bool GamepadTriggerEffect.IsAmplitudeVariable ( )

◆ IsFrequencyVariable()

proto external bool GamepadTriggerEffect.IsFrequencyVariable ( )

◆ SetAmplitudeDeltaAmount()

proto external void GamepadTriggerEffect.SetAmplitudeDeltaAmount ( float amount )

Sets 'm_fAmplDeltaAmount'.

Applicable only when m_bVariableAmplitude is set to true.

Parameters

amount must be in the range [0.0, 1.0].

◆ SetFrequencyDeltaAmount()

proto external void GamepadTriggerEffect.SetFrequencyDeltaAmount ( float amount )

Sets 'm_fFreqDeltaAmount'.

Applicable only when m_bVariableFreq is set to true.