> For the complete documentation index, see [llms.txt](https://gimhook.coder-gage.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gimhook.coder-gage.dev/creating-mods/api.md).

# API

All APIs mentioned below are in the global scope.

If you need to use React, it's included in the global scope - You can just use the `React` variable anywhere.

**NOTE**: The Gimhook SDK currently isn't able to replace React imports in mods with a wrapper for the global variable. Please don't import it.

### gimhook.getHooks

Module: `core`\
Type: `Function`\
Input type: `string` (name)\
Output type: `string[]`

`gimhook.getHooks` is used to get all of the hook callbacks, given a hook name.

### gimhook.addHook

Module: `core`\
Type: `Function`\
Input type: `string` (name), `Function` (callback)\
Output type: N/A

`gimhook.addHook` is used to add a callback function to a hook, which is called whenever the hook is triggered.

See the documentation page on hooks for more information.

### gimhook.onJoin

Module: `core`\
Type: `Function`\
Input type: `Function` (callback)\
Output type: N/A

`gimhook.onJoin(handler)` is a synonym for `gimhook.addHook("join", handler)`.

### gimhook.game.isGameActive

Module: `game`\
Type: `boolean`\
Input type: N/A\
Output type: N/A

`gimhook.game.isGameActive` is used to determine when a game is currently active.

### gimhook.game.is2DGamemode

Module: `game`\
Type: `boolean`\
Input type: N/A\
Output type: N/A

`gimhook.game.is2DGamemode` is used to determine if the active gamemode (if any) is a 2D gamemode.

### gimhook.graphics.player.getPlayer

Module: `core`\
Type: `Function`\
Input type: N/A\
Output type: Player (I don't know the TypeScript type for it)

`gimhook.graphics.player.getPlayer` is used to get the currently active player.

### gimhook.graphics.player.getPosition

Module: `core`\
Type: `Function`\
Input type: N/A\
Output type: Position (I don't know the TypeScript type for it)

`gimhook.graphics.player.getPosition` is used to get the position of the currently active player.

### gimhook.graphics.player.setPosition

Module: `core`\
Type: `Function`\
Input type: `number` (x), `number` (y)\
Output type: N/A

`gimhook.graphics.player.setPosition` is used to set the position of the currently active player.

NOTE: No, you can't use this to teleport around the map and cheat. It is useless unless you're in the creative map editor.

### gimhook.graphics.camera.getCamera

Module: `core`\
Type: `Function`\
Input type: N/A\
Output type: Camera (I don't know the TypeScript type for it)

`gimhook.graphics.camera.getCamera` is used to get the currently active camera.

### gimhook.graphics.camera.getZoom

Module: `core`\
Type: `Function`\
Input type: N/A\
Output type: `number`

`gimhook.graphics.camera.getZoom` is used to get the zoom value of the currently active camera.

### gimhook.graphics.camera.setZoom

Module: `core`\
Type: `Function`\
Input type: `number` (zoom)\
Output type: N/A

`gimhook.graphics.camera.setZoom` is used to set the zoom value of the currently active camera.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://gimhook.coder-gage.dev/creating-mods/api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.