> For the complete documentation index, see [llms.txt](https://inkgame.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://inkgame.gitbook.io/docs/exports/gameinput.md).

# gameInput

An export for getting user keyboard input

### Arguments

Object, contains input (string) and key (object)

input - A string containing the pressed key

key - An object containing booleans of non-printable keys pressed state (key.leftArrow, key.rightArrow, key.upArrow, key.downArrow, key.return, key.escape, key.ctrl, key.shift, key.tab, key.backspace, key.delete, key.pageDown, key.pageUp, key.meta)

### Returns

\-