TeamSpecBot: American spelling

2026-10-20T04:44:45Z

American spelling

← Older revision		Revision as of 04:44, 20 October 2026
Line 29:		Line 29:
	=== team_score ===		=== team_score ===

	Every team's value of one team counter, side by side in team order, followed by the goal. Teams 1 and 2 have their own ~~colours~~.		Every team's value of one team counter, side by side in team order, followed by the goal. Teams 1 and 2 have their own colors.

	* <code>counter</code>: the team counter to show.		* <code>counter</code>: the team counter to show.
Line 65:		Line 65:
	=== boss_health ===		=== boss_health ===

	Two bars for a two-team boss mode: the player's own team's boss on the left, the enemy's on the right, each in its team's ~~colour~~, with the share it has left. A boss at 0 shows SLAIN. A player on no team sees team 1 on the left, with the teams' names on the bars.		Two bars for a two-team boss mode: the player's own team's boss on the left, the enemy's on the right, each in its team's color, with the share it has left. A boss at 0 shows SLAIN. A player on no team sees team 1 on the left, with the teams' names on the bars.

	* <code>counter</code>: a team counter holding each team's boss's health, from 0 (dead) to <code>scale</code>, keyed by the team the boss belongs to.		* <code>counter</code>: a team counter holding each team's boss's health, from 0 (dead) to <code>scale</code>, keyed by the team the boss belongs to.

TeamSpecBot: Level Editor: client HUD scripting guide

2026-10-20T03:46:17Z

Level Editor: client HUD scripting guide

New page

<code>client.gd</code> draws your mode. It starts with <code>extends GamemodeClientScript</code> and runs on every player's machine, so it can read and show but never change anything: its <code>api</code>, a [[Level Editor/Scripting/Reference/GamemodeClientApi|GamemodeClientApi]], has no way to write. Its hooks are on [[Level Editor/Scripting/Reference/GamemodeClientScript|GamemodeClientScript]].

== What it can read ==

* The counters the server declared: [[Level Editor/Scripting/Reference/GamemodeClientApi#get_player|api.get_player]], [[Level Editor/Scripting/Reference/GamemodeClientApi#get_team|api.get_team]] and [[Level Editor/Scripting/Reference/GamemodeClientApi#get_global|api.get_global]]. The client script declares nothing; the server's counters arrive by themselves.
* [[Level Editor/Scripting/Reference/GamemodeClientApi#counter_maximum|api.counter_maximum]]: a counter's declared maximum. Read limits from here instead of copying the server's numbers, so the two scripts cannot disagree.
* Who is who: [[Level Editor/Scripting/Reference/GamemodeClientApi#local_player|api.local_player]] (the player at this keyboard, or -1 when there is none yet), [[Level Editor/Scripting/Reference/GamemodeClientApi#team_of|api.team_of]] and [[Level Editor/Scripting/Reference/GamemodeClientApi#players|api.players]].
* The teams: [[Level Editor/Scripting/Reference/GamemodeClientApi#teams|api.teams]], [[Level Editor/Scripting/Reference/GamemodeClientApi#team_name|api.team_name]] and [[Level Editor/Scripting/Reference/GamemodeClientApi#team_maximum|api.team_maximum]].
* [[Level Editor/Scripting/Reference/GamemodeClientApi#match_state|api.match_state]], and the payload tracks' lengths and checkpoints (see [[Level Editor/Scripting/Payload tracks|Payload tracks]]).

== Hooks ==

* <code>_start()</code>: the server's counters have arrived. Put your widgets on screen here.
* <code>_counter_changed(scope, key, name, value)</code>: 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 you only need this hook for something of your own.
* <code>_match_ended(team)</code>: the round is decided. <code>team</code> is the winner, or 0 for a draw.

== Widgets ==

[[Level Editor/Scripting/Reference/GamemodeClientApi#show_widget|api.show_widget]] puts one of TeamSpec's HUD widgets on screen and returns a handle for [[Level Editor/Scripting/Reference/GamemodeClientApi#remove_widget|api.remove_widget]]. You name the widget and hand it a Dictionary of settings; counter names can be written as plain strings. A widget opens showing the current values and keeps itself up to date, so there is nothing to call every frame. A name that is not one of the five below shows nothing.

<pre>
func _start() -> void:
api.show_widget(&"team_score", {
"counter": "score",
"threshold": api.counter_maximum(api.SCOPE_TEAM, &"score"),
})
</pre>

=== team_score ===

Every team's value of one team counter, side by side in team order, followed by the goal. Teams 1 and 2 have their own colours.

* <code>counter</code>: the team counter to show.
* <code>threshold</code>: the winning number, shown after the scores. 0 hides it.
* <code>warn_at</code>: highlight a team's number once it reaches this. 0 means never.

=== carry_pips ===

A row of pips for one player counter, for the player the HUD is following: the local player, or whoever they are spectating.

* <code>counter</code>: the player counter to show.
* <code>maximum</code>: how many pips to draw.
* <code>label</code>: optional text beside the row.

=== round_timer ===

A clock showing minutes and seconds left.

* <code>counter</code>: a global counter holding the seconds left.
* <code>warn_at</code>: at or under this many seconds the clock takes its warning look. 0 means never.
* <code>setup</code>: optional global counter; while it is not 0 the clock shows SETUP.
* <code>overtime</code>: optional global counter; while it is not 0 the clock shows OVERTIME instead of the time.

=== payload_progress ===

A bar the cart marker rides along, with a pip per checkpoint.

* <code>counter</code>: a global counter holding how far the cart has come, from 0 to <code>scale</code>.
* <code>scale</code>: that counter's value at the end of the track.
* <code>checkpoints</code>: an Array of each checkpoint's position along the bar, from 0 to 1. Divide each of [[Level Editor/Scripting/Reference/GamemodeClientApi#track_checkpoints|api.track_checkpoints]] by [[Level Editor/Scripting/Reference/GamemodeClientApi#track_length|api.track_length]].
* <code>pushers</code>: optional global counter, shown while above 0.
* <code>blocked</code>: optional global counter; while it is not 0 the bar shows BLOCKED.
* <code>rollback</code>: optional global counter; while it is not 0 the bar shows ROLLING BACK.

=== boss_health ===

Two bars for a two-team boss mode: the player's own team's boss on the left, the enemy's on the right, each in its team's colour, with the share it has left. A boss at 0 shows SLAIN. A player on no team sees team 1 on the left, with the teams' names on the bars.

* <code>counter</code>: a team counter holding each team's boss's health, from 0 (dead) to <code>scale</code>, keyed by the team the boss belongs to.
* <code>scale</code>: that counter's value for a boss at full health.
* <code>warn_at</code>: a living boss at or under this takes the warning look. 0 means never.
* <code>team_names</code>: a Dictionary of team to name, for a player on no team. Build it from [[Level Editor/Scripting/Reference/GamemodeClientApi#teams|api.teams]] and [[Level Editor/Scripting/Reference/GamemodeClientApi#team_name|api.team_name]].

== Messages ==

A client script cannot send messages: it only knows about the person at its own keyboard. Tell a player something from the server instead, with [[Level Editor/Scripting/Reference/GamemodeServerApi#notify|api.notify]]. See [[Level Editor/Scripting/Server rules#Telling players something|Server rules]].

{{Level Editor nav}}

[[Category:Level Editor]]
[[Category:Gamemode scripting]]

Level Editor/Scripting/Client HUD - Revision history

TeamSpecBot: American spelling

TeamSpecBot: Level Editor: client HUD scripting guide