InputManager Interface Reference

Input management system for user interactions. More...

Inheritance diagram for InputManager:

Public Member Functions
proto external float	GetLastTimeDelta ()
	Returns time delta used to update InputManager in last frame.
proto external void	SetLoading (bool isLoading)
	Tells input manager, that is loading. IM than show hide cursor even without per frame updating.
proto external EInputDeviceType	GetLastUsedInputDevice ()
	Returns last dominant input device used by user.
proto external bool	SetLastUsedInputDevice (EInputDeviceType type)
proto external KeyboardDeviceHandler	GetKeyboardDeviceHandler ()
proto external MouseDeviceHandler	GetMouseDeviceHandler ()
proto external GamepadDeviceHandler	GetGamepadDeviceHandler ()
proto external JoystickDeviceHandler	GetJoystickDeviceHandler ()
proto external GyroDeviceHandler	GetGyroDeviceHandler ()
proto external TrackIRDeviceHandler	GetTrackIRDeviceHandler ()
proto external bool	IsUsingMouseAndKeyboard ()
	Returns true when mouse/keyboard is preferred input method.
proto external void	SetCursorPosition (int x, int y)
	Sets system cursor position.
proto external bool	IsTrackIRConnected ()
proto external bool	IsJoystickConnected (int iSlotIndex)
proto external int	GetJoystickVendorId (int iSlotIndex)
proto external int	GetJoystickProductId (int iSlotIndex)
proto external string	GetJoystickProductName (int iSlotIndex)
proto external void	SetGamepadRumble (int userIdx, float fLeftMotorSpeed, float fRightMotorSpeed, float fLeftTriggerSpeed, float fRightTriggerSpeed, int iDurationMs=-1, int iFadeInMs=0, int iFadeOutMs=0)
proto external void	StopRumble (int userIdx=-1)
proto external void	SetGamepadTriggerEffect (int userIdx, GamepadTrigger eTriggerIndex, GamepadTriggerEffect eEffectType, int frequency, notnull array< int > curve)
	Set gamepad trigger effect Set gamepad trigger effect.
proto external void	SetGamepadLightColor (int userIdx, notnull Color color)
	Set gamepad light color.
proto external void	ResetAction (string actionName)
	Resets internal state of action.
proto external void	ResetContext (string contextName)
	Resets internal state of all actions in context.
proto external bool	RegisterActionManager (ActionManager pManager)
proto external bool	UnregisterActionManager (ActionManager pManager)
proto external ref InputBinding	CreateUserBinding ()
proto external BaseContainer	GetKeyUIMapping (string keyName)
proto external bool	GetActionKeybinding (string actionName, notnull array< string > keyStack, notnull array< BaseContainer > filterStack, EInputDeviceType deviceType=EInputDeviceType.INVALID, string preset=string.Empty, int keyBindIndex=-1)
Public Member Functions inherited from ActionManager
proto external void	SetDebug (int debugMode)
	Show debug info via DbgUI.
proto external bool	ActivateContext (string contextName, int duration=0)
proto external bool	IsContextActive (string contextName)
proto external void	SetContextDebug (string contextName, bool bDebug)
proto external bool	ActivateAction (string actionName, int duration=0)
proto external bool	IsActionActive (string actionName)
proto external float	GetActionValue (string actionName)
	Return normalized value of action.
proto external EActionValueType	GetActionInputType (string actionName)
	Return type of last input contributing to this action.
proto external bool	GetActionTriggered (string actionName)
	Return TRUE if value of action is above threshold(0.99) and is active.
proto external void	SetActionValue (string actionName, float value)
proto external int	GetActionCount ()
proto external string	GetActionName (int actionIndex)
proto external void	AddActionListener (string actionName, EActionTrigger trigger, ActionListenerCallback callback)
proto external bool	RemoveActionListener (string actionName, EActionTrigger trigger, ActionListenerCallback callback)

Detailed Description

Input management system for user interactions.

The InputManager handles all user input devices, including keyboard, mouse, gamepad, joystick, and TrackIR. It tracks the dominant input device, manages input bindings, system cursor, and device-specific interactions. This class is intended to be used as a singleton and extends the ActionManager interface.

Member Function Documentation

CreateUserBinding()

proto external ref InputBinding InputManager.CreateUserBinding

(

)

GetActionKeybinding()

proto external bool InputManager.GetActionKeybinding	(	string	actionName,
		notnull array< string >	keyStack,
		notnull array< BaseContainer >	filterStack,
		EInputDeviceType	deviceType = EInputDeviceType.INVALID,
		string	preset = string.Empty,
		int	keyBindIndex = -1 )

GetGamepadDeviceHandler()

proto external GamepadDeviceHandler InputManager.GetGamepadDeviceHandler

(

)

GetGyroDeviceHandler()

proto external GyroDeviceHandler InputManager.GetGyroDeviceHandler

(

)

GetJoystickDeviceHandler()

proto external JoystickDeviceHandler InputManager.GetJoystickDeviceHandler

(

)

GetJoystickProductId()

proto external int InputManager.GetJoystickProductId

(

int

iSlotIndex

)

GetJoystickProductName()

proto external string InputManager.GetJoystickProductName

(

int

iSlotIndex

)

GetJoystickVendorId()

proto external int InputManager.GetJoystickVendorId

(

int

iSlotIndex

)

GetKeyboardDeviceHandler()

proto external KeyboardDeviceHandler InputManager.GetKeyboardDeviceHandler

(

)

GetKeyUIMapping()

proto external BaseContainer InputManager.GetKeyUIMapping

(

string

keyName

)

GetLastTimeDelta()

proto external float InputManager.GetLastTimeDelta

(

)

Returns time delta used to update InputManager in last frame.

GetLastUsedInputDevice()

proto external EInputDeviceType InputManager.GetLastUsedInputDevice

(

)

Returns last dominant input device used by user.

EInputDeviceType.MOUSE for standard mouse & keyboard combination EInputDeviceType.KEYBOARD for keyboard only (activated when using keyboard navigation in UI) EInputDeviceType.* for other devices

GetMouseDeviceHandler()

proto external MouseDeviceHandler InputManager.GetMouseDeviceHandler

(

)

GetTrackIRDeviceHandler()

proto external TrackIRDeviceHandler InputManager.GetTrackIRDeviceHandler

(

)

IsJoystickConnected()

proto external bool InputManager.IsJoystickConnected

(

int

iSlotIndex

)

IsTrackIRConnected()

proto external bool InputManager.IsTrackIRConnected

(

)

IsUsingMouseAndKeyboard()

proto external bool InputManager.IsUsingMouseAndKeyboard

(

)

Returns true when mouse/keyboard is preferred input method.

RegisterActionManager()

proto external bool InputManager.RegisterActionManager

(

ActionManager

pManager

)

ResetAction()

proto external void InputManager.ResetAction

(

string

actionName

)

Resets internal state of action.

ResetContext()

proto external void InputManager.ResetContext

(

string

contextName

)

Resets internal state of all actions in context.

SetCursorPosition()

proto external void InputManager.SetCursorPosition	(	int	x,
		int	y )

Sets system cursor position.

SetGamepadLightColor()

proto external void InputManager.SetGamepadLightColor	(	int	userIdx,
		notnull Color	color )

Set gamepad light color.

SetGamepadRumble()

proto external void InputManager.SetGamepadRumble	(	int	userIdx,
		float	fLeftMotorSpeed,
		float	fRightMotorSpeed,
		float	fLeftTriggerSpeed,
		float	fRightTriggerSpeed,
		int	iDurationMs = -1,
		int	iFadeInMs = 0,
		int	iFadeOutMs = 0 )

SetGamepadTriggerEffect()

proto external void InputManager.SetGamepadTriggerEffect	(	int	userIdx,
		GamepadTrigger	eTriggerIndex,
		GamepadTriggerEffect	eEffectType,
		int	frequency,
		notnull array< int >	curve )

Set gamepad trigger effect Set gamepad trigger effect.

Functionality can vary across platforms.

Parameters

userIdx	user index
eTriggerIndex	can be left or right trigger
eEffectType	can be rumble or force-feedback
frequency	used just with rumble effect
curve	parameter curve, array of 10 integer values. Range is (0, 8) where 0 is minimum, 8 maximum force of effect.

SetLastUsedInputDevice()

proto external bool InputManager.SetLastUsedInputDevice

(

EInputDeviceType

type

)

SetLoading()

proto external void InputManager.SetLoading

(

bool

isLoading

)

Tells input manager, that is loading. IM than show hide cursor even without per frame updating.

StopRumble()

proto external void InputManager.StopRumble

(

int

userIdx = -1

)

UnregisterActionManager()

proto external bool InputManager.UnregisterActionManager

(

ActionManager

pManager

)

---

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

• GameLib/generated/Input/InputManager.c