Scripting API

Every function the mission scripts can call, grouped by class. The Since column is the Easy Red 2 version a call was introduced in: anything newer than the build you are targeting will not exist there.

📖 Scripting Guide ⚡ Callbacks API 🤖 Script Generator

AiParams

Class that handles AI parameters management.

Return	Function Name	Description	Since	Vote
void	allowBeingTargeted	If enabled, enemies will target this soldier whenever they see him. If disabled, the soldier will be completly ignored by enemies. Toghether with allowCheckForEnemies, this function is helpful to script systems like Civilian or Non combatant medics.	2.1.0	▲ 440
void	allowChangePose	When enabled, AI will change pose depending on cover, suppression and other situations. Disable this function if you want to control soldier's pose by custom scripting	2.1.0	▲ 377
void	allowCheckForEnemies	When enabled, AI will check for enemies around and target them. When this function is disabled AI will not search and target enemies. Useful for custom AI implementations	2.1.0	▲ 375
void	allowDoMedic	When this function is enabled, if a soldier has medic equipments in his inventory he will proceed to heal nearby units	2.1.0	▲ 309
void	allowFindCoverWhenSuppressed	When enabled, AI will automatically find cover when suppressed. If you want to move the AI trough custom scripting, you most likely want to disable this feature	2.1.0	▲ 366
void	allowFollowOrders	When enabled, AI will automatically follow squad leader orders. If you want to move this specific unit with your custom scripts, for example by using Soldier.moveTo function, most likely you want this to be disabled	2.1.0	▲ 346
void	allowGiveOrders	When enabled, AI will automatically give orders to the squad if squad leader. If you want to give orders to a squad with your custom scripts, for example by using Squad.moveTo function, most likely you want this to be disabled	2.1.0	▲ 344
void	allowLeaveVehicle	When enabled, AI will leave vehicle when necessary. If you want to control which vehicle the AI should use or force an AI never to leave a vehicle, you might want to disable this feature	2.1.0	▲ 356
void	allowMovements	When enabled, AI will perform move commands. if you don't want the AI never to move, not even with moveTo commands, disable this feature	2.1.0	▲ 341
void	allowOpenWindows	When enabled, AI will open windows that blocks it's vision, for example when in cover behind a window	2.1.0	▲ 342
void	allowRadioOrders	When enabled and if radioman, AI will communicate radio orders requested by squad leader	2.1.0	▲ 314
void	enableAiBehaviour	This function enables or disbales all AI functionalities toghether, including: allowChangePose, allowCheckForEnemies, allowFindCoverWhenSuppressed, allowLeaveVehicle, allowMovements, allowOpenWindows, allowOrders and allowRadioOrders	2.1.0	▲ 382
Objective	findObjective	Find an objective from it's unique Id (network safe). Useful in case you have to reference a specific objective across different phases or players, based on it's unique Id, for example, passed trough a global variable	2.1.0	▲ 242
void	followCustomDirectCommands	Disable various AI behaviors in order to prepare the soldier to follow direct commands, such as soldier.moveTo()	2.1.0	▲ 370
void	followCustomSquadOrders	Normally squad soldiers will automatically give the orders that they cosndier the best according to the situation. This function disables various AI behaviors in order to prepare the soldier to only follow and give custom squad orders via code, such as squad.moveTo()	2.1.0	▲ 346
string	getName	Return the name of the vehicle	2.1.0	▲ 314
void	setTargetPlanesOften	Enable this feature to force the AI to target planes, if closer than any other spotted enemy	2.1.0	▲ 382

Base Functions

These functions are not part of a specific class and can be called from anywhere.

Return	Function Name	Description	Since	Vote
void	#include	Include an external file into the code of a lua script. Useful to create files with collections of functions to share across different script. Included files must be placed within the folder '[mission folder]/scripts/general/' or any subfolder. The script will be pre-processed and aded to the final code before executing it	2.1.0	▲ 344
float	distance	The distance between 2 Vector3 points in meters	2.1.0	▲ 311
void	log	Log some text in the F3 console. This helps a lot with testing custom Lua code. press F3 to open the console and visualize the log	2.1.0	▲ 329
void	print	Display a message on the screen	2.1.0	▲ 503
float	round	Round a number to a specific quantity to decimal points	2.1.0	▲ 431
void	sayMissionClip	Loads a voice clip from the mission "sounds" folder, plays it from the soldier's mouth. Currently only .waw files are supported.	2.1.0	▲ 106
void	sleep	Pause the execution of the LUA script for some time. Notice: this is very helpful to give some pause to the CPU, expecially during 'while' and 'for' loops	2.1.0	▲ 369
Soldier	spawnHuman	Spawn a new human without specific loadout or rank. Faction Ids can be acquired in the Script Settings menu -> Id tables section	2.1.0	▲ 340
Objective	spawnMissionObjective	Spawn a Scriptable Mission Objective on current active phase and it's relative 3D Marker on the current phase. Only the master client can spawn and handle a Mission Objective. A Scriptable Objective doesn't do anything in particular on it's own. The user must make sure to update it's progress value, text, and other parameters on it's own, otherwise it will just act as a 3D Marker. For icon Ids see setIcon.	2.1.0	▲ 422
Soldier	spawnSoldier	Spawn an AI soldier. Faction Ids and loadout Ids can be acquired in the Script Settings menu -> Id tables section	2.1.0	▲ 380
Soldier	spawnSoldierOnVehicle	Spawn an AI soldier on a vehicle. Faction Ids and loadout Ids can be acquired in the Script Settings menu -> Id tables section	2.1.0	▲ 335
Squad	spawnSquad	Spawn an AI squad. Faction Ids and Squad Ids can be acquired in the Script Settings menu -> Id tables section. Can spawn custom squads made with Squad Editor	2.1.0	▲ 343
Squad	spawnSquadOnVehicle	Spawn an AI squad inside a given vehicle. Faction Ids and Squad Ids can be acquired in the Script Settings menu -> Id tables section. Vehicle crew squads will automatically fit the seats inside the vehicle. Can spawn custom squads made with Squad Editor	2.1.0	▲ 340
Squad	spawnSquadOnVehicle_script	Spawn an AI squad inside a given vehicle, and assign a script to each AI. Faction Ids and Squad Ids can be acquired in the Script Settings menu -> Id tables section. Vehicle crew squads will automatically fit the seats inside the vehicle. Can spawn custom squads made with Squad Editor	2.1.0	▲ 553
Squad	spawnSquad_script	Spawn an AI squad and assign a script to each AI. Faction Ids and Squad Ids can be acquired in the Script Settings menu -> Id tables section. Can spawn custom squads made with Squad Editor	2.1.0	▲ 443
Vehicle	spawnVehicle	Spawn a vehicle. Vehicle Ids can be acquired in the Script Settings menu -> Id tables section	2.1.0	▲ 368
Vehicle	spawnVehicle_camo	Spawn a vehicle with a specified camo. Vehicle Ids can be acquired in the Script Settings menu -> Id tables section	2.1.0	▲ 445
Vehicle	spawnVehicle_camo_dest	Spawn a vehicle with a specified camo and give it a destination. For Auto-Transport vehicles, this is where units will be deployed. Vehicle Ids can be acquired in the Script Settings menu -> Id tables section	2.1.0	▲ 360
Vehicle	spawnVehicle_dest	Spawn a vehicle and give it a destination. For Auto-Transport vehicles, this is where units will be deployed. Vehicle Ids can be acquired in the Script Settings menu -> Id tables section	2.1.0	▲ 333
void	waitForAny	Pause the execution of the script until any of the given conditions are met.	2.1.0	▲ 353
void	waitUntil	Pause the execution of the script until one or multiple conditions are met.	2.1.0	▲ 417

er2

General utility and helper functions.

Return	Function Name	Description	Since	Vote
void	addInvadersTickets	Adds tickets to the current invaders faction.	2.1.0	▲ 394
void	bindKey	Calls a callback when a keyboard key is pressed. The callback is one registered with er2.setCallback, so you bind a key to an id, not to a function. Binding the same key again replaces the previous id.Keys are watched only while at least one binding exists, and only on this computer: nothing is sent to the other players (call er2.runEveryone from the callback if you need that). The key is ignored while a menu or the chat has the focus, and on consoles there is no keyboard at all.Key names are Unity KeyCode names, case insensitive: F5, K, Alpha1 (the 1 above the letters), Keypad1, Space, LeftShift, Tab. Keys the game already uses still do their normal job.	2.1.1	▲ 41
void	bindKeyUp	Same as bindKey, but the callback runs when the key is released. A key can have both a press and a release callback.	2.1.1	▲ 42
vec3	cameraPosition	Get the world position of the camera	2.1.0	▲ 332
void	clearAllRunOnJoin	Clear all buffered requests to run a script locally for joining users	2.1.0	▲ 280
Number	consumeFactionSpending	Returns everything the players of this client have spent on births since the last call, and clears the tally. Subtract it from your own synced counter so the spending makes it back to the shared total.	2.1.1	▲ 68
float	convertKmhInMs	Converts a speed from kilometres per hour into metres per second, which is the unit the engine uses for every velocity.	2.1.0	▲ 64
float	convertMsInKmh	Converts a speed from metres per second, the unit the engine uses for every velocity, into kilometres per hour.	2.1.0	▲ 59
integer	countAliveDefenders	Get the count of all the currently alive defenders	2.1.0	▲ 341
integer	countAliveInFaction	Get the count of all the currently alive units on a specific faction	2.1.0	▲ 357
integer	countAliveInvaders	Get the count of all the currently alive invaders	2.1.0	▲ 399
integer	countDeceasedDefenders	Count how many defenders are deceased during the mission	2.1.0	▲ 348
integer	countDeceasedInvaders	Count how many invaders are deceased during the mission	2.1.0	▲ 350
integer	countLostVehiclesDefenders	Count how many defenders have been captured during the mission	2.1.0	▲ 332
integer	countLostVehiclesInvaders	Count how many invaders have been captured during the mission	2.1.0	▲ 255
integer	countPrisonersDefenders	Count how many vehicles have been lost by the defenders during the mission	2.1.0	▲ 308
integer	countPrisonersInvaders	Count how many vehicles have been lost by the invaders during the mission	2.1.0	▲ 316
void	createConquestProp	Places a map prop in the world at runtime: crates, radios, sandbags, anything that is scenery rather than a vehicle.The prop is local and is not synchronised. Call this on every client with identical values, exactly as you would for createSpawn, or players will not see the same battlefield. Scenery has no shared state, so putting it on the network would be traffic spent for nothing.Vehicles are rejected on purpose: for those use spawnConquestVehicle.	2.1.1	▲ 73
Number	createSpawn	Creates a spawn point at runtime and registers it in the current phase, so the respawn panel and the AI both see it.These spawns are local and are not synchronised. Call this on every client with identical values (drawing them from a shared seed is the easy way) or players will not agree on what exists.	2.1.1	▲ 67
void	damageAll	Damages every soldier and vehicle inside the radius. Unlike explosion it produces no visual or sound effect, and unlike destroyAll it leaves buildings standing.	2.1.0	▲ 65
void	destroyAll	Destroys all DestructableBuilding props within radius, including buildings not currently in view. Optionally kills units and explode vehicles.	2.1.0	▲ 111
void	endPrecipitation	Stops the rain or the snow from falling in the map To synchronize the weather changes to other clients you can use synchWeather.	2.1.0	▲ 316
void	explosion	Generates an explosion	2.1.0	▲ 476
Soldier	findSoldier	Find a soldier from it's unique Id (network safe). Useful in case you have to reference a specific soldier across different phases or players, based on it's unique Id, for example, passed trough a global variable	2.1.0	▲ 333
Soldier	findVehicle	Find a vehicle from it's unique Id (network safe). Useful in case you have to reference a specific vehicle across different phases or players, based on it's unique Id, for example, passed trough a global variable	2.1.0	▲ 369
void	getAllObjectives	Get all Mission Objectives in the current phase.	2.1.0	▲ 350
void	getAllSoldiers	Get all alive soldiers. Notice: After a new soldier spawns or dies, this function might get a few instant before returning a correctly updated value.	2.1.0	▲ 316
void	getAllVehicles	Get all vehicles around the map	2.1.0	▲ 308
string	getBattleName	Returns the current battle's name	2.1.0	▲ 350
Number	getCurrentPhaseId	Get the Id of the current phases.	2.1.0	▲ 310
string	getDefendersFaction	Get the Id for the defenders faction	2.1.0	▲ 323
float	getDistanceFromTerrain	Returns the distance between the given position and the terrain.	2.1.0	▲ 331
Number	getFactionBudget	The last budget value communicated for a faction with setFactionBudget.	2.1.1	▲ 54
string	getInvadersFaction	Get the Id for the invaders faction	2.1.0	▲ 321
integer	getInvadersTicket	Returns the number of tickets left by the invaders	2.1.0	▲ 292
void	getMapCenter	The centre of the playable terrain, in world coordinates. Use it as the origin when you generate something procedurally instead of hard-coding positions that only work on one map.	2.1.1	▲ 66
Number	getMapLocations	Fills a Lua table with the named places of the map (towns, villages, landmarks), each as a table with name and position. Useful to make a generated battle fight over real places instead of empty fields.	2.1.1	▲ 63
string	getMapName	Returns the name of the map of the current battle	2.1.0	▲ 339
void	getMapSize	The size of the playable terrain in metres. Only x and z are meaningful; y is unused. Together with getMapCenter it gives you the rectangle a generated layout has to stay inside.	2.1.1	▲ 76
string	getMyNickname	Get nickname of the local user	2.1.0	▲ 417
Objective	getNearestObjective	Get the nearest Mission Objective to a specific location	2.1.0	▲ 273
Squad	getNearestSoldier	Get nearest soldier to a specific location	2.1.0	▲ 344
Vehicle	getNearestVehicle	Get nearest vehicle from a specific location	2.1.0	▲ 315
string	getNickname	Get nickname of an online player	2.1.0	▲ 289
Soldier	getPlayer	Find a reference to the Soldier controlled by the player	2.1.0	▲ 329
Number	getPropPositions	Fills a Lua table with the positions of every map prop of a given kind inside a circle. propType is the type recorded in the prop database: environment, terrain, streets, buildings, props, vehicles, items, weapons. Handy to place objectives on actual buildings.	2.1.1	▲ 65
float	getSettingMaxAllies	Get the max allies threshold set during match creation. It is suggested to use this value to measure the amount of AI to spawn according to player preference. This can be used to impact gameplay balancing and performance.	2.1.0	▲ 397
float	getSettingMaxAxis	Get the max axis threshold set during match creation. It is suggested to use this value to measure the amount of AI to spawn according to player preference. This can be used to impact gameplay balancing and performance.	2.1.0	▲ 326
integer	getSettingMaxPlayersDefenders	Get the max allowed amount of Human Players on the defenders faction. Works only during multiplayer matches	2.1.0	▲ 346
integer	getSettingMaxPlayersInvaders	Get the max allowed amount of Human Players on the invaders faction. Works only during multiplayer matches	2.1.0	▲ 346
float	getSettingTicketsMultiplier	Get the tickets multipler set during match creation	2.1.0	▲ 412
float	getSettingUnitCountMultiplier	Returns the multiplier the engine applies to the invaders' tickets, based on the unit count the match was actually started with compared to the count the mission was designed for. Companion to getSettingTicketsMultiplier.	2.1.0	▲ 62
Table	getSoldiersInArea	Get all alive soldiers within a specific radius from a specific position, ordered by the distance from the given position. Notice: After a new soldier spawns or dies, this function might get a few instant before returning a correctly updated value.	2.1.0	▲ 328
void	getSpawnPosition	Where a spawn created by the script ended up. Note that createSpawn raises a position that is below the water line, so this can differ from what you passed in.	2.1.1	▲ 65
float	getTerrainHeight	Returns the terrain height from sea level of the given x and z coordinates.	2.1.0	▲ 347
integer	getTimeOfDayHour	Gets the current time (hour)	2.1.0	▲ 118
integer	getTimeOfDayMinute	Gets the current time (minutes)	2.1.0	▲ 121
void	getVehiclesInArea	Get all vehicles within a specific area	2.1.0	▲ 313
Number	getWaterLevel	The height of the sea or river surface on this map. Anything below this is under water.	2.1.1	▲ 69
bool	isAllied	Check if a given faction Id is part of Allies faction	2.1.0	▲ 301
bool	isAxis	Check if a given faction Id is part of Axis faction	2.1.0	▲ 321
AiParams	isCivilian	Check if a given faction Id is part of Civilians faction	2.1.0	▲ 337
bool	isInsideMainTerrainBounds	Checks if the given position is inside the terrain bounds	2.1.0	▲ 409
bool	isMasterClient	Check if current user is master client for online match. In an offline mission, the user is always the master client	2.1.0	▲ 431
bool	isOnline	Check if current mission is being played on an online match	2.1.0	▲ 431
bool	isSameFaction	Check if two faction Ids are part of the same faction (Allies or Axis)	2.1.0	▲ 429
void	isWater	Whether a position is water rather than dry land. The margin lets you decide how much shoreline counts as water: a squad that would land in ankle-deep surf usually still needs a boat, so the default leans that way.	2.1.1	▲ 64
Squad	makeSquad	Create a new empty squad. You can add soldiers to this squad in order to make them react to squad orders	2.1.0	▲ 312
bool	nextPhase	Force mission to skip to next phase	2.1.0	▲ 375
void	nuke	Generate a nuke explosion at a certain position. The nuke will devastate a certain area and will spawn a huge explosion visual effect with a never-ending smoke effect. Having multiple nuke smokes leftovers in a map can cause severe performance issues, so use this carefully.	2.1.0	▲ 277
void	nuke_nofx	Destroys every destructible building inside the radius and damages the units and vehicles caught in it, without any visual effect. Use nuke or explosion when the blast should be seen. Buildings outside the player's view are destroyed too, and the work is spread across several frames.	2.1.0	▲ 62
void	playClip	Play a global Audio Clip (.wav)	2.1.0	▲ 379
void	playClip3D	Play a 3D Audio Clip, coming from a specific location and with a maximum hear distance (.wav). Notice: In various occasions, such as host change, a phase script might restart, so make use of set and get to check whenever set to be played in loop forever was already initialized to avoid spawning it multiple times.	2.1.0	▲ 345
void	playClipOnRadio	Play a global Audio Clip with a radio distortion effect (.wav)	2.1.0	▲ 341
void	playClipOnRadio3D	Play a 3D Audio Clip, coming from a specific location and with a maximum hear distance with a radio distortion effect (.wav)	2.1.0	▲ 335
void	playMusic	Plays a music track globally.	2.1.0	▲ 347
bool	previousPhase	Force mission to skip to previous phase	2.1.0	▲ 362
float	raycast	Casts a ray from an origin toward a direction. Used to test collisions and objects presence. The test is done trough a Unity Raycast.	2.1.0	▲ 333
void	removeConquestWorldObjects	Removes everything the three functions above put in the world: props, vehicles and their crews. Call it before regenerating a layout and when the mode ends.It also cancels the creations still in flight, so a prop whose prefab was still loading when you cleared the field does not appear a moment later on ground that no longer belongs to it.	2.1.1	▲ 57
void	removeCreatedSpawns	Removes every spawn this script created and unregisters them from the current phase. Call it before regenerating a layout, and when the mode ends.	2.1.1	▲ 70
void	require	Equivalent to default Lua require function, but handles the script paths as local misison paths, to ensure easier file referencing and compatibility with Xbox, Nintendo Switch and PlayStation systems. External file must be placed within the folder '[mission folder]/scripts/general/' or any subfolder	2.1.0	▲ 440
bool	resetCallback	Unassign a callback by it's Id.	2.1.0	▲ 375
void	resetCallbacks	Unassign all global callbacks	2.1.0	▲ 367
void	resetFactionEconomy	Clears both budgets and the pending spending, and switches spawn costs off. Call it before setting up a new battle.	2.1.1	▲ 65
bool	run	Execute an external file without stopping execution of current scrip. External file must be placed within the folder '[mission folder]/scripts/general/' or any subfolder	2.1.0	▲ 338
void	runEveryone	Run a script locally for every player in the match (or just for the user if it's a SinglePlayer match). External file must be placed within the folder '[mission folder]/scripts/general/' or any subfolder	2.1.0	▲ 419
void	runEveryoneOnce	Run a script locally for every player in the match making sure it was not executed before (or just for the user if it's a SinglePlayer match). External file must be placed within the folder '[mission folder]/scripts/general/' or any subfolder	2.1.0	▲ 320
bool	runOnce	Execute an external file without stopping execution of current scrip, if the external file was never executed before during the mission. External file must be placed within the folder '[mission folder]/scripts/general/' or any subfolder	2.1.0	▲ 434
bool	setCallback	register a global callback on a specific event Id. Only a callback can be tied to an event Id, so when this is called again on the same Id, the new callback reference will override previous one. Callback Ids are specified at this page.	2.1.0	▲ 445
void	setFactionBudget	Tells the engine how many reinforcement points a faction has left. The respawn panel uses it to grey out spawns the side cannot afford, without waiting for a network round trip.The real counter stays in your script (a synced global is the usual place): this only mirrors it. Calling this at all is what switches spawn costs on.	2.1.1	▲ 55
bool	setPhase	Changes the current phase to the one of index order	2.1.0	▲ 388
void	setRaining	Activates the rain on the map. To synchronize the weather changes to other clients you can use synchWeather.	2.1.0	▲ 427
void	setSnowing	Activates the snow on the map. To synchronize the weather changes to other clients you can use synchWeather.	2.1.0	▲ 363
void	setSpawnCost	Changes what a player birth at this spawn costs the faction budget. Useful to make well-armed positions more expensive as the battle turns.	2.1.1	▲ 64
void	setSpawnVehicleDestination	Tells the vehicle of a spawn where to carry the squad before dropping it. Applies to anything the engine treats as an automatic transport: landing craft, gliders, cargo planes. The spawn is also turned to face that destination, so the vehicle appears pointing along its route instead of due north.Without a destination an automatic transport is created and simply sits there.	2.1.1	▲ 72
void	setSpawnWaypoint	Sends the squads born at this spawn towards a point as soon as they appear.	2.1.1	▲ 68
void	setTaskTextDefenders	Set task text for defenders	2.1.0	▲ 246
void	setTaskTextInvaders	Set task text for invaders	2.1.0	▲ 255
void	setTimeAndWeather	Sets the current time of day of the mission and some weather conditions, like clouds, snow and fog. To synchronize the weather changes to other clients you can use synchWeather. NOTE: This function it's CPU heavy	2.1.0	▲ 376
void	setTimeOfDay	Sets the current time of day of the mission. NOTE: This function is CPU heavy	2.1.0	▲ 423
void	setVictoryDefenders	Concludes the mission declaring defenders as winners	2.1.0	▲ 584
void	setVictoryInvaders	Concludes the mission declaring invaders as winners	2.1.0	▲ 326
void	showObjective	Display a new objective text	2.1.0	▲ 343
void	spawnConquestVehicle	Puts an empty vehicle in the world and leaves it there. Made for the guns and machine guns a battle is fought around: it is not a spawn point, so nobody is born in it and any unit that walks up to it can man it normally.Unlike the props, this one is a networked object: in multiplayer only the master client does anything and everyone else receives it automatically. On a client the call returns false and nothing happens, which is correct and not an error to guard against.	2.1.1	▲ 72
void	spawnConquestVehicleWithCrew	The same as spawnConquestVehicle, but the vehicle comes with an AI crew already aboard. This is how you leave a manned anti-tank gun or a bunker MG on the field.The squad may be one from the squads archive or a custom squad defined in the mission; the crew is cut down to the seats the vehicle actually has. Master client only, like spawnConquestVehicle: vehicle and soldiers are ordinary networked objects and reach everyone else on their own.	2.1.1	▲ 68
void	spawnItem	Puts an item on the ground, with physics, as if someone had dropped it there. Any soldier can walk up and pick it up.Multiplayer: only the master client spawns it; the others receive it automatically and whoever picks it up removes it for everyone. Players joining later do not see items spawned before they arrived. On the other clients the call returns false and does nothing, so it is safe to call it from a script that runs on everyone.Items of a DLC the executing player does not own are skipped with a line in the F3 console.	2.1.1	▲ 41
void	synchWeather	Apply the weather changes to all clients. Must be called on Master Client. After calling this, set weather is automatically applied for newly connected clients. Calling it too often can result in high network traffic and mission crash.	2.1.0	▲ 294
float	time	Time in seconds since the start of the execution of the game. The value is linear and doesn't take into account pausing, slowing down or speeding up game time	2.1.0	▲ 335
float	timeScaled	Scaled time in seconds since the start of the execution of the game. If the game is paused the count of the time doesn't increase. If the game is speeding up or slowing down this variable also increases with a proportional rate	2.1.0	▲ 355
bool	triggerCallback	Force the triggering of a callback set trough setCallback	2.1.0	▲ 411
string	tryLocalize	Resolves a localization key into the language the player is using. Text starting with # is looked up in the mission localization file; anything else is returned unchanged, so it is safe to pass any string through it.	2.1.0	▲ 59
void	unbindKey	Removes the press and release callbacks of a key. When the last key is unbound the keyboard is no longer watched. er2.resetCallbacks() and the end of the battle unbind every key.	2.1.1	▲ 41

global

Functions to manipulate global variables that can be accessed from any script and over the network.

Return	Function Name	Description	Since	Vote
any	get	Get the value of a stored global variable	2.1.0	▲ 378
any	myplayerget	Get the value of a stored global variable by my player.	2.1.0	▲ 355
void	myplayerset	Set a global variable for my network player that can be referenced from any script and by any player in the room. If another player sets a variable with the same id, it won't compromise my variable.	2.1.0	▲ 321
any	playerget	Get the value of a stored global variable by a specific player.	2.1.0	▲ 367
void	set	Set a global variable that can be referenced from any script and by any player in the room	2.1.0	▲ 434

hud

Controls the in-game mission status bar, the one showing flags, tickets and capture progress at the top of the screen. A mission script can hide the vanilla bar, hide the phase squares, and add its own icon + value fields to it. Exposed as the global hud.Nothing here is networked: like setTaskTextInvaders and setTaskTextDefenders, every client runs the mission script and drives its own local bar.

Return	Function Name	Description	Since	Vote
void	clearFields	Removes every custom field the script added to the bar. Does not touch the vanilla part.	2.1.0	▲ 61
bool	isEnabled	Tells whether the mission status bar is currently enabled.	2.1.0	▲ 57
void	removeField	Removes one custom field from the bar. Does nothing if no field with that id exists.	2.1.0	▲ 57
void	setEnabled	Shows or hides the whole mission status bar for the rest of the battle. Scripted fields added with setField are hidden too.	2.1.0	▲ 35
void	setField	Creates a custom field on the bar, or updates it if a field with the same id already exists. Fields are drawn in creation order, so the first setField call for a given id decides its position.	2.1.0	▲ 79
void	setFieldColor	Sets the colour of a field's value text. Components go from 0 to 1 and are clamped. Creates the field if it does not exist yet.	2.1.0	▲ 64
void	setFieldSide	Moves a HUD field to the right-hand end of the top bar instead of the left. Handy to keep your own numbers on your side and the enemy's under their flag.	2.1.1	▲ 72
void	setFieldWidth	Reserves a fixed width for the field's value text, so a number that changes often does not make the rest of the bar shift around. Creates the field if it does not exist yet.	2.1.0	▲ 53
void	setPhases	Shows or hides the phase advancement squares. They are visible by default in every game mode. Hide them in missions that do not advance through linear phases, so players are not told to expect a progression that will never happen.	2.1.0	▲ 53
void	setRespawnText	Writes a line of your own into the respawn menu, under the sector list, where the player decides whether to go back in. Newlines are honoured, so several values can be listed one per line. Pass an empty string to clear it.	2.1.1	▲ 73
void	setVanillaBar	Shows or hides only the vanilla half of the bar: faction flags, tickets, capture squares and objectives. Fields added by the script stay visible.Useful for non-linear or scripted missions where the standard capture progress means nothing, but you still want a bar of your own.	2.1.0	▲ 66

Objective

Functions related to mission objective areas and markers.

Return	Function Name	Description	Since	Vote
bool	canControl	Check if user can change the objective data, such as objective name, completition value, radius, icon and position. Usually this correspond to the Master Client	2.1.0	▲ 335
void	complete	Set the conquer progress of the Scripted Mission Objective to 1 (max). Equivalent of Objective.setProgress(1). Just like any other Mission Objective property, it doesn't work with Conquer Area Objective, or any other Vanilla objective type, but only with Scripted Mission Objective spawned with spawnMissionObjective call. Notice: When all the objectives in a Mission Phase are completed (progress = 1) the Next Phase is automatically triggered	2.1.0	▲ 440
string	getDisplayName	Returns the objective's name as it appears in the interface, with any # localization key already resolved into the current language.	2.1.0	▲ 65
string	getName	Returns the objective's name exactly as it is stored, without resolving a # localization key. Use getDisplayName if you need the text the player actually sees.	2.1.0	▲ 67
vec3	getPosition	Get the world position of the Mission Objective	2.1.0	▲ 435
float	getProgress	Get the progress of a Mission Objective. A value equals to 1 means that the Objective have been completed. When all Objectives in a Mission Phase are completed, the match pass automatically to the Next Phase	2.1.0	▲ 339
float	getRadius	Get the area radius of the Mission Objective	2.1.0	▲ 408
integer	getUniqueId	Get unique identifier for the objective. This is useful to check if an objective already exist, or to find specific objective with findObjective, especially across the network or between different phases.	2.1.0	▲ 314
bool	isAttractor	Check if a Mission Objective will attract default AI to fight on the area for at least a faction, or optionally, for a specific one.	2.1.0	▲ 322
bool	isCompleted	Check whenever a Mission Objective progress is complete (check if Objective.getProgress >= 1). Notice: When all the Mission Objectives in the current Mission Phase are marked as completed, the Next Phase will automatically be triggered	2.1.0	▲ 327
bool	isInside	Check whenever a vec3() position is inside a specific Mission Objective, specifically within it's radius from it's center position	2.1.0	▲ 326
bool	isScripted	Check if a Mission Objective is a scriptable one 8Scripted Mission Objective spawned with spawnMissionObjective call), where it is possible to control all the data	2.1.0	▲ 354
void	remove	Remove this objective from the current Mission Phase. Just like setting properties, only the master client can call do this operation	2.1.0	▲ 337
void	resetIconDefenders	Unset the icon of a Scripted Mission Objective specifically for the defenders faction, making it using the same icon as the attackers. This function impacts network performance during online gameplay, so don't call it too often. When this icon gets unset, the defenders will share the same icon as the attackers, which is assigned with setIcon	2.1.0	▲ 332
void	setAttractor	Enable or disable the attractor feature of the Scripted Mission Objective for both factions. When enabled, default AI will try to reach and fight inside the area. Optionally can change the effect for one faction only	2.1.0	▲ 338
void	setIcon	Update the icon of a Scripted Mission Objective from the icon Id. This function impacts network performance during online gameplay, so don't call it too often. Possible Ids are: "0": Conquer area icon. "1": Defend area icon. "2": Clear area icon. "3": Destroy AT gun icon. "4": Destroy vehicle icon. "5": Important area icon.	2.1.0	▲ 367
void	setIconDefenders	Update the icon of a Scripted Mission Objective from the icon Id, specifically for the defenders faction. This function impacts network performance during online gameplay, so don't call it too often. When this icon gets unset, the defenders will share the same icon as the attackers, which is assigned with setIcon	2.1.0	▲ 322
void	setName	Sets the objective's name. Works on scripted objectives only, and is synchronised over the network.A name starting with # is treated as a localization key and resolved from the mission localization file, so the same objective reads correctly in every language.	2.1.0	▲ 58
void	setPosition	Update the world position of a Scripted Mission Objective	2.1.0	▲ 327
void	setProgress	Set the conquer progress of the Scripted Mission Objective. Just like any other Mission Objective property, it doesn't work with Conquer Area Objective, or any other Vanilla objective type, but only with Scripted Mission Objective spawned with spawnMissionObjective call. Notice: When all the objectives in a Mission Phase are completed (progress = 1) the Next Phase is automatically triggered	2.1.0	▲ 353
void	setRadius	Update the area radius of a Scripted Mission Task	2.1.0	▲ 278
void	setSecuredFaction	Declares which faction actually holds this objective. Without it the engine assumes every held objective belongs to the invaders, so in a symmetric mode an area taken by the defenders would still be drawn in the invaders' colour.Pass an empty string for "nobody holds it".	2.1.1	▲ 70
void	setText	Update the text of a Scripted Mission Objective. The text is displayed when inside the Mission Objective radius. This function impacts network performance during online gameplay, so don't call it too often	2.1.0	▲ 364
void	setTextDefenders	Update the text of a Scripted Mission Objective for the Defenders. The text is displayed when inside the Mission Objective radius. If this function is never called, the defenders will see the same text as the invaders. This function impacts network performance during online gameplay, so don't call it too often.	2.1.0	▲ 317

Soldier

Functions related to player actions and properties.

Return	Function Name	Description	Since	Vote
bool	addAmmo	Adds an ammo box to the soldier's invetory	2.1.0	▲ 363
void	addItemToInventory	Puts an item in the soldier's inventory: a weapon, a magazine, an attachment, a bandage, a helmet, anything with an id in the items database. Online the change is sent to the owner of the soldier.Items of a DLC the executing player does not own are skipped with a line in the F3 console. Nothing is added when the inventory has no room.	2.1.1	▲ 41
bool	addMagazine	Adds a magazine to the soldier's invetory.	2.1.0	▲ 354
bool	addNewItem	Adds an item to the soldier's inventory	2.1.0	▲ 365
void	alertFor	Puts the soldier in an alert state for a defined time	2.1.0	▲ 331
void	applyBleeding	Applies bleed status to the soldier	2.1.0	▲ 310
void	boardVehicle	Order the soldier to approach and borar onto the specified vehicle if available.	2.1.0	▲ 354
bool	canSwitchSeat	Check if the soldier is ready to switch seat. Usually this happens when a soldier is not busy with enteirng or leaving the vehicle with an animation.	2.1.0	▲ 301
void	carryBody	Force the soldier to carry a another incapacitated soldier	2.1.0	▲ 375
bool	containsItem	Tells whether the soldier is carrying at least one item with this id.	2.1.0	▲ 59
integer	countItems	Counts how many items with this id the soldier is carrying.	2.1.0	▲ 80
void	damageSoldier	Apply damage to a soldier	2.1.0	▲ 291
void	decreaseStamina	Decreases soldier's stamina	2.1.0	▲ 390
void	disableHitByVehicleFor	Disable receiving damage from impacts with vehicles for some time	2.1.0	▲ 405
void	dropHeadgear	Makes the soldier lose the headgear they are wearing, dropping it on the ground. Does nothing if they are bareheaded.	2.1.0	▲ 60
void	executeOrdersRoutine	Executes the routine to process squad orders for the soldier.	2.1.0	▲ 348
void	findCover	Finds a cover position near a specified position within a given radius.	2.1.0	▲ 336
bool	forceTarget	Force a Soldier to target a specific Soldier or Vehicle.	2.1.0	▲ 366
AiParams	getAiParams	Access AI parameters management	2.1.0	▲ 352
Soldier	getCarriedBody	Get a reference to the incapacitated soldier carried by this unit	2.1.0	▲ 400
string	getClassName	Returns the soldier's class name	2.1.0	▲ 359
Vehicle	getCurrentVehicle	Returns the current vehicle the soldier is in	2.1.0	▲ 344
float	getDistanceFromGround	Get the distance between the soldier and the ground below	2.1.0	▲ 312
vec3	getFacePosition	Get the world position of soldier's face	2.1.0	▲ 321
string	getFaction	Gets the soldier's faction ID	2.1.0	▲ 382
vec3	getFireDirection	Return a vector representing the direction where the gun held by the soldier is pointed to	2.1.0	▲ 336
string	getHeadgearId	Returns the current wearing headgear Id	2.1.0	▲ 320
float	getHealth	Get the soldier's health	2.1.0	▲ 309
string	getHeldWeaponId	Returns the id of the weapon the soldier is currently holding in their hands.	2.1.0	▲ 59
vec3	getMoveDirection	Returns the moving direction of the soldier	2.1.0	▲ 322
string	getName	Returns the soldier's full name	2.1.0	▲ 418
Soldier	getNearestInjured	Get the nearest wounded soldier around the current one	2.1.0	▲ 317
Vehicle	getNearestVehicleToRepair	Returns the nearest vehicle that requires repair from the current soldier	2.1.0	▲ 322
string	getOwnerId	Get Id of the online player controlling this soldier (Including AIs being controlled by his machine).	2.1.0	▲ 328
vec3	getPosition	Get world position of the soldier	2.1.0	▲ 432
Squad	getSquad	Get the Squad that the soldier is currently in. Notice: The squad might not be available immediatly after a soldier is spawned, so make sure to wait for it to be ready	2.1.0	▲ 329
float	getSuppressionValue	Checks the suppression value of the soldier from the enemy fire.	2.1.0	▲ 331
string	getUnequippedWeaponId	Returns the id of the weapon the soldier carries slung on their back rather than in their hands.	2.1.0	▲ 68
string	getUniformId	Get the Id of the uniform worn by the soldier	2.1.0	▲ 302
integer	getUniqueId	Get unique identifier for the unit. This is useful to check if a unit already exist, or to find specific units with findSoldier, especially across the network or between different phases.	2.1.0	▲ 389
vec3	getVelocity	Returns the current soldier's velocity	2.1.0	▲ 324
string	getVestId	Get the Id of the vest worn by the soldier	2.1.0	▲ 424
bool	hasHeadgear	Check if the the soldier is wearing an headgear	2.1.0	▲ 392
bool	hasRadio	Check if a soldier is wearing a radio	2.1.0	▲ 416
bool	hasUnequippedWeapon	Tells whether the soldier carries a second weapon besides the one in their hands.	2.1.0	▲ 61
bool	hasVest	Check if a soldier is wearing a vest	2.1.0	▲ 295
void	healSoldier	Heals soldier of a certain amount	2.1.0	▲ 311
void	incapacitate	Force incapacitate a soldier	2.1.0	▲ 354
bool	isAI	Checks if the current soldier is controlled by the AI	2.1.0	▲ 418
bool	isAiming	Checks if the current soldier is aiming the gun	2.1.0	▲ 372
bool	isAlerted	Check if the soldier has spotted an enemy recently and is moving carefully	2.1.0	▲ 387
bool	isAlive	Checks if the current soldier is alive	2.1.0	▲ 355
bool	isAllied	Check if current soldier is part of Allies faction	2.1.0	▲ 450
bool	isAmmoBoxCarrier	Check if soldier is carrying an ammo box	2.1.0	▲ 374
bool	isATSoldier	Returns true if the current soldier is an Anti-Tank unit	2.1.0	▲ 362
bool	isAxis	Check if current soldier is part of Axis faction	2.1.0	▲ 436
bool	isBleeding	Check if the soldier is bleeding	2.1.0	▲ 345
bool	isCarried	Returns true if the current soldier is getting carried	2.1.0	▲ 401
bool	isCarryingBody	Check if the current soldier is carrying an incapacitated soldier	2.1.0	▲ 363
bool	isCharging	Returns true if the current soldier is charging	2.1.0	▲ 376
AiParams	isCivilian	Check if current soldier is part of Civilians faction	2.1.0	▲ 404
bool	isCrawling	Returns true if the current soldier is crawling	2.1.0	▲ 420
bool	isDead	Check if a soldier is dead	2.1.0	▲ 359
bool	isDoingMelee	Check if the soldier is doing a melee attack	2.1.0	▲ 308
bool	isEnteringVehicle	Returns true if the current soldier has started the entering vehicle animation	2.1.0	▲ 319
bool	isExitingVehicle	Returns true if the current soldier has started the exiting vehicle animation	2.1.0	▲ 386
bool	isFallingWithParachute	Checks if the current soldier is falling with a parachute	2.1.0	▲ 332
bool	isFlameThrowerCarrier	Check if a soldier is a flamethrower carrier	2.1.0	▲ 385
bool	isFromChargingFaction	Check if the soldier can execute a charge order	2.1.0	▲ 315
bool	isGrounded	Returns true if the soldier is on the ground	2.1.0	▲ 517
bool	isIncapacitated	Check if a soldier is incapacitated	2.1.0	▲ 322
bool	isInsideVehicle	Check if the soldier is inside a vehicle	2.1.0	▲ 319
bool	isJumping	Returns true if the current soldier is jumping	2.1.0	▲ 315
bool	isMarksman	Returns true if the current soldier is a Marksman	2.1.0	▲ 262
bool	isMechanic	Returns true if the current soldier is a mechanic	2.1.0	▲ 381
bool	isMedic	Returns true if the current soldier is a medic	2.1.0	▲ 341
bool	isMine	Check whenever I have network authority over a soldier	2.1.0	▲ 408
bool	isMoving	Returns true if the current soldier is moving	2.1.0	▲ 358
bool	isOnCover	Check if a soldier is taking cover	2.1.0	▲ 362
bool	isOnFire	Returns true if the current soldier is on fire	2.1.0	▲ 327
bool	isOnWater	Check if a soldier is walking inside water	2.1.0	▲ 344
bool	isOutOfStamina	Returns true if the current soldier is out of stamina	2.1.0	▲ 295
bool	isPlayer	Check if the soldier is a player	2.1.0	▲ 330
bool	isPlayerFPS	Returns true if the current soldier is a player and in first person	2.1.0	▲ 320
bool	isRadioman	Check if the current soldier is a Radioman	2.1.0	▲ 366
bool	isReachingVehicleToMount	Check if a soldier is on his way to mount inside a vehicle	2.1.0	▲ 351
bool	isReloading	Returns true if the current soldier is reloading a weapon	2.1.0	▲ 385
bool	isRunning	Returns true if the current soldier is running	2.1.0	▲ 408
bool	isSameFaction	Check if another soldier is in the same faction of this soldier	2.1.0	▲ 343
bool	isSquadLeader	Returns true if the current soldier is the Squad Leader	2.1.0	▲ 307
bool	isSquadReady	Check if soldier is in a squad, and the squad is marked as ready to receive orders. Notice: A squad might not be ready immediately after a soldier has spawned, so this can be used to check whenever the soldier is in a squad before getting the squad reference	2.1.0	▲ 318
bool	isStealth	Returns true if the soldier is moving stealthly	2.1.0	▲ 309
bool	isSuppressed	Checks if the soldier is being suppressed	2.1.0	▲ 261
bool	isSurrendering	Check if the soldier is surrendering	2.1.0	▲ 356
bool	isTalking	Returns true if the current soldier is talking	2.1.0	▲ 335
bool	isThrowing	Returns true if the current soldier is throwing something	2.1.0	▲ 359
bool	isTowardWall	Returns true if the current soldier is facing a wall	2.1.0	▲ 325
bool	isUsingVehicleTurret	Check if soldier is operating a turret	2.1.0	▲ 307
void	jump	Makes the soldier jump. Notice: the jump movement is based on the current soldier velocity and direction.	2.1.0	▲ 328
void	killSoldier	Kills the soldier	2.1.0	▲ 351
void	leaveVehicle	Commands the soldier to eject from the current vehicle.	2.1.0	▲ 322
void	moveTo	Moves the soldier to a specified position using CoverPosition with a new DestinationWithoutCover based on the given position and current pose.	2.1.0	▲ 345
Soldier	myself	Can be called within a SoldierBrain script to acquire the soldier controlled by the script	2.1.0	▲ 466
void	removeBleeding	Removes bleeding effect from soldier	2.1.0	▲ 345
bool	removeItem	Remove one or multiple items from a soldier invenotory	2.1.0	▲ 323
void	removeVest	Removes the vest the soldier is wearing, together with everything it holds.	2.1.0	▲ 58
bool	resetCallback	Unassign a callback by it's Id on a specific Soldier	2.1.0	▲ 432
void	resetCallbacks	Unassign all callbacks on a specific Soldier	2.1.0	▲ 432
void	resetPose	Allow the soldier to automatically choose it's pose, canceling setPose command	2.1.0	▲ 408
void	say	Makes the soldier say a line based on the VoiceClip Enum	2.1.0	▲ 422
void	sayClip	Play a 3D Audio Clip, coming from soldier mouth and with soldier speaking animation (.wav)	2.1.0	▲ 487
void	setAnimatorBool	Sets a bool parameter on the soldier's animator	2.1.0	▲ 104
void	setAnimatorController	Loads a RuntimeAnimatorController by name from the "er2animations" bundle and applies it.	2.1.0	▲ 89
bool	setBrain	Set script that controls AI. Usually AI will work with "Default" behaviour, which will controls the way AI gives and follows squad orders, however it's possible to define a completly new behaviour by coding a dedicated "brain" LUA file and assign it to the AI with this function	2.1.0	▲ 349
bool	setCallback	Register a callback for a specific event Id on a specific Soldier. Only a callback can be tied to an event Id, so when this is called again on the same Id, the new callback reference will override previous one. Callback Ids are specified at this page.	2.1.0	▲ 472
void	setInVehicle	Teleport the soldier inside the specified vehicle.	2.1.0	▲ 353
void	setNotAlerted	Force concludes the alert state of the soldier	2.1.0	▲ 324
void	setOnFire	Sets the current soldier on fire. Notice: The fire does not damage the soldier.	2.1.0	▲ 448
void	setPlayer	Force a soldier to be controlled by the player. Notice: This only works for soldiers and AIs that have been spawned (or are controlled) by current player's machine	2.1.0	▲ 424
void	setPose	Sets the soldier's pose based on the given integer. The soldier will strictly follow the assigned pose until resetPose is called	2.1.0	▲ 357
void	stop	Stops the soldier by resetting the cover position to the current position.	2.1.0	▲ 318
void	stopAlert	Pauses the soldier's alert state. Notice: the difference between this and setnotalerted is that this one just pauses the alert state, while the other one stops	2.1.0	▲ 389
void	stopIncapacitate	Stops a soldier from being incapacitated	2.1.0	▲ 564
void	stopSurrendering	Cancel soldier surrendering action	2.1.0	▲ 339
void	surrender	Force surrender the current soldier	2.1.0	▲ 460
bool	triggerCallback	Force the triggering of a callback set trough setCallback on a specific Soldier	2.1.0	▲ 443
void	wearHeadgear	Puts a headgear on the soldier, replacing the one they are wearing.	2.1.0	▲ 62
void	wearUniform	Changes the uniform the soldier is wearing.	2.1.0	▲ 79
void	wearVest	Puts a vest on the soldier, replacing the one they are wearing.	2.1.0	▲ 75

Squad

Class to handle a Squad controlling multiple Soldiers.

Return	Function Name	Description	Since	Vote
bool	addSoldier	Add a Soldier to a squad	2.1.0	▲ 420
void	alertEnemies	Alert all enemies of the presence of the squad for some time	2.1.0	▲ 378
void	attackFromPoint	Orders the squad to attack from the specified waypoint within the given radius.	2.1.0	▲ 343
void	boardVehicle	Orders the squad to board the specified vehicle.	2.1.0	▲ 339
void	cancelRadioRequest	Cancels any active radio request by the squad.	2.1.0	▲ 310
void	charge	Orders the squad to charge towards the specified position within the given radius.	2.1.0	▲ 422
void	coverArea	Orders the squad to cover an area defined by a center position and radius.	2.1.0	▲ 285
void	fireAtWill	Orders the squad to fire at will, canceling the stealth "hold fire" order, optionally playing an order animation.	2.1.0	▲ 358
void	followLeader	Orders the squad to follow their leader, optionally playing an order animation.	2.1.0	▲ 400
void	getAllMembers	Get all soldiers inside the squad	2.1.0	▲ 330
Soldier	getLeader	Get reference to the Squad Leader	2.1.0	▲ 359
Soldier	getMechanic	Get reference to the Squad Mechanic	2.1.0	▲ 470
Soldier	getMedic	Get reference to the Squad Medic	2.1.0	▲ 427
vec3	getObjectivePosition	Returns the position of the squad's current objective, or the leader's position if none is set.	2.1.0	▲ 297
float	getObjectiveRadius	Returns the radius of the squad's current objective area, or a default value if none exists.	2.1.0	▲ 301
Soldier	getRadioman	Get reference to the Squad Radioman	2.1.0	▲ 475
integer	getSquadSize	Returns how many soldiers the squad is made of, including the ones no longer alive. Use hasAliveMembers or getAllMembers when you need the current strength.	2.1.0	▲ 55
bool	hasAliveMembers	Returns whether the squad has any alive members.	2.1.0	▲ 336
bool	hasFullySpawned	When using in-game Spawn Manager, spawning a squad can take a few instants. This function can be used to check whenever a squad has fully spawned	2.1.0	▲ 343
bool	hasObjective	Returns whether the squad has an assigned objective.	2.1.0	▲ 384
void	holdFire	Orders the squad to hold fire and move stealthy, optionally playing an order animation.	2.1.0	▲ 334
bool	isPlayerInSquad	Check if Player is inside a squad	2.1.0	▲ 401
void	leaveVehicle	Orders the squad to leave the specified vehicle. The force flag determines whether the leave order is forced.	2.1.0	▲ 312
void	moveTo	Orders the squad to hold an area at the specified position with the given radius. Make sure that the squad can follow order, and eventually that the squad leader AI has give order feature disabled to avoid squad leader to override your orders	2.1.0	▲ 360
bool	removeSoldier	Remove a Soldier from a Squad (Soldier will be put on a new Squad)	2.1.0	▲ 480
void	repairVehicle	Orders the squad to repair the specified vehicle.	2.1.0	▲ 382
void	setClosestObjective	Orders the squad to set their objective to the closest available one.	2.1.0	▲ 386
void	setRandomObjective	Orders the squad to set a random objective.	2.1.0	▲ 415

Vehicle

Functions to handle vehicle spawning and behavior.

Return	Function Name	Description	Since	Vote
void	addNewItemToCargo	Puts an item in the vehicle's cargo: ammo boxes, magazines, bandages, weapons, anything with an id in the items database. Online the change is sent to the owner of the vehicle and to whoever sits inside.Items of a DLC the executing player does not own are skipped with a line in the F3 console. Nothing is added when the cargo has no room.	2.1.0	▲ 418
void	brake	Applies the brakes, bringing the vehicle to a stop.	2.1.0	▲ 58
bool	canBeRepaired	Checks if the vehicle can be repaired	2.1.0	▲ 303
bool	canPlayEnterAnimation	Tells whether a soldier boarding the vehicle can play the climbing-in animation, which requires a free animated entry point.	2.1.0	▲ 65
any	canRecieveDamage	Checks if the vehicle can recieve any form of damage.	2.1.0	▲ 377
bool	canRefillAmmo	Checks if is possible to refill ammo for the vehicle	2.1.0	▲ 397
bool	canShootInDirection	Checks if someone on the vehicle can shoot in that direction	2.1.0	▲ 310
bool	cargoContainsItem	Check if vehicle inventory contains a specific item	2.1.0	▲ 325
integer	countEmptySeats	Counts the empty seats in the vehicle	2.1.0	▲ 292
integer	countItems	Count how many items with a specific Id are found inside the inventory of the vehicle	2.1.0	▲ 282
any	countPeopleInside	Counts all the people inside the vehicle	2.1.0	▲ 317
void	damage	Apply damage to the hull of a vehicle	2.1.0	▲ 402
void	damageEngine	Damage vehicle engine (if any)	2.1.0	▲ 340
void	damageFuelTank	Damage vehicle fuel tank (if any)	2.1.0	▲ 373
void	damageHull	Damages the vehicle's hull by the given amount, without touching engine, tracks or fuel tank.	2.1.0	▲ 60
void	damageTracks	Damage vehicle tracks and/or wheels (if any)	2.1.0	▲ 287
void	destroy	Disable the vehicle forever	2.1.0	▲ 409
float	getDamage	Check life amount of a vehicle (hull integrity)	2.1.0	▲ 375
Soldier	getDriver	Get reference to the Soldier driving the vehicle	2.1.0	▲ 338
float	getEngineDamage	Check life amount of a vehicle engine (engine integrity)	2.1.0	▲ 339
string	getFaction	Get faction Id of the vehicle	2.1.0	▲ 418
float	getFueltankDamage	Check life amount of vehicle fuel tank	2.1.0	▲ 256
Soldier	getGunner	Get reference to a soldier controlling a turret of the vehicle	2.1.0	▲ 338
Soldier	getLeader	Get reference of the soldier in the commanding seat of the vehicle	2.1.0	▲ 326
string	getName	Returns the vehicle's display name.	2.1.0	▲ 60
Soldier	getPassengers	Get all passengers of the vehicle	2.1.0	▲ 332
vec3	getPosition	Get the world position of the vehicle	2.1.0	▲ 503
float	getTracksDamage	Check life amount of vehicle tracks/wheels	2.1.0	▲ 316
integer	getUniqueId	Get unique identifier for the vehicle. This is useful to check if a vehicle already exist, or to find specific vehicle with findVehicle, especially across the network or between different phases.	2.1.0	▲ 411
bool	hasDriver	Checks if the vehicle has a driver	2.1.0	▲ 345
void	holdPosition	The vehicle stays where it is, as a sentinel, within radius metres of its current position. Same as moveTo with the vehicle's own position.	2.1.1	▲ 41
bool	isArtilleryVehicle	Checks if the vehicle has any seat to be considered artillery	2.1.0	▲ 306
bool	isBraking	Checks if the vehicle is braking	2.1.0	▲ 288
bool	isDestroyed	Check if vehicle is fully destroyed	2.1.0	▲ 328
bool	isDriverAlive	Checks if there's a driver and is alive	2.1.0	▲ 343
bool	isEmpty	Check if vehicle is empty (No units are left inside)	2.1.0	▲ 374
bool	isFull	Check if vehicle seats are all occupied	2.1.0	▲ 333
bool	isLocked	Check whenever a vehicle can be entered or leaved	2.1.0	▲ 308
bool	isMine	Check whenever I have network authority over a vehicle	2.1.0	▲ 469
void	kickEveryoneOut	Force everyone to leave the vehicle	2.1.0	▲ 324
void	kickUnits	Force specific units to leave the vehicle	2.1.0	▲ 335
void	moveTo	Orders the AI crew to drive the vehicle to a position and keep it within radius metres of it. The gunners keep engaging whatever they see, so a tank parked this way still fights: it just does not leave the spot.Under the hood this is the same hold area order the crew squad gets from squad.moveTo, applied to the squad sitting in the vehicle. squad.followLeader() on that squad releases it. The crew keeps driving around inside the radius, so use a small radius (3-5 m) for a sentinel and a bigger one for a patrol area.	2.1.1	▲ 43
bool	playerIsInside	Check if the LOCAL player is currently inside this vehicle	2.1.0	▲ 92
void	removeItemFromCargo	Remove an item from the cargo of the vehicle	2.1.0	▲ 320
void	repair	Set vehicle to fully repaired. Notice: This works only on vehicles that are not fully destroyed	2.1.0	▲ 407
bool	resetCallback	Unassign a callback by it's Id on a specific Vehicle	2.1.0	▲ 467
void	resetCallbacks	Unassign all callbacks on a specific Vehicle	2.1.0	▲ 422
bool	setCallback	Register a callback for a specific event Id on a specific Vehicle. Only a callback can be tied to an event Id, so when this is called again on the same Id, the new callback reference will override previous one. Callback Ids are specified at this page.	2.1.0	▲ 341
bool	triggerCallback	Force the triggering of a callback set trough setCallback on a specific Vehicle	2.1.0	▲ 506