Effect used to rumble the gamepad. More...

Inheritance diagram for GamepadRumbleEffect:

Public Member Functions
proto external ERumbleImpact	GetImpact ()
	Get impact type.

proto external ERumbleInterval	GetInterval ()
	Get rumble interval type.

proto external int	GetLoopTimes ()
	How many times the effect will loop.

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 float	GetImpactValue (ERumbleImpact eImpact)
	Map ERumbleImpact to range [0.0, 1.0].

static proto int	GetIntervalMS (ERumbleInterval eInterval)
	Map ERumbleInterval to Milliseconds.

Detailed Description

Effect used to rumble the gamepad.

Member Function Documentation

proto external ERumbleImpact GamepadRumbleEffect.GetImpact ( )

Get impact type.

static proto float GamepadRumbleEffect.GetImpactValue ( ERumbleImpact eImpact )

static

Map ERumbleImpact to range [0.0, 1.0].

proto external ERumbleInterval GamepadRumbleEffect.GetInterval ( )

Get rumble interval type.

static proto int GamepadRumbleEffect.GetIntervalMS ( ERumbleInterval eInterval )

static

Map ERumbleInterval to Milliseconds.

proto external int GamepadRumbleEffect.GetLoopTimes ( )

How many times the effect will loop.

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