> For the complete documentation index, see [llms.txt](https://guide.cronuszen.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://guide.cronuszen.com/gpcscripting/gpc-script-guide/gpc-developer-guide/functions/keyboard-functions.md).

# Keyboard Functions

| **Function Name** | **Description**                                                             |
| ----------------- | --------------------------------------------------------------------------- |
| get\_keyboard     | Checks if a chosen keyboard key is held down.                               |
| get\_modifiers    | Checks if a chosen keyboard modifier is held down (ALT, SHIFT, CTRL, etc.). |

Keyboard functions for Core Keyboard Functions can be found here: [Core Keyboard Functions](/gpcscripting/gpc-script-guide/gpc-developer-guide/functions/keyboard-functions/core-keyboard-functions.md)

***

### get\_keyboard

get\_keyboard checks to see if a chosen keyboard key is pressed.

Code-Snippet

```
main {
    if(get_keyboard(KEY_A)){
        combo_run(jump);
    }
}

combo jump {
    wait(20);
    set_val(XB1_A, 100);
    wait(20);
}
```

Syntax

get\_keyboard( \<key\_constant> );

Parameters

\<key\_constant> : any defined keyboard constant.

Returns

True if the key is pressed, False if it is not.

***

### get\_modifiers

get\_modifiers checks if a chosen keyboard modifier is held down (ALT, SHIFT, CTRL, etc.).

Code-Snippet

```
main {
    if (get_modifiers(MOD_LCTRL | MOD_LALT) == (MOD_LCTRL | MOD_LALT)) {
        /* Both Left Alt and Left Ctrl are pressed */
    }
}
```

Syntax

get\_modifiers( \<modifier\_mask> );

Parameters

\<modifier\_mask> : a bitmask of keyboard modifiers.

Returns

The current state of the modifiers as a bitmask.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://guide.cronuszen.com/gpcscripting/gpc-script-guide/gpc-developer-guide/functions/keyboard-functions.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
