BIS Game Engine Scripting Commands

Page 1 of 415

!a
Operand types: a: Boolean Type of returned value: Boolean Description: not a Example: !true , result is false Category: Default

grp1 != grp2
Operand types: grp1: Group grp2: Group Type of returned value: Boolean Description: Checks whether two groups are different. If either of them is grpNull, true is returned. Example: group player != group soldierOne Category: OFP

a != b
Operand types: a: Number b: Number Type of returned value: Boolean Description: a is not equal to b Example: counter != 4 Category: Default

location1 != location2
Operand types: location1: Location

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 2 of 415

location2: Location Type of returned value: Boolean Description: Checks whether two locations are different. If either of them is null, true is returned. Category: Location

a != b
Operand types: a: String b: String Type of returned value: Boolean Description: a is not equal to b (case insensitive) Example: nameOfPlayer != "John Doe" Category: Default

text1 != text2
Operand types: text1: Structured text text2: Structured text Compatibility: Version 2.01 required. Type of returned value: Boolean Description: Checks whether two structured text values are different. Category: OFP

side1 != side2
Operand types: side1: Side side2: Side Type of returned value: Boolean Description: Checks whether two side values are different. Example:

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 3 of 415

side player != west Category: OFP

control1 != control2
Operand types: control1: Control control2: Control Compatibility: Version 2.50 required. Type of returned value: Boolean Description: Checks whether two controls are different. Category: OFP PC

task1 != task2
Operand types: task1: Task task2: Task Compatibility: Version 2.92 required. Type of returned value: Boolean Description: Checks whether two tasks are different. Category: Identity

obj1 != obj2
Operand types: obj1: Object obj2: Object Type of returned value: Boolean Description: Checks whether two objects are different. If either of them is objNull, true is returned. Example: vehicle player != player Category: OFP

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 4 of 415

display1 != display2
Operand types: display1: Display display2: Display Compatibility: Version 2.50 required. Type of returned value: Boolean Description: Checks whether two displays are different. Category: OFP PC

config1 != config2
Operand types: config1: Config config2: Config Compatibility: Version 2.58 required. Type of returned value: Boolean Description: Checks whether two config entries are different. Category: OFP PC

a%b
Operand types: a: Number b: Number Type of returned value: Number Description: The remainder of a divided by b. Note that the remainder is calculated in the real domain. Example: 4.5 % 3 , result is 1.5 Category: Default

a && b
Operand types: a: Boolean b: Boolean

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 5 of 415

Type of returned value: Boolean Description: a and b Example: alive player && alive leader player Category: Default

a*b
Operand types: a: Number b: Number Type of returned value: Number Description: a multiplied by b Example: iCounter*3 Category: Default

+a
Operand types: a: Number Type of returned value: Number Description: unary plus: returns a Example: +4 , result is 4 Category: Default

+a
Operand types: a: Array Type of returned value: Array Description: unary plus: returns a copy of the array

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 6 of 415

Example: + [0, 1, 2] , result is [0, 1, 2] Category: Default

a+b
Operand types: a: Number b: Number Type of returned value: Number Description: a plus b Example: counter + 1 Category: Default

arrayA + arrayB
Operand types: arrayA: Array arrayB: Array Type of returned value: Array Description: arrayA and arrayB are concatenated. Example: [0, 1, 2] + [1, 2, 3] , result is [0, 1, 2, 1, 2, 3] Category: Default

stringA + stringB
Operand types: stringA: String stringB: String Type of returned value: String Description: stringA and stringB are concatenated. Example: "I" + " am" + " blind" , result is "I am blind"

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 7 of 415

Category: Default

-a
Operand types: a: Number Type of returned value: Number Description: unary minus: zero minus a Example: - - 3 , result is 3 Category: Default

a-b
Operand types: a: Number b: Number Type of returned value: Number Description: a minus b Example: counter - 1 Category: Default

arrayA - arrayB
Operand types: arrayA: Array arrayB: Array Type of returned value: Array Description: All elements in arrayB are removed from arrayA. Example: [0, 1, 2, 4, 0, 1, 2, 3, 4, 5] - [1, 2, 3] , result is [0, 4, 0, 4, 5] Category: Default

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 8 of 415

a/b
Operand types: a: Number b: Number Type of returned value: Number Description: a divided by b Example: enemyStrenght/3 Category: Default

config / name
Operand types: config: Config name: String Compatibility: Version 2.92 required. Type of returned value: Config Description: Returns subentry of config entry with given name (alias for >>). Example: configFile / "CfgVehicles" Category: OFP PC

a:b
Operand types: a: Switch Type b: Code Type of returned value: Nothing Description: see switch Category: Default

a<b
Operand types: a: Number

http://www.arma2.com/comref/full.html

7/11/2010

com/comref/full.html 7/11/2010 .50 required.BIS Game Engine Scripting Commands Page 9 of 415 b: Number Type of returned value: Boolean Description: a lesser than b Example: counter < 4 Category: Default a <= b Operand types: a: Number b: Number Type of returned value: Boolean Description: a lesser or equal than b Example: player distance redCar <= 100 Category: Default display1 == display2 Operand types: display1: Display display2: Display Compatibility: Version 2. Type of returned value: Boolean Description: Checks whether two displays are equal. Type of returned value: http://www.arma2.50 required. Category: OFP PC control1 == control2 Operand types: control1: Control control2: Control Compatibility: Version 2.

arma2. If either of them is objNull.BIS Game Engine Scripting Commands Page 10 of 415 Boolean Description: Checks whether two controls are equal. Example: side player == west Category: OFP obj1 == obj2 Operand types: obj1: Object obj2: Object Type of returned value: Boolean Description: Checks whether two objects are the same. false is returned. http://www. Category: OFP PC side1 == side2 Operand types: side1: Side side2: Side Type of returned value: Boolean Description: Checks whether two side values are equal. Example: player == leader player Category: OFP config1 == config2 Operand types: config1: Config config2: Config Compatibility: Version 2.com/comref/full.58 required.html 7/11/2010 . Type of returned value: Boolean Description: Checks whether two config entries are equal.

Example: group player == group soldierOne Category: OFP a == b http://www.01 required. false is returned. Type of returned value: Boolean Description: Checks whether two tasks are equal.arma2.BIS Game Engine Scripting Commands Page 11 of 415 Category: OFP PC task1 == task2 Operand types: task1: Task task2: Task Compatibility: Version 2.com/comref/full.92 required. Type of returned value: Boolean Description: Checks whether two structured text values are equal. If either of them is grpNull.html 7/11/2010 . Category: Identity text1 == text2 Operand types: text1: Structured text text2: Structured text Compatibility: Version 2. Category: OFP grp1 == grp2 Operand types: grp1: Group grp2: Group Type of returned value: Boolean Description: Checks whether two groups are the same.

BIS Game Engine Scripting Commands Page 12 of 415 Operand types: a: Number b: Number Type of returned value: Boolean Description: a equal to b Example: counter == 4 Category: Default location1 == location2 Operand types: location1: Location location2: Location Type of returned value: Boolean Description: Checks whether two locations are the same.html 7/11/2010 . false is returned. If either of them is null.com/comref/full. Category: Location a == b Operand types: a: String b: String Type of returned value: Boolean Description: a equal to b (case insensitive) Example: nameOfPlayer == "John Doe" Category: Default a>b Operand types: a: Number b: Number Type of returned value: Boolean Description: http://www.arma2.

com/comref/full.35 required. Type of returned value: Config Description: Returns subentry of config entry with given name.html 7/11/2010 .BIS Game Engine Scripting Commands Page 13 of 415 a greater than b Example: counter > 4 Category: Default a >= b Operand types: a: Number b: Number Type of returned value: Boolean Description: a greater or equal than b Example: player distance redCar < 100 Category: Default config >> name Operand types: config: Config name: String Compatibility: Version 2.arma2. Example: configFile >> "CfgVehicles" Category: OFP PC a^b Operand types: a: Number b: Number Type of returned value: Number Description: a raised to the power of b http://www.

com/comref/full.BIS Game Engine Scripting Commands Page 14 of 415 Example: count^4 Category: Default a || b Operand types: a: Boolean b: Boolean Type of returned value: Boolean Description: a or b Example: !alive player || !alive leader player Category: Default abs x Operand types: x: Number Type of returned value: Number Description: The absolute value of x. result is 3 Category: Default accTime Type of returned value: Number Description: Returns the current time acceleration factor.arma2. Category: OFP acos x http://www. Example: abs -3 .html 7/11/2010 .

result is 60 Category: Default unit action action Operand types: unit: Object action: Array Type of returned value: Nothing Description: Makes the unit peform an action.html 7/11/2010 .01 required. param3 are type specific. vehicle soldierOne] Category: OFP actionKeys action Operand types: action: String Compatibility: Version 2.5 .arma2. param2. Example: acos 0.BIS Game Engine Scripting Commands Page 15 of 415 Operand types: x: Number Type of returned value: Number Description: The arccosine of x. maxKeys]: String or Array http://www. maxKeys] Operand types: action or [action.com/comref/full. Only type is required. the result is in degrees. Example: array = actionKeys "ReloadMagazine" Category: OFP actionKeysImages action or [action. param1. target defaults to unit and param1. The format of action can be [type. Example: soldierOne action ["eject". target. param3]. Type of returned value: Array Description: Returns a list of dikCodes of buttons assigned to the given user action. param2.

.] Operand types: [addon1. Type of returned value: String Description: Returns a list of button names assigned to the given user action. A maximum of maxKeys keys is listed. You can find the action names in config class ControllerSchemes. A maximum of maxKeys keys is listed. maxKeys] Operand types: action or [action. The list of active addons is initialized during this function. Example: activateAddons ["BISOFP"] Category: OFP activateKey keyName http://www. Example: text = actionKeysImages "ReloadMagazine" Category: OFP actionKeysNames action or [action.com/comref/full. Type of returned value: Nothing Description: Activates the listed addons.html 7/11/2010 . .32 required.01 required. Type of returned value: Structured text Description: Returns a list of button images or names assigned to the given user action..]: Array Compatibility: Version 2..BIS Game Engine Scripting Commands Page 16 of 415 Compatibility: Version 2. maxKeys]: String or Array Compatibility: Version 2..01 required. Example: list = actionKeysNames "ReloadMagazine" Category: OFP activateAddons [addon1.arma2. You can find the action names in config class ControllerSchemes. .

Category: Editor http://www. [name1. To determine the action ID. use following algorithm: the first action added to the given vehicle has ID zero. "hello. arguments.html 7/11/2010 ..]. subtype class] Operand types: map: Control [type. See keys.arma2. arguments. priority. Example: player addAction ["Hello".10 required. it's not.].. Returns the ID of the new EditorObject. the next vehicle has ID one. The action ID should be returned. showWindow. priority. . [name1. keysLimit and doneKeys in the description.sqs"] Category: OFP map addEditorObject [type. but due to a bug. Type of returned value: Nothing Description: Activates the given key for the current user profile. Create script is called with _new equal to true. hideOnUse. condition)]: Array Compatibility: Version 1. script filename(. script filename(. etc..92 required. shortcut. . subtype class]: Array Compatibility: Version 2. Type of returned value: String Description: Add an object to the editor and assign arguments.06 required. Example: activateKey "M04" Category: OFP unit addAction [action. The keys are used to unlock missions or campaigns. shortcut.com/comref/full.ext file of the missions.BIS Game Engine Scripting Commands Page 17 of 415 Operand types: keyName: String Compatibility: Version 2. condition)] Operand types: unit: Object [action.. showWindow. value1. Subtype class is optional. hideOnUse. Type of returned value: Description: Creates an action. value1.

ofsetY]] Category: OFP unit addLiveStats score Operand types: unit: Object score: Number Compatibility: Version 2.BIS Game Engine Scripting Commands Page 18 of 415 object addEventHandler handler Operand types: object: Object handler: Array Compatibility: Version 1.command]. Returns icon ID Example: id = group addGroupIcon["b_inf".{_this exec "playerKilled.sqs"}] Category: OFP group addGroupIcon properties Operand types: group: Group properties: Array Compatibility: Version 5501 required. Example: http://www.html 7/11/2010 .com/comref/full.10 required. Check scripting topic Event handlers for more information. Example: player addEventHandler ["killed". Type of returned value: Description: The format of handler is [type. The index of the currently added handler is returned.arma2.[offsetX. Type of returned value: Nothing Description: Xbox Live MP only: adds score to the Xbox Live Statistics score for the given unit (or the commander unit of the given vehicle). Type of returned value: Number Description: Add icon to a group.85 required.

BIS Game Engine Scripting Commands Page 19 of 415 player addLiveStats 10 Category: OFP unit addMagazine weaponName Operand types: unit: Object weaponName: String Type of returned value: Nothing Description: Adds a magazine to the unit.html 7/11/2010 .com/comref/full. Example: rearmTruckOne addMagazineCargo ["M16". Type of returned value: Nothing Description: Adds count magazines of type name into the weapon pool (used in the campaign to transfer weapons to the next mission). The format of magazines is [magazineName. When doing so. for example by adding 20 grenades.arma2. For magazineName values see CfgWeapons. This is used for infantry weapons. Example: player addMagazine "M16" Category: OFP unit addMagazineCargo magazines Operand types: unit: Object magazines: Array Type of returned value: Nothing Description: Adds magazines to the weapon cargo space. Note: you may create invalid combinations by using this function. application behaviour is undefined. Category: Resistance http://www. count].75 required. 10] Category: OFP addMagazinePool Compatibility: Version 1.

Type of returned value: Number Description: Creates a new menu item. Category: Editor name addPublicVariableEventHandler code Operand types: name: String code: Code Type of returned value: Nothing Description: Create an event handler for given variable. Example: "alarm" addPublicVariableEventHandler {_this execVM "alarm.command.arma2. Priority is optional.priority] Operand types: map: Control [text. Menu can be "file" or "view".command.BIS Game Engine Scripting Commands Page 20 of 415 map addMenu [text.text.text.com/comref/full.sqf"} Category: OFP unit addRating number http://www. index is index as returned from addMenu command. Type of returned value: Number Description: Adds a new menu button.html 7/11/2010 .92 required. Category: Editor map addMenuItem [menu or index.priority] Operand types: map: Control [menu or index. The event handler will be executed when some client in MP exports a variable using publicVariable on all clients except the publishing one. priority is optional and determines where in the menu the item will reside (higher priority items first).priority]: Array Compatibility: Version 2.priority]: Array Compatibility: Version 2.92 required.

com/comref/full.BIS Game Engine Scripting Commands Page 21 of 415 Operand types: unit: Object number: Number Type of returned value: Nothing Description: Adds number to the unit rating.arma2.html 7/11/2010 . a unit is considered "renegade" and is an enemy to everyone. This is usually used to reward for completed mission objectives.92 required. The rating for killed enemies and killed friendlies is adjusted automatically. Example: player addScore 10 Category: OFP addSwitchableUnit person Operand types: person: Object Compatibility: Version 2. Example: player addRating 1000 Category: OFP unit addScore score Operand types: unit: Object score: Number Type of returned value: Nothing Description: MP only: adds unit score. Category: OFP group addVehicle vehicle Operand types: group: Group vehicle: Object http://www. Type of returned value: Nothing Description: Add a unit into the list of units available for team switch. This is shown in the "I" MP screen as the total score. When the rating is lower than zero.

application behaviour is undefined. radius. The waypoint is placed randomly in a circle with the given center and radius. index]. Type of returned value: Array Description: Adds (or inserts when index is given) a new waypoint to a group.BIS Game Engine Scripting Commands Page 22 of 415 Compatibility: Version 5128 required. radius. Type of returned value: Nothing Description: Tells the group it owns the vehicle now.arma2. Category: OFP group addWaypoint [center.com/comref/full. index] Operand types: group: Group [center. Example: grp addWaypoint [position player. index]: Array Compatibility: Version 1. Note: you may create invalid combinations by using this function. 0] Category: OFP unit addWeapon weaponName Operand types: unit: Object weaponName: String Type of returned value: Nothing Description: Adds the weapon to the unit. When doing so. radius] or [center. radius] or [center.86 required.html 7/11/2010 . Example: player addWeapon "AK74" Category: OFP unit addWeaponCargo weapons Operand types: unit: Object http://www. for example by adding two rifles. The function returns a waypoint with format [group.

75 required. Type of returned value: Nothing Description: Adds count weapons of type name into the weapon pool (used in campaigns to transfer weapons to the next mission). Category: Resistance airportSide airportId Operand types: airportId: Number Compatibility: Version 2. For weaponName values see CfgWeapons. Example: airportSide 0 .html 7/11/2010 .unit. count] Operand types: [name.92 required. This is used for infantry weapons.unit. Example: rearmTruckOne addWeaponCargo ["M16".com/comref/full. http://www. result is west Category: OFP AISFinishHeal [unit.bool] Operand types: [unit. Type of returned value: Nothing Description: Checks a side of the airport. The format of weapons is [weaponName.bool]: Array Compatibility: Version 5501 required.BIS Game Engine Scripting Commands Page 23 of 415 weapons: Array Type of returned value: Nothing Description: Adds weapons to the weapon cargo space. count]. count]: Array Compatibility: Version 1.arma2. 10] Category: OFP addWeaponPool [name.

html 7/11/2010 .true] Category: OFP alive obj Operand types: obj: Object Type of returned value: Boolean Description: Checks whether the given person.BIS Game Engine Scripting Commands Page 24 of 415 Type of returned value: Nothing Description: AIS end state. vehicle or building is't dead / destroyed. Example: alive player Category: OFP allGroups Compatibility: Version 5501 required. Category: Editor http://www. Type of returned value: Nothing Description: Allow/dissallow 3D mode.arma2. Category: OFP map allow3DMode bool Operand types: map: Control bool: Boolean Compatibility: Version 2. Type of returned value: Array Description: Return a list of all groups.com/comref/full.92 required. Example: AISFinishHeal [wounded.medic.

com/comref/full.html 7/11/2010 . Type of returned value: Nothing Description: Allow/dissallow file ops (load/save etc). Category: OFP obj allowDammage allow Operand types: obj: Object allow: Boolean Type of returned value: Nothing Description: Obsolete. Category: Editor unit allowFleeing courage Operand types: unit: Object or Group courage: Number Type of returned value: Nothing Description: http://www.arma2.92 required. Category: OFP map allowFileOperations bool Operand types: map: Control bool: Boolean Compatibility: Version 2.BIS Game Engine Scripting Commands Page 25 of 415 obj allowDamage allow Operand types: obj: Object allow: Boolean Type of returned value: Nothing Description: Obsolete.

The less courage.arma2. Example: player ammo "M16" Category: OFP http://www. 0 means maximum courage. Type of returned value: Array Description: Return a list of all units (all persons except agents).BIS Game Engine Scripting Commands Page 26 of 415 Sets the group courage. Category: OFP unit ammo magazine Operand types: unit: Object magazine: String Type of returned value: Number Description: Counts how many shots the unit has left for the given magazine type. Example: [unitOne. Example: soldierOne allowFleeing 0 Category: OFP unitArray allowGetIn allow Operand types: unitArray: Array allow: Boolean Type of returned value: Nothing Description: Allows the getting in of vehicles of all units in the list. while 1 means always fleeing. unitTwo] allowGetIn false Category: OFP allUnits Compatibility: Version 5501 required. the sooner the group will start fleeing.html 7/11/2010 .com/comref/full.

Example: house animate ["doors1".com/comref/full. phase] Operand types: object: Object [animation. 1] Category: Resistance object animationPhase animation Operand types: object: Object animation: String Compatibility: Version 1. Animation is defined in config file. Type of returned value: Number Description: Return animation phase of animation on object.BIS Game Engine Scripting Commands Page 27 of 415 a and b Operand types: a: Boolean b: Boolean Type of returned value: Boolean Description: a and b Example: alive player and alive leader player Category: Default object animate [animation. Wanted animation phase is set to phase. Type of returned value: Nothing Description: Process animation on object.75 required.75 required.html 7/11/2010 . phase]: Array Compatibility: Version 1. Example: house animationPhase "doors1" Category: Resistance http://www.arma2.

Example: asin 0. Category: OFP asin x Operand types: x: Number Type of returned value: Number Description: The arcsine of x. result is 30 Category: Default assert codition Operand types: codition: Boolean Compatibility: Version 2. Type of returned value: Number Description: Return the stored value of armory points.00 required.5 . Type of returned value: String Description: Return the name of the current primary animation. Category: OFP armoryPoints Compatibility: Version 5500 required.arma2.com/comref/full.BIS Game Engine Scripting Commands Page 28 of 415 animationState man Operand types: man: Object Compatibility: Version 2. the result is in degrees.92 required.html 7/11/2010 . Type of returned value: Boolean http://www.

Example: assert (_x>0) Category: Default soldier assignAsCargo vehicle Operand types: soldier: Object vehicle: Object Type of returned value: Nothing Description: Assigns the soldier to the cargo / passenger space of the given vehicle. halts the program.com/comref/full.arma2.BIS Game Engine Scripting Commands Page 29 of 415 Description: Tests a condition and if the condition is false. Example: player assignAsCargo tankOne Category: OFP soldier assignAsCommander vehicle Operand types: soldier: Object vehicle: Object Type of returned value: Nothing Description: Assigns the soldier as commander of the given vehicle.html 7/11/2010 . Example: player assignAsCommander tankOne Category: OFP soldier assignAsDriver vehicle Operand types: soldier: Object vehicle: Object Type of returned value: Nothing Description: Assigns the soldier as driver of the given vehicle. http://www.

html 7/11/2010 .arma2. Category: OFP assignedCommander vehicle Operand types: vehicle: Object Compatibility: Version 5501 required.BIS Game Engine Scripting Commands Page 30 of 415 Example: player assignAsDriver tankOne Category: OFP soldier assignAsGunner vehicle Operand types: soldier: Object vehicle: Object Type of returned value: Nothing Description: Assigns the soldier as gunner of the given vehicle. Example: player assignAsGunner tankOne Category: OFP assignedCargo vehicle Operand types: vehicle: Object Compatibility: Version 5501 required.com/comref/full. Category: OFP http://www. Type of returned value: Array Description: Returns the list of soldiers assigned to the given vehicle as a cargo. Type of returned value: Object Description: Returns the soldier assigned to the given vehicle as a commander.

Type of returned value: Object Description: http://www.html 7/11/2010 . Type of returned value: Object Description: Returns the soldier assigned to the given vehicle as a gunner.BIS Game Engine Scripting Commands Page 31 of 415 assignedDriver vehicle Operand types: vehicle: Object Compatibility: Version 5501 required. Category: OFP assignedVehicle person Operand types: person: Object Compatibility: Version 5130 required.arma2. Category: OFP assignedGunner vehicle Operand types: vehicle: Object Compatibility: Version 5501 required. Type of returned value: Object Description: Return the target assigned to the vehicle.92 required.com/comref/full. Type of returned value: Object Description: Returns the soldier assigned to the given vehicle as a driver. Category: OFP assignedTarget vehicle Operand types: vehicle: Object Compatibility: Version 2.

"GREEN". Type of returned value: Array Description: Return the position in vehicle person is assigned to. "BLUE" and "YELLOW". "RED".com/comref/full.05 required. Type of returned value: Nothing Description: Assigns the vehicle (specifically its commander unit) to the given team.arma2.92 required. Category: OFP assignedVehicleRole person Operand types: person: Object Compatibility: Version 5130 required. Example: soldier2 assignTeam "RED" Category: OFP airplane assignToAirport airportId Operand types: airplane: Object airportId: Number Compatibility: Version 2. Type of returned value: Nothing Description: Set airport to be used by AI on getout Example: http://www. Category: OFP vehicle assignTeam team Operand types: vehicle: Object team: String Compatibility: Version 2.BIS Game Engine Scripting Commands Page 32 of 415 Return the vehicle person is assigned to.html 7/11/2010 . The possible team values are: "MAIN".

Example: atan 1 . in the range from -180 to +180. Example: 5 atan2 3 . using the signs of both parameters to determine the quadrant of the returned value.arma2. result is 59.com/comref/full. Example: atg 1 .0362 Category: Default atg x Operand types: x: Number Type of returned value: Number Description: The arctangens of x. result is 45 Category: Default x atan2 y Operand types: x: Number y: Number Type of returned value: Number Description: Returns the arctangens of x/y. result is 45 Category: Default http://www. the result is in degrees. the result is in degrees. The returned value is in degrees.html 7/11/2010 .BIS Game Engine Scripting Commands Page 33 of 415 plane assignToAirport 0 Category: OFP atan x Operand types: x: Number Type of returned value: Number Description: The arctangens of x.

The offset is applied to the object center unless a memory point is provided. [0.arma2. MemPoint]: Array Compatibility: Version 5501 required.2. Type of returned value: Nothing Description: Attach a object to given location. Example: player attachTo [car. MemPoint] Operand types: obj: Object [obj.hatch1] Category: OFP attackEnabled group Operand types: http://www. Category: Location location attachObject object Operand types: location: Location object: Object Compatibility: Version 2. offset.html 7/11/2010 . Type of returned value: Nothing Description: Attaches an object to another object. offset.BIS Game Engine Scripting Commands Page 34 of 415 attachedObject location Operand types: location: Location Compatibility: Version 2.com/comref/full. Type of returned value: Object Description: Return object attached to given location. Category: Location obj attachTo [obj.90 required.90 required.0].

Type of returned value: Array Description: http://www. Category: OFP behaviour unit Operand types: unit: Object Type of returned value: String Description: Returns the behaviour mode of the given unit ("CARELESS". This can be used to estimate computer performance. Example: behaviour player Category: OFP benchmark Type of returned value: Number Description: Returns the value of "3D performance" as it is in OFP preferences.BIS Game Engine Scripting Commands Page 35 of 415 group: Object or Group Compatibility: Version 2.92 required."SAFE".arma2.com/comref/full."AWARE". The function can be used to create missions that are able to adapt to computer peformance.92 required. Type of returned value: Boolean Description: Return whether leader can issue attack commands.html 7/11/2010 ."COMBAT" or "STEALTH"). Example: ? benchmark>2000 : setviewdistance 2000 Category: OFP boundingBox object Operand types: object: Object Compatibility: Version 2.

Category: Default breakTo name Operand types: name: String Type of returned value: Nothing Description: Breaks block to scope named 'name'. maxZ. minY]. The result is in format [[minX. Nil is returned.html 7/11/2010 . maxY]]. minZ. y] Category: OFP breakOut name Operand types: name: String Type of returned value: Nothing Description: Breaks block out scope named 'name'. Type of returned value: Array Description: Returns the position of original (loaded) center of object in model coordinates. z.arma2. [maxX. Category: OFP boundingCenter object Operand types: object: Object Compatibility: Version 5501 required. Category: Default building buildingExit index Operand types: building: Object index: Number http://www.com/comref/full. Nil is returned. The result is in format [x.BIS Game Engine Scripting Commands Page 36 of 415 Returns a bounding box of given object in model coordinates space.

Example: buildingExit [building. 1] Category: OFP building buildingPos index Operand types: building: Object index: Number Type of returned value: Array Description: Returns the given indexed position in a building. Example: building buildingPos 1 Category: OFP buttonAction control Operand types: control: Control Compatibility: Version 2.92 required. Type of returned value: String Description: Returns the action assigned to the given button or active text.50 required. Example: _action = buttonAction _button Category: OFP PC buttonAction idc Operand types: idc: Number Compatibility: Version 1. The action is any expression in this scripting language.arma2. http://www.com/comref/full. The returned value is in format Position.BIS Game Engine Scripting Commands Page 37 of 415 Type of returned value: Array Description: Returns the given indexed exit in a building. The returned value is in format Position.html 7/11/2010 .

Example: buttonSetAction [100.html 7/11/2010 .91 required. Example: _action = buttonAction 100 Category: Resistance buttonSetAction [idc.sqs"""] Category: Resistance control buttonSetAction action Operand types: control: Control action: String Compatibility: Version 2. Action is any expression in this scripting language. The function can be used for buttons and active texts. "player exec ""reply.sqs""" Category: OFP PC cadetMode http://www.com/comref/full. action] Operand types: [idc.arma2. The action is any expression in this scripting language. Action is any expression in this scripting language. Example: _control buttonSetAction "player exec ""reply. Type of returned value: Nothing Description: Assigns an action to the given button or active text. Type of returned value: Nothing Description: Assigns an action to the control with id idc of the topmost user dialog.BIS Game Engine Scripting Commands Page 38 of 415 Type of returned value: String Description: Returns the action assigned to the control with id idc of the topmost user dialog. action]: Array Compatibility: Version 1.50 required. The function can be used for buttons and active texts.

Example: [1.85 required.85 required. Example: call {"x=2"} Category: Default pars call body Operand types: pars: Any body: Code Compatibility: Version 1.arma2.com/comref/full. Type of returned value: Any Description: Executes the function body. result is 3 Category: Default camera camCommand command Operand types: camera: Object command: String Type of returned value: Nothing Description: http://www. Category: OFP call code Operand types: code: Code Compatibility: Version 1. Type of returned value: Any Description: Executes the given code. Argument pars is passed as _this.BIS Game Engine Scripting Commands Page 39 of 415 Type of returned value: Boolean Description: Returns true if the mission is played in cadet mode and false in veteran mode.2] call {(_this select 0)+(_this select 1)} .html 7/11/2010 .

95 required.com/comref/full. A time of zero results in an immediate change. For the "camera" type. Example: _camera camCommand "Manual on" Category: OFP camera camCommit time Operand types: camera: Object time: Number Type of returned value: Nothing Description: Commits the camera changes smoothly over time. For the "seagull" type it's one of: "landed" and "airborne". The "manual on" and "manual off" commands are recognized for all types. Example: _camera camCommit 5 Category: OFP camera camCommitPrepared time Operand types: camera: Object time: Number Compatibility: Version 2. A time of zero results in an immediate change.BIS Game Engine Scripting Commands Page 40 of 415 Executes a command on the given camera / actor object. the following commands can be used: "inertia on" and "inertia off".arma2.html 7/11/2010 . Example: _camera camCommit 5 Category: OFP camCommitted camera Operand types: camera: Object Type of returned value: Boolean http://www. Type of returned value: Nothing Description: Commits the prepared camera changes smoothly over time.

20] Category: OFP type camCreate position Operand types: type: String position: Array Type of returned value: Object Description: Creates a camera or an actor of the given type on the given initial position (format Position).BIS Game Engine Scripting Commands Page 41 of 415 Description: Checks whether the camera has finished committing. Type of returned value: Nothing Description: Sets construction camera parameters. Its type is one of "CAMERA" or "SEAGULL".y. Example: _camera = camCreate getPos player Category: OFP camDestroy camera Operand types: camera: Object Type of returned value: Nothing Description: http://www.arma2.z]. max above land] Operand types: camera: Object [[x. Example: camCommitted _camera Category: OFP camera camConstuctionSetParams [[x.z]. Example: _camera camConstuctionSetParams [getpos player.50.com/comref/full.html 7/11/2010 .radius. max above land]: Array Compatibility: Version 5501 required.radius.y.

"FRONT" or "BACK" ("BACK" is normally used).arma2. Position is one of: "TOP". "Back"] Category: OFP cameraEffectEnableHUD enable Operand types: enable: Boolean Compatibility: Version 5501 required. The format of effect is [name. "LEFT". "External". Category: OFP http://www.html 7/11/2010 . Category: OFP cameraInterest entity Operand types: entity: Object Compatibility: Version 2. position]. Type of returned value: Nothing Description: Enable / disable showing of in-game UI during currently active camera effect. Name is one of: "Internal". "Fixed" or "FixedWithZoom". Category: OFP camera cameraEffect effect Operand types: camera: Object effect: Array Type of returned value: Nothing Description: Switches the camera to the given vehicle / camera.BIS Game Engine Scripting Commands Page 42 of 415 Destroys the camera. "RIGHT".com/comref/full. Example: cameraEffect ["External". Type of returned value: Number Description: Return camera interest for given entity.57 required.

Example: _camera camCommit 5 http://www. zero means no (infinite) timeout.html 7/11/2010 .90 required.com/comref/full. Type of returned value: String Description: Return type of camera. Category: OFP campaignConfigFile Compatibility: Version 2. Category: OFP cameraView Compatibility: Version 5501 required. Type of returned value: Config Description: Return root of campaign description.arma2.95 required. Type of returned value: Object Description: Returns the vehicle to which the camera is attached. Time gives timeout. Category: OFP PC camera camPreload time Operand types: camera: Object time: Number Compatibility: Version 2.BIS Game Engine Scripting Commands Page 43 of 415 cameraOn Compatibility: Version 1.ext entries hierarchy. Type of returned value: Nothing Description: Preload the scene for he prepared camera.56 required.

See also camPreload and camCommitPrepared. See also camPreload and camCommitPrepared.com/comref/full.html 7/11/2010 .BIS Game Engine Scripting Commands Page 44 of 415 Category: OFP camPreloaded camera Operand types: camera: Object Compatibility: Version 2.95 required.95 required. Type of returned value: Boolean Description: Checks whether the camera has finished preloading. Type of returned value: Nothing Description: Prepares the camera heading. Type of returned value: Nothing Description: Prepares the camera bank angle. Example: _camera camPrepareBank -0.1 Category: OFP camera camPrepareDir direction Operand types: camera: Object direction: Number Compatibility: Version 2. Example: camPreloaded _camera Category: OFP camera camPrepareBank bank Operand types: camera: Object bank: Number Compatibility: Version 2.arma2. Example: http://www.92 required.

html 7/11/2010 . Prepares the camera focus blur. See also camPreload and camCommitPrepared. Type of returned value: Nothing http://www.95 required.blur]. Type of returned value: Nothing Description: Prepares the camera dive angle.BIS Game Engine Scripting Commands Page 45 of 415 _camera camPrepareDir 150 Category: OFP camera camPrepareDive dive Operand types: camera: Object dive: Number Compatibility: Version 2.arma2.95 required. Example: _camera camPrepareFocus [50.1 Category: OFP camera camPrepareFocus focusRange Operand types: camera: Object focusRange: Array Compatibility: Version 2.95 required. See also camPreload and camCommitPrepared. Type of returned value: Nothing Description: focusRange is in format [distance. Example: _camera camPrepareDive -0.com/comref/full. 1] Category: OFP camera camPrepareFov fieldOfView Operand types: camera: Object fieldOfView: Number Compatibility: Version 2.

Example: _camera camPrepareFovRange [0. Example: _camera camPrepareFov 0.1.95 required.1 Category: OFP camera camPrepareFovRange fovRange Operand types: camera: Object fovRange: Array Compatibility: Version 2.com/comref/full.html 7/11/2010 . 0. See also camPreload and camCommitPrepared.BIS Game Engine Scripting Commands Page 46 of 415 Description: Prepares the camera field of view (zoom). Type of returned value: Nothing Description: Prepares the camera position (format Position). See also camPreload and camCommitPrepared.5] Category: OFP camera camPreparePos position Operand types: camera: Object position: Array Compatibility: Version 2. Type of returned value: Nothing Description: Prepares the camera field of view range for auto zooming.95 required.arma2. Example: _camera camPreparePos getPos player Category: OFP camera camPrepareRelPos position Operand types: camera: Object position: Array http://www. See also camPreload and camCommitPrepared.

html 7/11/2010 . Type of returned value: Nothing Description: Prepares the camera target. Example: _camera camPrepareTarget player Category: OFP camera camSetBank bank http://www.95 required. See also camPreload and camCommitPrepared. Type of returned value: Nothing Description: Prepares the camera target to a position (format Position). Example: _camera camPrepareRelPos [10.BIS Game Engine Scripting Commands Page 47 of 415 Compatibility: Version 2.5] Category: OFP camera camPrepareTarget position Operand types: camera: Object position: Array Compatibility: Version 2. Type of returned value: Nothing Description: Prepares the camera position relative to the current position of the currect target (see camPrepareTarget).arma2. See also camPreload and camCommitPrepared.95 required.com/comref/full. See also camPreload and camCommitPrepared.95 required. Example: _camera camPrepareTarget getPos player Category: OFP camera camPrepareTarget target Operand types: camera: Object target: Object Compatibility: Version 2.

com/comref/full.1 Category: OFP camera camSetDir direction Operand types: camera: Object direction: Number Type of returned value: Nothing Description: Sets the camera heading. Example: _camera camSetDive -0. It does not automatically commit changes. It does not automatically commit changes. It does not automatically commit changes.arma2. Example: _camera camSetBank -0.1 Category: OFP camera camSetFocus focusRange Operand types: camera: Object focusRange: Array http://www.html 7/11/2010 .BIS Game Engine Scripting Commands Page 48 of 415 Operand types: camera: Object bank: Number Type of returned value: Nothing Description: Sets the camera bank angle. Example: _camera camSetDir 150 Category: OFP camera camSetDive dive Operand types: camera: Object dive: Number Type of returned value: Nothing Description: Sets the camera dive angle.

0. Sets the camera focus blur. Example: _camera camSetFocus [50.1. It does not automatically commit changes. It does not automatically commit changes.1 Category: OFP camera camSetFovRange fovRange Operand types: camera: Object fovRange: Array Type of returned value: Nothing Description: Sets the camera field of view range for auto zooming.com/comref/full.BIS Game Engine Scripting Commands Page 49 of 415 Type of returned value: Nothing Description: focusRange is in format [distance.5] Category: OFP camera camSetPos position Operand types: camera: Object position: Array Type of returned value: Nothing http://www. 1] Category: OFP camera camSetFov fieldOfView Operand types: camera: Object fieldOfView: Number Type of returned value: Nothing Description: Sets the camera field of view (zoom).arma2. Example: _camera camSetFovRange [0.blur].html 7/11/2010 . It does not automatically commit changes. Example: _camera camSetFov 0.

It does not automatically commit changes.arma2. It does not automatically commit changes. It does not automatically commit changes. http://www.5] Category: OFP camera camSetTarget target Operand types: camera: Object target: Object Type of returned value: Nothing Description: Sets the camera target.html 7/11/2010 .BIS Game Engine Scripting Commands Page 50 of 415 Description: Sets the camera position (format Position). Example: _camera camSetRelPos [10. Example: _camera camSetPos getPos player Category: OFP camera camSetRelPos position Operand types: camera: Object position: Array Type of returned value: Nothing Description: Sets the camera position relative to the current position of the currect target (see camSetTarget).com/comref/full. Example: _camera camSetTarget player Category: OFP camera camSetTarget position Operand types: camera: Object position: Array Type of returned value: Nothing Description: Sets the camera target to a position (format Position). It does not automatically commit changes.

Type of returned value: Object Description: Returns camera's target.com/comref/full.BIS Game Engine Scripting Commands Page 51 of 415 Example: _camera camSetTarget getPos player Category: OFP camTarget camera Operand types: camera: Object Compatibility: Version 5501 required. Example: camTarget _camera Category: OFP camUseNVG set Operand types: set: Boolean Compatibility: Version 2.73 required. Category: OFP canFire vehicle Operand types: vehicle: Object Type of returned value: Boolean Description: Checks whether the given vehicle is able to fire. only for damage. Example: canFire vehicle player Category: OFP http://www. It does not check for ammo.arma2. Type of returned value: Nothing Description: Set / clear using of night vision during cutscenes.html 7/11/2010 .

BIS Game Engine Scripting Commands Page 52 of 415 canMove vehicle Operand types: vehicle: Object Type of returned value: Boolean Description: Checks whether the given vehicle is able to move. Category: OFP captive unit Operand types: unit: Object http://www. Example: canStand player Category: OFP canUnloadInCombat vehicle Operand types: vehicle: Object Compatibility: Version 5501 required. Type of returned value: Boolean Description: Check if cargo of this vehicle want to get out when in combat. Example: canMove vehicle player Category: OFP canStand soldier Operand types: soldier: Object Type of returned value: Boolean Description: Checks whether the given soldier is able to stand up.arma2. only the damage status is checked.html 7/11/2010 . It does not test for fuel.com/comref/full.

Example: captive player Category: OFP case b Operand types: b: Any Type of returned value: Switch Type Description: see switch Category: Default try-Block catch code Operand types: try-Block: Exception Type code: Code Type of returned value: Any Description: processes code.arma2. when exception is thrown in try block Category: Default http://www.html 7/11/2010 . Example: captive player Category: OFP captiveNum unit Operand types: unit: Object Type of returned value: Number Description: Checks whether the unit is a captive. If the unit is a vehicle. its commander is checked instead.com/comref/full. its commander is checked instead. If the unit is a vehicle.BIS Game Engine Scripting Commands Page 53 of 415 Type of returned value: Boolean Description: Checks whether the unit is a captive.

html 7/11/2010 . Example: ceil 5. Category: OFP clearGroupIcons group Operand types: group: Group Compatibility: Version 5501 required. Example: clearGroupIcons group http://www. Type of returned value: Boolean Description: Checks whether cheats are enabled (whether the designers' version is running).56 required.com/comref/full. Category: Resistance civilian Type of returned value: Side Description: The Civilian side.BIS Game Engine Scripting Commands Page 54 of 415 ceil x Operand types: x: Number Type of returned value: Number Description: The ceil value of x. result is 6 Category: Default cheatsEnabled Compatibility: Version 1. Type of returned value: Nothing Description: Removes all icon from group.25 .arma2.

Type of returned value: Nothing Description: Clear the current overlay. Example: clearMagazineCargo jeepOne Category: OFP clearMagazinePool Compatibility: Version 1. Example: clearOverlay _map Category: Editor clearRadio http://www. Type of returned value: Nothing Description: Removes all magazines from the weapon pool (this is used in campaigns to transfer weapons to the next mission). Category: Resistance clearOverlay map Operand types: map: Control Compatibility: Version 2.html 7/11/2010 .92 required.arma2.75 required.BIS Game Engine Scripting Commands Page 55 of 415 Category: OFP clearMagazineCargo unit Operand types: unit: Object Type of returned value: Nothing Description: Removes all magazines from the vehicle cargo space.com/comref/full.

Type of returned value: Nothing Description: Clean up the content of radio protocol history.BIS Game Engine Scripting Commands Page 56 of 415 Compatibility: Version 2. http://www.html 7/11/2010 .73 required. Type of returned value: Nothing Description: Clear vehicle init field. Category: OFP clearVehicleInit vehicle Operand types: vehicle: Object Compatibility: Version 5154 required.com/comref/full. Example: clearVehicleInit soldier3 Category: OFP clearWeaponCargo unit Operand types: unit: Object Type of returned value: Nothing Description: Removes all weapons from the vehicle cargo space. Type of returned value: Nothing Description: Removes all weapons from the weapon pool (this is used in campaigns to transfer weapons to the next mission).arma2.75 required. Example: clearWeaponCargo jeepOne Category: OFP clearWeaponPool Compatibility: Version 1.

Example: closeDialog 1 Category: Resistance display closeDisplay exitcode Operand types: display: Display exitcode: Number Compatibility: Version 2. Type of returned value: Nothing Description: Close given display. Example: _display closeDisplay IDC_OK Category: OFP PC closeOverlay map Operand types: map: Control Compatibility: Version 2. Type of returned value: Nothing Description: Closes the current overlay without committing.com/comref/full.arma2.html 7/11/2010 .BIS Game Engine Scripting Commands Page 57 of 415 Category: Resistance closeDialog idc Operand types: idc: Number Compatibility: Version 1.50 required. Type of returned value: Nothing Description: Closes the topmost user dialog as if a button with id idc was pressed. Category: Editor http://www.53 required.92 required.

com/comref/full."GREEN"."YELLOW" or "RED"). Example: soldierOne commandChat "Show this text" Category: OFP http://www.html 7/11/2010 . Type of returned value: Nothing Description: Types text to the command radio channel. Example: combatMode group player Category: OFP unit commandChat chatText Operand types: unit: Object or Array chatText: String Compatibility: Version 5501 required.92 required. you have to execute it on all of them.BIS Game Engine Scripting Commands Page 58 of 415 collapseObjectTree map Operand types: map: Control Compatibility: Version 2. it does not broadcast the message. If you want the message to show on all computers.arma2. Note: this function only types text to the list. Type of returned value: Nothing Description: Collapse the object tree. Example: collapseObjectTree _map Category: Editor combatMode grp Operand types: grp: Object or Group Type of returned value: String Description: Returns the combat mode of the given unit ("BLUE".

but a person. the person is returned instead. Example: soldierOne commandFollow player Category: OFP http://www. If the vehicle is not a vehicle.arma2. If the target is objNull.BIS Game Engine Scripting Commands Page 59 of 415 commander vehicle Operand types: vehicle: Object Type of returned value: Object Description: Returns the commander of the vehicle. Example: soldierOne commandFire player Category: OFP unit commandFollow formationLeader Operand types: unit: Object or Array formationLeader: Object Type of returned value: Nothing Description: Orders a unit to follow the given unit (via the radio).com/comref/full. the unit is ordered to commence firing on its current target (set using doTarget or commandTarget).html 7/11/2010 . Example: commander vehicle player Category: OFP unit commandFire target Operand types: unit: Object or Array target: Object Type of returned value: Nothing Description: Orders a unit to commence firing on the given target (via the radio).

target] Operand types: unit(s): Object or Array [fsm name.28 required. Type of returned value: Nothing Description: Orders the unit to get out from the vehicle (via the radio).53 required. Type of returned value: String Description: Return the name of the topmost commanding menu. position. Example: soldierOne commandFSM ["move. Example: commandGetOut unitOne Category: OFP commandingMenu Compatibility: Version 5501 required.arma2. position player. player] Category: OFP PC commandGetOut unit Operand types: unit: Object or Array Compatibility: Version 2.html 7/11/2010 . Category: OFP unit commandMove position Operand types: unit: Object or Array http://www. Type of returned value: Nothing Description: Orders a unit to process command defined by FSM file (via the radio).com/comref/full. position.BIS Game Engine Scripting Commands Page 60 of 415 unit(s) commandFSM [fsm name.fsm". target]: Array Compatibility: Version 2.

html 7/11/2010 . Note: the stop command is never finished.BIS Game Engine Scripting Commands Page 61 of 415 position: Array Type of returned value: Nothing Description: Orders the unit to move to the given position (format Position) (via the radio). Example: soldierOne commandRadio "messageOne" Category: OFP commandStop unit Operand types: unit: Object or Array Type of returned value: Nothing Description: Orders the unit to stop (via the radio).arma2. The message is defined in the description. the unit will never be ready. Type of returned value: Nothing Description: Sends the message to the command radio channel.com/comref/full.ext file or radio protocol. Example: commandStop unitOne Category: OFP unit commandTarget position Operand types: unit: Object or Array http://www. Example: soldierOne commandMove getMarkerPos "MarkerMoveOne" Category: OFP unit commandRadio radioName Operand types: unit: Object or Array radioName: String Compatibility: Version 5501 required.

Example: soldierOne commandWatch player Category: OFP comment comment Operand types: comment: String Compatibility: Version 1.arma2.85 required. Example: soldierOne commandWatch getMarkerPos "MarkerMoveOne" Category: OFP unit commandWatch target Operand types: unit: Object or Array target: Object Type of returned value: Nothing Description: Orders the unit to watch the given target (via the radio).BIS Game Engine Scripting Commands Page 62 of 415 position: Object Type of returned value: Nothing Description: Orders the unit to target the given target (via the radio). Example: soldierOne commandTarget player Category: OFP unit commandWatch position Operand types: unit: Object or Array position: Array Type of returned value: Nothing Description: Orders the unit to watch the given position (format Position) (via the radio). Type of returned value: http://www.html 7/11/2010 .com/comref/full.

" Category: Default commitOverlay map Operand types: map: Control Compatibility: Version 2. Type of returned value: Code Description: Compile expression.92 required. It's used to create comments. Type of returned value: Nothing Description: Commit the current overlay. _compiled = compile _function.arma2.html 7/11/2010 . Category: Default completedFSM FSM handle Operand types: FSM handle: Number Compatibility: Version 5500 required.com/comref/full.60 required. Example: _function = "a = a + 1". Example: comment "This is a comment. Type of returned value: http://www. Example: commitOverlay _map Category: Editor compile expression Operand types: expression: String Compatibility: Version 2. call _compiled.BIS Game Engine Scripting Commands Page 63 of 415 Nothing Description: This function does nothing.

.paa". image "data\isniper. . Category: OFP composeText [text1.]: Array Compatibility: Version 2.35 required. Category: OFP PC configName config Operand types: config: Config Compatibility: Version 2. Example: _name = configName (configFile >> "CfgVehicles") .] Operand types: [text1. The FSM handle is the number returned by the execFSM command. text2.. lineBreak. text2.html 7/11/2010 . "Second line"] Category: OFP configFile Compatibility: Version 2. ..35 required.arma2. Type of returned value: String Description: Returns name of config entry. Example: txt = composeText ["First line".BIS Game Engine Scripting Commands Page 64 of 415 Boolean Description: Check whether the given FSM completes. Type of returned value: Structured text Description: Creates a structured text by joining the given structured or plain texts..com/comref/full.01 required. result is "CfgVehicles" http://www. Type of returned value: Config Description: Return root of config entries hierarchy.

Type of returned value: Nothing http://www. Type of returned value: String Description: Return the content of the (text) clipboard. Category: OFP copyToClipboard text Operand types: text: String Compatibility: Version 5500 required. Type of returned value: Control Description: A non-existing control. Type of returned value: Nothing Description: Copy the text to the clipboard.92 required. Category: OFP groupTo copyWaypoints groupFrom Operand types: groupTo: Group groupFrom: Group Compatibility: Version 5500 required. Category: OFP PC copyFromClipboard Compatibility: Version 5500 required.arma2. including itself.BIS Game Engine Scripting Commands Page 65 of 415 Category: OFP PC controlNull Compatibility: Version 2.com/comref/full. This value is not equal to anything.html 7/11/2010 .

arma2.html 7/11/2010 . Type of returned value: Number Description: Returns count of subentries. result is 4 http://www.5 Category: Default count config Operand types: config: Config Compatibility: Version 2. Category: OFP cos x Operand types: x: Number Type of returned value: Number Description: The cosine of x. the argument is in degrees. result is 0. Example: _count = count (configFile >> "CfgVehicles") Category: OFP PC count array Operand types: array: Array Type of returned value: Number Description: The number of elements in the array. Example: cos 60 .35 required.BIS Game Engine Scripting Commands Page 66 of 415 Description: Copy the chain of waypoints from source to target group. The target group will start to process waypoints from the first one.com/comref/full.1.0.2] . Example: count [0.

arma2. Example: player countEnemy list triggerOne Category: OFP unit countFriendly array Operand types: unit: Object array: Array Type of returned value: Number Description: Counts how many units in the array are considered friendly by the given unit.com/comref/full.BIS Game Engine Scripting Commands Page 67 of 415 Category: Default condition count array Operand types: condition: Code array: Array Type of returned value: Number Description: Counts the elements in the array for which the given condition is true. Example: "_x > 2" count [0. 3. It is calculated as follows: 1) Set the count to 0. result is 2 Category: Default unit countEnemy array Operand types: unit: Object array: Array Type of returned value: Number Description: Counts how many units in the array are considered enemy by the given unit. Example: player countFriendly list triggerOne Category: OFP http://www. increase the count. 3] . 2) For each element in the array assign an element as _x and evaluate the condition expression. 1.html 7/11/2010 . 2. If it's true. 1.

html 7/11/2010 . placement. Example: "Tank" countType list triggerOne Category: OFP unit countUnknown array Operand types: unit: Object array: Array Type of returned value: Number Description: Counts how many units in the array are considered unknown to the given unit. For types see CfgVehicles. special] http://www. Example: west countSide list triggerOne Category: OFP typeName countType array Operand types: typeName: String array: Array Type of returned value: Number Description: Counts how many vehicles in the array are of the given type.BIS Game Engine Scripting Commands Page 68 of 415 side countSide array Operand types: side: Side array: Array Type of returned value: Number Description: Checks how many vehicles belong to the given side. position. markers.com/comref/full.arma2. Example: player countUnknown list triggerOne Category: OFP createAgent [type.

position. markers. The class name is searched in the description. "FORM"] Category: OFP createCenter side Operand types: side: Side Compatibility: Version 1. placement. special]: Array Compatibility: Version 2. Example: center = createCenter East Category: OFP createDialog name Operand types: name: String Compatibility: Version 1. Example: _ok = createDialog "RscDisplayGame" Category: Resistance http://www.cpp file. Type of returned value: Side Description: Creates a new AI center for the given side. Special properties can be: "NONE" and "FORM". Type of returned value: Object Description: Creates an (independent) agent (person) of the given type (type is a name of a subclass of CfgVehicles).ext file of the campaign and the globlal resource. Otherwise. the given position is used. []. If a user dialog already exists. position player.50 required.com/comref/full.BIS Game Engine Scripting Commands Page 69 of 415 Operand types: [type.86 required. The function returns its success. the position of a random one is used. 0.89 required. The unit is placed inside a circle with this position as its center and placement as its radius.arma2. it creates a child dialog of the topmost user dialog. the description. Type of returned value: Boolean Description: Creates a user dialog from the resource template name.ext file of the mission. If the markers array contains several marker names.html 7/11/2010 . Example: agent = createAgent ["SoldierWB".

Example: _link = createDiarySubject ["Group". Record is selected based on given object (diary record.com/comref/full. object. "Kill all enemies."] Category: Identity person createDiarySubject [subject. [title. state))]: Array Compatibility: Version 2. task(. [title. task or unit). "Player"] Category: Identity person createDiaryRecord [subject.BIS Game Engine Scripting Commands Page 70 of 415 createDiaryLink [subject. text]: Array Compatibility: Version 5500 required. state))] or [subject. task(.53 required. state))] or [subject. text(.arma2. text](. display name. picture]: Array Compatibility: Version 2. task(. Example: _record = player createDiaryRecord ["diary". text](. display name] or [subject. player. Type of returned value: String Description: Create a link to the section of diary given by subject. text] Operand types: [subject. display name. picture] Operand types: person: Object [subject.92 required. Example: http://www. Type of returned value: Number Description: Create a new subject page in a log. task(.html 7/11/2010 . state))] Operand types: person: Object [subject. text(. object. Type of returned value: Diary record Description: Create a new record in a log. display name] or [subject.

resource] Operand types: [unit.arma2."RscDisplayGear"] Category: OFP createGroup side Operand types: side: Side Compatibility: Version 1. Example: _display createDisplay "RscObserver" Category: OFP PC CreateGearDialog [unit. http://www.BIS Game Engine Scripting Commands Page 71 of 415 _index = player createDiarySubject ["myPage".53 required.html 7/11/2010 . Type of returned value: Group Description: Creates a new AI group for the given center (side).86 required.resource]: Array Compatibility: Version 5501 required.com/comref/full. Example: CreateGearDialog [palyer. Type of returned value: Nothing Description: Opens gear dialog for given unit. Type of returned value: Nothing Description: Create child display of given display and load from resource "name". "My page"] Category: Identity parent createDisplay name Operand types: parent: Display name: String Compatibility: Version 2.

otherwise the given position is guarded. If the given vehicle is valid. position] Operand types: [name. vehicle player] Category: OFP createLocation [type. The marker is created on all computers in a network session.arma2. sizeX. Example: point = createGuardedPoint [East.com/comref/full.86 required. the position of a static object with the given id is guarded. [0. position]: Array Compatibility: Version 1. position. idStatic.html 7/11/2010 . sizeZ] Operand types: [type. If idStatic is not negative. position. Type of returned value: Nothing Description: Adds a point guarded by the given side. sizeZ]: Array Compatibility: Version 2. -1.86 required. idStatic. position. sizeX. Type of returned value: Location Description: Create location of given type with given size at given position. The marker name has to be unique.BIS Game Engine Scripting Commands Page 72 of 415 Example: group = createGroup East Category: OFP createGuardedPoint [side. vehicle]: Array Compatibility: Version 1. the starting position of the vehicle is guarded. Type of returned value: String Description: Creates a new marker on the given position. Category: Location createMarker [name. position. http://www.90 required. vehicle] Operand types: [side. 0].

position]: Array Compatibility: Version 2. position] Operand types: [name.html 7/11/2010 .32 required. Type of returned value: Nothing Description: Creates a previously added menu.arma2. The marker is only created on the computer where the command is called. the given position is used. Otherwise. markers.BIS Game Engine Scripting Commands Page 73 of 415 Example: marker = createMarker [Marker1. If the markers array contains several marker names. Example: marker = createMarkerLocal [Marker1. Category: Editor createMine [type. position. markers. placement] Operand types: [type. Type of returned value: String Description: Creates a new marker on the given position. position player] Category: OFP createMarkerLocal [name.92 required.com/comref/full. the position of a random one is used. The mine is placed inside a circle with this position as its center and placement as its http://www. position. position player] Category: OFP map createMenu index Operand types: map: Control index: Number Compatibility: Version 2. Type of returned value: Object Description: Creates a mine of the given type (type is the name of the subclass of CfgVehicles).92 required. The marker name has to be unique. placement]: Array Compatibility: Version 2.

position player. Category: Identity createSoundSource [type. Example: _display createMissionDisplay "Tutorial" Category: OFP PC person createSimpleTask [name] or [name. markers.BIS Game Engine Scripting Commands Page 74 of 415 radius. 0] Category: OFP parent createMissionDisplay root Operand types: parent: Display root: String Compatibility: Version 5140 required. position.arma2. Type of returned value: Task Description: Create a new simple task (subtask of parentTask).com/comref/full. Type of returned value: Display Description: Create single missions display as a child of given display. markers. placement]: Array Compatibility: Version 2. Type of returned value: Object Description: http://www. parentTask] Operand types: person: Object [name] or [name. placement] Operand types: [type. parentTask]: Array Compatibility: Version 5500 required. []. position.32 required.html 7/11/2010 . Example: mine = createMine ["MineMine". The mission dialog will be set to the directory given as an argument "root".

com/comref/full. Category: Identity createTrigger [type. the given position is used. Type of returned value: Object Description: Creates a new trigger on the given position. priority. this type must be a class name in CfgNonAIVehicles or CfgVehicles with simulation=detector. Type is name of registered task type. 0] Category: OFP teamMember createTask [[type] or [type. position. markers. Example: trigger = createTrigger["EmptyDetector". Example: soundSource = createSoundSource ["LittleDog". []. The sound source is placed inside a circle with this position as its center and placement as its radius.. special]: Array Compatibility: http://www. position]: Array Compatibility: Version 1. markers. placement. position] Operand types: [type.. special] Operand types: group: Group [type.] Operand types: teamMember: [[type] or [type.]: Array Compatibility: Version 2.62 required. priority. value1..86 required. position player. . name1. name1. position. value2. parentTask]. name2.BIS Game Engine Scripting Commands Page 75 of 415 Creates a sound source of the given type (type is the name of the subclass of CfgVehicles). value2. the position of a random one is used.html 7/11/2010 . parentTask]. Type of returned value: Task Description: Create a new AI task (subtask of parentTask). name2. An object of the given type is created. Otherwise.. . placement.arma2. position player] Category: OFP group createUnit [type. value1. If the markers array contains several marker names.

"FLY" and "FORM". Type of returned value: Object Description: Creates a vehicle of the given type (type is the name of the subclass in CfgVehicles). Type of returned value: Object Description: Creates a unit (person) of the given type (type is a name of a subclass of CfgVehicles) and makes it a member of the given group.32 required. If the markers array contains several marker names.BIS Game Engine Scripting Commands Page 76 of 415 Version 2. 0. position. Example: "SoldierWB" createUnit [getMarkerPos "barracks".34 required. group (Group). 0. the position of a random one is used. Example: veh = createVehicle ["Cobra". Type of returned value: Nothing Description: Creates a unit of the given type. skill (Number). "PRIVATE". skill and rank are optional. Otherwise. Special properties can be: "NONE". The format of unitInfo is: [pos (Position). The vehicle is placed inside a circle with this position as center and placement as its radius. 0. Example: unit = group player createUnit ["SoldierWB". init (String). Their default values are "". the given position is used. position player. Otherwise. "FORM"] Category: OFP type createUnit unitInfo Operand types: type: String unitInfo: Array Compatibility: Version 1. placement. the position of a random one is used. markers.5. special] Operand types: [type.html 7/11/2010 . placement. Note: init. []. "FLY"] Category: OFP http://www. If the markers array contains several marker names. rank (String)]. position player. The unit is placed inside a circle with this position as its center and placement as its radius. markers. Special properties can be: "NONE" and "FORM". special]: Array Compatibility: Version 2.arma2.com/comref/full. []. position. the given position is used. groupAlpha] Category: OFP createVehicle [type.32 required.

BIS Game Engine Scripting Commands Page 77 of 415 type createVehicle pos Operand types: type: String pos: Array Compatibility: Version 1.56 required. See CfgVehicles for possible type values. Example: _tank = "M1Abrams" createVehicle getmarkerpos "tankFactory" Category: OFP type createVehicleLocal pos Operand types: type: String pos: Array Compatibility: Version 2. Type of returned value: Object Description: Creates an empty vehicle of the given type. Example: crew vehicle player http://www. a list containing only persons is returned. but person. If the vehicle is not a vehicle. See CfgVehicles for possible type values. Vehicle is not transferred through network in MP games. Pos is in format Position.com/comref/full.34 required. Pos is in format Position. Example: _tank = "M1Abrams" createVehicleLocal getmarkerpos "tankFactory" Category: OFP crew vehicle Operand types: vehicle: Object Type of returned value: Array Description: Returns all units mounted in the given vehicle.html 7/11/2010 .arma2. Type of returned value: Object Description: Creates an empty vehicle of the given type.

Type of returned value: Number Description: Returns number of seconds until auto-scroll starts. function] Operand types: control: Control [handler name. Example: _delay = ctrlAutoScrollDelay _control http://www. Type of returned value: Nothing Description: Launch actions attached to given (button based) control. Type of returned value: Number Description: Add an event handler to the given control.92 required.arma2.BIS Game Engine Scripting Commands Page 78 of 415 Category: OFP ctrlActivate control Operand types: control: Control Compatibility: Version 2.com/comref/full. function]: Array Compatibility: Version 5501 required. ""] Category: OFP PC ctrlAutoScrollDelay control Operand types: control: Control Compatibility: Version 5501 required. -2 if scrollbar not present. Returns id of the handler or -1 when failed. Example: ctrlActivate _control Category: OFP PC control ctrlAddEventHandler [handler name. Example: _id = _control ctrlAddEventHandler ["KeyDown".html 7/11/2010 .

-2 if scrollbar not present. Type of returned value: Nothing Description: Commit control animation.com/comref/full.html 7/11/2010 . Type of returned value: Boolean Description: True if auto-scroll should move back to start after it reach end.50 required. Example: _speed = ctrlAutoScrollSpeed _control Category: OFP PC control ctrlCommit time Operand types: control: Control time: Number Compatibility: Version 2.arma2. Type of returned value: Number Description: Returns number of seconds to auto-scroll one line.BIS Game Engine Scripting Commands Page 79 of 415 Category: OFP PC ctrlAutoScrollRewind control Operand types: control: Control Compatibility: Version 5501 required. Example: _rewind = ctrlAutoScrollRewind _control Category: OFP PC ctrlAutoScrollSpeed control Operand types: control: Control Compatibility: Version 5501 required. http://www. -1 if auto-scroll is disabled.

false] Category: Resistance control ctrlEnable enable Operand types: control: Control enable: Boolean Compatibility: Version 2.50 required.50 required. http://www. Type of returned value: Nothing Description: Enables / disables the control with id idc of the topmost user dialog.com/comref/full. Type of returned value: Nothing Description: Enable / disable given control. enable]: Array Compatibility: Version 1. Example: _done = ctrlCommitted _control Category: OFP PC ctrlEnable [idc.BIS Game Engine Scripting Commands Page 80 of 415 Example: _control ctrlCommit 2 Category: OFP PC ctrlCommitted control Operand types: control: Control Compatibility: Version 2. enable] Operand types: [idc.html 7/11/2010 .arma2. Type of returned value: Boolean Description: Check if the control animation is finished.50 required. Example: ctrlEnable [100.

html 7/11/2010 . Example: _ok = ctrlEnabled _control Category: OFP PC ctrlEnabled idc Operand types: idc: Number Compatibility: Version 1.50 required. http://www.arma2.50 required. Type of returned value: Boolean Description: Returns whether the control with id idc of the topmost user dialog is enabled. Type of returned value: Number Description: Returns the current fade factor of control. Type of returned value: Boolean Description: Returns whether given control is enabled.50 required.com/comref/full.BIS Game Engine Scripting Commands Page 81 of 415 Example: _control ctrlEnable false Category: OFP PC ctrlEnabled control Operand types: control: Control Compatibility: Version 2. Example: _enabled = ctrlEnabled 100 Category: Resistance ctrlFade control Operand types: control: Control Compatibility: Version 2.

1.92 required. The format of frame is [time.html 7/11/2010 . position].92 required.92 required. Type of returned value: Nothing Description: Adds the next frame to the map animation. Category: OFP PC ctrlMapAnimCommit control Operand types: control: Control Compatibility: Version 2.arma2. getMarkerPos "anim1"] Category: OFP PC ctrlMapAnimClear control Operand types: control: Control Compatibility: Version 2. the format of position is Position2D. Example: _map ctrlMapAnimAdd [1.com/comref/full. Type of returned value: Nothing Description: Clears the map animation. zoom. Type of returned value: Nothing Description: Plays the map animation. http://www.BIS Game Engine Scripting Commands Page 82 of 415 Example: _scale = ctrlFade _control Category: OFP PC map ctrlMapAnimAdd frame Operand types: map: Control frame: Array Compatibility: Version 1. 0.

"Scroll") to custom one. To restore default texture."Array".arma2.com/comref/full. If new texture does not exist.BIS Game Engine Scripting Commands Page 83 of 415 Category: OFP PC ctrlMapAnimDone control Operand types: control: Control Compatibility: Version 2.html 7/11/2010 . Type of returned value: Boolean Description: Checks whether the map animation has finished.92 required. default cursor texture is used."customCursor"] Category: OFP ctrlMapMouseOver control Operand types: control: Control Compatibility: Version 5501 required. write empty string. Category: OFP PC control ctrlMapCursor texture names Operand types: control: Control texture names: Array Compatibility: Version 5501 required. Example: <map_control> ctrlMapCursor ["Track". Category: OFP http://www. Type of returned value: Nothing Description: Changes default cursor texture ("Track". Type of returned value: Array Description: Returns description of map sign mouse cursor is over. "Move".

arma2. Category: OFP PC map ctrlMapScreenToWorld [x.92 required. Category: OFP PC map ctrlMapWorldToScreen position Operand types: map: Control position: Array Compatibility: Version 5127 required.com/comref/full. Type of returned value: Number Description: Return the current scale of the map control. y]: Array Compatibility: Version 5127 required.BIS Game Engine Scripting Commands Page 84 of 415 ctrlMapScale control Operand types: control: Control Compatibility: Version 2.html 7/11/2010 . Type of returned value: Array Description: Convert position in the map from screen coordinates to world coordinates. y] Operand types: map: Control [x.50 required. Type of returned value: Array Description: Convert position in the map from world coordinates to screen coordinates. Category: OFP PC ctrlParent control Operand types: control: Control Compatibility: Version 2. Type of returned value: http://www.

Type of returned value: Nothing Description: Remove all even handlers from the given control. Example: _pos = ctrlPosition _control Category: OFP PC control ctrlRemoveAllEventHandlers handler name Operand types: control: Control handler name: String Compatibility: Version 5501 required.BIS Game Engine Scripting Commands Page 85 of 415 Display Description: Returns container of given control.html 7/11/2010 . id] Operand types: control: Control [handler name.com/comref/full. Example: _display = ctrlParent _control Category: OFP PC ctrlPosition control Operand types: control: Control Compatibility: Version 2. Type of returned value: Array Description: Returns the current position and size of control as [x.arma2. w. y.50 required. id]: Array Compatibility: http://www. h] array. Example: _control ctrlRemoveAllEventHandlers "KeyDown" Category: OFP PC control ctrlRemoveEventHandler [handler name.

0] Category: OFP PC ctrlScale control Operand types: control: Control Compatibility: Version 5501 required.BIS Game Engine Scripting Commands Page 86 of 415 Version 5501 required. Example: _control ctrlRemoveEventHandler ["KeyDown".arma2. 1] Category: OFP PC control ctrlSetAutoScrollDelay delay Operand types: control: Control http://www. Type of returned value: Number Description: Returns the current scale of control. Type of returned value: Nothing Description: Remove a given event handler from the given control.com/comref/full. 0. Color is in format Color.50 required. 0.html 7/11/2010 . Example: _scale = ctrlScale _control Category: OFP PC display ctrlSetActiveColor color Operand types: display: Control color: Array Compatibility: Version 2. Type of returned value: Nothing Description: Sets text color of given control when control is selected. Example: _control ctrlSetActiveColor [1.

Example: _control ctrlSetAutoScrollDelay 5 Category: OFP PC control ctrlSetAutoScrollSpeed speed Operand types: control: Control speed: Number Compatibility: Version 5501 required.BIS Game Engine Scripting Commands Page 87 of 415 delay: Number Compatibility: Version 5501 required. Example: _control ctrlSetAutoScrollDelay 5 Category: OFP PC control ctrlSetAutoScrollRewind delay Operand types: control: Control delay: Boolean Compatibility: Version 5501 required. Type of returned value: Nothing Description: Sets number of second before auto-scroll starts.arma2. Example: _control ctrlSetAutoScrollSpeed 5 Category: OFP PC display ctrlSetBackgroundColor color http://www. If speed smaller than 0. Type of returned value: Nothing Description: Sets number of second required to scroll to next line. auto-scroll is disabled.com/comref/full.html 7/11/2010 . Type of returned value: Nothing Description: Defines if scroll should rewind when auto-scroll reach end.

html 7/11/2010 .arma2. Example: _control ctrlSetBackgroundColor [1. 0. Type of returned value: Nothing Description: Sets given event handler of given control Example: _control ctrlSetEventHandler ["KeyDown".50 required. ""] Category: OFP PC control ctrlSetFade fade Operand types: control: Control fade: Number Compatibility: Version 2. Color is in format Color. function]: Array Compatibility: Version 2.54 required. Example: _control ctrlSetFade 1 Category: OFP PC http://www. Type of returned value: Nothing Description: Sets background color of given control. function] Operand types: control: Control [handler name. Type of returned value: Nothing Description: Sets wanted transparency for control animation.BIS Game Engine Scripting Commands Page 88 of 415 Operand types: display: Control color: Array Compatibility: Version 2. 1] Category: OFP PC control ctrlSetEventHandler [handler name.com/comref/full.50 required. 0.

Type of returned value: Nothing Description: Sets H1 font of given HTML control. Type of returned value: Nothing Description: Sets the main font of given control. Example: ctrlSetFocus _control Category: OFP PC control ctrlSetFont name Operand types: control: Control name: String Compatibility: Version 2. Example: _control ctrlSetFontH1 "TahomaB" Category: OFP PC http://www.92 required.com/comref/full.50 required.BIS Game Engine Scripting Commands Page 89 of 415 ctrlSetFocus control Operand types: control: Control Compatibility: Version 2. Example: _control ctrlSetFont "TahomaB" Category: OFP PC control ctrlSetFontH1 name Operand types: control: Control name: String Compatibility: Version 2.50 required.arma2. Type of returned value: Nothing Description: Set the input focus on given control.html 7/11/2010 .

50 required. Type of returned value: Nothing Description: Sets H2 bold font of given HTML control.com/comref/full. Example: _control ctrlSetFontH2 "TahomaB" Category: OFP PC control ctrlSetFontH2B name Operand types: control: Control name: String Compatibility: Version 2. Type of returned value: Nothing Description: Sets H2 font of given HTML control.50 required.arma2.BIS Game Engine Scripting Commands Page 90 of 415 control ctrlSetFontH1B name Operand types: control: Control name: String Compatibility: Version 2.html 7/11/2010 . Type of returned value: Nothing Description: Sets H1 bold font of given HTML control. Example: _control ctrlSetFontH1B "TahomaB" Category: OFP PC control ctrlSetFontH2 name Operand types: control: Control name: String Compatibility: Version 2. Example: _control ctrlSetFontH2B "TahomaB" Category: OFP PC http://www.50 required.

Example: _control ctrlSetFontH3 "TahomaB" Category: OFP PC control ctrlSetFontH3B name Operand types: control: Control name: String Compatibility: Version 2. Type of returned value: Nothing Description: Sets H3 bold font of given HTML control. Example: _control ctrlSetFontH4 "TahomaB" http://www.50 required.com/comref/full.50 required.BIS Game Engine Scripting Commands Page 91 of 415 control ctrlSetFontH3 name Operand types: control: Control name: String Compatibility: Version 2. Example: _control ctrlSetFontH3B "TahomaB" Category: OFP PC control ctrlSetFontH4 name Operand types: control: Control name: String Compatibility: Version 2. Type of returned value: Nothing Description: Sets H4 font of given HTML control.arma2.html 7/11/2010 . Type of returned value: Nothing Description: Sets H3 font of given HTML control.50 required.

Example: _control ctrlSetFontH4B "TahomaB" Category: OFP PC control ctrlSetFontH5 name Operand types: control: Control name: String Compatibility: Version 2.BIS Game Engine Scripting Commands Page 92 of 415 Category: OFP PC control ctrlSetFontH4B name Operand types: control: Control name: String Compatibility: Version 2.arma2. Type of returned value: Nothing Description: Sets H5 bold font of given HTML control. Type of returned value: Nothing Description: Sets H4 bold font of given HTML control. http://www.html 7/11/2010 .com/comref/full. Example: _control ctrlSetFontH5 "TahomaB" Category: OFP PC control ctrlSetFontH5B name Operand types: control: Control name: String Compatibility: Version 2. Type of returned value: Nothing Description: Sets H5 font of given HTML control.50 required.50 required.50 required.

arma2.50 required.50 required.BIS Game Engine Scripting Commands Page 93 of 415 Example: _control ctrlSetFontH5B "TahomaB" Category: OFP PC control ctrlSetFontH6 name Operand types: control: Control name: String Compatibility: Version 2.50 required. Type of returned value: Nothing Description: Sets H5 font of given HTML control. Type of returned value: Nothing Description: Sets H6 bold font of given HTML control. Example: _control ctrlSetFontH6B "TahomaB" Category: OFP PC control ctrlSetFontHeight height Operand types: control: Control height: Number Compatibility: Version 2.html 7/11/2010 .com/comref/full. Type of returned value: Nothing http://www. Example: _control ctrlSetFontH6 "TahomaB" Category: OFP PC control ctrlSetFontH6B name Operand types: control: Control name: String Compatibility: Version 2.

BIS Game Engine Scripting Commands Page 94 of 415 Description: Sets the main font size of given control. Type of returned value: Nothing Description: Sets H1 font size of given HTML control. Example: _control ctrlSetFontHeightH1 0.arma2. Example: _control ctrlSetFontHeightH2 0. Example: _control ctrlSetFontHeight 0.05 Category: OFP PC control ctrlSetFontHeightH1 height Operand types: control: Control height: Number Compatibility: Version 2.com/comref/full.05 Category: OFP PC control ctrlSetFontHeightH3 height Operand types: control: Control height: Number Compatibility: http://www.html 7/11/2010 . Type of returned value: Nothing Description: Sets H2 font size of given HTML control.50 required.50 required.05 Category: OFP PC control ctrlSetFontHeightH2 height Operand types: control: Control height: Number Compatibility: Version 2.

com/comref/full.html 7/11/2010 .50 required.05 Category: OFP PC control ctrlSetFontHeightH6 height Operand types: http://www. Type of returned value: Nothing Description: Sets H4 font size of given HTML control. Example: _control ctrlSetFontHeightH4 0. Example: _control ctrlSetFontHeightH3 0.arma2.BIS Game Engine Scripting Commands Page 95 of 415 Version 2. Example: _control ctrlSetFontHeightH5 0. Type of returned value: Nothing Description: Sets H5 font size of given HTML control.50 required.50 required. Type of returned value: Nothing Description: Sets H3 font size of given HTML control.05 Category: OFP PC control ctrlSetFontHeightH5 height Operand types: control: Control height: Number Compatibility: Version 2.05 Category: OFP PC control ctrlSetFontHeightH4 height Operand types: control: Control height: Number Compatibility: Version 2.

50 required.com/comref/full. Type of returned value: Nothing Description: Sets P font size of given HTML control.50 required.BIS Game Engine Scripting Commands Page 96 of 415 control: Control height: Number Compatibility: Version 2. Example: _control ctrlSetFontHeightP 0.50 required. Example: _control ctrlSetFontP "TahomaB" Category: OFP PC control ctrlSetFontP height Operand types: control: Control height: Number Compatibility: Version 2. Type of returned value: Nothing Description: Sets H6 font size of given HTML control. Type of returned value: Nothing Description: Sets P font of given HTML control.arma2.05 Category: OFP PC control ctrlSetFontPB name http://www.html 7/11/2010 .05 Category: OFP PC control ctrlSetFontP name Operand types: control: Control name: String Compatibility: Version 2. Example: _control ctrlSetFontHeightH6 0.

h] Operand types: control: Control [x. Type of returned value: Nothing Description: Sets P bold font of given HTML control.com/comref/full. h]: Array Compatibility: Version 2. Example: _control ctrlSetPosition [0.50 required. y. 0.BIS Game Engine Scripting Commands Page 97 of 415 Operand types: control: Control name: String Compatibility: Version 2. 0. w. 0. Color is in format Color.5] Category: OFP PC http://www.html 7/11/2010 . Width and height are optional. y.arma2.50 required. Type of returned value: Nothing Description: Sets background color of given control. 1] Category: OFP PC control ctrlSetPosition [x. Type of returned value: Nothing Description: Sets wanted position and size for control animation.5. w. Example: _control ctrlSetForegroundColor [1.50 required. Example: _control ctrlSetFontPB "TahomaB" Category: OFP PC display ctrlSetForegroundColor color Operand types: display: Control color: Array Compatibility: Version 2.

"Hello.com/comref/full.5 Category: OFP PC control ctrlSetStructuredText structured text Operand types: control: Control structured text: Structured text Compatibility: Version 2.Second line" Category: OFP PC ctrlSetText [idc.&ltbr/&gt. Example: _control ctrlScale 0.53 required.BIS Game Engine Scripting Commands Page 98 of 415 control ctrlSetScale scale Operand types: control: Control scale: Number Compatibility: Version 5501 required. Type of returned value: Nothing Description: Sets wanted scale for control animation.arma2. edit lines and active texts.50 required. This can be used for static texts. Example: _control ctrlSetStructuredText parseText "First line&lt.html 7/11/2010 .img image=data\isniper. Example: ctrlSetText [100. world"] Category: Resistance http://www. buttons. Top left corner remains same. text]: Array Compatibility: Version 1.paa/&gt. text] Operand types: [idc. Type of returned value: Nothing Description: Set the structured text which will be displayed in structured text control. Type of returned value: Nothing Description: Sets the text that will be shown in the control with id idc of the topmost user dialog.

Type of returned value: Nothing Description: Sets tooltip text of given control. 0. Type of returned value: Nothing Description: Sets the text that will be shown in given control. Example: _control ctrlSetText "Hello. Color is in format Color. Example: _control ctrlSetTooltip "tooltip" http://www. Type of returned value: Nothing Description: Sets text color of given control. world. 1] Category: OFP PC display ctrlSetTooltip text Operand types: display: Control text: String Compatibility: Version 2.html 7/11/2010 . Example: _control ctrlSetTextColor [1.BIS Game Engine Scripting Commands Page 99 of 415 control ctrlSetText text Operand types: control: Control text: String Compatibility: Version 2.50 required.92 required." Category: OFP PC display ctrlSetTextColor color Operand types: display: Control color: Array Compatibility: Version 2.50 required. 0.arma2.com/comref/full.

1] Category: OFP PC display ctrlSetTooltipColorText color Operand types: display: Control color: Array Compatibility: Version 2. 0.92 required. Type of returned value: Nothing Description: Sets tooltip text color of given control. Color is in format Color.92 required. Color is in format Color.html 7/11/2010 .com/comref/full. http://www.arma2.92 required. Example: _control ctrlSetTooltipColorShade [1. Color is in format Color. Type of returned value: Nothing Description: Sets tooltip border color of given control. Type of returned value: Nothing Description: Sets tooltip background color of given control. Example: _control ctrlSetTooltipColorBox [1. 0. 0. 1] Category: OFP PC display ctrlSetTooltipColorShade color Operand types: display: Control color: Array Compatibility: Version 2.BIS Game Engine Scripting Commands Page 100 of 415 Category: OFP PC display ctrlSetTooltipColorBox color Operand types: display: Control color: Array Compatibility: Version 2. 0.

Example: _control ctrlShow false Category: OFP PC ctrlShown control Operand types: control: Control Compatibility: Version 2. 0. http://www. show]: Array Compatibility: Version 1. true] Category: Resistance control ctrlShow show Operand types: control: Control show: Boolean Compatibility: Version 2.com/comref/full.50 required.BIS Game Engine Scripting Commands Page 101 of 415 Example: _control ctrlSetTooltipColorText [1. 1] Category: OFP PC ctrlShow [idc.50 required. Type of returned value: Nothing Description: Show / hide given control. Type of returned value: Boolean Description: Returns whether given control is shown. Type of returned value: Nothing Description: Shows / hides the control with id idc of the topmost user dialog.html 7/11/2010 .arma2. 0. show] Operand types: [idc.50 required. Example: ctrlShow [100.

html 7/11/2010 .56 required. Type of returned value: String Description: Returns the text shown in the control with id idc of the topmost user dialog.BIS Game Engine Scripting Commands Page 102 of 415 Example: _ok = ctrlShown _control Category: OFP PC ctrlText control Operand types: control: Control Compatibility: Version 2.50 required.arma2. This can be used for static texts. Type of returned value: Number Description: http://www. Example: _message = ctrlText 100 Category: Resistance ctrlType control Operand types: control: Control Compatibility: Version 2. Example: _text = ctrlText _control Category: OFP PC ctrlText idc Operand types: idc: Number Compatibility: Version 1.com/comref/full.50 required. buttons. Type of returned value: String Description: Returns the text shown in given control. edit lines and active texts.

Category: OFP currentMagazine vehicle Operand types: vehicle: Object Compatibility: Version 5500 required.92 required.arma2. Type of returned value: Boolean Description: Returns whether the control with id idc of the topmost user dialog is visible. Example: _visible = ctrlVisible 100 Category: Resistance currentCommand vehicle Operand types: vehicle: Object Compatibility: Version 2. Category: OFP http://www. Type of returned value: String Description: Return the current command type (empty string when no command).BIS Game Engine Scripting Commands Page 103 of 415 Returns value representing type of control. Example: _type = ctrlType _control Category: OFP PC ctrlVisible idc Operand types: idc: Number Compatibility: Version 1.html 7/11/2010 .com/comref/full. Type of returned value: String Description: Return the name of the type of the currently using magazine (on the primary turret for vehicles).50 required.

Category: Identity currentTasks teamMember Operand types: teamMember: Compatibility: Version 2.html 7/11/2010 . Type of returned value: Number Description: Return the index of the current waypoint. Category: Identity currentWaypoint group Operand types: group: Group Compatibility: Version 5500 required. Type of returned value: http://www.com/comref/full.arma2.BIS Game Engine Scripting Commands Page 104 of 415 currentTask person Operand types: person: Object Compatibility: Version 5501 required.91 required. Type of returned value: Array Description: List all uncompleted tasks. Type of returned value: Task Description: Return current task of given person. Category: OFP currentWeapon vehicle Operand types: vehicle: Object Compatibility: Version 5500 required.

the argument uses format ["name". The object can be defined in the description.BIS Game Engine Scripting Commands Page 105 of 415 String Description: Return the name of the currently selected weapon (on the primary turret for vehicles).ext file.html 7/11/2010 ."type".0 Category: OFP cutObj effect Operand types: effect: Array Type of returned value: Nothing Description: Object background . Example: 0 cutFadeIn 1. it's assumed to be one.speed] or ["name". If speed is not given. Example: alive cursorTarget Category: OFP layer cutFadeOut duration Operand types: layer: Number duration: Number Compatibility: Version 5126 required."type"]. Example: http://www.com/comref/full. Type of returned value: Nothing Description: Terminate the effect in the given layer and set duration of the fade out phase to the given time. Type of returned value: Object Description: This is the entity pointed to by a players cursor. Category: OFP cursorTarget Compatibility: Version 5500 required.arma2.

0 is the back most.speed] or ["name"."type".the right argument uses format ["name".ext file. The left argument define layer in which the effect is show.html 7/11/2010 . it's assumed to be one. If speed is not given. it's assumed to be one.ext file. "PLAIN"] Category: OFP layer cutRsc effect Operand types: layer: Number effect: Array Compatibility: Version 5126 required. Example: 0 cutObj ["TVSet". If speed is not given. "plain"] Category: OFP cutRsc effect Operand types: effect: Array Type of returned value: Nothing Description: Resource background ."type"]. Example: cutRsc ["binocular". Type of returned value: Nothing Description: http://www. Type of returned value: Nothing Description: Object background .arma2. The resource can be defined in the description.BIS Game Engine Scripting Commands Page 106 of 415 cutObj ["TVSet"."type". The object can be defined in the description.the argument uses format ["name".speed] or ["name". "plain"] Category: OFP layer cutObj effect Operand types: layer: Number effect: Array Compatibility: Version 5126 required.com/comref/full."type"].

BIS Game Engine Scripting Commands

Page 107 of 415

Resource background - the right argument uses format ["name","type",speed] or ["name","type"]. If speed is not given, it's assumed to be one. The left argument define layer in which the effect is show, 0 is the back most. The resource can be defined in the description.ext file. Example: 0 cutRsc ["binocular", "PLAIN"] Category: OFP

cutText effect
Operand types: effect: Array Type of returned value: Nothing Description: Text background - the argument uses format ["text","type",speed] or ["text","type"]. If speed is not given, it's assumed to be one. Type may be one of: "PLAIN", "PLAIN DOWN", "BLACK", "BLACK FADED", "BLACK OUT", "BLACK IN", "WHITE OUT" or "WHITE IN". Example: cutText ["", "BLACK OUT"] Category: OFP

layer cutText effect
Operand types: layer: Number effect: Array Compatibility: Version 5126 required. Type of returned value: Nothing Description: Text background - the right argument uses format ["text","type",speed] or ["text","type"]. If speed is not given, it's assumed to be one. Type may be one of: "PLAIN", "PLAIN DOWN", "BLACK", "BLACK FADED", "BLACK OUT", "BLACK IN", "WHITE OUT" or "WHITE IN". The left argument define layer in which the effect is show, 0 is the back most. Example: 0 cutText ["", "BLACK OUT"] Category: OFP

damage object
Operand types:

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 108 of 415

object: Object Compatibility: Version 1.50 required. Type of returned value: Number Description: Returns the object damage in a range of 0 to 1. Note: this function is identical to getDammage. Example: damage player Category: OFP

date
Compatibility: Version 2.92 required. Type of returned value: Array Description: Return the actual mission date and time as an array [year, month, day, hour, minute]. Category: OFP

DateToNumber date
Operand types: date: Array Compatibility: Version 5501 required. Type of returned value: Number Description: Convert date to float number. Example: time = DateToNumber [year,month,day,hour,minute] Category: OFP

dayTime
Type of returned value: Number Description: Returns the time in the world, in hours. Category: OFP

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 109 of 415

debugLog anything
Operand types: anything: Any Type of returned value: Nothing Description: Dumps the argument's type and value to the debugging output. Example: debugLog player Category: OFP

default a
Operand types: a: Code Type of returned value: Nothing Description: see switch Category: Default

deg x
Operand types: x: Number Type of returned value: Number Description: Converts x from radians to degrees. Example: deg 1 , result is 57.295 Category: Default

deleteCenter side
Operand types: side: Side Compatibility: Version 1.86 required. Type of returned value:

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 110 of 415

Nothing Description: Destroys the AI center of the given side. Example: deleteCenter East Category: OFP

deleteCollection object
Operand types: object: Object Compatibility: Version 2.90 required. Type of returned value: Nothing Description: Delete a collection. Category: OFP

map deleteEditorObject object
Operand types: map: Control object: String Compatibility: Version 2.92 required. Type of returned value: Any Description: Delete the editor object. Requires all editor object links to be removed prior. Category: Editor

deleteGroup group
Operand types: group: Group Type of returned value: Nothing Description: Destroys the given AI group. Example: deleteGroup group

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 111 of 415

Category: OFP

deleteIdentity identityName
Operand types: identityName: String Compatibility: Version 1.75 required. Type of returned value: Boolean Description: Deletes an identity created by saveIdentity from the campaign progress file. Example: deleteIdentity "playerIdentity" Category: Resistance

deleteLocation location
Operand types: location: Location Compatibility: Version 2.90 required. Type of returned value: Nothing Description: Delete the given location. Category: Location

deleteMarker name
Operand types: name: String Type of returned value: Nothing Description: Destroys the given marker. The marker is destroyed on all computers in a network session. Example: deleteMarker "Marker1" Category: OFP

deleteMarkerLocal name

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 112 of 415

Operand types: name: String Compatibility: Version 2.92 required. Type of returned value: Nothing Description: Destroys the given marker. The marker is only destroyed on the computer where the command is called. Example: deleteMarkerLocal "Marker1" Category: OFP

deleteStatus statusName
Operand types: statusName: String Compatibility: Version 1.75 required. Type of returned value: Boolean Description: Deletes a status created by saveStatus from the campaign progress file. Example: deleteStatus "playerState" Category: Resistance

deleteVehicle object
Operand types: object: Object Compatibility: Version 1.34 required. Type of returned value: Nothing Description: Deletes any unit or vehicle. Only vehicles inserted in the editor or created during a mission can be deleted. The player unit cannot be deleted. Example: deleteVehicle tank Category: OFP

deleteWaypoint waypoint

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 113 of 415

Operand types: waypoint: Array Compatibility: Version 1.86 required. Type of returned value: Nothing Description: Removes the waypoint. Example: deleteWaypoint [grp, 2] Category: OFP

detach obj
Operand types: obj: Object Compatibility: Version 5501 required. Type of returned value: Nothing Description: Detaches an object. Example: detach player Category: OFP

diag_fps
Compatibility: Version 5500 required. Type of returned value: Number Description: Returns average framerate over last 16 frames. Category: OFP

diag_fpsmin
Compatibility: Version 5500 required. Type of returned value: Number Description:

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 114 of 415

Returns minimal framerate. Calculated from the longest frame over last 16 frames. Category: OFP

diag_frameno
Compatibility: Version 5500 required. Type of returned value: Number Description: Returns number of frame currently displayed . Category: OFP

diag_log anything
Operand types: anything: Any Compatibility: Version 5501 required. Type of returned value: Nothing Description: Dumps the argument's type and value to the report file. Example: diag_log player Category: OFP

diag_tickTime
Compatibility: Version 5501 required. Type of returned value: Number Description: Real time spent from the start of the game. Category: OFP

dialog
Compatibility: Version 1.78 required.

http://www.arma2.com/comref/full.html

7/11/2010

Type of returned value: Boolean Description: Checks whether given subject is present in the diary of given person. Category: OFP direction object Operand types: object: Object Compatibility: Version 1.arma2. For possible values of flag. Type of returned value: Boolean Description: Check if given difficulty setting is currently enabled.50 required. see config class Flags in CfgDificulties.com/comref/full. Category: Resistance person diarySubjectExists name Operand types: person: Object name: String Compatibility: Version 5501 required.BIS Game Engine Scripting Commands Page 115 of 415 Type of returned value: Boolean Description: Returns whether a user dialog is present. Example: direction player http://www. Category: Identity difficultyEnabled flag Operand types: flag: String Compatibility: Version 5127 required.html 7/11/2010 . Type of returned value: Number Description: Returns the object heading in the range of 0 to 360.

BIS Game Engine Scripting Commands Page 116 of 415 Category: OFP direction location Operand types: location: Location Compatibility: Version 2. Type of returned value: Number Description: Return direction (angle) of given location. Type of returned value: Nothing Description: Sends the message to the direct channel. Category: Location unit directSay radioName Operand types: unit: Object radioName: String Compatibility: Version 5501 required. Example: soldierOne disableAI "Move" http://www.90 required. The message is defined in the description.arma2.com/comref/full. Example: soldierOne directSay "messageOne" Category: OFP unit disableAI section Operand types: unit: Object section: String Type of returned value: Nothing Description: Disables parts of the AI behaviour to get more control over a unit.ext file or radio protocol.html 7/11/2010 . "AUTOTARGET" (disables independed target assigning and watching of unknown targets) or "MOVE" (disables movement). Section is one of "TARGET" (disables watching assigned targets).

script can work with the data types which do not support serialization (UI types). Implemented by the counter.BIS Game Engine Scripting Commands Page 117 of 415 Category: OFP unit disableConversation lock Operand types: unit: Object lock: Boolean Type of returned value: Nothing Description: Lock / unlock the unit to using conversation. function] Operand types: display: Display http://www.html 7/11/2010 . Type of returned value: Nothing Description: Disable saving of script containing this command. Category: Default disableUserInput disable Operand types: disable: Boolean Type of returned value: Nothing Description: Disables all user input. Category: OFP display displayAddEventHandler [handler name.arma2.unlock need to be matched. This is normally used only in cutscenes to disable the player's controls. After this. so lock . Example: player disableConversation true Category: OFP disableSerialization Compatibility: Version 5501 required.com/comref/full.

http://www. Example: _control = _display displayCtrl 101 Category: OFP PC displayNull Compatibility: Version 2. function]: Array Compatibility: Version 5501 required.com/comref/full.50 required. Type of returned value: Number Description: Add an event handler to the given display. Type of returned value: Control Description: Return child control with specified idc.BIS Game Engine Scripting Commands Page 118 of 415 [handler name.arma2. ""] Category: OFP PC display displayCtrl idc Operand types: display: Display idc: Number Compatibility: Version 2.92 required. This value is not equal to anything. Example: _id = _display displayAddEventHandler ["KeyDown". including itself. Category: OFP PC display displayRemoveAllEventHandlers handler name Operand types: display: Display handler name: String Compatibility: Version 5501 required. Returns id of the handler or -1 when failed. Type of returned value: Display Description: A non-existing display.html 7/11/2010 .

Example: _display displayRemoveAllEventHandlers "KeyDown" Category: OFP PC display displayRemoveEventHandler [handler name. id] Operand types: display: Display [handler name. ""] Category: OFP PC dissolveTeam team Operand types: team: String http://www.54 required.BIS Game Engine Scripting Commands Page 119 of 415 Type of returned value: Nothing Description: Remove all even handlers from the given display.arma2. Example: _display displayRemoveEventHandler ["KeyDown". id]: Array Compatibility: Version 5501 required. function] Operand types: display: Display [handler name. Type of returned value: Nothing Description: Sets given event handler of given display. 0] Category: OFP PC display displaySetEventHandler [handler name. function]: Array Compatibility: Version 2. Type of returned value: Nothing Description: Remove a given event handler from the given display.html 7/11/2010 .com/comref/full. Example: _control displaySetEventHandler ["KeyDown".

BIS Game Engine Scripting Commands Page 120 of 415 Compatibility: Version 2. "GREEN". Example: dissolveTeam "RED" Category: OFP obj1 or pos1 distance obj2 or pos2 Operand types: obj1 or pos1: Object or Array obj2 or pos2: Object or Array Type of returned value: Number Description: Computes the distance between two objects or positions. Example: player distance leader player Category: OFP location1 or pos1 distance location2 or pos2 Operand types: location1 or pos1: location2 or pos2: Compatibility: Version 5501 required.com/comref/full. "BLUE" or "YELLOW".05 required. Type of returned value: Number http://www. Category: Location distributionRegion Compatibility: Version 5129 required. All members become members of the main team. Type of returned value: Number Description: Computes the distance between two locations or positions.arma2. Type of returned value: Nothing Description: Dissolves the given team. Possible team values are: "RED".html 7/11/2010 .

BIS Game Engine Scripting Commands Page 121 of 415 Description: Return the region where the game was sold (based on distribution id).arma2.code.. Type of returned value: Nothing Description: Execute the code inside the given namespace.. Category: OFP with do code Operand types: with: With Type code: Code Compatibility: Version 5501 required. starts cycle Example: for "_x" from 20 to 10 step -2 do {. Example: with missionNamespace do {global=global+1} Category: Default forCommand do code Operand types: forCommand: for type code: Code Type of returned value: Any Description: End of for command. Note: the maximum repeat count for the loop is http://www.85 required.com/comref/full. Type of returned value: Nothing Description: Repeats the code while the condition is true.html 7/11/2010 .} Category: Default while do code Operand types: while: While Type code: Code Compatibility: Version 1.

Example: soldierOne doFire objNull Category: OFP unit doFollow position Operand types: unit: Object or Array position: Object Type of returned value: Nothing Description: Orders a unit to follow the given unit (silently). http://www. default {block}.html 7/11/2010 . case 2 : {block}. the unit is ordered to commence firing on its current target (set using doTarget or commandTarget). If the target is objNull.BIS Game Engine Scripting Commands Page 122 of 415 10000.arma2. the loop will be terminated and an error message is shown. If the condition is still true after the loop was repeated 10000 times. Example: while "a>b" do {a=a+1} Category: Default switch do block Operand types: switch: Switch Type block: Code Type of returned value: Any Description: Switch form Example: switch (_a) do { case 1: {block}.com/comref/full.} Category: Default unit doFire target Operand types: unit: Object or Array target: Object Type of returned value: Nothing Description: Orders a unit to commence firing on the given target (silently).

html 7/11/2010 .BIS Game Engine Scripting Commands Page 123 of 415 Example: soldierOne doFollow player Category: OFP unit(s) doFSM [fsm name. Type of returned value: Nothing Description: Orders a unit to get out from the vehicle (silently). player] Category: OFP PC doGetOut unit Operand types: unit: Object or Array Compatibility: Version 2. position. http://www.com/comref/full. position player. target]: Array Compatibility: Version 2. Example: doGetOut unitOne Category: OFP unit doMove position Operand types: unit: Object or Array position: Array Type of returned value: Nothing Description: Orders the unit to move to the given position (format Position) (silently).fsm".53 required. position. Example: soldierOne doFSM ["move. target] Operand types: unit(s): Object or Array [fsm name. Type of returned value: Nothing Description: Orders a unit to process command defined by FSM file (silently).arma2.28 required.

Example: soldierOne doWatch getMarkerPos "MarkerMoveOne" http://www.arma2.BIS Game Engine Scripting Commands Page 124 of 415 Example: soldierOne doMove getMarkerPos "MarkerMoveOne" Category: OFP doStop unit Operand types: unit: Object or Array Type of returned value: Nothing Description: Orders the unit to stop (silently). Note: the stop command is never finished. Example: soldierOne doTarget player Category: OFP unit doWatch position Operand types: unit: Object or Array position: Array Type of returned value: Nothing Description: Orders the unit to watch the given position (format Position) (silently). Example: doStop unitOne Category: OFP unit doTarget position Operand types: unit: Object or Array position: Object Type of returned value: Nothing Description: Orders the unit to target the given target (silently).html 7/11/2010 . the unit will never be ready.com/comref/full.

fill] Operand types: map: Control [center. color] Operand types: map: Control [position1. a.35 required. b.arma2. angle. color. Category: OFP PC http://www. a. position2. position2.BIS Game Engine Scripting Commands Page 125 of 415 Category: OFP unit doWatch target Operand types: unit: Object or Array target: Object Type of returned value: Nothing Description: Orders the unit to watch the given target (silently). color]: Array Compatibility: Version 2. Example: soldierOne doWatch player Category: OFP map drawArrow [position1. Type of returned value: Nothing Description: Draw arrow in map.html 7/11/2010 . b.35 required. color. Type of returned value: Nothing Description: Draw ellipse in map. angle. fill]: Array Compatibility: Version 2.com/comref/full. Category: OFP PC map drawEllipse [center.

angle. position. Category: OFP PC map drawLine [position1.92 required. angle. param type. Category: Editor map drawLocation location Operand types: map: Control location: Location http://www. shadow]: Array Compatibility: Version 2. line type.com/comref/full. position2. position. width. color]: Array Compatibility: Version 2. Type of returned value: Nothing Description: Draw icon in map. to.arma2.35 required. color]: Array Compatibility: Version 2. color] Operand types: map: Control [position1.html 7/11/2010 . to. param type. Type of returned value: Nothing Description: The editor will draw a line between the two specified editor objects. color.35 required. text. color] Operand types: map: Control [from.BIS Game Engine Scripting Commands Page 126 of 415 map drawIcon [texture. line type. height. shadow] Operand types: map: Control [texture. width. height. Type of returned value: Nothing Description: Draw line in map. color. position2. Category: OFP PC map drawLink [from. text. Line type can be LINE or ARROW.

b. Category: Location PC map drawRectangle [center.html 7/11/2010 . but a person.arma2.BIS Game Engine Scripting Commands Page 127 of 415 Compatibility: Version 2. Example: driver vehicle player Category: OFP drop array Operand types: array: Array Compatibility: Version 1. color. fill]: Array Compatibility: Version 2. the person is returned instead. color.35 required. Type of returned value: Nothing Description: Draw location in the map. http://www.90 required. angle. a. fill] Operand types: map: Control [center.50 required.com/comref/full. Category: OFP PC driver vehicle Operand types: vehicle: Object Type of returned value: Object Description: Returns the driver of the vehicle. Type of returned value: Nothing Description: Draw rectangle in map. b. Type of returned value: Nothing Description: Drops a particle into the scene. If the vehicle is not a vehicle. a. angle. Array is in format ParticleArray.

Type of returned value: Any Description: Show the edit object dialog for the given object. Category: OFP echo text Operand types: text: String Compatibility: Version 2. Type of returned value: Nothing Description: Sends any text into the debugger console or the logfile.com/comref/full.html 7/11/2010 .arma2.92 required.00 required. Example: echo "Text in logfile" Category: Default map editObject object Operand types: map: Control object: String Compatibility: Version 2.BIS Game Engine Scripting Commands Page 128 of 415 Category: Resistance east Type of returned value: Side Description: The East side. Category: Editor map editorSetEventHandler [handler name. function] Operand types: map: Control http://www.

function]: Array Compatibility: Version 2.92 required.85 required.html 7/11/2010 . Type of returned value: Array Description: Constructs an array that can be processed by then. Example: if (a>b) then {c=0} else {c=1} Category: Default vehicle emptyPositions position Operand types: vehicle: Object position: String http://www.92 required.arma2. Category: OFP ifCode else elseCode Operand types: ifCode: Code elseCode: Code Compatibility: Version 1. Type of returned value: Nothing Description: Sets given event handler of given editor. Type of returned value: Object Description: Returns the effective commander (who really commands) of the vehicle. Example: _map editorSetEventHandler ["SelectObject". ""] Category: Editor effectiveCommander vehicle Operand types: vehicle: Object Compatibility: Version 2.com/comref/full.BIS Game Engine Scripting Commands Page 129 of 415 [handler name.

Type of returned value: Number Description: Returns the number of available cargo.arma2. Example: soldierOne enableAI "Move" Category: OFP group enableAttack enable Operand types: group: Object or Group enable: Boolean Compatibility: Version 2. Type of returned value: Nothing Description: Set if leader can issue attack commands. gunner or commander positions in the vehicle. Section is one of "TARGET" (enables watching assigned targets).92 required.com/comref/full. "AUTOTARGET" (enables independed target assigning and watching of unknown targets) or "MOVE" (enables movement).html 7/11/2010 . Type of returned value: Nothing Description: Enables parts of the AI behaviour.53 required. Example: _freePositions = (vehicle player) freePositions "cargo" Category: OFP unit enableAI section Operand types: unit: Object section: String Compatibility: Version 2. driver.BIS Game Engine Scripting Commands Page 130 of 415 Compatibility: Version 2.92 required. Category: OFP enableEndDialog Type of returned value: http://www.

Type of returned value: Nothing Description: Enable / disable reload right after magazine is empty.arma2.html 7/11/2010 . Type of returned value: Nothing Description: Enable/disable environmental effects (ambient life + sound).BIS Game Engine Scripting Commands Page 131 of 415 Nothing Description: Enables the dialog buttons to be shown during the OnPlayerKilled script.92 required. Example: enableEnvironment false Category: OFP enableRadio enable Operand types: enable: Boolean Type of returned value: Nothing Description: Enables radio transmissions to be heard and seen on screen.com/comref/full. Category: OFP object enableReload enable Operand types: object: Object enable: Boolean Compatibility: Version 2.92 required. Category: OFP enableEnvironment enabled Operand types: enabled: Boolean Compatibility: Version 2. Example: _vehicle enableReload false http://www.

When disabled. save] Operand types: enable or [enable.com/comref/full. save]: Compatibility: Version 5501 required. the autosave is created (if not forbidden by save == false). Category: OFP entity enableSimulation enable Operand types: entity: Object enable: Boolean Type of returned value: Nothing Description: Enable / disable simulation for given entity.92 required.arma2. Category: OFP enableSentences enable Operand types: enable: Boolean Type of returned value: Nothing Description: Enables radio transmissions to be heard and seen on screen.BIS Game Engine Scripting Commands Page 132 of 415 Category: OFP enableSaving enable or [enable. Category: OFP enableTeamSwitch enable Operand types: enable: Boolean Compatibility: Version 2.html 7/11/2010 . http://www. Type of returned value: Nothing Description: Enable / disable saving of the game. It does not affect KBTell conversations.

Example: vehicle player engineOn false Category: OFP http://www. "END1". Type of returned value: Nothing Description: Finish loading screen displaying (started by startLoadingScreen). "END3". Category: OFP endMission end type Operand types: end type: String Compatibility: Version 5501 required.arma2. "END2".90 required.BIS Game Engine Scripting Commands Page 133 of 415 Type of returned value: Nothing Description: Enable / disable team switch. "END4".com/comref/full. The end type can be "CONTINUE". "KILLED". or "END6". "LOSER". Type of returned value: Nothing Description: Finish the mission. Category: OFP endLoadingScreen Compatibility: Version 5501 required.html 7/11/2010 . Category: OFP vehicle engineOn on Operand types: vehicle: Object on: Boolean Compatibility: Version 1. "END5". Type of returned value: Nothing Description: Switches the vehicle's engine on (true) or off (false).

Type of returned value: Any Description: Return object argument in mission editor.com/comref/full.BIS Game Engine Scripting Commands Page 134 of 415 estimatedEndServerTime Compatibility: Version 5501 required. Using this function the designer can provide a "time left" estimate that is shown in the "Game in progress" screen or in the master browser. the following example can be used in the init. argument]: Array Compatibility: Version 2.35 required. For missions with a hard set limit adjusted via Param1. argument] Operand types: map: Control [object.34 required.sqs file. Type of returned value: Nothing Description: Returns the estimated time left in the game. Category: OFP estimatedTimeLeft timeLeft Operand types: timeLeft: Number Compatibility: Version 1.html 7/11/2010 .arma2. Type of returned value: Number Description: Estimated end of MP game converted to serverTime. Example: estimatedTimeLeft Param1 Category: OFP map evalObjectArgument [object. Category: Editor argument exec script Operand types: http://www.

The FSM file is first searched in the mission folder.arma2. script]: Array Compatibility: Version 2. Example: execFSM "test.92 required. jeepOne] exec "getIn. Example: [player. The script is first searched in the mission folder. Type of returned value: Number Description: Execute the scripted FSM.sqs" Category: OFP map execEditorScript [object.com/comref/full. Return the FSM handler or 0 when failed.BIS Game Engine Scripting Commands Page 135 of 415 argument: Any script: String Type of returned value: Nothing Description: Executes a script. Type of returned value: Any Description: Execute an editor script for the specified object. Example: _map execEditorScript ["_team_1". then in the campaign scripts folder and finally in the global scripts folder. then in the campaign scripts subfolder and finally in the global scripts folder.html 7/11/2010 . script] Operand types: map: Control [object. "create"] Category: Editor execFSM filename Operand types: filename: String Compatibility: Version 5500 required. Argument is passed to the script as local variable _this.fsm" Category: OFP http://www.

58 required. then in the campaign scripts folder and finally in the global scripts folder. Type of returned value: Number Description: Execute the scripted FSM. Example: execVM "test.arma2.com/comref/full. The function is first searched in the mission folder. Argument is passed to the FSM as local variable _this. Type of returned value: Script Description: Compile and execute function (sqf). Example: player execFSM "test.fsm" Category: OFP execVM filename Operand types: filename: String Compatibility: Version 2.BIS Game Engine Scripting Commands Page 136 of 415 argument execFSM filename Operand types: argument: Any filename: String Compatibility: Version 5500 required. Type of returned value: Script Description: Compile and execute function (sqf). Argument is passed to the script as local variable _this.60 required. The function is first searched in the mission folder.html 7/11/2010 .sqf" Category: OFP PC argument execVM filename Operand types: argument: Any filename: String Compatibility: Version 2. Example: http://www. Return the FSM handler or 0 when failed. The FSM file is first searched in the mission folder. then in the campaign scripts folder and finally in the global scripts folder. then in the campaign scripts folder and finally in the global scripts folder.

arma2. result is 2.com/comref/full.BIS Game Engine Scripting Commands Page 137 of 415 player execVM "test. result is [when _x is greater then 5. Type of returned value: Any Description: if result of condition is true. and current block with result of code Example: if (_x>5) exitWith {echo "_x is too big".7182 Category: Default expectedDestination person http://www. evaluates code._x} .html 7/11/2010 . Category: OFP if exitWith code Operand types: if: If Type code: Code Compatibility: Version 2 required.sqf" Category: OFP PC exit Type of returned value: Nothing Description: Exits the script. Example: exp 1 . outputs message and terminates code in current level with value of _x Category: Default exp x Operand types: x: Number Type of returned value: Number Description: The exponential value of x.

5. returns empty string. Type of returned value: String Description: Gets unit faction. Category: OFP time fadeMusic volume Operand types: time: Number volume: Number Type of returned value: Nothing Description: Causes a smooth change in the music volume. the target volume by volume. planningMode. Type of returned value: Array Description: Return expected destination of unit as a [position. Category: OFP faction unit Operand types: unit: Object Compatibility: Version 5501 required.html 7/11/2010 . The default music volume is 0.BIS Game Engine Scripting Commands Page 138 of 415 Operand types: person: Object Compatibility: Version 2. If faction is not defined. The change duration is given by time. forceReplan].arma2.92 required. Example: 5 fadeMusic 0 Category: OFP time fadeRadio volume Operand types: time: Number volume: Number Type of returned value: Nothing Description: http://www.com/comref/full.

Mission saves will not be deleted. "END3". "END5".BIS Game Engine Scripting Commands Page 139 of 415 Causes a smooth change in the radio volume. The default radio volume is 1. or "END6".1 Category: OFP failMission end type Operand types: end type: String Compatibility: Version 5501 required. "LOSER".html 7/11/2010 . the target volume by volume. Category: Default http://www. The change duration is given by time.com/comref/full. "KILLED". "END2".1 Category: OFP time fadeSound volume Operand types: time: Number volume: Number Type of returned value: Nothing Description: Causes a smooth change in the master volume. The change duration is given by time. The end type can be "CONTINUE". Category: OFP false Type of returned value: Boolean Description: Always false.arma2.0. "END1". the target volume by volume. The default master volume is 1. Type of returned value: Nothing Description: Finish the mission.0. Example: 5 fadeRadio 0. Example: 5 fadeSound 0. "END4".

Type of returned value: Nothing Description: Adds magazines from the campaign pool to the person (depending on the weapons the person has). Type of returned value: Object Description: Returns the object where the object should search for cover.92 required. The minDist. result is 1 Category: Default object findCover [position. minDist.html 7/11/2010 . hidePosition.BIS Game Engine Scripting Commands Page 140 of 415 fillWeaponsFromPool person Operand types: person: Object Compatibility: Version 1. visibilityPosition.92 required. 2] find 1 . ignoreObject] Operand types: object: Object [position. Category: OFP http://www. Example: [0. visibilityPosition is used to select cover that can see a certain position. returns -1 if not found. visibilityPosition and ignoreObject parameters are optional. minDist. hidePosition. Example: fillWeaponsFromPool victor Category: Resistance array find x Operand types: array: Array x: Any Compatibility: Version 2. visibilityPosition. ignoreObject is an object that is ignored in visibility check. Type of returned value: Number Description: Returns the position of the first array element that matches x. 1. ignoreObject]: Array Compatibility: Version 2.75 required. maxDist.arma2. maxDist.com/comref/full.

name1. Use [type. value1.com/comref/full. game value] to search by object reference of a specific editor object type.html 7/11/2010 . name1. Type of returned value: String Description: Return object of given type with given arguments.. value1. Category: Editor center findEmptyPosition [radius.54 required. maxDistance. .. Example: _display = findDisplay 1 Category: OFP PC map findEditorObject value Operand types: map: Control value: Any Compatibility: Version 2.BIS Game Engine Scripting Commands Page 141 of 415 findDisplay idd Operand types: idd: Number Compatibility: Version 2.]: Array Compatibility: Version 2. maxDistance] or [radius.. Category: Editor map findEditorObject [type.] Operand types: map: Control [type. Type of returned value: String Description: Return object that matches the provided reference. Type of returned value: Display Description: Find display by its IDD.35 required.92 required. vehicleType] http://www.. .arma2.

BIS Game Engine Scripting Commands Page 142 of 415 Operand types: center: Array [radius. Category: OFP center findEmptyPositionReady [radius. maxDistance] or [radius. vehicleType]: Array Compatibility: Version 5501 required. maxDistance. When not found. Type of returned value: Nothing Description: http://www.92 required. Type of returned value: Array Description: Check if findEmptyPosition can be called without waiting for files. Type of returned value: Object Description: Find the nearest enemy from the specified position. maxDistance] Operand types: center: Array [radius. Category: OFP object findNearestEnemy position Operand types: object: Object position: Object or Array Compatibility: Version 2.33 required. Category: OFP finishMissionInit Compatibility: Version 2. maxDistance]: Array Compatibility: Version 5501 required.com/comref/full.html 7/11/2010 . with the free area (vehicle of the given type can be placed anywhere) of the given radius.arma2. Type of returned value: Array Description: Search for the position nearest (up to maxDistance) to the center. empty array is returned.

mode]. Category: OFP finite x Operand types: x: Number Type of returned value: Boolean Description: True. Example: soldierOne fire ["throw". magazine] or [muzzle. mode."SmokeShell"] Category: OFP http://www.BIS Game Engine Scripting Commands Page 143 of 415 Finish world initialization before mission is launched. if number is finite (not infinite and valid number) Example: finite 10/0 .arma2. result is false Category: Default unit fire weaponName Operand types: unit: Object weaponName: String Type of returned value: Nothing Description: The unit will fire from the given weapon. Example: soldierOne fire "HandGrenade" Category: OFP unit fire array Operand types: unit: Object array: Array Type of returned value: Nothing Description: The unit will fire from the given weapon.html 7/11/2010 . The array has format [muzzle.com/comref/full."SmokeShell".

html 7/11/2010 . objNull is returned.com/comref/full. When used on anything else.BIS Game Engine Scripting Commands Page 144 of 415 flag unit Operand types: unit: Object Type of returned value: Object Description: If the unit has a flag. Example: flag player Category: OFP flagOwner flag Operand types: flag: Object Type of returned value: Object Description: When used on a flag. this flag is returned.arma2. Example: fleeing player Category: OFP floor x Operand types: http://www. objNull is returned. If not. A dead or empty unit returns false. the returned value is the person that has this flag. Example: flagowner flagOne Category: OFP fleeing unit Operand types: unit: Object Type of returned value: Boolean Description: Checks whether the unit is fleeing.

Example: cobraOne flyInHeight 150 Category: OFP fog Compatibility: Version 2. The accepted range is from 50 to 1000. Type of returned value: Number Description: Return the current fog. Type of returned value: Number Description: Return the fog forecast.92 required.BIS Game Engine Scripting Commands Page 145 of 415 x: Number Type of returned value: Number Description: The floor value of x.25 .arma2. Category: OFP http://www.com/comref/full. Category: OFP fogForecast Compatibility: Version 2. Example: floor 5.92 required.html 7/11/2010 . result is 5 Category: Default helicopter flyInHeight height Operand types: helicopter: Object height: Number Type of returned value: Nothing Description: Sets the height level for the helicopter.

27 required. See example.html 7/11/2010 .{_x=_x+1}] do {debugLog _x. using C like style. Example: for "_x" from 1 to 10 do {debugLog _x.} Category: Default for forspec Operand types: forspec: Array Type of returned value: for type Description: creates cycle. Example: for [{_x=1}. Type of returned value: Nothing Description: Forces the map to display.BIS Game Engine Scripting Commands Page 146 of 415 for var Operand types: var: String Type of returned value: for type Description: Starts for sequence. Category: OFP forceMap show Operand types: show: Boolean Compatibility: Version 1. http://www.} Category: Default forceEnd Type of returned value: Nothing Description: Forces the mission to terminate. use in complette form(see example).arma2.com/comref/full.{_x<=10}.

Example: "_x setdammage 1" forEach units group player Category: Default format format Operand types: format: Array Type of returned value: String Description: The first argument of the array is in format string. Type of returned value: Nothing Description: Force the speed of the given object.92 required.arma2.com/comref/full. %2.1" http://www. Each %x is replaced by the corresponding argument.text . %x may appear in the string in any order. result is "1 .%1". Category: OFP command forEach array Operand types: command: Code array: Array Type of returned value: Nothing Description: Executes the given command for each element in array.html 7/11/2010 . It's executed as follows: for each element of array an element is assigned as _x and the command is executed. Example: format ["%1 . etc.BIS Game Engine Scripting Commands Page 147 of 415 Example: forceMap true Category: OFP object forceSpeed speed Operand types: object: Object speed: Number Compatibility: Version 2. "text"] . This string may contain references to the following arguments using format %1. 1.%2 .

arma2.92 required. "ECH LEFT".html 7/11/2010 .BIS Game Engine Scripting Commands Page 148 of 415 Category: OFP formation grp Operand types: grp: Object or Group Type of returned value: String Description: Returns the formation of the group ("COLUMN".92 required. "WEDGE". Category: OFP formationLeader person Operand types: person: Object Compatibility: Version 2. "VEE" or "LINE"). "ECH RIGHT". "STAG COLUMN". Type of returned value: Number Description: Return the direction unit watching in formation.com/comref/full. Example: formation group player Category: OFP formationDirection person Operand types: person: Object Compatibility: Version 2. Type of returned value: Object Description: Return leader of the formation. Category: OFP formationMembers person http://www.

Category: OFP formationTask person Operand types: person: Object Compatibility: Version 2. arg2.BIS Game Engine Scripting Commands Page 149 of 415 Operand types: person: Object Compatibility: Version 2. etc. arg1.arma2. Type of returned value: Structured text Description: Creates a structured text by replacing %1. Type of returned value: String Description: Return the current task of the unit in the formation.. in format by plain or structured texts given as arguments...92 required. Type of returned value: Array Description: Return list of units (drivers) in the formation. Category: OFP formationPosition person Operand types: person: Object Compatibility: Version 2.com/comref/full.]: Array Compatibility: Version 2.html 7/11/2010 . .] Operand types: [format.92 required.92 required.01 required.. arg2. arg1. . http://www. Type of returned value: Array Description: Return position of unit in the formation. %2. Category: OFP formatText [format.

in the range from 0 to 1.} Category: Default fuel vehicle Operand types: vehicle: Object Type of returned value: Number Description: Checks how much fuel is left in the gas tank. For dead units objNull is returned. image "data\isniper..BIS Game Engine Scripting Commands Page 150 of 415 Example: txt = formatText ["Image: %1". but not always. Example: formLeader player != leader player Category: OFP for "_var" from b Operand types: for "_var": for type b: Number Type of returned value: for type Description: Continue sequence of 'for' command.code. Example: for "_x" from 10 to 20 do {.arma2.html 7/11/2010 . Example: fuel vehicle player http://www.com/comref/full.paa"] Category: OFP formLeader unit Operand types: unit: Object Type of returned value: Object Description: Returns the formation leader for the given unit.. The result is often the same as groupLeader.

html 7/11/2010 .arma2. Example: _array = getArray (configFile >> "CfgVehicles" >> "Thing" >> "threat") Category: OFP PC getDammage obj Operand types: obj: Object Type of returned value: Number Description: Returns the object damage in the range from 0 to 1.BIS Game Engine Scripting Commands Page 151 of 415 Category: OFP gearSlotData control Operand types: control: Control Compatibility: Version 5501 required. Example: getDammage player Category: OFP http://www. Type of returned value: Array Description: Extract array from config entry.com/comref/full. Example: weapon = gearSlotData _control Category: OFP PC getArray config Operand types: config: Config Compatibility: Version 2.35 required. Type of returned value: String Description: Returns gear slot item name.

Type of returned value: Object Description: Fetches a reference to the mission editor camera. Category: Editor map getEditorObjectScope object Operand types: map: Control object: String Compatibility: Version 2. Type of returned value: String Description: Returns the current mode of the editor.BIS Game Engine Scripting Commands Page 152 of 415 getDir obj Operand types: obj: Object Type of returned value: Number Description: Returns the object heading in the range from 0 to 360.arma2.92 required. Type of returned value: http://www.html 7/11/2010 . Example: getDir player Category: OFP getEditorCamera map Operand types: map: Control Compatibility: Version 2.com/comref/full.92 required. Category: Editor getEditorMode map Operand types: map: Control Compatibility: Version 2.92 required.

Type of returned value: Array http://www.arma2. Type of returned value: Any Description: Return the value of variable in the variable space of given FSM. otherwise it's friendly.com/comref/full. Example: value = west getFriend east Category: OFP FSM handle getFSMVariable name Operand types: FSM handle: Number name: String Compatibility: Version 5501 required.BIS Game Engine Scripting Commands Page 153 of 415 String Description: Returns the editor object scope of the specified editor object. Type of returned value: Number Description: Returns if sides are friendly or hostile. The FSM handle is the number returned by the execFSM command. For a value smaller than 0. Category: OFP group getGroupIcon ID Operand types: group: Group ID: Number Compatibility: Version 5501 required.6 it results in being enemy.html 7/11/2010 . Category: Editor side1 getFriend side2 Operand types: side1: Side side2: Side Compatibility: Version 5501 required.

text.BIS Game Engine Scripting Commands Page 154 of 415 Description: Get group icon properties. Type of returned value: http://www.arma2. Type of returned value: Array Description: Returns all group icons.].[offsetx.. visible] Example: getGroupIconParams group Category: OFP getGroupIcons group Operand types: group: Group Compatibility: Version 5501 required..offsety].html 7/11/2010 . Type of returned value: Array Description: Returns group icons params.92 required.scale. [color.[.[[id.com/comref/full. Example: group getGroupIcon id Category: OFP getGroupIconParams group Operand types: group: Group Compatibility: Version 5501 required..icon.] Example: getGroupIcons group Category: OFP object getHideFrom enemy Operand types: object: Object enemy: Object Compatibility: Version 2.

z. http://www.21 required. Type of returned value: String Description: Gets the marker color.html 7/11/2010 . Category: OFP getMarkerColor marker Operand types: marker: String Compatibility: Version 1. Type of returned value: Array Description: Gets the marker size. Example: getMarkerPos "markerOne" Category: OFP getMarkerSize marker Operand types: marker: String Compatibility: Version 1.BIS Game Engine Scripting Commands Page 155 of 415 Array Description: Returns the hiding position in format Position. See setMarkerSize. Example: getMarkerColor "MarkerOne" Category: OFP getMarkerPos markerName Operand types: markerName: String Type of returned value: Array Description: Returns the marker positon in format [x.y].21 required. See setMarkerColor.arma2. If enemy is null it is the some position in front of the object or enemy position otherwise.com/comref/full.

arma2.35 required. Type of returned value: Number Description: Extract number from config entry. argument] Operand types: map: Control [object.21 required.com/comref/full. Type of returned value: String Description: Return name of object argument in mission editor. Type of returned value: String Description: Gets the type of the marker. Example: getMarkerType "MarkerOne" Category: OFP getNumber config Operand types: config: Config Compatibility: Version 2.html 7/11/2010 . Example: _array = getNumber (configFile >> "CfgVehicles" >> "Thing" >> "maxSpeed") Category: OFP PC map getObjectArgument [object. argument]: Array Compatibility: Version 2.35 required. See setMarkerType. http://www.BIS Game Engine Scripting Commands Page 156 of 415 Example: getMarkerSize "MarkerOne" Category: OFP getMarkerType marker Operand types: marker: String Compatibility: Version 1.

92 required. Category: Editor map getObjectProxy object Operand types: map: Control object: String Compatibility: Version 2. Example: getPos player Category: OFP getPos location http://www.92 required.BIS Game Engine Scripting Commands Page 157 of 415 Category: Editor map getObjectChildren object Operand types: map: Control object: String Compatibility: Version 2. Type of returned value: Object Description: Return the proxy object associated with the given editor object.arma2. Type of returned value: Array Description: Return a list of all the children of the specified object. Category: Editor getPos obj Operand types: obj: Object Type of returned value: Array Description: Returns the object position in format Position.com/comref/full.html 7/11/2010 .

Example: getPosASL player Category: OFP object getSpeed speedMode Operand types: object: Object speedMode: String Compatibility: Version 2.arma2.html 7/11/2010 .com/comref/full.92 required. Type of returned value: Number Description: Get the speed for the given speed mode."FAST". http://www. Type of returned value: Array Description: Returns the object position in format PositionASL.35 required. SpeedMode can be: "AUTO".53 required. Category: OFP getText config Operand types: config: Config Compatibility: Version 2."NORMAL". Type of returned value: Array Description: Return (raw) position of given location. Category: Location getPosASL obj Operand types: obj: Object Compatibility: Version 2.BIS Game Engine Scripting Commands Page 158 of 415 Operand types: location: Location Compatibility: Version 5501 required."SLOW".

com/comref/full.92 required. Type of returned value: Any Description: http://www. Category: OFP location getVariable name Operand types: location: Location name: String Compatibility: Version 2.arma2.html 7/11/2010 . Example: _array = getText (configFile >> "CfgVehicles" >> "Thing" >> "icon") Category: OFP PC namespace getVariable name Operand types: namespace: Namespace name: String Compatibility: Version 5501 required. Type of returned value: Any Description: Return the value of variable in the given namespace. Type of returned value: Any Description: Return the value of variable in the variable space of given group. Category: Default group getVariable name Operand types: group: Group name: String Compatibility: Version 5501 required.BIS Game Engine Scripting Commands Page 159 of 415 Type of returned value: String Description: Extract text from config entry.

Category: Location object getVariable name Operand types: object: Object name: String Compatibility: Version 2. Type of returned value: Nothing Description: Get variable from the variable space of given map.92 required.arma2. Type of returned value: Any Description: Return the value of variable in the variable space of given object.92 required.html 7/11/2010 . Type of returned value: Any Description: Return the value of variable in the variable space of given task. Category: OFP map getVariable name Operand types: map: Control name: String Compatibility: Version 2.92 required.BIS Game Engine Scripting Commands Page 160 of 415 Return the value of variable in the variable space of given location.com/comref/full. Category: Identity http://www. Category: Editor task getVariable name Operand types: task: Task name: String Compatibility: Version 2.

com/comref/full. If you want the message to show on all computers. Note: this function only types text to the list. otherSoldier glanceAt getMarkerPos "markerOne" Category: OFP unit globalChat chatText Operand types: unit: Object chatText: String Type of returned value: Nothing Description: Types text to the global radio channel.40 required. Type of returned value: Array Description: Gets the waypoint position.arma2. it does not broadcast the message.html 7/11/2010 . Example: getWPPos [groupOne.21 required. you have to execute it on all of them.BIS Game Engine Scripting Commands Page 161 of 415 getWPPos waypoint Operand types: waypoint: Array Compatibility: Version 1. The format of waypoint is Waypoint. Type of returned value: Nothing Description: Control what the unit is glancing at (target or position) (format Position) Example: someSoldier glanceAt otherSoldier. Example: soldierOne globalChat "Show this text" Category: OFP http://www. 1] Category: OFP unit(s) glanceAt position Operand types: unit(s): Object or Array position: Object or Array Compatibility: Version 2.

Example: group player == group leader player Category: OFP unit groupChat chatText Operand types: http://www. Example: soldierOne globalRadio "messageOne" Category: OFP goto label Operand types: label: String Type of returned value: Nothing Description: Only in scripts: go to given label. Example: goto "Loop" Category: OFP group obj Operand types: obj: Object Type of returned value: Group Description: Returns the group to which the given unit is assigned. grpNull is returned.html 7/11/2010 .com/comref/full.BIS Game Engine Scripting Commands Page 162 of 415 unit globalRadio radioName Operand types: unit: Object radioName: String Type of returned value: Nothing Description: Sends the message to the global radio channel.arma2. The message is defined in the description. Note: the string argument is used here. For dead units. Be sure to use double quotes around the label name in goto.ext file or radio protocol.

The message is defined in the description. Example: http://www. Category: OFP unit groupRadio radioName Operand types: unit: Object radioName: String Type of returned value: Nothing Description: Sends the message to the group radio channel.com/comref/full.ext file or radio protocol. Type of returned value: Boolean Description: Return if groups icon raises onClick and onOver events. it does not broadcast the message. Example: soldierOne groupChat "Show this text" Category: OFP groupIconSelectable Compatibility: Version 5501 required. Note: this function only types text to the list. Type of returned value: Array Description: Return group icons are visible. you have to execute it on all of them.html 7/11/2010 . Category: OFP groupIconsVisible Compatibility: Version 5501 required.BIS Game Engine Scripting Commands Page 163 of 415 unit: Object chatText: String Type of returned value: Nothing Description: Types text to the group radio channel.arma2. If you want the message to show on all computers.

Example: group player == objNull .bool]: Array Compatibility: Version 5501 required.bool] Operand types: unit: Object [unit. result is false Category: OFP http://www. including itself. This value is not equal to anything. Example: player groupSelectUnit [unit.BIS Game Engine Scripting Commands Page 164 of 415 soldierOne groupRadio "messageOne" Category: OFP groupSelectedUnits unit Operand types: unit: Object Compatibility: Version 5501 required.arma2.true] Category: OFP grpNull Type of returned value: Group Description: A non-existing group.com/comref/full.html 7/11/2010 . Type of returned value: Nothing Description: Select unit from unit's group. Type of returned value: Array Description: Returns selected groups in sgroup. Example: array = groupSelectedUnits unit Category: OFP unit groupSelectUnit [unit.

Type of returned value: Nothing Description: Stops the program into a debugger. Example: gunner vehicle player Category: OFP halt Compatibility: Version 2.com/comref/full.BIS Game Engine Scripting Commands Page 165 of 415 gunner vehicle Operand types: vehicle: Object Type of returned value: Object Description: Returns the gunner of the vehicle. Example: halt Category: Default handsHit soldier Operand types: soldier: Object Type of returned value: Number Description: Checks whether the soldier's hands are hit (causing inaccurate aiming). but a person.arma2. the person is returned.html 7/11/2010 .00 required. Example: handsHit leader player Category: OFP unit hasWeapon weaponName Operand types: http://www. If the vehicle is not a vehicle.

Example: array = hcAllGroups unit Category: OFP unit hcGroupParams group Operand types: unit: Object group: Group Compatibility: Version 5501 required.BIS Game Engine Scripting Commands Page 166 of 415 unit: Object weaponName: String Type of returned value: Boolean Description: Checks whether the unit has the given weapon. Type of returned value: Array Description: Returns selected groups in high command.arma2. Return value is [string.float[4]] Example: unit hcGroupParams group Category: OFP hcLeader group Operand types: http://www.html 7/11/2010 .com/comref/full. Example: player hasWeapon "M16" Category: OFP hcAllGroups unit Operand types: unit: Object Compatibility: Version 5501 required. Type of returned value: Array Description: Returns parameters describing group in high command bar.

Example: hcLeader group Category: OFP hcRemoveAllGroups unit Operand types: unit: Object Compatibility: Version 5501 required. Type of returned value: Nothing Description: Removes group from unit's high command bar.com/comref/full. Example: hcRemoveAllGroups unit Category: OFP unit hcRemoveGroup group Operand types: unit: Object group: Group Compatibility: Version 5501 required. Example: unit HCRemoveGroup group Category: OFP hcSelected unit http://www. Type of returned value: Nothing Description: Remove all groups from unit's high command bar.BIS Game Engine Scripting Commands Page 167 of 415 group: Group Compatibility: Version 5501 required. Type of returned value: Object Description: Returns group's HC commander.arma2.html 7/11/2010 .

teamyellow) . group name and team (teammain.html 7/11/2010 .arma2. teamgreen. Group is the only necessary parameter. Type of returned value: Nothing Description: Add group to unit's high command bar.BIS Game Engine Scripting Commands Page 168 of 415 Operand types: unit: Object Compatibility: Version 5501 required. teamred.true] Category: OFP unit hcSetGroup array Operand types: unit: Object array: Array Compatibility: Version 5501 required."HQ". Example: unit hcSetGroup [group. Type of returned value: Array Description: Returns selected groups in high command. Type of returned value: Nothing Description: Select given group in HC bar. Array parameters are group. teamblue.com/comref/full. Example: unit hcSelectGroup [group. Example: array = hcSelected unit Category: OFP unit hcSelectGroup array Operand types: unit: Object array: Array Compatibility: Version 5501 required."teamred"] or player hcSetGroup [group] Category: OFP http://www.

Category: OFP hideBody person Operand types: person: Object Compatibility: Version 2.arma2. Type of returned value: Nothing Description: Shows or hides HC bar.BIS Game Engine Scripting Commands Page 169 of 415 hcShowBar bool Operand types: bool: Boolean Compatibility: Version 5501 required. Example: hideBody player Category: OFP hint text Operand types: text: Text or String Type of returned value: http://www.com/comref/full. Example: hcShowBar true Category: OFP hcShownBar Compatibility: Version 5501 required. Type of returned value: Boolean Description: Return a list of all groups.html 7/11/2010 .10 required. Type of returned value: Nothing Description: Hides the body of the given person. There must be some groups under hc command to show hc bar.

\n is used to indicate the end of a line.01 required.01 required. The text can contain several lines.arma2. Example: hintC "Press W to move forward" Category: OFP title hintC text Operand types: title: String text: Structured text Compatibility: Version 2.com/comref/full. Type of returned value: Nothing Description: http://www. Category: OFP title hintC text Operand types: title: String text: String Compatibility: Version 2.BIS Game Engine Scripting Commands Page 170 of 415 Nothing Description: Shows a text hint. Example: hint "Press W to move forward" Category: OFP hintC text Operand types: text: String Type of returned value: Nothing Description: Shows a text hint. Type of returned value: Nothing Description: Creates a hint dialog with the given title and text. The text can contain several lines.html 7/11/2010 . This hint has to be confirmed. \n is used to indicate the end of a line.

arma2..01 required. Example: hintCadet "Press W to move forward" Category: OFP hintSilent text Operand types: text: Text or String Compatibility: Version 5501 required. Category: OFP title hintC [text1. Category: OFP hintCadet text Operand types: text: Text or String Type of returned value: Nothing Description: Shows a text hint only when using cadet mode.]: Array Compatibility: Version 2.] Operand types: title: String [text1.com/comref/full. . .BIS Game Engine Scripting Commands Page 171 of 415 Creates a hint dialog with the given title and text. Type of returned value: Nothing Description: Same as hint. The text can contain several lines. Texts can be plain or structured.html 7/11/2010 ... Type of returned value: Nothing Description: Creates a hint dialog with the given title and text. text2. text2. Category: OFP http://www. but without a sound. \n is used to indicate the end of a line..

BIS Game Engine Scripting Commands Page 172 of 415 control htmlLoad filename Operand types: control: Control filename: String Compatibility: Version 2. Type of returned value: Nothing Description: Load HTML from file to given control.html 7/11/2010 .paa" Category: OFP http://www. Type of returned value: If Type Description: The first part of the if command. Example: _control htmlLoad "briefing. Example: txt1 = image "data\isniper.com/comref/full. Type of returned value: Structured text Description: Creates a structured text containing the given image.arma2.01 required.85 required.html" Category: OFP PC if condition Operand types: condition: Boolean Compatibility: Version 1.53 required. Example: if (a>b) then {a=b} Category: Default image filename Operand types: filename: String Compatibility: Version 2.

com/comref/full. result is true Category: Default position in location Operand types: position: Array location: Location Compatibility: Version 2. Example: 1 in [0.BIS Game Engine Scripting Commands Page 173 of 415 importAllGroups map Operand types: map: Control Compatibility: Version 2. 1.92 required.arma2. Type of returned value: Number Description: Return importance of given location. 2] . Category: Location x in array Operand types: x: Any array: Array Type of returned value: Boolean Description: Checks whether x is equal to any element in the array. http://www.92 required. Type of returned value: Nothing Description: Imports all groups into the RTE.html 7/11/2010 . Category: Editor importance location Operand types: location: Location Compatibility: Version 2.90 required.

Type of returned value: Boolean Description: Check if fireplace is inflamed (buring). Example: player in jeepOne Category: OFP fireplace inflame burn Operand types: fireplace: Object burn: Boolean Type of returned value: Nothing Description: Controls fireplace buring.html 7/11/2010 . Set to true to inflame the fireplace. Example: fireplaceOne inflame true Category: OFP inflamed fireplace Operand types: fireplace: Object Compatibility: Version 1.04 required.BIS Game Engine Scripting Commands Page 174 of 415 Type of returned value: Boolean Description: Check if the position is inside area defined by the location.com/comref/full. Category: Location soldier in vehicle Operand types: soldier: Object vehicle: Object Type of returned value: Boolean Description: Checks whether the soldier is mounted in the vehicle.arma2. http://www.

Type of returned value: Config Description: Returns base entry of config entry. Example: _base = inheritsFrom (configFile >> "CfgVehicles" >> "Car") Category: OFP PC initAmbientLife Compatibility: Version 2. Category: OFP inputAction name http://www. function]: Array Compatibility: Version 2.arma2. Type of returned value: Nothing Description: Sets given event handler of in-game UI. Category: OFP inheritsFrom config Operand types: config: Config Compatibility: Version 2. Type of returned value: Nothing Description: Initialize the ambient life.html 7/11/2010 .com/comref/full.92 required. function] Operand types: [handler name.BIS Game Engine Scripting Commands Page 175 of 415 Example: inflamed fireplaceOne Category: OFP inGameUISetEventHandler [handler name.91 required.90 required.

. Subtype class is optional.92 required. value1. lod name]: Array [begin. value1.53 required.com/comref/full. Category: OFP map insertEditorObject [type. 1500. 2]. value. Example: [tank. end]: Array Compatibility: Version 2. subtype class]: Array Compatibility: Version 2.arma2. [name1. Type of returned value: String Description: Insert an object to the editor and assign arguments. 1500.. Type of returned value: Array Description: Find named selection in object which is in specified lod intersected by given section of a line.. Returns the ID of the new EditorObject. 2]] Category: OFP isArray config Operand types: config: Config http://www. value.]. subtype class] Operand types: map: Control [type.html 7/11/2010 . Category: Editor [object. . Create script is not called. end] Operand types: [object. [1550.BIS Game Engine Scripting Commands Page 176 of 415 Operand types: name: String Compatibility: Version 5500 required. "VIEW" intersect [[1500. . lod name] intersect [begin. Type of returned value: Number Description: Return the state of input devices mapped to given input action (see CfgDefaultKeysMapping for action names). [name1..].

Example: _ok = isClass (configFile >> "CfgVehicles") . Type of returned value: Boolean Description: Return true for dedicated server.90 required.html 7/11/2010 . result is false Category: OFP PC isClass config Operand types: config: Config Compatibility: Version 2. Example: _ok = isArray (configFile >> "CfgVehicles") .BIS Game Engine Scripting Commands Page 177 of 415 Compatibility: Version 2. Category: OFP isEngineOn vehicle Operand types: vehicle: Object Compatibility: Version 1.arma2. Type of returned value: Boolean Description: Check if config entry represents array.35 required. Type of returned value: Boolean Description: http://www.com/comref/full. result is true Category: OFP PC isDedicated Compatibility: Version 5501 required.35 required. Type of returned value: Boolean Description: Check if config entry represents config class.

object skipobj] Operand types: position: Array [float minDistance.float onWater. Type of returned value: Array Description: Chek if given area is flat and emty. Type of returned value: Boolean Description: http://www. Category: OFP isHidden person Operand types: person: Object Compatibility: Version 2. 5.object skipobj]: Array Compatibility: Version 5501 required.92 required.arma2.5. false.float gradientRadius.bool onShore. Example: on = isEngineOn vehicle player Category: OFP position isFlatEmpty [float minDistance.float onWater.float maxGradient.float precizePos. player) Category: OFP isFormationLeader person Operand types: person: Object Compatibility: Version 2.html 7/11/2010 .com/comref/full.float maxGradient.92 required. Type of returned value: Boolean Description: Returns true if the specified person is subgroup leader.float gradientRadius.bool onShore. 0.BIS Game Engine Scripting Commands Page 178 of 415 Checks whether the engine is on.float precizePos. 0. 0. Example: newposition = position isFlatEmpty(10.

http://www.06 required.arma2. Example: ok = isKeyActive "M04" Category: OFP object isKindOf typeName Operand types: object: Object typeName: String Compatibility: Version 2. Type of returned value: Boolean Description: Checks whether the type typeName1 is inherited from the type typeName1. Type of returned value: Boolean Description: Checks whether the object is of the given type. Type of returned value: Boolean Description: Checks whether the given key is active in the current user profile. Category: OFP isKeyActive keyName Operand types: keyName: String Compatibility: Version 2.BIS Game Engine Scripting Commands Page 179 of 415 Return whether the person is hidden (reached the hiding position). Example: vehicle player isKindOf "Tank" Category: OFP typeName1 isKindOf typeName2 Operand types: typeName1: String typeName2: String Compatibility: Version 5160 required.30 required.html 7/11/2010 .com/comref/full.

00 required. The function returns true if the variable is null and false if it's not.13 required.arma2.BIS Game Engine Scripting Commands Page 180 of 415 Example: "Tank" isKindOf "Land" . result is true Category: OFP isMarkedForCollection object Operand types: object: Object Compatibility: Version 2. Example: marked = isMarkedForCollection truck Category: OFP isMultiplayer Compatibility: Version 5501 required. Category: OFP isNil variable Operand types: variable: Compatibility: Version 2. Type of returned value: Boolean Description: Tests whether the variable is null. Example: if (isNil("_pokus")) then {_pokus=0.com/comref/full.html 7/11/2010 .} http://www. Type of returned value: Boolean Description: Return true if multiPlayer. Type of returned value: Boolean Description: Checks whether the object is marked for weapons collection.

Note: a==GrpNull does not work.BIS Game Engine Scripting Commands Page 181 of 415 Category: Default isNull location Operand types: location: Location Compatibility: Version 5501 required.92 required. result is false Category: OFP http://www.html 7/11/2010 . Note: a==controlNull does not work. Type of returned value: Boolean Description: Check whether the value is null. because controlNull is not equal to anything. Type of returned value: Boolean Description: Checks whether the value is equal to controlNull.arma2. result is true Category: OFP PC isNull grp Operand types: grp: Group Type of returned value: Boolean Description: Checks whether the value is equal to grpNull. Category: Location isNull control Operand types: control: Control Compatibility: Version 2. because grpNull is not equal to anything. Example: isNull group player .com/comref/full. Example: isNull controlNull . even to itself. even to itself.

result is true Category: Identity isNull display Operand types: display: Display Compatibility: Version 2. because displayNull is not equal to anything.html 7/11/2010 .BIS Game Engine Scripting Commands Page 182 of 415 isNull task Operand types: task: Task Compatibility: Version 5160 required.com/comref/full. result is true Category: OFP http://www. Type of returned value: Boolean Description: Checks whether the value is equal to taskNull. because taskNull is not equal to anything. Note: a==displayNull does not work. even to itself. even to itself. even to itself. because objNull is not equal to anything.92 required. Example: isNull displayNull . result is true Category: OFP PC isNull obj Operand types: obj: Object Type of returned value: Boolean Description: Checks whether the value is equal to objNull. Note: a==ObjNull does not work.arma2. Example: isNull taskNull . Type of returned value: Boolean Description: Checks whether the value is equal to displayNull. Example: isNull objNull . Note: a==TaskNull does not work.

BIS Game Engine Scripting Commands Page 183 of 415 isNumber config Operand types: config: Config Compatibility: Version 2.92 required. Example: _ok = isNumber (configFile >> "CfgVehicles") .92 required. Category: OFP isRealTime map Operand types: map: Control Compatibility: Version 2. http://www.com/comref/full. Type of returned value: Boolean Description: Check if config entry represents number.35 required. Type of returned value: Boolean Description: Check if given person is the player.html 7/11/2010 . result is false Category: OFP PC isOnRoad position or object Operand types: position or object: Object or Array Compatibility: Version 5501 required. Type of returned value: Boolean Description: Check whether given position is on road.arma2. Category: OFP isPlayer person Operand types: person: Object Compatibility: Version 2.

92 required. Category: OFP isShowing3DIcons map Operand types: map: Control Compatibility: Version 2.92 required. Type of returned value: Boolean Description: Returns true if the editor is set to draw 3D icons.35 required. Type of returned value: Boolean Description: Returns true if the computer is the server.BIS Game Engine Scripting Commands Page 184 of 415 Type of returned value: Boolean Description: Returns true if the mission editor is operating in real time mode.arma2.com/comref/full. Category: Editor isText config Operand types: config: Config Compatibility: Version 2. Example: _ok = isText (configFile >> "CfgVehicles") . result is false http://www.html 7/11/2010 . Example: _isRealTime = isRealTime _map Category: Editor isServer Compatibility: Version 2. Type of returned value: Boolean Description: Check if config entry represents text.

id]: Array Type of returned value: Nothing Description: Joins the unit to the given group.com/comref/full. Example: [unitOne.BIS Game Engine Scripting Commands Page 185 of 415 Category: OFP PC items unit Operand types: unit: Object Compatibility: Version 5501 required. id] Operand types: unit: Object [group.arma2.html 7/11/2010 . Note: the total number of group members cannot exceed 12. Example: player joinAs [_group. Type of returned value: Array Description: Returns an array of names of all special items of the vehicle.33 and before. unitTwo] join player Category: OFP unit joinAs [group. if position id is available. Example: items player Category: OFP unitArray join group Operand types: unitArray: Array group: Object or Group Type of returned value: Nothing Description: Joins all units in the array to the given group. Note: This function is unsupported in MP in version 1. this one is used. 4] Category: OFP http://www.

Type of returned value: Boolean Description: Register knowledge base database to given person.com/comref/full. 4] Category: OFP unitArray joinSilent group Operand types: unitArray: Array group: Object or Group Type of returned value: Nothing Description: Joins all units in the array to the given group.42 required.txt" Category: OFP PC http://www. id] Operand types: unit: Object [group. Example: _unit kbAddDatabase "chat. Avoid any radio communication related to joining. Avoid any radio communication related to joining. if position id is available. this one is used. Example: [unitOne. id]: Array Type of returned value: Nothing Description: Joins the unit to the given group.BIS Game Engine Scripting Commands Page 186 of 415 unit joinAsSilent [group. unitTwo] joinSilent player Category: OFP person kbAddDatabase filename Operand types: person: Object filename: String Compatibility: Version 2.html 7/11/2010 .arma2. Example: player joinAsSilent [_group.

. player event handler))]: Array Compatibility: Version 2.92 required.txt" Category: OFP PC person kbAddTopic [name. Example: _unit kbAddDatabase "chat. player event handler))] Operand types: person: Object [name. Category: OFP PC person kbHasTopic name Operand types: person: Object name: String Compatibility: Version 2.92 required. Category: OFP PC person kbReact [receiver. filename(.arma2. argument speech]. task type(.] http://www.com/comref/full.45 required. sentence id. filename(. argument value. .html 7/11/2010 . Type of returned value: Boolean Description: Register target list knowledge base database to given person..BIS Game Engine Scripting Commands Page 187 of 415 person kbAddDatabaseTargets filename Operand types: person: Object filename: String Compatibility: Version 2. Type of returned value: Boolean Description: Check if conversation topic was registered to given person. task type(. argument text. topic. [argument name. Type of returned value: Nothing Description: Register conversation topic to given person.

. Category: OFP PC person kbTell [receiver. [argument name. . topic. Category: OFP PC person kbWasSaid [receiver. Type of returned value: Nothing Description: Unregister conversation topic from given person.... sentence id. . argument speech]. sentence id.92 required.]: Array Compatibility: Version 2. sentence id. topic. sentence id. argument value. argument text. sentence id. Category: OFP PC person kbRemoveTopic name Operand types: person: Object name: String Compatibility: Version 2.]: Array Compatibility: Version 5500 required.] Operand types: person: Object [receiver. argument speech]. argument value. argument text..arma2. argument speech]. topic. [argument name. Type of returned value: Nothing Description: Make the person tell to the receiver the sentence. argument text. max.. argument value. [argument name. . topic. max. age] Operand types: person: Object [receiver.92 required.com/comref/full. topic. Type of returned value: Nothing Description: Pass a non-verbal communication to the receiver.BIS Game Engine Scripting Commands Page 188 of 415 Operand types: person: Object [receiver. age]: Array http://www.html 7/11/2010 .

01 required. Example: name = keyName 28 . result is "Enter" Category: OFP unit knowsAbout target Operand types: unit: Object or Group target: Object Type of returned value: http://www. Category: OFP PC keyImage dikCode Operand types: dikCode: Number Compatibility: Version 2. Example: name = keyImage 28 .BIS Game Engine Scripting Commands Page 189 of 415 Compatibility: Version 5500 required.com/comref/full. Type of returned value: Structured text Description: Returns a structured text. result is "Enter" Category: OFP keyName dikCode Operand types: dikCode: Number Compatibility: Version 2. mouse or joystick) with the given code.01 required.arma2. Type of returned value: String Description: Returns the name of a button (on the keyboard.html 7/11/2010 . containing an image or name (if no image is found) of the button (on the keyboard. mouse or joystick) with the given code. Type of returned value: Boolean Description: Check if given item was said by person to someone.

Example: cobraOne land "LAND" Category: OFP airplane landAt airportId Operand types: airplane: Object http://www.arma2. "GET OUT" (hovering low for another unit to get out) or "NONE" (cancel landing).BIS Game Engine Scripting Commands Page 190 of 415 Number Description: Checks whether the unit knows about the target (and how much). The landing mode may be "LAND" (a complete stop). Type of returned value: Number Description: Checks whether the side knows about the target (and how much). Example: east knowsAbout jeepOne Category: OFP helicopter land mode Operand types: helicopter: Object mode: String Type of returned value: Nothing Description: Forces a helicopter landing.html 7/11/2010 .com/comref/full. "GET IN" (hovering very low for another unit to get in). the vehicle commander is considered instead. Example: soldierOne knowsAbout jeepOne Category: OFP side knowsAbout target Operand types: side: Side target: Object Compatibility: Version 5501 required. If the unit is a vehicle.

92 required. text] Operand types: [idc. Example: _index = lbAdd [101. Type of returned value: Nothing Description: Order AI airplane to land at given airport Example: plane landAt 0 Category: OFP landResult helicopter Operand types: helicopter: Object Compatibility: Version 5501 required.50 required.BIS Game Engine Scripting Commands Page 191 of 415 airportId: Number Compatibility: Version 2. "NotReady" (position searching is still in progress) or empty string when wrong argument given.arma2.com/comref/full.html 7/11/2010 . Type of returned value: String Description: Return the result of helicopter landing position searching (performed after land command). text]: Array Compatibility: Version 1. The value can be "Found" (position found). "First item"] Category: Resistance control lbAdd text Operand types: http://www. Category: OFP lbAdd [idc. It returns the index of the newly added item. Type of returned value: Number Description: Adds an item with the given text to the listbox or combobox with id idc of the topmost user dialog. "NotFound" (position not found).

91 required.com/comref/full.50 required. Example: lbClear _control Category: OFP PC lbColor [idc. Example: lbClear 101 Category: Resistance lbClear control Operand types: control: Control Compatibility: Version 2.arma2. It returns the index of the newly added item. Type of returned value: Number Description: Adds an item with the given text to the given listbox or combobox.91 required. index] http://www. Type of returned value: Nothing Description: Clears all items in the listbox or combobox with id idc of the topmost user dialog.BIS Game Engine Scripting Commands Page 192 of 415 control: Control text: String Compatibility: Version 2. Type of returned value: Nothing Description: Clears all items in the given listbox or combobox.html 7/11/2010 . Example: _index = _control lbAdd "First item" Category: OFP PC lbClear idc Operand types: idc: Number Compatibility: Version 1.

Type of returned value: Array Description: Returns the text color of the item with the given index of the listbox or combobox with id idc of the topmost user dialog.html 7/11/2010 . Example: _index = lbCurSel 101 Category: Resistance http://www.com/comref/full.50 required. The color is returned in format Color. Example: _color = _control lbColor 0 Category: OFP PC lbCurSel idc Operand types: idc: Number Compatibility: Version 1. Type of returned value: Array Description: Returns the text color of the item with the given index of the given listbox or combobox.50 required. index]: Array Compatibility: Version 1.91 required.BIS Game Engine Scripting Commands Page 193 of 415 Operand types: [idc. 0] Category: Resistance control lbColor index Operand types: control: Control index: Number Compatibility: Version 2. Type of returned value: Number Description: Returns the index of the selected item of the listbox or combobox with id idc of the topmost user dialog.arma2. Example: _color = lbColor [101.

Type of returned value: String Description: Returns the additional text (invisible) in an item with the given index of the listbox or combobox with id idc of the topmost user dialog. Type of returned value: String Description: Returns the additional text (invisible) in an item with the given index of the given listbox or combobox.arma2. index]: Array Compatibility: Version 1. Type of returned value: Number Description: Returns the index of the selected item of the given listbox or combobox.91 required.com/comref/full. 0] Category: Resistance control lbData index Operand types: control: Control index: Number Compatibility: Version 2. Example: _index = lbCurSel _control Category: OFP PC lbData [idc.BIS Game Engine Scripting Commands Page 194 of 415 lbCurSel control Operand types: control: Control Compatibility: Version 2. Example: _data = _control lbData 0 Category: OFP PC http://www.html 7/11/2010 . Example: _data = lbData [101. index] Operand types: [idc.91 required.50 required.

50 required. Example: lbDelete [101. Example: _selected = _control lbIsSelected 0 http://www.html 7/11/2010 . Type of returned value: Nothing Description: Removes the item with the given index from the given listbox or combobox.91 required. Example: _control lbDelete 0 Category: OFP PC control lbIsSelected index Operand types: control: Control index: Number Compatibility: Version 2. 0] Category: Resistance control lbDelete index Operand types: control: Control index: Number Compatibility: Version 2. index] Operand types: [idc. Type of returned value: Nothing Description: Removes the item with the given index from the listbox or combobox with id idc of the topmost user dialog.arma2. Type of returned value: Boolean Description: Check whether given row of the given listbox is selected.92 required.com/comref/full.BIS Game Engine Scripting Commands Page 195 of 415 lbDelete [idc. index]: Array Compatibility: Version 1.

Example: http://www. Type of returned value: String Description: Returns the picture name of the item with the given index of the given listbox or combobox.91 required.arma2. 0] Category: Resistance control lbPicture index Operand types: control: Control index: Number Compatibility: Version 2.50 required. Example: _picture = lbPicture [101.92 required.html 7/11/2010 . Type of returned value: String Description: Returns the picture name of the item with the given index of the listbox or combobox with id idc of the topmost user dialog.com/comref/full. Type of returned value: Array Description: Returns the array of selected rows indices in the given listbox.BIS Game Engine Scripting Commands Page 196 of 415 Category: OFP PC lbPicture [idc. index] Operand types: [idc. Example: _picture = _control lbPicture 0 Category: OFP PC lbSelection control Operand types: control: Control Compatibility: Version 2. index]: Array Compatibility: Version 1.

html 7/11/2010 . 1.BIS Game Engine Scripting Commands Page 197 of 415 _indices = lbSelection _control Category: OFP PC lbSetColor [idc.arma2. Example: _control lbSetColor [0. [0. Example: lbSetColor [101. 0.50 required. index]: Array Compatibility: Version 1. 1. 0. index. 0. Color is in format Color. 0.com/comref/full. index.50 required. color] Operand types: [idc. Type of returned value: Nothing Description: Sets the color of the item with the given index of the listbox or combobox with id idc of the topmost user dialog to the given color. index] Operand types: [idc. color] Operand types: control: Control [index. color]: Array Compatibility: Version 2. [0. color]: Array Compatibility: Version 1. Color is in format Color.5]] Category: Resistance control lbSetColor [index.5]] Category: OFP PC lbSetCurSel [idc. 0. Type of returned value: Nothing Description: Sets the text color of the item with the given index of the given listbox or combobox.91 required. Type of returned value: Nothing Description: http://www.

data]: Array Compatibility: http://www. data] Operand types: [idc.html 7/11/2010 . Type of returned value: Nothing Description: Selects the item with the given index of the given listbox or combobox. Example: _control lbSetCurSel 0 Category: OFP PC lbSetData [idc.com/comref/full. 0] Category: Resistance control lbSetCurSel index Operand types: control: Control index: Number Compatibility: Version 2. 1.91 required. index. data]: Array Compatibility: Version 1.BIS Game Engine Scripting Commands Page 198 of 415 Selects the item with the given index of the listbox or combobox with id idc of the topmost user dialog. Example: lbSetCurSel [101. data] Operand types: control: Control [index. "#1"] Category: Resistance control lbSetData [index. Type of returned value: Nothing Description: Sets the additional text (invisible) in the item with the given index of the listbox or combobox with id idc of the topmost user dialog to the given data. Example: lbSetData [101. index.50 required.arma2.

Name is the picture name. index. name] Operand types: [idc. 0. "#1"] Category: OFP PC lbSetPicture [idc. the dtaExt subdirectory of the campaign directory and the dtaExt directory and the data bank (or directory). the dtaExt subdirectory of the campaign directory and the dtaExt directory and the data bank (or directory). Type of returned value: Nothing Description: Sets the picture in the item with the given index of the given listbox or combobox. name]: Array Compatibility: Version 1. Example: _control lbSetPicture [0. "iskoda"] Category: OFP PC http://www. "iskoda"] Category: Resistance control lbSetPicture [index. Name is the picture name. name] Operand types: control: Control [index.html 7/11/2010 .com/comref/full. Example: _control lbSetData [1. Type of returned value: Nothing Description: Sets the picture in the item with the given index of the listbox or combobox with id idc of the topmost user dialog.BIS Game Engine Scripting Commands Page 199 of 415 Version 2.91 required. name]: Array Compatibility: Version 2. The picture is searched in the mission directory.50 required. The picture is searched in the mission directory. Example: lbSetPicture [101.arma2.91 required. Type of returned value: Nothing Description: Sets the additional text (invisible) in the item with the given index of the given listbox or combobox to the given data. index.

Example: lbSetValue [101. 0.BIS Game Engine Scripting Commands Page 200 of 415 control lbSetSelected [index. Type of returned value: Nothing Description: Sets the additional integer value in the item with the given index of the listbox or combobox with id idc of the topmost user dialog to the given value. value] Operand types: control: Control [index. true] Category: OFP PC lbSetValue [idc.html 7/11/2010 . index. index.arma2.com/comref/full. Example: _control lbSetValue [0. 1] Category: Resistance control lbSetValue [index. 1] http://www. Listbox must support multiple selection Example: _control lbSetSelection [0.91 required. value]: Array Compatibility: Version 1. value]: Array Compatibility: Version 2. selected]: Array Compatibility: Version 5501 required.50 required. Type of returned value: Nothing Description: Sets the additional integer value in the item with the given index of the given listbox or combobox to the given value. Type of returned value: Nothing Description: Set the selection state of the given row of the given listbox. value] Operand types: [idc. selected] Operand types: control: Control [index.

arma2. Type of returned value: Number Description: Sorts the given listbox or combobox by item text.html 7/11/2010 .50 required. Type of returned value: Number Description: Returns the number of items in the given listbox or combobox. Example: lbSort _control http://www.BIS Game Engine Scripting Commands Page 201 of 415 Category: OFP PC lbSize control Operand types: control: Control Compatibility: Version 2. Type of returned value: Number Description: Returns the number of items in the listbox or combobox with id idc of the topmost user dialog. Example: _n = lbSize _control Category: OFP PC lbSize idc Operand types: idc: Number Compatibility: Version 1.91 required. Example: _n = lbSize 101 Category: Resistance lbSort control Operand types: control: Control Compatibility: Version 5148 required.com/comref/full.

Type of returned value: String Description: Returns the shown text in the item with the given index of the given listbox or combobox. 0] Category: Resistance control lbText index Operand types: control: Control index: Number Compatibility: Version 2. Example: _text = lbText [101.91 required. Type of returned value: String Description: Returns the shown text in the item with the given index of the listbox or combobox with id idc of the topmost user dialog. index]: Array Compatibility: Version 1.50 required. Type of returned value: Number Description: Sorts the given listbox or combobox by item value.html 7/11/2010 . Example: http://www. Example: lbSortByValue _control Category: OFP PC lbText [idc.BIS Game Engine Scripting Commands Page 202 of 415 Category: OFP PC lbSortByValue control Operand types: control: Control Compatibility: Version 5148 required. index] Operand types: [idc.com/comref/full.arma2.

91 required.html 7/11/2010 . Type of returned value: Number Description: Returns the additional integer value in the item with the given index of the listbox or combobox with id idc of the topmost user dialog. index]: Array Compatibility: Version 1. index] Operand types: [idc. http://www. Type of returned value: Number Description: Returns the additional integer value in the item with the given index of the given listbox or combobox. For dead units.BIS Game Engine Scripting Commands Page 203 of 415 _text = _control lbText 0 Category: OFP PC lbValue [idc. 0] Category: Resistance control lbValue index Operand types: control: Control index: Number Compatibility: Version 2.com/comref/full.arma2. Example: _value = _control lbValue 0 Category: OFP PC leader unit Operand types: unit: Object Type of returned value: Object Description: Returns the group leader for the given unit.50 required. Example: _value = lbValue [101. objNull is returned.

For a dead unit.BIS Game Engine Scripting Commands Page 204 of 415 Example: leader player Category: OFP leader grp Operand types: grp: Group Type of returned value: Object Description: Returns the group leader for the given group.arma2. Example: groupOne leaveVehicle jeepOne Category: OFP http://www.html 7/11/2010 . Example: soldierOne leaveVehicle jeepOne Category: OFP group leaveVehicle vehicle Operand types: group: Group vehicle: Object Type of returned value: Nothing Description: Ceases the using of the vehicle in the group. grpNull is returned.com/comref/full. Example: leader group player == leader player Category: OFP group leaveVehicle vehicle Operand types: group: Object vehicle: Object Type of returned value: Nothing Description: Ceases the using of the vehicle in the group. It unassigns all grouped units from the vehicle. It unassigns all grouped units from the vehicle.

Category: OFP lightDetachObject light Operand types: light: Object Compatibility: Version 2. position] Operand types: light: Object [object. Type of returned value: Nothing Description: Attach light to given object (at given position).58 required.58 required.arma2. position]: Array Compatibility: Version 2. Type of returned value: String Description: Returns the life state of the given unit. Type of returned value: Nothing Description: Detach light from object.com/comref/full. Category: OFP lightIsOn lamppost Operand types: lamppost: Object Compatibility: Version 1.BIS Game Engine Scripting Commands Page 205 of 415 lifeState unit Operand types: unit: Object Compatibility: Version 5501 required.04 required. http://www. Category: OFP light lightAttachObject [object.html 7/11/2010 .

arma2.html 7/11/2010 . Possible values are "ON". http://www. Type of returned value: Structured text Description: Creates a structured text containing a line break. Category: OFP lineBreak Compatibility: Version 2.com/comref/full. For a trigger of type "Not present" the list is the same as the list that would be returned for type "Present". "StreetLamp"] != "OFF" Category: OFP object limitSpeed speed Operand types: object: Object speed: Number Compatibility: Version 2. Type of returned value: Nothing Description: Limit speed of given vehicle to given value (in km/h).01 required.BIS Game Engine Scripting Commands Page 206 of 415 Type of returned value: String Description: Checks whether the lampost is turned on. "OFF" and "AUTO" (auto means the lamp will be shining during the night automatically).92 required. Example: txt3 = lineBreak Category: OFP list trigger Operand types: trigger: Object Type of returned value: Array Description: Returns a list of units that would activate the given trigger. Example: lightIsOn nearestObject [player.

]] Operand types: [IDC.].. [[text. Example: _index = lnbAddRow [idc.text]. [value. [data.[[[text..].html 7/11/2010 .com/comref/full..[[[text.]]: Array Compatibility: Version 5501 required..text]. http://www. [data.BIS Game Engine Scripting Commands Page 207 of 415 Example: list triggerOne Category: OFP map listObjects type Operand types: map: Control type: String Compatibility: Version 2...[[]]]] . Category: Editor ln x Operand types: x: Number Type of returned value: Number Description: The natural logarithm of x.]]. Returns row index.]].text]. [value. [value.. result is 2. [[text. [value. [data. Type of returned value: Number Description: Adds list of rows of strings..arma2. Type of returned value: Array Description: Return the list of all objects of given type...[[[]].]... [data.].text].]]....92 required.302 Category: Default lnbAddArray [IDC.]]. Example: ln 10 ..

[text. [text.. Example: _index = lnbAddColumn [105. Example: _index = _control lbAdd "First item" Category: OFP PC lnbAddRow [idc.. Type of returned value: Number Description: Adds an row of strings..]] Operand types: [idc.]]: Array Compatibility: Version 5501 required...com/comref/full.50 required. It returns the index of the newly added item.BIS Game Engine Scripting Commands Page 208 of 415 Category: Resistance lnbAddColumn [idc. It returns the index of the newly added column.html 7/11/2010 . text.8] Category: Resistance control lnbAddColumn position Operand types: control: Control position: Number Compatibility: Version 5501 required. 0.arma2. position] Operand types: [idc. text. Example: http://www.. Type of returned value: Number Description: Adds an column at given position. Type of returned value: Number Description: Adds an item with the given text to the given listbox or combobox. position]: Array Compatibility: Version 1.

["First column"...t2.t3. Example: lnbClear 101 Category: Resistance lnbClear control Operand types: control: Control Compatibility: Version 2.BIS Game Engine Scripting Commands Page 209 of 415 _index = lnbAddRow [105.html 7/11/2010 ..]].] Operand types: control: Control [text1. http://www. .text2... It returns the index of the newly added row.. Example: _index = _control lnbAdd [t1...com/comref/full. Returns row index. "second column". Type of returned value: Nothing Description: Clears all items in the 2D listbox.91 required.] Category: OFP PC lnbClear idc Operand types: idc: Number Compatibility: Version 5501 required..]: Array Compatibility: Version 5501 required. Type of returned value: Number Description: Adds an row to the end od 2d listbox . Category: Resistance control lnbAddRow [text1..text2. Type of returned value: Nothing Description: Clears all items in the given listbox or combobox..arma2.

Type of returned value: Array Description: Returns the text color of the item with the given position of the given 2D listbox.com/comref/full. column]: Array Compatibility: Version 5501 required.html 7/11/2010 . Example: _color = _control lnbColor [row.1]] Category: Resistance control lnbColor [row.91 required. The color is returned in format Color. [0. [row.arma2. Example: _color = lnbColor [101. column] Operand types: control: Control [row. column] Category: OFP PC lnbCurSelRow control Operand types: control: Control Compatibility: Version 2. [row. column]: Array Compatibility: Version 5501 required.BIS Game Engine Scripting Commands Page 210 of 415 Example: lbClear _control Category: OFP PC lnbColor [idc. Type of returned value: Array Description: Returns the text color of the item with the given position of the 2D listbox. column] Operand types: [idc. Type of returned value: Number Description: http://www.

[row. column] Operand types: [idc. column]: Array Compatibility: Version 5501 required. Example: _row = lnbCurSel 105 Category: Resistance lnbData [idc. [row. column]: Array Compatibility: Version 5501 required.1]] Category: Resistance control lnbData [row. Type of returned value: String Description: Returns the additional text (invisible) in an item with the given position of the 2D listbox. Type of returned value: Number Description: Returns the index of the selected row id 2D listbox.com/comref/full.BIS Game Engine Scripting Commands Page 211 of 415 Returns the index of the selected item of the given listbox or combobox.arma2. [0. column] Operand types: control: Control [row. Type of returned value: String http://www.html 7/11/2010 . Example: _index = lbCurSel _control Category: OFP PC lnbCurSelRow idc Operand types: idc: Number Compatibility: Version 5501 required. Example: _data = lnbData [101.

Type of returned value: Nothing Description: Removes column with given index.50 required. Type of returned value: Nothing Description: Removes the item with the given index from the given listbox or combobox.BIS Game Engine Scripting Commands Page 212 of 415 Description: Returns the additional text (invisible) in an item with the given position of the given 2D listbox. index] Operand types: [idc. index]: Array Compatibility: Version 1.com/comref/full. Example: _data = _control lnbData [row.html 7/11/2010 . Example: _control lbDelete 0 Category: OFP PC lnbDeleteRow [idc. Type of returned value: http://www.arma2. index]: Array Compatibility: Version 5501 required. index] Operand types: [idc. column] Category: OFP PC lnbDeleteColumn [idc. Example: lnbDeleteColumn [101. 0] Category: Resistance control lnbDeleteColumn index Operand types: control: Control index: Number Compatibility: Version 5501 required.

Example: _control lnbDelete 0 Category: OFP PC lnbGetColumnsPosition control Operand types: control: Control Compatibility: Version 2. http://www.BIS Game Engine Scripting Commands Page 213 of 415 Nothing Description: Removes row with given index from the 2D listbox.arma2. Type of returned value: Nothing Description: Removes row with the given index from the given listbox or combobox. Example: lnbDeleteRow [105.html 7/11/2010 .91 required. Example: _index = lbCurSel _control Category: OFP PC lnbGetColumnsPosition idc Operand types: idc: Number Compatibility: Version 5501 required.com/comref/full. Type of returned value: Array Description: Returns the index of the selected item of the given listbox or combobox. 0] Category: Resistance control lnbDeleteRow row Operand types: control: Control row: Number Compatibility: Version 5501 required.

column]. column]. Type of returned value: String Description: Returns the picture name of the item with the given position of the given listbox or combobox.1]] Category: Resistance control lnbPicture [row.html 7/11/2010 . [row. color]: Array Compatibility: http://www. Type of returned value: String Description: Returns the picture name of the item with the given position of the 2D listbox. column] Operand types: [idc. column]: Array Compatibility: Version 5501 required. color] Operand types: [idc.com/comref/full. Example: _picture = _control lnbPicture [row. [row. column] Category: OFP PC lnbSetColor [idc. [row.BIS Game Engine Scripting Commands Page 214 of 415 Type of returned value: Array Description: Returns the columns position in 2D listbox.arma2. [0. Example: _n = lnbGetColumnsSize 105 Category: Resistance lnbPicture [idc. Example: _picture = lnbPicture [101. column] Operand types: control: Control [row. [row. column]: Array Compatibility: Version 5501 required.

html 7/11/2010 . column]. 0. color] Operand types: control: Control [[row.BIS Game Engine Scripting Commands Page 215 of 415 Version 5501 required. [row.arma2. data]: Array Compatibility: Version 5501 required.. Type of returned value: Nothing Description: Sets the additional text (invisible) in the item with the given position of the 2D listbox. Type of returned value: Nothing Description: Sets the color of the item with the given position of the 2D listbox. column].1].5]] Category: Resistance control lnbSetColor [[row. [0. 1.pos2.5]] Category: OFP PC lnbsetColumnsPos [idc. 0. Color is in format Color. column]. [0. data] Operand types: [idc. Color is in format Color. 0. column]. 0... Example: lnbSetColor [101. column]. Example: lnbSetData [101. Type of returned value: Nothing Description: Sets the text color of the item with the given position of the given 2D listbox . "#1"] Category: Resistance control lnbSetColumnsPos [pos1. [0. Example: _control lnbSetColor [[row. 1.1].com/comref/full. color]: Array Compatibility: Version 5501 required. [row. [0.] Operand types: http://www.

BIS Game Engine Scripting Commands Page 216 of 415 control: Control [pos1.. data] http://www. column]. [row. index] Operand types: [idc.. Example: _control lbSetCurSel row Category: OFP PC lnbSetData [idc. Example: lnbSetCurSel [105.com/comref/full.. Type of returned value: Nothing Description: Selects the item with the given index of the given listbox or combobox.html 7/11/2010 .arma2. Type of returned value: Nothing Description: Selects the row with the given index of the 2D listbox..pos2.] Category: OFP PC lnbSetCurSelRow [idc. Type of returned value: Nothing Description: Set position of 2d listbox columns.]: Array Compatibility: Version 5501 required.. Example: _control lbSetColumnsPos [pos1..pos2. index]: Array Compatibility: Version 5501 required. 0] Category: Resistance control lnbSetCurSelRow row Operand types: control: Control row: Number Compatibility: Version 5501 required.

com/comref/full. The picture is searched in the mission directory.BIS Game Engine Scripting Commands Page 217 of 415 Operand types: [idc. data]: Array Compatibility: Version 5501 required. Name is the picture name. [row. "#1"] Category: OFP PC lnbSetPicture [idc. name]: Array Compatibility: Version 5501 required. Type of returned value: Nothing Description: Sets the additional text (invisible) in the item with the given position of the 2D listbox. column]. Type of returned value: Nothing Description: Sets the additional text (invisible) in the item with the given position of the given 2D listbox to the given data.1]. [0. Example: lnbSetData [101. column]. "#1"] Category: Resistance control lnbSetData [[row.1]. data]: Array Compatibility: Version 5501 required. "iskoda"] Category: Resistance http://www. column]. name] Operand types: [idc. column].html 7/11/2010 . column].arma2. [row. Example: lnbSetPicture [101. [0. data] Operand types: control: Control [[row. Type of returned value: Nothing Description: Sets the picture in the item with the given position of the 2D listbox. [row. column]. the dtaExt subdirectory of the campaign directory and the dtaExt directory and the data bank (or directory). Example: _control lnbSetData [[row.

column]. [row. column]. data]: Array Compatibility: Version 5501 required. column]. Type of returned value: Nothing Description: Sets the additional text (invisible) in the item with the given position of the 2D listbox. [row. column].com/comref/full. [0. The picture is searched in the mission directory. "#1"] Category: Resistance control lnbSetText [[row. column]. Example: lnbSetData [101. column]. Type of returned value: Nothing Description: Sets the additional text (invisible) in the item with the given index of the given 2D listbox to the given data. text] Operand types: control: Control [[row. Example: _control lnbSetData [[row. name]: Array Compatibility: Version 5501 required. text]: Array Compatibility: Version 5501 required.BIS Game Engine Scripting Commands Page 218 of 415 control lnbSetPicture [[row. name] Operand types: control: Control [[row. column]. Name is the picture name.arma2. "#1"] http://www.html 7/11/2010 . column].1]. data] Operand types: [idc. the dtaExt subdirectory of the campaign directory and the dtaExt directory and the data bank (or directory). "iskoda"] Category: OFP PC lnbSetText [idc. Type of returned value: Nothing Description: Sets the picture in the item with the given position of the given 2D listbox. Example: _control lnbSetPicture [[row.

column]. Type of returned value: Nothing Description: Sets the additional integer value in the item with the given position of the given 2D listbox to the given value. Type of returned value: Nothing Description: Sets the additional integer value in the item with the position index of the 2D listbox. value] Operand types: [idc. value]: Array Compatibility: Version 5501 required.arma2. 1] Category: OFP PC lnbSize idc Operand types: idc: Number Compatibility: Version 5501 required. Type of returned value: Array Description: Returns [X. value]: Array Compatibility: Version 5501 required. [row. column].1]. Example: _control lnbSetValue [[row. column]. Example: lnbSetValue [101. 1] Category: Resistance control lnbSetValue [[row. column]. column].Y] size of 2D listbox. [row. value] Operand types: control: Control [[row. Example: http://www. [0.BIS Game Engine Scripting Commands Page 219 of 415 Category: OFP PC lnbSetValue [idc.com/comref/full.html 7/11/2010 .

column]]: Array Compatibility: Version 1.1]] Category: Resistance control lnbText [row. Type of returned value: String Description: Returns the shown text in the item with the given position of the given 2D listbox. [row. column] Operand types: control: Control [row. [row. Example: _text = lnbText [101. column]] Operand types: [idc. http://www.html 7/11/2010 . Type of returned value: Array Description: Returns the number of items in the given listbox or combobox. Type of returned value: String Description: Returns the shown text in the item with the given position of the 2D listbox.91 required. Example: _n = lbSize _control Category: OFP PC lnbText [idc.com/comref/full. [0.arma2. column]: Array Compatibility: Version 5501 required.50 required.BIS Game Engine Scripting Commands Page 220 of 415 _n = lnbSize 105 Category: Resistance lnbSize control Operand types: control: Control Compatibility: Version 2.

com/comref/full. [row. column] Operand types: control: Control [row.BIS Game Engine Scripting Commands Page 221 of 415 Example: _text = _control lnbText [row. Type of returned value: String Description: Returns the content of the given file. column] Category: OFP PC loadFile filename Operand types: filename: String Compatibility: Version 1. column] Category: OFP PC lnbValue [idc.arma2. column]: Array Compatibility: Version 5501 required. http://www.html 7/11/2010 . Type of returned value: Number Description: Returns the additional integer value in the item with the given position of the given 2D listbox. Type of returned value: Number Description: Returns the additional integer value in the item with the given position of the 2D listbox. column]: Array Compatibility: Version 5501 required. [row. column] Operand types: [idc. [0. Example: _value = lnbValue [101. Example: _value = _control lnbValue [row.1]] Category: Resistance control lnbValue [row.82 required.

92 required.sqf" . Category: Editor http://www. if failed.75 required. Type of returned value: Nothing Description: Creates the load overlay dialog for the specified type of overlay.sav file in campaign directory (from entry name).com/comref/full. Type of returned value: Nothing Description: Load a game from the autosave. Type of returned value: Boolean Description: Loads person's identity from objects.BIS Game Engine Scripting Commands Page 222 of 415 Example: loadFile "myFunction.html 7/11/2010 . result is "if a>b then {a} else {b}" Category: OFP loadGame Compatibility: Version 5501 required.arma2. Example: player loadIdentity "playerIdentity" Category: Resistance map loadOverlay config Operand types: map: Control config: Config Compatibility: Version 2. Category: OFP person loadIdentity name Operand types: person: Object name: String Compatibility: Version 1. restart the mission.

csv file.arma2.com/comref/full. Example: local unitName Category: OFP localize stringName Operand types: stringName: String Type of returned value: String Description: Replaces the string with the given name with the corresponding localized text from the stringtable. Example: player loadStatus "playerState" Category: Resistance local obj Operand types: obj: Object Type of returned value: Boolean Description: MP: checks whether the given unit is local on the computer. Example: localize "STR_DN_FROG" Category: OFP http://www. In SP all objects are local.html 7/11/2010 . Note: all static objects are local on all computers.BIS Game Engine Scripting Commands Page 223 of 415 object loadStatus name Operand types: object: Object name: String Compatibility: Version 1.sav file in campaign directory (from entry name).75 required. This can be used when one or more activation fields or scripts need to be performed only on one computer. Type of returned value: Boolean Description: Loads object's properties from objects.

arma2. Category: Location locationPosition location Operand types: location: Location Compatibility: Version 2.html 7/11/2010 . Example: jeepOne lock true Category: OFP vehicle lockCargo lock Operand types: vehicle: Object lock: Boolean Compatibility: Version 5501 required. Category: Location vehicle lock lock Operand types: vehicle: Object lock: Boolean Type of returned value: Nothing Description: Locks the vehicle (disables mounting / dismounting) for the player.90 required. Type of returned value: Location Description: A non-existing location. This value is not equal to anything. including itself. Type of returned value: Nothing http://www.com/comref/full.BIS Game Engine Scripting Commands Page 224 of 415 locationNull Compatibility: Version 5501 required. Type of returned value: Array Description: Return position of given location.

Category: OFP vehicle lockCargo [cargo index.arma2. lock] Operand types: vehicle: Object [cargo index. Category: OFP vehicle lockDriver lock Operand types: vehicle: Object lock: Boolean Compatibility: Version 5501 required. the player cannot mount / dismount without an order. lock]: Array Compatibility: Version 5501 required.BIS Game Engine Scripting Commands Page 225 of 415 Description: Lock the all cargo positions of the vehicle. Type of returned value: Nothing Description: Lock the driver position of the vehicle. Example: locked jeepOne Category: OFP http://www. If it's locked. Category: OFP locked unit Operand types: unit: Object Type of returned value: Boolean Description: Checks whether the vehicle is locked for the player.html 7/11/2010 .com/comref/full. Type of returned value: Nothing Description: Lock the cargo position of the vehicle.

com/comref/full. Category: OFP vehicle lockedTurret turret path Operand types: vehicle: Object turret path: Array Compatibility: Version 5501 required.html 7/11/2010 . Category: OFP lockedDriver vehicle Operand types: vehicle: Object Compatibility: Version 5501 required. Type of returned value: Boolean Description: Check whether gunner position of the vehicle turret is locked. lock]: Array Compatibility: Version 5501 required.arma2. Type of returned value: Boolean Description: Check whether cargo position of the vehicle is locked. http://www. Category: OFP vehicle lockTurret [turret path. Type of returned value: Boolean Description: Check whether driver position of the vehicle turret is locked.BIS Game Engine Scripting Commands Page 226 of 415 vehicle lockedCargo cargo index Operand types: vehicle: Object cargo index: Number Compatibility: Version 5501 required. lock] Operand types: vehicle: Object [turret path.

Example: log 10 . Example: groupOne lockWP true Category: OFP log x Operand types: x: Number Type of returned value: Number Description: The base-10 logarithm of x.40 required.arma2. This is sometimes used during cut-scenes.BIS Game Engine Scripting Commands Page 227 of 415 Type of returned value: Nothing Description: Lock the gunner position of the vehicle turret. Type of returned value: Nothing Description: Control what the unit is looking at (target or position) (format Position) http://www. Category: OFP group lockWp lockWP Operand types: group: Object or Group lockWP: Boolean Type of returned value: Nothing Description: Disables switching to the next waypoint (the current waypoint will never complete while lockWp is used). result is 1 Category: Default unit(s) lookAt position Operand types: unit(s): Object or Array position: Object or Array Compatibility: Version 2.html 7/11/2010 .com/comref/full.

html 7/11/2010 . Category: Editor magazines vehicle Operand types: vehicle: Object Compatibility: Version 1. The format of frame is [time. and point the camera at. Type of returned value: Array Description: Returns an array with the type names of all the vehicle's magazines. Example: magazines player Category: Resistance mapAnimAdd frame Operand types: frame: Array Compatibility: Version 1. position].com/comref/full.27 required. Type of returned value: Nothing Description: Center the map on. the format of position is Position2D.75 required.BIS Game Engine Scripting Commands Page 228 of 415 Example: someSoldier lookAt otherSoldier. zoom. http://www.92 required.arma2. Type of returned value: Nothing Description: Adds the next frame to the map animation. otherSoldier lookAt getMarkerPos "markerOne" Category: OFP map lookAtPos position Operand types: map: Control position: Array Compatibility: Version 2. the position.

27 required.1. Category: OFP markerAlpha markerName Operand types: markerName: String Compatibility: Version 5501 required. getMarkerPos "anim1"] Category: OFP mapAnimClear Compatibility: Version 1.com/comref/full. Type of returned value: Number http://www.27 required. Type of returned value: Boolean Description: Checks whether the map animation has finished. Category: OFP mapAnimCommit Compatibility: Version 1.html 7/11/2010 .BIS Game Engine Scripting Commands Page 229 of 415 Example: mapAnimAdd [1. Type of returned value: Nothing Description: Plays the map animation. Type of returned value: Nothing Description: Clears the map animation. Category: OFP mapAnimDone Compatibility: Version 1.arma2.27 required. 0.

92 required. Example: markerAlpha "MarkerOne" Category: OFP markerBrush name Operand types: name: String Compatibility: Version 5501 required.arma2. Type of returned value: String Description: Gets the marker color. Note: this function is identical to getMarkerColor.html 7/11/2010 . Example: markerColor "MarkerOne" Category: OFP markerDir markerName Operand types: markerName: String Compatibility: Version 2.BIS Game Engine Scripting Commands Page 230 of 415 Description: Gets the marker alpha. See setMarkerColor. See setMarkerAlpha. Example: markerBrush "MarkerOne" Category: OFP markerColor markerName Operand types: markerName: String Compatibility: Version 1. Type of returned value: Array http://www.50 required.com/comref/full. Type of returned value: String Description: Gets the marker brush. See setMarkerBrush.

y].50 required.arma2. Type of returned value: String Description: Gets the marker shape.50 required. Example: markerDir "MarkerOne" Category: OFP markerPos markerName Operand types: markerName: String Compatibility: Version 1.BIS Game Engine Scripting Commands Page 231 of 415 Description: Gets the marker direction.z. See setMarkerShape. Note: this function is identical to getMarkerPos. Example: markerShape "MarkerOne" Category: OFP markerSize markerName Operand types: markerName: String Compatibility: Version 1. Type of returned value: Array Description: Returns the marker positon in format [x. Example: markerPos "markerOne" Category: OFP markerShape name Operand types: name: String Compatibility: Version 5501 required.html 7/11/2010 .com/comref/full. See setMarkerDir. Type of returned value: Array http://www.

com/comref/full. Example: markerSize "MarkerOne" Category: OFP markerText markerName Operand types: markerName: String Compatibility: Version 2. Example: markerType "MarkerOne" Category: OFP a max b Operand types: a: Number b: Number Type of returned value: Number Description: http://www. Example: markerText "MarkerOne" Category: OFP markerType markerName Operand types: markerName: String Compatibility: Version 1.html 7/11/2010 .92 required.50 required.BIS Game Engine Scripting Commands Page 232 of 415 Description: Gets the marker size. See setMarkerText. Note: this function is identical to getMarkerType.arma2. Note: this function is identical to getMarkerSize. Type of returned value: Array Description: Gets the marker text. Type of returned value: String Description: Gets the type of the marker. See setMarkerSize. See setMarkerType.

result is 2 Category: Default missionConfigFile Compatibility: Version 2.80 required.90 required. Type of returned value: Config Description: Return root of mission description.b Example: 3 min 2 . Category: OFP PC missionName Compatibility: Version 1.ext entries hierarchy. Type of returned value: String Description: Returns the name of the current mission.html 7/11/2010 .b Example: 3 max 2 . Category: OFP missionNamespace http://www. result is 3 Category: Default a min b Operand types: a: Number b: Number Type of returned value: Number Description: The smaller of a.BIS Game Engine Scripting Commands Page 233 of 415 The greater of a.com/comref/full.arma2.

Category: OFP missionStart Compatibility: Version 1. Example: 3 mod 2 .92 required. Type of returned value: Namespace Description: Return the global namespace attached to mission. minute. Note that the remainer is calculated in the real domain. hour. Category: OFP a mod b Operand types: a: Number b: Number Type of returned value: Number Description: The remainder of a divided by b. Type of returned value: Array Description: Converts position from object model space to world space. Category: OFP http://www.BIS Game Engine Scripting Commands Page 234 of 415 Compatibility: Version 5501 required. month. Type of returned value: Array Description: Returns the time of the mission start in format [year.80 required. day. second].arma2.html 7/11/2010 .com/comref/full. result is 1 Category: Default object modelToWorld modelPos Operand types: object: Object modelPos: Array Compatibility: Version 2.

result is 0. (Immediately.arma2.BIS Game Engine Scripting Commands Page 235 of 415 morale unit Operand types: unit: Object Compatibility: Version 5500 required..html 7/11/2010 . without animation). Example: morale leader player . Example: groupOne move getPos player Category: OFP soldier moveInCargo vehicle Operand types: soldier: Object vehicle: Object Type of returned value: Nothing Description: Moves the soldier into the vehicle's cargo position. Example: soldierOne moveInCargo jeepOne Category: OFP http://www.+1).com/comref/full.5 Category: OFP group move pos Operand types: group: Object or Group pos: Array Type of returned value: Nothing Description: Creates a move waypoint on the given position (format Position) and makes it the currently active group waypoint. Type of returned value: Number Description: Checks a current morale level of the unit (-1.

without animation). Example: soldierOne moveInDriver jeepOne Category: OFP soldier moveInGunner vehicle Operand types: http://www. CargoIndex] Operand types: soldier: Object [vehicle. (Immediatetely.html 7/11/2010 . CargoIndex]: Array Type of returned value: Nothing Description: Moves the soldier into a vehicle's specified cargo position.com/comref/full. Example: soldierOne moveInCargo jeepOne Category: OFP soldier moveInCommander vehicle Operand types: soldier: Object vehicle: Object Type of returned value: Nothing Description: Moves the soldier into the vehicle's commander position. without animation). without animation). (Immediately. Example: soldierOne moveInCommander jeepOne Category: OFP soldier moveInDriver vehicle Operand types: soldier: Object vehicle: Object Type of returned value: Nothing Description: Moves the soldier into the vehicle's driver position.arma2.BIS Game Engine Scripting Commands Page 236 of 415 soldier moveInCargo [vehicle. (Immediately.

com/comref/full. turret path] Operand types: soldier: Object [vehicle. Example: soldierOne moveInTurret [tank.arma2. Type of returned value: Nothing Description: Shifts an editor object to the end of the objects array. turret path]: Array Type of returned value: Nothing Description: Moves the soldier into the vehicle's turret. (Immediately. http://www.BIS Game Engine Scripting Commands Page 237 of 415 soldier: Object vehicle: Object Type of returned value: Nothing Description: Moves the soldier into the vehicle's gunner position. Category: Editor moveOut soldier Operand types: soldier: Object Compatibility: Version 5501 required. This means that the object will be drawn last (after all other objects). [0.html 7/11/2010 . without animation). Example: soldierOne moveInGunner jeepOne Category: OFP soldier moveInTurret [vehicle. 0]] Category: OFP map moveObjectToEnd object Operand types: map: Control object: String Compatibility: Version 2.92 required. (Immediately. without animation).

BIS Game Engine Scripting Commands Page 238 of 415 Type of returned value: Nothing Description: Moves the soldier out of vehicle. Example: moveTime player Category: OFP PC person moveTo position Operand types: person: Object position: Array Compatibility: Version 2. Category: OFP moveToCompleted person Operand types: person: Object Compatibility: Version 2. (Immediately. Type of returned value: Nothing Description: Low level command to person to move to given position. Type of returned value: Boolean Description: Check if latest low level moveTo command is finished. Type of returned value: Number Description: Returns the current time of the most important RTM animation currently being played on the soldier. Category: OFP moveTime soldier Operand types: soldier: Object Compatibility: Version 5500 required. without animation). http://www.61 required.62 required.com/comref/full.html 7/11/2010 .arma2.

driver. gunner). Category: OFP name object Operand types: object: Object Type of returned value: String Description: Returns the name of the variable assigned to the object in the mission editor. When used on a vehicle.90 required. http://www.com/comref/full. Type of returned value: Boolean Description: Check if latest low level moveTo command failed. Example: name vehicle player Category: OFP name location Operand types: location: Location Compatibility: Version 2.arma2.BIS Game Engine Scripting Commands Page 239 of 415 Category: OFP moveToFailed person Operand types: person: Object Compatibility: Version 2. the name of the first crew member is returned (in order: commander.92 required. Category: OFP musicVolume Type of returned value: Number Description: Checks the current music volume (set by fadeMusic).html 7/11/2010 .

]..90 required. .BIS Game Engine Scripting Commands Page 240 of 415 Type of returned value: String Description: Return name of global vatiable containing given location. radius] Operand types: position: Object or Array radius or [typeName. typeName2.com/comref/full. Example: _list = position player nearObjects 50 Category: OFP nearestBuilding obj Operand types: obj: Object Type of returned value: Object Description: Returns the nearest building to the given object. Type of returned value: Location http://www. Example: neareastBuilding player Category: OFP nearestLocation [position. radius] or [[typeName1.]. radius]: Compatibility: Version 5501 required.html 7/11/2010 . Type of returned value: Array Description: Find entities in the circle with given radius. . type]: Array Compatibility: Version 2.. typeName2. only entities of given type (or its subtype) are listed.arma2.. radius] or [[typeName1.. Category: Location position nearEntities radius or [typeName. If typeName(s) is (are) given. type] Operand types: [position.

<position to sort from>]: Array Compatibility: Version 2. Category: Location nearestObject pos Operand types: pos: Array Type of returned value: Object Description: Returns the nearest object of the given type to the given position or object. [types]. Category: Location nearestLocations [position. distance.BIS Game Engine Scripting Commands Page 241 of 415 Description: Find the nearest location (to the given position) of given type.y. "type"] or [object. If <position to sort from> is provided. "StreetLamp"] Category: OFP http://www. Type of returned value: Location Description: Find the nearest location (to the given position) having it speech non-empty. "type"]. Example: nearestObject [player. Type of returned value: Array Description: Find the nearest locations (from the given position) of certain types.z. Pos may be using format [x.html 7/11/2010 . <position to sort from>] Operand types: [position. [types].com/comref/full.92 required. locations will be ordered by distance from this point.arma2. Category: Location nearestLocationWithDubbing position Operand types: position: Array Compatibility: Version 5501 required. within the specified distance. distance.

Example: obj = position player nearestObject "Building" Category: Resistance position nearestObject id Operand types: position: Array id: Number Compatibility: Version 2. limit].]. ["Car".. ["type".... limit] or [object...01 required.com/comref/full.01 required. ["type".92 required. Example: nearestObjects [player. Pos may be using format [x.z. within the specified distance.arma2.y. 200] Category: OFP http://www. Type of returned value: Object Description: Find object nearest to given position with given type.]. Example: obj = position player nearestObject 1234 Category: Resistance nearestObjects pos Operand types: pos: Array Compatibility: Version 2. Type of returned value: Object Description: Find object nearest to given position with given Visitor id. Type of returned value: Array Description: Returns a list of nearest objects of the given types to the given position or object.BIS Game Engine Scripting Commands Page 242 of 415 position nearestObject type Operand types: position: Array type: String Compatibility: Version 2.html 7/11/2010 ."Tank"].

html 7/11/2010 . radius] Operand types: position: Object or Array radius or [typeName. Example: _list = position player nearObjects 50 Category: OFP position nearObjectsReady radius Operand types: position: Object or Array radius: Number Compatibility: Version 5501 required. Type of returned value: Array Description: Find objects in the circle with given radius. radius]: Compatibility: Version 2. Type of returned value: Array Description: Find the road segments within the circle of given radius. only objects of given type (or its subtype) are listed. Example: _list = player nearRoads 50 http://www.com/comref/full. Type of returned value: Boolean Description: Check whether all data are loaded to nearObjects will return in reasonable time. If typeName is given. Example: _ok = position player nearObjectsReady 50 Category: OFP position or object nearRoads radius Operand types: position or object: Object or Array radius: Number Compatibility: Version 5500 required.arma2.BIS Game Engine Scripting Commands Page 243 of 415 position nearObjects radius or [typeName.92 required.

The output is list of items: [position. Category: Editor nextMenuItemIndex map Operand types: http://www. object] Category: OFP needReload vehicle Operand types: vehicle: Object Compatibility: Version 2. type.arma2. Category: OFP map newOverlay config Operand types: map: Control config: Config Compatibility: Version 2.92 required. Type of returned value: Nothing Description: Creates the new overlay dialog for the specified type of overlay. subj. distance radius around it.92 required. Type of returned value: Number Description: Return how much vehicle wants to reload its weapons.com/comref/full.BIS Game Engine Scripting Commands Page 244 of 415 Category: OFP unit nearTargets radius Operand types: unit: Object radius: Number Type of returned value: Array Description: Check target database of the unit for all targets in max. cost. side.html 7/11/2010 .

Type of returned value: Number Description: Return the time (in seconds) when the next weather change will occur.html 7/11/2010 .arma2.92 required. This value can be used to undefine an existing variable. Type of returned value: Number Description: Returns the total number of user-added menu items belonging to the given menu. Category: OFP nil Type of returned value: Any Description: Nil value.com/comref/full.92 required.92 required.BIS Game Engine Scripting Commands Page 245 of 415 map: Control Compatibility: Version 2. Type of returned value: Number Description: Returns the next available menu item index. Category: Editor nextWeatherChange Compatibility: Version 2. Example: variableToDestroy = nil Category: Default map nMenuItems menu index Operand types: map: Control menu index: Compatibility: Version 2. Category: Editor http://www.

result is false Category: OFP objective objStatus status Operand types: objective: String status: String Type of returned value: http://www.BIS Game Engine Scripting Commands Page 246 of 415 not a Operand types: a: Boolean Type of returned value: Boolean Description: not a Example: not false .5324] Category: OFP objNull Type of returned value: Object Description: A non-existing object. Example: player == objNull . Type of returned value: Array Description: Convert float number to date.arma2. result is true Category: Default NumberToDate [year.com/comref/full.html 7/11/2010 . including itself.time]: Array Compatibility: Version 5501 required.time] Operand types: [year. Example: date = NumberToDate [2008. This value is not equal to anything.0.

Type of returned value: Nothing Description: Defines a sound (voice) that is played the first time when the Group section in the briefing is selected.com/comref/full.75 required. Example: "obj_1" objStatus "FAILED" Category: OFP onBriefingGroup sound Operand types: sound: String Compatibility: Version 1.html 7/11/2010 .BIS Game Engine Scripting Commands Page 247 of 415 Nothing Description: Sets the briefing objective status. Example: onBriefingGroup "GroupVoiceOver" Category: Resistance onBriefingNotes sound Operand types: sound: String Compatibility: Version 1. Type of returned value: Nothing Description: Defines a sound (voice) that is played the first time when the Notes section in the briefing is selected.arma2. Example: onBriefingNotes "NotesVoiceOver" Category: Resistance onBriefingPlan sound Operand types: sound: String http://www. "DONE" or "HIDDEN". "FAILED".75 required. Status may be one of: "ACTIVE".

Example: onBriefingPlan "PlanVoiceOver" Category: Resistance onBriefingTeamSwitch sound Operand types: sound: String Compatibility: Version 2. Type of returned value: Nothing Description: Defines an action performed when commnad mode change.75 required. Type of returned value: Nothing Description: Defines a sound (voice) that is played the first time when the Plan section in the briefing is selected. Command receives _isHighCommand bool Category: OFP map onDoubleClick command Operand types: map: Control http://www.com/comref/full. Type of returned value: Nothing Description: Defines a sound (voice) that is played the first time when the Team switch section in the briefing is selected.92 required.BIS Game Engine Scripting Commands Page 248 of 415 Compatibility: Version 1.html 7/11/2010 .arma2. Example: onBriefingTeamSwitch "TeamSwitchVoiceOver" Category: Resistance onCommandModeChanged command Operand types: command: Compatibility: Version 5501 required.

com/comref/full. Type of returned value: Any Description: Defines an action performed when the user double clicks on the map. Type of returned value: Nothing Description: Defines an action performed when palyer clicked on group marker (3D or in a map) Category: OFP onGroupIconOverEnter command Operand types: command: Compatibility: Version 5501 required. Type of returned value: Nothing Description: Defines an action performed when palyer clicked on group marker (3D or in a map) Category: OFP onGroupIconOverLeave command Operand types: command: Compatibility: Version 5501 required.BIS Game Engine Scripting Commands Page 249 of 415 command: String Compatibility: Version 2.arma2. Type of returned value: Nothing http://www. Command receives: _pos array position _units array selected units _shift.html 7/11/2010 .92 required._alt bool key state Category: Editor onGroupIconClick command Operand types: command: Compatibility: Version 5501 required.

group player]" Category: Resistance parameters onMapSingleClick command Operand types: parameters: Any command: Compatibility: http://www. Command receives: _pos array position _units array selected units _shift.BIS Game Engine Scripting Commands Page 250 of 415 Description: Defines an action performed when palyer clicked on group marker (3D or in a map) Category: OFP onHCGroupSelectionChanged command Operand types: command: Compatibility: Version 5501 required.91 required.com/comref/full. Type of returned value: Nothing Description: Defines an action performed when HC group has been selected. command should return true. Type of returned value: Nothing Description: Defines an action performed when the user clicks on the map. Example: onMapSingleClick """SoldierEG"" createUnit [_pos.html 7/11/2010 .arma2. Command receives _group group selected group _isSelected bool new selection state Category: OFP onMapSingleClick command Operand types: command: Compatibility: Version 1._alt bool key state If the click is processed.

html 7/11/2010 . Variables _id and _name are set.com/comref/full.BIS Game Engine Scripting Commands Page 251 of 415 Version 5500 required.10 required. Example: "SoldierEG" onMapSingleClick "_this createUnit [_pos. Variables _id and _name are set. Category: Resistance onPlayerDisconnected statement Operand types: statement: Compatibility: Version 2.arma2.10 required._alt bool key state _this any parameters passed to this function If the click is processed. Type of returned value: Nothing Description: This statement is launched whenever a player is connected to a MP session. command should return true. Type of returned value: Nothing Description: This statement is launched whenever a player is disconnected from a MP session. Command receives: _pos array position _units array selected units _shift. Type of returned value: Nothing Description: Defines an action performed when the user clicks on the map. Category: Resistance onPreloadFinished command http://www. group player]" Category: OFP onPlayerConnected statement Operand types: statement: Compatibility: Version 2.

92 required. Category: OFP map onShowNewObject command Operand types: map: Control command: String Compatibility: Version 2.html 7/11/2010 .com/comref/full. Set to empty for default behavior. Command receives: _pos array position Category: Editor onTeamSwitch command Operand types: command: Compatibility: Version 5500 required. Type of returned value: http://www. Type of returned value: Nothing Description: Defines an action performed after the preload screen finished.arma2. Type of returned value: Any Description: Defines an action performed when the user right clicks on the map and selects New Object.BIS Game Engine Scripting Commands Page 252 of 415 Operand types: command: Compatibility: Version 5501 required. Category: OFP onPreloadStarted command Operand types: command: Compatibility: Version 5501 required. Type of returned value: Nothing Description: Defines an action performed just before the preload screen started.

92 required. Example: [unitOne. Command receives: _from object previous unit _to object current units Category: OFP a or b Operand types: a: Boolean b: Boolean Type of returned value: Boolean Description: a or b Example: not alive player or not alive leader player Category: Default unitArray orderGetIn order Operand types: unitArray: Array order: Boolean Type of returned value: Nothing Description: Forces all units in the list to get in their assigned vehicle. Type of returned value: Number Description: http://www.com/comref/full.BIS Game Engine Scripting Commands Page 253 of 415 Nothing Description: Defines an action performed when the team switch is finished. unitTwo] orderGetIn true Category: OFP overcast Compatibility: Version 2.html 7/11/2010 .arma2.

Category: OFP parseNumber string Operand types: string: String Compatibility: Version 2. Type of returned value: Number Description: Parse string containing real number.arma2. Category: OFP owner object Operand types: object: Object Compatibility: Version 5501 required.com/comref/full.BIS Game Engine Scripting Commands Page 254 of 415 Return the current overcast. Type of returned value: Number Description: Return the overcast forecast.html 7/11/2010 .92 required. return the ID of the client where the object is local.125" Category: Default parseText text http://www. Type of returned value: Number Description: On server machine. Example: parseNumber "0.92 required. Category: OFP overcastForecast Compatibility: Version 2. Otherwise return 0.

Category: OFP pi Type of returned value: Number Description: pi (180 degrees converted to radians) Example: pi .html 7/11/2010 .BIS Game Engine Scripting Commands Page 255 of 415 Operand types: text: String Compatibility: Version 2.75 required.com/comref/full. result is 3.1415 Category: Default pickWeaponPool obj Operand types: obj: Object Compatibility: Version 1. http://www.01 required.img image=data\isniper. Type of returned value: Nothing Description: Transfers weapons and magazines from the cargo space of object obj to the weapon pool (used in campaigns to transfer weapons to the next mission).&ltbr/&gt.Second line" Category: OFP parsingNamespace Compatibility: Version 5501 required. Type of returned value: Structured text Description: Creates a structured text by parsing the given XML description. Example: txt = parseText "First line&lt.arma2. Type of returned value: Namespace Description: Return the global namespace attached to config parser.paa/&gt.

Type of returned value: Nothing Description: When used on a person.arma2. Example: soldierOne playAction "SitDown" Category: OFP soldier playActionNow action Operand types: soldier: Object action: String Compatibility: Version 5501 required. Category: OFP soldier playAction action Operand types: soldier: Object action: String Compatibility: Version 5500 required.com/comref/full. Type of returned value: Array Description: Return a list of playable units (occupied by both AI or players). a smooth transition to the given action will be initiated.html 7/11/2010 . a smooth transition to the given action will be initiated. Example: soldierOne playActionNow "SitDown" Category: OFP http://www.BIS Game Engine Scripting Commands Page 256 of 415 Category: Resistance playableUnits Compatibility: Version 5501 required. Type of returned value: Nothing Description: When used on a person. but all previous playAction are discarded.

80 required. Type of returned value: Number Description: Returns the number of players playing on the given side. Category: OFP playerSide Compatibility: Version 2. Example: alive player Category: OFP playerRespawnTime Compatibility: Version 2.BIS Game Engine Scripting Commands Page 257 of 415 player Type of returned value: Object Description: This is the person controlled by the player.html 7/11/2010 . http://www. Type of returned value: Number Description: Return the player remaining time to respawn.09 required. Type of returned value: Side Description: Returns the player's side.92 required. In MP this value is different on each computer. This is valid even when the player controlled person is dead (a difference from player side). Category: OFP playersNumber side Operand types: side: Side Compatibility: Version 1.arma2.com/comref/full.

mission. skipBriefing] Operand types: [campaign.arma2. skipBriefing]: Array Compatibility: Version 2. a single mission is launched. If skipBriefing is true. mission] or [campaign. mission] or [campaign. a smooth transition to the given move will be initiated. Type of returned value: Nothing Description: When used on a person. If the campaign is empty.com/comref/full.html 7/11/2010 . Both campaign and mission are given as their directory name. a smooth transition to the given move will be initiated. Example: playMission["XOutrage".BIS Game Engine Scripting Commands Page 258 of 415 Category: OFP soldier playGesture moveName Operand types: soldier: Object moveName: String Compatibility: Version 5500 required. Example: soldierOne playGesture "Wave" Category: OFP playMission [campaign."x05Negotiator. mission. Example: http://www.Noe"] Category: OFP soldier playMove moveName Operand types: soldier: Object moveName: String Type of returned value: Nothing Description: When used on a person.19 required. Type of returned value: Nothing Description: The mission is launched (from the main menu). the intro and briefing are skipped.

ext file. Position is in seconds. Example: playMusic ["Track13".ext file. Example: playMusic "musicname" http://www. but all previous playAction are discarded.html 7/11/2010 .arma2.BIS Game Engine Scripting Commands Page 259 of 415 soldierOne playMove "Stand" Category: OFP soldier playMoveNow moveName Operand types: soldier: Object moveName: String Compatibility: Version 5501 required. Example: soldierOne playMoveNow "Stand" Category: OFP playMusic nameAndPos Operand types: nameAndPos: Array Type of returned value: Nothing Description: Plays music defined in the description. Type of returned value: Nothing Description: When used on a person. a smooth transition to the given move will be initiated.com/comref/full.position]. 30] Category: OFP playMusic name Operand types: name: String Type of returned value: Nothing Description: Plays music defined in the description. The format of nameAndPos is [name.

BIS Game Engine Scripting Commands Page 260 of 415 Category: OFP playScriptedMission [world. expression.50 required.arma2. Config (optional) can reference to the config entry replacing description.ext file. Type of returned value: Array Description: Returns the object position in format Position. config] Operand types: [world. Example: position player Category: OFP http://www.ext for this mission. expression. Example: playSound "soundname" Category: OFP position object Operand types: object: Object Compatibility: Version 1.com/comref/full.html 7/11/2010 . Type of returned value: Nothing Description: Load the given world. Category: OFP playSound name Operand types: name: String Type of returned value: Nothing Description: Plays a sound defined in the description. launch an empty mission and execute the given expression. config]: Array Compatibility: Version 5500 required.

90 required. Type of returned value: Array Description: Return (raw) position of given location. y]: Array Compatibility: Version 2.arma2. Type of returned value: Array Description: Convert screen coordinates in map to world coordinates.54 required. Type of returned value: Array Description: Transform position from camera coordinate space to world coordinate space.html 7/11/2010 .com/comref/full. y] Operand types: map: Control [x.52 required. Example: _worldPos = positionCameraToWorld _cameraPos Category: OFP PC map posScreenToWorld [x.BIS Game Engine Scripting Commands Page 261 of 415 position location Operand types: location: Location Compatibility: Version 2. Category: OFP PC map posWorldToScreen position Operand types: map: Control position: Array http://www. Category: Location positionCameraToWorld position Operand types: position: Array Compatibility: Version 2.

Type of returned value: Array Description: Convert world coordinates to screen coordinates in map.92 required.54 required. 0. Category: OFP PC number ppEffectAdjust array Operand types: number: Number array: Array Compatibility: Version 2.html 7/11/2010 .arma2.92 required.BIS Game Engine Scripting Commands Page 262 of 415 Compatibility: Version 2.1] Category: Visual string ppEffectAdjust array Operand types: string: String array: Array Compatibility: Version 2. 0.1. Type of returned value: Nothing Description: Set post process effect parameters Example: hndl ppEffectAdjust [0. Type of returned value: Nothing Description: Adjust parameters for specified post process effect Example: "radialBlurr" ppEffectEnable [] Category: Visual array ppEffectCommit scalar Operand types: array: Array scalar: Number http://www.com/comref/full.0075.0075. 0.

. if 0 set immediately Example: hndl ppEffectCommit 0 Category: Visual number ppEffectCommit number Operand types: number: Number number: Number Compatibility: Version 2..com/comref/full.arma2.92 required. Type of returned value: Nothing Description: Set time when old pars are replaced by last set. Type of returned value: Nothing Description: Set time when old pars are replaced by last set. if 0 set immediately Example: .92 required. Category: Visual ppEffectCommitted effect http://www.BIS Game Engine Scripting Commands Page 263 of 415 Compatibility: Version 2.html 7/11/2010 . if 0 set immediately Example: hndl ppEffectCommit 0 Category: Visual string ppEffectCommit number Operand types: string: String number: Number Compatibility: Version 2. Type of returned value: Nothing Description: Set time when old pars are replaced by last set.92 required.

html 7/11/2010 . Type of returned value: Number Description: Create post process effect specified by name and priority http://www. Type of returned value: Boolean Description: Check whether given post process effect is commited Category: Visual ppEffectCreate effect Operand types: effect: Array Compatibility: Version 5501 required.arma2. Type of returned value: Boolean Description: Check whether given post process effect is commited Category: Visual ppEffectCommitted effect Operand types: effect: String Compatibility: Version 5501 required. Type of returned value: Array Description: Create post process effect specified by name and priority Category: Visual ppEffectCreate effect Operand types: effect: Array Compatibility: Version 5501 required.com/comref/full.BIS Game Engine Scripting Commands Page 264 of 415 Operand types: effect: Number Compatibility: Version 5501 required.

Type of returned value: Nothing Description: Enable / disable post process effect Example: hndl ppEffectEnable true Category: Visual string ppEffectEnable bool http://www.arma2.BIS Game Engine Scripting Commands Page 265 of 415 Category: Visual ppEffectDestroy effect Operand types: effect: Array Compatibility: Version 5501 required.com/comref/full. Type of returned value: Nothing Description: Destroy post process effect given by handle Category: Visual number ppEffectEnable bool Operand types: number: Number bool: Boolean Compatibility: Version 2. Type of returned value: Nothing Description: Create post process effect specified by name and priority Category: Visual ppEffectDestroy effect Operand types: effect: Number Compatibility: Version 5501 required.html 7/11/2010 .92 required.

is overloaded form multiple effects. ["chromAberration". ["chromAberration".html 7/11/2010 . Example: "radialBlurr" ppEffectEnable true. Type of returned value: Number Description: Return the precision of the given entity.arma2. Type of returned value: Nothing Description: Enable/disable specified post process effect.92 required. "radialBlurr"] ppEffectEnable true Category: Visual precision entity Operand types: entity: Object Compatibility: Version 2. Type of returned value: Nothing Description: Enable/disable specified post process effect. Example: "radialBlurr" ppEffectEnable true. "radialBlurr"] ppEffectEnable true Category: Visual array ppEffectEnable bool Operand types: array: Array bool: Boolean Compatibility: Version 2.com/comref/full.BIS Game Engine Scripting Commands Page 266 of 415 Operand types: string: String bool: Boolean Compatibility: Version 2.92 required.92 required. is overloaded form multiple effects. Category: OFP preloadCamera position Operand types: http://www.

50 required. Preload data The object can be defined in the description. Type of returned value: Boolean Description: Make sure sound can start playing without any delay once we need it.50 required.com/comref/full."type". Speed is ignored. Category: OFP preloadTitleObj effect Operand types: effect: Array Type of returned value: Boolean Description: Object title . Category: OFP preloadSound sound Operand types: sound: String Compatibility: Version 2.arma2.argument uses format ["text".speed] or ["name". Type of returned value: Boolean Description: Preload all textures and models around given position Category: OFP distance preloadObject object Operand types: distance: Number object: Object or String Compatibility: Version 2. Type of returned value: Boolean Description: Preload all data for given object. Example: http://www.50 required.html 7/11/2010 ."type"].BIS Game Engine Scripting Commands Page 267 of 415 position: Array Compatibility: Version 2.ext file.

Preload data The resource can be defined in the description. http://www."type"]. result is "if a>b then {a} else {b}" Category: OFP preprocessFileLineNumbers filename Operand types: filename: String Compatibility: Version 2.arma2.ext file. "PLAIN"] Category: OFP preprocessFile filename Operand types: filename: String Compatibility: Version 1. The preprocessor is C-like. Type of returned value: String Description: Returns the preprocessed content of the given file."plain"] Category: OFP preloadTitleRsc effect Operand types: effect: Array Type of returned value: Boolean Description: Resource title .sqf" .com/comref/full. it supports comments using // or /* and */ and macros defined with #define.argument uses format ["name".speed] or ["name".58 required.html 7/11/2010 . The preprocessor is C-like. Speed is ignored. Example: preprocessFile "myFunction. Example: titleRsc ["BIS". Type of returned value: String Description: Returns the preprocessed content of the given file. it supports comments using // or /* and */ and macros defined with #define.82 required."type".BIS Game Engine Scripting Commands Page 268 of 415 titleObj ["BISLogo".

Type of returned value: String Description: Returns the name of the vehicle's primary weapon (an empty string if there is none). Category: Default http://www.html 7/11/2010 . result is "if a>b then {a} else {b}" Category: OFP primaryWeapon vehicle Operand types: vehicle: Object Compatibility: Version 1.BIS Game Engine Scripting Commands Page 269 of 415 Example: preprocessFileLineNumbers "myFunction.85 required.com/comref/full. Type of returned value: Number Description: Return the priority of the task.75 required. Type of returned value: Nothing Description: Introduces one or more local variables in the innermost scope.91 required. Example: primaryWeapon player Category: Resistance priority task Operand types: task: Task Compatibility: Version 2.arma2.sqf" . Category: Identity private variable Operand types: variable: String or Array Compatibility: Version 1.

html 7/11/2010 .BIS Game Engine Scripting Commands Page 270 of 415 processDiaryLink link Operand types: link: String Compatibility: Version 5500 required. set progress bar to the given value (from interval [0. Type of returned value: Nothing Description: Process commands stored using setVehicleInit. Type of returned value: Nothing Description: Open the diary screen on the record specified by link. Category: Identity processInitCommands Compatibility: Version 2.com/comref/full. http://www. Type of returned value: Nothing Description: If loading screen is show.33 required.arma2. Type of returned value: Number Description: Returns the current position in the progress bar. 1]) Category: OFP progressPosition control Operand types: control: Control Compatibility: Version 5500 required. Category: OFP progressLoadingScreen progress Operand types: progress: Number Compatibility: Version 5501 required.

arma2.BIS Game Engine Scripting Commands Page 271 of 415 Example: _pos = progressPosition _control Category: OFP PC control progressSetPosition pos Operand types: control: Control pos: Number Compatibility: Version 2. Type of returned value: Nothing Description: Sets the current position in the progress bar.33 and before.html 7/11/2010 .34: Number.92 required. Boolean. Type of returned value: Nothing Description: Transfers weapons and magazines from the weapon pool (used in campaigns to transfer weapons to the next mission) into the cargo space of object obj. http://www. Only type Number is supported in versions 1. Object and Group. Example: publicVariable "CTFscoreOne" Category: OFP putWeaponPool obj Operand types: obj: Object Compatibility: Version 1.75 required. Example: _control sliderSetPosition 0 Category: OFP PC publicVariable varName Operand types: varName: String Type of returned value: Nothing Description: Broadcasts the variable value to all computers.com/comref/full. The following types are supported since 1.

75 required. result is 3. Example: rad 180 .75 required.com/comref/full. Type of returned value: Number Description: Returns the number of weapons of type name in the weapon pool (used in campaigns to transfer weapons to the next mission). Category: Resistance queryWeaponPool name Operand types: name: String Compatibility: Version 1.arma2.html 7/11/2010 .BIS Game Engine Scripting Commands Page 272 of 415 Category: Resistance queryMagazinePool name Operand types: name: String Compatibility: Version 1. Type of returned value: Number Description: Returns the number of magazines of type name in the weapon pool (used in campaigns to transfer weapons to the next mission).1415 Category: Default radioVolume http://www. Category: Resistance rad x Operand types: x: Number Type of returned value: Number Description: Converts x from degrees to radians.

arma2. Type of returned value: Number Description: Return the current rain. Type of returned value: String Description: Return the rank of the given unit.92 required. Category: OFP rankId unit http://www.BIS Game Engine Scripting Commands Page 273 of 415 Type of returned value: Number Description: Checks the current radio volume (set by setRadioVolume).com/comref/full. (0<=random<1) Example: random 1 Category: Default rank unit Operand types: unit: Object Compatibility: Version 2. Category: OFP random x Operand types: x: Number Type of returned value: Number Description: The random real value from 0 to x. Category: OFP rain Compatibility: Version 2.html 7/11/2010 .92 required.

Type of returned value: Number Description: Return the rank of the given unit for comparison.91 required.html 7/11/2010 . Type of returned value: Boolean Description: Check if given location has rectangular shape.com/comref/full. Type of returned value: Array Description: http://www. Category: OFP rating unit Operand types: unit: Object Type of returned value: Number Description: Checks the unit rating.BIS Game Engine Scripting Commands Page 274 of 415 Operand types: unit: Object Compatibility: Version 5500 required. decreased for killing friendlies and can be changed by a mission designer.90 required. Example: rating player Category: OFP rectangular location Operand types: location: Location Compatibility: Version 2. This rating is increased for killing enemies. Category: Location registeredTasks teamMember Operand types: teamMember: Compatibility: Version 2.arma2.

92 required. Parameters are defined in the given config class (subclass of CfgTasks). Category: OFP reloadEnabled vehicle Operand types: vehicle: Object Compatibility: Version 2.BIS Game Engine Scripting Commands Page 275 of 415 List all registered task types. Type of returned value: Nothing Description: Reload all weapons.90 required. Category: Identity teamMember registerTask entry name Operand types: teamMember: entry name: String Compatibility: Version 2. Category: Identity reload vehicle Operand types: vehicle: Object Compatibility: Version 2.arma2. Type of returned value: Boolean Description: Check whether magazine is reloaded whenever emptied.92 required.html 7/11/2010 .com/comref/full. Type of returned value: Boolean Description: Register a new task type. Category: OFP who remoteControl whom http://www.

Type of returned value: Nothing Description: Switch on remote control of the unit. Example: player removeAction 0 Category: OFP object removeAllEventHandlers handlerType Operand types: object: Object handlerType: String Compatibility: Version 1.BIS Game Engine Scripting Commands Page 276 of 415 Operand types: who: Object whom: Object Compatibility: Version 5501 required.85 required.com/comref/full. Type of returned value: Nothing Description: Removes the action with the given id.arma2. Example: player removeAllEventHandlers "killed" Category: OFP http://www.11 required. Example: player remoteControl gunner _uav Category: OFP unit removeAction index Operand types: unit: Object index: Number Compatibility: Version 1. Type of returned value: Nothing Description: Removes all event handlers of the given type which were added by addEventHandler.html 7/11/2010 .

string identifier] Operand types: map: Control [object. Example: removeAllItems player Category: OFP removeAllWeapons unit Operand types: unit: Object Type of returned value: Nothing Description: Removes all weapons from the unit. Type of returned value: Nothing Description: Removes an icon for an editor object.html 7/11/2010 .BIS Game Engine Scripting Commands Page 277 of 415 removeAllItems unit Operand types: unit: Object Compatibility: Version 5501 required.com/comref/full. string identifier]: Array Compatibility: Version 2. Example: removeAllWeapons player Category: OFP map removeDrawIcon [object.arma2. Category: Editor map removeDrawLinks [from. param type] Operand types: map: Control http://www.92 required. Type of returned value: Nothing Description: Removes all special items from the unit.

Format of handler is [type.BIS Game Engine Scripting Commands Page 278 of 415 [from.arma2.index]. Category: Editor object removeEventHandler handler Operand types: object: Object handler: Array Compatibility: Version 1.com/comref/full. Type of returned value: Nothing Description: Removes event handler added by addEventHandler.85 required.92 required.html 7/11/2010 . When any handler is removed. param type]: Array Compatibility: Version 2. Example: group removeGroupIcon id Category: OFP unit removeMagazine weaponName http://www. Pass an empty string as param type to remove all draw links for an object. Example: player removeEventHandler ["killed". Type of returned value: Nothing Description: Remove icon with given ID from group. all handler indices higher that the deleted one should be decremented.0] Category: OFP group removeGroupIcon icon ID Operand types: group: Group icon ID: Number Compatibility: Version 5501 required. Index is returned by addEventHandler. Type of returned value: Nothing Description: Remove all drawn links for the given editor object for the given editor object type.

application behaviour is undefined.92 required.BIS Game Engine Scripting Commands Page 279 of 415 Operand types: unit: Object weaponName: String or Array Type of returned value: Nothing Description: Removes the magazine from the unit. Category: Editor map removeMenuItem text of menu item to delete Operand types: map: Control http://www. When doing so. Note: you may create invalid combinations by using this function. Note: you may create invalid combinations by using this function. Example: player removeMagazine "M16" Category: OFP unit removeMagazines weaponName Operand types: unit: Object weaponName: String Type of returned value: Nothing Description: Removes all magazines of the given type from the unit.arma2.html 7/11/2010 . Example: player removeMagazines "M16" Category: OFP map removeMenuItem index of menu item to delete Operand types: map: Control index of menu item to delete: Number Compatibility: Version 2.com/comref/full. application behaviour is undefined. Type of returned value: Nothing Description: Removes a previously added menu item. When doing so.

application behaviour is undefined.BIS Game Engine Scripting Commands Page 280 of 415 text of menu item to delete: String Compatibility: Version 2.92 required.com/comref/full. Note: you may create invalid combinations by using this function. Type of returned value: Nothing Description: Removes a previously added menu item. Category: Editor person removeSimpleTask task Operand types: person: Object task: Task Compatibility: Version 5501 required. Type of returned value: Nothing Description: Remove a simple task from the list of simple tasks.html 7/11/2010 . When doing so. Category: OFP unit removeWeapon weaponName Operand types: unit: Object weaponName: String Type of returned value: Nothing Description: Removes the weapon from the unit. Category: Identity removeSwitchableUnit person Operand types: person: Object Compatibility: Version 2. http://www.arma2.92 required. Type of returned value: Nothing Description: Remove a unit from the list of units available for team switch.

arma2.75 required.html 7/11/2010 . "1. Example: requiredVersion "1. Example: array resize 2 Category: Default http://www. e. Type of returned value: Nothing Description: Changes the array size. Category: OFP array resize count Operand types: array: Array count: Number Compatibility: Version 1.Minor". a warning message is shown and false is returned.BIS Game Engine Scripting Commands Page 281 of 415 Example: player removeWeapon "M16" Category: OFP requiredVersion version Operand types: version: String Compatibility: Version 1. The version format is "Major.g.30" Category: OFP resistance Type of returned value: Side Description: The Resistance side.com/comref/full. Type of returned value: Boolean Description: Checks whether the appropriate version of the application is available. If it's not. This function can be used to add or remove elements from the array.30".21 required.

Example: soldierOne reveal soldierTwo Category: OFP reversedMouseY http://www.BIS Game Engine Scripting Commands Page 282 of 415 vehicle respawnVehicle [delay = -1.92 required.52 required. count = 0]: Array Compatibility: Version 2.0.ext is used. It does not matter whether the group can know about the unit or not.arma2. default respawnDelay from description. 3] Category: OFP restartEditorCamera map Operand types: map: Control Compatibility: Version 2. Count tells how many respawns is processed (default unlimited).com/comref/full. count = 0] Operand types: vehicle: Object [delay = -1. Example: car respawnVehicle [5. Type of returned value: Nothing Description: Restarts the mission editor camera (if it was deleted by a script. Type of returned value: Nothing Description: Set vehicle as respawnable in MP games.html 7/11/2010 . for example). Category: Editor group reveal unit Operand types: group: Object or Group unit: Object Type of returned value: Nothing Description: Reveals the unit to the group. Delay is respawn delay.

com/comref/full. Type of returned value: Array Description: Find the road segments connected to the given road segment. Example: round -5. Category: OFP round x Operand types: x: Number Type of returned value: Number Description: The round value of x. Category: OFP roadsConnectedTo road segment Operand types: road segment: Object Compatibility: Version 5500 required.25 .BIS Game Engine Scripting Commands Page 283 of 415 Compatibility: Version 5501 required. Type of returned value: Boolean Description: Return if mouse vertical axe is inverted. Category: OFP http://www.arma2.33 required.html 7/11/2010 . Type of returned value: Nothing Description: Launch init. result is -5 Category: Default runInitScript Compatibility: Version 2.sqs script.

com/comref/full.arma2. Type of returned value: Number Category: OFP SafeZoneX Compatibility: Version 5501 required. Type of returned value: Number Category: OFP saveGame Type of returned value: Nothing Description: Creates an autosave game (used for Retry). http://www. Type of returned value: Number Category: OFP SafeZoneY Compatibility: Version 5501 required.html 7/11/2010 . Type of returned value: Number Category: OFP SafeZoneW Compatibility: Version 5501 required.BIS Game Engine Scripting Commands Page 284 of 415 SafeZoneH Compatibility: Version 5501 required.

http://www.html 7/11/2010 . Type of returned value: Boolean Description: Saves person's identity to objects.BIS Game Engine Scripting Commands Page 285 of 415 Category: OFP person saveIdentity name Operand types: person: Object name: String Compatibility: Version 1.com/comref/full.sav file in campaign directory as entry name.92 required. Type of returned value: Nothing Description: Save the current overlay.sav file in campaign directory as entry name. Example: saveOverlay _map Category: Editor object saveStatus name Operand types: object: Object name: String Compatibility: Version 1.75 required.75 required.arma2. Type of returned value: Boolean Description: Saves object's properties to objects. Example: player saveIdentity "playerIdentity" Category: Resistance saveOverlay map Operand types: map: Control Compatibility: Version 2.

The unit will play the given sound. the title is not shown.BIS Game Engine Scripting Commands Page 286 of 415 Example: player saveStatus "playerState" Category: Resistance saveVar varName Operand types: varName: String Type of returned value: Nothing Description: Saves the variable value into the global campaign space. If the camera is not withing the given range. target]: Object or Array speechName: Array Compatibility: Version 1. The sound is defined in the description. maxTitlesDistance] or [sound. target] say speechName Operand types: unit or [unit. titles will be written to the conversation history. speed]. Category: OFP unit or [unit. maxTitlesDistance. If the unit is a person. Type of returned value: Boolean Description: Check if saving the game is enabled.75 required.ext file. Type of returned value: Nothing Description: The format of speechName is [sound. Example: saveVar "varOne" Category: OFP savingEnabled Compatibility: Version 5501 required. Category: OFP http://www. it will also pefrorm the corresponding lipsync effect.html 7/11/2010 .arma2. If target is given.com/comref/full. The variable is then available to all following missions in the campaign.

Category: OFP http://www. The sound is defined in the description. If target is given.com/comref/full. Type of returned value: Nothing Description: Functionally same as Say. target]: Object or Array speechName: String Type of returned value: Nothing Description: The unit will play the given sound.html 7/11/2010 .arma2.BIS Game Engine Scripting Commands Page 287 of 415 unit or [unit. target] say speechName Operand types: unit or [unit.ext file. it will also pefrorm the corresponding lipsync effect. target]: Object or Array speechName: String Compatibility: Version 5501 required. target] say2D speechName Operand types: unit or [unit. Type of returned value: Nothing Description: Functionally same as Say. Example: soldierOne say "speechId" Category: OFP unit or [unit. titles will be written to the conversation history. only difference is sound played as 2D (mono) allways. target] say2D speechName Operand types: unit or [unit. target]: Object or Array speechName: Array Compatibility: Version 5501 required. Example: soldierOne say "speechId" Category: OFP unit or [unit. only difference is sound played as 2D (mono) allways. If the unit is a person.

and name is also used as reference in some commands. Type of returned value: Nothing Description: Functionally same as Say. target]: Object or Array speechName: Array Compatibility: Version 5501 required. only difference is sound played as 3D allways. Scope name can be defined only once per scope. Category: OFP unit or [unit.com/comref/full. target]: Object or Array speechName: String Compatibility: Version 5501 required. Type of returned value: Nothing Description: Functionally same as Say. Name is visible in debugger. target] say3D speechName Operand types: unit or [unit.html 7/11/2010 . only difference is sound played as 3D allways. Category: Default score unit Operand types: unit: Object Type of returned value: http://www.arma2. target] say3D speechName Operand types: unit or [unit. Example: soldierOne say "speechId" Category: OFP scopeName name Operand types: name: String Type of returned value: Nothing Description: defines name of current scope.BIS Game Engine Scripting Commands Page 288 of 415 unit or [unit.

Type of returned value: Array Description: Returns the position on landscape (in world coordinates) corresponding to the given point on screen (in UI coordinates).com/comref/full. Example: score unitOne Category: OFP screenToWorld position Operand types: position: Array Compatibility: Version 5501 required. Example: http://www.50 required.html 7/11/2010 . Type of returned value: Nothing Description: Assign a friendly name to the VM script thjis command is executed from.arma2. Category: OFP scriptDone script Operand types: script: Script Compatibility: Version 2.BIS Game Engine Scripting Commands Page 289 of 415 Number Description: MP: returns the unit's score. Type of returned value: Boolean Description: Check if script is already finished Category: OFP scriptName name Operand types: name: String Compatibility: Version 5501 required.

Type of returned value: Number Description: Returns the current state of the given scud launcher.Launch prepared. Note: nonintegral values are used to indicate a transition between states.com/comref/full.arma2. http://www. If it is true.28 required.Launched. The following states are recognized: 0 .Ignition and 4 . it selects the second one.BIS Game Engine Scripting Commands Page 290 of 415 scriptName "Trading" Category: Default scudState scud Operand types: scud: Object Compatibility: Version 1.html 7/11/2010 . Example: scudState scudOne>=4 Category: OFP secondaryWeapon vehicle Operand types: vehicle: Object Compatibility: Version 1. 2 .Launch preparation. Example: secondaryWeapon player Category: Resistance array select index Operand types: array: Array index: Boolean Type of returned value: Any Description: If the index is false.No activity.75 required. Type of returned value: String Description: Returns the name of a vehicle's secondary weapon (an empty string if there is none). 1 . this selects the first element of the array. 3 .

arma2. _sourcesCount] Operand types: [_position. etc.35 required. 3] select 1 . Index 0 denotes the first element. 1 the second. 2. _expression. _radius. _radius. Type of returned value: Config Description: Returns subentry with given index. value of _expression in the given area. _sourcesCount]: Array Compatibility: Version 5500 required. _expression.com/comref/full. _precision.BIS Game Engine Scripting Commands Page 291 of 415 Category: Default config select index Operand types: config: Config index: Number Compatibility: Version 2. Category: OFP http://www. Type of returned value: Array Description: Find the places with the max. Example: (configFile >> "CfgVehicles") select 0 Category: OFP PC array select index Operand types: array: Array index: Number Type of returned value: Any Description: Selects index element of the array. Example: [1. _precision. result is 2 Category: Default selectBestPlaces [_position.html 7/11/2010 .

92 required. Does not un-select previously selected objects.html 7/11/2010 .BIS Game Engine Scripting Commands Page 292 of 415 person selectDiarySubject subject Operand types: person: Object subject: String Compatibility: Version 5500 required. Type of returned value: Any Description: Select an editor object. Category: Editor object selectionPosition selection name Operand types: object: Object selection name: String Compatibility: Version 2. http://www.92 required. Category: Editor map selectEditorObject object Operand types: map: Control object: String Compatibility: Version 2.arma2. Type of returned value: Nothing Description: Returns a list of currently selected editor objects.92 required. Category: Identity selectedEditorObjects map Operand types: map: Control Compatibility: Version 2.com/comref/full. Type of returned value: Nothing Description: Select the subject page in a log.

html 7/11/2010 . Example: group player selectLeader player Category: OFP selectNoPlayer Compatibility: Version 5501 required. Category: OFP group selectLeader unit Operand types: group: Group unit: Object Compatibility: Version 2.33 required. Type of returned value: Nothing Description: Select group leader. Example: http://www.com/comref/full. Type of returned value: Nothing Description: Switch player to given unit.33 required.BIS Game Engine Scripting Commands Page 293 of 415 Type of returned value: Array Description: Search for selection in the object model (first in the memory level. then in other levels). Type of returned value: Nothing Description: Switch player to no unit.arma2. Category: OFP selectPlayer unit Operand types: unit: Object Compatibility: Version 2. Returns position in model space.

priority. name1. parentTask]..27 required. [type] or [type. parentTask].arma2.26 required. name1. name2. Type of returned value: Nothing Description: Sends a simple command to the vehicle's driver / gunner. Example: soldierOne selectWeapon "LAWLauncher" Category: OFP object sendSimpleCommand command Operand types: object: Object command: String Compatibility: Version 2. . [type] or [type.html 7/11/2010 . . name2. value2.] Operand types: sender: [receiver. value1. value2. priority... Type of returned value: Task http://www. For weapon values see CfgWeapons.]: Array Compatibility: Version 2.com/comref/full.92 required. Type of returned value: Nothing Description: Selects the given weapon.. Example: vehicle player sendSimpleCommand "STOP" Category: OFP sender sendTask [receiver. value1.BIS Game Engine Scripting Commands Page 294 of 415 selectPlayer aP Category: OFP unit selectWeapon weapon Operand types: unit: Object weapon: String Compatibility: Version 1.

result. Type of returned value: Nothing Description: Send a result of the task to the task sender. Example: array set [0. Changes an element of the given array.com/comref/full. If the element does not exist. index+1 is called to create it. Type of returned value: Nothing Description: Format of element is [index.BIS Game Engine Scripting Commands Page 295 of 415 Description: Create a new AI task (subtask of parentTask). value]. result. Type of returned value: Number Description: Server time synchronized to clients.92 required. "Hello"] Category: Default http://www. sentence] Operand types: task: Task [state. Category: Identity task sendTaskResult [state. sentence]: Array Compatibility: Version 2. Type is name of registered task type.75 required.html 7/11/2010 . Category: OFP array set element Operand types: array: Array element: Array Compatibility: Version 1. Category: Identity serverTime Compatibility: Version 5501 required.arma2.

92 required.com/comref/full. Example: setAccTime 0.BIS Game Engine Scripting Commands Page 296 of 415 setAccTime accFactor Operand types: accFactor: Number Type of returned value: Nothing Description: Sets the time acceleration coeficient. Type of returned value: Nothing Description: Set owner of the airport Example: 0 setAirportSide east Category: OFP vehicle setAmmoCargo ammoCargo Operand types: vehicle: Object ammoCargo: Number Type of returned value: Nothing Description: Sets the amount of ammo resources in the cargo space of a repair vehicle.html 7/11/2010 .1 Category: OFP airportId setAirportSide side Operand types: airportId: Number side: Side Compatibility: Version 2.arma2. soldiers use individual magazines instead. It can also be used to slow down time in cutscenes. Ammo resources are used to resupply vehicles. An amount of one indicates a full cargo. Example: rearmTruckOne setAmmoCargo 0 Category: OFP http://www.

Category: OFP setArmoryPoints points Operand types: points: Number Compatibility: Version 5500 required. name2. value1. Type of returned value: Structured text Description: Returns a structured text created by the given structured or plain text by setting attributes to the given values.. name2. "data\iSoldier.]: Array Compatibility: Version 2.] Operand types: text: Text or String [name1.. Type of returned value: Nothing Description: Sets custom camera apreture (-1 to do it automatically). value1.01 required. Type of returned value: Nothing Description: Store the given amount of armory points.. . value2. Category: OFP text setAttributes [name1. value2.html 7/11/2010 .BIS Game Engine Scripting Commands Page 297 of 415 setAperture set Operand types: set: Number Compatibility: Version 2. . Example: txt = img setAttributes ["image"..paa"] Category: OFP group setBehaviour behaviour Operand types: group: Object or Group http://www.73 required.arma2.com/comref/full.

"COMBAT" or "STEALTH". the vehicle commander is marked instead. Example: setCaptive player Category: OFP group setCombatMode mode Operand types: http://www. If the unit is a vehicle.com/comref/full.57 required. "SAFE". Behaviour is one of: "CARELESS". A captive is neutral to everyone. Example: _soldier setCameraInterest 50 Category: OFP person setCaptive captive Operand types: person: Object captive: Type of returned value: Nothing Description: Marks the unit as captive. "AWARE".BIS Game Engine Scripting Commands Page 298 of 415 behaviour: String Type of returned value: Nothing Description: Sets the group behaviour mode. Note: This function does not remove the unit's weapons.arma2.html 7/11/2010 . Example: groupOne setBehaviour "SAFE" Category: OFP entity setCameraInterest interest Operand types: entity: Object interest: Number Compatibility: Version 2. Type of returned value: Nothing Description: Set camera interest for given entity.

engage at will). "GREEN" (Hold fire . engage at will).html 7/11/2010 .BIS Game Engine Scripting Commands Page 299 of 415 group: Object or Group mode: String Type of returned value: Nothing Description: Sets the group's combat mode (engagement rules). "YELLOW" (Fire at will) or "RED" (Fire at will. Type of returned value: Nothing Description: Switch the group to process the given waypoint. Mode can be one of: "BLUE" (Never fire). "WHITE" (Hold fire.com/comref/full.defend only).arma2. Example: groupOne setCombatMode "BLUE" Category: OFP person setCurrentTask task Operand types: person: Object task: Task Compatibility: Version 5501 required. Category: Identity group setCurrentWaypoint waypoint Operand types: group: Group waypoint: Array Compatibility: Version 5129 required. Category: OFP object setDamage damage Operand types: object: Object damage: Number Compatibility: http://www. Type of returned value: Nothing Description: Set the task as a current task of the person.

month.arma2. Category: OFP object setDestination [position. planningMode.html 7/11/2010 . damage 1 means it's completely destroyed / dead.86 required. forceReplan] Operand types: object: Object [position. day. hour. planningMode. Type of returned value: Nothing Description: Sets the actual mission date and time. Example: player setdamage 1 Category: OFP obj setDammage dammage Operand types: obj: Object dammage: Number Type of returned value: Nothing Description: Damages / repairs the object. Example: player setdammage 1 Category: OFP setDate [year. Type of returned value: Nothing Description: Damages / repairs the object.BIS Game Engine Scripting Commands Page 300 of 415 Version 1. It was introduced to fix a spelling error in the original function name.com/comref/full. Damage 0 means the object is fully functional. Note: this function is identical to setDammage. damage 1 means it's completely destroyed / dead.50 required. forceReplan]: Array Compatibility: http://www. day. hour. minute]: Array Compatibility: Version 1. Damage 0 means the object is fully functional. month. minute] Operand types: [year.

height.90 required.92 required. angle. draw line?. offset. Example: player setDir 180 Category: OFP location setDirection direction Operand types: location: Location direction: Number Compatibility: Version 2.html 7/11/2010 . offset. height. Type of returned value: Nothing http://www. Type of returned value: Nothing Description: Set the destination for path planning of the pilot. texture. string identifier.92 required. draw line?. Type of returned value: Nothing Description: Set a new direction (angle) of given location. Category: Location map setDrawIcon [object.arma2.BIS Game Engine Scripting Commands Page 301 of 415 Version 2. priority]: Array Compatibility: Version 2. maintain size?. texture.com/comref/full. is3D. color. shadow. priority] Operand types: map: Control [object. maintain size?. angle. shadow. The accepted heading range is from 0 to 360. width. width. string identifier. color. Category: OFP obj setDir heading Operand types: obj: Object heading: Number Type of returned value: Nothing Description: Sets the object heading. is3D.

is3D.condition.BIS Game Engine Scripting Commands Page 302 of 415 Description: Set the icon to be shown in 2D editor for the specified editor object.scope. Example: _source setDropInterval 0. Type of returned value: Nothing Description: Set interval of emitting particles from particle source.56 required. If maintain size is a number. Type of returned value: Nothing Description: Sets map mode to MAP.html 7/11/2010 .condition.92 required. Category: Editor map setEditorObjectScope [objects.com/comref/full. Category: Editor particleSource setDropInterval interval Operand types: particleSource: Object interval: Number Compatibility: Version 2.subordinates also] Operand types: map: Control [objects.arma2.editor type.92 required. Type of returned value: Nothing Description: http://www.editor type.05 Category: OFP map setEditorMode mode Operand types: map: Control mode: String Compatibility: Version 2. If maintain size is false. show line and priority are optional. icon will not scale depending on the scale of the map. 3D or PREVIEW.scope.subordinates also]: Array Compatibility: Version 2. the icon will maintain size if map scale is below that number.

Example: _map setEditorObjectScope [[].false]. if true then subordinates in the editor will be assigned the same scope as the parent. If the result is an object. Example: trigger setEffectCondition "thisList" Category: OFP person setFace soldier Operand types: person: Object soldier: String Type of returned value: Nothing Description: Sets the person's face. the effect was launched if the result is the player or the player vehicle. editor type is the editor type to effect (eg unit). If true.html 7/11/2010 . Example: setFace "Face10" Category: OFP person setFaceanimation blink http://www. If the result is a boolean and true.vehicle.86 required. ALLNODRAG. the effect was launched if the result contains the player or the player vehicle.HIDE. If the array is empty then the command will automatically parse all editor objects. Type of returned value: Nothing Description: The statement is executed when the trigger or waypoint is activated and the effects are launched depending on the result. subordinates also is a boolean value. the scope of the evaluated editor object will be modified. Category: Editor trigger or waypoint setEffectCondition statement Operand types: trigger or waypoint: Object or Array statement: String Compatibility: Version 1. VIEW. objects is an array of either Editor Objects (eg [_unit_0]) or actual Game Objects (eg [player]). or for none.com/comref/full. ALLNOTREE or ALL.arma2.BIS Game Engine Scripting Commands Page 303 of 415 This command defines the level of access a user has to editor objects. LINKFROM. If the result is an array. condition is an executable string that must evaluate to true or false. SELECT. LINKTO.side effectiveCommander _x != side player. scope is one of HIDE. the effect was launched.

arma2. Blink is in the range from 0 to 1. the flag is returned to the flagpole.com/comref/full. Example: setFlagOwner objNull Category: OFP flag setFlagSide side Operand types: flag: Object side: Side Type of returned value: Nothing Description: Sets the flag side.BIS Game Engine Scripting Commands Page 304 of 415 Operand types: person: Object blink: Number Type of returned value: Nothing Description: Sets the facial animation phase (eye blinking). Example: setFaceAnimation 0.html 7/11/2010 . When the owner is set to objNull.5 Category: OFP flag setFlagOwner owner Operand types: flag: Object owner: Object Type of returned value: Nothing Description: Sets the flag owner. Example: setFlagSide east Category: OFP flag setFlagTexture texture Operand types: flag: Object texture: String http://www.

"ECH RIGHT". Example: setFlagTexture "usa_vlajka. the flag is not drawn. A fog level of zero is minimum fog and a fog level of one is maximum fog. Example: 1800 setFog 0.arma2. "STAG COLUMN". If the texture is "". Formation is one of: "COLUMN". "VEE" or "LINE".5 Category: OFP group setFormation formation Operand types: group: Object or Group formation: String Type of returned value: Nothing Description: Sets the group formation.com/comref/full. Example: groupOne setFormation "LINE" Category: OFP object setFormationTask task Operand types: object: Object task: String http://www.html 7/11/2010 . A time of zero means there will be an immediate change.BIS Game Engine Scripting Commands Page 305 of 415 Type of returned value: Nothing Description: Sets the flag texture. "ECH LEFT". "WEDGE".pac" Category: OFP time setFog fog Operand types: time: Number fog: Number Type of returned value: Nothing Description: Changes the fog value smoothly during the given time (in seconds).

Type of returned value: Nothing Description: Sets how friendly side1 is with side2.com/comref/full. Category: OFP FSM handle setFSMVariable [name. value] Operand types: side1: Side [side2. Category: OFP group setFormDir heading Operand types: group: Object or Group heading: Number Type of returned value: Nothing Description: Sets the formation heading. Type of returned value: Nothing Description: Set the current task of the formation member.html 7/11/2010 .BIS Game Engine Scripting Commands Page 306 of 415 Compatibility: Version 2.6 it results in being enemy. Example: player setformdir 180 Category: OFP side1 setFriend [side2.92 required. For a value smaller than 0. When the group is moving. value]: Array Compatibility: Version 1. value]: Array Compatibility: Version 5501 required. value] Operand types: FSM handle: Number [name. The accepted heading range is from 0 to 360.arma2. this value is overridden by the movement direction.86 required. The formation is facing this direction unless an enemy is seen. http://www. otherwise it's friendly.

arma2.html 7/11/2010 . Type of returned value: Nothing http://www. A fuel level of one is a full gas tank. Example: jeepOne setFuel 0 Category: OFP vehicle setFuelCargo amount Operand types: vehicle: Object amount: Number Type of returned value: Nothing Description: Sets the fuel amount in the cargo space of a refuelling vehicle. Category: OFP vehicle setFuel amount Operand types: vehicle: Object amount: Number Type of returned value: Nothing Description: Sets the fuel amount.com/comref/full.BIS Game Engine Scripting Commands Page 307 of 415 Type of returned value: Nothing Description: Set variable to given value in the variable space of given FSM. Example: refuelTruckOne setFuelCargo 0 Category: OFP group setGroupIcon properties Operand types: group: Group properties: Array Compatibility: Version 5501 required. A fuel level of one is a full gas tank. The FSM handle is the number returned by the execFSM command.

com/comref/full.bool] Example: group setGroupIconParams [[1. Example: setGroupIcon[id.[offsetX.BIS Game Engine Scripting Commands Page 308 of 415 Description: Set group icons properties.float.1."b_inf".string. Type of returned value: http://www.1].1. Type of returned value: Nothing Description: Sets if group icons raises onclick and onover events. Type of returned value: Nothing Description: Set group icons parameters.html 7/11/2010 .ofsetY]] Category: OFP group setGroupIconParams properties Operand types: group: Group properties: Array Compatibility: Version 5501 required.show] Category: OFP setGroupIconsSelectable bool Operand types: bool: Boolean Compatibility: Version 5501 required. Example: selectableGroupIcons true Category: OFP setGroupIconsVisible array Operand types: array: Array Compatibility: Version 5501 required.arma2. [color."text".scale.

damage]: Array Compatibility: Version 2.arma2.92 required.true] Category: OFP group setGroupid [nameFomat.. Category: OFP object setHit [part. Example: showGroupIcons [true. .] Operand types: group: Object or Group [nameFomat. damage] Operand types: object: Object [part.. hidePosition]: Array Compatibility: Version 2. ObjectWhereHide can be taken using findCover. .30 required.]: Array Type of returned value: Nothing Description: Sets the group identity. nameParam1.. Category: OFP object setHideBehind [objectWhereHide. parameters are names of subclasses of CLASS_NAME with the description of the name subpart. HidePosition can be taken using getHideFrom. Type of returned value: Nothing Description: http://www. hidePosition] Operand types: object: Object [objectWhereHide. nameParam1. nameFormat contains strings "%CLASS_NAME" where CLASS_NAME is name of class in CfgWorlds.. Type of returned value: Nothing Description: It sets the data for hiding.html 7/11/2010 .com/comref/full.BIS Game Engine Scripting Commands Page 309 of 415 Nothing Description: Sets if group icons are visible.

b]: Array Compatibility: Version 2. Type of returned value: Nothing Description: Set a new importance of given location. 1] Category: OFP person setIdentity identity Operand types: person: Object identity: String Type of returned value: Nothing Description: Sets the identity of a person. g. Category: Location light setLightAmbient [r.58 required. Identities are defined in the descripion. damage 1 means completely destroyed / dead. Example: vehicle player setHit ["engine". Type of returned value: Nothing Description: http://www. Damage 0 means fully functional.html 7/11/2010 .com/comref/full. b] Operand types: light: Object [r.arma2.ext file of the mission or campaign.90 required.BIS Game Engine Scripting Commands Page 310 of 415 Damage / repair part of object. Example: setIdentity "JohnDoe" Category: OFP location setImportance importance Operand types: location: Location importance: Number Compatibility: Version 2. g.

BIS Game Engine Scripting Commands Page 311 of 415 Set ambient color of light. Type of returned value: Nothing Description: Set brightness of light.5 Category: OFP http://www. The marker is modified on all computers in a network session.com/comref/full. b] Operand types: light: Object [r. Type of returned value: Nothing Description: Set diffuse color of light. Type of returned value: Nothing Description: Sets the marker alpha. Category: OFP marker setMarkerAlpha alpha Operand types: marker: String alpha: Number Compatibility: Version 5501 required. g.arma2. g. Example: "MarkerOne" setMarkerAlpha 0. Category: OFP light setLightBrightness brightness Operand types: light: Object brightness: Number Compatibility: Version 2. Category: OFP light setLightColor [r. b]: Array Compatibility: Version 2.58 required.58 required.html 7/11/2010 .

The marker is only modified on the computer where the command is called.BIS Game Engine Scripting Commands Page 312 of 415 marker setMarkerAlphaLocal alpha Operand types: marker: String alpha: Number Compatibility: Version 5501 required. Brush is the name of the subclass in CfgMarkerBrushes.86 required. Type of returned value: Nothing Description: Selects the fill texture for the marker ("RECTANGLE" or "ELLIPSE"). Type of returned value: Nothing Description: Sets the marker alpha. The marker is modified on all computers in a network session. http://www. Example: "Marker1" setMarkerBrush "DiagGrid" Category: OFP name setMarkerBrushLocal brush Operand types: name: String brush: String Compatibility: Version 2.92 required.arma2. Brush is the name of the subclass in CfgMarkerBrushes. Type of returned value: Nothing Description: Selects the fill texture for the marker ("RECTANGLE" or "ELLIPSE").5 Category: OFP name setMarkerBrush brush Operand types: name: String brush: String Compatibility: Version 1. Example: "MarkerOne" setMarkerAlpha 0.html 7/11/2010 .com/comref/full. The marker is only modified on the computer where the command is called.

"ColorYellow" or "ColorWhite". "ColorRed". The marker is only modified on the computer where the command is called. "ColorBlue". Type of returned value: Nothing Description: Sets the marker color. "ColorBlack". "ColorGreen". "ColorBlue". "ColorRedAlpha".html 7/11/2010 .arma2. The marker is modified on all computers in a network session.92 required. "ColorGreenAlpha". "ColorRedAlpha".com/comref/full. "ColorGreenAlpha". "ColorGreen". Type of returned value: Nothing Description: Sets the marker color.BIS Game Engine Scripting Commands Page 313 of 415 Example: "Marker1" setMarkerBrushLocal "DiagGrid" Category: OFP marker setMarkerColor color Operand types: marker: String color: String Compatibility: Version 1. "ColorRed".21 required. Color is one of: "Default". Example: "MarkerOne" setMarkerColor "ColorBlack" Category: OFP marker setMarkerColorLocal color Operand types: marker: String color: String Compatibility: Version 2. "ColorBlack". Color is one of: "Default". Example: "MarkerOne" setMarkerColorLocal "ColorBlack" Category: OFP name setMarkerDir angle Operand types: name: String angle: Number http://www. "ColorYellow" or "ColorWhite".

BIS Game Engine Scripting Commands Page 314 of 415 Compatibility: Version 1. The marker is modified on all computers in a network session. Example: "Marker1" setMarkerDir 90 Category: OFP name setMarkerDirLocal angle Operand types: name: String angle: Number Compatibility: Version 2.92 required. Type of returned value: Nothing Description: Sets the orientation of the marker. The marker is only modified on the computer where the command is called. Angle is in degrees. Angle is in degrees. Example: "Marker1" setMarkerDirLocal 90 Category: OFP markerName setMarkerPos pos Operand types: markerName: String pos: Array Type of returned value: Nothing Description: Moves the marker.arma2. The marker is modified on all computers in a network session.com/comref/full. Example: "MarkerOne" setMarkerPos getMarkerPos "MarkerTwo" Category: OFP markerName setMarkerPosLocal pos http://www.html 7/11/2010 . Type of returned value: Nothing Description: Sets the orientation of the marker.86 required. The format of pos is Position2D.

arma2. Type of returned value: Nothing Description: Moves the marker.html 7/11/2010 .com/comref/full.92 required.86 required. Shape can be "ICON".92 required. The marker is only modified on the computer where the command is called. Type of returned value: Nothing Description: Selects the shape (type) of the marker. The marker is only modified on the computer where the command is called. The marker is modified on all computers in a network session. Shape can be "ICON". Example: "MarkerOne" setMarkerPosLocal getMarkerPos "MarkerTwo" Category: OFP name setMarkerShape shape Operand types: name: String shape: String Compatibility: Version 1. The format of pos is Position2D. "RECTANGLE" or "ELLIPSE".BIS Game Engine Scripting Commands Page 315 of 415 Operand types: markerName: String pos: Array Compatibility: Version 2. Example: "Marker1" setMarkerShapeLocal "RECTANGLE" Category: OFP http://www. "RECTANGLE" or "ELLIPSE". Example: "Marker1" setMarkerShape "RECTANGLE" Category: OFP name setMarkerShapeLocal shape Operand types: name: String shape: String Compatibility: Version 2. Type of returned value: Nothing Description: Selects the shape (type) of the marker.

Type of returned value: Nothing Description: Sets the marker size. Size is in format [a-axis.BIS Game Engine Scripting Commands Page 316 of 415 marker setMarkerSize size Operand types: marker: String size: Array Compatibility: Version 1. Type of returned value: Nothing Description: Sets the marker size. Example: "MarkerOne" setMarkerSizeLocal [100.com/comref/full. 200] Category: OFP marker setMarkerSizeLocal size Operand types: marker: String size: Array Compatibility: Version 2. Example: "MarkerOne" setMarkerSize [100. 200] Category: OFP name setMarkerText text Operand types: name: String text: String Compatibility: Version 1. The marker is only modified on the computer where the command is called. b-axis]. Size is in format [a-axis. http://www.21 required.arma2. The marker is modified on all computers in a network session. b-axis]. Type of returned value: Nothing Description: Sets the text label of an existing marker.92 required. The marker is modified on all computers in a network session.86 required.html 7/11/2010 .

"Dot". Category: OFP markerName setMarkerType markerType Operand types: markerName: String markerType: String Type of returned value: Nothing Description: Sets the marker type.html 7/11/2010 .92 required. "Arrow" or "Empty". "Flag1". The marker is modified on all computers in a network session. "Destroy". "Pickup". "Warning". The marker is only modified on the computer where the command is called. "Unknown". "Join".com/comref/full. Type of returned value: http://www. Type may be any of: "Flag". Category: OFP name setMarkerTextLocal text Operand types: name: String text: String Compatibility: Version 2.arma2. "Marker". Type of returned value: Nothing Description: Sets the text label of an existing marker. "End".92 required. Example: "MarkerOne" setMarkerType "Arrow" Category: OFP markerName setMarkerTypeLocal markerType Operand types: markerName: String markerType: String Compatibility: Version 2.BIS Game Engine Scripting Commands Page 317 of 415 Example: "Marker1" setMarkerText You are here. Example: "Marker1" setMarkerTextLocal You are here. "Start".

Example: setMousePosition [0. "Join".5] Category: OFP trigger or waypoint setMusicEffect track Operand types: trigger or waypoint: Object or Array track: String http://www. Example: "MarkerOne" setMarkerTypeLocal "Arrow" Category: OFP person setMimic mimic Operand types: person: Object mimic: String Type of returned value: Nothing Description: Sets a unit's mimic. "Start".com/comref/full. y] Operand types: [x. "Marker". "Arrow" or "Empty". "Surprised". "Sad". "Unknown".arma2. "Agresive" and "Angry". The following values are recognized: "Default". "Cynic". Type may be any of: "Flag". "Warning". "Smile". "End". y]: Array Compatibility: Version 2. "Pickup". Example: setMimic "Angry" Category: OFP setMousePosition [x. "Destroy".BIS Game Engine Scripting Commands Page 318 of 415 Nothing Description: Sets the marker type. Type of returned value: Nothing Description: Move (UI) mouse pointer to specified position of the screen.5. "Dot".91 required.html 7/11/2010 . "Normal". "Ironic". "Hurt". 0. The marker is only modified on the computer where the command is called. "Flag1".

"$NONE$" (no change) or "$STOP$" (stops the current music track)..92 required.com/comref/full. proxy object]: Array Compatibility: Version 2. . value1. . Track is a subclass name of CfgMusic. Category: Location map setObjectArguments [object.]]: Array Compatibility: Version 2.BIS Game Engine Scripting Commands Page 319 of 415 Compatibility: Version 1. Type of returned value: Nothing Description: Set which global variable will contain given location. http://www. value1. Type of returned value: Any Description: Set object arguments in mission editor.arma2.. Category: Editor map setObjectProxy [object. [name1.. [name1.html 7/11/2010 . Example: trigger setMusicEffect "Track1" Category: OFP location setName name Operand types: location: Location name: String Compatibility: Version 2.86 required. proxy object] Operand types: map: Control [object.]] Operand types: map: Control [object.92 required..90 required. Type of returned value: Nothing Description: Defines the music track played on activation.

Category: Editor object setObjectTexture texture Operand types: object: Object texture: Array Compatibility: Version 1. velocity]: Array Compatibility: Version 2.arma2.com/comref/full.html 7/11/2010 . Velocity is transformed and http://www.56 required.BIS Game Engine Scripting Commands Page 320 of 415 Type of returned value: Any Description: Set the proxy object associated with the given editor object. Type of returned value: Nothing Category: Resistance time setOvercast overcast Operand types: time: Number overcast: Number Type of returned value: Nothing Description: Changes the overcast level to the given value smoothly during the given time (in seconds). Type of returned value: Nothing Description: Update particle source to create particles on circle with given radius. An overcast level of zero means clear (sunny) weather and with an overcast level of one.5 Category: OFP particleSource setParticleCircle [radius. A time of zero means an immediate change. storms and showers are very likely.75 required. velocity] Operand types: particleSource: Object [radius. Example: 1800 setOvercast 0.

Example: setPlayable aP http://www.56 required. color. {angle}]: Array Compatibility: Version 2. moveVelocity. position. randomDirectionPeriod.html 7/11/2010 . Type of returned value: Nothing Description: Set randomization of particle source parameters. size. Category: OFP particleSource setParticleRandom [lifeTime. randomDirectionIntensity. moveVelocity.56 required.arma2. Category: OFP particleSource setParticleParams array Operand types: particleSource: Object array: Array Compatibility: Version 2. Array is in format ParticleArray. rotationVelocity. Category: OFP setPlayable unit Operand types: unit: Object Compatibility: Version 2. rotationVelocity. {angle}] Operand types: particleSource: Object [lifeTime. randomDirectionPeriod.92 required. position. color. randomDirectionIntensity. Type of returned value: Nothing Description: Set parameters to particle source.BIS Game Engine Scripting Commands Page 321 of 415 added to total velocity. size.com/comref/full. Type of returned value: Nothing Description: Create MP role for the unit.

Type of returned value: Nothing Description: Sets the object position. getpos player select 1 + 10] Category: OFP obj setPosASL pos Operand types: obj: Object pos: Array Compatibility: Version 2.BIS Game Engine Scripting Commands Page 322 of 415 Category: OFP obj setPos pos Operand types: obj: Object pos: Array Type of returned value: Nothing Description: Sets the object position. Type of returned value: Nothing Description: Sets the object position. The pos array uses the PositionASL format.com/comref/full. Example: player setPos [getpos player select 0. The pos array uses the PositionASL format. The version of the command does not offset based on object center. The pos array uses the Position format. Example: http://www. getposASL player select 1 + 10.html 7/11/2010 .53 required.arma2. Example: player setPosASL [getposASL player select 0. getPosASL select 2] Category: OFP obj setPosASL2 pos Operand types: obj: Object pos: Array Compatibility: Version 2.53 required.

Category: Location index setRadioMsg text Operand types: index: Number text: String Type of returned value: Nothing Description: Sets the radio message (0.arma2. Example: 0 setRadioMsg "Alpha Radio" Category: OFP time setRain rainDensity Operand types: time: Number rainDensity: Number Compatibility: Version 1. getposASL player select 1 + 10. Use "NULL" to disable the radio slot. Type of returned value: Nothing Description: Changes the rain density smoothly during the given time (in seconds). map radio) to the given text. Rain is not possible when overcast is smaller than 0. A time of zero means an immediate change.html 7/11/2010 . 0.BIS Game Engine Scripting Commands Page 323 of 415 player setPosASL [getposASL player select 0.com/comref/full. getPosASL select 2] Category: OFP location setPosition position Operand types: location: Location position: Array Compatibility: Version 2. Example: http://www.7.90 required.75 required. A rain level of zero is no rain and a rain level of one is maximum rain. Type of returned value: Nothing Description: Set a new position of given location.

Example: http://www.arma2. An amount of one is a full cargo space. MAJOR or COLONEL.com/comref/full.92 required. Type of returned value: Nothing Description: Set if given location has rectangular shape. SERGEANT.90 required. CAPTAIN.BIS Game Engine Scripting Commands Page 324 of 415 60 setRain 1 Category: OFP unit setRank rank Operand types: unit: Object rank: String Compatibility: Version 2. LIEUTENANT.html 7/11/2010 . Possible values: PRIVATE. Category: Location vehicle setRepairCargo amount Operand types: vehicle: Object amount: Number Type of returned value: Nothing Description: Sets the amount or repair resources in the cargo space of a repair vehicle. CORPORAL. Type of returned value: Nothing Description: Sets rank of given unit. Example: player setRank "COLONEL" Category: OFP location setRectangular rectangular Operand types: location: Location rectangular: Boolean Compatibility: Version 2.

descriptionShort.arma2. Category: Location task setSimpleTaskDescription [description.BIS Game Engine Scripting Commands Page 325 of 415 repairTruckOne setRepairCargo 0 Category: OFP location setSide side Operand types: location: Location side: Side Compatibility: Version 2.com/comref/full. Type of returned value: Nothing Description: Set a new target side of given location. descriptionHUD] Operand types: task: Task [description.html 7/11/2010 . Type of returned value: Nothing Description: Attach descriptions to the simple task. descriptionShort. Type of returned value: Nothing Description: Attach a destination to the simple task. Category: Identity task setSimpleTaskDestination position Operand types: task: Task position: Array Compatibility: Version 5500 required.90 required. descriptionHUD]: Array Compatibility: Version 5500 required. Category: Identity http://www.

sizeZ] Operand types: location: Location [sizeX. Value of skill may vary from 0 to 1. sizeZ]: Array Compatibility: Version 2. Example: hero setSkill ["Endurance". Type of returned value: Nothing Description: Sets skill of given type of person (commander unit). Example: hero setSkill 1 Category: Resistance vehicle setSkill [type. height) of given location. Type of returned value: Nothing Description: Set a new size (width.65 required. 1] Category: OFP PC http://www. skill] Operand types: vehicle: Object [type.75 required.com/comref/full.arma2.html 7/11/2010 . skill]: Array Compatibility: Version 2.90 required. Category: Location vehicle setSkill skill Operand types: vehicle: Object skill: Number Compatibility: Version 1.BIS Game Engine Scripting Commands Page 326 of 415 location setSize [sizeX. Value of skill may vary from 0 to 1. Type of returned value: Nothing Description: Sets ability levell of person (commander unit).

Example: groupOne setSpeedMode "LIMITED" Category: OFP object setTargetAge age Operand types: object: Object age: String Compatibility: Version 2. They behave like the target was seen age seconds ago. ""] Category: OFP group setSpeedMode mode Operand types: group: Object or Group mode: String Type of returned value: Nothing Description: Sets the group speed mode.32 required. Mode may be one of: "LIMITED" (half speed).86 required. "NORMAL" (full speed. "30 MIN". Type of returned value: Nothing Description: Defines the different sound effects. "15 MIN". Type of returned value: Nothing Description: Sets how the target is known to the other centers. SoundEnv plays an enviromental sound from CfgEnvSounds. soundEnv. Example: player setTargetAge "10 MIN" http://www. "120 MIN" or "UNKNOWN". "5 MIN". soundEnv. Example: trigger setSoundEffect ["Alarm". voice. "". Possible age values are: "ACTUAL". "60 MIN".BIS Game Engine Scripting Commands Page 327 of 415 trigger or waypoint setSoundEffect [sound. "10 MIN". soundDet] Operand types: trigger or waypoint: Object or Array [sound. soundDet]: Array Compatibility: Version 1. "".com/comref/full. SoundDet (only for triggers) creates a dynamic sound object attached to a trigger defined in CfgSFX. maintain formation) or "FULL" (do not wait for any other units in the formation).html 7/11/2010 .arma2. Sound / voice plays a 2D / 3D sound from CfgSounds. voice.

Type of returned value: Nothing Description: Sets the desired terrain resolution (in meters).html 7/11/2010 .arma2. Type of returned value: Nothing Description: Set a new state of the task.BIS Game Engine Scripting Commands Page 328 of 415 Category: OFP task setTaskResult [state.92 required.com/comref/full.125. Category: Identity task setTaskState state Operand types: task: Task state: String Compatibility: Version 2. If you select an unsupported resolution.5 Category: OFP http://www. the nearest supported resolution is used instead.5. 12.89 required.75 required.25 and 3. result] Operand types: task: Task [state. 6. Type of returned value: Nothing Description: Set a result of the task. For default landscapes the supported resolutions are: 50. Category: Identity setTerrainGrid grid Operand types: grid: Number Compatibility: Version 1. Example: setTerrainGrid 12. result]: Array Compatibility: Version 2. 25.

"BLACK FADED". Type can be "NONE". The second argument - http://www. "DELTA". "BLACK OUT". "FOXTROT"."] Category: OFP trigger setTriggerActivation [by. For "TEXT". Example: trigger setTitleEffect ["TEXT". "GUER". text]: Array Compatibility: Version 1. repeating] Operand types: trigger: Object [by.who activates trigger (side. Category: Location trigger or waypoint setTitleEffect [type. "BLACK IN". "HOTEL". the effect defines a subtype: "PLAIN". "ALPHA". "PLAIN DOWN". "PLAIN DOWN". For "RES".BIS Game Engine Scripting Commands Page 329 of 415 location setText text Operand types: location: Location text: String Compatibility: Version 2. "ANY". Type of returned value: Nothing Description: Defines the title effect. radio. "WEST".arma2. "LEADER" or "MEMBER". "GROUP". text defines a resource class. The first argument . a subclass of CfgTitles. "RES" or "TEXT". "WHITE OUT" or "WHITE IN". text defines the shown object.86 required. "ECHO".86 required. Text is shown as text itself. "EAST". "OBJECT". "LOGIC". "GOLF". "JULIET". vehicle or group member): "NONE". type. effect. Type of returned value: Nothing Description: Defines the trigger activation type. Type of returned value: Nothing Description: Set a new text attached to given location. effect. "STATIC". "CHARLIE".90 required. "CIV". a subclass of RscTitles. For "OBJECT". repeating]: Array Compatibility: Version 1. text] Operand types: trigger or waypoint: Object or Array [type. "BRAVO".html 7/11/2010 . type. "Hello world. "BLACK". "INDIA".com/comref/full. "VEHICLE".

activ.86 required. desactiv]: Array Compatibility: Version 1. Type of returned value: Nothing Description: Defines the area controlled by the trigger. "EAST D". Type of returned value: Nothing Description: The first argument can modify the condition of when the trigger is activated.BIS Game Engine Scripting Commands Page 330 of 415 when is it activated (presention or detection by the specified side): "PRESENT". "EAST D". rectangle] Operand types: trigger: Object [a. Example: trigger setTriggerStatements ["this". activ. "ok = false"] Category: OFP trigger setTriggerText text http://www. the height is 2 * b. Variable thisList contains all vehicles which caused the activation. desactiv] Operand types: trigger: Object [cond. The result of the activation defined by trigger activation is in variable this. b. angle. "NOT PRESENT". Activ and desactiv expressions are launched upon trigger activation / deactivation. 50. Example: trigger setTriggerArea [100. true] Category: OFP trigger setTriggerArea [a. the width is 2 * a. The third argument . rectangle]: Array Compatibility: Version 1. "WEST D". false] Category: OFP trigger setTriggerStatements [cond.86 required. angle. It is rotated angle degrees.arma2. "ok = true". The area is rectangular or elliptic. 45. b.com/comref/full. Example: trigger setTriggerActivation ["WEST".html 7/11/2010 .whether the activation is repeating. "GUER D" or "CIV D".

This is used for example as a radio slot label for radio activated triggers. mid.BIS Game Engine Scripting Commands Page 331 of 415 Operand types: trigger: Object text: String Compatibility: Version 1. Type of returned value: Nothing Description: Sets the text label attached to the trigger object. 10. Example: trigger setTriggerTimeout [5. "END5".86 required.com/comref/full. a waypoints switch or an end of mission): "NONE". interruptable]: Array Compatibility: Version 1.arma2. with an average value mid). "END1". interruptable] Operand types: trigger: Object [min.86 required. max. Example: trigger setTriggerText "Call for support" Category: OFP trigger setTriggerTimeout [min. mid. Type of returned value: Nothing Description: Defines the time between condition satisfaction and trigger activation (randomly from min to max. false] Category: OFP trigger setTriggerType action Operand types: trigger: Object action: String Compatibility: Version 1. "END3". "END6". "END4". "SWITCH".html 7/11/2010 . 7. the condition must be fullfilled all the time. max. Type of returned value: Nothing Description: Sets the type of action processed by the trigger after activation (no action. "END2".86 required. Example: trigger setTriggerType "END1" http://www. "LOOSE" or "WIN". If the last argument is true.

BIS Game Engine Scripting Commands Page 332 of 415 Category: OFP location setType type Operand types: location: Location type: String Compatibility: Version 2. Type of returned value: Nothing Description: Set / reset the unconscious life state of the given unit (in MP works only for a local unit).0. Type of returned value: Nothing Description: Sets skill of given unit.com/comref/full.90 required.0 Category: OFP http://www.2 to 1. Skill may vary from 0.html 7/11/2010 . Category: OFP unit setUnitAbility skill Operand types: unit: Object skill: Number Compatibility: Version 2. Example: player setUnitSkill 1.33 required.arma2. Category: Location unit setUnconscious set Operand types: unit: Object set: Boolean Compatibility: Version 5501 required. Type of returned value: Nothing Description: Set a new type of given location.

for usage in formation FSM (to avoid collision with setUnitPos used by the mission). Example: soldierOne setUnitPos "Down" Category: OFP unit setUnitPosWeak mode Operand types: unit: Object mode: String Compatibility: Version 5117 required. CORPORAL. Example: soldierOne setUnitPosWeak "Down" Category: OFP unit setUnitRank rank Operand types: unit: Object rank: String Compatibility: Version 2.html 7/11/2010 .arma2. Example: player setUnitRank "COLONEL" Category: OFP http://www. Type of returned value: Nothing Description: Equal to setUnitPos. LIEUTENANT. "UP" or "AUTO". CAPTAIN. Possible values: PRIVATE.33 required.BIS Game Engine Scripting Commands Page 333 of 415 unit setUnitPos mode Operand types: unit: Object mode: String Type of returned value: Nothing Description: Sets the unit position rules. Mode may be one of: "DOWN". MAJOR or COLONEL.com/comref/full. SERGEANT. Type of returned value: Nothing Description: Sets rank of given unit.

Type of returned value: Nothing Description: Set variable to given value in the variable space of given object.html 7/11/2010 . Category: OFP map setVariable [name. Type of returned value: Nothing Description: Set variable to given value in the given namespace.arma2. If public is true then the value is broadcast to all computers. value. value] http://www.92 required. Type of returned value: Nothing Description: Set variable to given value in the variable space of given group. Category: OFP object setVariable [name. value]: Array Compatibility: Version 5501 required. public]: Array Compatibility: Version 2.BIS Game Engine Scripting Commands Page 334 of 415 namespace setVariable [name.com/comref/full. public] Operand types: object: Object [name. If public is true then the value is broadcast to all computers. value. value]: Array Compatibility: Version 5501 required. value] Operand types: group: Group [name. value] Operand types: namespace: Namespace [name. Category: Default group setVariable [name.

value]: Array Compatibility: Version 2. Category: Editor task setVariable [name.com/comref/full. value]: Array Compatibility: Version 2. Type of returned value: Nothing Description: Set variable to given value in the variable space of given map. value] Operand types: location: Location [name. Type of returned value: http://www. z. value] Operand types: task: Task [name.BIS Game Engine Scripting Commands Page 335 of 415 Operand types: map: Control [name.arma2.html 7/11/2010 . y]: Array Compatibility: Version 2. Category: Identity location setVariable [name. Category: Location object setVectorDir [x. Type of returned value: Nothing Description: Set variable to given value in the variable space of given task.92 required.92 required.61 required. y] Operand types: object: Object [x.92 required. value]: Array Compatibility: Version 2. Type of returned value: Nothing Description: Set variable to given value in the variable space of given location. z.

[x. Example: http://www. z]]: Array Compatibility: Version 5164 required.[x. Type of returned value: Nothing Description: Set object's direction and up vector Category: OFP object setVectorUp [x. The value ranges from 0 to 1.32 required. Category: OFP object setVectorDirAndUp [[x. y]. y]. z. Category: OFP object setVehicleAmmo value Operand types: object: Object value: Number Compatibility: Version 2. y] Operand types: object: Object [x. y]: Array Compatibility: Version 2. y. Type of returned value: Nothing Description: Sets how much ammunition (compared to the current configuration of magazines.arma2.com/comref/full. Direction vector will remain unchanged. z. Type of returned value: Nothing Description: Set object's up vector. z. but fully loaded) the vehicle has. z]] Operand types: object: Object [[x. Up vector will remain unchanged.BIS Game Engine Scripting Commands Page 336 of 415 Nothing Description: Set object's direction vector. y.html 7/11/2010 .61 required. z.

com/comref/full. By this id vehicle is referenced by triggers and waypoints.33 required.html 7/11/2010 . Type of returned value: Nothing Description: http://www.32 required.arma2. Type of returned value: Nothing Description: Sets id (integer value) to vehicle. Type of returned value: Nothing Description: Sets the armor (or health for men) state of the vehicle (a value from 0 to 1).33 required. Example: player setVehicleArmor 0. Example: player setVehicleId 1 Category: OFP vehicle setVehicleInit statement Operand types: vehicle: Object statement: String Compatibility: Version 2.5 Category: OFP object setVehicleId id Operand types: object: Object id: Number Compatibility: Version 2.BIS Game Engine Scripting Commands Page 337 of 415 player setVehicleAmmo 0 Category: OFP object setVehicleArmor value Operand types: object: Object value: Number Compatibility: Version 2.

BIS Game Engine Scripting Commands

Page 338 of 415

Execute statement attached to vehicle. This statement is also propagated over network in MP games. Example: soldier3 setVehicleInit "this allowfleeing 0" Category: OFP

vehicle setVehicleLock state
Operand types: vehicle: Object state: String Compatibility: Version 2.33 required. Type of returned value: Nothing Description: Set how vehicle is locked for player. Possible values: UNLOCKED, DEFAULT or LOCKED. Example: veh1 setVehicleLock "LOCKED" Category: OFP

object setVehiclePosition [position, markers, placement]
Operand types: object: Object [position, markers, placement]: Array Compatibility: Version 2.32 required. Type of returned value: Nothing Description: Changes the object position. If the markers array contains more than one marker names, the position of a random one is used. Otherwise, the given position is used. The object is placed inside a circle with this position as its center and placement as its radius. Example: player setVehiclePosition [[0, 0, 0], ["Marker1"], 0] Category: OFP

object setVehicleVarName name
Operand types: object: Object

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 339 of 415

name: String Compatibility: Version 2.32 required. Type of returned value: Nothing Description: Sets the name of the variable which contains a reference to this object. It is necessary in MP to change the variable content after a respawn. Example: player setVehicleVarName "aP" Category: OFP

vehicle setVelocity [x, z, y]
Operand types: vehicle: Object [x, z, y]: Array Compatibility: Version 1.80 required. Type of returned value: Nothing Description: Sets the velocity (speed vector) of a vehicle. Category: OFP

setViewDistance distance
Operand types: distance: Number Type of returned value: Nothing Description: Sets the rendering distance. Default is 900 meters. The accepted range is from 500 to 5000 meters. Example: setviewdistance 2000 Category: OFP

map setVisibleIfTreeCollapsed [object, visible if tree collapsed]
Operand types: map: Control [object, visible if tree collapsed]: Array Compatibility:

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 340 of 415

Version 2.92 required. Type of returned value: Nothing Description: Sets whether or not the object is visible even if the tree is collapsed. Category: Editor

waypoint setWaypointBehaviour mode
Operand types: waypoint: Array mode: String Compatibility: Version 1.86 required. Type of returned value: Nothing Description: Switches the unit behaviour when the waypoint becomes active. Possible values are: "UNCHANGED", "CARELESS", "SAFE", "AWARE", "COMBAT" and "STEALTH". Example: [grp, 2] setWaypointBehaviour "AWARE" Category: OFP

waypoint setWaypointCombatMode mode
Operand types: waypoint: Array mode: String Compatibility: Version 1.86 required. Type of returned value: Nothing Description: The group combat mode is switched when the waypoint becomes active. Possible values are: "NO CHANGE", "BLUE", "GREEN", "WHITE", "YELLOW" and "RED". Example: [grp, 2] setWaypointCombatMode "RED" Category: OFP

waypoint setWaypointCompletionRadius radius
Operand types: waypoint: Array

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 341 of 415

radius: Number Compatibility: Version 5500 required. Type of returned value: Nothing Description: Set the radius around the waypoint where is the waypoint completed. Example: [grp, 2] setWaypointCompletionRadius 30 Category: OFP

waypoint setWaypointDescription text
Operand types: waypoint: Array text: String Compatibility: Version 1.86 required. Type of returned value: Nothing Description: Sets the description shown in the HUD while the waypoint is active. Example: [grp, 2] setWaypointDescription "Move here." Category: OFP

waypoint setWaypointFormation formation
Operand types: waypoint: Array formation: String Compatibility: Version 1.86 required. Type of returned value: Nothing Description: Switches the group formation when the waypoint becomes active. Possible values are: "NO CHANGE", "COLUMN", "STAG COLUMN", "WEDGE", "ECH LEFT", "ECH RIGHT", "VEE" and "LINE". Example: [grp, 2] setWaypointFormation "LINE" Category: OFP

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 342 of 415

waypoint setWaypointHousePosition pos
Operand types: waypoint: Array pos: Number Compatibility: Version 1.86 required. Type of returned value: Nothing Description: For waypoints attached to a house, this defines the target house position. Example: [grp, 2] setWaypointHousePosition 1 Category: OFP

waypoint setWaypointPosition [center, radius]
Operand types: waypoint: Array [center, radius]: Array Compatibility: Version 1.86 required. Type of returned value: Nothing Description: Moves the waypoint to a random position in a circle with the given center and radius. Example: [grp, 2] setWaypointPosition [position player, 0] Category: OFP

waypoint setWaypointScript command
Operand types: waypoint: Array command: String Compatibility: Version 1.86 required. Type of returned value: Nothing Description: Attaches a script to a scripted waypoint. Command consist of a script name and additional script arguments. Example: [grp, 2] setWaypointScript "find.sqs player" Category: OFP

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 343 of 415

waypoint setWaypointSpeed mode
Operand types: waypoint: Array mode: String Compatibility: Version 1.86 required. Type of returned value: Nothing Description: Switches the group speed mode when the waypoint becomes active. Possible values are: "UNCHANGED", "LIMITED", "NORMAL" and "FULL". Example: [grp, 2] setWaypointSpeed "FULL" Category: OFP

waypoint setWaypointStatements [condition, statement]
Operand types: waypoint: Array [condition, statement]: Array Compatibility: Version 1.86 required. Type of returned value: Nothing Description: The waypoint is done only when the condition is fulfilled. When the waypoint is done, the statement expression is executed. Example: [grp, 2] setWaypointStatements ["true", ""] Category: OFP

waypoint setWaypointTimeout [min, mid, max]
Operand types: waypoint: Array [min, mid, max]: Array Compatibility: Version 1.86 required. Type of returned value: Nothing Description: Defines the time between condition satisfaction and waypoint finish (randomly from min to max, with an average value mid).

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 344 of 415

Example: [grp, 2] setWaypointTimeout [5, 10, 6] Category: OFP

waypoint setWaypointType type
Operand types: waypoint: Array type: String Compatibility: Version 1.86 required. Type of returned value: Nothing Description: Changes the waypoint type. Type can be: "MOVE", "DESTROY", "GETIN", "SAD", "JOIN", "LEADER", "GETOUT", "CYCLE", "LOAD", "UNLOAD", "TR UNLOAD", "HOLD", "SENTRY", "GUARD", "TALK", "SCRIPTED", "SUPPORT", "GETIN NEAREST", "AND" or "OR". Example: [grp, 2] setWaypointType "HOLD" Category: OFP

setWind [x, z, forced]
Operand types: [x, z, forced]: Array Compatibility: Version 5501 required. Type of returned value: Nothing Description: Set current (forced == false) or permanent (forced == true) wind direction and force. Category: OFP

wapoint setWPPos position
Operand types: wapoint: Array position: Array Compatibility: Version 1.21 required. Type of returned value: Nothing Description: Sets the waypoint position. Waypoint uses format Waypoint. Position uses format Position2D.

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 345 of 415

Example: [groupOne, 1] setWPPos getMarkerPos "MarkerOne" Category: OFP

map show3DIcons bool
Operand types: map: Control bool: Boolean Compatibility: Version 2.92 required. Type of returned value: Nothing Description: Toggle the drawing of 3D icons. Category: Editor

showCinemaBorder show
Operand types: show: Boolean Type of returned value: Nothing Description: Forces drawing of the cinema borders. This is normally used in cutscenes to indicate the player has no control. Category: OFP

showCommandingMenu class name
Operand types: class name: String Compatibility: Version 5500 required. Type of returned value: Nothing Description: Create the commanding menu described by the given config class. When class name is empty, current commanding menu is hidden. Category: OFP

http://www.arma2.com/comref/full.html

7/11/2010

Type of returned value: Nothing Description: Enable / disable showing of HUD.com/comref/full.arma2. Category: Editor http://www.html 7/11/2010 . Category: OFP showGps show Operand types: show: Boolean Type of returned value: Nothing Description: Enables the GPS receiver (the default is false). Category: OFP showHUD enable Operand types: enable: Boolean Compatibility: Version 5501 required.92 required. Category: OFP map showLegend bool Operand types: map: Control bool: Boolean Compatibility: Version 2. Type of returned value: Nothing Description: Show/hide map legend.BIS Game Engine Scripting Commands Page 346 of 415 showCompass show Operand types: show: Boolean Type of returned value: Nothing Description: Enables the compass (the default is true).

BIS Game Engine Scripting Commands

Page 347 of 415

showMap show
Operand types: show: Boolean Type of returned value: Nothing Description: Enables the map (the default is true). Example: showMap true Category: OFP

shownCompass
Type of returned value: Boolean Description: Checks whether the player has the compass enabled. Category: OFP

map showNewEditorObject [type, class, side, position]
Operand types: map: Control [type, class, side, position]: Array Compatibility: Version 2.92 required. Type of returned value: Any Description: Show the add editor object dialog, type is editor object type, class is class definition to automatically select, side filters by a certain side, pos is position to create the object. Category: Editor

shownGps
Type of returned value: Boolean Description: Checks whether the player has the GPS receiver enabled. Category: OFP

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 348 of 415

shownMap
Type of returned value: Boolean Description: Checks whether the player has the map enabled. Category: OFP

shownPad
Type of returned value: Boolean Description: Checks whether the player has the notebook enabled. Category: OFP

shownRadio
Type of returned value: Boolean Description: Checks whether the player has the radio transmitter enabled. Category: OFP

shownWarrant
Type of returned value: Boolean Description: Checks whether the player has the ID card enabled. (Obsolete). Category: OFP

shownWatch
Type of returned value: Boolean Description: Checks whether the player has the watch enabled. Category: OFP

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 349 of 415

showPad show
Operand types: show: Boolean Type of returned value: Nothing Description: Enables the notepad (the default is true). Category: OFP

showRadio show
Operand types: show: Boolean Type of returned value: Nothing Description: Enables the radio (the default is false). Category: OFP

showSubtitles enable
Operand types: enable: Boolean Compatibility: Version 5501 required. Type of returned value: Boolean Description: Enable / disable showing of subtitles. Return the previous state. Category: OFP

showWarrant show
Operand types: show: Boolean Type of returned value: Nothing Description: Obsolete. Enables the ID card (the default is false). Category: OFP

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 350 of 415

showWatch show
Operand types: show: Boolean Type of returned value: Nothing Description: Enables the watch (the default is true). Category: OFP

waypoint showWaypoint show
Operand types: waypoint: Array show: String Compatibility: Version 1.86 required. Type of returned value: Nothing Description: Sets the condition determining when the waypoint is shown. Possible values are: "NEVER", "EASY" and "ALWAYS". Example: [grp, 2] showWaypoint "ALWAYS" Category: OFP

side location
Operand types: location: Location Compatibility: Version 2.90 required. Type of returned value: Side Description: Return target side of given location. Category: Location

side unit
Operand types: unit: Object

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 351 of 415

Type of returned value: Side Description: Returns the side of the unit. Example: side player == west Category: OFP

side group
Operand types: group: Group Compatibility: Version 5501 required. Type of returned value: Side Description: Returns the side of the group. Example: side group player == west Category: OFP

unit sideChat chatText
Operand types: unit: Object or Array chatText: String Type of returned value: Nothing Description: Types text to the side radio channel. Note: this function only types text to the list, it does not broadcast the message. If you want the message to show on all computers, you have to execute it on all of them. Example: soldierOne sideChat "Show this text" Category: OFP

sideEnemy
Compatibility: Version 1.78 required. Type of returned value:

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 352 of 415

Side Description: The Enemy side (used for renegades). Category: OFP

sideFriendly
Compatibility: Version 1.78 required. Type of returned value: Side Description: The Friendly side (used for captives). Category: OFP

sideLogic
Compatibility: Version 1.86 required. Type of returned value: Side Description: The Logic side. Category: OFP

unit sideRadio radioName
Operand types: unit: Object or Array radioName: String Type of returned value: Nothing Description: Sends the message to the side radio channel. The message is defined in the description.ext file or radio protocol. Example: soldierOne sideRadio "messageOne" Category: OFP

sideUnknown

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 353 of 415

Compatibility: Version 5501 required. Type of returned value: Side Description: The unknown side. Category: OFP

simpleTasks person
Operand types: person: Object Compatibility: Version 5501 required. Type of returned value: Array Description: Return all simple tasks assigned to given person. Category: Identity

simulationEnabled entity
Operand types: entity: Object Compatibility: Version 5500 required. Type of returned value: Boolean Description: Check if the entity has enabled simulation. Category: OFP

sin x
Operand types: x: Number Type of returned value: Number Description: The sine of x, the argument is in degrees. Example: sin 30 , result is 0.5 Category: Default

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 354 of 415

size location
Operand types: location: Location Compatibility: Version 2.90 required. Type of returned value: Array Description: Return size of given location (width, height). Category: Location

sizeOf typeName
Operand types: typeName: String Compatibility: Version 5160 required. Type of returned value: Number Description: Return the size of the entity of given type. Category: OFP

skill person
Operand types: person: Object Compatibility: Version 1.75 required. Type of returned value: Number Description: Returns the current level of ability of the person. Example: skill player Category: Resistance

vehicle skill type
Operand types: vehicle: Object

http://www.arma2.com/comref/full.html

7/11/2010

Daytime is adjusted. Value of skill may vary from 0 to 1. Duration is in hours.html 7/11/2010 .com/comref/full.5 Category: OFP sliderPosition idc Operand types: idc: Number http://www. Type of returned value: Nothing Description: Suspend execution of script for given time. Type of returned value: Number Description: Returns skill of given type of person (commander unit). Example: sleep 0. Example: hero skill "Endurance" Category: OFP PC skipTime duration Operand types: duration: Number Type of returned value: Nothing Description: Skips the specified time. a weather change is estimated and no changes to any units are done.60 required.BIS Game Engine Scripting Commands Page 355 of 415 type: String Compatibility: Version 2.65 required.arma2. Example: skipTime 2.5 Category: OFP sleep delay Operand types: delay: Number Compatibility: Version 2.

79 required.arma2.92 required.com/comref/full. Example: _pos = sliderPosition _control Category: OFP PC sliderRange idc Operand types: idc: Number Compatibility: Version 1. max]) of the slider with id idc of the topmost user dialog.79 required.BIS Game Engine Scripting Commands Page 356 of 415 Compatibility: Version 1. Type of returned value: Number Description: Returns the current thumb position of the slider with id idc of the topmost user dialog. Type of returned value: Array Description: Returns the limits (as an array [min. Type of returned value: Number Description: Returns the current thumb position of the given slider.html 7/11/2010 . Example: _pos = sliderPosition 101 Category: Resistance sliderPosition control Operand types: control: Control Compatibility: Version 2. Example: _limits = sliderRange 100 Category: Resistance sliderRange control Operand types: control: Control http://www.

Type of returned value: Nothing Description: Sets the current thumb position of the given slider. Example: sliderSetPosition [100.html 7/11/2010 .arma2. pos] Operand types: [idc. pos]: Array Compatibility: Version 1. Example: _limits = sliderRange _control Category: OFP PC sliderSetPosition [idc. Type of returned value: Nothing Description: Sets the current thumb position of the slider with id idc of the topmost user dialog. 0] Category: Resistance control sliderSetPosition pos Operand types: control: Control pos: Number Compatibility: Version 2.BIS Game Engine Scripting Commands Page 357 of 415 Compatibility: Version 2.com/comref/full.92 required. min. Example: _control sliderSetPosition 0 Category: OFP PC sliderSetRange [idc.92 required.79 required. max]) of the given slider. Type of returned value: Array Description: Returns the limits (as an array [min. max] Operand types: http://www.

Type of returned value: Nothing Description: Sets the limits of the slider with id idc of the given slider. 2. 0. Type of returned value: Nothing Description: Sets the speed (a click on the arrow results in a move per line. line. min.html 7/11/2010 . A click on the scale outside the thumb results in a move per page) of the slider with id idc of the topmost user dialog. Example: _control sliderSetRange [0. 0. page]: Array Compatibility: Version 1.79 required. 10] Category: OFP PC sliderSetSpeed [idc. max]: Array Compatibility: Version 1. Example: sliderSetSpeed [100. page] Operand types: [idc. Type of returned value: Nothing Description: Sets the limits of the slider with id idc of the topmost user dialog. Example: sliderSetRange [100.79 required. line. max]: Array Compatibility: Version 2.arma2. page] http://www.BIS Game Engine Scripting Commands Page 358 of 415 [idc. max] Operand types: control: Control [min.5.92 required.com/comref/full. 10] Category: Resistance control sliderSetRange [min.0] Category: Resistance control sliderSetSpeed [line.

arma2. A click on the scale outside the thumb results in a move per page) of the given slider.5.BIS Game Engine Scripting Commands Page 359 of 415 Operand types: control: Control [line. Type of returned value: Array Description: Returns the speed (as an array [line.92 required. Example: _speed = sliderSpeed _control Category: OFP PC someAmmo unit http://www. Type of returned value: Nothing Description: Sets the speed (a click on the arrow results in a move per line. Example: _control sliderSetSpeed [0.com/comref/full. page]) of the given slider. page]) of the slider with id idc of the topmost user dialog.html 7/11/2010 .79 required. Type of returned value: Array Description: Returns the speed (as an array [line.0] Category: OFP PC sliderSpeed idc Operand types: idc: Number Compatibility: Version 1. Example: _speed = sliderSpeed Category: Resistance sliderSpeed control Operand types: control: Control Compatibility: Version 2. page]: Array Compatibility: Version 2. 2.92 required.

BIS Game Engine Scripting Commands Page 360 of 415 Operand types: unit: Object Type of returned value: Boolean Description: Checks whether the unit has some ammo remaining. Example: speed player Category: OFP http://www.com/comref/full. Type of returned value: Script Description: Executes a script.arma2. Category: OFP arguments spawn script Operand types: arguments: Any script: Code Compatibility: Version 2. Argument is passed to the script as local variable _this. Example: someAmmo vehicle player Category: OFP soundVolume Type of returned value: Number Description: Checks the current sound volume (set by setSoundVolume).50 required. Category: OFP speed obj Operand types: obj: Object Type of returned value: Number Description: Returns the object speed (in km/h).html 7/11/2010 .

Example: speedMode group player Category: OFP sqrt x Operand types: x: Number Type of returned value: Number Description: The square root of x. result is 3 Category: Default startLoadingScreen [text] or [text./ step step Operand types: for /.. scripts run at full speed./: for type http://www.html 7/11/2010 . Type of returned value: Nothing Description: Shows loading screen with the given text. When loading screen is shown..com/comref/full. Category: OFP for /. simulation and scene drawing is disabled. using the given resource. Example: sqrt 9 .. resource]: Array Compatibility: Version 5501 required. resource] Operand types: [text] or [text.arma2. "NORMAL" or "FULL").BIS Game Engine Scripting Commands Page 361 of 415 speedMode grp Operand types: grp: Object or Group Type of returned value: String Description: Returns the speed mode of the group ("LIMITED"..

.arma2.00 required.. Use disableAI to get better control over stopping a unit. and set negative.} Category: Default unit stop stop Operand types: unit: Object stop: Boolean Type of returned value: Nothing Description: Stops an AI unit. Example: soldierOne stop true Category: OFP stopped unit Operand types: unit: Object Type of returned value: Boolean Description: Checks whether the unit is stopped using the "stop" command. Example: stopped jeepOne Category: OFP str any value Operand types: any value: Any Compatibility: Version 2. step must be specified.code. This function is obsolete. Example: for "_x" from 20 to 10 step -2 do {.BIS Game Engine Scripting Commands Page 362 of 415 step: Number Type of returned value: for type Description: Optionaly can set step. Type of returned value: http://www. If you want to count down. Default value is 1.html 7/11/2010 .com/comref/full.

if operator is not included in list.binary operator. y] Operand types: [x.com/comref/full."b:ARRAY select BOOL"] Category: Default surfaceIsWater [x.nullary operator. type of input operands is included). `mask` parameter can be empty string. Category: OFP surfaceType [x.html 7/11/2010 . result is ["b:ARRAY select SCALAR". y]: Array Compatibility: Version 2. In this case. y]: Array Compatibility: Version 2. Example: str(2+3) .arma2.58 required. y] Operand types: [x. `mask` can contain wildcards. t:name* or *:*. result is "5" Category: Default supportInfo mask Operand types: mask: String Compatibility: Version 2.BIS Game Engine Scripting Commands Page 363 of 415 String Description: Converts any variable to a string. 'n' . 'b' . function returns empty array.unary operator. for example: *:name. t:*. Type of returned value: Array Description: Creates list of supported operators and type. or one of field.58 required. Type of returned value: Boolean Description: Returns whether water is on given position. Example: supportInfo "b:select*" . http://www.00 required.type. Each field of array has format: "x:name" where x is 't' . 'u' . 'name' is operator's/type's name (in case operator.

BIS Game Engine Scripting Commands

Page 364 of 415

Type of returned value: String Description: Returns what surface is on given position. Category: OFP

switch exp
Operand types: exp: Any Type of returned value: Switch Type Description: Begins switch form Example: switch (_a) do { case 1: {block}; case 2 : {block}; default {block};} Category: Default

switchableUnits
Compatibility: Version 2.92 required. Type of returned value: Array Description: Return a list of units accessible through team switch. Category: OFP

soldier switchAction action
Operand types: soldier: Object action: String Compatibility: Version 5500 required. Type of returned value: Nothing Description: When used on a person, the given action is started immediately (there is no transition). Use switchmove "" to switch back to the default movement if there is no transition back, otherwise the person may be stuck. Example: soldierOne switchAction "SitDown"

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 365 of 415

Category: OFP

unit switchCamera mode
Operand types: unit: Object mode: String Type of returned value: Nothing Description: Switches the camera to the given vehicle / camera. Mode is one of: "INTERNAL" (1st person), "GUNNER" (optics / sights), "EXTERNAL" (3rd person) or "GROUP" (group). Example: sniperOne switchCamera "gunner" Category: OFP

soldier switchGesture moveName
Operand types: soldier: Object moveName: String Compatibility: Version 5500 required. Type of returned value: Nothing Description: When used on a person, the given move is started immediately (there is no transition). Example: soldierOne switchGesture "Wave" Category: OFP

lamppost switchLight mode
Operand types: lamppost: Object mode: String Type of returned value: Nothing Description: Controls the lamppost mode. Mode may be "ON", "OFF" and "AUTO". "AUTO" is default and means the lampost is only on during nighttime. Example:

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 366 of 415

nearestObject [player, "StreetLamp"] switchLight "Off" Category: OFP

soldier switchMove moveName
Operand types: soldier: Object moveName: String Type of returned value: Nothing Description: When used on a person, the given move is started immediately (there is no transition). Use switchmove "" to switch back to the default movement if there is no transition back, otherwise the person may be stuck. Example: soldierOne switchMove "FXStandDip" Category: OFP

synchronizedObjects unit
Operand types: unit: Object Compatibility: Version 5501 required. Type of returned value: Array Description: Return the list of objects synchronized with the given unit. Category: OFP

unit synchronizeObjectsAdd [objects]
Operand types: unit: Object [objects]: Array Compatibility: Version 5501 required. Type of returned value: Nothing Description: Add given objects to the unit's list of synchronized objects. Category: OFP

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 367 of 415

unit synchronizeObjectsRemove [objects]
Operand types: unit: Object [objects]: Array Compatibility: Version 5501 required. Type of returned value: Nothing Description: Remove given objects from the unit's list of synchronized objects. Category: OFP

trigger synchronizeTrigger [waypoint1, waypoint2, ...]
Operand types: trigger: Object [waypoint1, waypoint2, ...]: Array Compatibility: Version 1.86 required. Type of returned value: Nothing Description: Synchronizes the trigger with waypoints. Each waypoint is given as an array [group, index]. Example: trigger synchronizeWaypoint [] Category: OFP

waypoint synchronizeWaypoint [waypoint1, waypoint2, ...]
Operand types: waypoint: Array [waypoint1, waypoint2, ...]: Array Compatibility: Version 1.86 required. Type of returned value: Nothing Description: Synchronizes the waypoint with other waypoints. Each waypoint is given as an array [group, index]. Example: [group1, 2] synchronizeWaypoint [[group2, 3]] Category: OFP

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 368 of 415

trigger synchronizeWaypoint [waypoint1, waypoint2, ...]
Operand types: trigger: Object [waypoint1, waypoint2, ...]: Array Compatibility: Version 1.86 required. Type of returned value: Nothing Description: Synchronizes the trigger with waypoints. Each waypoint is given as an array [group, index]. Example: trigger synchronizeWaypoint [] Category: OFP

tan x
Operand types: x: Number Type of returned value: Number Description: The tangens of x, the argument is in degrees. Example: tan 45 , result is 1 Category: Default

[speaker, side, unit, place, time] targetsAggregate candidates
Operand types: [speaker, side, unit, place, time]: Array candidates: Array Compatibility: Version 2.92 required. Type of returned value: Array Description: Aggregate candidates. Category: Conversations

speaker targetsQuery [receiver, side, unit, place, time]
Operand types:

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 369 of 415

speaker: Object [receiver, side, unit, place, time]: Array Compatibility: Version 2.92 required. Type of returned value: Array Description: Find all targets known to sender matching given query. Category: Conversations

taskChildren task
Operand types: task: Task Compatibility: Version 2.92 required. Type of returned value: Array Description: Return the child tasks of the specified task. Category: Identity

taskCompleted task
Operand types: task: Task Compatibility: Version 2.89 required. Type of returned value: Boolean Description: Return if task is completed. (state Succeeded, Failed or Canceled) Category: Identity

taskDescription task
Operand types: task: Task Compatibility: Version 5501 required. Type of returned value: Array Description: Returns the descripction of the task.

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 370 of 415

Category: Identity

taskDestination task
Operand types: task: Task Compatibility: Version 2.92 required. Type of returned value: Array Description: Returns the position of the task (as specified by destination parameter in config). Category: Identity

taskHint text
Operand types: text: Array Type of returned value: Nothing Description: Shows info about new,changed or failed task. The text can contain several lines. \n is used to indicate the end of a line. Example: taskHint "Capture town." Category: OFP

taskNull
Compatibility: Version 5153 required. Type of returned value: Task Description: A non-existing task. This value is not equal to anything, including itself. Example: taskNull == taskNull , result is false Category: Identity

taskParent task

http://www.arma2.com/comref/full.html

7/11/2010

BIS Game Engine Scripting Commands

Page 371 of 415

Operand types: task: Task Compatibility: Version 2.92 required. Type of returned value: Task Description: Return the parent task of the specified task. Category: Identity

taskResult task
Operand types: task: Task Compatibility: Version 2.92 required. Type of returned value: Array Description: Return the result of the given task. Category: Identity

taskState task
Operand types: task: Task Compatibility: Version 2.89 required. Type of returned value: String Description: Return the state of the given task. Category: Identity

teamSwitch
Compatibility: Version 2.92 required. Type of returned value: Nothing Description: Invoke the team switch dialog (force it even when conditions are noy met). Category: OFP

http://www.arma2.com/comref/full.html

7/11/2010

Category: Location text text Operand types: text: String Compatibility: Version 2. Type of returned value: Structured text Description: Creates a structured text containing the given plain text.01 required.90 required.50 required. http://www.arma2.BIS Game Engine Scripting Commands Page 372 of 415 teamSwitchEnabled Compatibility: Version 2. Category: OFP terminate script Operand types: script: Script Compatibility: Version 2.com/comref/full.html 7/11/2010 . Type of returned value: String Description: Return text attached to given location. Type of returned value: Nothing Description: Terminate (abort) the script Category: OFP text location Operand types: location: Location Compatibility: Version 2. Type of returned value: Boolean Description: Check if tam switch is currently enabled.92 required.

85 required.{c=2}] http://www." Category: OFP textLog anything Operand types: anything: Any Type of returned value: Nothing Description: Dumps the argument value into the debugging output. Example: textLog player Category: OFP tg x Operand types: x: Number Type of returned value: Number Description: The tangens of x. Example: tg 45 . Type of returned value: Any Description: The first or second element of the array is executed depending on the result of the if condition. the argument is in degrees. result is 1 Category: Default if then else Operand types: if: If Type else: Array Compatibility: Version 1.html 7/11/2010 . The result of the executed expression is returned as a result (the result may be nothing).com/comref/full.BIS Game Engine Scripting Commands Page 373 of 415 Example: txt2 = text "Hello world. Example: if (a>b) then {c=1} else {c=2}.if (a>b) then [{c=1}.arma2.

Example: if (a>b) then {c=1} Category: Default throw expression Operand types: expression: Any Type of returned value: Nothing Description: Throws an exception. Category: OFP titleCut effect http://www. See try. Example: throw "invalid argument" Category: Default time Type of returned value: Number Description: Returns the time that elapsed since the mission started (in seconds). The exception is processed by first catch block. nothing is returned. If the code is not executed. If the code is executed.85 required.arma2.BIS Game Engine Scripting Commands Page 374 of 415 Category: Default if then codeToExecute Operand types: if: If Type codeToExecute: Code Compatibility: Version 1. Type of returned value: Any Description: The code is executed when the if condition is met. the last value calculated in the code is returned.com/comref/full.html 7/11/2010 .

speed] or ["name". If speed is not http://www.the argument uses format ["text"."type". Example: titleFadeIn 1.speed] or ["name".the argument uses format ["name"."type". The object can be defined in the description."type"]. Example: titleObj ["BISLogo".html 7/11/2010 ."type"].ext file. Category: OFP titleFadeOut duration Operand types: duration: Number Compatibility: Version 5126 required.arma2.com/comref/full. If speed is not given.0 Category: OFP titleObj effect Operand types: effect: Array Type of returned value: Nothing Description: Object title . it's assumed to be one. Type of returned value: Nothing Description: Terminate the title effect and set duration of the fade out phase to the given time.BIS Game Engine Scripting Commands Page 375 of 415 Operand types: effect: Array Type of returned value: Nothing Description: Obsolete."plain"] Category: OFP titleRsc effect Operand types: effect: Array Type of returned value: Nothing Description: Resource title .

com/comref/full.ext file. If speed is not given. "PLAIN"] Category: OFP titleText effect Operand types: effect: Array Type of returned value: Nothing Description: Text title . http://www..html 7/11/2010 ."type"]. Resource can be defined in the description.BIS Game Engine Scripting Commands Page 376 of 415 given.} Category: Default toArray string Operand types: string: String Compatibility: Version 5195 required."type". Example: for "_x" from 10 to 20 do {. "PLAIN"] Category: OFP for "_var" from a to b Operand types: for "_var" from a: for type b: Number Type of returned value: for type Description: Continue sequence of 'for' command.code. Example: titleText ["Show this text".arma2.. it's assumed to be one.speed] or ["text". it's assumed to be one. Example: titleRsc ["BIS". Type of returned value: Array Description: Convert the string to the array of characters.the argument uses format ["text".

result is "ArmA" Category: Default toUpper string Operand types: string: String Compatibility: Version 5195 required. result is [65. Type of returned value: String Description: Convert the array of characters to the string. Type of returned value: String Description: Convert the string to lower case. Example: toString [65. 109. 109. 65] .arma2. Type of returned value: String Description: Convert the string to upper case.com/comref/full. Example: toLower "ArmA" .html 7/11/2010 .BIS Game Engine Scripting Commands Page 377 of 415 Example: toArray "ArmA" . 114. 65] Category: Default toLower string Operand types: string: String Compatibility: Version 5195 required. 114. http://www. result is "arma" Category: Default toString characters Operand types: characters: Array Compatibility: Version 5195 required.

arma2. Type of returned value: Boolean Description: Returns true if the trigger has been activated. Category: OFP triggerActivation trigger Operand types: trigger: Object Compatibility: Version 5501 required. Type of returned value: Array Description: Returns trigger activation in the form [by.html 7/11/2010 .BIS Game Engine Scripting Commands Page 378 of 415 Example: toUpper "ArmA" .com/comref/full. b. Type of returned value: Array Description: Returns trigger area in the form [a. rectangle] Category: OFP triggerAttachedVehicle trigger http://www. type. repeating] Category: OFP triggerArea trigger Operand types: trigger: Object Compatibility: Version 5501 required. angle. result is "ARMA" Category: Default triggerActivated trigger Operand types: trigger: Object Compatibility: Version 5501 required.

the trigger is detached from the assigned vehicle.86 required. "LEADER" or "MEMBER". otherwise it's attached to the vehicle and the source is changed to "VEHICLE". Example: trigger triggerAttachVehicle [player] Category: OFP http://www. Type of returned value: Object Description: Returns vehicle attached to the trigger (for example using triggerAttachVehicle) Category: OFP trigger triggerAttachObject objectId Operand types: trigger: Object objectId: Number Compatibility: Version 1. Type of returned value: Nothing Description: If [] is given. "LEADER" or "MEMBER". If the activation source is "VEHICLE". the trigger is attached to the vehicle or its group.html 7/11/2010 .com/comref/full.arma2. When the source is "GROUP". Type of returned value: Nothing Description: Assigns a static object to the trigger. Example: trigger triggerAttachObject 1234 Category: OFP trigger triggerAttachVehicle [] or [vehicle] Operand types: trigger: Object [] or [vehicle]: Array Compatibility: Version 1. The activation source is changed to "STATIC".BIS Game Engine Scripting Commands Page 379 of 415 Operand types: trigger: Object Compatibility: Version 5101 required.86 required. it's attached to the group. "GROUP". If [vehicle] is given. it's changed to "NONE".

desactiv] Category: OFP triggerText trigger Operand types: trigger: Object Compatibility: Version 5501 required. Type of returned value: String Description: http://www.BIS Game Engine Scripting Commands Page 380 of 415 triggerStatements trigger Operand types: trigger: Object Compatibility: Version 5501 required. Type of returned value: String Description: Returns trigger text. max.arma2. Category: OFP triggerTimeout trigger Operand types: trigger: Object Compatibility: Version 5501 required.html 7/11/2010 . interruptable] Category: OFP triggerType trigger Operand types: trigger: Object Compatibility: Version 5501 required. activ. Type of returned value: Array Description: Returns trigger timeout in the form [min. mid. Type of returned value: Array Description: Returns trigger statements in the form [cond.com/comref/full.

that can throw exception } catch{ //block.html 7/11/2010 . Any thrown exception in try block is caught in catch block. Type of returned value: Object Description: Returns the unit in the vehicle turret.com/comref/full. This is structured exception block.BIS Game Engine Scripting Commands Page 381 of 415 Returns trigger type. that process an exception. The structured exception block has following formtry //begin of try-catch block { //block. Category: OFP true Type of returned value: Boolean Description: Always true. Category: OFP type task Operand types: task: Task Compatibility: http://www.arma2. Category: Default try code Operand types: code: Code Type of returned value: Exception Type Description: Defines try-catch structure. Exception is described in _exception variable }. Category: Default vehicle turretUnit turret path Operand types: vehicle: Object turret path: Array Compatibility: Version 5501 required.

90 required. Type of returned value: String Description: Returns the name of the type of the given object.00 required. Type is returned as string Example: typeName "hello" . Category: Identity type location Operand types: location: Location Compatibility: Version 2.com/comref/full. Type of returned value: String Description: Return the type of the task. Type of returned value: String Description: Returns type-name of expression. Category: Location typeName any Operand types: any: Any Compatibility: Version 2.91 required.arma2. result is "string" Category: Default typeOf object Operand types: object: Object Compatibility: Version 1.BIS Game Engine Scripting Commands Page 382 of 415 Version 2.91 required.html 7/11/2010 . Type of returned value: String Description: Return type of given location. http://www.

Category: OFP unassignTeam vehicle Operand types: vehicle: Object Compatibility: Version 2.html 7/11/2010 . the group leader will issue an order to disembark. This is equal to vehicle assignTeam "MAIN".arma2.com/comref/full. Type of returned value: Namespace Description: Return the global namespace attached to user interface. Example: unassignTeam soldier2 Category: OFP unassignVehicle unit Operand types: unit: Object Type of returned value: Nothing Description: The person is unassigned from the vehicle. Example: unassignVehicle player Category: OFP http://www.05 required. result is "SoldierWB" Category: OFP uiNamespace Compatibility: Version 5501 required. If he is currently inside. Type of returned value: Nothing Description: Unassigns the vehicle (its commander unit) from his team.BIS Game Engine Scripting Commands Page 383 of 415 Example: typeOf player .

Type of returned value: String Description: Return the unit position rules. Example: unitReady player Category: OFP units unit Operand types: unit: Object Type of returned value: Array Description: Returns an array with all the units in the group of the given object. until the command is finished. Category: OFP unitReady unit Operand types: unit: Object or Array Type of returned value: Boolean Description: Checks whether the unit is ready.html 7/11/2010 .arma2. Example: player in units player Category: OFP units grp Operand types: grp: Group Type of returned value: http://www.com/comref/full.92 required. For a destroyed object an empty array is returned. A unit is busy when it's given an order like "move".BIS Game Engine Scripting Commands Page 384 of 415 unitPos person Operand types: person: Object Compatibility: Version 2.

angle. Category: OFP teamMember unregisterTask name Operand types: teamMember: name: String Compatibility: Version 2. width. Category: Identity map updateDrawIcon [object.BIS Game Engine Scripting Commands Page 385 of 415 Array Description: Returns an array with all the units in the group. http://www. maintain size?. height. Type of returned value: Boolean Description: Unregister a task type. width. Type of returned value: Nothing Description: Updates the icon to be shown in 2D editor for the specified editor object. maintain size?.html 7/11/2010 . Type of returned value: Boolean Description: Unlock the given achievement.90 required.com/comref/full. offset. Example: player in units group player Category: OFP unlockAchievement name Operand types: name: String Compatibility: Version 5501 required. offset. string identifier. height.arma2. string identifier. If maintain size is false. angle. shadow]: Array Compatibility: Version 2. color. color. shadow] Operand types: map: Control [object.92 required.

command]: Array Compatibility: Version 2.command] Operand types: map: Control [menu item index. Example: player useAudioTimeForMoves true Category: OFP http://www. Category: Editor updateObjectTree map Operand types: map: Control Compatibility: Version 2.text. Type of returned value: Nothing Description: Sets the text and command for the menu item. the icon will maintain size if map scale is below that number.text. command is optional.92 required. Used for audio/animation synchronization. Type of returned value: Nothing Description: Update the editor object tree.92 required.BIS Game Engine Scripting Commands Page 386 of 415 icon will not scale depending on the scale of the map. Category: Editor soldier useAudioTimeForMoves toggle Operand types: soldier: Object toggle: Boolean Type of returned value: Nothing Description: Switch between elapsed gamet time and audio time being used as animation timer.arma2.html 7/11/2010 . If maintain size is a number.com/comref/full. Category: Editor map updateMenuItem [menu item index. index is index as returned from addMenuItem command.

Category: OFP vectorUp obj Operand types: obj: Object Compatibility: Version 2.com/comref/full.61 required. z. Type of returned value: Array Description: Return object's direction vector in world coordinates as [x. y]. Example: vehicle player != player Category: OFP unit vehicleChat chatText Operand types: unit: Object chatText: String Type of returned value: http://www.html 7/11/2010 .BIS Game Engine Scripting Commands Page 387 of 415 vectorDir obj Operand types: obj: Object Compatibility: Version 2. z. y]. the unit is returned. Category: OFP vehicle unit Operand types: unit: Object Type of returned value: Object Description: Returns the vehicle in which the given unit is mounted.arma2. Type of returned value: Array Description: Return object's up vector in world coordinates as [x.61 required. If there is none.

you have to execute it on all of them. it does not broadcast the message.BIS Game Engine Scripting Commands Page 388 of 415 Nothing Description: Types text to the vehicle radio channel.92 required. Note: this function only types text to the list.arma2. Type of returned value: Array Description: http://www. Example: _vehicles = vehicles Category: OFP vehicles Compatibility: Version 2.com/comref/full. If you want the message to show on all computers.html 7/11/2010 . Example: soldierOne vehicleChat "Show this text" Category: OFP unit vehicleRadio radioName Operand types: unit: Object radioName: String Type of returned value: Nothing Description: Sends the message to the vehicle radio channel. The message is defined in the description.ext file or radio protocol.92 required. Type of returned value: Array Description: Return a list of vehicles in the current mission. Example: soldierOne vehicleRadio "messageOne" Category: OFP vehicles Compatibility: Version 2.

BIS Game Engine Scripting Commands Page 389 of 415 Return a list of vehicles in the current mission.91 required. z.html 7/11/2010 . Category: OFP verifySignature filename Operand types: filename: String Compatibility: Version 2.arma2. Example: _vehicles = vehicles Category: OFP vehicleVarName object Operand types: object: Object Compatibility: Version 2. y]. Type of returned value: Boolean Description: Check if file is signed by an accepted key. Type of returned value: Array Description: Returns the velocity (speed vector) of the vehicle as an array with format [x.80 required. Type of returned value: String Description: Returns the name of the variable which contains a reference to this object.com/comref/full.91 required. Category: OFP http://www. Category: OFP velocity vehicle Operand types: vehicle: Object Compatibility: Version 1.

waitUntil {_i = _i + 1.arma2.60 required.html 7/11/2010 .com/comref/full. Category: OFP visibleMap Compatibility: Version 5501 required. Type of returned value: Nothing Description: Suspend execution of script until condition is satisfied. http://www. Category: OFP waitUntil condition Operand types: condition: Code Compatibility: Version 2.BIS Game Engine Scripting Commands Page 390 of 415 viewDistance Compatibility: Version 5501 required. Example: _i = 0. Type of returned value: Boolean Description: Return true if the main map is shown (active). _i >= 100} Category: Default waypointAttachedObject waypoint Operand types: waypoint: Array Compatibility: Version 5500 required. Type of returned value: Number Description: Returns the rendering distance. Type of returned value: Object Description: Gets the object attached to the waypoint.

86 required. Type of returned value: Object Description: Gets the vehicle attached to the waypoint. Type of returned value: Nothing http://www. Type of returned value: Nothing Description: Attaches a static object to the given waypoint.arma2.BIS Game Engine Scripting Commands Page 391 of 415 Example: waypointAttachedObject [groupOne. 1] Category: OFP waypoint waypointAttachObject idStatic or object Operand types: waypoint: Array idStatic or object: Compatibility: Version 1. Example: waypointAttachedVehicle [groupOne.86 required.com/comref/full. 1] Category: OFP waypointAttachedVehicle waypoint Operand types: waypoint: Array Compatibility: Version 5500 required. 2] waypointAttachObject 1234 Category: OFP waypoint waypointAttachVehicle vehicle Operand types: waypoint: Array vehicle: Object Compatibility: Version 1.html 7/11/2010 . Example: [grp.

BIS Game Engine Scripting Commands Page 392 of 415 Description: Attaches a vehicle to the given waypoint. Example: waypointCombatMode [groupOne. Type of returned value: Number http://www. 1] Category: OFP waypointCompletionRadius waypoint Operand types: waypoint: Array Compatibility: Version 5500 required. Type of returned value: String Description: Gets the waypoint behavior.html 7/11/2010 . 1] Category: OFP waypointCombatMode waypoint Operand types: waypoint: Array Compatibility: Version 5500 required.com/comref/full. 2] waypointAttachVehicle vehicle player Category: OFP waypointBehaviour waypoint Operand types: waypoint: Array Compatibility: Version 5500 required. Type of returned value: String Description: Gets the waypoint combat mode.arma2. Example: [grp. Example: waypointBehaviour [groupOne.

1] Category: OFP waypointFormation waypoint Operand types: waypoint: Array Compatibility: Version 5500 required.arma2. 1] Category: OFP waypointDescription waypoint Operand types: waypoint: Array Compatibility: Version 5500 required.html 7/11/2010 .BIS Game Engine Scripting Commands Page 393 of 415 Description: Gets the radius around the waypoint where is the waypoint completed.com/comref/full. 1] Category: OFP waypointHousePosition waypoint Operand types: waypoint: Array Compatibility: Version 5500 required. Example: waypointDescription [groupOne. Type of returned value: String Description: Gets the waypoint formation. Example: waypointFormation [groupOne. Example: _radius = waypointCompletionRadius [groupOne. Type of returned value: String Description: Gets the waypoint description. Type of returned value: Number http://www.

Example: waypointPosition [groupOne. 1] Category: OFP waypoints group Operand types: group: Object or Group Compatibility: Version 5129 required. http://www. 1] Category: OFP waypointPosition waypoint Operand types: waypoint: Array Compatibility: Version 1. Type of returned value: String Description: Gets the waypoint script.50 required. Type of returned value: Array Description: Return the list of waypoints for given group.BIS Game Engine Scripting Commands Page 394 of 415 Description: Gets the house position assigned to the waypoint.arma2. Note: this function is identical to getWaypointPosition. Category: OFP waypointScript waypoint Operand types: waypoint: Array Compatibility: Version 5500 required.com/comref/full.html 7/11/2010 . Type of returned value: Array Description: Gets the waypoint position. Example: waypointHousePosition [groupOne. Waypoint uses format Waypoint.

arma2. Example: waypointShow [groupOne. 1] Category: OFP waypointSpeed waypoint Operand types: waypoint: Array Compatibility: Version 5500 required. Type of returned value: Array Description: Gets the waypoint statements. Example: waypointSpeed [groupOne.BIS Game Engine Scripting Commands Page 395 of 415 Example: waypointScript [groupOne.html 7/11/2010 . Type of returned value: String Description: Gets the waypoint show/hide status. http://www. 1] Category: OFP waypointShow waypoint Operand types: waypoint: Array Compatibility: Version 5500 required.com/comref/full. Type of returned value: String Description: Gets the waypoint speed. 1] Category: OFP waypointStatements waypoint Operand types: waypoint: Array Compatibility: Version 5500 required.

com/comref/full. Example: waypointTimeout [groupOne. 1] Category: OFP vehicle weaponDirection weaponName Operand types: vehicle: Object weaponName: String Compatibility: Version 2. Type of returned value: Array Description: Gets the waypoint timeout values.BIS Game Engine Scripting Commands Page 396 of 415 Example: waypointStatements [groupOne. 1] Category: OFP waypointTimeout waypoint Operand types: waypoint: Array Compatibility: Version 5500 required. Type of returned value: Array Description: http://www.61 required. Example: waypointType [groupOne.arma2. Type of returned value: String Description: Gets the waypoint type. 1] Category: OFP waypointType waypoint Operand types: waypoint: Array Compatibility: Version 5500 required.html 7/11/2010 .

Type of returned value: Array Description: Returns an array of names of all the vehicle's weapons.com/comref/full.75 required. Type of returned value: While Type Description: The first part of the while contruct. Category: OFP while condition Operand types: condition: Code Compatibility: Version 1.85 required. Example: weapons player Category: Resistance west Type of returned value: Side Description: The West side.html 7/11/2010 .BIS Game Engine Scripting Commands Page 397 of 415 Returns direction where is given weapon aiming. Example: while "x<10" do {x=x+1} Category: Default http://www. Example: _dir = _vehicle weaponDirection "M16" Category: OFP weapons vehicle Operand types: vehicle: Object Compatibility: Version 1.arma2.

Type of returned value: Array Description: Return the current wind vector.arma2. Category: OFP with namespace Operand types: namespace: Namespace Compatibility: Version 5501 required.92 required.com/comref/full.92 required. Type of returned value: String Description: Return the name of the currently loaded world. Type of returned value: Array Description: http://www.html 7/11/2010 .92 required.BIS Game Engine Scripting Commands Page 398 of 415 wind Compatibility: Version 2. Type of returned value: With Type Description: The first part of the with contruct. Category: OFP object worldToModel worldPos Operand types: object: Object worldPos: Array Compatibility: Version 2. Example: with missionNamespace do {global=global+1} Category: Default worldName Compatibility: Version 2.

html 7/11/2010 . http://www. Type of returned value: Array Description: Converts position in world space into screen (UI) space. Array Description: An array of items. including nothing. Category: OFP Any Description: Anyhing .com/comref/full. Anything Description: Anything. Boolean Description: Boolean (true or false).any value. Category: OFP worldToScreen position Operand types: position: Array Compatibility: Version 5501 required.arma2. each may be of any type. Any Value Description: Any value.BIS Game Engine Scripting Commands Page 399 of 415 Converts position from world space to object model space.

Group http://www.":updatePhase:"] do {.com/comref/full. for type Description: This type handles for cycles..code.}.BIS Game Engine Scripting Commands Page 400 of 415 Code Description: Part of code (compiled). Exception Type Description: A helper type used in try-catch constructs.arma2. Diary record Description: Diary record. Control Description: Control UI object..code...":condition:"...html 7/11/2010 . Usage of this type: for "_var" from :expr: to :expr: [step <expr>] do {.}.Second usage: for [":initPhase:". Config Description: Config file entry. Display Description: Display UI object.

Object Description: A game object (like a soldier.then constructs. If Type Description: A helper type used in if. Nothing Description: Nothing . vehicle or building).set of variables. http://www..no value. Location Description: Location.html 7/11/2010 . Number Description: A real number.arma2. Number or Nothing Description: Number or Nothing. Namespace Description: Namespace .com/comref/full.BIS Game Engine Scripting Commands Page 401 of 415 Description: A group.

String or Array Description: String or Array. Object or Group Description: Object or group. If you pass a group. Object or String Description: Object or String.BIS Game Engine Scripting Commands Page 402 of 415 Object or Array Description: Object or Array. east.arma2. its leader is considered.html 7/11/2010 . http://www. civilian and resistance). String Description: An ASCII string. Orientation Description: Script Description: Side Description: The name of the side (see west.com/comref/full.

Target Description: Task Description: Task. Structured text Description: Switch Type Description: A helper type used in switch constructs.com/comref/full.arma2.html 7/11/2010 . Text or String Description: Text or String.BIS Game Engine Scripting Commands Page 403 of 415 String or Code Description: String or Code. Transformation Description: Vector http://www.

Rubbing.Float number without dimension which determines the impact of the density od the enviroment on this particle. a] Description: Color. With Type Description: A helper type used in while. TimerPeriod . Volume . RotationVelocity. Weight.Float number which determines number of rotations in one second.do constructs. OnTimer. Random parameters: RandomDirectionPeriod . TimerPeriod. MoveVelocity . Category: OFP ParticleArray Format: [ShapeName. AnimationName Name of the animation of the shape. BeforeDestroy.BIS Game Engine Scripting Commands Page 404 of 415 Description: While Type Description: A helper type used in while. Position. Object.no impact (vacuum). b.do constructs. Weight .Name of the shape associated with the particle. {angle}] Description: Global parameters: ShapeName . Type . RandomDirectionPeriod.3D vector (xyz) which describes the velocity vector of the particle (direction and speed in m/s). Color . Color. The rest od the values during the life time will be lineary interpolated.Life time of the particle (in sec).Type of the particle (either "Billboard" or "SpaceObject"). RandomDirectionIntensity. All of them are fon interval [0. RotationVelocity .I.com/comref/full..transparancy).Either 3D coordinate (xzy) or name of the selection .. F. Type. 0 .The period of calling the "OnTimer" event (in sec).Color of the particle in time to render (RGBA). Size .Period of changing the velocity vector (s). b intensity of blue and a alpha (1 . Size. LifeTime . if you set the array [1.Weight of the particle (in kg). g intensity of green. AnimationName. Color Format: [r. Volume.html 7/11/2010 . Render parameters: Note that all these values are set as arrays to show their development in time. RandomDirectionIntensity - http://www. r is intensity of red.Phase of the animation in time.2] as a size then at the beginning the size of the particle will be 1 and at the end of the life time of the particle it's size will be 2.Size of the particle in time to render (m). g. MoveVelocity.arma2. LifeTime. AnimationPhase. 1].in this case the Object property must be set. AnimationPhase .Volume of the particle (in m^3). Physical parameters: Position . Rubbing .

Category: OFP Position2D Format: [x.y] Description: Position. x coordinates are from East to West.z] or [x.z] Description: x coordinates are from East to West. z coordinates are from South to North. Position of the particle is stored in "this" variable.com/comref/full.Name of the script to run right before destroying the particle.y] Description: Position. Category: OFP http://www.BIS Game Engine Scripting Commands Page 405 of 415 Each MoveVelocity component will be changed with random value from interval <0.Name of the script to run every period determined by TimerPeriod property. z coordinates are from South to North.html 7/11/2010 . Object . Category: OFP PositionASL Format: [x. y is the height above ground and the default y is 0.Object to bind this particle to. Category: OFP Waypoint Format: [group. z coordinates are from South to North.arma2. index selects the waypoint (index 0 selects the first waypoint which is always created on the group starting position). OnTimer . Position of the particle is stored in "this" variable.z. Category: OFP Position Format: [x.index] Description: Group is of type Group. BeforeDestroy . y is the height above see level.z. RandomDirectionIntensity>. x coordinates are from East to West.

r.sqs .BIS Game Engine Scripting Commands Page 406 of 415 Array assignment Assignments used on arrays assign only a pointer to the same array to the target variable. Each handler receives arguments in _this.argument: end # .launched when the mission is finished (before the debriefing screen.no arguments initIntro.com/comref/full. after executing a = b both a and b represent the same array. gunner] . Code is passed to them as a string and they interpret it as code if they wish. You can force creating a copy of an array by using the unary operator +Array. Some of them have a name given by the mission designer (scripted waypoint. "Killed" object:killer "Hit" object:causedBy.arguments: [[r. Multiple handlers can be attached at one time. One particular situation that can lead to this behaviour is aList = list sensor_name.sqs .launched when the intro is started (since 1.sqs . we recommend to use curled braces for code only. b].launched when an illuminating shell is lit(since 1.object:unit http://www.scalar:howMuch "Engine" bool:engineState "GetIn" string:position (1).html 7/11/2010 . g. Other argument types and meaning are defined below.arma2. if and while) use the concept of "code strings".45) .50) or user action scripts). since 1. moreover future versions of the scripting language may precompile code enclosed in curled braces.sqs . g.number of game endings onFlare. While both ways are currently equivalent and a string constant is created.50) . The event handler types are defined below. Since 1.50) . a is changed as well. Event based scripts There are some scripts in the game which are launched when a particular event occured. b is the light color Event handlers Event handlers can be defined in a unit config or by function addEventHandler.launched when the mission is started (before the briefing screen) . as this makes scripts easier to read. init.no arguments exit. _this select 0 is always the source of the event. Names of others are given by the program. When b is an array. particle scripts (since 1.85 string constants can be written in two ways: using double quotes (like "Hello") or curled braces (like {a=a+1}). Code strings Many languague constructs (including forEach. When b is changed.

html 7/11/2010 . _a = _this select 0.object:whoFired "Dammaged" string:selectionName. "gunner". it is considered to be equivalent to a space. Main language contructs used in functions are: if.string:mode.BIS Game Engine Scripting Commands Page 407 of 415 "GetOut" string:position (1). "commander". Example 1 (max. Scripts can wait suspended until a certain condition it met and they can also use goto to change the execution point at any time.. _b = _this select 1.do Curled braces Multiple commands (including assigment commands) delimited with a semicolon The result of the last expression evaluated is returned as a function result.com/comref/full..arma2.. Semicolon is therefore required even when ending a line. This can be nothing when a function returns no value.string:muzzle. "cargo" MP notes: "Killed" and "Hit" event handlers are executed where the given unit is local. Functions .else while. then. do) is based on structured expressions and end-of-line has no special meaning.scalar:howMuch "Gear" bool:gearState "Fuel" bool:fuelState "Init" No arguments (1) position can be "driver". if (_a>_b) then {_a} else {_b} Example 2 (infantrySafe."_b"}. private {"_a".then.sqf) comment "Switch all infantry units to safe mode". { if (vehicle _x == _x) then { _x setBehaviour "safe" } } forEach _this http://www. functions (see call. Note: scripts can do some things that are not possible in functions. Events added by addEventHandler may be different on each computer.sqf) comment "Return the maximum of the first and second argument". All other event handlers are executed on all computers.object:unit "Fired" string:weapon.SQF While script syntax (see exec) is line based.string:ammo "IncomingMissile" string:ammo.

Example: @condition Waiting for a time: line starting with '&'. Local variables A local variable is any variable which name starts with an underscore. &__waitUntil Command: any expression returning no value. Example: #LabelName Waiting for a condition: line starting with '@'. Example: &endTime is equivalent to @_time >= (endTime) Delay: line starting with '~'. Example: . the command is executed only when the condition is satisfied. If assignment is made into a variable that does not exist in any visible scope. A local variable name starts with an underscore ('_').SQF (as opposed to . while. To overcome this limitation you can store multiline in separate files and load them using the loadFile or preprocessFile functions (the second uses a C-like preprocessor with // or /* */ comments and #define macros).com/comref/full. Example: _a = 10 Conditional: ? condition : command or assignmented. Each of the commands then.'.html 7/11/2010 .arma2. Script syntax Each script line may be one of the following: Comment: line starting with '. it is created in the innermost scope. The recommended file extension for functions is . Variables starting with two underscores are reserved and should never be used. Example: ~delay is equivalent to __waitUntil = _time+(cas) . All local variables from outer scopes are visible as well.This is comment Label: line starting with '#'. count. You can use function private to introduce variables at any given scope. http://www. Example: ?_condVar>10:_var=_var+2 Note: variable _time is reserved. do. All other variables are global.BIS Game Engine Scripting Commands Page 408 of 415 Due to the line-based nature of scripts it is not possible to create multiline string constants in them. exec and call define a visibility scope for local variables.SQS used for scripts). It is used to keep the time elapsed since the script execution started. forEach. Example: _unit setBehaviour "safe" Assignment: assignment of any value to variable. Local variables can be used during script execution to avoid variable conflicts.

Condition must return a boolean value. Variables may be unitialized by assigning it the nil value. This effectively destroys the variable as if it never existed. Array variable thisList is set to the list of all units in the group that the given waypoint is assigned to. Boolean variable this is set during evaluation of the condition expression to the primary sensor activation condition. Variable denoting trigger can be created by filling in the name field.com/comref/full. Vehicle Config entry: CfgVehicles Value All Logic Land Car Motorcycle Tank APC Man Civilian Civilian2 Civilian3 Description any vehicle game logic invisible unit ground vehicle + + + + http://www. the whole expression results nil (an undefined value). Waypoints The Condition expression is used to determine when the waypoint execution is terminated.arma2. it is converted to false. When an undefined value is encountered in a field where a boolean value is expected. Boolean variable this is set during evaluation of the condition expression to the primary waypoint termination condition.BIS Game Engine Scripting Commands Page 409 of 415 Triggers The Condition expression is used to determine when the trigger is activated. The On Activation and On Deactivation expressions define actions that are peformed when the trigger condition changes to true or false. The expression must either be an assignment or return nothing (see type none). Condition must return a boolean value. Array variable thisList is set to the list of all vehicles that would satisfy the primary sensor activation condition. When any uninitialized variable is detected in any expression. The On Activation expression defines an action that is peformed after the waypoint is terminated. Variables Variables have to be inicialized before being used.html 7/11/2010 . Expressions must either be an assignment or return nothing (see type none).

arma2.html 7/11/2010 .com/comref/full.BIS Game Engine Scripting Commands Page 410 of 415 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - Soldier SoldierLAW Air Helicopter Plane Ship SmallShip BigShip Jeep JeepMG Rapid RapidY Skoda SkodaBlue SkodaRed SkodaGreen Tractor Truck Truck5t Truck5tOpen Truck5tRepair Truck5tReammo Truck5tRefuel SoldierWB SoldierWG SoldierWMedic SoldierWCrew SoldierWPilot SoldierWMG SoldierWLAW SoldierWAT SoldierWAA SoldierWMortar SoldierWSniper SoldierWSaboteurPipe SoldierWSaboteurDay SoldierWMiner OfficerW SoldierWCaptive M1Abrams M60 M113 M113Ambul Cobra Ch47D air vehicle helicopter airplane 5 ton truck basic western soldier western soldier with grenade launcher western soldier with machine gun western soldier with LAW launcher western soldier with guided AT missile western soldier with AA missile western soldier with riffle grenade http://www.

BIS Game Engine Scripting Commands Page 411 of 415 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ParachuteEast ParachuteWest ParachuteC ParachuteG UH60 UH60MG Su25 A10 Cessna BoatW M2StaticMG UAZ Ural UralRepair UralReammo UralRefuel Scud SoldierEB SoldierWFakeE SoldierEG SoldierEMedic SoldierECrew SoldierEPilot SoldierEMG SoldierELAW SoldierEAT SoldierEAA SoldierEMiner OfficerE OfficerENight GeneralE Angelina SoldierESniper SoldierESaboteurPipe SoldierEFakeW LaserTarget BMP BMPAmbul RussianTank T72 T80 ZSU M2StaticMGE Mi24 Mi17 laser designator dot http://www.html 7/11/2010 .com/comref/full.arma2.

html 7/11/2010 .BIS Game Engine Scripting Commands Page 412 of 415 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + CarrierW BoatE TruckV3SG GJeep TruckV3SCivil TruckV3SGRefuel TruckV3SGRepair TruckV3SGReammo UAZG SGUAZG SoldierGB SoldierGMedic SoldierGCrew SoldierGPilot SoldierGG SoldierGMG SoldierGLAW SoldierGAT SoldierGAA OfficerG OfficerGNight SoldierGFakeE SoldierGFakeC SoldierGFakeC2 T55G Static static object or building ReammoBox ReammoBoxWest ReammoBoxEast ReammoBoxGuer HeavyReammoBox HeavyReammoBoxWest HeavyReammoBoxEast HeavyReammoBoxRes MachineGunBox FlagCarrier Danger Fire Target TargetE Camp Fortress1 Fortress2 CampEmpty CampEast http://www.arma2.com/comref/full.

BIS Game Engine Scripting Commands Page 413 of 415 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + CampEastC Grave GraveCross1 GraveCross2 GraveCrossHelmet ACamp MASH Fence FenceWood Wire WireFence Barrels Barrel1 Barrel2 Barrel3 Barrel4 Table Tablemap Chair Phone Camera1 Computer ChairHangar ChairX VideoTable TablePub Radio ChairSmall Crawling ExcerciseTrack ExcerciseTrack2 ExcerciseTrack3 Paleta1 Paleta2 JeepWreck1 JeepWreck2 JeepWreck3 M113Wreck UralWreck Body Shed Office Barracks Hangar Hangar_Hall http://www.com/comref/full.html 7/11/2010 .arma2.

com/comref/full.html 7/11/2010 .BIS Game Engine Scripting Commands Page 414 of 415 + + + + + + + Hangar_Office ShedSmall HeliH HeliHEmpty TargetTraining TargetGrenade FuelStation fuel station building Weapons and magazines Config entry: CfgWeapons Value Description Shell73 Heat73 Gun73 Shell105 Heat105 Gun105 Shell120 Heat120 Gun120 Shell125 Heat125 Gun125 MGun Riffle StrokeFist M16 M4 AK47 AK47CZ AK74 AK74SU HK SniperRiffle M21 SVDDragunov Binocular NVGoggles MachineGun7_6 MachineGun7_6Manual M60 PK MachineGun12_7 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + http://www.arma2.

arma2.html 7/11/2010 .com/comref/full.BIS Game Engine Scripting Commands Page 415 of 415 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Browning MachineGun30 MachineGun30A10 ZsuCannon GrenadeLauncher RiffleGrenadeLauncher M16GrenadeLauncher AK47GrenadeLauncher AK74GrenadeLauncher Mortar Flare FlareGreen FlareRed HandGrenade SmokeShell SmokeShellRed SmokeShellGreen Put Mine MineE PipeBomb LAWLauncher RPGLauncher CarlGustavLauncher AT4Launcher AALauncher 9K32Launcher AT3Launcher HellfireLauncher ZuniLauncher38 Rocket57x64 Rocket57x192 HellfireLauncherCobra HellfireLauncherHind MaverickLauncher CarHorn TruckHorn SportCarHorn http://www.