TeamSpecBot: American spelling

2026-10-20T04:46:12Z

American spelling

← Older revision		Revision as of 04:46, 20 October 2026
Line 102:		Line 102:
	* <code>attacker</code>: <code>int</code>		* <code>attacker</code>: <code>int</code>
	\|returns=<code>void</code>		\|returns=<code>void</code>
	\|description=A boss took damage, after the server script heard about it. Rebalance the ~~defence~~ here: <code>api.entity_health</code> reads what it has left.		\|description=A boss took damage, after the server script heard about it. Rebalance the defense here: <code>api.entity_health</code> reads what it has left.
	}}		}}

TeamSpecBot: Scripting reference: GamemodeBotScript

2026-10-20T03:48:28Z

Scripting reference: GamemodeBotScript

New page

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

The base class of a map's <code>bot.gd</code>: what the mode tells its bots to do.

This script runs on the server next to <code>server.gd</code> and works through the very same <code>api</code>, so it sees exactly the match the rules are running. Give bots their jobs here and keep the rules in <code>server.gd</code>: a point scored from this file is a rule nobody will find.

A bot is told its job, never its movement. With no orders it hunts whoever is nearest and wanders when there is nobody.

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: GamemodeServerApi
|scripts=<code>bot.gd</code>
|description=Everything this script can do goes through <code>api</code>. See [[Level Editor/Scripting/Reference/GamemodeServerApi|GamemodeServerApi]].

Everything this script can do: the server script's own <code>GamemodeServerApi</code>.
}}

== Hooks ==

=== _start ===
{{API member
|name=_start
|kind=Hook
|signature=_start() -> void
|scripts=<code>bot.gd</code>
|returns=<code>void</code>
|description=The map is live, and the server script's <code>_start</code> has already run. Look up the zones and positions your orders use here, once.
}}

=== _tick ===
{{API member
|name=_tick
|kind=Hook
|signature=_tick(_delta: float) -> void
|scripts=<code>bot.gd</code>
|params=* <code>delta</code>: <code>float</code>
|returns=<code>void</code>
|description=Every server tick, after the rules have run for that tick. Orders do not expire and giving the same order again costs nothing, so decide every bot's job on an interval and give it every time.
}}

=== _player_joined ===
{{API member
|name=_player_joined
|kind=Hook
|signature=_player_joined(_entity_id: int) -> void
|scripts=<code>bot.gd</code>
|params=* <code>entity_id</code>: <code>int</code>
|returns=<code>void</code>
|description=A player joined, after the server script gave them a team. <code>api.is_bot</code> says whether it is a bot; this is the place for <code>api.bot_set_skill</code>.
}}

=== _player_spawned ===
{{API member
|name=_player_spawned
|kind=Hook
|signature=_player_spawned(_entity_id: int) -> void
|scripts=<code>bot.gd</code>
|params=* <code>entity_id</code>: <code>int</code>
|returns=<code>void</code>
|description=A player came back to life after dying. Not called for the first spawn after joining; that is <code>_player_joined</code>.
}}

=== _player_died ===
{{API member
|name=_player_died
|kind=Hook
|signature=_player_died(_entity_id: int, _killer_id: int) -> void
|scripts=<code>bot.gd</code>
|params=* <code>entity_id</code>: <code>int</code>
* <code>killer_id</code>: <code>int</code>
|returns=<code>void</code>
|description=A player died. Drop whatever you were tracking about them. When they respawn is the server script's decision, so there is no respawn time here.
}}

=== _player_left ===
{{API member
|name=_player_left
|kind=Hook
|signature=_player_left(_entity_id: int) -> void
|scripts=<code>bot.gd</code>
|params=* <code>entity_id</code>: <code>int</code>
|returns=<code>void</code>
|description=A player left the match for good. Forget anything you kept about them.
}}

=== _entity_damaged ===
{{API member
|name=_entity_damaged
|kind=Hook
|signature=_entity_damaged(_entity: int, _amount: float, _attacker: int) -> void
|scripts=<code>bot.gd</code>
|params=* <code>entity</code>: <code>int</code>
* <code>amount</code>: <code>float</code>
* <code>attacker</code>: <code>int</code>
|returns=<code>void</code>
|description=A boss took damage, after the server script heard about it. Rebalance the defence here: <code>api.entity_health</code> reads what it has left.
}}

=== _entity_died ===
{{API member
|name=_entity_died
|kind=Hook
|signature=_entity_died(_entity: int, _killer: int) -> void
|scripts=<code>bot.gd</code>
|params=* <code>entity</code>: <code>int</code>
* <code>killer</code>: <code>int</code>
|returns=<code>void</code>
|description=A boss died, after the server script heard about it.
}}

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

{{Level Editor nav}}

Level Editor/Scripting/Reference/GamemodeBotScript - Revision history

TeamSpecBot: American spelling

TeamSpecBot: Scripting reference: GamemodeBotScript