InputMgr::GetConsoleCookie

Defined in: C4Input.h

Returns the cookie passed to the console callback function.

Prototype

void *GetConsoleCookie(void) const;

Description

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

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