> For the complete documentation index, see [llms.txt](https://fecality-api.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://fecality-api.gitbook.io/docs/documentation/namespaces/input.md).

# Input

input namespace

### Functions <a href="#functions" id="functions"></a>

#### is\_key\_down <a href="#is_key_down" id="is_key_down"></a>

local state = input.is\_key\_down(0x1)

| ​[Parameter](https://jewls.gitbook.io/fatality-api/documentation/namespaces/input)​ | ​[Datatype](https://jewls.gitbook.io/fatality-api/documentation/namespaces/input)​ | ​[Description](https://jewls.gitbook.io/fatality-api/documentation/namespaces/input)​                |
| ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| key\_code                                                                           | number                                                                             | key's [virtual key code](https://docs.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes)​ |

**Returns:**

| ​[Value](https://jewls.gitbook.io/fatality-api/documentation/namespaces/input)​ | ​[Datatype](https://jewls.gitbook.io/fatality-api/documentation/namespaces/input)​ |
| ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| key's state                                                                     | boolean                                                                            |

#### get\_cursor\_pos <a href="#get_cursor_pos" id="get_cursor_pos"></a>

local x, y = input.get\_cursor\_pos()

**Returns:**

| ​[Value](https://jewls.gitbook.io/fatality-api/documentation/namespaces/input)​ | ​[Datatype](https://jewls.gitbook.io/fatality-api/documentation/namespaces/input)​ |
| ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| mouse cursor x position                                                         | number                                                                             |
| mouse cursor y position                                                         | number                                                                             |