GamepadRumbleEffect Interface Reference

Effect used to rumble the gamepad. More...

Inheritance diagram for GamepadRumbleEffect:

Public Member Functions
proto external int	GetFadeInTimeMS ()
	Get fade-in time.
proto external int	GetFadeOutTimeMS ()
	Get fade-out time.
proto external float	GetAmplitude ()
	Get rumble amplitude. "saturate( Scale * (Base + Bias) )".
proto external void	SetAmplitudeBase (float a)
	Set Amplitude value.
proto external int	GetDurationMS ()
	Get rumble duration.
proto external int	GetLoopTimes ()
	How many times the effect will loop.
proto external bool	IsInfiniteLooping ()
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.

Static Public Member Functions
static proto void	SetRumbleIntensity (float intensity)
static proto void	GetRumbleIntensity (out float intensity)

Detailed Description

Effect used to rumble the gamepad.

Member Function Documentation

GetAmplitude()

proto external float GamepadRumbleEffect.GetAmplitude

(

)

Get rumble amplitude. "saturate( Scale * (Base + Bias) )".

GetDurationMS()

proto external int GamepadRumbleEffect.GetDurationMS

(

)

Get rumble duration.

GetFadeInTimeMS()

proto external int GamepadRumbleEffect.GetFadeInTimeMS

(

)

Get fade-in time.

GetFadeOutTimeMS()

proto external int GamepadRumbleEffect.GetFadeOutTimeMS

(

)

Get fade-out time.

GetLoopTimes()

proto external int GamepadRumbleEffect.GetLoopTimes

(

)

How many times the effect will loop.

GetRumbleIntensity()

static proto void GamepadRumbleEffect.GetRumbleIntensity ( out float intensity )

static

IsInfiniteLooping()

proto external bool GamepadRumbleEffect.IsInfiniteLooping

(

)

SetAmplitudeBase()

proto external void GamepadRumbleEffect.SetAmplitudeBase

(

float

a

)

Set Amplitude value.

SetRumbleIntensity()

static proto void GamepadRumbleEffect.SetRumbleIntensity ( float intensity )

static

---

How much the controller should rumble

---

The documentation for this interface was generated from the following file:

• Game/generated/Gamepad/GamepadRumbleEffect.c