HPL3/Community/Scripting/Classes/ckeypress

From Frictional Wiki
Jump to navigation Jump to search

cKeyPress

Fields

cKeyPress has no public fields.

Functions

Return Type Function Name Parameters Description
eKey GetKey const Returns an eKey value representing the pressed key.
int GetUnicode const Returns an equivalent [[wp>Unicode]] value of the pressed key.
int GetModifier const Returns the eKeyModifier flags accompanying the pressed key.

Remarks

This class represents a key press associated with an event triggered by the pressing of a key. It will usually be generated either by way of a GUI action via cGuiMessageData, or retrieved manually from an instance of iKeyboard.