BIS Game Engine Scripting Commands

Page 1 of 415

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

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

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

location1 != location2
Operand types: location1: Location

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

7/11/2010

BIS Game Engine Scripting Commands

Page 2 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 3 of 415

side player != west Category: OFP

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 4 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 5 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 6 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 7 of 415

Category: Default

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 8 of 415

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

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

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

a<b
Operand types: a: Number

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

7/11/2010

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Example: _camera = camCreate getPos player Category: OFP camDestroy camera Operand types: camera: Object Type of returned value: Nothing Description: http://www.y. Example: _camera camConstuctionSetParams [getpos player.com/comref/full. max above land] Operand types: camera: Object [[x.y.z].20] Category: OFP type camCreate position Operand types: type: String position: Array Type of returned value: Object Description: Creates a camera or an actor of the given type on the given initial position (format Position).arma2. Its type is one of "CAMERA" or "SEAGULL".50. Type of returned value: Nothing Description: Sets construction camera parameters.radius.radius.z]. max above land]: Array Compatibility: Version 5501 required. Example: camCommitted _camera Category: OFP camera camConstuctionSetParams [[x.BIS Game Engine Scripting Commands Page 41 of 415 Description: Checks whether the camera has finished committing.html 7/11/2010 .

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

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

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

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

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

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

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

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

It does not automatically commit changes. http://www. Example: _camera camSetTarget player Category: OFP camera camSetTarget position Operand types: camera: Object position: Array Type of returned value: Nothing Description: Sets the camera target to a position (format Position). It does not automatically commit changes.BIS Game Engine Scripting Commands Page 50 of 415 Description: Sets the camera position (format Position).html 7/11/2010 .com/comref/full. It does not automatically commit changes. Example: _camera camSetPos getPos player Category: OFP camera camSetRelPos position Operand types: camera: Object position: Array Type of returned value: Nothing Description: Sets the camera position relative to the current position of the currect target (see camSetTarget). It does not automatically commit changes. Example: _camera camSetRelPos [10.5] Category: OFP camera camSetTarget target Operand types: camera: Object target: Object Type of returned value: Nothing Description: Sets the camera target.arma2.

html 7/11/2010 . Type of returned value: Nothing Description: Set / clear using of night vision during cutscenes. Example: canFire vehicle player Category: OFP http://www. only for damage.73 required.arma2. It does not check for ammo.com/comref/full. Example: camTarget _camera Category: OFP camUseNVG set Operand types: set: Boolean Compatibility: Version 2. Category: OFP canFire vehicle Operand types: vehicle: Object Type of returned value: Boolean Description: Checks whether the given vehicle is able to fire. Type of returned value: Object Description: Returns camera's target.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. Type of returned value: Boolean Description: Check if cargo of this vehicle want to get out when in combat. 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.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. It does not test for fuel. only the damage status is checked.html 7/11/2010 . Category: OFP captive unit Operand types: unit: Object http://www.com/comref/full. Example: canStand player Category: OFP canUnloadInCombat vehicle Operand types: vehicle: Object Compatibility: Version 5501 required.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

special] http://www.com/comref/full. For types see CfgVehicles.arma2. position. placement. 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. markers.html 7/11/2010 . Example: west countSide list triggerOne Category: OFP typeName countType array Operand types: typeName: String array: Array Type of returned value: Number Description: Counts how many vehicles in the array are of the given type. Example: player countUnknown list triggerOne Category: OFP createAgent [type.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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Type of returned value: String Description: Return the current command type (empty string when no command). Type of returned value: String Description: Return the name of the type of the currently using magazine (on the primary turret for vehicles). Example: _visible = ctrlVisible 100 Category: Resistance currentCommand vehicle Operand types: vehicle: Object Compatibility: Version 2.50 required. Category: OFP http://www.com/comref/full.BIS Game Engine Scripting Commands Page 103 of 415 Returns value representing type of control. Category: OFP currentMagazine vehicle Operand types: vehicle: Object Compatibility: Version 5500 required.html 7/11/2010 .arma2. 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.92 required.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

html 7/11/2010 .com/comref/full.ext file or radio protocol.arma2. grpNull is returned.BIS Game Engine Scripting Commands Page 162 of 415 unit globalRadio radioName Operand types: unit: Object radioName: String Type of returned value: Nothing Description: Sends the message to the global radio channel. The message is defined in the description. Note: the string argument is used here. Be sure to use double quotes around the label name in goto. Example: goto "Loop" Category: OFP group obj Operand types: obj: Object Type of returned value: Group Description: Returns the group to which the given unit is assigned. Example: soldierOne globalRadio "messageOne" Category: OFP goto label Operand types: label: String Type of returned value: Nothing Description: Only in scripts: go to given label. For dead units. Example: group player == group leader player Category: OFP unit groupChat chatText Operand types: http://www.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

com/comref/full.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. http://www. Example: lnbDeleteRow [105. Type of returned value: Array Description: Returns the index of the selected item of the given listbox or combobox. Example: _index = lbCurSel _control Category: OFP PC lnbGetColumnsPosition idc Operand types: idc: Number Compatibility: Version 5501 required.arma2. Example: _control lnbDelete 0 Category: OFP PC lnbGetColumnsPosition control Operand types: control: Control Compatibility: Version 2. Type of returned value: Nothing Description: Removes row with the given index from the given listbox or combobox.91 required.

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

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

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

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

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

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

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

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

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

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

Example: jeepOne lock true Category: OFP vehicle lockCargo lock Operand types: vehicle: Object lock: Boolean Compatibility: Version 5501 required. Category: Location locationPosition location Operand types: location: Location Compatibility: Version 2.html 7/11/2010 .90 required. Type of returned value: Location Description: A non-existing location. Type of returned value: Nothing http://www. including itself.BIS Game Engine Scripting Commands Page 224 of 415 locationNull Compatibility: Version 5501 required. Type of returned value: Array Description: Return position of given location.arma2. This value is not equal to anything.com/comref/full. 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: OFP vehicle lockCargo [cargo index.html 7/11/2010 .arma2. lock] Operand types: vehicle: Object [cargo index.BIS Game Engine Scripting Commands Page 225 of 415 Description: Lock the all cargo positions of the vehicle.com/comref/full. Category: OFP locked unit Operand types: unit: Object Type of returned value: Boolean Description: Checks whether the vehicle is locked for the player. the player cannot mount / dismount without an order. If it's locked. Example: locked jeepOne Category: OFP http://www. Type of returned value: Nothing Description: Lock the driver position of the vehicle. 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. lock]: Array Compatibility: Version 5501 required.

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

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 . 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. Example: log 10 . This is sometimes used during cut-scenes. 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).com/comref/full. Type of returned value: Nothing Description: Control what the unit is looking at (target or position) (format Position) http://www.arma2.40 required.

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

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

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

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

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

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

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

Type of returned value: Number Description: Checks a current morale level of the unit (-1. without animation).5 Category: OFP group move pos Operand types: group: Object or Group pos: Array Type of returned value: Nothing Description: Creates a move waypoint on the given position (format Position) and makes it the currently active group waypoint.+1).. Example: groupOne move getPos player Category: OFP soldier moveInCargo vehicle Operand types: soldier: Object vehicle: Object Type of returned value: Nothing Description: Moves the soldier into the vehicle's cargo position. Example: morale leader player .html 7/11/2010 .com/comref/full. result is 0.arma2. Example: soldierOne moveInCargo jeepOne Category: OFP http://www.BIS Game Engine Scripting Commands Page 235 of 415 morale unit Operand types: unit: Object Compatibility: Version 5500 required. (Immediately.

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

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

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

90 required. the name of the first crew member is returned (in order: commander.com/comref/full. Example: name vehicle player Category: OFP name location Operand types: location: Location Compatibility: Version 2.92 required. Category: OFP musicVolume Type of returned value: Number Description: Checks the current music volume (set by fadeMusic). Category: OFP name object Operand types: object: Object Type of returned value: String Description: Returns the name of the variable assigned to the object in the mission editor. http://www.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. Type of returned value: Boolean Description: Check if latest low level moveTo command failed. gunner).arma2. driver.

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

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

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

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

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

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

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. Type of returned value: Array Description: Convert float number to date. Example: date = NumberToDate [2008.0.time] Operand types: [year. result is true Category: Default NumberToDate [year.BIS Game Engine Scripting Commands Page 246 of 415 not a Operand types: a: Boolean Type of returned value: Boolean Description: not a Example: not false . result is false Category: OFP objective objStatus status Operand types: objective: String status: String Type of returned value: http://www.com/comref/full.html 7/11/2010 . including itself.arma2. Example: player == objNull .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

34: Number. http://www.arma2. Only type Number is supported in versions 1. Type of returned value: Nothing Description: Transfers weapons and magazines from the weapon pool (used in campaigns to transfer weapons to the next mission) into the cargo space of object obj. Example: publicVariable "CTFscoreOne" Category: OFP putWeaponPool obj Operand types: obj: Object Compatibility: Version 1. Example: _control sliderSetPosition 0 Category: OFP PC publicVariable varName Operand types: varName: String Type of returned value: Nothing Description: Broadcasts the variable value to all computers. Type of returned value: Nothing Description: Sets the current position in the progress bar. Boolean.html 7/11/2010 . Object and Group.33 and before.com/comref/full.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.92 required.75 required. The following types are supported since 1.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

] Operand types: sender: [receiver. value1... name2.27 required. value1. [type] or [type.26 required. Type of returned value: Nothing Description: Sends a simple command to the vehicle's driver / gunner. Example: soldierOne selectWeapon "LAWLauncher" Category: OFP object sendSimpleCommand command Operand types: object: Object command: String Compatibility: Version 2.BIS Game Engine Scripting Commands Page 294 of 415 selectPlayer aP Category: OFP unit selectWeapon weapon Operand types: unit: Object weapon: String Compatibility: Version 1. [type] or [type. parentTask]. . name1. Example: vehicle player sendSimpleCommand "STOP" Category: OFP sender sendTask [receiver.html 7/11/2010 . name1. name2. Type of returned value: Nothing Description: Selects the given weapon..92 required. For weapon values see CfgWeapons. parentTask].]: Array Compatibility: Version 2. value2. priority.arma2.. .com/comref/full. Type of returned value: Task http://www. value2. priority.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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).BIS Game Engine Scripting Commands Page 332 of 415 Category: OFP location setType type Operand types: location: Location type: String Compatibility: Version 2.html 7/11/2010 .33 required. Skill may vary from 0. Type of returned value: Nothing Description: Sets skill of given unit.2 to 1. Category: OFP unit setUnitAbility skill Operand types: unit: Object skill: Number Compatibility: Version 2.90 required.com/comref/full.0. Type of returned value: Nothing Description: Set a new type of given location. Category: Location unit setUnconscious set Operand types: unit: Object set: Boolean Compatibility: Version 5501 required. Example: player setUnitSkill 1.

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

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

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

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

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

BIS Game Engine Scripting Commands

Page 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

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

BIS Game Engine Scripting Commands

Page 347 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 348 of 415

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

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 349 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 350 of 415

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

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

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

side unit
Operand types: unit: Object

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

7/11/2010

BIS Game Engine Scripting Commands

Page 351 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 352 of 415

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

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

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

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

sideUnknown

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

7/11/2010

BIS Game Engine Scripting Commands

Page 353 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 354 of 415

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

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

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

vehicle skill type
Operand types: vehicle: Object

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

7/11/2010

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

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

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

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

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

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

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

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

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

BIS Game Engine Scripting Commands

Page 364 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 365 of 415

Category: OFP

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 366 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 367 of 415

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 368 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 369 of 415

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

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

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

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

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

7/11/2010

BIS Game Engine Scripting Commands

Page 370 of 415

Category: Identity

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

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

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

taskParent task

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

7/11/2010

BIS Game Engine Scripting Commands

Page 371 of 415

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

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

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

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

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

7/11/2010

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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