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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

It does not automatically commit changes. It does not automatically commit changes.BIS Game Engine Scripting Commands Page 50 of 415 Description: Sets the camera position (format Position). http://www. Example: _camera camSetPos getPos player Category: OFP camera camSetRelPos position Operand types: camera: Object position: Array Type of returned value: Nothing Description: Sets the camera position relative to the current position of the currect target (see camSetTarget).com/comref/full. It does not automatically commit changes.html 7/11/2010 .arma2.5] Category: OFP camera camSetTarget target Operand types: camera: Object target: Object Type of returned value: Nothing Description: Sets the camera target. Example: _camera camSetRelPos [10. 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: canFire vehicle player Category: OFP http://www. It does not check for ammo.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.arma2.html 7/11/2010 .com/comref/full. only for damage.73 required. Type of returned value: Nothing Description: Set / clear using of night vision during cutscenes. Type of returned value: Object Description: Returns camera's target. Category: OFP canFire vehicle Operand types: vehicle: Object Type of returned value: Boolean Description: Checks whether the given vehicle is able to fire. Example: camTarget _camera Category: OFP camUseNVG set Operand types: set: Boolean Compatibility: Version 2.

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

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

html 7/11/2010 .BIS Game Engine Scripting Commands Page 54 of 415 ceil x Operand types: x: Number Type of returned value: Number Description: The ceil value of x. Example: clearGroupIcons group http://www.25 . result is 6 Category: Default cheatsEnabled Compatibility: Version 1. Example: ceil 5.arma2.com/comref/full. Category: Resistance civilian Type of returned value: Side Description: The Civilian side.56 required. Type of returned value: Nothing Description: Removes all icon from group. 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).

Category: Resistance clearOverlay map Operand types: map: Control Compatibility: Version 2.com/comref/full.arma2.html 7/11/2010 .92 required.BIS Game Engine Scripting Commands Page 55 of 415 Category: OFP clearMagazineCargo unit Operand types: unit: Object Type of returned value: Nothing Description: Removes all magazines from the vehicle cargo space. 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). Example: clearOverlay _map Category: Editor clearRadio http://www. Example: clearMagazineCargo jeepOne Category: OFP clearMagazinePool Compatibility: Version 1.75 required. Type of returned value: Nothing Description: Clear the current overlay.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

BIS Game Engine Scripting Commands

Page 107 of 415

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

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

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

damage object
Operand types:

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

7/11/2010

BIS Game Engine Scripting Commands

Page 108 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 109 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 110 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 111 of 415

Category: OFP

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

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

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

deleteMarkerLocal name

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

7/11/2010

BIS Game Engine Scripting Commands

Page 112 of 415

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

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

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

deleteWaypoint waypoint

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

7/11/2010

BIS Game Engine Scripting Commands

Page 113 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 114 of 415

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

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

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

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

dialog
Compatibility: Version 1.78 required.

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

7/11/2010

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

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

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

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

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

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

.html 7/11/2010 . starts cycle Example: for "_x" from 20 to 10 step -2 do {.arma2. Category: OFP with do code Operand types: with: With Type code: Code Compatibility: Version 5501 required. Example: with missionNamespace do {global=global+1} Category: Default forCommand do code Operand types: forCommand: for type code: Code Type of returned value: Any Description: End of for command. Type of returned value: Nothing Description: Repeats the code while the condition is true.} Category: Default while do code Operand types: while: While Type code: Code Compatibility: Version 1. Note: the maximum repeat count for the loop is http://www.code. 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)..85 required.

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

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

arma2. Note: the stop command is never finished. Example: soldierOne doTarget player Category: OFP unit doWatch position Operand types: unit: Object or Array position: Array Type of returned value: Nothing Description: Orders the unit to watch the given position (format Position) (silently).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). Example: soldierOne doWatch getMarkerPos "MarkerMoveOne" http://www.html 7/11/2010 .com/comref/full. the unit will never be ready. Example: doStop unitOne Category: OFP unit doTarget position Operand types: unit: Object or Array position: Object Type of returned value: Nothing Description: Orders the unit to target the given target (silently).

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

otherwise it's friendly. Example: value = west getFriend east Category: OFP FSM handle getFSMVariable name Operand types: FSM handle: Number name: String Compatibility: Version 5501 required.html 7/11/2010 . 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. Category: OFP group getGroupIcon ID Operand types: group: Group ID: Number Compatibility: Version 5501 required.arma2. Type of returned value: Number Description: Returns if sides are friendly or hostile.6 it results in being enemy. For a value smaller than 0. The FSM handle is the number returned by the execFSM command.com/comref/full. Category: Editor side1 getFriend side2 Operand types: side1: Side side2: Side Compatibility: Version 5501 required. Type of returned value: Array http://www.

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

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

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

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

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

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

Type of returned value: Any Description: Return the value of variable in the variable space of given task.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.com/comref/full. Category: Editor task getVariable name Operand types: task: Task 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. Category: Identity http://www. Type of returned value: Any Description: Return the value of variable in the variable space of given object. Category: OFP map getVariable name Operand types: map: Control name: String Compatibility: Version 2.html 7/11/2010 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

float gradientRadius. Example: newposition = position isFlatEmpty(10.object skipobj] Operand types: position: Array [float minDistance.5. 0.arma2.bool onShore.float onWater.object skipobj]: Array Compatibility: Version 5501 required. 0.bool onShore.com/comref/full. 0.float precizePos. Example: on = isEngineOn vehicle player Category: OFP position isFlatEmpty [float minDistance.92 required. Category: OFP isHidden person Operand types: person: Object Compatibility: Version 2.float gradientRadius.float maxGradient.BIS Game Engine Scripting Commands Page 178 of 415 Checks whether the engine is on. false.float maxGradient. player) Category: OFP isFormationLeader person Operand types: person: Object Compatibility: Version 2. Type of returned value: Boolean Description: http://www.float onWater. 5.float precizePos.html 7/11/2010 .92 required. 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Note: all static objects are local on all computers.csv file. Type of returned value: Boolean Description: Loads object's properties from objects. Example: localize "STR_DN_FROG" Category: OFP http://www.sav file in campaign directory (from entry name). Example: player loadStatus "playerState" Category: Resistance local obj Operand types: obj: Object Type of returned value: Boolean Description: MP: checks whether the given unit is local on the computer.BIS Game Engine Scripting Commands Page 223 of 415 object loadStatus name Operand types: object: Object name: String Compatibility: Version 1.com/comref/full. Example: local unitName Category: OFP localize stringName Operand types: stringName: String Type of returned value: String Description: Replaces the string with the given name with the corresponding localized text from the stringtable. 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.arma2.html 7/11/2010 .75 required.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Example: onMapSingleClick """SoldierEG"" createUnit [_pos. 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. command should return true.arma2.com/comref/full.html 7/11/2010 ._alt bool key state If the click is processed.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. 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. Command receives: _pos array position _units array selected units _shift.

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

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

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

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

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

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

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

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

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

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

52 required. y] Operand types: map: Control [x.com/comref/full.54 required. Category: OFP PC map posWorldToScreen position Operand types: map: Control position: Array http://www.90 required. 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. y]: Array Compatibility: Version 2.BIS Game Engine Scripting Commands Page 261 of 415 position location Operand types: location: Location Compatibility: Version 2. Category: Location positionCameraToWorld position Operand types: position: Array Compatibility: Version 2. Type of returned value: Array Description: Return (raw) position of given location. Type of returned value: Array Description: Convert screen coordinates in map to world coordinates.arma2.html 7/11/2010 .

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

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

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

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

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

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

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

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

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

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

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

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 random x Operand types: x: Number Type of returned value: Number Description: The random real value from 0 to x. Category: OFP rankId unit http://www.92 required.com/comref/full. Type of returned value: String Description: Return the rank of the given unit.arma2. Category: OFP rain Compatibility: Version 2. 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.92 required.html 7/11/2010 .

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

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

arma2. Type of returned value: Nothing Description: Removes the action with the given id. 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.85 required. Example: player remoteControl gunner _uav Category: OFP unit removeAction index Operand types: unit: Object index: Number Compatibility: Version 1.html 7/11/2010 . Example: player removeAllEventHandlers "killed" Category: OFP http://www.com/comref/full. Type of returned value: Nothing Description: Removes all event handlers of the given type which were added by addEventHandler.

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

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

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

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

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

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.52 required. count = 0] Operand types: vehicle: Object [delay = -1. Example: car respawnVehicle [5.html 7/11/2010 . 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). default respawnDelay from description. count = 0]: Array Compatibility: Version 2. 3] Category: OFP restartEditorCamera map Operand types: map: Control Compatibility: Version 2.BIS Game Engine Scripting Commands Page 282 of 415 vehicle respawnVehicle [delay = -1.arma2. Type of returned value: Nothing Description: Set vehicle as respawnable in MP games. for example).0. Delay is respawn delay.com/comref/full.92 required. Example: soldierOne reveal soldierTwo Category: OFP reversedMouseY http://www.ext is used.

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

Type of returned value: Number Category: OFP SafeZoneY Compatibility: Version 5501 required.com/comref/full.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). Type of returned value: Number Category: OFP SafeZoneW Compatibility: Version 5501 required.BIS Game Engine Scripting Commands Page 284 of 415 SafeZoneH Compatibility: Version 5501 required. Type of returned value: Number Category: OFP SafeZoneX Compatibility: Version 5501 required.arma2. http://www.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

BIS Game Engine Scripting Commands

Page 338 of 415

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

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

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

object setVehicleVarName name
Operand types: object: Object

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

7/11/2010

BIS Game Engine Scripting Commands

Page 339 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 340 of 415

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

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

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

waypoint setWaypointCompletionRadius radius
Operand types: waypoint: Array

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

7/11/2010

BIS Game Engine Scripting Commands

Page 341 of 415

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 342 of 415

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 343 of 415

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 344 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 345 of 415

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

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

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

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

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

7/11/2010

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

BIS Game Engine Scripting Commands

Page 347 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 348 of 415

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

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 349 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 350 of 415

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

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

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

side unit
Operand types: unit: Object

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

7/11/2010

BIS Game Engine Scripting Commands

Page 351 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 352 of 415

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

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

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

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

sideUnknown

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

7/11/2010

BIS Game Engine Scripting Commands

Page 353 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 354 of 415

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

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

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

vehicle skill type
Operand types: vehicle: Object

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

7/11/2010

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Sign up to vote on this title
UsefulNot useful