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. Type of returned value: http://www.50 required.arma2.50 required. Type of returned value: Boolean Description: Checks whether two displays are equal.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. Category: OFP PC control1 == control2 Operand types: control1: Control control2: Control Compatibility: Version 2.html 7/11/2010 .

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

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

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.arma2.com/comref/full.html 7/11/2010 . If either of them is null. false is returned. 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.

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. Type of returned value: Config Description: Returns subentry of config entry with given name.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.com/comref/full.html 7/11/2010 .35 required.arma2.

arma2.com/comref/full. Category: OFP acos x http://www.html 7/11/2010 . Example: abs -3 . result is 3 Category: Default accTime Type of returned value: Number Description: Returns the current time acceleration factor.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.

param3]. maxKeys] Operand types: action or [action. target. Example: acos 0. The format of action can be [type. the result is in degrees.html 7/11/2010 . param2. Example: soldierOne action ["eject". Type of returned value: Array Description: Returns a list of dikCodes of buttons assigned to the given user action. 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. Example: array = actionKeys "ReloadMagazine" Category: OFP actionKeysImages action or [action.5 . param3 are type specific. param2. vehicle soldierOne] Category: OFP actionKeys action Operand types: action: String Compatibility: Version 2. Only type is required. param1.com/comref/full. maxKeys]: String or Array http://www.arma2. target defaults to unit and param1.01 required.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 Compatibility: Version 2. . You can find the action names in config class ControllerSchemes. Example: activateAddons ["BISOFP"] Category: OFP activateKey keyName http://www..32 required.. You can find the action names in config class ControllerSchemes. Type of returned value: Structured text Description: Returns a list of button images or names assigned to the given user action.] Operand types: [addon1.. Example: text = actionKeysImages "ReloadMagazine" Category: OFP actionKeysNames action or [action. The list of active addons is initialized during this function.]: Array Compatibility: Version 2. A maximum of maxKeys keys is listed.01 required.01 required. maxKeys] Operand types: action or [action. Example: list = actionKeysNames "ReloadMagazine" Category: OFP activateAddons [addon1.html 7/11/2010 .com/comref/full.arma2. Type of returned value: String Description: Returns a list of button names assigned to the given user action.BIS Game Engine Scripting Commands Page 16 of 415 Compatibility: Version 2.. . Type of returned value: Nothing Description: Activates the listed addons. A maximum of maxKeys keys is listed.

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

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

for example by adding 20 grenades. This is used for infantry weapons. count]. 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. Category: Resistance http://www. 10] Category: OFP addMagazinePool Compatibility: Version 1.com/comref/full. 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.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 . Note: you may create invalid combinations by using this function. For magazineName values see CfgWeapons. application behaviour is undefined.arma2. Example: rearmTruckOne addMagazineCargo ["M16".75 required. When doing so.

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

92 required.html 7/11/2010 . The rating for killed enemies and killed friendlies is adjusted automatically. This is shown in the "I" MP screen as the total score. a unit is considered "renegade" and is an enemy to everyone. 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. Type of returned value: Nothing Description: Add a unit into the list of units available for team switch.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. Category: OFP group addVehicle vehicle Operand types: group: Group vehicle: Object http://www.com/comref/full. When the rating is lower than zero. This is usually used to reward for completed mission objectives. Example: player addScore 10 Category: OFP addSwitchableUnit person Operand types: person: Object Compatibility: Version 2.

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

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

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

Category: OFP obj allowDammage allow Operand types: obj: Object allow: Boolean Type of returned value: Nothing Description: Obsolete. Type of returned value: Nothing Description: Allow/dissallow file ops (load/save etc).92 required.html 7/11/2010 .com/comref/full.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. Category: OFP map allowFileOperations bool Operand types: map: Control bool: Boolean Compatibility: Version 2. Category: Editor unit allowFleeing courage Operand types: unit: Object or Group courage: Number Type of returned value: Nothing Description: http://www.arma2.

while 1 means always fleeing. the sooner the group will start fleeing.com/comref/full.html 7/11/2010 . 0 means maximum courage. 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. Example: player ammo "M16" Category: OFP http://www.arma2. Type of returned value: Array Description: Return a list of all units (all persons except agents). 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. The less courage. unitTwo] allowGetIn false Category: OFP allUnits Compatibility: Version 5501 required.BIS Game Engine Scripting Commands Page 26 of 415 Sets the group courage.

Type of returned value: Nothing Description: Process animation on object. Wanted animation phase is set to phase. phase]: Array Compatibility: Version 1.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.75 required. 1] Category: Resistance object animationPhase animation Operand types: object: Object animation: String Compatibility: Version 1.75 required. Animation is defined in config file. Example: house animate ["doors1".arma2. Example: house animationPhase "doors1" Category: Resistance http://www.html 7/11/2010 . Type of returned value: Number Description: Return animation phase of animation on object. phase] Operand types: object: Object [animation.com/comref/full.

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

halts the program. 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. 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.html 7/11/2010 .arma2. 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.BIS Game Engine Scripting Commands Page 29 of 415 Description: Tests a condition and if the condition is false.com/comref/full. http://www.

Example: player assignAsGunner tankOne Category: OFP assignedCargo 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. Type of returned value: Array Description: Returns the list of soldiers assigned to the given vehicle as a cargo.com/comref/full. Category: OFP http://www.html 7/11/2010 .arma2. Type of returned value: Object Description: Returns the soldier assigned to the given vehicle as a commander. Category: OFP assignedCommander vehicle Operand types: vehicle: Object Compatibility: Version 5501 required.

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

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

Example: atg 1 .html 7/11/2010 .0362 Category: Default atg x Operand types: x: Number Type of returned value: Number Description: The arctangens of x. Example: atan 1 . result is 59.arma2.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 result is in degrees. 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. in the range from -180 to +180. the result is in degrees. result is 45 Category: Default http://www. Example: 5 atan2 3 . using the signs of both parameters to determine the quadrant of the returned value. The returned value is in degrees.com/comref/full.

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

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

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

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

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

com/comref/full. Example: [1.85 required. Type of returned value: Any Description: Executes the given code.html 7/11/2010 . Example: call {"x=2"} Category: Default pars call body Operand types: pars: Any body: Code Compatibility: Version 1.2] call {(_this select 0)+(_this select 1)} .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. Category: OFP call code Operand types: code: Code Compatibility: Version 1.arma2. 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. Argument pars is passed as _this.85 required.

Example: _camera camCommit 5 Category: OFP camera camCommitPrepared time Operand types: camera: Object time: Number Compatibility: Version 2.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". 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 "camera" type.arma2.html 7/11/2010 .95 required. For the "seagull" type it's one of: "landed" and "airborne".com/comref/full. A time of zero results in an immediate change. A time of zero results in an immediate change. Type of returned value: Nothing Description: Commits the prepared camera changes smoothly over time. Example: _camera camCommit 5 Category: OFP camCommitted camera Operand types: camera: Object Type of returned value: Boolean http://www. The "manual on" and "manual off" commands are recognized for all types.

com/comref/full.y. max above land]: Array Compatibility: Version 5501 required.radius.arma2. Example: camCommitted _camera Category: OFP camera camConstuctionSetParams [[x.y.radius.z]. Example: _camera = camCreate getPos player Category: OFP camDestroy camera Operand types: camera: Object Type of returned value: Nothing Description: http://www. Type of returned value: Nothing Description: Sets construction camera parameters. Example: _camera camConstuctionSetParams [getpos player.z].BIS Game Engine Scripting Commands Page 41 of 415 Description: Checks whether the camera has finished committing. max above land] Operand types: camera: Object [[x. Its type is one of "CAMERA" or "SEAGULL".html 7/11/2010 .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).50.

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

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

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

Prepares the camera focus blur. See also camPreload and camCommitPrepared.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.html 7/11/2010 .arma2. Type of returned value: Nothing http://www. See also camPreload and camCommitPrepared. Type of returned value: Nothing Description: focusRange is in format [distance. Type of returned value: Nothing Description: Prepares the camera dive angle. Example: _camera camPrepareFocus [50. Example: _camera camPrepareDive -0.95 required.blur].com/comref/full.95 required. 1] Category: OFP camera camPrepareFov fieldOfView Operand types: camera: Object fieldOfView: Number Compatibility: Version 2.95 required.1 Category: OFP camera camPrepareFocus focusRange Operand types: camera: Object focusRange: Array Compatibility: Version 2.

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

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

It does not automatically commit changes. It does not automatically commit changes. 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. It does not automatically commit changes.1 Category: OFP camera camSetFocus focusRange Operand types: camera: Object focusRange: Array http://www.arma2.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 camSetBank -0.html 7/11/2010 .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.com/comref/full.

Example: _camera camSetFocus [50.BIS Game Engine Scripting Commands Page 49 of 415 Type of returned value: Nothing Description: focusRange is in format [distance.com/comref/full.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. It does not automatically commit changes. It does not automatically commit changes. Sets the camera focus blur.5] Category: OFP camera camSetPos position Operand types: camera: Object position: Array Type of returned value: Nothing http://www.blur]. Example: _camera camSetFov 0.arma2.html 7/11/2010 . Example: _camera camSetFovRange [0. 0. It does not automatically commit changes. 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).1.

http://www.com/comref/full.5] Category: OFP camera camSetTarget target Operand types: camera: Object target: Object Type of returned value: Nothing Description: Sets the camera target. Example: _camera camSetRelPos [10.html 7/11/2010 . 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). It does not automatically commit changes. 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.BIS Game Engine Scripting Commands Page 50 of 415 Description: Sets the camera position (format Position).arma2. It does not automatically commit changes. It does not automatically commit changes.

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.73 required. Type of returned value: Nothing Description: Set / clear using of night vision during cutscenes. only for damage.com/comref/full. It does not check for ammo. Example: camTarget _camera Category: OFP camUseNVG set Operand types: set: Boolean Compatibility: Version 2. Type of returned value: Object Description: Returns camera's target. Example: canFire vehicle player Category: OFP http://www. Category: OFP canFire vehicle Operand types: vehicle: Object Type of returned value: Boolean Description: Checks whether the given vehicle is able to fire.arma2.html 7/11/2010 .

only the damage status is checked. Example: canStand player Category: OFP canUnloadInCombat vehicle Operand types: vehicle: Object Compatibility: Version 5501 required. Category: OFP captive unit Operand types: unit: Object http://www. It does not test for fuel.html 7/11/2010 . 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.com/comref/full. Type of returned value: Boolean Description: Check if cargo of this vehicle want to get out when in combat.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.

If the unit is a vehicle.com/comref/full.html 7/11/2010 .BIS Game Engine Scripting Commands Page 53 of 415 Type of returned value: Boolean Description: Checks whether the unit is a captive. when exception is thrown in try block Category: Default http://www. its commander is checked instead.arma2. 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. 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.

html 7/11/2010 .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. Type of returned value: Nothing Description: Removes all icon from group. result is 6 Category: Default cheatsEnabled Compatibility: Version 1. Example: clearGroupIcons group http://www. Type of returned value: Boolean Description: Checks whether cheats are enabled (whether the designers' version is running). Example: ceil 5.25 .56 required.com/comref/full. Category: OFP clearGroupIcons group Operand types: group: Group Compatibility: Version 5501 required. Category: Resistance civilian Type of returned value: Side Description: The Civilian side.arma2.

Example: clearOverlay _map Category: Editor clearRadio http://www.com/comref/full.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. Type of returned value: Nothing Description: Clear the current overlay. Example: clearMagazineCargo jeepOne Category: OFP clearMagazinePool Compatibility: Version 1.92 required. Category: Resistance clearOverlay map Operand types: map: Control Compatibility: Version 2.75 required.html 7/11/2010 .arma2. 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).

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).73 required. 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. Example: clearWeaponCargo jeepOne Category: OFP clearWeaponPool Compatibility: Version 1. Category: OFP clearVehicleInit vehicle Operand types: vehicle: Object Compatibility: Version 5154 required.html 7/11/2010 .com/comref/full.75 required. http://www.arma2. Type of returned value: Nothing Description: Clear vehicle init field. 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.

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

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

html 7/11/2010 . the unit is ordered to commence firing on its current target (set using doTarget or commandTarget). If the vehicle is not a vehicle. Example: soldierOne commandFollow player Category: OFP http://www. 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). If the target is objNull.com/comref/full. 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). but a person.arma2.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. the person is returned instead.

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

com/comref/full. Example: soldierOne commandMove getMarkerPos "MarkerMoveOne" Category: OFP unit commandRadio radioName Operand types: unit: Object or Array radioName: String Compatibility: Version 5501 required.arma2.html 7/11/2010 . Example: commandStop unitOne Category: OFP unit commandTarget position Operand types: unit: Object or Array http://www. 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).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). Note: the stop command is never finished. the unit will never be ready. The message is defined in the description.ext file or radio protocol. Type of returned value: Nothing Description: Sends the message to the command radio channel.

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). Type of returned value: http://www.85 required.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).html 7/11/2010 . Example: soldierOne commandWatch player Category: OFP comment comment Operand types: comment: String Compatibility: Version 1.arma2.com/comref/full. 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).

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

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

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

com/comref/full. 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.2] .arma2. Type of returned value: Number Description: Returns count of subentries.BIS Game Engine Scripting Commands Page 66 of 415 Description: Copy the chain of waypoints from source to target group.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.html 7/11/2010 .1. Example: cos 60 . The target group will start to process waypoints from the first one. result is 0.0.35 required. result is 4 http://www. Example: count [0.

1. 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 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. 2) For each element in the array assign an element as _x and evaluate the condition expression. If it's true. It is calculated as follows: 1) Set the count to 0. 1. increase the count. 2.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. 3] . 3. Example: player countFriendly list triggerOne Category: OFP http://www.html 7/11/2010 .arma2. Example: "_x > 2" count [0.

arma2. markers. 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. placement. Example: player countUnknown list triggerOne Category: OFP createAgent [type.com/comref/full.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. For types see CfgVehicles. special] http://www. position. 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.html 7/11/2010 .

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

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

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

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

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

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

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

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

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

Type of returned value: Nothing Description: Launch actions attached to given (button based) control. Example: _delay = ctrlAutoScrollDelay _control http://www. function] Operand types: control: Control [handler name. Type of returned value: Number Description: Returns number of seconds until auto-scroll starts. Example: ctrlActivate _control Category: OFP PC control ctrlAddEventHandler [handler name. Type of returned value: Number Description: Add an event handler to the given control. -2 if scrollbar not present. Example: _id = _control ctrlAddEventHandler ["KeyDown". Returns id of the handler or -1 when failed. ""] Category: OFP PC ctrlAutoScrollDelay control Operand types: control: Control Compatibility: Version 5501 required.92 required.html 7/11/2010 .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.

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

http://www.50 required.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.50 required.arma2. false] Category: Resistance control ctrlEnable enable Operand types: control: Control enable: Boolean Compatibility: Version 2. Type of returned value: Nothing Description: Enables / disables the control with id idc of the topmost user dialog. enable] Operand types: [idc. Type of returned value: Boolean Description: Check if the control animation is finished. Example: ctrlEnable [100.com/comref/full. enable]: Array Compatibility: Version 1.html 7/11/2010 .50 required. Type of returned value: Nothing Description: Enable / disable given control. Example: _done = ctrlCommitted _control Category: OFP PC ctrlEnable [idc.

arma2.50 required. Type of returned value: Boolean Description: Returns whether the control with id idc of the topmost user dialog is enabled. Example: _enabled = ctrlEnabled 100 Category: Resistance ctrlFade control Operand types: control: Control Compatibility: Version 2.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.html 7/11/2010 . Example: _ok = ctrlEnabled _control Category: OFP PC ctrlEnabled idc Operand types: idc: Number Compatibility: Version 1. Type of returned value: Number Description: Returns the current fade factor of control.50 required. Type of returned value: Boolean Description: Returns whether given control is enabled.50 required. http://www.

Type of returned value: Nothing Description: Plays the map animation. Type of returned value: Nothing Description: Clears the map animation.92 required. the format of position is Position2D.1. Category: OFP PC ctrlMapAnimCommit control Operand types: control: Control Compatibility: Version 2. zoom.com/comref/full.arma2.92 required. position]. The format of frame is [time. http://www.92 required.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. Type of returned value: Nothing Description: Adds the next frame to the map animation. getMarkerPos "anim1"] Category: OFP PC ctrlMapAnimClear control Operand types: control: Control Compatibility: Version 2.html 7/11/2010 . 0. Example: _map ctrlMapAnimAdd [1.

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

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

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

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

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

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

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

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

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

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

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 http://www. 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.50 required.com/comref/full.arma2. Example: _control ctrlSetFontH6 "TahomaB" Category: OFP PC control ctrlSetFontH6B name Operand types: control: Control name: String Compatibility: Version 2.50 required.html 7/11/2010 .

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

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

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

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

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

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

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

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

50 required. Type of returned value: String Description: Returns the text shown in the control with id idc of the topmost user dialog. Type of returned value: Number Description: http://www. edit lines and active texts. Example: _message = ctrlText 100 Category: Resistance ctrlType control Operand types: control: Control Compatibility: Version 2.arma2. Example: _text = ctrlText _control Category: OFP PC ctrlText idc Operand types: idc: Number Compatibility: Version 1.50 required. buttons.com/comref/full.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. This can be used for static texts. Type of returned value: String Description: Returns the text shown in given control.html 7/11/2010 .56 required.

Category: OFP http://www.50 required. Type of returned value: String Description: Return the name of the type of the currently using magazine (on the primary turret for vehicles).com/comref/full. Type of returned value: String Description: Return the current command type (empty string when no command).arma2.92 required.html 7/11/2010 . Type of returned value: Boolean Description: Returns whether the control with id idc of the topmost user dialog is visible. Category: OFP currentMagazine vehicle Operand types: vehicle: Object Compatibility: Version 5500 required. Example: _visible = ctrlVisible 100 Category: Resistance currentCommand vehicle Operand types: vehicle: Object Compatibility: Version 2.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.

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

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.0 Category: OFP cutObj effect Operand types: effect: Array Type of returned value: Nothing Description: Object background .html 7/11/2010 . If speed is not given.the argument uses format ["name". Example: alive cursorTarget Category: OFP layer cutFadeOut duration Operand types: layer: Number duration: Number Compatibility: Version 5126 required. Category: OFP cursorTarget Compatibility: Version 5500 required.arma2.com/comref/full. Example: http://www."type". Type of returned value: Object Description: This is the entity pointed to by a players cursor. it's assumed to be one. Example: 0 cutFadeIn 1.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)."type"].speed] or ["name". The object can be defined in the description.ext file.

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

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

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

Section is one of "TARGET" (disables watching assigned targets).90 required. Example: soldierOne disableAI "Move" http://www. Category: Location unit directSay radioName Operand types: unit: Object radioName: String Compatibility: Version 5501 required.com/comref/full.arma2. "AUTOTARGET" (disables independed target assigning and watching of unknown targets) or "MOVE" (disables movement). The message is defined in the description.html 7/11/2010 .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.ext file or radio protocol. 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. Type of returned value: Nothing Description: Sends the message to the direct channel.

Example: player disableConversation true Category: OFP disableSerialization Compatibility: Version 5501 required.html 7/11/2010 . This is normally used only in cutscenes to disable the player's controls. Category: Default disableUserInput disable Operand types: disable: Boolean Type of returned value: Nothing Description: Disables all user input.com/comref/full.arma2. so lock . function] Operand types: display: Display http://www. Type of returned value: Nothing Description: Disable saving of script containing this command. Implemented by the counter. script can work with the data types which do not support serialization (UI types).unlock need to be matched. Category: OFP display displayAddEventHandler [handler name. After this.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]: Array Compatibility: Version 5501 required.50 required.BIS Game Engine Scripting Commands Page 118 of 415 [handler name. Type of returned value: Number Description: Add an event handler to the given display.html 7/11/2010 . Type of returned value: Control Description: Return child control with specified idc. Type of returned value: Display Description: A non-existing display.arma2. This value is not equal to anything.com/comref/full. http://www. including itself. Example: _control = _display displayCtrl 101 Category: OFP PC displayNull Compatibility: Version 2. Category: OFP PC display displayRemoveAllEventHandlers handler name Operand types: display: Display handler name: String Compatibility: Version 5501 required.92 required. Returns id of the handler or -1 when failed. Example: _id = _display displayAddEventHandler ["KeyDown". ""] Category: OFP PC display displayCtrl idc Operand types: display: Display idc: Number Compatibility: Version 2.

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

com/comref/full. Category: Location distributionRegion Compatibility: Version 5129 required. 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. Type of returned value: Nothing Description: Dissolves the given team.05 required. 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.BIS Game Engine Scripting Commands Page 120 of 415 Compatibility: Version 2. "BLUE" or "YELLOW". "GREEN". Possible team values are: "RED". All members become members of the main team. Type of returned value: Number Description: Computes the distance between two locations or positions.arma2.html 7/11/2010 . Type of returned value: Number http://www.

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

arma2. 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}.html 7/11/2010 . 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). case 2 : {block}. http://www. the loop will be terminated and an error message is shown. the unit is ordered to commence firing on its current target (set using doTarget or commandTarget).} 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). If the target is objNull. default {block}.com/comref/full.BIS Game Engine Scripting Commands Page 122 of 415 10000.

28 required. Example: soldierOne doFSM ["move. http://www.53 required.html 7/11/2010 .arma2.com/comref/full. target] Operand types: unit(s): Object or Array [fsm name. position. position. Type of returned value: Nothing Description: Orders a unit to process command defined by FSM file (silently). position player.fsm".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). target]: Array Compatibility: Version 2. player] Category: OFP PC doGetOut unit Operand types: unit: Object or 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).

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). Example: soldierOne doWatch getMarkerPos "MarkerMoveOne" http://www. the unit will never be ready.arma2.com/comref/full. Note: the stop command is never finished.html 7/11/2010 .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).

Category: OFP PC http://www. color] Operand types: map: Control [position1. Example: soldierOne doWatch player Category: OFP map drawArrow [position1. Type of returned value: Nothing Description: Draw arrow in map. fill] Operand types: map: Control [center. color.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).arma2.35 required. a. fill]: Array Compatibility: Version 2.35 required.com/comref/full. b. b. color]: Array Compatibility: Version 2. a. angle.html 7/11/2010 . position2. Category: OFP PC map drawEllipse [center. color. Type of returned value: Nothing Description: Draw ellipse in map. position2. angle.

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

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

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

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

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

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

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

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

Category: OFP estimatedTimeLeft timeLeft Operand types: timeLeft: Number Compatibility: Version 1. Type of returned value: Any Description: Return object argument in mission editor. 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. Type of returned value: Nothing Description: Returns the estimated time left in the game.34 required. the following example can be used in the init. Category: Editor argument exec script Operand types: http://www.sqs file.com/comref/full. argument] Operand types: map: Control [object.html 7/11/2010 . argument]: Array Compatibility: Version 2. For missions with a hard set limit adjusted via Param1.35 required.BIS Game Engine Scripting Commands Page 134 of 415 estimatedEndServerTime Compatibility: Version 5501 required. Type of returned value: Number Description: Estimated end of MP game converted to serverTime.arma2. Example: estimatedTimeLeft Param1 Category: OFP map evalObjectArgument [object.

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

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

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

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

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

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

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

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

"SmokeShell".html 7/11/2010 . The array has format [muzzle. mode]. if number is finite (not infinite and valid number) Example: finite 10/0 .BIS Game Engine Scripting Commands Page 143 of 415 Finish world initialization before mission is launched. Category: OFP finite x Operand types: x: Number Type of returned value: Boolean Description: True. 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. magazine] or [muzzle. 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."SmokeShell"] Category: OFP http://www.com/comref/full. mode.arma2. Example: soldierOne fire ["throw".

Example: fleeing player Category: OFP floor x Operand types: http://www. objNull is returned. this flag is returned. A dead or empty unit returns false.html 7/11/2010 .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. the returned value is the person that has this flag.com/comref/full. When used on anything else. Example: flagowner flagOne Category: OFP fleeing unit Operand types: unit: Object Type of returned value: Boolean Description: Checks whether the unit is fleeing.arma2. Example: flag player Category: OFP flagOwner flag Operand types: flag: Object Type of returned value: Object Description: When used on a flag. If not. objNull is returned.

com/comref/full. Category: OFP http://www.BIS Game Engine Scripting Commands Page 145 of 415 x: Number Type of returned value: Number Description: The floor value of x. Category: OFP fogForecast Compatibility: Version 2. The accepted range is from 50 to 1000. Example: floor 5. Type of returned value: Number Description: Return the current fog.92 required.25 . Example: cobraOne flyInHeight 150 Category: OFP fog Compatibility: Version 2.92 required. 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.html 7/11/2010 . Type of returned value: Number Description: Return the fog forecast.arma2.

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

%1". Each %x is replaced by the corresponding argument. Example: format ["%1 . %x may appear in the string in any order.com/comref/full. result is "1 .arma2. etc. "text"] . Type of returned value: Nothing Description: Force the speed of the given object. 1.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. %2.text . 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.1" http://www. 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.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.92 required. This string may contain references to the following arguments using format %1.%2 .

92 required.html 7/11/2010 .92 required.com/comref/full. Category: OFP formationMembers person http://www. Category: OFP formationLeader person Operand types: person: Object Compatibility: Version 2. "VEE" or "LINE").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". "ECH LEFT". Example: formation group player Category: OFP formationDirection person Operand types: person: Object Compatibility: Version 2. "STAG COLUMN".arma2. "WEDGE". Type of returned value: Number Description: Return the direction unit watching in formation. Type of returned value: Object Description: Return leader of the formation. "ECH RIGHT".

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

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

Type of returned value: String Description: Returns gear slot item name. Example: weapon = gearSlotData _control Category: OFP PC getArray config Operand types: config: Config Compatibility: Version 2.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.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.com/comref/full.35 required. Type of returned value: Array Description: Extract array from config entry.

com/comref/full. Category: Editor getEditorMode map Operand types: map: Control Compatibility: Version 2. Type of returned value: Object Description: Fetches a reference to the mission editor camera.92 required.92 required.html 7/11/2010 . Example: getDir player Category: OFP getEditorCamera map Operand types: map: Control Compatibility: Version 2.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. Type of returned value: String Description: Returns the current mode of the editor.arma2. Type of returned value: http://www. Category: Editor map getEditorObjectScope object Operand types: map: Control object: String Compatibility: Version 2.92 required.

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

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

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

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

Category: Editor map getObjectProxy object Operand types: map: Control object: String Compatibility: Version 2. Type of returned value: Array Description: Return a list of all the children of the specified object.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.html 7/11/2010 .arma2. Example: getPos player Category: OFP getPos location http://www. Category: Editor getPos obj Operand types: obj: Object Type of returned value: Array Description: Returns the object position in format Position.com/comref/full.92 required.92 required.

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

Category: Default group getVariable name Operand types: group: Group name: String Compatibility: Version 5501 required. Type of returned value: Any Description: Return the value of variable in the variable space of given group. Category: OFP location getVariable name Operand types: location: Location name: String Compatibility: Version 2. Example: _array = getText (configFile >> "CfgVehicles" >> "Thing" >> "icon") Category: OFP PC namespace getVariable name Operand types: namespace: Namespace 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.html 7/11/2010 . Type of returned value: Any Description: Return the value of variable in the given namespace.92 required.com/comref/full. Type of returned value: Any Description: http://www.arma2.

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

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

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. The message is defined in the description.com/comref/full. Example: group player == group leader player Category: OFP unit groupChat chatText Operand types: http://www. 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. 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. Be sure to use double quotes around the label name in goto.arma2. Note: the string argument is used here. For dead units. grpNull is returned.ext file or radio protocol.html 7/11/2010 .

Type of returned value: Array Description: Return group icons are visible.arma2. Category: OFP groupIconsVisible Compatibility: Version 5501 required. Type of returned value: Boolean Description: Return if groups icon raises onClick and onOver events.html 7/11/2010 . you have to execute it on all of them. 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. Example: http://www. If you want the message to show on all computers. The message is defined in the description. it does not broadcast the message. Example: soldierOne groupChat "Show this text" Category: OFP groupIconSelectable Compatibility: Version 5501 required.com/comref/full.ext file or radio protocol. Note: this function only types text to the list.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.

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

the person is returned. Example: handsHit leader player Category: OFP unit hasWeapon weaponName Operand types: http://www. Example: gunner vehicle player Category: OFP halt Compatibility: Version 2.00 required. but a person. Type of returned value: Nothing Description: Stops the program into a debugger.arma2. 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). If the vehicle is not a vehicle.com/comref/full.html 7/11/2010 .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: player hasWeapon "M16" Category: OFP hcAllGroups unit Operand types: unit: Object 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.arma2. Return value is [string. Example: array = hcAllGroups unit Category: OFP unit hcGroupParams group Operand types: unit: Object group: Group Compatibility: Version 5501 required.float[4]] Example: unit hcGroupParams group Category: OFP hcLeader group Operand types: http://www. Type of returned value: Array Description: Returns selected groups in high command. Type of returned value: Array Description: Returns parameters describing group in high command bar.com/comref/full.html 7/11/2010 .

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

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

There must be some groups under hc command to show hc bar. Type of returned value: Nothing Description: Hides the body of the given person. Type of returned value: Boolean Description: Return a list of all groups. Example: hideBody player Category: OFP hint text Operand types: text: Text or String Type of returned value: http://www.html 7/11/2010 . Example: hcShowBar true Category: OFP hcShownBar Compatibility: Version 5501 required.com/comref/full.10 required. 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. Category: OFP hideBody person Operand types: person: Object Compatibility: Version 2.arma2.

Category: OFP title hintC text Operand types: title: String text: String Compatibility: Version 2. \n is used to indicate the end of a line. 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: Creates a hint dialog with the given title and text. 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. \n is used to indicate the end of a line.01 required.html 7/11/2010 .BIS Game Engine Scripting Commands Page 170 of 415 Nothing Description: Shows a text hint. The text can contain several lines.01 required. The text can contain several lines.arma2. Type of returned value: Nothing Description: http://www. This hint has to be confirmed.

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

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

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.90 required. result is true Category: Default position in location Operand types: position: Array location: Location Compatibility: Version 2.arma2.html 7/11/2010 . http://www.BIS Game Engine Scripting Commands Page 173 of 415 importAllGroups map Operand types: map: Control Compatibility: Version 2. 1. Type of returned value: Number Description: Return importance of given location.92 required. Category: Editor importance location Operand types: location: Location Compatibility: Version 2.92 required.com/comref/full. Example: 1 in [0. 2] . Type of returned value: Nothing Description: Imports all groups into the RTE.

04 required.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. http://www. Type of returned value: Boolean Description: Check if fireplace is inflamed (buring). Set to true to inflame the fireplace.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. Example: player in jeepOne Category: OFP fireplace inflame burn Operand types: fireplace: Object burn: Boolean Type of returned value: Nothing Description: Controls fireplace buring. Example: fireplaceOne inflame true Category: OFP inflamed fireplace Operand types: fireplace: Object Compatibility: Version 1.html 7/11/2010 .arma2.

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

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

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

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

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

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

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

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

Category: OFP isRealTime map Operand types: map: Control Compatibility: Version 2. Example: _ok = isNumber (configFile >> "CfgVehicles") .92 required.arma2.92 required. http://www. Category: OFP isPlayer person Operand types: person: Object Compatibility: Version 2. Type of returned value: Boolean Description: Check if config entry represents number.BIS Game Engine Scripting Commands Page 183 of 415 isNumber config Operand types: config: Config Compatibility: Version 2.35 required.html 7/11/2010 . Type of returned value: Boolean Description: Check if given person is the player.com/comref/full. Type of returned value: Boolean Description: Check whether given position is on road. 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 if config entry represents text. Category: Editor isText config Operand types: config: Config Compatibility: Version 2. Type of returned value: Boolean Description: Returns true if the editor is set to draw 3D icons.com/comref/full.92 required.92 required. Type of returned value: Boolean Description: Returns true if the computer is the server.35 required. Example: _ok = isText (configFile >> "CfgVehicles") . Example: _isRealTime = isRealTime _map Category: Editor isServer Compatibility: Version 2. Category: OFP isShowing3DIcons map Operand types: map: Control Compatibility: Version 2.arma2.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. result is false http://www.html 7/11/2010 .

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

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

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

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

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

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

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. "NotReady" (position searching is still in progress) or empty string when wrong argument given. "NotFound" (position not found). text]: Array Compatibility: Version 1.50 required.com/comref/full. Category: OFP lbAdd [idc. Example: _index = lbAdd [101. text] Operand types: [idc. The value can be "Found" (position found). "First item"] Category: Resistance control lbAdd text Operand types: http://www. Type of returned value: String Description: Return the result of helicopter landing position searching (performed after land command).92 required.html 7/11/2010 . 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. It returns the index of the newly added item.BIS Game Engine Scripting Commands Page 191 of 415 airportId: Number Compatibility: Version 2.arma2.

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

com/comref/full.BIS Game Engine Scripting Commands Page 193 of 415 Operand types: [idc. 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. Example: _index = lbCurSel 101 Category: Resistance http://www. The color is returned in format Color. Example: _color = lbColor [101.arma2.91 required.html 7/11/2010 .50 required.50 required. 0] Category: Resistance control lbColor index Operand types: control: Control index: Number Compatibility: Version 2. index]: Array 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. 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.

91 required. index] Operand types: [idc.BIS Game Engine Scripting Commands Page 194 of 415 lbCurSel control Operand types: control: Control Compatibility: Version 2.91 required.50 required. Type of returned value: Number Description: Returns the index of the selected item of the given listbox or combobox.arma2. Example: _data = lbData [101. Example: _index = lbCurSel _control Category: OFP PC lbData [idc. 0] Category: Resistance control lbData index Operand types: control: Control index: Number Compatibility: Version 2. Example: _data = _control lbData 0 Category: OFP PC http://www.com/comref/full. 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.html 7/11/2010 . index]: Array Compatibility: Version 1.

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

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

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

data] Operand types: [idc. data]: Array Compatibility: http://www. 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.arma2. Example: lbSetCurSel [101. "#1"] Category: Resistance control lbSetData [index. data] Operand types: control: Control [index. Example: _control lbSetCurSel 0 Category: OFP PC lbSetData [idc.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.com/comref/full.50 required. Example: lbSetData [101.91 required. 1. Type of returned value: Nothing Description: Selects the item with the given index of the given listbox or combobox. index.html 7/11/2010 . data]: Array Compatibility: Version 1. 0] Category: Resistance control lbSetCurSel index Operand types: control: Control index: Number Compatibility: Version 2. index.

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

com/comref/full. value] Operand types: [idc. 1] Category: Resistance control lbSetValue [index.arma2. 1] http://www. Example: lbSetValue [101. 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. index. Type of returned value: Nothing Description: Set the selection state of the given row of the given listbox. value] Operand types: control: Control [index. selected]: Array Compatibility: Version 5501 required.html 7/11/2010 . selected] Operand types: control: Control [index. index. Example: _control lbSetValue [0. value]: Array Compatibility: Version 1.BIS Game Engine Scripting Commands Page 200 of 415 control lbSetSelected [index.91 required.50 required. Listbox must support multiple selection Example: _control lbSetSelection [0. 0. 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. value]: Array Compatibility: Version 2. true] Category: OFP PC lbSetValue [idc.

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

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

index]: Array Compatibility: Version 1. 0] Category: Resistance control lbValue index Operand types: control: Control index: Number Compatibility: Version 2.com/comref/full. For dead units. http://www.BIS Game Engine Scripting Commands Page 203 of 415 _text = _control lbText 0 Category: OFP PC lbValue [idc.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. 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.arma2. index] Operand types: [idc. objNull is returned.91 required. Type of returned value: Number Description: Returns the additional integer value in the item with the given index of the given listbox or combobox.

Example: groupOne leaveVehicle jeepOne Category: OFP http://www. grpNull is returned. 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.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.com/comref/full. For a dead unit. It unassigns all grouped units from the vehicle. 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. It unassigns all grouped units from the vehicle.html 7/11/2010 .arma2.

04 required. Type of returned value: Nothing Description: Attach light to given object (at given position). 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.58 required. position]: Array Compatibility: Version 2. Category: OFP lightDetachObject light Operand types: light: Object Compatibility: Version 2.arma2. http://www. Type of returned value: Nothing Description: Detach light from object.com/comref/full. Type of returned value: String Description: Returns the life state of the given unit.58 required. position] Operand types: light: Object [object.html 7/11/2010 . Category: OFP light lightAttachObject [object.

01 required. http://www.92 required. Type of returned value: Structured text Description: Creates a structured text containing a line break.html 7/11/2010 . 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. Possible values are "ON". "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).arma2.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". Category: OFP lineBreak Compatibility: Version 2. "OFF" and "AUTO" (auto means the lamp will be shining during the night automatically). Example: lightIsOn nearestObject [player.BIS Game Engine Scripting Commands Page 206 of 415 Type of returned value: String Description: Checks whether the lampost is turned on.

...]. Type of returned value: Number Description: Adds list of rows of strings. [value.[[[text.]]: Array Compatibility: Version 5501 required.. [value. http://www.]].com/comref/full. [[text.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. result is 2.]].[[[text.text].]] Operand types: [IDC. [data. [data...text].. Example: ln 10 .[[[]]. [[text.]]...text]. Returns row index.302 Category: Default lnbAddArray [IDC. [value.text].arma2.].].92 required..]].. Example: _index = lnbAddRow [idc.. Category: Editor ln x Operand types: x: Number Type of returned value: Number Description: The natural logarithm of x..]. [data.html 7/11/2010 . [data.. [value... Type of returned value: Array Description: Return the list of all objects of given type.[[]]]] .

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

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

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

BIS Game Engine Scripting Commands Page 211 of 415 Returns the index of the selected item of the given listbox or combobox.arma2. Example: _row = lnbCurSel 105 Category: Resistance lnbData [idc.html 7/11/2010 . column] Operand types: [idc. column]: Array Compatibility: Version 5501 required. [row. Example: _index = lbCurSel _control Category: OFP PC lnbCurSelRow idc Operand types: idc: Number Compatibility: Version 5501 required. Type of returned value: Number Description: Returns the index of the selected row id 2D listbox.1]] Category: Resistance control lnbData [row. Type of returned value: String http://www. column]: Array Compatibility: Version 5501 required. [row.com/comref/full. Example: _data = lnbData [101. column] Operand types: control: Control [row. [0. 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: http://www.arma2.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 5501 required. index] Operand types: [idc.html 7/11/2010 . Type of returned value: Nothing Description: Removes the item with the given index from the given listbox or combobox. Example: _control lbDelete 0 Category: OFP PC lnbDeleteRow [idc.com/comref/full. 0] Category: Resistance control lnbDeleteColumn index Operand types: control: Control index: Number Compatibility: Version 5501 required.50 required. Example: lnbDeleteColumn [101. column] Category: OFP PC lnbDeleteColumn [idc. Type of returned value: Nothing Description: Removes column with given index. Example: _data = _control lnbData [row. index]: Array Compatibility: Version 1.

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

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

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

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

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

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

[row. value] Operand types: [idc. [0. value] Operand types: control: Control [[row. Example: http://www.BIS Game Engine Scripting Commands Page 219 of 415 Category: OFP PC lnbSetValue [idc. 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. Example: _control lnbSetValue [[row. column].html 7/11/2010 .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.com/comref/full.Y] size of 2D listbox. Type of returned value: Nothing Description: Sets the additional integer value in the item with the position index of the 2D listbox. column]. column]. [row. value]: Array Compatibility: Version 5501 required. Example: lnbSetValue [101.1]. column]. 1] Category: Resistance control lnbSetValue [[row. column].

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

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

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

75 required. Type of returned value: Boolean Description: Loads object's properties from objects. 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. Note: all static objects are local on all computers.arma2.html 7/11/2010 .sav file in campaign directory (from entry name).com/comref/full. This can be used when one or more activation fields or scripts need to be performed only on one computer. In SP all objects are local. 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.BIS Game Engine Scripting Commands Page 223 of 415 object loadStatus name Operand types: object: Object name: String Compatibility: Version 1.csv file. Example: localize "STR_DN_FROG" Category: OFP http://www.

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

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

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

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. Example: log 10 .arma2.html 7/11/2010 . result is 1 Category: Default unit(s) lookAt position Operand types: unit(s): Object or Array position: Object or Array Compatibility: Version 2. 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.com/comref/full. 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).

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

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

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

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

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

ext entries hierarchy.90 required. Type of returned value: String Description: Returns the name of the current mission. 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. result is 2 Category: Default missionConfigFile Compatibility: Version 2.html 7/11/2010 . Category: OFP PC missionName Compatibility: Version 1.BIS Game Engine Scripting Commands Page 233 of 415 The greater of a.arma2.com/comref/full.80 required.b Example: 3 max 2 .b Example: 3 min 2 . Type of returned value: Config Description: Return root of mission description.

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

Example: morale leader player .com/comref/full. result is 0.BIS Game Engine Scripting Commands Page 235 of 415 morale unit Operand types: unit: Object Compatibility: Version 5500 required. without animation). Type of returned value: Number Description: Checks a current morale level of the unit (-1. Example: soldierOne moveInCargo jeepOne Category: OFP http://www.arma2.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.+1).html 7/11/2010 . (Immediately.. 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 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. without animation).com/comref/full. (Immediately. (Immediately. without animation). CargoIndex]: Array Type of returned value: Nothing Description: Moves the soldier into a vehicle's specified cargo position. Example: soldierOne moveInDriver jeepOne Category: OFP soldier moveInGunner vehicle Operand types: http://www. without animation).arma2. CargoIndex] Operand types: soldier: Object [vehicle.html 7/11/2010 . (Immediatetely. 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.BIS Game Engine Scripting Commands Page 236 of 415 soldier moveInCargo [vehicle.

turret path] Operand types: soldier: Object [vehicle. turret path]: Array Type of returned value: Nothing Description: Moves the soldier into the vehicle's turret. This means that the object will be drawn last (after all other objects). Category: Editor moveOut soldier Operand types: soldier: Object Compatibility: Version 5501 required. http://www. Example: soldierOne moveInTurret [tank. [0.92 required. (Immediately.arma2.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.com/comref/full. 0]] Category: OFP map moveObjectToEnd object Operand types: map: Control object: String Compatibility: Version 2. (Immediately. Example: soldierOne moveInGunner jeepOne Category: OFP soldier moveInTurret [vehicle. without animation).html 7/11/2010 . without animation). Type of returned value: Nothing Description: Shifts an editor object to the end of the objects array.

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

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.arma2.com/comref/full. Category: OFP musicVolume Type of returned value: Number Description: Checks the current music volume (set by fadeMusic).html 7/11/2010 . Type of returned value: Boolean Description: Check if latest low level moveTo command failed. http://www.92 required. driver. gunner). Example: name vehicle player Category: OFP name location Operand types: location: Location Compatibility: Version 2.90 required.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.

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

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

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

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

The output is list of items: [position. Type of returned value: Nothing Description: Creates the new overlay dialog for the specified type of overlay. cost.arma2. Category: OFP map newOverlay config Operand types: map: Control config: Config Compatibility: Version 2.92 required. distance radius around it. object] Category: OFP needReload vehicle Operand types: vehicle: Object Compatibility: Version 2. Category: Editor nextMenuItemIndex map Operand types: http://www. subj.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. type. side.html 7/11/2010 .92 required. Type of returned value: Number Description: Return how much vehicle wants to reload its weapons.com/comref/full.

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

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

Example: onBriefingGroup "GroupVoiceOver" Category: Resistance onBriefingNotes sound Operand types: sound: String Compatibility: Version 1.75 required.75 required.arma2.com/comref/full.BIS Game Engine Scripting Commands Page 247 of 415 Nothing Description: Sets the briefing objective status. 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.html 7/11/2010 . Example: onBriefingNotes "NotesVoiceOver" Category: Resistance onBriefingPlan sound Operand types: sound: String http://www. Example: "obj_1" objStatus "FAILED" Category: OFP onBriefingGroup sound Operand types: sound: String Compatibility: Version 1. Status may be one of: "ACTIVE". "FAILED". 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. "DONE" or "HIDDEN".

Example: onBriefingPlan "PlanVoiceOver" Category: Resistance onBriefingTeamSwitch sound Operand types: sound: String Compatibility: Version 2. Command receives _isHighCommand bool Category: OFP map onDoubleClick command Operand types: map: Control http://www.92 required. Type of returned value: Nothing Description: Defines an action performed when commnad mode change.com/comref/full. Example: onBriefingTeamSwitch "TeamSwitchVoiceOver" Category: Resistance onCommandModeChanged command Operand types: command: Compatibility: Version 5501 required.75 required.html 7/11/2010 .BIS Game Engine Scripting Commands Page 248 of 415 Compatibility: Version 1.arma2. 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. 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.

arma2.html 7/11/2010 . 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.com/comref/full.92 required.BIS Game Engine Scripting Commands Page 249 of 415 command: String Compatibility: Version 2. 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. Command receives: _pos array position _units array selected units _shift._alt bool key state Category: Editor onGroupIconClick command Operand types: command: Compatibility: Version 5501 required. Type of returned value: Nothing http://www.

Command receives _group group selected group _isSelected bool new selection state Category: OFP onMapSingleClick command Operand types: command: Compatibility: Version 1.91 required. Type of returned value: Nothing Description: Defines an action performed when the user clicks on the map.arma2._alt bool key state If the click is processed.com/comref/full. Type of returned value: Nothing Description: Defines an action performed when HC group has been selected. command should return true. Example: onMapSingleClick """SoldierEG"" createUnit [_pos.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. group player]" Category: Resistance parameters onMapSingleClick command Operand types: parameters: Any command: Compatibility: http://www.html 7/11/2010 . Command receives: _pos array position _units array selected units _shift.

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

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

unitTwo] orderGetIn true Category: OFP overcast Compatibility: Version 2. Example: [unitOne.92 required.BIS Game Engine Scripting Commands Page 253 of 415 Nothing Description: Defines an action performed when the team switch is finished. Type of returned value: Number Description: http://www.com/comref/full. 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.html 7/11/2010 .arma2.

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

result is 3.1415 Category: Default pickWeaponPool obj Operand types: obj: Object Compatibility: Version 1.arma2.BIS Game Engine Scripting Commands Page 255 of 415 Operand types: text: String Compatibility: Version 2. Example: txt = parseText "First line&lt. Type of returned value: Namespace Description: Return the global namespace attached to config parser.01 required. Category: OFP pi Type of returned value: Number Description: pi (180 degrees converted to radians) Example: pi . Type of returned value: Structured text Description: Creates a structured text by parsing the given XML description. 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).html 7/11/2010 .img image=data\isniper.75 required.Second line" Category: OFP parsingNamespace Compatibility: Version 5501 required.&ltbr/&gt. http://www.com/comref/full.paa/&gt.

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

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

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

Example: playMusic "musicname" http://www.position].arma2.html 7/11/2010 .ext file. but all previous playAction are discarded. Type of returned value: Nothing Description: When used on a person. Example: playMusic ["Track13".ext file.com/comref/full. Example: soldierOne playMoveNow "Stand" Category: OFP playMusic nameAndPos Operand types: nameAndPos: Array Type of returned value: Nothing Description: Plays music defined in the description. The format of nameAndPos is [name.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. Position is in seconds. 30] Category: OFP playMusic name Operand types: name: String Type of returned value: Nothing Description: Plays music defined in the description. a smooth transition to the given move will be initiated.

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

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

com/comref/full. Type of returned value: Array Description: Convert world coordinates to screen coordinates in map. 0.54 required.0075. 0. Type of returned value: Nothing Description: Set post process effect parameters Example: hndl ppEffectAdjust [0.1] Category: Visual string ppEffectAdjust array Operand types: string: String array: Array Compatibility: Version 2.arma2.1.92 required.BIS Game Engine Scripting Commands Page 262 of 415 Compatibility: Version 2. Category: OFP PC number ppEffectAdjust array Operand types: number: Number array: Array Compatibility: Version 2.html 7/11/2010 . 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.0075. 0.92 required.

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

html 7/11/2010 . 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.com/comref/full.arma2. 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. 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 ppEffectCommitted effect Operand types: effect: String Compatibility: Version 5501 required.BIS Game Engine Scripting Commands Page 264 of 415 Operand types: effect: Number Compatibility: Version 5501 required.

BIS Game Engine Scripting Commands Page 265 of 415 Category: Visual ppEffectDestroy effect Operand types: effect: Array Compatibility: Version 5501 required.arma2. 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.html 7/11/2010 . Type of returned value: Nothing Description: Enable / disable post process effect Example: hndl ppEffectEnable true Category: Visual string ppEffectEnable bool http://www.92 required.com/comref/full. 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.

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

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

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

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

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

92 required.arma2. Type of returned value: Nothing Description: Sets the current position in the progress bar. The following types are supported since 1.75 required.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. Example: publicVariable "CTFscoreOne" Category: OFP putWeaponPool obj Operand types: obj: Object Compatibility: Version 1. Only type Number is supported in versions 1.com/comref/full. Boolean. Object and Group. http://www. 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.33 and before.34: Number.html 7/11/2010 . 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.

1415 Category: Default radioVolume http://www. Example: rad 180 .com/comref/full.75 required. Category: Resistance rad x Operand types: x: Number Type of returned value: Number Description: Converts x from degrees to radians. 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).html 7/11/2010 . Category: Resistance queryWeaponPool name Operand types: name: String Compatibility: Version 1.arma2.75 required. 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). result is 3.BIS Game Engine Scripting Commands Page 272 of 415 Category: Resistance queryMagazinePool name Operand types: name: String Compatibility: Version 1.

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

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

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

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

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

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

Note: you may create invalid combinations by using this function. Note: you may create invalid combinations by using this function.html 7/11/2010 . When doing so. 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. application behaviour is undefined.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.com/comref/full.arma2. When doing so. Category: Editor map removeMenuItem text of menu item to delete Operand types: map: Control http://www. 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.92 required. Type of returned value: Nothing Description: Removes a previously added menu item. application behaviour is undefined.

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

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

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

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

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

ext file. Category: OFP unit or [unit. The variable is then available to all following missions in the campaign. The sound is defined in the description. If target is given. Type of returned value: Boolean Description: Check if saving the game is enabled. maxTitlesDistance. maxTitlesDistance] or [sound.html 7/11/2010 . it will also pefrorm the corresponding lipsync effect. the title is not shown. target]: Object or Array speechName: Array Compatibility: Version 1. speed]. Example: saveVar "varOne" Category: OFP savingEnabled Compatibility: Version 5501 required.arma2. If the unit is a person.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. target] say speechName Operand types: unit or [unit. If the camera is not withing the given range.75 required. Type of returned value: Nothing Description: The format of speechName is [sound. Category: OFP http://www.com/comref/full. The unit will play the given sound. titles will be written to the conversation history.

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

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

Type of returned value: Array Description: Returns the position on landscape (in world coordinates) corresponding to the given point on screen (in UI coordinates). Type of returned value: Nothing Description: Assign a friendly name to the VM script thjis command is executed from.html 7/11/2010 . Type of returned value: Boolean Description: Check if script is already finished Category: OFP scriptName name Operand types: name: String Compatibility: Version 5501 required. 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. Example: score unitOne Category: OFP screenToWorld position Operand types: position: Array Compatibility: Version 5501 required. Example: http://www.arma2.com/comref/full.50 required.

Launch prepared. 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. If it is true. The following states are recognized: 0 .75 required.arma2.Ignition and 4 .Launched. Example: scudState scudOne>=4 Category: OFP secondaryWeapon vehicle Operand types: vehicle: Object Compatibility: Version 1. 1 .28 required. this selects the first element of the array. Note: nonintegral values are used to indicate a transition between states. 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.No activity.com/comref/full. Type of returned value: String Description: Returns the name of a vehicle's secondary weapon (an empty string if there is none). 3 . http://www. Type of returned value: Number Description: Returns the current state of the given scud launcher.html 7/11/2010 .Launch preparation. 2 .

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

Does not un-select previously selected objects.arma2.92 required. Category: Identity selectedEditorObjects map Operand types: map: Control Compatibility: Version 2. Type of returned value: Any Description: Select an editor object.92 required. Category: Editor map selectEditorObject object Operand types: map: Control object: String Compatibility: Version 2.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.com/comref/full.92 required. Type of returned value: Nothing Description: Select the subject page in a log. Type of returned value: Nothing Description: Returns a list of currently selected editor objects. http://www. Category: Editor object selectionPosition selection name Operand types: object: Object selection name: String Compatibility: Version 2.

Returns position in model space. Example: http://www. 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. Type of returned value: Nothing Description: Switch player to no unit. then in other levels).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.com/comref/full. Category: OFP selectPlayer unit Operand types: unit: Object Compatibility: Version 2.33 required. Type of returned value: Nothing Description: Switch player to given unit. Example: group player selectLeader player Category: OFP selectNoPlayer Compatibility: Version 5501 required.html 7/11/2010 .arma2.

Example: soldierOne selectWeapon "LAWLauncher" Category: OFP object sendSimpleCommand command Operand types: object: Object command: String Compatibility: Version 2. Type of returned value: Nothing Description: Sends a simple command to the vehicle's driver / gunner.. value2. . name1.27 required. value1.92 required. value1. [type] or [type. priority.. [type] or [type. Type of returned value: Task http://www. parentTask]. priority. parentTask].com/comref/full.26 required. For weapon values see CfgWeapons.. name2.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. name2. . value2.arma2. Type of returned value: Nothing Description: Selects the given weapon.] Operand types: sender: [receiver.. Example: vehicle player sendSimpleCommand "STOP" Category: OFP sender sendTask [receiver.html 7/11/2010 .]: Array Compatibility: Version 2. name1.

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

Ammo resources are used to resupply vehicles. Example: rearmTruckOne setAmmoCargo 0 Category: OFP http://www. 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. It can also be used to slow down time in cutscenes.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.92 required. An amount of one indicates a full cargo.arma2. soldiers use individual magazines instead. Example: setAccTime 0.1 Category: OFP airportId setAirportSide side Operand types: airportId: Number side: Side Compatibility: Version 2.com/comref/full.html 7/11/2010 .

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

html 7/11/2010 . 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. A captive is neutral to everyone. If the unit is a vehicle. "COMBAT" or "STEALTH". Example: setCaptive player Category: OFP group setCombatMode mode Operand types: http://www. Behaviour is one of: "CARELESS". "SAFE".com/comref/full.57 required.arma2. "AWARE". Type of returned value: Nothing Description: Set camera interest for given entity. Example: groupOne setBehaviour "SAFE" Category: OFP entity setCameraInterest interest Operand types: entity: Object interest: Number Compatibility: Version 2. the vehicle commander is marked instead.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.

defend only).arma2. Category: OFP object setDamage damage Operand types: object: Object damage: Number Compatibility: http://www. Mode can be one of: "BLUE" (Never fire).com/comref/full. "GREEN" (Hold fire . "YELLOW" (Fire at will) or "RED" (Fire at will. Example: groupOne setCombatMode "BLUE" Category: OFP person setCurrentTask task Operand types: person: Object task: Task Compatibility: Version 5501 required.html 7/11/2010 . engage at will). "WHITE" (Hold fire. Category: Identity group setCurrentWaypoint waypoint Operand types: group: Group waypoint: Array Compatibility: Version 5129 required.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). engage at will). Type of returned value: Nothing Description: Set the task as a current task of the person. Type of returned value: Nothing Description: Switch the group to process the given waypoint.

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

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

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

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

Example: setFlagOwner objNull Category: OFP flag setFlagSide side Operand types: flag: Object side: Side Type of returned value: Nothing Description: Sets the flag side.arma2. Blink is in the range from 0 to 1. the flag is returned to the flagpole.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).html 7/11/2010 .5 Category: OFP flag setFlagOwner owner Operand types: flag: Object owner: Object Type of returned value: Nothing Description: Sets the flag owner. Example: setFaceAnimation 0.com/comref/full. Example: setFlagSide east Category: OFP flag setFlagTexture texture Operand types: flag: Object texture: String http://www. When the owner is set to objNull.

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

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

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. The FSM handle is the number returned by the execFSM command. Example: refuelTruckOne setFuelCargo 0 Category: OFP group setGroupIcon properties Operand types: group: Group properties: Array Compatibility: Version 5501 required.html 7/11/2010 .com/comref/full. Category: OFP vehicle setFuel amount Operand types: vehicle: Object amount: Number Type of returned value: Nothing Description: Sets the fuel amount. 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. Type of returned value: Nothing http://www. A fuel level of one is a full gas tank. A fuel level of one is a full gas tank.arma2.

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

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

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

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

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.com/comref/full. Brush is the name of the subclass in CfgMarkerBrushes. Type of returned value: Nothing Description: Sets the marker alpha.5 Category: OFP name setMarkerBrush brush Operand types: name: String brush: String Compatibility: Version 1.arma2.html 7/11/2010 . The marker is only modified on the computer where the command is called. Example: "Marker1" setMarkerBrush "DiagGrid" Category: OFP name setMarkerBrushLocal brush Operand types: name: String brush: String Compatibility: Version 2. Type of returned value: Nothing Description: Selects the fill texture for the marker ("RECTANGLE" or "ELLIPSE"). The marker is modified on all computers in a network session. http://www. Example: "MarkerOne" setMarkerAlpha 0.92 required.86 required. The marker is only modified on the computer where the command is called. Type of returned value: Nothing Description: Selects the fill texture for the marker ("RECTANGLE" or "ELLIPSE").

"ColorGreen".21 required. Type of returned value: Nothing Description: Sets the marker color.arma2.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. Color is one of: "Default". "ColorYellow" or "ColorWhite". The marker is only modified on the computer where the command is called.com/comref/full. "ColorRed". The marker is modified on all computers in a network session. Type of returned value: Nothing Description: Sets the marker color. "ColorYellow" or "ColorWhite".92 required. Example: "MarkerOne" setMarkerColor "ColorBlack" Category: OFP marker setMarkerColorLocal color Operand types: marker: String color: String Compatibility: Version 2. "ColorRed". "ColorRedAlpha". "ColorBlack".html 7/11/2010 . "ColorRedAlpha". "ColorGreen". Example: "MarkerOne" setMarkerColorLocal "ColorBlack" Category: OFP name setMarkerDir angle Operand types: name: String angle: Number http://www. "ColorBlack". Color is one of: "Default". "ColorGreenAlpha". "ColorGreenAlpha". "ColorBlue". "ColorBlue".

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

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

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

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

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

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

An overcast level of zero means clear (sunny) weather and with an overcast level of one.75 required.5 Category: OFP particleSource setParticleCircle [radius. velocity] Operand types: particleSource: Object [radius. Example: 1800 setOvercast 0.56 required. 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).arma2.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. velocity]: Array Compatibility: Version 2. Category: Editor object setObjectTexture texture Operand types: object: Object texture: Array Compatibility: Version 1.com/comref/full.html 7/11/2010 . A time of zero means an immediate change. Velocity is transformed and http://www. storms and showers are very likely. Type of returned value: Nothing Description: Update particle source to create particles on circle with given radius.

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

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

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

Example: player setRank "COLONEL" Category: OFP location setRectangular rectangular Operand types: location: Location rectangular: Boolean Compatibility: Version 2.arma2. Possible values: PRIVATE. CAPTAIN.html 7/11/2010 . Type of returned value: Nothing Description: Sets rank of given unit. MAJOR or COLONEL. LIEUTENANT. Example: http://www.90 required. SERGEANT. 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.com/comref/full.92 required. An amount of one is a full cargo space. Type of returned value: Nothing Description: Set if given location has rectangular shape. CORPORAL.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.

Category: Location task setSimpleTaskDescription [description. Type of returned value: Nothing Description: Set a new target side of given location. descriptionShort.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.90 required. descriptionShort.html 7/11/2010 .com/comref/full. Type of returned value: Nothing Description: Attach a destination to the simple task. descriptionHUD]: Array Compatibility: Version 5500 required.arma2. descriptionHUD] Operand types: task: Task [description. Category: Identity task setSimpleTaskDestination position Operand types: task: Task position: Array Compatibility: Version 5500 required. Category: Identity http://www. Type of returned value: Nothing Description: Attach descriptions to the simple task.

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

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

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

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

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

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

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

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

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

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

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

Type of returned value: Nothing Description: Sets id (integer value) to vehicle. Type of returned value: Nothing Description: http://www. By this id vehicle is referenced by triggers and waypoints.33 required.33 required. Example: player setVehicleId 1 Category: OFP vehicle setVehicleInit statement Operand types: vehicle: Object statement: String Compatibility: Version 2.32 required. Example: player setVehicleArmor 0.arma2. Type of returned value: Nothing Description: Sets the armor (or health for men) state of the vehicle (a value from 0 to 1).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.html 7/11/2010 .com/comref/full.

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

Category: OFP showHUD enable Operand types: enable: Boolean Compatibility: Version 5501 required. Category: OFP showGps show Operand types: show: Boolean Type of returned value: Nothing Description: Enables the GPS receiver (the default is false).92 required.com/comref/full. Type of returned value: Nothing Description: Enable / disable showing of HUD.html 7/11/2010 . Category: Editor http://www.arma2. 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). Category: OFP map showLegend bool Operand types: map: Control bool: Boolean Compatibility: Version 2.

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

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

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

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

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

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

html 7/11/2010 . Example: someAmmo vehicle player Category: OFP soundVolume Type of returned value: Number Description: Checks the current sound volume (set by setSoundVolume).arma2. Category: OFP arguments spawn script Operand types: arguments: Any script: Code Compatibility: Version 2.50 required. Category: OFP speed obj Operand types: obj: Object Type of returned value: Number Description: Returns the object speed (in km/h).com/comref/full. Argument is passed to the script as local variable _this.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. Type of returned value: Script Description: Executes a script. Example: speed player Category: OFP http://www.

"NORMAL" or "FULL").. result is 3 Category: Default startLoadingScreen [text] or [text. Category: OFP for /. using the given resource. resource] Operand types: [text] or [text.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". simulation and scene drawing is disabled./ step step Operand types: for /. When loading screen is shown.. Example: speedMode group player Category: OFP sqrt x Operand types: x: Number Type of returned value: Number Description: The square root of x. resource]: Array Compatibility: Version 5501 required.arma2.html 7/11/2010 .com/comref/full.. Type of returned value: Nothing Description: Shows loading screen with the given text.. scripts run at full speed. Example: sqrt 9 ./: for type http://www.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

arma2. Type of returned value: Array Description: http://www. 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. 1] Category: OFP waypointType waypoint Operand types: waypoint: Array Compatibility: Version 5500 required.html 7/11/2010 .61 required. Example: waypointType [groupOne.BIS Game Engine Scripting Commands Page 396 of 415 Example: waypointStatements [groupOne. Type of returned value: String Description: Gets the waypoint type. Example: waypointTimeout [groupOne. 1] Category: OFP waypointTimeout waypoint Operand types: waypoint: Array Compatibility: Version 5500 required.com/comref/full.

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

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

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

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

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

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

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

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

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

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

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

Local variables A local variable is any variable which name starts with an underscore. &__waitUntil Command: any expression returning no value. Example: @condition Waiting for a time: line starting with '&'. Example: ?_condVar>10:_var=_var+2 Note: variable _time is reserved. Example: _unit setBehaviour "safe" Assignment: assignment of any value to variable. http://www. If assignment is made into a variable that does not exist in any visible scope. Example: &endTime is equivalent to @_time >= (endTime) Delay: line starting with '~'.arma2. exec and call define a visibility scope for local variables. forEach. All other variables are global. Script syntax Each script line may be one of the following: Comment: line starting with '. The recommended file extension for functions is . it is created in the innermost scope.This is comment Label: line starting with '#'.com/comref/full. Local variables can be used during script execution to avoid variable conflicts.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. Variables starting with two underscores are reserved and should never be used.SQS used for scripts). Each of the commands then. while. You can use function private to introduce variables at any given scope. It is used to keep the time elapsed since the script execution started. Example: #LabelName Waiting for a condition: line starting with '@'.SQF (as opposed to . All local variables from outer scopes are visible as well. Example: ~delay is equivalent to __waitUntil = _time+(cas) . 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). the command is executed only when the condition is satisfied.html 7/11/2010 .'. A local variable name starts with an underscore ('_'). Example: . count. Example: _a = 10 Conditional: ? condition : command or assignmented. do.

it is converted to false. When an undefined value is encountered in a field where a boolean value is expected. Variables Variables have to be inicialized before being used. Variable denoting trigger can be created by filling in the name field.arma2. The On Activation and On Deactivation expressions define actions that are peformed when the trigger condition changes to true or false. Variables may be unitialized by assigning it the nil value. When any uninitialized variable is detected in any expression. This effectively destroys the variable as if it never existed. The expression must either be an assignment or return nothing (see type none). 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). Boolean variable this is set during evaluation of the condition expression to the primary waypoint termination condition. The On Activation expression defines an action that is peformed after the waypoint is terminated. Waypoints The Condition expression is used to determine when the waypoint execution is terminated. Boolean variable this is set during evaluation of the condition expression to the primary sensor activation condition. Array variable thisList is set to the list of all units in the group that the given waypoint is assigned to. Condition must return a boolean value.com/comref/full. Array variable thisList is set to the list of all vehicles that would satisfy the primary sensor activation condition. Expressions must either be an assignment or return nothing (see type none).BIS Game Engine Scripting Commands Page 409 of 415 Triggers The Condition expression is used to determine when the trigger is activated.html 7/11/2010 . Condition must return a boolean value.

com/comref/full.arma2.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.html 7/11/2010 .

html 7/11/2010 .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.com/comref/full.arma2.

html 7/11/2010 .arma2.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.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.arma2.html 7/11/2010 .com/comref/full.

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.com/comref/full.arma2.html 7/11/2010 .

com/comref/full.html 7/11/2010 .arma2.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.

Sign up to vote on this title
UsefulNot useful