InputMgr::GetEscapeCookie

Defined in: C4Input.h

Returns the cookie passed to the escape callback function.

Prototype

void *GetEscapeCookie(void) const;

Description

The GetEscapeCookie function returns the pointer that was previously passed to the cookie parameter of the InputMgr::SetEscapeCallback function.

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