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

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

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

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

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

arma2.com/comref/full.35 required. 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.html 7/11/2010 .BIS Game Engine Scripting Commands Page 13 of 415 a greater than b Example: counter > 4 Category: Default a >= b Operand types: a: Number b: Number Type of returned value: Boolean Description: a greater or equal than b Example: player distance redCar < 100 Category: Default config >> name Operand types: config: Config name: String Compatibility: Version 2. Type of returned value: Config Description: Returns subentry of config entry with given name.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Example: atg 1 . result is 59.html 7/11/2010 .BIS Game Engine Scripting Commands Page 33 of 415 plane assignToAirport 0 Category: OFP atan x Operand types: x: Number Type of returned value: Number Description: The arctangens of x. The returned value is in degrees. the result is in degrees. Example: 5 atan2 3 . result is 45 Category: Default http://www.0362 Category: Default atg 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. Example: atan 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. the result is in degrees.

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

com/comref/full.92 required.arma2.BIS Game Engine Scripting Commands Page 35 of 415 group: Object or Group Compatibility: Version 2. 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". Type of returned value: Boolean Description: Return whether leader can issue attack commands."AWARE"."COMBAT" or "STEALTH")."SAFE". The function can be used to create missions that are able to adapt to computer peformance.html 7/11/2010 .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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

com/comref/full. but a person. 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). the person is returned instead. Example: soldierOne commandFollow player Category: OFP http://www.html 7/11/2010 . Example: commander vehicle player Category: OFP unit commandFire target Operand types: unit: Object or Array target: Object Type of returned value: Nothing Description: Orders a unit to commence firing on the given target (via the radio).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). If the vehicle is not a vehicle. If the target is objNull.arma2.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Type of returned value: Nothing Description: Sets number of second required to scroll to next line. Type of returned value: Nothing Description: Sets number of second before auto-scroll starts.com/comref/full. 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: Defines if scroll should rewind when auto-scroll reach end. 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.html 7/11/2010 . Example: _control ctrlSetAutoScrollSpeed 5 Category: OFP PC display ctrlSetBackgroundColor color http://www.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.arma2.html 7/11/2010 . Category: OFP currentWeapon vehicle Operand types: vehicle: Object Compatibility: Version 5500 required. Type of returned value: Number Description: Return the index of the current waypoint. Type of returned value: Task Description: Return current task of given person.com/comref/full. Type of returned value: Array Description: List all uncompleted tasks.91 required. Type of returned value: http://www. Category: Identity currentTasks teamMember Operand types: teamMember: Compatibility: Version 2.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

com/comref/full.arma2.92 required. result is 5 Category: Default helicopter flyInHeight height Operand types: helicopter: Object height: Number Type of returned value: Nothing Description: Sets the height level for the helicopter. Category: OFP fogForecast Compatibility: Version 2. Type of returned value: Number Description: Return the current fog.html 7/11/2010 . Example: cobraOne flyInHeight 150 Category: OFP fog Compatibility: Version 2.92 required. Category: OFP http://www.25 . 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. The accepted range is from 50 to 1000. Type of returned value: Number Description: Return the fog forecast.

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

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

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

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

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

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

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

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

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

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

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

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

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

Category: Default group getVariable name Operand types: group: Group name: String Compatibility: Version 5501 required. Type of returned value: Any Description: Return the value of variable in the given namespace. Type of returned value: Any Description: http://www. Category: OFP location getVariable name Operand types: location: Location name: String Compatibility: Version 2.arma2.92 required.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.html 7/11/2010 . Type of returned value: Any Description: Return the value of variable in the variable space of given group.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

For a dead unit. Example: soldierOne leaveVehicle jeepOne Category: OFP group leaveVehicle vehicle Operand types: group: Group vehicle: Object Type of returned value: Nothing Description: Ceases the using of the vehicle in the group.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. Example: leader group player == leader player Category: OFP group leaveVehicle vehicle Operand types: group: Object vehicle: Object Type of returned value: Nothing Description: Ceases the using of the vehicle in the group. It unassigns all grouped units from the vehicle. Example: groupOne leaveVehicle jeepOne Category: OFP http://www. grpNull is returned. It unassigns all grouped units from the vehicle.arma2.html 7/11/2010 .com/comref/full.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

com/comref/full.BIS Game Engine Scripting Commands Page 248 of 415 Compatibility: Version 1.92 required. 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 an action performed when commnad mode change. Type of returned value: Nothing Description: Defines a sound (voice) that is played the first time when the Plan section in the briefing is selected. Type of returned value: Nothing Description: Defines a sound (voice) that is played the first time when the Team switch section in the briefing is selected.arma2. Example: onBriefingPlan "PlanVoiceOver" Category: Resistance onBriefingTeamSwitch sound Operand types: sound: String Compatibility: Version 2.75 required.html 7/11/2010 .

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

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

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

Set to empty for default behavior. Type of returned value: Nothing Description: Defines an action performed just before the preload screen started. Type of returned value: Nothing Description: Defines an action performed after the preload screen finished.com/comref/full. 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.92 required. Command receives: _pos array position Category: Editor onTeamSwitch command Operand types: command: Compatibility: Version 5500 required. Type of returned value: http://www. Category: OFP map onShowNewObject command Operand types: map: Control command: String Compatibility: Version 2.arma2.html 7/11/2010 . Category: OFP onPreloadStarted command Operand types: command: Compatibility: Version 5501 required.

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.arma2. Type of returned value: Number Description: http://www.html 7/11/2010 .92 required. 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.com/comref/full. Example: [unitOne.

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

Category: OFP pi Type of returned value: Number Description: pi (180 degrees converted to radians) Example: pi .BIS Game Engine Scripting Commands Page 255 of 415 Operand types: text: String Compatibility: Version 2. Example: txt = parseText "First line&lt.arma2.75 required.Second line" Category: OFP parsingNamespace Compatibility: Version 5501 required.img image=data\isniper.01 required. result is 3.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.paa/&gt.com/comref/full. http://www.&ltbr/&gt. Type of returned value: Namespace Description: Return the global namespace attached to config parser.html 7/11/2010 . Type of returned value: Nothing Description: Transfers weapons and magazines from the cargo space of object obj to the weapon pool (used in campaigns to transfer weapons to the next mission).

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

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

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

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

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

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

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

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

Type of returned value: Array Description: Create post process effect specified by name and priority Category: Visual ppEffectCreate effect Operand types: effect: Array Compatibility: Version 5501 required.html 7/11/2010 . Type of returned value: Boolean Description: Check whether given post process effect is commited 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. Type of returned value: Number Description: Create post process effect specified by name and priority http://www.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.arma2.

com/comref/full. Type of returned value: Nothing Description: Destroy post process effect given by handle Category: Visual number ppEffectEnable bool Operand types: number: Number bool: Boolean Compatibility: Version 2.92 required. Type of returned value: Nothing Description: Create post process effect specified by name and priority Category: Visual ppEffectDestroy effect Operand types: effect: Number Compatibility: Version 5501 required. Type of returned value: 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.arma2.html 7/11/2010 .

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

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

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

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

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

com/comref/full. Boolean.33 and before. Object and Group.html 7/11/2010 .34: Number. The following types are supported since 1.92 required. Example: publicVariable "CTFscoreOne" Category: OFP putWeaponPool obj Operand types: obj: Object Compatibility: Version 1. Only type Number is supported in versions 1. 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. 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: Sets the current position in the progress bar.75 required.arma2.BIS Game Engine Scripting Commands Page 271 of 415 Example: _pos = progressPosition _control Category: OFP PC control progressSetPosition pos Operand types: control: Control pos: Number Compatibility: Version 2. http://www.

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

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

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

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

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

Category: Editor map removeDrawLinks [from. Example: removeAllItems player Category: OFP removeAllWeapons unit Operand types: unit: Object Type of returned value: Nothing Description: Removes all weapons from the unit. Type of returned value: Nothing Description: Removes all special items from the unit.arma2. Type of returned value: Nothing Description: Removes an icon for an editor object. param type] Operand types: map: Control http://www. string identifier] Operand types: map: Control [object.92 required. Example: removeAllWeapons player Category: OFP map removeDrawIcon [object.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.html 7/11/2010 .

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

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

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

Example: array resize 2 Category: Default http://www.30" Category: OFP resistance Type of returned value: Side Description: The Resistance side.21 required.com/comref/full. Example: requiredVersion "1. a warning message is shown and false is returned. The version format is "Major. Type of returned value: Nothing Description: Changes the array size.g.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 . "1.arma2. This function can be used to add or remove elements from the array. e. If it's not.Minor".30".75 required. Type of returned value: Boolean Description: Checks whether the appropriate version of the application is available. Category: OFP array resize count Operand types: array: Array count: Number Compatibility: Version 1.

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

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

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

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

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

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

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

Example: http://www.50 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.html 7/11/2010 . 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: Array Description: Returns the position on landscape (in world coordinates) corresponding to the given point on screen (in UI coordinates).com/comref/full.BIS Game Engine Scripting Commands Page 289 of 415 Number Description: MP: returns the unit's score. Type of returned value: Nothing Description: Assign a friendly name to the VM script thjis command is executed from.

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

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

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

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

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

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

Example: rearmTruckOne setAmmoCargo 0 Category: OFP http://www. Ammo resources are used to resupply vehicles. Type of returned value: Nothing Description: Set owner of the airport Example: 0 setAirportSide east Category: OFP vehicle setAmmoCargo ammoCargo Operand types: vehicle: Object ammoCargo: Number Type of returned value: Nothing Description: Sets the amount of ammo resources in the cargo space of a repair vehicle.html 7/11/2010 . An amount of one indicates a full cargo.1 Category: OFP airportId setAirportSide side Operand types: airportId: Number side: Side Compatibility: Version 2.92 required.com/comref/full.arma2. soldiers use individual magazines instead.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. Example: setAccTime 0. It can also be used to slow down time in cutscenes.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

BIS Game Engine Scripting Commands

Page 338 of 415

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

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

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

object setVehicleVarName name
Operand types: object: Object

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

7/11/2010

BIS Game Engine Scripting Commands

Page 339 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 340 of 415

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

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

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

waypoint setWaypointCompletionRadius radius
Operand types: waypoint: Array

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

7/11/2010

BIS Game Engine Scripting Commands

Page 341 of 415

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 342 of 415

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 343 of 415

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 344 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 345 of 415

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

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

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

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

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

7/11/2010

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

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

com/comref/full. Daytime is adjusted.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.5 Category: OFP sliderPosition idc Operand types: idc: Number http://www. Example: sleep 0.html 7/11/2010 .60 required.5 Category: OFP sleep delay Operand types: delay: Number Compatibility: Version 2. Duration is in hours. Type of returned value: Number Description: Returns skill of given type of person (commander unit). a weather change is estimated and no changes to any units are done. Value of skill may vary from 0 to 1. Type of returned value: Nothing Description: Suspend execution of script for given time. Example: skipTime 2.arma2.65 required.

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

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

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

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

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

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

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

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

BIS Game Engine Scripting Commands

Page 364 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 365 of 415

Category: OFP

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 366 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 367 of 415

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 368 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 369 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 370 of 415

Category: Identity

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

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

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

taskParent task

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

7/11/2010

BIS Game Engine Scripting Commands

Page 371 of 415

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

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

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

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

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

7/11/2010

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Type of returned value: String Description: Gets the waypoint description.com/comref/full.html 7/11/2010 . Type of returned value: Number http://www. 1] Category: OFP waypointDescription waypoint Operand types: waypoint: Array Compatibility: Version 5500 required. Example: waypointDescription [groupOne.arma2. Example: waypointFormation [groupOne. 1] Category: OFP waypointHousePosition 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. Example: _radius = waypointCompletionRadius [groupOne. Type of returned value: String Description: Gets the waypoint formation. 1] Category: OFP waypointFormation waypoint Operand types: waypoint: Array Compatibility: Version 5500 required.

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

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

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

85 required. Example: _dir = _vehicle weaponDirection "M16" Category: OFP weapons vehicle Operand types: vehicle: Object Compatibility: Version 1. 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. Category: OFP while condition Operand types: condition: Code Compatibility: Version 1. Example: while "x<10" do {x=x+1} Category: Default http://www.75 required.arma2.html 7/11/2010 .BIS Game Engine Scripting Commands Page 397 of 415 Returns direction where is given weapon aiming. Example: weapons player Category: Resistance west Type of returned value: Side Description: The West side.com/comref/full.

92 required. Category: OFP object worldToModel worldPos Operand types: object: Object worldPos: Array Compatibility: Version 2.com/comref/full.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. 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.92 required.BIS Game Engine Scripting Commands Page 398 of 415 wind Compatibility: Version 2. Type of returned value: String Description: Return the name of the currently loaded world.arma2.92 required. Category: OFP with namespace Operand types: namespace: Namespace Compatibility: Version 5501 required.

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

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

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

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

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

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

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. Category: OFP Position2D Format: [x.y] Description: Position.Name of the script to run every period determined by TimerPeriod property.index] Description: Group is of type Group. y is the height above ground and the default y is 0. Object . x coordinates are from East to West. BeforeDestroy . index selects the waypoint (index 0 selects the first waypoint which is always created on the group starting position).z. z coordinates are from South to North.z] Description: x coordinates are from East to West.html 7/11/2010 . Category: OFP Position Format: [x. z coordinates are from South to North. Position of the particle is stored in "this" variable.z] or [x. Position of the particle is stored in "this" variable. OnTimer . Category: OFP Waypoint Format: [group. Category: OFP http://www.y] Description: Position. Category: OFP PositionASL Format: [x.arma2. y is the height above see level.z. RandomDirectionIntensity>.Name of the script to run right before destroying the particle.com/comref/full. z coordinates are from South to North.Object to bind this particle to.

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

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

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

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

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

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 .arma2.

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

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

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

Sign up to vote on this title
UsefulNot useful