InputMgr::GetEscapeCallback

Defined in: C4Input.h

Returns the callback function that is invoked when the escape key is pressed.

Prototype

InputMgr::KeyCallback *GetEscapeCallback(void) const;

Description

The GetEscapeCallback function returns a pointer to the callback function that is called whenever the escape key is pressed and the keyboard is in game input mode. By default, there is no escape callback function installed.

The KeyCallback type is defined as follows.

typedef void KeyCallback(void *);

The GetEscapeCallback function is normally used to save the current escape callback function before it is changed or set to nullptr with the InputMgr::SetEscapeCallback function. In this case, the InputMgr::GetEscapeCookie function should also be called to save the current cookie value expected by the escape callback function. These two values can be passed to the SetEscapeCallback at a later time to restore the previously installed callback function.