InputMgr::SetInputMode

Defined in: C4Input.h

Sets the current mode in which the Input Manager processes input events.

Prototype

void SetInputMode(InputMode mode);

Parameters

mode The new input mode.

Description

The SetInputMode function sets the current mode in which the Input Manager processes input events from various types of input devices. The mode parameter can be a combination (through logical OR) of the following constants.

`kInputInactive`	No input is processed by the Input Manager. This flag should be specified by itself to disable the Input Manager.
`kInputMouseActive`	Mouse input is processed by the Input Manager.
`kInputKeyboardActive`	Keyboard input is processed by the Input Manager.
`kInputGameActive`	Joystick and game controller input is processed by the Input Manager.
`kInputAllActive`	All input is processed by the Input Manager. Specifying this flag is equivalent to specifying `kInputMouseActive`, `kInputKeyboardActive`, and `kInputGameActive`.

If the new input mode specifies that events are to be processed by the Input Manager for a particular type of device, then events for that type of device are sent to input actions and are not captured by the Interface Manager.

The default input mode is kInputInactive when the Input Manager is initialized.