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

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

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

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

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

html 7/11/2010 . Type of returned value: Config Description: Returns subentry of config entry with given name.35 required.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.arma2. Example: configFile >> "CfgVehicles" Category: OFP PC a^b Operand types: a: Number b: Number Type of returned value: Number Description: a raised to the power of b http://www.

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

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

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

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

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

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

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

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

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

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

Category: Editor http://www. 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. Type of returned value: Array Description: Return a list of all groups. Example: alive player Category: OFP allGroups Compatibility: Version 5501 required.medic.BIS Game Engine Scripting Commands Page 24 of 415 Type of returned value: Nothing Description: AIS end state.com/comref/full.arma2. Type of returned value: Nothing Description: Allow/dissallow 3D mode. vehicle or building is't dead / destroyed. Example: AISFinishHeal [wounded.92 required.html 7/11/2010 .

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

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

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

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

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. 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.html 7/11/2010 . Example: player assignAsCommander tankOne Category: OFP soldier assignAsDriver vehicle Operand types: soldier: Object vehicle: Object Type of returned value: Nothing Description: Assigns the soldier as driver of the given vehicle.arma2. http://www. halts the program.com/comref/full.

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

html 7/11/2010 . Category: OFP assignedGunner vehicle Operand types: vehicle: Object Compatibility: Version 5501 required. Category: OFP assignedTarget vehicle Operand types: vehicle: Object Compatibility: Version 2.92 required.arma2.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: Return the target assigned to the vehicle.com/comref/full. Category: OFP assignedVehicle person Operand types: person: Object Compatibility: Version 5130 required. Type of returned value: Object Description: http://www. Type of returned value: Object Description: Returns the soldier assigned to the given vehicle as a gunner. Type of returned value: Object Description: Returns the soldier assigned to the given vehicle as a driver.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Example: _camera camSetDive -0. It does not automatically commit changes. It does not automatically commit changes.arma2.html 7/11/2010 . 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.com/comref/full. Example: _camera camSetBank -0.1 Category: OFP camera camSetDir direction Operand types: camera: Object direction: Number Type of returned value: Nothing Description: Sets the camera heading.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. It does not automatically commit changes.1 Category: OFP camera camSetFocus focusRange Operand types: camera: Object focusRange: Array http://www.

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

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

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

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.com/comref/full. 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.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. only the damage status is checked.html 7/11/2010 .arma2. It does not test for fuel. Type of returned value: Boolean Description: Check if cargo of this vehicle want to get out when in combat.

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

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

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

com/comref/full.BIS Game Engine Scripting Commands Page 56 of 415 Compatibility: Version 2. Type of returned value: Nothing Description: Clear vehicle init field. 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.75 required. http://www. Example: clearWeaponCargo jeepOne Category: OFP clearWeaponPool Compatibility: Version 1.73 required.arma2. Category: OFP clearVehicleInit vehicle Operand types: vehicle: Object Compatibility: Version 5154 required. 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).html 7/11/2010 . Type of returned value: Nothing Description: Clean up the content of radio protocol history.

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

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

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

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

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

arma2. 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).85 required.html 7/11/2010 .com/comref/full.BIS Game Engine Scripting Commands Page 62 of 415 position: Object Type of returned value: Nothing Description: Orders the unit to target the given target (via the radio). Example: soldierOne commandWatch player Category: OFP comment comment Operand types: comment: String Compatibility: Version 1. Type of returned value: http://www. 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).

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

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

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

1.35 required. result is 0.2] . result is 4 http://www.com/comref/full.html 7/11/2010 . 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.arma2. The target group will start to process waypoints from the first one.0. the argument is in degrees. Category: OFP cos x Operand types: x: Number Type of returned value: Number Description: The cosine of x. Example: count [0.BIS Game Engine Scripting Commands Page 66 of 415 Description: Copy the chain of waypoints from source to target group. Example: cos 60 . Type of returned value: Number Description: Returns count of subentries.5 Category: Default count config Operand types: config: Config Compatibility: Version 2.

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

special] http://www. Example: player countUnknown list triggerOne Category: OFP createAgent [type.BIS Game Engine Scripting Commands Page 68 of 415 side countSide array Operand types: side: Side array: Array Type of returned value: Number Description: Checks how many vehicles belong to the given side. 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. position.html 7/11/2010 . placement.arma2.com/comref/full. For types see CfgVehicles. 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.

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

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

Type of returned value: Nothing Description: Create child display of given display and load from resource "name".86 required.com/comref/full.BIS Game Engine Scripting Commands Page 71 of 415 _index = player createDiarySubject ["myPage".arma2."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).html 7/11/2010 .53 required.resource]: Array Compatibility: Version 5501 required. http://www. Example: _display createDisplay "RscObserver" Category: OFP PC CreateGearDialog [unit.resource] Operand types: [unit. "My page"] Category: Identity parent createDisplay name Operand types: parent: Display name: String Compatibility: Version 2. Example: CreateGearDialog [palyer. Type of returned value: Nothing Description: Opens gear dialog for given unit.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

html 7/11/2010 .com/comref/full. 1] Category: OFP PC control ctrlSetAutoScrollDelay delay Operand types: control: Control http://www. Type of returned value: Number Description: Returns the current scale of control. 0] Category: OFP PC ctrlScale control Operand types: control: Control Compatibility: Version 5501 required. 0.50 required. 0. Type of returned value: Nothing Description: Remove a given event handler from the given control. 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.arma2. Example: _scale = ctrlScale _control Category: OFP PC display ctrlSetActiveColor color Operand types: display: Control color: Array Compatibility: Version 2. Color is in format Color. Example: _control ctrlSetActiveColor [1. Example: _control ctrlRemoveEventHandler ["KeyDown".

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

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

50 required. Type of returned value: Nothing Description: Set the input focus on given control.html 7/11/2010 .50 required. 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. Example: _control ctrlSetFont "TahomaB" Category: OFP PC control ctrlSetFontH1 name Operand types: control: Control name: String Compatibility: Version 2.arma2. Type of returned value: Nothing Description: Sets H1 font of given HTML control. Example: ctrlSetFocus _control Category: OFP PC control ctrlSetFont name Operand types: control: Control name: String Compatibility: Version 2. Type of returned value: Nothing Description: Sets the main font of given control.com/comref/full.92 required.

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

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

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

50 required. Example: _control ctrlSetFontH6B "TahomaB" Category: OFP PC control ctrlSetFontHeight height Operand types: control: Control height: Number Compatibility: Version 2.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.50 required.arma2.com/comref/full. Example: _control ctrlSetFontH6 "TahomaB" Category: OFP PC control ctrlSetFontH6B name Operand types: control: Control name: String Compatibility: Version 2. Type of returned value: Nothing Description: Sets H6 bold font of given HTML control. Type of returned value: Nothing http://www.html 7/11/2010 . Type of returned value: Nothing Description: Sets H5 font of given HTML control.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

the unit is ordered to commence firing on its current target (set using doTarget or commandTarget).BIS Game Engine Scripting Commands Page 122 of 415 10000.arma2. the loop will be terminated and an error message is shown. case 2 : {block}. 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). default {block}. http://www. If the target is objNull.html 7/11/2010 . 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}. If the condition is still true after the loop was repeated 10000 times.com/comref/full.} Category: Default unit doFire target Operand types: unit: Object or Array target: Object Type of returned value: Nothing Description: Orders a unit to commence firing on the given target (silently).

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

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

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

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

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

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

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

92 required. driver.92 required. 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.arma2. Category: OFP enableEndDialog Type of returned value: http://www. Type of returned value: Number Description: Returns the number of available cargo. Example: _freePositions = (vehicle player) freePositions "cargo" Category: OFP unit enableAI section Operand types: unit: Object section: String Compatibility: Version 2.html 7/11/2010 . Type of returned value: Nothing Description: Enables parts of the AI behaviour. gunner or commander positions in the vehicle.53 required. Section is one of "TARGET" (enables watching assigned targets).com/comref/full.BIS Game Engine Scripting Commands Page 130 of 415 Compatibility: Version 2.

html 7/11/2010 . Category: OFP enableEnvironment enabled Operand types: enabled: Boolean Compatibility: Version 2. 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.arma2. Example: _vehicle enableReload false http://www. Type of returned value: Nothing Description: Enable/disable environmental effects (ambient life + sound).92 required. Category: OFP object enableReload enable Operand types: object: Object enable: Boolean Compatibility: Version 2.92 required. Type of returned value: Nothing Description: Enable / disable reload right after magazine is empty.com/comref/full.

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

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

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

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

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

Type of returned value: Any Description: if result of condition is true.sqf" Category: OFP PC exit Type of returned value: Nothing Description: Exits the script. result is [when _x is greater then 5. 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._x} .arma2. result is 2. evaluates code. Example: exp 1 . 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".BIS Game Engine Scripting Commands Page 137 of 415 player execVM "test.html 7/11/2010 .com/comref/full.7182 Category: Default expectedDestination person http://www.

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

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

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

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

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

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

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

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

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

It's executed as follows: for each element of array an element is assigned as _x and the command is executed. result is "1 .html 7/11/2010 . 1. "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.%2 .com/comref/full.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. %2. 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. This string may contain references to the following arguments using format %1.text .arma2.92 required. Example: format ["%1 . etc.1" http://www.%1". Each %x is replaced by the corresponding argument. Type of returned value: Nothing Description: Force the speed of the given object. %x may appear in the string in any order.

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

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

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

Type of returned value: String Description: Returns gear slot item name.com/comref/full.html 7/11/2010 . Type of returned value: Array Description: Extract array from config entry.35 required.arma2. Example: getDammage player Category: OFP http://www.BIS Game Engine Scripting Commands Page 151 of 415 Category: OFP gearSlotData control Operand types: control: Control Compatibility: Version 5501 required. 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. Example: weapon = gearSlotData _control Category: OFP PC getArray config Operand types: config: Config Compatibility: Version 2.

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

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

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

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

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

BIS Game Engine Scripting Commands Page 157 of 415 Category: Editor map getObjectChildren object Operand types: map: Control object: String Compatibility: Version 2.92 required. Category: Editor getPos obj Operand types: obj: Object Type of returned value: Array Description: Returns the object position in format Position. Example: getPos player Category: OFP getPos location http://www.92 required.com/comref/full.html 7/11/2010 . 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.arma2. Type of returned value: Object Description: Return the proxy object associated with the given editor object.

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

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

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

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

Example: group player == group leader player Category: OFP unit groupChat chatText Operand types: http://www. Example: soldierOne globalRadio "messageOne" Category: OFP goto label Operand types: label: String Type of returned value: Nothing Description: Only in scripts: go to given label. Note: the string argument is used here.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. grpNull is returned. For dead units.ext file or radio protocol.com/comref/full.arma2.html 7/11/2010 . 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. Be sure to use double quotes around the label name in goto.

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

true] Category: OFP grpNull Type of returned value: Group Description: A non-existing group.bool] Operand types: unit: Object [unit.html 7/11/2010 . including itself. Example: player groupSelectUnit [unit. Type of returned value: Array Description: Returns selected groups in sgroup.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: array = groupSelectedUnits unit Category: OFP unit groupSelectUnit [unit. This value is not equal to anything.com/comref/full. Example: group player == objNull . result is false Category: OFP http://www.arma2. Type of returned value: Nothing Description: Select unit from unit's group.bool]: Array Compatibility: Version 5501 required.

com/comref/full. Type of returned value: Nothing Description: Stops the program into a debugger. 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). Example: handsHit leader player Category: OFP unit hasWeapon weaponName Operand types: http://www. but a person. the person is returned.00 required. Example: gunner vehicle player Category: OFP halt Compatibility: Version 2.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.html 7/11/2010 .arma2. If the vehicle is not a vehicle.

Return value is [string.html 7/11/2010 . Example: array = hcAllGroups unit Category: OFP unit hcGroupParams group Operand types: unit: Object group: Group Compatibility: Version 5501 required. Example: player hasWeapon "M16" Category: OFP hcAllGroups unit Operand types: unit: Object Compatibility: Version 5501 required.com/comref/full. Type of returned value: Array Description: Returns selected groups in high command.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.float[4]] Example: unit hcGroupParams group Category: OFP hcLeader group Operand types: http://www. Type of returned value: Array Description: Returns parameters describing group in high command bar.

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

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

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

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

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

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

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

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

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

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

com/comref/full. Category: OFP isEngineOn vehicle Operand types: vehicle: Object Compatibility: Version 1. Type of returned value: Boolean Description: Check if config entry represents config class. Type of returned value: Boolean Description: Return true for dedicated server. Example: _ok = isArray (configFile >> "CfgVehicles") .90 required.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.35 required. result is true Category: OFP PC isDedicated Compatibility: Version 5501 required. Type of returned value: Boolean Description: http://www. result is false Category: OFP PC isClass config Operand types: config: Config Compatibility: Version 2.html 7/11/2010 . Example: _ok = isClass (configFile >> "CfgVehicles") .35 required.

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

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

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

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

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

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

html 7/11/2010 .35 required. Type of returned value: Boolean Description: Returns true if the computer is the server.arma2. Type of returned value: Boolean Description: Check if config entry represents text. Category: Editor isText config Operand types: config: Config Compatibility: Version 2. Example: _isRealTime = isRealTime _map Category: Editor isServer Compatibility: Version 2. result is false http://www.92 required.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. Category: OFP isShowing3DIcons map Operand types: map: Control Compatibility: Version 2. Example: _ok = isText (configFile >> "CfgVehicles") . Type of returned value: Boolean Description: Returns true if the editor is set to draw 3D icons.com/comref/full.92 required.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Possible values are "ON". Type of returned value: Structured text Description: Creates a structured text containing a line break. "OFF" and "AUTO" (auto means the lamp will be shining during the night automatically). 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.01 required. Type of returned value: Nothing Description: Limit speed of given vehicle to given value (in km/h). Example: lightIsOn nearestObject [player. Category: OFP lineBreak Compatibility: Version 2.92 required.BIS Game Engine Scripting Commands Page 206 of 415 Type of returned value: String Description: Checks whether the lampost is turned on. "StreetLamp"] != "OFF" Category: OFP object limitSpeed speed Operand types: object: Object speed: Number Compatibility: Version 2. http://www.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".html 7/11/2010 .

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

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

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

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

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

50 required.html 7/11/2010 . column] Category: OFP PC lnbDeleteColumn [idc. index] Operand types: [idc. index] Operand types: [idc. Example: _data = _control lnbData [row. 0] Category: Resistance control lnbDeleteColumn index Operand types: control: Control index: Number Compatibility: Version 5501 required. Example: _control lbDelete 0 Category: OFP PC lnbDeleteRow [idc. Example: lnbDeleteColumn [101. index]: Array Compatibility: Version 1. 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. Type of returned value: Nothing Description: Removes the item with the given index from the given listbox or combobox. index]: Array Compatibility: Version 5501 required. Type of returned value: Nothing Description: Removes column with given index.com/comref/full.

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

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

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

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

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

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

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

Type of returned value: Array Description: Returns the number of items in the given listbox or combobox.arma2.1]] Category: Resistance control lnbText [row. Type of returned value: String Description: Returns the shown text in the item with the given position of the given 2D listbox.com/comref/full. Example: _text = lnbText [101.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 1. column]] Operand types: [idc. [row.50 required. [0. http://www. [row. Type of returned value: String Description: Returns the shown text in the item with the given position of the 2D listbox. column] Operand types: control: Control [row. column]: Array Compatibility: Version 5501 required. Example: _n = lbSize _control Category: OFP PC lnbText [idc.html 7/11/2010 .91 required.

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

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

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

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

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

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

result is 1 Category: Default unit(s) lookAt position Operand types: unit(s): Object or Array position: Object or Array Compatibility: Version 2. 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). This is sometimes used during cut-scenes.com/comref/full.arma2.BIS Game Engine Scripting Commands Page 227 of 415 Type of returned value: Nothing Description: Lock the gunner position of the vehicle turret.html 7/11/2010 .40 required. Example: log 10 . Example: groupOne lockWP true Category: OFP log x Operand types: x: Number Type of returned value: Number Description: The base-10 logarithm of x.

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

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

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

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

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

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

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

html 7/11/2010 .+1). Example: soldierOne moveInCargo jeepOne Category: OFP http://www. (Immediately. Type of returned value: Number Description: Checks a current morale level of the unit (-1.com/comref/full. result is 0..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. Example: morale leader player .BIS Game Engine Scripting Commands Page 235 of 415 morale unit Operand types: unit: Object Compatibility: Version 5500 required. 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. without animation).

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

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

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

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

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

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

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

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

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

Category: Editor nextWeatherChange Compatibility: Version 2. Category: OFP nil Type of returned value: Any Description: Nil value. Type of returned value: Number Description: Returns the next available menu item index.arma2. Type of returned value: Number Description: Returns the total number of user-added menu items belonging to the given menu. Type of returned value: Number Description: Return the time (in seconds) when the next weather change will occur.92 required.92 required. This value can be used to undefine an existing variable.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.html 7/11/2010 .92 required.com/comref/full. Category: Editor http://www.

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

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

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

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

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

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

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

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

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

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

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

09 required. Type of returned value: Number Description: Return the player remaining time to respawn. http://www.92 required. Type of returned value: Number Description: Returns the number of players playing on the given side. Example: alive player Category: OFP playerRespawnTime Compatibility: Version 2.arma2. Category: OFP playersNumber side Operand types: side: Side Compatibility: Version 1. This is valid even when the player controlled person is dead (a difference from player side). Type of returned value: Side Description: Returns the player's side. In MP this value is different on each computer. Category: OFP playerSide Compatibility: Version 2.com/comref/full.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.80 required.

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

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

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

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

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

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

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

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

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

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

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

arma2. Example: primaryWeapon player Category: Resistance priority task Operand types: task: Task Compatibility: Version 2. result is "if a>b then {a} else {b}" Category: OFP primaryWeapon vehicle Operand types: vehicle: Object Compatibility: Version 1.com/comref/full. Type of returned value: Nothing Description: Introduces one or more local variables in the innermost scope.sqf" .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.html 7/11/2010 .91 required. Type of returned value: Number Description: Return the priority of the task.75 required. Category: Default http://www. Type of returned value: String Description: Returns the name of the vehicle's primary weapon (an empty string if there is none).85 required.

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

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

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

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

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

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

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.11 required.85 required.com/comref/full. Example: player remoteControl gunner _uav Category: OFP unit removeAction index Operand types: unit: Object index: Number Compatibility: Version 1. Type of returned value: Nothing Description: Removes the action with the given id.arma2. Type of returned value: Nothing Description: Switch on remote control of the unit.html 7/11/2010 .BIS Game Engine Scripting Commands Page 276 of 415 Operand types: who: Object whom: Object Compatibility: Version 5501 required. Example: player removeAction 0 Category: OFP object removeAllEventHandlers handlerType Operand types: object: Object handlerType: String Compatibility: Version 1.

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

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

When doing so. Type of returned value: Nothing Description: Removes a previously added menu item.com/comref/full. 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. Note: you may create invalid combinations by using this function. application behaviour is undefined. 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. Category: Editor map removeMenuItem text of menu item to delete Operand types: map: Control http://www.arma2.html 7/11/2010 .92 required.BIS Game Engine Scripting Commands Page 279 of 415 Operand types: unit: Object weaponName: String or Array Type of returned value: Nothing Description: Removes the magazine from the unit. Note: you may create invalid combinations by using this function.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Type of returned value: Nothing Description: Set a new size (width. 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. Value of skill may vary from 0 to 1. Value of skill may vary from 0 to 1. skill] Operand types: vehicle: Object [type.75 required. height) of given location.com/comref/full. Example: hero setSkill ["Endurance". 1] Category: OFP PC http://www. skill]: Array Compatibility: Version 2. Type of returned value: Nothing Description: Sets skill of given type of person (commander unit). sizeZ] Operand types: location: Location [sizeX. Example: hero setSkill 1 Category: Resistance vehicle setSkill [type.90 required.65 required. Category: Location vehicle setSkill skill Operand types: vehicle: Object skill: Number Compatibility: Version 1.arma2.html 7/11/2010 .

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

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

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

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

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

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

SERGEANT. CORPORAL. Type of returned value: Nothing Description: Equal to setUnitPos. 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.html 7/11/2010 . LIEUTENANT. Possible values: PRIVATE.com/comref/full.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. Example: soldierOne setUnitPosWeak "Down" Category: OFP unit setUnitRank rank Operand types: unit: Object rank: String Compatibility: Version 2.33 required. Example: player setUnitRank "COLONEL" Category: OFP http://www. "UP" or "AUTO". MAJOR or COLONEL. Example: soldierOne setUnitPos "Down" Category: OFP unit setUnitPosWeak mode Operand types: unit: Object mode: String Compatibility: Version 5117 required. CAPTAIN.

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

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

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

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

BIS Game Engine Scripting Commands

Page 338 of 415

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

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

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

object setVehicleVarName name
Operand types: object: Object

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

7/11/2010

BIS Game Engine Scripting Commands

Page 339 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 340 of 415

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

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

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

waypoint setWaypointCompletionRadius radius
Operand types: waypoint: Array

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

7/11/2010

BIS Game Engine Scripting Commands

Page 341 of 415

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 342 of 415

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 343 of 415

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 344 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 345 of 415

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

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

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

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

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

7/11/2010

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

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

5 Category: OFP sleep delay Operand types: delay: Number Compatibility: Version 2. Type of returned value: Nothing Description: Suspend execution of script for given time.5 Category: OFP sliderPosition idc Operand types: idc: Number http://www.65 required. Example: hero skill "Endurance" Category: OFP PC skipTime duration Operand types: duration: Number Type of returned value: Nothing Description: Skips the specified time. a weather change is estimated and no changes to any units are done.BIS Game Engine Scripting Commands Page 355 of 415 type: String Compatibility: Version 2.60 required. Daytime is adjusted.arma2. Type of returned value: Number Description: Returns skill of given type of person (commander unit). Example: skipTime 2.com/comref/full. Duration is in hours. Value of skill may vary from 0 to 1. Example: sleep 0.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. Type of returned value: Number Description: Returns the current thumb position of the slider with id idc of the topmost user dialog. Example: _limits = sliderRange 100 Category: Resistance sliderRange control Operand types: control: Control http://www.79 required.79 required. Example: _pos = sliderPosition _control Category: OFP PC sliderRange idc Operand types: idc: Number Compatibility: Version 1.com/comref/full.arma2.92 required. max]) of the slider with id idc of the topmost user dialog.BIS Game Engine Scripting Commands Page 356 of 415 Compatibility: Version 1.html 7/11/2010 . Type of returned value: Number Description: Returns the current thumb position of the given slider.

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

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

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

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

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

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

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

BIS Game Engine Scripting Commands

Page 364 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 365 of 415

Category: OFP

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 366 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 367 of 415

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 368 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 369 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 370 of 415

Category: Identity

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

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

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

taskParent task

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

7/11/2010

BIS Game Engine Scripting Commands

Page 371 of 415

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

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

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

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

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

7/11/2010

arma2.html 7/11/2010 . Type of returned value: Structured text Description: Creates a structured text containing the given plain text. Category: Location text text Operand types: text: String Compatibility: Version 2.92 required.50 required. Type of returned value: Boolean Description: Check if tam switch is currently enabled.com/comref/full.90 required.01 required.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. Type of returned value: String Description: Return text attached to given location. Category: OFP terminate script Operand types: script: Script Compatibility: Version 2. http://www.

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

See try.html 7/11/2010 . If the code is not executed. 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. 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). the last value calculated in the code is returned.arma2. Category: OFP titleCut effect http://www. If the code is executed. The exception is processed by first catch block.com/comref/full.BIS Game Engine Scripting Commands Page 374 of 415 Category: Default if then codeToExecute Operand types: if: If Type codeToExecute: Code Compatibility: Version 1.85 required.

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

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

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

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

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

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

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

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

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

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". until the command is finished.arma2.html 7/11/2010 .92 required. Type of returned value: String Description: Return the unit position rules.com/comref/full. 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. Category: OFP unitReady unit Operand types: unit: Object or Array Type of returned value: Boolean Description: Checks whether the unit is ready. Example: player in units player Category: OFP units grp Operand types: grp: Group Type of returned value: http://www. For a destroyed object an empty array is returned.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Sign up to vote on this title
UsefulNot useful