HPL3/Amnesia: Rebirth/Scripting/iKeyboard

Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!

Fields

iKeyboard has no public fields.

Functions

Return Type	Function And Description
cKeyPress	GetKey()
int	GetModifier()
cKeyPress	GetReleasedKey()
bool	KeyIsDown(eKey aKey)
bool	KeyIsPressed()
bool	KeyIsReleased()
tString	KeyToString(eKey )
tString	KeyToSymbol(eKey )
tString	ModifierKeyToString(eKeyModifier )
eKey	StringToKey(const tString &in )

Details

GetKey

cKeyPress GetKey()

Returns:

• cKeyPress—

GetModifier

int GetModifier()

Returns:

• int—

GetReleasedKey

cKeyPress GetReleasedKey()

Returns:

• cKeyPress—

KeyIsDown

bool KeyIsDown(eKey aKey)

Parameters

• aKey (eKey) —

Returns:

• bool—

KeyIsPressed

bool KeyIsPressed()

Returns:

• bool—

KeyIsReleased

bool KeyIsReleased()

Returns:

• bool—

KeyToString

tString KeyToString(eKey )

Parameters

• ' (eKey) —

Returns:

• tString—

KeyToSymbol

tString KeyToSymbol(eKey )

Parameters

• ' (eKey) —

Returns:

• tString—

ModifierKeyToString

tString ModifierKeyToString(eKeyModifier )

Parameters

• ' (eKeyModifier) —

Returns:

• tString—

StringToKey

eKey StringToKey(const tString &in )

Parameters

• ' (tString) —

Returns:

• eKey—

References

• HPL3/Amnesia: Rebirth/Scripting/Scripting Api ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/Scripting Api/cInput ‎ (← links)

See all references...