Scripting API

AiParams ▼

Class that handles AI parameters management.

Return	Function Name	Description	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.	▲ 243
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	▲ 228
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	▲ 239
void	allowDoMedic	When this function is enabled, if a soldier has medic equipments in his inventory he will proceed to heal nearby units	▲ 199
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	▲ 227
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	▲ 214
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	▲ 214
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	▲ 234
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	▲ 216
void	allowOpenWindows	When enabled, AI will open windows that blocks it's vision, for example when in cover behind a window	▲ 235
void	allowRadioOrders	When enabled and if radioman, AI will communicate radio orders requested by squad leader	▲ 208
void	enableAiBehaviour	This function enables or disbales all AI functionalities toghether, including: allowChangePose, allowCheckForEnemies, allowFindCoverWhenSuppressed, allowLeaveVehicle, allowMovements, allowOpenWindows, allowOrders and allowRadioOrders	▲ 263
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	▲ 129
void	followCustomDirectCommands	Disable various AI behaviors in order to prepare the soldier to follow direct commands, such as soldier.moveTo()	▲ 257
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()	▲ 223
string	getName	Return the name of the vehicle	▲ 197
void	setTargetPlanesOften	Enable this feature to force the AI to target planes, if closer than any other spotted enemy	▲ 247

Base Functions ▼

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

Return	Function Name	Description	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	▲ 231
float	distance	The distance between 2 Vector3 points in meters	▲ 195
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	▲ 207
void	print	Display a message on the screen	▲ 370
float	round	Round a number to a specific quantity to decimal points	▲ 307
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	▲ 240
Soldier	spawnHuman	Spawn a new human without specific loadout or rank. Faction Ids can be acquired in the Script Settings menu -> Id tables section	▲ 203
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.	▲ 276
Soldier	spawnSoldier	Spawn an AI soldier. Faction Ids and loadout Ids can be acquired in the Script Settings menu -> Id tables section	▲ 227
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	▲ 214
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	▲ 220
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	▲ 218
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	▲ 433
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	▲ 325
Vehicle	spawnVehicle	Spawn a vehicle. Vehicle Ids can be acquired in the Script Settings menu -> Id tables section	▲ 208
Vehicle	spawnVehicle_camo	Spawn a vehicle with a specified camo. Vehicle Ids can be acquired in the Script Settings menu -> Id tables section	▲ 322
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	▲ 254
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	▲ 207
void	waitForAny	Pause the execution of the script until any of the given conditions are met.	▲ 223
void	waitUntil	Pause the execution of the script until one or multiple conditions are met.	▲ 271

er2 ▼

General utility and helper functions.

Return	Function Name	Description	Vote
void	addInvadersTickets	Adds tickets to the current invaders faction.	▲ 198
vec3	cameraPosition	Get the world position of the camera	▲ 217
void	clearAllRunOnJoin	Clear all buffered requests to run a script locally for joining users	▲ 163
integer	countAliveDefenders	Get the count of all the currently alive defenders	▲ 225
integer	countAliveInFaction	Get the count of all the currently alive units on a specific faction	▲ 243
integer	countAliveInvaders	Get the count of all the currently alive invaders	▲ 284
integer	countDeceasedDefenders	Count how many defenders are deceased during the mission	▲ 219
integer	countDeceasedInvaders	Count how many invaders are deceased during the mission	▲ 225
integer	countLostVehiclesDefenders	Count how many defenders have been captured during the mission	▲ 212
integer	countLostVehiclesInvaders	Count how many invaders have been captured during the mission	▲ 134
integer	countPrisonersDefenders	Count how many vehicles have been lost by the defenders during the mission	▲ 197
integer	countPrisonersInvaders	Count how many vehicles have been lost by the invaders during the mission	▲ 210
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.	▲ 210
void	explosion	Generates an explosion	▲ 347
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	▲ 212
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	▲ 252
void	getAllObjectives	Get all Mission Objectives in the current phase.	▲ 242
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.	▲ 201
void	getAllVehicles	Get all vehicles around the map	▲ 202
string	getBattleName	Returns the current battle's name	▲ 240
Number	getCurrentPhaseId	Get the Id of the current phases.	▲ 199
string	getDefendersFaction	Get the Id for the defenders faction	▲ 212
float	getDistanceFromTerrain	Returns the distance between the given position and the terrain.	▲ 225
string	getInvadersFaction	Get the Id for the invaders faction	▲ 214
integer	getInvadersTicket	Returns the number of tickets left by the invaders	▲ 191
string	getMapName	Returns the name of the map of the current battle	▲ 225
string	getMyNickname	Get nickname of the local user	▲ 306
Objective	getNearestObjective	Get the nearest Mission Objective to a specific location	▲ 161
Squad	getNearestSoldier	Get nearest soldier to a specific location	▲ 216
Vehicle	getNearestVehicle	Get nearest vehicle from a specific location	▲ 197
string	getNickname	Get nickname of an online player	▲ 181
Soldier	getPlayer	Find a reference to the Soldier controlled by the player	▲ 214
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.	▲ 271
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.	▲ 208
integer	getSettingMaxPlayersDefenders	Get the max allowed amount of Human Players on the defenders faction. Works only during multiplayer matches	▲ 230
integer	getSettingMaxPlayersInvaders	Get the max allowed amount of Human Players on the invaders faction. Works only during multiplayer matches	▲ 225
float	getSettingTicketsMultiplier	Get the tickets multipler set during match creation	▲ 293
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.	▲ 217
float	getTerrainHeight	Returns the terrain height from sea level of the given x and z coordinates.	▲ 224
void	getVehiclesInArea	Get all vehicles within a specific area	▲ 199
bool	isAllied	Check if a given faction Id is part of Allies faction	▲ 200
bool	isAxis	Check if a given faction Id is part of Axis faction	▲ 216
AiParams	isCivilian	Check if a given faction Id is part of Civilians faction	▲ 223
bool	isInsideMainTerrainBounds	Checks if the given position is inside the terrain bounds	▲ 269
bool	isMasterClient	Check if current user is master client for online match. In an offline mission, the user is always the master client	▲ 290
bool	isOnline	Check if current mission is being played on an online match	▲ 318
bool	isSameFaction	Check if two faction Ids are part of the same faction (Allies or Axis)	▲ 317
Squad	makeSquad	Create a new empty squad. You can add soldiers to this squad in order to make them react to squad orders	▲ 208
bool	nextPhase	Force mission to skip to next phase	▲ 246
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.	▲ 175
void	playClip	Play a global Audio Clip (.wav)	▲ 232
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.	▲ 230
void	playClipOnRadio	Play a global Audio Clip with a radio distortion effect (.wav)	▲ 216
void	playClipOnRadio3D	Play a 3D Audio Clip, coming from a specific location and with a maximum hear distance with a radio distortion effect (.wav)	▲ 222
void	playMusic	Plays a music track globally.	▲ 236
bool	previousPhase	Force mission to skip to previous phase	▲ 256
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.	▲ 216
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	▲ 332
bool	resetCallback	Unassign a callback by it's Id.	▲ 259
void	resetCallbacks	Unassign all global callbacks	▲ 244
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	▲ 240
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	▲ 297
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	▲ 225
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	▲ 255
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.	▲ 326
bool	setPhase	Changes the current phase to the one of index order	▲ 273
void	setRaining	Activates the rain on the map. To synchronize the weather changes to other clients you can use synchWeather.	▲ 310
void	setSnowing	Activates the snow on the map. To synchronize the weather changes to other clients you can use synchWeather.	▲ 245
void	setTaskTextDefenders	Set task text for defenders	▲ 130
void	setTaskTextInvaders	Set task text for invaders	▲ 148
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	▲ 255
void	setTimeOfDay	Sets the current time of day of the mission. NOTE: This function is CPU heavy	▲ 306
void	setVictoryDefenders	Concludes the mission declaring defenders as winners	▲ 453
void	setVictoryInvaders	Concludes the mission declaring invaders as winners	▲ 203
void	showObjective	Display a new objective text	▲ 236
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.	▲ 178
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	▲ 218
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	▲ 227
bool	triggerCallback	Force the triggering of a callback set trough setCallback	▲ 288

global ▼

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

Return	Function Name	Description	Vote
any	get	Get the value of a stored global variable	▲ 265
any	myplayerget	Get the value of a stored global variable by my player.	▲ 203
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.	▲ 180
any	playerget	Get the value of a stored global variable by a specific player.	▲ 248
void	set	Set a global variable that can be referenced from any script and by any player in the room	▲ 318

Objective ▼

Functions related to mission objective areas and markers.

Return	Function Name	Description	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	▲ 210
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	▲ 332
vec3	getPosition	Get the world position of the Mission Objective	▲ 332
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	▲ 219
float	getRadius	Get the area radius of the Mission Objective	▲ 304
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.	▲ 203
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.	▲ 225
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	▲ 205
bool	isInside	Check whenever a vec3() position is inside a specific Mission Objective, specifically within it's radius from it's center position	▲ 214
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	▲ 204
void	remove	Remove this objective from the current Mission Phase. Just like setting properties, only the master client can call do this operation	▲ 239
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	▲ 221
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	▲ 214
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.	▲ 258
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	▲ 217
void	setPosition	Update the world position of a Scripted Mission Objective	▲ 218
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	▲ 244
void	setRadius	Update the area radius of a Scripted Mission Task	▲ 168
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	▲ 224
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.	▲ 211

Soldier ▼

Functions related to player actions and properties.

Return	Function Name	Description	Vote
bool	addAmmo	Adds an ammo box to the soldier's invetory	▲ 238
bool	addMagazine	Adds a magazine to the soldier's invetory.	▲ 247
bool	addNewItem	Adds an item to the soldier's inventory	▲ 250
void	alertFor	Puts the soldier in an alert state for a defined time	▲ 218
void	applyBleeding	Applies bleed status to the soldier	▲ 203
void	boardVehicle	Order the soldier to approach and borar onto the specified vehicle if available.	▲ 243
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.	▲ 193
void	carryBody	Force the soldier to carry a another incapacitated soldier	▲ 263
void	damageSoldier	Apply damage to a soldier	▲ 187
void	decreaseStamina	Decreases soldier's stamina	▲ 290
void	disableHitByVehicleFor	Disable receiving damage from impacts with vehicles for some time	▲ 290
bool	doingMelee	Check if the soldier is doing a melee attack	▲ 197
void	executeOrdersRoutine	Executes the routine to process squad orders for the soldier.	▲ 182
void	findCover	Finds a cover position near a specified position within a given radius.	▲ 226
bool	forceTarget	Force a Soldier to target a specific Soldier or Vehicle.	▲ 245
AiParams	getAiParams	Access AI parameters management	▲ 244
Soldier	getCarriedBody	Get a reference to the incapacitated soldier carried by this unit	▲ 303
string	getClassName	Returns the soldier's class name	▲ 240
Vehicle	getCurrentVehicle	Returns the current vehicle the soldier is in	▲ 222
float	getDistanceFromGround	Get the distance between the soldier and the ground below	▲ 201
vec3	getFacePosition	Get the world position of soldier's face	▲ 220
string	getFaction	Gets the soldier's faction ID	▲ 277
vec3	getFireDirection	Return a vector representing the direction where the gun held by the soldier is pointed to	▲ 219
string	getHeadgearId	Returns the current wearing headgear Id	▲ 217
float	getHealth	Get the soldier's health	▲ 195
vec3	getMoveDirection	Returns the moving direction of the soldier	▲ 208
string	getName	Returns the soldier's full name	▲ 312
Soldier	getNearestInjured	Get the nearest wounded soldier around the current one	▲ 197
Vehicle	getNearestVehicleToRepair	Returns the nearest vehicle that requires repair from the current soldier	▲ 205
void	getOffVehicle	Kicks the soldier from the current vehicle	▲ 212
string	getOwnerId	Get Id of the online player controlling this soldier (Including AIs being controlled by his machine).	▲ 234
vec3	getPosition	Get world position of the soldier	▲ 322
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	▲ 202
float	getSuppressionValue	Checks the suppression value of the soldier from the enemy fire.	▲ 190
string	getUniformId	Get the Id of the uniform worn by the soldier	▲ 192
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.	▲ 216
Vehicle	getVehicleSoldierIsExitingFrom	Get the vehicle the current soldier is exiting from	▲ 204
vec3	getVelocity	Returns the current soldier's velocity	▲ 211
string	getVestId	Get the Id of the vest worn by the soldier	▲ 309
bool	hasHeadgear	Check if the the soldier is wearing an headgear	▲ 271
bool	hasRadio	Check if a soldier is wearing a radio	▲ 314
bool	hasVest	Check if a soldier is wearing a vest	▲ 186
void	healSoldier	Heals soldier of a certain amount	▲ 202
void	incapacitate	Force incapacitate a soldier	▲ 253
bool	isAI	Checks if the current soldier is controlled by the AI	▲ 295
bool	isAiming	Checks if the current soldier is aiming the gun	▲ 258
bool	isAlerted	Check if the soldier has spotted an enemy recently and is moving carefully	▲ 281
bool	isAlive	Checks if the current soldier is alive	▲ 250
bool	isAllied	Check if current soldier is part of Allies faction	▲ 345
bool	isAmmoBoxCarrier	Check if soldier is carrying an ammo box	▲ 262
bool	isATSoldier	Returns true if the current soldier is an Anti-Tank unit	▲ 250
bool	isAxis	Check if current soldier is part of Axis faction	▲ 324
bool	isBleeding	Check if the soldier is bleeding	▲ 245
bool	isCarried	Returns true if the current soldier is getting carried	▲ 281
bool	isCarryingBody	Check if the current soldier is carrying an incapacitated soldier	▲ 257
bool	isCharging	Returns true if the current soldier is charging	▲ 257
AiParams	isCivilian	Check if current soldier is part of Civilians faction	▲ 293
bool	isCrawling	Returns true if the current soldier is crawling	▲ 245
bool	isDead	Check if a soldier is dead	▲ 246
bool	isEnteringVehicle	Returns true if the current soldier has started the entering vehicle animation	▲ 235
bool	isExitingVehicle	Returns true if the current soldier has started the exiting vehicle animation	▲ 264
bool	isFallingFromParachute	Checks if the current soldier is falling with a parachute	▲ 223
bool	isFlameThrowerCarrier	Check if a soldier is a flamethrower carrier	▲ 186
bool	isFromChargingFaction	Check if the soldier can execute a charge order	▲ 199
bool	isGrounded	Returns true if the soldier is on the ground	▲ 406
bool	isIncapacitated	Check if a soldier is incapacitated	▲ 203
bool	isInsideVehicle	Check if the soldier is inside a vehicle	▲ 202
bool	isJumping	Returns true if the current soldier is jumping	▲ 204
bool	isMarksman	Returns true if the current soldier is a Marksman	▲ 156
bool	isMechanic	Returns true if the current soldier is a mechanic	▲ 266
bool	isMedic	Returns true if the current soldier is a medic	▲ 218
bool	isMine	Check whenever I have network authority over a soldier	▲ 274
bool	isMoving	Returns true if the current soldier is moving	▲ 217
bool	isOnCover	Check if a soldier is taking cover	▲ 250
bool	isOnFire	Returns true if the current soldier is on fire	▲ 219
bool	isOnWater	Check if a soldier is walking inside water	▲ 241
bool	isOutOfStamina	Returns true if the current soldier is out of stamina	▲ 186
bool	isPlayer	Check if the soldier is a player	▲ 220
bool	isPlayerFPS	Returns true if the current soldier is a player and in first person	▲ 208
bool	isRadioman	Check if the current soldier is a Radioman	▲ 258
bool	isReachingVehicleToMount	Check if a soldier is on his way to mount inside a vehicle	▲ 229
bool	isReloading	Returns true if the current soldier is reloading a weapon	▲ 265
bool	isRunning	Returns true if the current soldier is running	▲ 284
bool	isSameFaction	Check if another soldier is in the same faction of this soldier	▲ 229
bool	isSquadLeader	Returns true if the current soldier is the Squad Leader	▲ 212
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	▲ 203
bool	isStealth	Returns true if the soldier is moving stealthly	▲ 207
bool	isSuppressed	Checks if the soldier is being suppressed	▲ 138
bool	isSurrendering	Check if the soldier is surrendering	▲ 246
bool	isTalking	Returns true if the current soldier is talking	▲ 232
bool	isThrowing	Returns true if the current soldier is throwing something	▲ 217
bool	isTowardWall	Returns true if the current soldier is facing a wall	▲ 227
bool	isUsingVehicleTurret	Check if soldier is operating a turret	▲ 198
void	jump	Makes the soldier jump. Notice: the jump movement is based on the current soldier velocity and direction.	▲ 214
void	killSoldier	Kills the soldier	▲ 238
void	leaveVehicle	Commands the soldier to eject from the current vehicle.	▲ 224
void	moveTo	Moves the soldier to a specified position using CoverPosition with a new DestinationWithoutCover based on the given position and current pose.	▲ 211
Soldier	myself	Can be called within a SoldierBrain script to acquire the soldier controlled by the script	▲ 359
void	pauseAlert	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	▲ 218
void	removeBleeding	Removes bleeding effect from soldier	▲ 227
bool	removeItem	Remove one or multiple items from a soldier invenotory	▲ 196
bool	resetCallback	Unassign a callback by it's Id on a specific Soldier	▲ 326
void	resetCallbacks	Unassign all callbacks on a specific Soldier	▲ 336
void	resetPose	Allow the soldier to automatically choose it's pose, canceling setPose command	▲ 279
void	say	Makes the soldier say a line based on the VoiceClip Enum	▲ 307
void	sayClip	Play a 3D Audio Clip, coming from soldier mouth and with soldier speaking animation (.wav)	▲ 360
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	▲ 234
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.	▲ 319
void	setInVehicle	Teleport the soldier inside the specified vehicle.	▲ 238
void	setNotAlerted	Force concludes the alert state of the soldier	▲ 216
void	setOnFire	Sets the current soldier on fire. Notice: The fire does not damage the soldier.	▲ 334
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	▲ 314
void	setPose	Sets the soldier's pose based on the given integer. The soldier will strictly follow the assigned pose until resetPose is called	▲ 255
void	stop	Stops the soldier by resetting the cover position to the current position.	▲ 215
void	stopIncapacitate	Stops a soldier from being incapacitated	▲ 379
void	stopSurrendering	Cancel soldier surrendering action	▲ 240
void	surrender	Force surrender the current soldier	▲ 355
bool	triggerCallback	Force the triggering of a callback set trough setCallback on a specific Soldier	▲ 331

Squad ▼

Class to handle a Squad controlling multiple Soldiers.

Return	Function Name	Description	Vote
bool	addSoldier	Add a Soldier to a squad	▲ 291
void	alertEnemies	Alert all enemies of the presence of the squad for some time	▲ 262
void	attackFromPoint	Orders the squad to attack from the specified waypoint within the given radius.	▲ 233
void	boardVehicle	Orders the squad to board the specified vehicle.	▲ 218
void	cancelRadioRequest	Cancels any active radio request by the squad.	▲ 198
void	charge	Orders the squad to charge towards the specified position within the given radius.	▲ 300
void	coverArea	Orders the squad to cover an area defined by a center position and radius.	▲ 191
void	fireAtWill	Orders the squad to fire at will, canceling the stealth "hold fire" order, optionally playing an order animation.	▲ 255
void	followLeader	Orders the squad to follow their leader, optionally playing an order animation.	▲ 212
void	getAllMembers	Get all soldiers inside the squad	▲ 220
Soldier	getLeader	Get reference to the Squad Leader	▲ 272
Soldier	getMechanic	Get reference to the Squad Mechanic	▲ 363
Soldier	getMedic	Get reference to the Squad Medic	▲ 315
vec3	getObjectivePosition	Returns the position of the squad's current objective, or the leader's position if none is set.	▲ 187
float	getObjectiveRadius	Returns the radius of the squad's current objective area, or a default value if none exists.	▲ 202
Soldier	getRadioman	Get reference to the Squad Radioman	▲ 333
bool	hasAliveMembers	Returns whether the squad has any alive members.	▲ 204
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	▲ 230
bool	hasObjective	Returns whether the squad has an assigned objective.	▲ 264
void	holdFire	Orders the squad to hold fire and move stealthy, optionally playing an order animation.	▲ 217
bool	isPlayerInSquad	Check if Player is inside a squad	▲ 291
void	leaveVehicle	Orders the squad to leave the specified vehicle. The force flag determines whether the leave order is forced.	▲ 198
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	▲ 239
bool	removeSoldier	Remove a Soldier from a Squad (Soldier will be put on a new Squad)	▲ 348
void	repairVehicle	Orders the squad to repair the specified vehicle.	▲ 272
void	setClosestObjective	Orders the squad to set their objective to the closest available one.	▲ 256
void	setRandomObjective	Orders the squad to set a random objective.	▲ 291

Vehicle ▼

Functions to handle vehicle spawning and behavior.

Return	Function Name	Description	Vote
void	addNewItemToCargo	Add a new item to the cargo of the vehicle	▲ 299
bool	canBeRepaired	Checks if the vehicle can be repaired	▲ 191
any	canRecieveDamage	Checks if the vehicle can recieve any form of damage.	▲ 256
bool	canRefillAmmo	Checks if is possible to refill ammo for the vehicle	▲ 277
bool	canShootInDirection	Checks if someone on the vehicle can shoot in that direction	▲ 210
bool	cargoContainsItem	Check if vehicle inventory contains a specific item	▲ 216
integer	countEmptySeats	Counts the empty seats in the vehicle	▲ 199
integer	countItems	Count how many items with a specific Id are found inside the inventory of the vehicle	▲ 172
any	countPeopleInside	Counts all the people inside the vehicle	▲ 212
void	damage	Apply damage to the hull of a vehicle	▲ 306
void	damageEngine	Damage vehicle engine (if any)	▲ 226
void	damageFuelTank	Damage vehicle fuel tank (if any)	▲ 263
void	damageTracks	Damage vehicle tracks and/or wheels (if any)	▲ 190
void	destroy	Disable the vehicle forever	▲ 310
void	dropInfantry	Kicks all the soldier seated in the passenger seats	▲ 221
void	emptyAllTurrets	Empties the magazines of all the turrets in the vehicle	▲ 249
float	getDamage	Check life amount of a vehicle (hull integrity)	▲ 258
Soldier	getDriver	Get reference to the Soldier driving the vehicle	▲ 228
float	getEngineDamage	Check life amount of a vehicle engine (engine integrity)	▲ 230
string	getFaction	Get faction Id of the vehicle	▲ 312
float	getFueltankDamage	Check life amount of vehicle fuel tank	▲ 160
Soldier	getGunner	Get reference to a soldier controlling a turret of the vehicle	▲ 211
Soldier	getLeader	Get reference of the soldier in the commanding seat of the vehicle	▲ 220
Soldier	getPassengers	Get all passengers of the vehicle	▲ 220
vec3	getPosition_vehicle	Get the world position of the vehicle	▲ 391
float	getTracksDamage	Check life amount of vehicle tracks/wheels	▲ 205
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.	▲ 304
bool	hasDriver	Checks if the vehicle has a driver	▲ 219
bool	isArtilleryVehicle	Checks if the vehicle has any seat to be considered artillery	▲ 202
bool	isBraking	Checks if the vehicle is braking	▲ 182
bool	isDestroyed	Check if vehicle is fully destroyed	▲ 224
bool	isDriverAlive	Checks if there's a driver and is alive	▲ 218
bool	isEmpty	Check if vehicle is empty (No units are left inside)	▲ 256
bool	isFull	Check if vehicle seats are all occupied	▲ 216
bool	isLocked	Check whenever a vehicle can be entered or leaved	▲ 191
bool	isMine	Check whenever I have network authority over a vehicle	▲ 357
void	kickEveryoneOut	Force everyone to leave the vehicle	▲ 235
void	kickUnits	Force specific units to leave the vehicle	▲ 235
void	removeItemFromCargo	Remove an item from the cargo of the vehicle	▲ 217
void	repair	Set vehicle to fully repaired. Notice: This works only on vehicles that are not fully destroyed	▲ 304
bool	resetCallback	Unassign a callback by it's Id on a specific Vehicle	▲ 334
void	resetCallbacks	Unassign all callbacks on a specific Vehicle	▲ 315
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.	▲ 262
bool	triggerCallback	Force the triggering of a callback set trough setCallback on a specific Vehicle	▲ 325