GamepadEffect Interface Reference

Inheritance diagram for GamepadEffect:

Public Member Functions
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

ApplyImmediate()

proto external void GamepadEffect.ApplyImmediate

(

)

Apply this effect immediately. Normally it would be applied at next update of GamepadIOHandlerComponent.

GetContext()

proto external owned string GamepadEffect.GetContext

(

)

Name of GamepadEffectContext on which this GamepadEffect depends on.

Empty string means no context depended-upon. The context's IsEnabled() is ANDed with this GamepadEffect's IsEnabled().

GetEffectName()

proto external owned string GamepadEffect.GetEffectName

(

)

GetOwner()

proto external IEntity GamepadEffect.GetOwner

(

)

GetPriority()

proto external int GamepadEffect.GetPriority

(

)

GamepadEffect with higher priority is preferred.

IsEnabled()

proto external bool GamepadEffect.IsEnabled

(

)

SetEnabled()

proto external void GamepadEffect.SetEnabled	(	bool	val,
		float	autoDisableTimeout = 0.0,
		bool	immediate = true
	)

Disabled GamepadEffects are ignored.

---

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

• Game/generated/Gamepad/GamepadEffect.c