API Reference

The reference is generated from the scripting typings that ship with every server (data/scripts/*.d.ts). The same files drive editor IntelliSense in GRC and VS Code, so what you read here is exactly what the compiler checks against.

Page	Side	Contents
Server globals	server	Everything available to serverside scripts, weapon server halves, classes and serverside NPC code (globals.d.ts).
Serverside NPCs	server	The NPC `this` and its level view for serverside NPC scripts (npc.server.d.ts), on top of the server globals.
Client globals	client	Everything available to clientside weapons (*.client.ts), client classes and clientside NPC code (weapons/globals.client.d.ts).
GUI controls	client	Graal-style GUI controls: windows, buttons, text, images, scroll views and events (weapons/gui.client.d.ts).
Clientside NPCs	client	The NPC `this` for clientside NPC scripts and triggerAction (npc.client.d.ts), on top of the client globals.
Login server (platform)	client	Platform-only: the privileged client API available to Login Server weapons (session, server list, friends, PMs). Game-server scripts cannot use it (loginserver weapons/system.client.d.ts).

All symbols

Symbol	Kind	Side	Page
`camerax`	function	client	Client globals
`cameray`	function	client	Client globals
`ChatPlayer`	interface	client	Client globals
`ChatPlayer`	interface	client	Login server (platform)
`clearAnis`	function	client	Client globals
`clearInterval`	function	client	Client globals
`clearInterval`	function	client	Login server (platform)
`clearInterval`	function	server	Server globals
`clearTimeout`	function	client	Client globals
`clearTimeout`	function	client	Login server (platform)
`clearTimeout`	function	server	Server globals
`client`	global	client	Client globals
`ClientCollection`	interface	client	Client globals
`clientr`	global	client	Client globals
`collection`	function	client	Client globals
`Collection`	interface	server	Server globals
`collection`	function	server	Server globals
`CollectionBag`	interface	server	Server globals
`CollectionEventMap`	interface	client	Client globals
`CollectionQueryRow`	interface	client	Client globals
`CollectionQueryRow`	interface	server	Server globals
`createlevel`	function	server	Server globals
`Database`	interface	server	Server globals
`disabledefmovement`	function	client	Client globals
`echo`	function	client	Client globals
`echo`	function	client	Login server (platform)
`echo`	function	server	Server globals
`enabledefmovement`	function	client	Client globals
`findGuiControl`	function	client	GUI controls
`findimg`	function	client	Client globals
`findobj`	function	client	GUI controls
`findweapon`	function	client	Client globals
`findWeapon`	function	client	Client globals
`findweapon`	function	client	Login server (platform)
`findWeapon`	function	client	Login server (platform)
`findweapon`	function	server	Server globals
`findWeapon`	function	server	Server globals
`Friend`	interface	client	Login server (platform)
`friends`	global	client	Login server (platform)
`GameControl`	global	client	GUI controls
`gettile`	function	client	Client globals
`gmaptolevel`	function	client	Client globals
`gmaptolevel`	function	server	Server globals
`GuiActor`	interface	client	GUI controls
`GuiButtonCtrl`	class	client	GUI controls
`GuiButtonEvent`	interface	client	GUI controls
`GuiControl`	class	client	GUI controls
`GuiEventMap`	interface	client	GUI controls
`GuiGameScreen`	interface	client	GUI controls
`GuiImageCtrl`	class	client	GUI controls
`GuiKeyEvent`	interface	client	GUI controls
`GuiMouseButton`	type	client	GUI controls
`GuiMoveEvent`	interface	client	GUI controls
`GuiPanelCtrl`	class	client	GUI controls
`GuiScrollCtrl`	class	client	GUI controls
`GuiStretchCtrl`	class	client	GUI controls
`GuiTextCtrl`	class	client	GUI controls
`GuiTextEditCtrl`	class	client	GUI controls
`GuiWheelEvent`	interface	client	GUI controls
`GuiWindowCtrl`	class	client	GUI controls
`hideimg`	function	client	Client globals
`keydown`	function	client	Client globals
`keydown`	function	client	Login server (platform)
`level`	global	server	Server globals
`leveltogmap`	function	client	Client globals
`leveltogmap`	function	server	Server globals
`logout`	function	client	Login server (platform)
`measuretext`	function	client	Client globals
`measuretext`	function	client	Login server (platform)
`mousedown`	function	client	Client globals
`mousedown`	function	client	Login server (platform)
`mouseonui`	function	client	Client globals
`mouseonui`	function	client	Login server (platform)
`mousex`	function	client	Client globals
`mousex`	function	client	Login server (platform)
`mousey`	function	client	Client globals
`mousey`	function	client	Login server (platform)
`NpcLevel`	interface	server	Serverside NPCs
`NpcThis`	interface	client	Clientside NPCs
`NpcThis`	interface	server	Serverside NPCs
`onwall`	function	client	Client globals
`opendatabase`	function	server	Server globals
`openPM`	function	client	Login server (platform)
`ParticleEmitter`	interface	client	Client globals
`ParticleModifierHandle`	interface	client	Client globals
`ParticleTemplate`	interface	client	Client globals
`pendingPMs`	function	client	Login server (platform)
`player`	global	client	Client globals
`player`	global	client	Login server (platform)
`Player`	interface	server	Server globals
`PMMessage`	interface	client	Login server (platform)
`PMPending`	interface	client	Login server (platform)
`PMSender`	interface	client	Client globals
`PMSender`	interface	client	Login server (platform)
`Projectile`	interface	server	Server globals
`replaceAni`	function	client	Client globals
`resetambient`	function	client	Client globals
`resetfocus`	function	client	Client globals
`ScreenHeight`	global	client	Client globals
`ScreenHeight`	global	client	Login server (platform)
`ScreenWidth`	global	client	Client globals
`ScreenWidth`	global	client	Login server (platform)
`ScriptImage`	interface	client	Client globals
`ScriptThis`	interface	server	Server globals
`sendPM`	function	client	Login server (platform)
`sendPM`	function	server	Server globals
`server`	global	server	Server globals
`ServerInfo`	interface	client	Login server (platform)
`ServerLevel`	interface	server	Server globals
`serverOptions`	global	server	Server globals
`serverr`	global	client	Client globals
`serverr`	global	server	Server globals
`servers`	global	client	Login server (platform)
`session`	global	client	Login server (platform)
`setambient`	function	client	Client globals
`setAni`	function	client	Client globals
`setfocus`	function	client	Client globals
`setInterval`	function	client	Client globals
`setInterval`	function	client	Login server (platform)
`setInterval`	function	server	Server globals
`setleveltile`	function	server	Server globals
`setTimeout`	function	client	Client globals
`setTimeout`	function	client	Login server (platform)
`setTimeout`	function	server	Server globals
`sleep`	function	client	Client globals
`sleep`	function	client	Login server (platform)
`sleep`	function	server	Server globals
`SqlParam`	type	server	Server globals
`SqlRow`	type	server	Server globals
`TextMeasurement`	interface	client	Client globals
`TextMeasurement`	interface	client	Login server (platform)
`tiletype`	function	client	Client globals
`triggerAction`	function	client	Clientside NPCs
`triggerClient`	function	server	Server globals
`triggerServer`	function	client	Client globals
`triggerServer`	function	client	Login server (platform)
`updatelevel`	function	client	Client globals
`WeaponHandle`	interface	client	Client globals
`WeaponHandle`	interface	client	Login server (platform)
`WeaponHandle`	interface	server	Server globals
`WeaponThis`	interface	client	Client globals
`WeaponThis`	interface	client	Login server (platform)

API Reference ​

All symbols ​

API Reference

All symbols