TeamSpecBot: American spelling

2026-10-20T04:44:46Z

American spelling

← Older revision		Revision as of 04:44, 20 October 2026
Line 38:		Line 38:
	* [[Level Editor/Scripting/Reference/GamemodeServerApi#markers\|api.markers()]]: every marker's name, in map order.		* [[Level Editor/Scripting/Reference/GamemodeServerApi#markers\|api.markers()]]: every marker's name, in map order.
	* [[Level Editor/Scripting/Reference/GamemodeServerApi#marker\|api.marker(name)]]: where it stands (the origin, and a line in the log, for a name the map does not place).		* [[Level Editor/Scripting/Reference/GamemodeServerApi#marker\|api.marker(name)]]: where it stands (the origin, and a line in the log, for a name the map does not place).
	* [[Level Editor/Scripting/Reference/GamemodeServerApi#marker_facing\|api.marker_facing(name)]]: the way it faces, level and one ~~metre~~ long. A point it looks at is <code>api.marker(n) + api.marker_facing(n) * distance</code>.		* [[Level Editor/Scripting/Reference/GamemodeServerApi#marker_facing\|api.marker_facing(name)]]: the way it faces, level and one meter long. A point it looks at is <code>api.marker(n) + api.marker_facing(n) * distance</code>.

	== Switchable parts ==		== Switchable parts ==
Line 61:		Line 61:
	== The map's own bots ==		== The map's own bots ==
	Bots that belong to the map are fixtures such as training dummies, not stand-ins for players: nobody can kick them, and they take no player's seat.		Bots that belong to the map are fixtures such as training dummies, not stand-ins for players: nobody can kick them, and they take no player's seat.
	* [[Level Editor/Scripting/Reference/GamemodeServerApi#spawn_bot\|api.spawn_bot]] spawns one with a name, loadout and team; [[Level Editor/Scripting/Reference/GamemodeServerApi#map_bots\|api.map_bots()]] and [[Level Editor/Scripting/Reference/GamemodeServerApi#is_map_bot\|api.is_map_bot]] list and ~~recognise~~ them.		* [[Level Editor/Scripting/Reference/GamemodeServerApi#spawn_bot\|api.spawn_bot]] spawns one with a name, loadout and team; [[Level Editor/Scripting/Reference/GamemodeServerApi#map_bots\|api.map_bots()]] and [[Level Editor/Scripting/Reference/GamemodeServerApi#is_map_bot\|api.is_map_bot]] list and recognize them.
	* Training orders: [[Level Editor/Scripting/Reference/GamemodeServerApi#bot_idle\|api.bot_idle]] (stand still, never shoot), [[Level Editor/Scripting/Reference/GamemodeServerApi#bot_dodge\|api.bot_dodge]] (a moving target), [[Level Editor/Scripting/Reference/GamemodeServerApi#bot_shoot\|api.bot_shoot]] (fire at one player only).		* Training orders: [[Level Editor/Scripting/Reference/GamemodeServerApi#bot_idle\|api.bot_idle]] (stand still, never shoot), [[Level Editor/Scripting/Reference/GamemodeServerApi#bot_dodge\|api.bot_dodge]] (a moving target), [[Level Editor/Scripting/Reference/GamemodeServerApi#bot_shoot\|api.bot_shoot]] (fire at one player only).
	* [[Level Editor/Scripting/Reference/GamemodeServerApi#bot_build\|api.bot_build]], [[Level Editor/Scripting/Reference/GamemodeServerApi#bot_demolish\|bot_demolish]] and [[Level Editor/Scripting/Reference/GamemodeServerApi#bot_has_building\|bot_has_building]]: buildings for a map bot that holds a building tool.		* [[Level Editor/Scripting/Reference/GamemodeServerApi#bot_build\|api.bot_build]], [[Level Editor/Scripting/Reference/GamemodeServerApi#bot_demolish\|bot_demolish]] and [[Level Editor/Scripting/Reference/GamemodeServerApi#bot_has_building\|bot_has_building]]: buildings for a map bot that holds a building tool.

TeamSpecBot: Level Editor: map entities in gamemode scripts

2026-10-20T03:46:19Z

Level Editor: map entities in gamemode scripts

New page

Besides zones, pickups and payload tracks, a server script can read and drive the other things a map places: doors, logic entities, map markers, switchable parts and bosses. It can also put up buildings and spawn bots of the map's own. Each of these is found by the '''name''' you give it in the editor. Everything here is on the server's [[Level Editor/Scripting/Reference/GamemodeServerApi|GamemodeServerApi]].

== Doors ==
A [[Level Editor/Entities/Door|door]] is named by its name in the scene tree.
* [[Level Editor/Scripting/Reference/GamemodeServerApi#doors|api.doors()]]: every door's name.
* [[Level Editor/Scripting/Reference/GamemodeServerApi#door_open|api.door_open(name)]], [[Level Editor/Scripting/Reference/GamemodeServerApi#door_close|api.door_close(name)]], [[Level Editor/Scripting/Reference/GamemodeServerApi#door_toggle|api.door_toggle(name)]]: move it. A locked door refuses to open.
* [[Level Editor/Scripting/Reference/GamemodeServerApi#door_lock|api.door_lock(name)]] and [[Level Editor/Scripting/Reference/GamemodeServerApi#door_unlock|api.door_unlock(name)]].
* [[Level Editor/Scripting/Reference/GamemodeServerApi#door_state|api.door_state(name)]]: <code>api.DOOR_CLOSED</code>, <code>api.DOOR_OPENING</code>, <code>api.DOOR_OPEN</code> or <code>api.DOOR_CLOSING</code>; [[Level Editor/Scripting/Reference/GamemodeServerApi#door_locked|api.door_locked(name)]].
* <code>_door_changed(door, state)</code>: called whenever a door changes state, however it was moved (a player walking up, its wait running out, an output, or your script).

A setup time that keeps the attackers' gate shut for the first 60 seconds:
<pre>
const SETUP_SECONDS := 60.0

var _clock: float = 0.0

func _start() -> void:
api.door_lock(&"Gate")

func _tick(delta: float) -> void:
_clock += delta
if _clock >= SETUP_SECONDS and api.door_locked(&"Gate"):
api.door_unlock(&"Gate")
api.door_open(&"Gate")
</pre>

== Outputs and logic ==
* [[Level Editor/Scripting/Reference/GamemodeServerApi#fire_input|api.fire_input(target, input, parameter, delay)]]: send an input to every entity named <code>target</code>, as an output would. <code>parameter</code> is text (<code>"5"</code>); <code>delay</code> is in seconds. False, with a line in the log, for a name the map does not have.
* [[Level Editor/Scripting/Reference/GamemodeServerApi#counter_value|api.counter_value(name)]]: a Logic Counter's value.
* <code>_logic_event(entity, event, activator)</code>: a relay, timer, counter or button raised an event (<code>"OnTrigger"</code>, <code>"OnTimer"</code>, <code>"OutValue"</code>, <code>"OnHitMin"</code>, <code>"OnHitMax"</code>, <code>"OnPressed"</code> or <code>"OnUseLocked"</code>). <code>activator</code> is the player who set it off, 0 for nobody. Its outputs fire either way; this is where a mode reacts to a button press or a counter filling up.

See [[Level Editor/Workflows/Outputs and logic|Outputs and logic]].

== Map markers ==
A [[Level Editor/Entities/Map Marker|Map Marker]] is a named spot and facing.
* [[Level Editor/Scripting/Reference/GamemodeServerApi#markers|api.markers()]]: every marker's name, in map order.
* [[Level Editor/Scripting/Reference/GamemodeServerApi#marker|api.marker(name)]]: where it stands (the origin, and a line in the log, for a name the map does not place).
* [[Level Editor/Scripting/Reference/GamemodeServerApi#marker_facing|api.marker_facing(name)]]: the way it faces, level and one metre long. A point it looks at is <code>api.marker(n) + api.marker_facing(n) * distance</code>.

== Switchable parts ==
A [[Level Editor/Entities/Group|group]] with '''Switchable''' ticked is a part: everything in it comes and goes together.
* [[Level Editor/Scripting/Reference/GamemodeServerApi#parts|api.parts()]]: every part's name.
* [[Level Editor/Scripting/Reference/GamemodeServerApi#set_part_enabled|api.set_part_enabled(name, enabled)]]: put the part in the world, or take it out: it is seen and it blocks, or it is neither, for every player, including those who join later.
* [[Level Editor/Scripting/Reference/GamemodeServerApi#part_enabled|api.part_enabled(name)]]: whether it is there now.

== Bosses ==
A [[Level Editor/Entities/Boss Spawn|Boss Spawn]] places a boss. Bosses stand whether or not the mode mentions them.
* [[Level Editor/Scripting/Reference/GamemodeServerApi#bosses|api.bosses()]]: every boss's entity id, in map order.
* [[Level Editor/Scripting/Reference/GamemodeServerApi#entity_name|api.entity_name]], [[Level Editor/Scripting/Reference/GamemodeServerApi#entity_team|entity_team]], [[Level Editor/Scripting/Reference/GamemodeServerApi#entity_health|entity_health]], [[Level Editor/Scripting/Reference/GamemodeServerApi#entity_max_health|entity_max_health]], [[Level Editor/Scripting/Reference/GamemodeServerApi#entity_alive|entity_alive]], [[Level Editor/Scripting/Reference/GamemodeServerApi#entity_position|entity_position]] and [[Level Editor/Scripting/Reference/GamemodeServerApi#entity_zone|entity_zone]] (its arena zone) read one.
* <code>_entity_damaged(entity, amount, attacker)</code> and <code>_entity_died(entity, killer)</code> report what happens to them. What a dead boss means for the match (killing the enemy's boss wins, say) is the mode's to decide.
* [[Level Editor/Scripting/Reference/GamemodeServerApi#revive_boss|api.revive_boss]] brings a dead boss back, for a practice boss.
* On the HUD, the <code>boss_health</code> widget shows both teams' bosses; see [[Level Editor/Scripting/Client HUD#boss_health|Client HUD]].

== Buildings ==
* [[Level Editor/Scripting/Reference/GamemodeServerApi#place_building|api.place_building]]: put up a building of the map's own (a sentry, dispenser or teleporter end), already built, at a level from 1 to 3, for a team, under a key you choose.
* [[Level Editor/Scripting/Reference/GamemodeServerApi#remove_building|api.remove_building(key)]] and [[Level Editor/Scripting/Reference/GamemodeServerApi#has_building|api.has_building(key)]].
* [[Level Editor/Scripting/Reference/GamemodeServerApi#forbid_building|api.forbid_building(zone)]] stops players building in a zone (a spawn room).

== The map's own bots ==
Bots that belong to the map are fixtures such as training dummies, not stand-ins for players: nobody can kick them, and they take no player's seat.
* [[Level Editor/Scripting/Reference/GamemodeServerApi#spawn_bot|api.spawn_bot]] spawns one with a name, loadout and team; [[Level Editor/Scripting/Reference/GamemodeServerApi#map_bots|api.map_bots()]] and [[Level Editor/Scripting/Reference/GamemodeServerApi#is_map_bot|api.is_map_bot]] list and recognise them.
* Training orders: [[Level Editor/Scripting/Reference/GamemodeServerApi#bot_idle|api.bot_idle]] (stand still, never shoot), [[Level Editor/Scripting/Reference/GamemodeServerApi#bot_dodge|api.bot_dodge]] (a moving target), [[Level Editor/Scripting/Reference/GamemodeServerApi#bot_shoot|api.bot_shoot]] (fire at one player only).
* [[Level Editor/Scripting/Reference/GamemodeServerApi#bot_build|api.bot_build]], [[Level Editor/Scripting/Reference/GamemodeServerApi#bot_demolish|bot_demolish]] and [[Level Editor/Scripting/Reference/GamemodeServerApi#bot_has_building|bot_has_building]]: buildings for a map bot that holds a building tool.
* [[Level Editor/Scripting/Reference/GamemodeServerApi#edit_bot_loadout|api.edit_bot_loadout]] lets a player change the loadout of map bots (for example from a zone's <code>_zone_used</code>).

== Tile maps ==
[[Level Editor/Scripting/Reference/GamemodeServerApi#open_tile_map|api.open_tile_map]] opens a grid plan on a player's screen for them to fill in (where to put sentries or walls, say), and <code>_form_submitted(entity_id, form, values)</code> hears what they applied. A player can apply the same map again, so make applying it twice harmless.

== Related pages ==
* [[Level Editor/Scripting/Server rules|Server rules]]
* [[Level Editor/Scripting/Reference/GamemodeServerApi|GamemodeServerApi reference]]

{{Level Editor nav}}

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

Level Editor/Scripting/Map entities - Revision history

TeamSpecBot: American spelling

TeamSpecBot: Level Editor: map entities in gamemode scripts