Cavestory Mod API
Functions
ExtendedInput

Extended input management. More...

Functions

CAVESTORY_MOD_API void CSM_ExtendedInput_SetKeyState (CSM_SDL_Scancode iScanCode, BOOL bPressed)
 Set whether a key is being pressed or not. More...
 
CAVESTORY_MOD_API BOOL CSM_ExtendedInput_GetKey (CSM_SDL_Scancode iScanCode)
 Check to see if a key is being held down. More...
 
CAVESTORY_MOD_API BOOL CSM_ExtendedInput_GetKeyDown (CSM_SDL_Scancode iScanCode)
 Check to see if a key was depressed on this frame. More...
 
CAVESTORY_MOD_API BOOL CSM_ExtendedInput_GetKeyUp (CSM_SDL_Scancode iScanCode)
 Check to see if a key was released on this frame. More...
 
CAVESTORY_MOD_API BOOL CSM_ExtendedInput_GetKeyRepeated (CSM_SDL_Scancode iScanCode)
 Check to see if a key was repeated on this frame. More...
 
CAVESTORY_MOD_API void CSM_ExtendedInput_ProcessFrame ()
 Process an input frame.
 
CAVESTORY_MOD_API void CSM_ExtendedInput_ProcessShortcuts ()
 Process all registered keyshortcuts.
 

Detailed Description

Extended input management.

Functions for extended input management.

Function Documentation

◆ CSM_ExtendedInput_GetKey()

CAVESTORY_MOD_API BOOL CSM_ExtendedInput_GetKey ( CSM_SDL_Scancode  iScanCode)

Check to see if a key is being held down.

Parameters
iScanCodeThe keycode to check.
Returns
Returns true if the specified key is being held down, false otherwise.
See also
CSM_SDL_Scancode

◆ CSM_ExtendedInput_GetKeyDown()

CAVESTORY_MOD_API BOOL CSM_ExtendedInput_GetKeyDown ( CSM_SDL_Scancode  iScanCode)

Check to see if a key was depressed on this frame.

Parameters
iScanCodeThe keycode to check.
Returns
Returns true if the specified key was depressed on this frame, false otherwise.
See also
CSM_SDL_Scancode

◆ CSM_ExtendedInput_GetKeyRepeated()

CAVESTORY_MOD_API BOOL CSM_ExtendedInput_GetKeyRepeated ( CSM_SDL_Scancode  iScanCode)

Check to see if a key was repeated on this frame.

Parameters
iScanCodeThe keycode to check.
Returns
Returns true if the specified key was repeated on this frame, false otherwise.
See also
CSM_SDL_Scancode

◆ CSM_ExtendedInput_GetKeyUp()

CAVESTORY_MOD_API BOOL CSM_ExtendedInput_GetKeyUp ( CSM_SDL_Scancode  iScanCode)

Check to see if a key was released on this frame.

Parameters
iScanCodeThe keycode to check.
Returns
Returns true if the specified key was released on this frame, false otherwise.
See also
CSM_SDL_Scancode

◆ CSM_ExtendedInput_SetKeyState()

CAVESTORY_MOD_API void CSM_ExtendedInput_SetKeyState ( CSM_SDL_Scancode  iScanCode,
BOOL  bPressed 
)

Set whether a key is being pressed or not.

Parameters
iScanCodeThe keycode to set.
bPressedWhether the key is being pressed or not.
See also
CSM_SDL_Scancode