TeamSpecBot: Scripting reference: GamemodeClientScript

2026-10-20T03:48:30Z

Scripting reference: GamemodeClientScript

New page

The base class of <code>client.gd</code>: the script starts with <code>extends GamemodeClientScript</code>.

The base class of a map's <code>client.gd</code>: what its gamemode shows.

This script runs on every player's machine. It can read the counters the server keeps and put HUD widgets on screen, and it cannot change anything about the match. Everything it can do goes through <code>api</code>.

It declares nothing: the server's counters and teams arrive by themselves.

See [[Level Editor/Scripting/Reference]] for every class, and [[Level Editor/Scripting/Reference/Sandbox]] for the rest of GDScript a script may use.

__TOC__

== Properties ==

=== api ===
{{API member
|name=api
|kind=Property
|signature=api: GamemodeClientApi
|scripts=<code>client.gd</code>
|description=Everything this script can do goes through <code>api</code>. See [[Level Editor/Scripting/Reference/GamemodeClientApi|GamemodeClientApi]].

Everything this script can do, as a <code>GamemodeClientApi</code>.
}}

== Hooks ==

=== _start ===
{{API member
|name=_start
|kind=Hook
|signature=_start() -> void
|scripts=<code>client.gd</code>
|returns=<code>void</code>
|description=The server's counters and teams have arrived and can be read. Put your HUD widgets on screen here.
}}

=== _counter_changed ===
{{API member
|name=_counter_changed
|kind=Hook
|signature=_counter_changed(_scope: int, _key: int, _name: StringName, _value: int) -> void
|scripts=<code>client.gd</code>
|params=* <code>scope</code>: <code>int</code>
* <code>key</code>: <code>int</code>
* <code>name</code>: <code>StringName</code>
* <code>value</code>: <code>int</code>
|returns=<code>void</code>
|description=A counter changed. <code>scope</code> is <code>api.SCOPE_PLAYER</code>, <code>api.SCOPE_TEAM</code> or <code>api.SCOPE_GLOBAL</code>; <code>key</code> is the player's entity id, the team, or 0 for a global counter. Widgets update by themselves, so this is only needed for something of your own.
}}

=== _match_ended ===
{{API member
|name=_match_ended
|kind=Hook
|signature=_match_ended(_team: int) -> void
|scripts=<code>client.gd</code>
|params=* <code>team</code>: <code>int</code>
|returns=<code>void</code>
|description=The round is decided. <code>team</code> is the winner, or 0 for a draw.
}}

[[Category:Gamemode scripting]]
[[Category:Scripting reference]]

{{Level Editor nav}}

Level Editor/Scripting/Reference/GamemodeClientScript - Revision history

TeamSpecBot: Scripting reference: GamemodeClientScript