Unscoped Api

The api is accessible via the global variable GL. Scripts are also encouraged to use the scoped API which automatically handles cleanup. The scoped api is available with the script-specific api variable.

Properties

commands

static commands: Readonly<CommandsApi>

Functions for adding commands to the command palette

hotkeys

static hotkeys: Readonly<HotkeysApi>

Functions to listen for key combinations

lib()

static lib: <T>(name) => Libraries[T]

Gets the exported values of a library

Type Parameters

Type Parameter
`T` extends `string` \| `number`

Parameters

Parameter	Type
`name`	`T`

Returns

Libraries[T]

libs

static libs: Readonly<LibsApi>

Methods for getting info on libraries

net

static net: Readonly<NetApi>

Ways to interact with the current connection to the server, and functions to send general requests

patcher

static patcher: Readonly<PatcherApi>

Functions for intercepting the arguments and return values of functions

plugin()

static plugin: <T>(name) => Plugins[T]

Gets the exported values of a plugin, if it has been enabled

Type Parameters

Type Parameter
`T` extends `string` \| `number`

Parameters

Parameter	Type
`name`	`T`

Returns

Plugins[T]

plugins

static plugins: Readonly<PluginsApi>

Methods for getting info on plugins

rewriter

static rewriter: Readonly<RewriterApi>

Functions to edit Gimkit’s code

storage

static storage: Readonly<StorageApi>

Functions for persisting data between reloads

svelte_5_43_0

static svelte_5_43_0: Svelte

The exports of svelte v5.43.0, used internally by Gimloader and exposed to make scripts smaller. Should never be used by hand.

UI

static UI: Readonly<UIApi>

Functions for interacting with the DOM

Accessors

React

Get Signature

get static React(): typeof React

Gimkit’s internal react instance

Returns

typeof React

ReactDOM

Get Signature

get static ReactDOM(): __module

Gimkit’s internal reactDom instance

Returns

__module

stores

Get Signature

get static stores(): Stores

A variety of Gimkit internal objects available in 2d gamemodes

Returns

Stores