BIS Game Engine Scripting Commands

Page 1 of 415

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

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

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

location1 != location2
Operand types: location1: Location

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

7/11/2010

BIS Game Engine Scripting Commands

Page 2 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 3 of 415

side player != west Category: OFP

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 4 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 5 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 6 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 7 of 415

Category: Default

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 8 of 415

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

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

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

a<b
Operand types: a: Number

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

7/11/2010

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

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

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

false is returned.com/comref/full. Category: Location a == b Operand types: a: String b: String Type of returned value: Boolean Description: a equal to b (case insensitive) Example: nameOfPlayer == "John Doe" Category: Default a>b Operand types: a: Number b: Number Type of returned value: Boolean Description: http://www.html 7/11/2010 .arma2. If either of them is null.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.

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

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

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

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

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

for example by adding 20 grenades. Example: player addMagazine "M16" Category: OFP unit addMagazineCargo magazines Operand types: unit: Object magazines: Array Type of returned value: Nothing Description: Adds magazines to the weapon cargo space. Note: you may create invalid combinations by using this function. For magazineName values see CfgWeapons.html 7/11/2010 . When doing so. count]. The format of magazines is [magazineName. Category: Resistance http://www. Example: rearmTruckOne addMagazineCargo ["M16". This is used for infantry weapons. application behaviour is undefined.com/comref/full. 10] Category: OFP addMagazinePool Compatibility: Version 1.arma2.75 required. 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).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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Example: _camera camSetRelPos [10. It does not automatically commit changes.html 7/11/2010 . 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.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). It does not automatically commit changes.arma2. http://www. Example: _camera camSetPos getPos player Category: OFP camera camSetRelPos position Operand types: camera: Object position: Array Type of returned value: Nothing Description: Sets the camera position relative to the current position of the currect target (see camSetTarget). It does not automatically commit changes. It does not automatically commit changes.

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

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

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

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

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

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

Type of returned value: Nothing Description: Close given display.arma2.BIS Game Engine Scripting Commands Page 57 of 415 Category: Resistance closeDialog idc Operand types: idc: Number Compatibility: Version 1. 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. Category: Editor http://www.92 required. Example: closeDialog 1 Category: Resistance display closeDisplay exitcode Operand types: display: Display exitcode: Number Compatibility: Version 2. Example: _display closeDisplay IDC_OK Category: OFP PC closeOverlay map Operand types: map: Control Compatibility: Version 2.53 required.com/comref/full.50 required.html 7/11/2010 .

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

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).arma2.BIS Game Engine Scripting Commands Page 59 of 415 commander vehicle Operand types: vehicle: Object Type of returned value: Object Description: Returns the commander of the vehicle. the unit is ordered to commence firing on its current target (set using doTarget or commandTarget).com/comref/full. but a person.html 7/11/2010 . Example: soldierOne commandFollow player Category: OFP http://www. If the target is objNull. the person is returned instead. 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). If the vehicle is not a vehicle.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Type of returned value: Nothing Description: Commit control animation. 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.html 7/11/2010 . Example: _rewind = ctrlAutoScrollRewind _control Category: OFP PC ctrlAutoScrollSpeed control Operand types: control: Control Compatibility: Version 5501 required. -1 if auto-scroll is disabled.50 required.arma2.BIS Game Engine Scripting Commands Page 79 of 415 Category: OFP PC ctrlAutoScrollRewind control Operand types: control: Control Compatibility: Version 5501 required.com/comref/full. -2 if scrollbar not present. Example: _speed = ctrlAutoScrollSpeed _control Category: OFP PC control ctrlCommit time Operand types: control: Control time: Number Compatibility: Version 2. http://www.

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

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

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

Category: OFP http://www.html 7/11/2010 . To restore default texture. Category: OFP PC control ctrlMapCursor texture names Operand types: control: Control texture names: Array Compatibility: Version 5501 required. Example: <map_control> ctrlMapCursor ["Track"."Array". If new texture does not exist. write empty string.92 required.com/comref/full. "Move".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. Type of returned value: Nothing Description: Changes default cursor texture ("Track"."customCursor"] Category: OFP ctrlMapMouseOver control Operand types: control: Control Compatibility: Version 5501 required. Type of returned value: Array Description: Returns description of map sign mouse cursor is over. "Scroll") to custom one.arma2. default cursor texture is used.

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

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

com/comref/full. Type of returned value: Number Description: Returns the current scale of control. Example: _control ctrlRemoveEventHandler ["KeyDown". 0] Category: OFP PC ctrlScale control Operand types: control: Control Compatibility: Version 5501 required.arma2.50 required. 0. Example: _control ctrlSetActiveColor [1. 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. 0. Example: _scale = ctrlScale _control Category: OFP PC display ctrlSetActiveColor color Operand types: display: Control color: Array Compatibility: Version 2.html 7/11/2010 . 1] Category: OFP PC control ctrlSetAutoScrollDelay delay Operand types: control: Control http://www. Color is in format Color.BIS Game Engine Scripting Commands Page 86 of 415 Version 5501 required.

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

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

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

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

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

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

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

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

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

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

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

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

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

Color is in format Color. 0. Example: _control ctrlSetTooltipColorBox [1.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. http://www.arma2.com/comref/full. Color is in format Color. Color is in format Color. 0.92 required. 1] Category: OFP PC display ctrlSetTooltipColorShade color Operand types: display: Control color: Array Compatibility: Version 2. Type of returned value: Nothing Description: Sets tooltip background color of given control.92 required. Type of returned value: Nothing Description: Sets tooltip border color of given control. Example: _control ctrlSetTooltipColorShade [1. Type of returned value: Nothing Description: Sets tooltip text color of given control. 0.html 7/11/2010 . 0. 1] Category: OFP PC display ctrlSetTooltipColorText color Operand types: display: Control color: Array Compatibility: Version 2.

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

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

Type of returned value: String Description: Return the name of the type of the currently using magazine (on the primary turret for vehicles).html 7/11/2010 . 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.92 required. Example: _type = ctrlType _control Category: OFP PC ctrlVisible idc Operand types: idc: Number Compatibility: Version 1.50 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.com/comref/full. Category: OFP http://www.arma2. Category: OFP currentMagazine vehicle Operand types: vehicle: Object Compatibility: Version 5500 required.

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

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

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

BIS Game Engine Scripting Commands

Page 107 of 415

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

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

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

damage object
Operand types:

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

7/11/2010

BIS Game Engine Scripting Commands

Page 108 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 109 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 110 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 111 of 415

Category: OFP

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

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

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

deleteMarkerLocal name

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

7/11/2010

BIS Game Engine Scripting Commands

Page 112 of 415

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

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

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

deleteWaypoint waypoint

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

7/11/2010

BIS Game Engine Scripting Commands

Page 113 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 114 of 415

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

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

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

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

dialog
Compatibility: Version 1.78 required.

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

7/11/2010

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

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

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

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

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

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

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

} 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). 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. http://www. the loop will be terminated and an error message is shown. If the target is objNull. If the condition is still true after the loop was repeated 10000 times.com/comref/full.arma2. 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).html 7/11/2010 . case 2 : {block}. 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}. default {block}.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

arma2. Note: the string argument is used here.html 7/11/2010 . grpNull is returned. The message is defined in the description. Be sure to use double quotes around the label name in goto. 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.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. For dead units.ext file or radio protocol. 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.com/comref/full.

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

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

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

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

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

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

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

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

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

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

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

Type of returned value: Boolean Description: Check if fireplace is inflamed (buring).com/comref/full.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. 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. Example: fireplaceOne inflame true Category: OFP inflamed fireplace Operand types: fireplace: Object Compatibility: Version 1. 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.html 7/11/2010 .04 required.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Category: OFP vehicle lockedTurret turret path Operand types: vehicle: Object turret path: Array Compatibility: Version 5501 required. lock] Operand types: vehicle: Object [turret path. Type of returned value: Boolean Description: Check whether gunner position of the vehicle turret is locked. Type of returned value: Boolean Description: Check whether cargo position of the vehicle is locked. Category: OFP lockedDriver vehicle Operand types: vehicle: Object Compatibility: Version 5501 required.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.com/comref/full. lock]: Array Compatibility: Version 5501 required.arma2.html 7/11/2010 . Category: OFP vehicle lockTurret [turret path. Type of returned value: Boolean Description: Check whether driver position of the vehicle turret is locked.

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

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

27 required. Type of returned value: Nothing Description: Clears the map animation. getMarkerPos "anim1"] Category: OFP mapAnimClear Compatibility: Version 1. Type of returned value: Nothing Description: Plays the map animation.27 required.com/comref/full. Category: OFP mapAnimCommit Compatibility: Version 1. Category: OFP markerAlpha markerName Operand types: markerName: String Compatibility: Version 5501 required.BIS Game Engine Scripting Commands Page 229 of 415 Example: mapAnimAdd [1.html 7/11/2010 . 0. Category: OFP mapAnimDone Compatibility: Version 1.27 required. Type of returned value: Number http://www.1.arma2. 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.50 required.com/comref/full.arma2.BIS Game Engine Scripting Commands Page 230 of 415 Description: Gets the marker alpha. See setMarkerBrush. Example: markerColor "MarkerOne" Category: OFP markerDir markerName Operand types: markerName: String Compatibility: Version 2. Type of returned value: Array http://www. Type of returned value: String Description: Gets the marker color. Note: this function is identical to getMarkerColor. Example: markerAlpha "MarkerOne" Category: OFP markerBrush name Operand types: name: String Compatibility: Version 5501 required. Type of returned value: String Description: Gets the marker brush.92 required. See setMarkerColor.html 7/11/2010 . See setMarkerAlpha.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Category: Editor http://www. Example: variableToDestroy = nil Category: Default map nMenuItems menu index Operand types: map: Control menu index: Compatibility: Version 2. 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.arma2. Category: OFP nil Type of returned value: Any Description: Nil value. Category: Editor nextWeatherChange Compatibility: Version 2.com/comref/full.92 required.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.html 7/11/2010 . Type of returned value: Number Description: Returns the next available menu item index.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

html 7/11/2010 .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.arma2.92 required. Type of returned value: Nothing Description: Enable / disable post process effect Example: hndl ppEffectEnable true Category: Visual string ppEffectEnable bool http://www.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: Destroy post process effect given by handle Category: Visual number ppEffectEnable bool Operand types: number: Number bool: Boolean Compatibility: Version 2.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

com/comref/full.html 7/11/2010 . Type of returned value: Number Category: OFP SafeZoneW Compatibility: Version 5501 required. http://www. 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.arma2. Type of returned value: Number Category: OFP SafeZoneX Compatibility: Version 5501 required. Type of returned value: Number Category: OFP SafeZoneY Compatibility: Version 5501 required.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

BIS Game Engine Scripting Commands

Page 347 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 348 of 415

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

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 349 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 350 of 415

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

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

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

side unit
Operand types: unit: Object

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

7/11/2010

BIS Game Engine Scripting Commands

Page 351 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 352 of 415

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

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

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

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

sideUnknown

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

7/11/2010

BIS Game Engine Scripting Commands

Page 353 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 354 of 415

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

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

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

vehicle skill type
Operand types: vehicle: Object

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

7/11/2010

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

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

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

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

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

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

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

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

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

BIS Game Engine Scripting Commands

Page 364 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 365 of 415

Category: OFP

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 366 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 367 of 415

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 368 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 369 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 370 of 415

Category: Identity

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

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

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

taskParent task

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

7/11/2010

BIS Game Engine Scripting Commands

Page 371 of 415

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

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

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

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

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

7/11/2010

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

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

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

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

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

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

b. repeating] Category: OFP triggerArea trigger Operand types: trigger: Object Compatibility: Version 5501 required. Category: OFP triggerActivation trigger Operand types: trigger: Object Compatibility: Version 5501 required.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. rectangle] Category: OFP triggerAttachedVehicle trigger http://www. angle. type. Type of returned value: Array Description: Returns trigger activation in the form [by. Type of returned value: Array Description: Returns trigger area in the form [a.com/comref/full.html 7/11/2010 .arma2. result is "ARMA" Category: Default triggerActivated trigger Operand types: trigger: Object Compatibility: Version 5501 required.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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