Clears all the resources for each budget and recalculate their values 

Clears all the budget weights that have been previously added 

Clear the given budget's account of all of its resources. 

Example budget names are BUDGET_Units, BUDGET_Tech, BUDGET_Addon and BUDGET_Secure Example: AI_ClearBudgetTotal( player4, "BUDGET_Tech" )

Clear the build demand table 

Clear all class preferences that have been set up both class and anti-class 

This clears the importance override on this military point 

Clears all PBG limits that were previously set 

Clears the attack request for this player. This player will now attack any enemies.  

Run this string in the AI of player 

Enables/Disables an AI player 

Enables/Disables all AI players 

Enables/disables a component of the AI 

Components:
COMPONENT_Attacking
COMPONENT_Defending
COMPONENT_ForwardDefending
COMPONENT_Resourcing
COMPONENT_BuildUnits
COMPONENT_BuildStructures
COMPONENT_BuildResearch
COMPONENT_Securing
COMPONENT_BuildAddOns COMPONENT_Tactics

enables or disables an AI player option (currently options are: AIOPT_Retreat) 

Tells the AI to take all of its units and forces them to attack the given player immediately 

Gets the difficulty level of this AI player 

Levels can be one of: AD_Easy, AD_Standard, AD_Hard, AD_Hardest

Returns true if player is an AI player 

Returns true if player is a AIPlayer and is enabled 

Locks the entity and disables its tactics (if any) and the AI will no longer use this object 

Lock an SGroup from the ai_player 

Locks the squad and disables its tactics (if any) and the AI will no longer use this object 

Offset the anticlass preference to increase the demand for certain unit anticlasses 

Classname can be: aiclass_infantry, aiclass_light_vehicle, aiclass_heavy_vehicle as defined in the AE under type_ai_class

Sets the given budget to the given weight 

Example budget names are BUDGET_Units, BUDGET_Tech, BUDGET_Addon and BUDGET_Secure Example: AI_SetBudgetWeight( player4, "BUDGET_Tech", 50 )

Sets the demand for this squadasd 

Set a build order table for the ai_player 

An example build table:
local build_table =
{
 {SBP.ALLIED_RIFLEMEN, 1, 5},
 {SBP.ALLIED_TANKTHINGY, 2, 3}
}
The first number in each entry is the starting value -- the lowest number gets built first
The second number is the increment that happens each time the unit is built
NOTE: Setting build demand table clobbers the class preferences

Offset the class preference to increase the demand for certain unit class 

Classname can be: aiclass_infantry, aiclass_light_vehicle, aiclass_heavy_vehicle as defined in the AE under type_ai_class

Set the difficulty level of this AI player 

Levels ca be one of: AD_Easy, AD_Standard, AD_Hard, AD_Hardest

This overrides the default importance of the given military point 

Sets a limit to a PBG type (buildings, squads, upgrades, etc) 

Set limits to the production items that an AI can build 

An example production limites table:
local production_limits_table =
{
 {SBP.ENGINEER_SQUAD, 2},
 {EBP.ALLIED_BARRACKS, 0}
 {UPG.ALLIED_MINESWEEPER, 0}
}
The first argument is the table is the blueprint, and second: the number of those items the AI can build

Tells the AI to attack only the given player. 

Set the victory point percentage - how much should we prefer victory points over resource points? Percentage should be between 0.0 and 1.0. 1.0 means 100 percent. 0.5 means choose equally between victory points and other kinds of points. 

Unlocks this entity so that AI can use it again 

Unlock an SGroup from the ai_player 

Unlocks the given squad so the AI can use it again 

Re-updates the AI in regards to all the static objects in the world (if SCAR creates new strategic points dynamically this will need to be called) 

Creates the maximum number of squads of this loadout given the resources at a marker position and adds them to a squadgroup. The squadgroup will be created if it doesnt exist. 

Loadout will be clipped to unitMin and unitMax from the squad blueprint.

Set the Lua Function used to initialize each Balance Tool iteration.  

The function is used to set up the forces that will battle

write all battle simulation result 

start battle simulation screen.  

record one sentence of battle sim result 

Returns an entity property bag group. 

Returns an ID that uniquely identifies this pbg. NOTE: this is an arbitrary 32bit ID, and does not start from 0. 

Returns a medal property bag group. 

Return the path name of the group 

Example name would be "abilities\ally_mad_minute_ability"

Return the number of property bag groups of the same type 

Example type would be PBG_Critical

Return the path name of the group 

Example name would be "abilities\ally_mad_minute_ability"

Returns a squad property bag group. 

Return whether a blueprint exists at this path 

Returns true if an entity blueprint exists with the given name. 

Returns true if a squad blueprint exists with the given name. 

Procedurally rotates the camera around a target. Camera input will be disabled. distance is in meters, declination is in degrees, speed is in degrees/sec. 

Clamps the camera's target position to a marker 

Print current camera settings. 

Camera would move to the specified position. bPan is a boolean flag that pans the camera if set to true 

Focus the Camera on the specificed position 

Set the camera to follow the first entity in an EGroup. 

The camera will follow it until the player takes control again.

Camera will follow specified entity 

Camera would follow current selection 

Set the camera to follow the first squad in an SGroup. 

The camera will follow them until the player takes control again.

Camera will follow specified squad 

Get the current camera declination (tilt) 

Get the current camera orbit (rotation) 

Get the current target position for the camera. 

Get values: TV_SlideTargetRate, TV_SlideTargetBase, TV_SlideTargetThreshold 

Get the current zoom distance for the camera. 

Returns whether the camera distance, orbit and declination are close to default values 

Returns the enabled/disabled state of the camera input. 

Locks the camera to an EGroup's position and orientation (first entity), and a fixed arbitrary declination/distance (or -1 to allow user input)  

Locks the camera to an entity's position and orientation, and a fixed arbitrary declination/distance (or -1 to allow user input) 

Locks the camera to an SGroup's position and orientation (first entity), and a fixed arbitrary declination/distance (or -1 to allow user input)  

Move the camera to an EGroup's location. The optional pan flag should be true if you want the camera to glide to the new location. You can specify a pan rate to use (use SLOW_CAMERA_PANNING for a default slower rate) 

This function can be called through a CTRL object in NISlets.

Move the camera to desired location. The optional pan flag should be true if you want the camera to glide to the new location. You can specify a pan rate to use (use SLOW_CAMERA_PANNING for a default slower rate) 

This function canNOT be called through a CTRL object in NISlets.

Slightly refocus the camera to rest on a position if it's close by. 

This function can be called through a CTRL object in NISlets.

Move the camera to an SGroup's location. The optional pan flag should be true if you want the camera to glide to the new location. You can specify a pan rate to use (use SLOW_CAMERA_PANNING for a default slower rate) 

This function can be called through a CTRL object in NISlets.

Camera is no longer locked to an entity 

Reload all cameras' tuning values 

Clears state info related to camera focus 

Reset camera position to default home position 

Set the current camera declination (tilt) 

Helper function to set the default camera parameters 

If the parameter is nil, the particular property is not modified

Enables / Disables camera input. 

Set the current camera orbit (rotation) 

Set values: TV_SlideTargetRate, TV_SlideTargetBase, TV_SlideTargetThreshold 

Set the current zoom distance for the camera. 

Stops the camera from procedurally rotating. Input is restored. 

Frees up the camera (so it's not clamped to a marker anymore) 

Order a squad group to abandon their current team weapon if they have it and they could (tuning value in attribute editor) 

Sends an ability command to a player, egroup or sgroup. extra parameters are provided if the ability requires them. 

Attach the squad from sgroupnameAttachee to sgroupname. Both SGroups must contain only one squad. 

Issues an attack command to an SGroup 

Order a squad group to attack move to a position (anything whose position can be queried). can be queued, can follow a plan, can search for cover within a radius 

Command attacker sgroup to attack move to strategic point target; when it is capturable, the sgroup would capture it 

Order a squad group to capture team weapon entity group. 

Orders a squad to contruct a building at specified position, or to continue construction on an existing building. 

The command also checks to see if a building already exists at the location, and the squad will continue building it, if it is of the correct type.

Applies critical hit to entity/squad/sgroup/egroup 

Player id doesn't have to be the owner as the applied entities but need to make sure the player is still alive

Detonates a building's demolitions 

Order a squad group to dig in the first position and facing the second position 

Order a squad group to dig out if they are already dug in 

Order a squad group to execute a squad AI plan. pass in nil to execute the default plan. 

Order a squad group to load at a random entity or squad of the group 

overload is a flag that will allow the hold entity to ignore maximum slot check

Order a squad group to dig in instantly at the current position and facing 

This order should only be used in the beginning of missions since it skips all the dig in animation. Also, if any of the squad member is on terrain that doesn't allow dig in, the whole squad would refuse to instant dig in.

Order a squad group to dig out instantly 

See Cmd_Garrison. 

Sends a instant reinforce command to all squads in a group. count represents the number of commands to send. 

Note: This function bypasses pre-reqs, costs and the production queue

Sends a instant reinforce command to all squads in a group. count represents the number of commands to send. spawnlocation is where the reinforced unit will spawn. You can optionally find a hidden position by specifying a checktype (CHECK_OFFCAMERA, CHECK_IN_FOW or CHECK_BOTH), and what to do if a hidden position can't be found (SPAWN_ATMARKER, SPAWN_ATSQUAD, or DO_NOTHING) - SPAWN_ATMARKER is the default. 

Note: This function bypasses pre-reqs and costs and the production queue

Order a squad group to instant setup their team weapon 

Sends an instant upgrade command to a player, egroup or sgroup. accepts a single upgrade or table of upgrades. 

Move a squad group to a given position. 

Supports facing, 'offset' movement, and can find cover. The sgroup can be deleted when in proximity of a marker (it assumes a proximity of 5 if you forget to set one on the marker)

Move a squad group out of a position to a certain radius 

All squads in the group will move away from the centre position from its current position

Moves a squad group to the closest marker in a list/table of MarkerIDs. 

Command attacker sgroup to attack move to strategic point target; when it is capturable, the sgroup would capture it 

Sends a reinforce command to all squads in a group. count represents the number of commands to send. 

Note: To reinforce squad bypassing the pre-reqs and costs use Cmd_InstantReinforceUnit.

Sends a reinforce command to all squads in a group. count represents the number of commands to send. spawnlocation is where the reinforced unit will spawn. You can optionally find a hidden position by specifying a checktype (CHECK_OFFCAMERA, CHECK_IN_FOW or CHECK_BOTH), and what to do if a hidden position can't be found (SPAWN_ATMARKER, SPAWN_ATSQUAD, or DO_NOTHING) - SPAWN_ATMARKER is the default. 

To reinforce squads bypassing the pre-reqs and costs use Cmd_InstantReinforceUnit

Order a squad group to retreat, optionally to a specific location. The sgroup can be deleted when in proximity of a marker (it assumes a proximity of 5 if you forget to set one on the marker) 

Order a squad group to revert occupied building 

Orders a squad group to place demolition charges on a building (egroup). Function does nothing if egroup cannot be detonated, or player can't afford the demolitions 

Sends an camouflage stance command to all squads in a group. stanceid should be the number returned by Util_GetCamouflageStanceID( stancename ) 

Send a command to the squad to follow a path. Can wait at each waypoint. The sgroup can be deleted when in proximity of a marker if you pass in the marker as the 7th argument (it assumes a proximity of 5 if you forget to set one on the marker) 

loop can be: LOOP_NONE, LOOP_NORMAL, LOOP_TOGGLE_DIRECTION

Causes a squad to patrol a marker attacking any enemies that come within its radius. If used on circular markers, the radius must be at least 5. To stop the squad from patrolling the marker, use Cmd_Stop. 

Sends a stop command to egroup or sgroup. 

Orders a squad to surrender and awards the local player with an appropriate number of action points 

The command will also overwrite the exit position as well, if you do not want the squads to exit at the map entry point.

Orders an EGroup or SGroup to kick out its occupants. If no position is specified, the occupants stay at the exit. 

Orders an sgroup to exit the building or vehicle that it's in. If no position is specified, the sgroup stays at the exit. 

Sends an upgrade command to a player, egroup or sgroup. accepts a single upgrade or table of upgrades. 

Send a entity command to a entity group(CMD_DefaultAction, CMD_Stop, CMD_Destroy, CMD_BuildSquad, CMD_CancelProduction, CMD_RallyPoint, CMD_AttackForced) 

Entity commands are mostly used for buildings etc. If you need to issue commands to units, use the Squad_Command function.

Send an entity ability command (CMD_Ability) to an entity 

Send a entity-based command to an entity group. 

Use this function to issue orders that require a entity to an entity group (eg. order a building to attack another building)
See Command_Entity for a list of all the possible entityCommands.

Send a squad command to a squad group with custom data 

Send a position command to an entity group. 

Use this function to issue orders that require a position to an entity group (eg. set a rally point for a building)
See Command_Entity for a list of all the possible entityCommands.

Send a positional ability command (CMD_Ability) to an entity 

Use this function to issue ability orders that require a position to player

Send a positional/directional ability command (CMD_Ability) to an entity 

Use this function to issue ability orders that require a position and a direction to player

Send a dual target (position and squad) command to an entity group. 

Use this function to issue orders that require a position and a squad to an entity group (eg. unloading squad from hold)
See Command_Entity for a list of all the possible entityCommands.

Send a squad-based command to an entity group. 

Use this function to issue orders that require a squad to an entity group (eg. order a building to attack a squad)
See Command_Entity for a list of all the possible entityCommands.

Send a squad command to a entity group with custom data 

Send a player command to a player 

PCMD_Ability

Send a player ability command (PCMD_Ability) to a player 

Send an entity command to a player. 

Send a player command to itself to act upon single with custom parameter and index data (PCMD_CriticalHit) 

This is a special command for SCAR and debug feature

Send a player command to a player with a custom flag 

Send a position command to a player. 

Use this function to issue orders that require a position to player)
See Command_Player for a list of all the possible playerCommands.

Send a positional ability command (PCMD_Ability) to a player 

Use this function to issue ability orders that require a position to player

Send a positional/directional ability command (PCMD_Ability) to a player 

Use this function to issue ability orders that require a position and a direction to player

Send a position command to a player with extra info 

Use this function to issue orders that require a position to player
See Command_Player for a list of all the possible playerCommands.

Send a player command to itself to order squads in the sgroup to construct the building at specific position and facing 

structureBlueprint must be a valid building that can be constructed by the sgroup. This building would cost nothing and does not effect population and availability This is a special command for SCAR use

Send a player command to itself to order squads in the sgroup to construct fences from posStart to posEnd 

structureBlueprint must be a valid building that can be constructed by the sgroup. This building would cost nothing and does not effect population and availability This is a special command for SCAR use

Send a player command to itself to order squads in the sgroup to construct a field ranging from posStart to posEnd 

structureBlueprint must be a valid building that can be constructed by the sgroup. This building would cost nothing and does not effect population and availability This is a special command for SCAR use

Send a player command to itself to act upon all entities in the sgroup with custom parameter and index data (PCMD_CriticalHit) 

This is a special command for SCAR & debug use

Sends an upgrade command to a player 

Send a squad command to a squad group 

SCMD_DefaultAction, SCMD_Move, SCMD_Stop, SCMD_Destroy, SCMD_BuildStructure, SCMD_Capture, SCMD_Attack, SCMD_ReinforceUnit, SCMD_Upgrade, SCMD_CancelProduction SCMD_AttackMove, SCMD_Ability, SCMD_Attach, SCMD_Detach SCMD_Load,SCMD_UnloadSquads, SCMD_DoPlan SCMD_SlotItemRemove, SCMD_InstantReinforceUnit, SCMD_InstantUpgrade

Send a ability command (SCMD_Ability) to a squad 

Send a position ATTACK MOVE command to a squad group with custom data 

Send a custom squad AI plan command to the squad to execute the plan specified towards the position 

Send a custom squad AI plan command to the squad to execute the plan specified towards the position 

Send an entity command to a squad group. 

Use this function to isssue an entity-based command to a squad group.
See Command_Squad for a list of all the possible squadCommands

Send a entity ability command (SCMD_Ability) to a squad 

Send an entity command ATTACK to a squad group. 

Use this function to issue an entity-based command to a squad group with custom FOW check flag. (eg. order a squad to attack a building)
planName is the name of the custom plan file to execute. Pass in empty string to use the default
stationary flag uses SCMD_StationaryAttack instead where plan file is ignored and squad does not pursue its target See Command_Squad for a list of all the possible squadCommands

Send a entity command to a squad group with custom BOOLEAN data 

Send a entity command to a squad group with custom data 

Send special squad command to a squad group with squad load parameters 

This is a special command for loading squads into building (entity) holds (SCMD_Load, SCMD_InstantLoad)

Send a squad command to a squad group with custom data 

Send a position command to a squad group. 

Use this function to issue orders that require a position to a squad group (eg. order a squad to move to position, or attack position)
See Command_Squad for a list of all the possible squadCommands.

Send a positional ability command (SCMD_Ability) to a squad 

Send a position command to a squad group with custom data 

Send a move-facing command to a squad group 

Send an position command ATTACK to a squad group. 

Use this function to issue an position-based command to a squad group with custom FOW check flag. (eg. order a squad to attack a building)
planName is the name of the custom plan file to execute. Pass in empty string to use the default
stationary flag uses SCMD_StationaryAttack instead where plan file is ignored and squad does not pursue its target See Command_Squad for a list of all the possible squadCommands

Send a command to a squad group with 2 positional input 

Use this function to issue orders that require a position to a squad group and additional data (eg. order a squad to dig in with facing)
See Command_Squad for a list of all the possible squadCommands.

Send an squad-based command to a squad group. 

Use this function to issue a squad-based command to a squad group.
See Command_Squad for a list of all the possible squadCommands

Send a squad ability command (SCMD_Ability) to a squad 

Send an squad-based command to a squad group. 

Use this function to issue a squad-based command to a squad group with special boolean flag. (eg. order a squad to attack another squad)
If bCheckFOW is set to false, the squad would be able to attack other squads hidden in FOW
planName is the name of the custom plan file to execute. Pass in empty string to use the default
stationary flag uses SCMD_StationaryAttack instead where plan file is ignored and squad does not pursue its target See Command_Squad for a list of all the possible squadCommands

Send a squad command to a squad group with custom data 

Send special squad command to a squad group with squad load parameters 

This is a special command for loading squads into vehicle (squad) holds (SCMD_Load, SCMD_InstantLoad)

Sends an upgrade command to a squad group. 

Pauses for a given amount of time. This function MUST be called from a CTRL object in NISlet events only! 

See Event_Start for more information on NISlet events.

Returns true if a given event is running 

Completes execution of the event immediatley (all calls to Wait() are ignored) 

Starts event. Event will not start until all rules are evaluated for this frame! 

We allow saving events in multiplayer so please don't put any non-UI events in multiplayer Running events are not saved at all.

Starts an event the same way as Event_Start, but calls a user defined function when the event is over 

Returns the full path name to the main SCAR script 

Register an init function with the scar system. 

This init function will be called when scar is started up.
**Important: Make sure you do not register two functions with the same name; the init function names should be unique.

Returns true if an init function exists 

Unregister an init function that was registered from Scar_AddInit 

Add a rule to be executed every frame 

Add a rule to be executed at every 'interval' seconds 

Add a rule to be executed 'calls' times, at every 'interval' seconds 

Add a rule to be executed once, after 'interval' seconds 

Change 'interval' seconds of an existing rule 

Test if a rule is currently active 

Remove a currently active rule 

Kills all rules. 

Remove a currently executing rule (only works inside a rule function) 

Add a gun to the gun manager. The manager will take care of turning it around to attack units, and optionally reinforcing it if the crew is killed. 

If you pass in an EGroup, it will automatically find or create a corresponding SGroup with sg_ instead of the eg_ prefix.

Remove's the direction settings for a gun, turning it into a fire-at-anything type.  

Use this if you are relocating a gun. Also removes any special first-trigger speech if you have any hooked up, as it may no longer be suitable if you're moving it.

Remove a gun from the gun manager. 

Sets an sgroup to charge a position when the player steps into the trigger zone 

Stops monitoring all squads from the auto-charge functions 

Removes a squad from being monitored by the auto-charge functions 

Toggles all cinematic related settings. true = go to cinematic, false = go back to normal 

Stops monitoring all squads from the auto-reinforce functions 

Removes an SGroup from the auto-reinforce functions 

Sets an sgroup to retreat to the given destination or building once pinned for a certain duration, or reduced to a third of it's original size 

The optional threshold value should be a percentage (between 0.0 and 1.0) - when the member count drops below this, they retreat

Stops monitoring all squads from the auto-retreat functions 

Removes a squad from being monitored by the auto-retreat functions 

Adds a territory to the automanager. You specify the territory by passing in an EGroup containing the flag. 

Removes all territories from the automanager and shuts the system down. 

Removes a territory from the automanager. You specify the territory by passing in an EGroup containing the flag. 

Add a bridge to the Bridge Territory Manager.  

bridgepoint, bank1point and bank2point should be egroups each containing one territory flag

Stops an SGroup from auto-targetting, until one of their members is explicity given an attack order or Ceasefire_RemoveSGroup() is called (at which point they all start firing again) 

You can optionally specify a function that will be called when the ceasefire is broken by the game (rather than by calling Ceasefire_RemoveSGroup)

Removes the ceasefire effect from an sgroup. This may already have been removed by issuing an attack order directly to the group. 

Restores various aspects of the single player game after loading a mission from a save game 

Disables any resource income - useful to stop resources accruing during the opening movie 

Re-enables resource income.  

Forces a sync weapon to shoot at the sky, so long as it's manned by a given player. 

Stops all sync weapons from going through their "shooting at the sky" routine. 

Removes a sync weapon from the "shoot at the sky" system. It can then target people again. 

Triggers smoke to come in from the map edge, at the position and direction of the given marker 

Returns a random item from a table. You can return multiple items (without duplicates) by passing in an optional number parameter. 

Utility wrapper to setup the AI. Visit Scardoc to read the extended description. 

An example use:
Util_AI_Setup(player5, 10, player1, 1, 6, 5, 2, 3)
player5 = the AI player
10 = the popcap override value
player1 = the main target for the AI
1 = the difficulty setting
6 = the AI production template table entry
5 = the aggression setting, 1-5, 5 is the most aggressive
2 = the unit preference, 1-5, 1 is infantry heavy, 5 is vehicle heavy
3 = the counter preference, 1-5, 1 is anti-infantry, 5 is anti-vehicle

Spawns a raft that will travel from the spawn location to a specified landing location. 

Note: the raft does not know the difference between land and water and will travel over all of it.

Adds an entity to the end of a group if the group doesnt already have it. 

Appends the entities in one group to another group.  

All entities from 'grouptoadd' will be added to 'group'.
If 'group' already contains an entity from 'grouptoadd' it will not be added.
This function does not clear the contents of 'grouptoadd'.
Example: Add group2 (0, 10, 11, 22) to group1 (1, 11, 20) --> group1 would now be (1, 11, 20, 0, 10, 22)

Returns true if ALL or ANY entities in a group can see ALL or ANY entities in a given egroup. 

Returns true if ALL or ANY entities in a group can see ALL or ANY squads in a given sgroup. 

Removes all entities from a group 

Returns true if the contents of the two groups are equal. Order of the entities does not matter. 

Check if a group contains ALL or ANY of the blueprints. 

Returns true if EGroup1 contains ANY or ALL of EGroup2 

Returns true if EGroup contains a particular EntityID 

Returns the total number of spawned and despawned entities in a group. 

Get the number of alive entities (both spawned and despawned) 

Returns the number of despawned entities in a group. 

Returns the number of spawned entities in a group. 

Returns a new entity group with the given name. 

Entity groups are used for buildings and objects such as rocks and trees.
If you need to issue orders to a group vehicles or units you must use a SquadGroupObs.

Find a entity group from name. Creates a new one with given name if it doesnt exist. 

Create and display kicker message on the each entity in the egroup to the player

Despawn all spawned entities in a group. 

Manually destroy a group that you dont need anymore. 

Destroys all spawned and despawned entities in a group. 

Be careful not to confuse this with EGroup_Destroy which destroys the group and NOT the items it contains. This function will destroy spawned and despawned items in a group

Duplicates an EGroup 

Creates a copy of egroup1 in egroup2. The function will clear egroup2 beforehand if necessary.

Enables or disables the minimap indicator for all entities in a group 

Returns true if the entity group with the given name exists 

Filters an EGroup by blueprint. 

Blueprints can be provided by name or by ID, and in a table if you want to filter on more than one type. Setting filtertype to FILTER_KEEP results in the group only containing entities of the types listed in the blueprint table. Setting filtertype to FILTER_REMOVE will strip those same entities out and leave those that aren't of the types listed.

Filters an EGroup by construction status. 

Setting filtertype to FILTER_KEEP results in the group only containing those entities that are in the process of being built. Setting filtertype to FILTER_REMOVE will strip those same entities out and leave those that are complete.

Call a lua function for each item in a group. Function will recieve (groupid, itemindex, itemid) and should return true to break or false to continue. 

function Rule_Test( )
 local DespawnEntity = function( egroupid, itemindex, entityID )
  Entity_Despawn( entityID )
 end

 EGroup_ForEach( EGroup_FromName("eg_PlayersHQ"), DespawnEntity )
end
Note: This function iterates over SPAWNED ENTITIES ONLY.

Call a lua function for each item in a group. Function will recieve (groupid, itemindex, itemid) and should return a bool. 

Only use this to TEST conditions on entities. DO NOT use this to perform operations on all entities, since it may not call your function on all entities (due to short circuit evaluation). This is used for checking if ALL or ANY items in a group match a given predicate. (eg. Are all items in a group choas marines)
Note: This function iterates over SPAWNED ENTITIES ONLY.

Same as EGroup_ForEachAllOrAny except you have a choice to iterate over spawned entities, despawned entities, or both. 

Same as EGroup_ForEach except you have a choice to iterate over spawned entities, despawned entities, or both. 

Find an entity group with a given name. 

Returns the average health of all units in a entity group. 

This uses the "proper" measure of health for panel buildings, so should accurately reflect what the user sees.

Returns the despawned entity at the given index. 

Use EGroup_GetSpawnedEntityAt if you want the spawned items in the group
Use index 1 to get the first entity in the group.
It is an error if index > EGroup_GetCountDeSpawned()

Check invulnerablity state for ALL or ANY entity in an entity group. 

Set all param to true to check for ALL or set to false to check for ANY.

Gets the last attacker(s) for all the entities in an EGroup Gets the last attacker for all the squads in an SGroup and stores that in SGroupAttacker 

Returns the name of a given entity group. 

Returns the number of combat slots in total of a certain hold-able type  

Returns a position (a certain distance away) relative to an entity's current position/orientation. see LuaConsts.scar for explanation of 'offset' parameter 

Returns the center position of an entity group. 

Get a random spawned entity from egroup 

Builds a table of EGroupIDs that are named in a sequence. i.e. a name of "eg_building" will find groups "eg_building1", "eg_building2" and so on, up until it looks for a group that isn't there. 

Returns the spawned entity at the given index. 

Use EGroup_GetDeSpawnedEntityAt if you want the despawned items in the group
Use index 1 to get the first entity in the group.
It is an error if index > EGroup_GetCountSpawned()

Returns the distance from the centre of the group of the entity that furthest out.  

Returns an sgroup containing all squads held by any entities in an egroup 

Returns whether ANY or ALL entities in an EGroup have the specified upgrade 

Hide or show all entities in an EGroup 

Bool should be true to hide, false to show

Change the ownership of a Strategic Point 

Reverts an occupied building 

Performs a group intersection.  

Only entities that are in both groups will be added to 'group'.
The contents of 'grouptointersect' will not be changed.
Example: group = (1,2,3,4,5,6) grouptointersect = (2,4,6,8,10) --> group will now equal (2,4,6)

Returns true if all or any strategic points in a group have been captured. Use ANY or ALL. 

This function will ignore all entities that cannot be captured and will return false if no entities in the group can be captured.

Returns true if ALL or ANY entities are attacking within the time 

Returns true if a named entity group contains no spawned or despawned entities 

Returns whether any entity in an EGroup has a hold on anything 

Returns true if ALL or ANY entities are in cover. 

Returns true if ANY or ALL entities in an EGroup are moving. 

Returns true if ANY or ALL (use those keywords) of the enities in the group are present onscreen. You can pass in a percentage of the screen to check, so 0.8 would be a centered rectangle occupying 80% of the screen. 

Returns true if ALL or ANY entities in a group are currently producing squads 

Set all to true to check for ALL or set to false to check for ANY

Returns true if ALL or ANY entities are under attack within the time 

Check if the entities are attacked by the player 

Returns true if ALL or ANY entities are under attack from a direction within the time. see LuaConsts.scar for types of directions. you can pass in a table of offsets 

Checks if ANY or ALL squads within an EGroup are using an ability 

also used for emplacements/entities that are built but function through the use of squads. Does not check WHAT ability a squad is using.

Kill all entities in an EGroup 

Removes an entity from a group. 

Removes all demolition charges on an egroup 

Remove from the first SGroup all squads contained in the second SGroup. SGroup2 remains untouched. 

Removes upgrade(s) from an egroup 

Respawn all despawned entities in a group. 

Trigger animation action for an EGroup. Please only use this for simple animations 

Set animation event for an EGroup. Please only use this for simple animations 

Set animation state of a state machine for an EGroup. Please only use this for simple animations 

Set animation variable value for an EGroup. Please only use this for simple animations 

Sets whether a weapon to auto-target things or not 

Sets the health of each unit in an entity group to a given percent [0.0, 1.0]. 

Overrides crushable behavior for an egroup 

Set the minimum health for this entity 

This is usually set to zero, any higher value prevents the entity from having its health reduced below this given value

Enable/Disable invulnerablity for an entire entity group. Use true and false for simple on/off, or use a number between 0.0 and 1.0 for more precise control on how much damage an entity can take before it takes no more. 

The optional reset_time is used to automatically remove invulnerability after a set time. If invulnerable, both health and critical damage are disabled.

Changes the player owner for all spawned and despawned entities of an EGroup. 

Strategic/capturable point does not support setting player owner directly

Set player selectable state of entities in the egroup 

Enables shared team production on a building (teammates can build using THEIR resources) 

Sets a strategic point to neutral (not owned by any team)  

Makes an egroup neutral 

Creates an entity group containing a single entity 

Creates an EGroup containing just one entity, creating the group if it doesn't exist and clearing it if it does. It returns the name of the EGroup.

Returns true if ANY or ALL of the squad's entities have the specified upgrade 

Calls a function when any entity in an EGroup gets destroyed by the player clicking the "Detonate me" button 

Instantly wires a building for demolitions 

Displays info about the panel that is intersected by the passed in ray 

Returns whether an entity can attack a target without moving or turning. 

Check if the entity can load an sgroup or not 

Check if the entity can load squad or not 

Returns true if a target entity is in the entities sight radius 

Returns true if a target squad is in the squads sight radius 

Clears any previous posture suggestions made to an entity 

Creates an entity at a given position and assigns it to a given player. 'blueprint' is a string value containing the name of the entity blueprint. This function does not spawn the entity so you will need to call Entity_Spawn to see this entity 

Creates an entity at a given position and assigns it to a given player. 'blueprint' is a string value containing the name of the entity blueprint. This function spawns the entity so there is no need to call Entity_Spawn 

DeSpawn the entity at its current position 

Remove an entity from the world and destroy it. 

Disables the death of the given entity building, only works for panel based destructible buldings 

Damages this entity but only if its a destructible building 

dmgType of 0 is damage accessory, 1 is damage panel, 2 is destroy panel and 3 is destroy radius

Sets whether an entity pays attention to its surroundings 

Sets whether an entity can produce anything (including upgrades) 

Force constructs this entity but only if its a building 

Get an entity from a mission editor ID. 

Returns the active entity command. Some valid entity commands: STATEID_StructureBuilding, STATEID_Dead, STATEID_Idle, STATEID_Pause 

Returns the entity's blueprint 

Returns the construction progress (with range [0.0, 1.0] for a given entity. Returns 0.0 if the entity is not a building. 

Get cover safety value from the where the entity is standing. The safety value is number from -.5 to .5. 

Higher value means better cover. If the entity doesn't have cover_ext, value of 0 would be returned

Returns the entities unique id in the world 

Returns the heading of the entity. The heading is currently a lua table with three entries (x, y, z) 

Returns the health of an entity. 

Health will be zero for entities with no health extension.

Returns the max health of an entity. 

Max health will be zero for entities with no health extension.

Returns the percentage health, taking into account destructible buildings 

Health will be zero for entities with no health extension nor building destruction

Check if the entity is invulnerable or not 

Returns the invulnerable point in terms of percentage 

For buildings, retrieve the percentage value of healthy below which no more panels could be destroyed

Find the last squad attacker on this entity. If found, the squad is added to the sgroup 

Find the squad attackers on this entity from the last seconds specified. If found, the squads are added to the sgroup. Building attackers are ignored 

Returns the number of combat slots in total of a certain hold-able type 

Returns a position relative to an entity's current position and orientation. see LuaConsts.scar for explanation of 'offset' parameter. 

Returns the Player owner of the given entity. Entity MUST NOT be owned by the world. 

Use World_OwnsEntity to make sure entity is not owned by the world before calling this function

Returns the position of the entity. The position is currently a lua table with three entries (x, y, z) 

Returns the blueprint for a production queue item with index. 

Returns the production type (PITEM_Upgrade, PITEM_Spawn, PITEM_SquadUpgrade, PITEM_SquadReinforce, PITEM_PlayerUpgrade) for a production queue item with index. 

Returns the number of items in the entities production queue. 

It is an error to call this function on an entity that does not have a production queue.
Use Entity_HasProductionQueue to check that the entity has a queue.

Returns the inner sight radius for this entity 

Radius will be zero for entities without a sight extension

Returns the inner sight radius for this entity 

Radius will be zero for entities without a sight extension

Returns the outer sight radius for this entity 

Radius will be zero for entities without a sight extension

Returns the outer sight radius for this entity 

Radius will be zero for entities without a sight extension

Returns the Squad for the passed Entity. (May be NULL) 

Adds squads held by an entity to an SGroup 

Gets the total number of panels in a building (returns 0 for anything but panel based destructible buldings) 

Gets the current number of undestroyed panels in a building (returns 0 for anything but panel based destructible buldings) 

Returns a weapon hardpoint 

Returns how many hardpoints an entity has 

Return true if the entity has the given criticalID applied to it 

Returns true if an entity has a production queue. 

Return true if the entity has purchased the specified upgrade. 

Strategic point will be captured instantly by the team of the supplied player 

Reverts an occupied building 

Returns true if entity is still alive 

Returns true if the entity is attacking within the time 

Time is in seconds

Returns true if the given entity is a building 

Returns whether the entity is camouflaged. 

Returns true if the entity is a capturable building 

Returns true if entity is a casualty else false 

Returns whether this entity's demolition charges are ready to be detonated 

Returns true if the given blueprint is a building 

Returns true if the given blueprint is objcover 

Returns whether a hardpoint is active 

Check if the entity has a hold on anything 

Returns true if entity is in cover. 

Returns whether an entity is moving. 

Determines if this entity is of the given type. Types are defined in type_ext/unit_type_list 

Returns true if the entity is part of a squad 

Returns whether an entity is a soldier 

if entity is spawned return true 

Returns true if the entity is a starting position 

Returns true if the entity is a strategic point. 

Returns true if strategic point is captured by the team of the player provided. 

Return true if the entity is a team weapon 

Returns true if the entity is under attack.  

Returns true if the entity is under attack by a certain player 

Returns true if the entity was under attack from a certain direction (8 offset types, see LuaConsts.scar) 

Check if an entity with the given ID can be found in the world 

Returns whether an entity is a vehicle 

Returns true if entityID is a victory point 

Kill the entity. Sets health to 0, and triggers death effects. 

Calls a function when an entity gets destroyed by the player clicking the "Detonate me" button next to an entity. 

Removes all booby-traps on this entity 

Removes all demolition charges on an entity 

Removes an upgrade from an entity 

Trigger animation action for an entity. Please only use this for simple animations 

Set animation action parameter for an entity. Please only use this for simple animations 

Set animation event for an entity. Please only use this for simple animations 

Set animation state of a state machine for an entity. Please only use this for simple animations 

Set animation variable value for an entity. Please only use this for simple animations 

Overrides crushable behavior for an entity 

Fully wires this entity for demolitions, if it's set up to be demolishable. 'player' is the one that owns the demolitions and can detonate them. 

Sets the heading of the entity. The position is currently a lua table with three entries (x, y, z) 

Set the health of an entity. healthPercent must be in the range [0.0, 1.0]. 

Set invulnerability on the entity. Reset time is in seconds. If it it set, the invulnerability will expire after this time. 

Make an entity invulnerable to physical damage when health is below the minimum health percentage 

resetTime is the time in seconds that vulnerability will be restored.; zero time for reset time means the buff will last forever

Changes the owner of the given squad. 

This function doesn't work with strategic/capturable point

Sets the position of the entity. The position is currently a lua table with three entries (x, y, z) 

Sets whether or not a projectile can explode.  

Enables shared team production on a building (teammates can build using THEIR resources) 

Sets a strategic point to neutral (not owned by any team) 

Makes an entity neutral 

Shows/hides the entity in the simulation 

Spawn the entity at its current position 

Abruptly stops an active ability 

Suggests a posture to an entity, lasting the passed duration 

Posture of 0 is prone, 1 is kneel/crouch, and 2 is standing. Duration is in seconds, negative means indefinate.

Returns whether this entity is set up to have demolitions placed on it 

Tags the entity to be used for debugging 

Hides or shows an entity visually. 

Make the passed entity a casualty by triggering the MakeCasualtyAction 

Make the passed entity a wreck by triggering the MakeWreckAction 

Make the passed entity go out of control 

Triggers an OutOfControlAction on the unit. Does not trigger any actions associated with an OOC weapon hit critical, just the OOC action.

Reveal FOW for all players 

Reveals a circular area for all alive players over a given duration. YOU SHOULD ONLY CALL THIS ONCE FOR EACH AREA. 

Pass in a duration of -1 for indefinite duration ( until unreveal is called )

Reveals an entity groups line of sight(LOS) for all alive players over a given duration. YOU SHOULD ONLY CALL THIS ONCE FOR EACH AREA. 

Pass in a duration of -1 for indefinite duration ( until the entities are dead )

Reveals an entity groups in FOW for all alive players over a given duration. 

Pass in a duration of -1 for indefinite duration ( until the entities are dead )

Reveals an entities line of sight (LOS) for all alive players over a given duration. YOU SHOULD ONLY CALL THIS ONCE FOR EACH AREA. 

Pass in a duration of -1 for indefinite duration ( until the entity is dead )