Operand types:
a:
Boolean
Type of returned value:
Boolean
Description:
not a
Example:
!true
, result is false
Category: Default
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
Operand types:
a:
Number
b:
Number
Type of returned value:
Boolean
Description:
a is not equal to b
Example:
counter != 4
Category: Default
Operand types:
location1:
Location
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
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
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
Operand types:
side1:
Side
side2:
Side
Type of returned value:
Boolean
Description:
Checks whether two side values are different.
Example:
side player != west
Category: OFP
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
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
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
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
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
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
Operand types:
a:
Boolean
b:
Boolean
Type of returned value:
Boolean
Description:
a and b
Example:
alive player && alive leader player
Category: Default
Operand types:
a:
Number
b:
Number
Type of returned value:
Number
Description:
a multiplied by b
Example:
iCounter*3
Category: Default
Operand types:
a:
Number
Type of returned value:
Number
Description:
unary plus: returns a
Example:
+4
, result is 4
Category: Default
Operand types:
a:
Array
Type of returned value:
Array
Description:
unary plus: returns a copy of the array
Example:
+ [0, 1, 2]
, result is [0, 1, 2]
Category: Default
Operand types:
a:
Number
b:
Number
Type of returned value:
Number
Description:
a plus b
Example:
counter + 1
Category: Default
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
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"
Category: Default
Operand types:
a:
Number
Type of returned value:
Number
Description:
unary minus: zero minus a
Example:
- - 3
, result is 3
Category: Default
Operand types:
a:
Number
b:
Number
Type of returned value:
Number
Description:
a minus b
Example:
counter - 1
Category: Default
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
Operand types:
a:
Number
b:
Number
Type of returned value:
Number
Description:
a divided by b
Example:
enemyStrenght/3
Category: Default
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
Operand types:
a:
Switch Type
b:
Code
Type of returned value:
Nothing
Description:
see switch
Category: Default
Operand types:
a:
Number
b:
Number
Type of returned value:
Boolean
Description:
a lesser than b
Example:
counter < 4
Category: Default
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
Operand types:
display1:
Display
display2:
Display
Compatibility:
Version 2.50 required.
Type of returned value:
Boolean
Description:
Checks whether two displays are equal.
Category: OFP PC
Operand types:
control1:
Control
control2:
Control
Compatibility:
Version 2.50 required.
Type of returned value:
Boolean
Description:
Checks whether two controls are equal.
Category: OFP PC
Operand types:
side1:
Side
side2:
Side
Type of returned value:
Boolean
Description:
Checks whether two side values are equal.
Example:
side player == west
Category: OFP
Operand types:
obj1:
Object
obj2:
Object
Type of returned value:
Boolean
Description:
Checks whether two objects are the same. If either of them is objNull, false is returned.
Example:
player == leader player
Category: OFP
Operand types:
config1:
Config
config2:
Config
Compatibility:
Version 2.58 required.
Type of returned value:
Boolean
Description:
Checks whether two config entries are equal.
Category: OFP PC
Operand types:
task1:
Task
task2:
Task
Compatibility:
Version 2.92 required.
Type of returned value:
Boolean
Description:
Checks whether two tasks are equal.
Category: Identity
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 equal.
Category: OFP
Operand types:
grp1:
Group
grp2:
Group
Type of returned value:
Boolean
Description:
Checks whether two groups are the same. If either of them is grpNull, false is returned.
Example:
group player == group soldierOne
Category: OFP
Operand types:
a:
Number
b:
Number
Type of returned value:
Boolean
Description:
a equal to b
Example:
counter == 4
Category: Default
Operand types:
location1:
Location
location2:
Location
Type of returned value:
Boolean
Description:
Checks whether two locations are the same. If either of them is null, false is returned.
Category: Location
Operand types:
a:
String
b:
String
Type of returned value:
Boolean
Description:
a equal to b (case insensitive)
Example:
nameOfPlayer == "John Doe"
Category: Default
Operand types:
a:
Number
b:
Number
Type of returned value:
Boolean
Description:
a greater than b
Example:
counter > 4
Category: Default
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
Operand types:
config:
Config
name:
String
Compatibility:
Version 2.35 required.
Type of returned value:
Config
Description:
Returns subentry of config entry with given name.
Example:
configFile >> "CfgVehicles"
Category: OFP PC
Operand types:
a:
Number
b:
Number
Type of returned value:
Number
Description:
a raised to the power of b
Example:
count^4
Category: Default
Operand types:
a:
Boolean
b:
Boolean
Type of returned value:
Boolean
Description:
a or b
Example:
!alive player || !alive leader player
Category: Default
Operand types:
x:
Number
Type of returned value:
Number
Description:
The absolute value of x.
Example:
abs -3
, result is 3
Category: Default
Type of returned value:
Number
Description:
Returns the current time acceleration factor.
Category: OFP
Operand types:
x:
Number
Type of returned value:
Number
Description:
The arccosine of x, the result is in degrees.
Example:
acos 0.5
, result is 60
Category: Default
Operand types:
unit:
Object
action:
Array
Type of returned value:
Nothing
Description:
Makes the unit peform an action. The format of action can be [type, target, param1, param2, param3]. Only type is required, target defaults to unit and param1, param2, param3 are type specific.
Example:
soldierOne action ["eject", vehicle soldierOne]
Category: OFP
Operand types:
action:
String
Compatibility:
Version 2.01 required.
Type of returned value:
Array
Description:
Returns a list of dikCodes of buttons assigned to the given user action.
Example:
array = actionKeys "ReloadMagazine"
Category: OFP
Operand types:
action or [action, maxKeys]:
String or Array
Compatibility:
Version 2.01 required.
Type of returned value:
Structured text
Description:
Returns a list of button images or names assigned to the given user action. A maximum of maxKeys keys is listed. You can find the action names in config class ControllerSchemes.
Example:
text = actionKeysImages "ReloadMagazine"
Category: OFP
Operand types:
action or [action, maxKeys]:
String or Array
Compatibility:
Version 2.01 required.
Type of returned value:
String
Description:
Returns a list of button names assigned to the given user action. A maximum of maxKeys keys is listed. You can find the action names in config class ControllerSchemes.
Example:
list = actionKeysNames "ReloadMagazine"
Category: OFP
Operand types:
[addon1, ...]:
Array
Compatibility:
Version 2.32 required.
Type of returned value:
Nothing
Description:
Activates the listed addons. The list of active addons is initialized during this function.
Example:
activateAddons ["BISOFP"]
Category: OFP
Operand types:
keyName:
String
Compatibility:
Version 2.06 required.
Type of returned value:
Nothing
Description:
Activates the given key for the current user profile. The keys are used to unlock missions or campaigns. See keys, keysLimit and doneKeys in the description.ext file of the missions.
Example:
activateKey "M04"
Category: OFP
Operand types:
unit:
Object
[action, script filename(, arguments, priority, showWindow, hideOnUse, shortcut, condition)]:
Array
Compatibility:
Version 1.10 required.
Type of returned value:
Description:
Creates an action. The action ID should be returned, but due to a bug, it's not.
To determine the action ID, use following algorithm: the first action added to the given vehicle has ID zero, the next vehicle has ID one, etc.
Example:
player addAction ["Hello", "hello.sqs"]
Category: OFP
Operand types:
map:
Control
[type, [name1, value1, ...], subtype class]:
Array
Compatibility:
Version 2.92 required.
Type of returned value:
String
Description:
Add an object to the editor and assign arguments. Create script is called with _new equal to true. Returns the ID of the new EditorObject. Subtype class is optional.
Category: Editor
Operand types:
object:
Object
handler:
Array
Compatibility:
Version 1.85 required.
Type of returned value:
Description:
The format of handler is [type,command]. Check scripting topic Event handlers for more information. The index of the currently added handler is returned.
Example:
player addEventHandler ["killed",{_this exec "playerKilled.sqs"}]
Category: OFP
Operand types:
group:
Group
properties:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Number
Description:
Add icon to a group. Returns icon ID
Example:
id = group addGroupIcon["b_inf",[offsetX,ofsetY]]
Category: OFP
Operand types:
unit:
Object
score:
Number
Compatibility:
Version 2.10 required.
Type of returned value:
Nothing
Description:
Xbox Live MP only: adds score to the Xbox Live Statistics score for the given unit (or the commander unit of the given vehicle).
Example:
player addLiveStats 10
Category: OFP
Operand types:
unit:
Object
weaponName:
String
Type of returned value:
Nothing
Description:
Adds a magazine to the unit. Note: you may create invalid combinations by using this function, for example by adding 20 grenades. When doing so, application behaviour is undefined.
Example:
player addMagazine "M16"
Category: OFP
Operand types:
unit:
Object
magazines:
Array
Type of returned value:
Nothing
Description:
Adds magazines to the weapon cargo space. This is used for infantry weapons. The format of magazines is [magazineName, count].
For magazineName values see CfgWeapons.
Example:
rearmTruckOne addMagazineCargo ["M16", 10]
Category: OFP
Compatibility:
Version 1.75 required.
Type of returned value:
Nothing
Description:
Adds count magazines of type name into the weapon pool (used in the campaign to transfer weapons to the next mission).
Category: Resistance
Operand types:
map:
Control
[text,priority]:
Array
Compatibility:
Version 2.92 required.
Type of returned value:
Number
Description:
Adds a new menu button. Priority is optional.
Category: Editor
Operand types:
map:
Control
[menu or index,text,command,priority]:
Array
Compatibility:
Version 2.92 required.
Type of returned value:
Number
Description:
Creates a new menu item. Menu can be "file" or "view", index is index as returned from addMenu command. priority is optional and determines where in the menu the item will reside (higher priority items first).
Category: Editor
Operand types:
name:
String
code:
Code
Type of returned value:
Nothing
Description:
Create an event handler for given variable. The event handler will be executed when some client in MP exports a variable using publicVariable on all clients except the publishing one.
Example:
"alarm" addPublicVariableEventHandler {_this execVM "alarm.sqf"}
Category: OFP
Operand types:
unit:
Object
number:
Number
Type of returned value:
Nothing
Description:
Adds number to the unit rating. This is usually used to reward for completed mission objectives. The rating for killed enemies and killed friendlies is adjusted automatically. When the rating is lower than zero, a unit is considered "renegade" and is an enemy to everyone.
Example:
player addRating 1000
Category: OFP
Operand types:
unit:
Object
score:
Number
Type of returned value:
Nothing
Description:
MP only: adds unit score. This is shown in the "I" MP screen as the total score.
Example:
player addScore 10
Category: OFP
Operand types:
person:
Object
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Add a unit into the list of units available for team switch.
Category: OFP
Operand types:
group:
Group
vehicle:
Object
Compatibility:
Version 5128 required.
Type of returned value:
Nothing
Description:
Tells the group it owns the vehicle now.
Category: OFP
Operand types:
group:
Group
[center, radius] or [center, radius, index]:
Array
Compatibility:
Version 1.86 required.
Type of returned value:
Array
Description:
Adds (or inserts when index is given) a new waypoint to a group. The waypoint is placed randomly in a circle with the given center and radius. The function returns a waypoint with format [group, index].
Example:
grp addWaypoint [position player, 0]
Category: OFP
Operand types:
unit:
Object
weaponName:
String
Type of returned value:
Nothing
Description:
Adds the weapon to the unit. Note: you may create invalid combinations by using this function, for example by adding two rifles. When doing so, application behaviour is undefined.
Example:
player addWeapon "AK74"
Category: OFP
Operand types:
unit:
Object
weapons:
Array
Type of returned value:
Nothing
Description:
Adds weapons to the weapon cargo space. This is used for infantry weapons. The format of weapons is [weaponName, count].
For weaponName values see CfgWeapons.
Example:
rearmTruckOne addWeaponCargo ["M16", 10]
Category: OFP
Operand types:
[name, count]:
Array
Compatibility:
Version 1.75 required.
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).
Category: Resistance
Operand types:
airportId:
Number
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Checks a side of the airport.
Example:
airportSide 0
, result is west
Category: OFP
Operand types:
[unit,unit,bool]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
AIS end state.
Example:
AISFinishHeal [wounded,medic,true]
Category: OFP
Operand types:
obj:
Object
Type of returned value:
Boolean
Description:
Checks whether the given person, vehicle or building is't dead / destroyed.
Example:
alive player
Category: OFP
Compatibility:
Version 5501 required.
Type of returned value:
Array
Description:
Return a list of all groups.
Category: OFP
Operand types:
map:
Control
bool:
Boolean
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Allow/dissallow 3D mode.
Category: Editor
Operand types:
obj:
Object
allow:
Boolean
Type of returned value:
Nothing
Description:
Obsolete.
Category: OFP
Operand types:
obj:
Object
allow:
Boolean
Type of returned value:
Nothing
Description:
Obsolete.
Category: OFP
Operand types:
map:
Control
bool:
Boolean
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Allow/dissallow file ops (load/save etc).
Category: Editor
Operand types:
unit:
Object or Group
courage:
Number
Type of returned value:
Nothing
Description:
Sets the group courage. The less courage, the sooner the group will start fleeing. 0 means maximum courage, while 1 means always fleeing.
Example:
soldierOne allowFleeing 0
Category: OFP
Operand types:
unitArray:
Array
allow:
Boolean
Type of returned value:
Nothing
Description:
Allows the getting in of vehicles of all units in the list.
Example:
[unitOne, unitTwo] allowGetIn false
Category: OFP
Compatibility:
Version 5501 required.
Type of returned value:
Array
Description:
Return a list of all units (all persons except agents).
Category: OFP
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.
Example:
player ammo "M16"
Category: OFP
Operand types:
a:
Boolean
b:
Boolean
Type of returned value:
Boolean
Description:
a and b
Example:
alive player and alive leader player
Category: Default
Operand types:
object:
Object
[animation, phase]:
Array
Compatibility:
Version 1.75 required.
Type of returned value:
Nothing
Description:
Process animation on object. Animation is defined in config file. Wanted animation phase is set to phase.
Example:
house animate ["doors1", 1]
Category: Resistance
Operand types:
object:
Object
animation:
String
Compatibility:
Version 1.75 required.
Type of returned value:
Number
Description:
Return animation phase of animation on object.
Example:
house animationPhase "doors1"
Category: Resistance
Operand types:
man:
Object
Compatibility:
Version 2.92 required.
Type of returned value:
String
Description:
Return the name of the current primary animation.
Category: OFP
Compatibility:
Version 5500 required.
Type of returned value:
Number
Description:
Return the stored value of armory points.
Category: OFP
Operand types:
x:
Number
Type of returned value:
Number
Description:
The arcsine of x, the result is in degrees.
Example:
asin 0.5
, result is 30
Category: Default
Operand types:
codition:
Boolean
Compatibility:
Version 2.00 required.
Type of returned value:
Boolean
Description:
Tests a condition and if the condition is false, halts the program.
Example:
assert (_x>0)
Category: Default
Operand types:
soldier:
Object
vehicle:
Object
Type of returned value:
Nothing
Description:
Assigns the soldier to the cargo / passenger space of the given vehicle.
Example:
player assignAsCargo tankOne
Category: OFP
Operand types:
soldier:
Object
vehicle:
Object
Type of returned value:
Nothing
Description:
Assigns the soldier as commander of the given vehicle.
Example:
player assignAsCommander tankOne
Category: OFP
Operand types:
soldier:
Object
vehicle:
Object
Type of returned value:
Nothing
Description:
Assigns the soldier as driver of the given vehicle.
Example:
player assignAsDriver tankOne
Category: OFP
Operand types:
soldier:
Object
vehicle:
Object
Type of returned value:
Nothing
Description:
Assigns the soldier as gunner of the given vehicle.
Example:
player assignAsGunner tankOne
Category: OFP
Operand types:
vehicle:
Object
Compatibility:
Version 5501 required.
Type of returned value:
Array
Description:
Returns the list of soldiers assigned to the given vehicle as a cargo.
Category: OFP
Operand types:
vehicle:
Object
Compatibility:
Version 5501 required.
Type of returned value:
Object
Description:
Returns the soldier assigned to the given vehicle as a commander.
Category: OFP
Operand types:
vehicle:
Object
Compatibility:
Version 5501 required.
Type of returned value:
Object
Description:
Returns the soldier assigned to the given vehicle as a driver.
Category: OFP
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
Operand types:
vehicle:
Object
Compatibility:
Version 2.92 required.
Type of returned value:
Object
Description:
Return the target assigned to the vehicle.
Category: OFP
Operand types:
person:
Object
Compatibility:
Version 5130 required.
Type of returned value:
Object
Description:
Return the vehicle person is assigned to.
Category: OFP
Operand types:
person:
Object
Compatibility:
Version 5130 required.
Type of returned value:
Array
Description:
Return the position in vehicle person is assigned to.
Category: OFP
Operand types:
vehicle:
Object
team:
String
Compatibility:
Version 2.05 required.
Type of returned value:
Nothing
Description:
Assigns the vehicle (specifically its commander unit) to the given team. The possible team values are: "MAIN", "RED", "GREEN", "BLUE" and "YELLOW".
Example:
soldier2 assignTeam "RED"
Category: OFP
Operand types:
airplane:
Object
airportId:
Number
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Set airport to be used by AI on getout
Example:
plane assignToAirport 0
Category: OFP
Operand types:
x:
Number
Type of returned value:
Number
Description:
The arctangens of x, the result is in degrees.
Example:
atan 1
, result is 45
Category: Default
Operand types:
x:
Number
y:
Number
Type of returned value:
Number
Description:
Returns the arctangens of x/y. The returned value is in degrees, in the range from -180 to +180, using the signs of both parameters to determine the quadrant of the returned value.
Example:
5 atan2 3
, result is 59.0362
Category: Default
Operand types:
x:
Number
Type of returned value:
Number
Description:
The arctangens of x, the result is in degrees.
Example:
atg 1
, result is 45
Category: Default
Operand types:
location:
Location
Compatibility:
Version 2.90 required.
Type of returned value:
Object
Description:
Return object attached to given location.
Category: Location
Operand types:
location:
Location
object:
Object
Compatibility:
Version 2.90 required.
Type of returned value:
Nothing
Description:
Attach a object to given location.
Category: Location
Operand types:
obj:
Object
[obj, offset, MemPoint]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Attaches an object to another object. The offset is applied to the object center unless a memory point is provided.
Example:
player attachTo [car, [0,2,0],hatch1]
Category: OFP
Operand types:
group:
Object or Group
Compatibility:
Version 2.92 required.
Type of returned value:
Boolean
Description:
Return whether leader can issue attack commands.
Category: OFP
Operand types:
unit:
Object
Type of returned value:
String
Description:
Returns the behaviour mode of the given unit ("CARELESS","SAFE","AWARE","COMBAT" or "STEALTH").
Example:
behaviour player
Category: OFP
Type of returned value:
Number
Description:
Returns the value of "3D performance" as it is in OFP preferences. This can be used to estimate computer performance. The function can be used to create missions that are able to adapt to computer peformance.
Example:
? benchmark>2000 : setviewdistance 2000
Category: OFP
Operand types:
object:
Object
Compatibility:
Version 2.92 required.
Type of returned value:
Array
Description:
Returns a bounding box of given object in model coordinates space. The result is in format [[minX, minZ, minY], [maxX, maxZ, maxY]].
Category: OFP
Operand types:
object:
Object
Compatibility:
Version 5501 required.
Type of returned value:
Array
Description:
Returns the position of original (loaded) center of object in model coordinates. The result is in format [x, z, y]
Category: OFP
Operand types:
name:
String
Type of returned value:
Nothing
Description:
Breaks block out scope named 'name'. Nil is returned.
Category: Default
Operand types:
name:
String
Type of returned value:
Nothing
Description:
Breaks block to scope named 'name'. Nil is returned.
Category: Default
Operand types:
building:
Object
index:
Number
Type of returned value:
Array
Description:
Returns the given indexed exit in a building. The returned value is in format Position.
Example:
buildingExit [building, 1]
Category: OFP
Operand types:
building:
Object
index:
Number
Type of returned value:
Array
Description:
Returns the given indexed position in a building. The returned value is in format Position.
Example:
building buildingPos 1
Category: OFP
Operand types:
control:
Control
Compatibility:
Version 2.92 required.
Type of returned value:
String
Description:
Returns the action assigned to the given button or active text. The action is any expression in this scripting language.
Example:
_action = buttonAction _button
Category: OFP PC
Operand types:
idc:
Number
Compatibility:
Version 1.50 required.
Type of returned value:
String
Description:
Returns the action assigned to the control with id idc of the topmost user dialog. The action is any expression in this scripting language. The function can be used for buttons and active texts.
Example:
_action = buttonAction 100
Category: Resistance
Operand types:
[idc, action]:
Array
Compatibility:
Version 1.50 required.
Type of returned value:
Nothing
Description:
Assigns an action to the control with id idc of the topmost user dialog. Action is any expression in this scripting language. The function can be used for buttons and active texts.
Example:
buttonSetAction [100, "player exec ""reply.sqs"""]
Category: Resistance
Operand types:
control:
Control
action:
String
Compatibility:
Version 2.91 required.
Type of returned value:
Nothing
Description:
Assigns an action to the given button or active text. Action is any expression in this scripting language.
Example:
_control buttonSetAction "player exec ""reply.sqs"""
Category: OFP PC
Type of returned value:
Boolean
Description:
Returns true if the mission is played in cadet mode and false in veteran mode.
Category: OFP
Operand types:
code:
Code
Compatibility:
Version 1.85 required.
Type of returned value:
Any
Description:
Executes the given code.
Example:
call {"x=2"}
Category: Default
Operand types:
pars:
Any
body:
Code
Compatibility:
Version 1.85 required.
Type of returned value:
Any
Description:
Executes the function body. Argument pars is passed as _this.
Example:
[1,2] call {(_this select 0)+(_this select 1)}
, result is 3
Category: Default
Operand types:
camera:
Object
command:
String
Type of returned value:
Nothing
Description:
Executes a command on the given camera / actor object. The "manual on" and "manual off" commands are recognized for all types. For the "camera" type, the following commands can be used: "inertia on" and "inertia off". For the "seagull" type it's one of: "landed" and "airborne".
Example:
_camera camCommand "Manual on"
Category: OFP
Operand types:
camera:
Object
time:
Number
Type of returned value:
Nothing
Description:
Commits the camera changes smoothly over time. A time of zero results in an immediate change.
Example:
_camera camCommit 5
Category: OFP
Operand types:
camera:
Object
time:
Number
Compatibility:
Version 2.95 required.
Type of returned value:
Nothing
Description:
Commits the prepared camera changes smoothly over time. A time of zero results in an immediate change.
Example:
_camera camCommit 5
Category: OFP
Operand types:
camera:
Object
Type of returned value:
Boolean
Description:
Checks whether the camera has finished committing.
Example:
camCommitted _camera
Category: OFP
Operand types:
camera:
Object
[[x,y,z],radius, max above land]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Sets construction camera parameters.
Example:
_camera camConstuctionSetParams [getpos player,50,20]
Category: OFP
Operand types:
type:
String
position:
Array
Type of returned value:
Object
Description:
Creates a camera or an actor of the given type on the given initial position (format Position). Its type is one of "CAMERA" or "SEAGULL".
Example:
_camera = camCreate getPos player
Category: OFP
Operand types:
camera:
Object
Type of returned value:
Nothing
Description:
Destroys the camera.
Category: OFP
Operand types:
camera:
Object
effect:
Array
Type of returned value:
Nothing
Description:
Switches the camera to the given vehicle / camera. The format of effect is [name, position]. Name is one of: "Internal", "External", "Fixed" or "FixedWithZoom". Position is one of: "TOP", "LEFT", "RIGHT", "FRONT" or "BACK" ("BACK" is normally used).
Example:
cameraEffect ["External", "Back"]
Category: OFP
Operand types:
enable:
Boolean
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Enable / disable showing of in-game UI during currently active camera effect.
Category: OFP
Operand types:
entity:
Object
Compatibility:
Version 2.57 required.
Type of returned value:
Number
Description:
Return camera interest for given entity.
Category: OFP
Compatibility:
Version 1.56 required.
Type of returned value:
Object
Description:
Returns the vehicle to which the camera is attached.
Category: OFP
Compatibility:
Version 5501 required.
Type of returned value:
String
Description:
Return type of camera.
Category: OFP
Compatibility:
Version 2.90 required.
Type of returned value:
Config
Description:
Return root of campaign description.ext entries hierarchy.
Category: OFP PC
Operand types:
camera:
Object
time:
Number
Compatibility:
Version 2.95 required.
Type of returned value:
Nothing
Description:
Preload the scene for he prepared camera. Time gives timeout, zero means no (infinite) timeout.
Example:
_camera camCommit 5
Category: OFP
Operand types:
camera:
Object
Compatibility:
Version 2.92 required.
Type of returned value:
Boolean
Description:
Checks whether the camera has finished preloading.
Example:
camPreloaded _camera
Category: OFP
Operand types:
camera:
Object
bank:
Number
Compatibility:
Version 2.95 required.
Type of returned value:
Nothing
Description:
Prepares the camera bank angle. See also camPreload and camCommitPrepared.
Example:
_camera camPrepareBank -0.1
Category: OFP
Operand types:
camera:
Object
direction:
Number
Compatibility:
Version 2.95 required.
Type of returned value:
Nothing
Description:
Prepares the camera heading. See also camPreload and camCommitPrepared.
Example:
_camera camPrepareDir 150
Category: OFP
Operand types:
camera:
Object
dive:
Number
Compatibility:
Version 2.95 required.
Type of returned value:
Nothing
Description:
Prepares the camera dive angle. See also camPreload and camCommitPrepared.
Example:
_camera camPrepareDive -0.1
Category: OFP
Operand types:
camera:
Object
focusRange:
Array
Compatibility:
Version 2.95 required.
Type of returned value:
Nothing
Description:
focusRange is in format [distance,blur].
Prepares the camera focus blur. See also camPreload and camCommitPrepared.
Example:
_camera camPrepareFocus [50, 1]
Category: OFP
Operand types:
camera:
Object
fieldOfView:
Number
Compatibility:
Version 2.95 required.
Type of returned value:
Nothing
Description:
Prepares the camera field of view (zoom). See also camPreload and camCommitPrepared.
Example:
_camera camPrepareFov 0.1
Category: OFP
Operand types:
camera:
Object
fovRange:
Array
Compatibility:
Version 2.95 required.
Type of returned value:
Nothing
Description:
Prepares the camera field of view range for auto zooming. See also camPreload and camCommitPrepared.
Example:
_camera camPrepareFovRange [0.1, 0.5]
Category: OFP
Operand types:
camera:
Object
position:
Array
Compatibility:
Version 2.95 required.
Type of returned value:
Nothing
Description:
Prepares the camera position (format Position). See also camPreload and camCommitPrepared.
Example:
_camera camPreparePos getPos player
Category: OFP
Operand types:
camera:
Object
position:
Array
Compatibility:
Version 2.95 required.
Type of returned value:
Nothing
Description:
Prepares the camera position relative to the current position of the currect target (see camPrepareTarget). See also camPreload and camCommitPrepared.
Example:
_camera camPrepareRelPos [10,5]
Category: OFP
Operand types:
camera:
Object
position:
Array
Compatibility:
Version 2.95 required.
Type of returned value:
Nothing
Description:
Prepares the camera target to a position (format Position). See also camPreload and camCommitPrepared.
Example:
_camera camPrepareTarget getPos player
Category: OFP
Operand types:
camera:
Object
target:
Object
Compatibility:
Version 2.95 required.
Type of returned value:
Nothing
Description:
Prepares the camera target. See also camPreload and camCommitPrepared.
Example:
_camera camPrepareTarget player
Category: OFP
Operand types:
camera:
Object
bank:
Number
Type of returned value:
Nothing
Description:
Sets the camera bank angle. It does not automatically commit changes.
Example:
_camera camSetBank -0.1
Category: OFP
Operand types:
camera:
Object
direction:
Number
Type of returned value:
Nothing
Description:
Sets the camera heading. It does not automatically commit changes.
Example:
_camera camSetDir 150
Category: OFP
Operand types:
camera:
Object
dive:
Number
Type of returned value:
Nothing
Description:
Sets the camera dive angle. It does not automatically commit changes.
Example:
_camera camSetDive -0.1
Category: OFP
Operand types:
camera:
Object
focusRange:
Array
Type of returned value:
Nothing
Description:
focusRange is in format [distance,blur].
Sets the camera focus blur. It does not automatically commit changes.
Example:
_camera camSetFocus [50, 1]
Category: OFP
Operand types:
camera:
Object
fieldOfView:
Number
Type of returned value:
Nothing
Description:
Sets the camera field of view (zoom). It does not automatically commit changes.
Example:
_camera camSetFov 0.1
Category: OFP
Operand types:
camera:
Object
fovRange:
Array
Type of returned value:
Nothing
Description:
Sets the camera field of view range for auto zooming. It does not automatically commit changes.
Example:
_camera camSetFovRange [0.1, 0.5]
Category: OFP
Operand types:
camera:
Object
position:
Array
Type of returned value:
Nothing
Description:
Sets the camera position (format Position). It does not automatically commit changes.
Example:
_camera camSetPos getPos player
Category: OFP
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
Operand types:
camera:
Object
target:
Object
Type of returned value:
Nothing
Description:
Sets the camera target. It does not automatically commit changes.
Example:
_camera camSetTarget player
Category: OFP
Operand types:
camera:
Object
position:
Array
Type of returned value:
Nothing
Description:
Sets the camera target to a position (format Position). It does not automatically commit changes.
Example:
_camera camSetTarget getPos player
Category: OFP
Operand types:
camera:
Object
Compatibility:
Version 5501 required.
Type of returned value:
Object
Description:
Returns camera's target.
Example:
camTarget _camera
Category: OFP
Operand types:
set:
Boolean
Compatibility:
Version 2.73 required.
Type of returned value:
Nothing
Description:
Set / clear using of night vision during cutscenes.
Category: OFP
Operand types:
vehicle:
Object
Type of returned value:
Boolean
Description:
Checks whether the given vehicle is able to fire. It does not check for ammo, only for damage.
Example:
canFire vehicle player
Category: OFP
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.
Example:
canMove vehicle player
Category: OFP
Operand types:
soldier:
Object
Type of returned value:
Boolean
Description:
Checks whether the given soldier is able to stand up.
Example:
canStand player
Category: OFP
Operand types:
vehicle:
Object
Compatibility:
Version 5501 required.
Type of returned value:
Boolean
Description:
Check if cargo of this vehicle want to get out when in combat.
Category: OFP
Operand types:
unit:
Object
Type of returned value:
Boolean
Description:
Checks whether the unit is a captive. If the unit is a vehicle, its commander is checked instead.
Example:
captive player
Category: OFP
Operand types:
unit:
Object
Type of returned value:
Number
Description:
Checks whether the unit is a captive. If the unit is a vehicle, its commander is checked instead.
Example:
captive player
Category: OFP
Operand types:
b:
Any
Type of returned value:
Switch Type
Description:
see switch
Category: Default
Operand types:
try-Block:
Exception Type
code:
Code
Type of returned value:
Any
Description:
processes code, when exception is thrown in try block
Category: Default
Operand types:
x:
Number
Type of returned value:
Number
Description:
The ceil value of x.
Example:
ceil 5.25
, result is 6
Category: Default
Compatibility:
Version 1.56 required.
Type of returned value:
Boolean
Description:
Checks whether cheats are enabled (whether the designers' version is running).
Category: Resistance
Type of returned value:
Side
Description:
The Civilian side.
Category: OFP
Operand types:
group:
Group
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Removes all icon from group.
Example:
clearGroupIcons group
Category: OFP
Operand types:
unit:
Object
Type of returned value:
Nothing
Description:
Removes all magazines from the vehicle cargo space.
Example:
clearMagazineCargo jeepOne
Category: OFP
Compatibility:
Version 1.75 required.
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).
Category: Resistance
Operand types:
map:
Control
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Clear the current overlay.
Example:
clearOverlay _map
Category: Editor
Compatibility:
Version 2.73 required.
Type of returned value:
Nothing
Description:
Clean up the content of radio protocol history.
Category: OFP
Operand types:
vehicle:
Object
Compatibility:
Version 5154 required.
Type of returned value:
Nothing
Description:
Clear vehicle init field.
Example:
clearVehicleInit soldier3
Category: OFP
Operand types:
unit:
Object
Type of returned value:
Nothing
Description:
Removes all weapons from the vehicle cargo space.
Example:
clearWeaponCargo jeepOne
Category: OFP
Compatibility:
Version 1.75 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).
Category: Resistance
Operand types:
idc:
Number
Compatibility:
Version 1.50 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
Operand types:
display:
Display
exitcode:
Number
Compatibility:
Version 2.53 required.
Type of returned value:
Nothing
Description:
Close given display.
Example:
_display closeDisplay IDC_OK
Category: OFP PC
Operand types:
map:
Control
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Closes the current overlay without committing.
Category: Editor
Operand types:
map:
Control
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Collapse the object tree.
Example:
collapseObjectTree _map
Category: Editor
Operand types:
grp:
Object or Group
Type of returned value:
String
Description:
Returns the combat mode of the given unit ("BLUE","GREEN","YELLOW" or "RED").
Example:
combatMode group player
Category: OFP
Operand types:
unit:
Object or Array
chatText:
String
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Types text to the command 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 commandChat "Show this text"
Category: OFP
Operand types:
vehicle:
Object
Type of returned value:
Object
Description:
Returns the commander of the vehicle. If the vehicle is not a vehicle, but a person, the person is returned instead.
Example:
commander vehicle player
Category: OFP
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). If the target is objNull, the unit is ordered to commence firing on its current target (set using doTarget or commandTarget).
Example:
soldierOne commandFire player
Category: OFP
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).
Example:
soldierOne commandFollow player
Category: OFP
Operand types:
unit(s):
Object or Array
[fsm name, position, target]:
Array
Compatibility:
Version 2.53 required.
Type of returned value:
Nothing
Description:
Orders a unit to process command defined by FSM file (via the radio).
Example:
soldierOne commandFSM ["move.fsm", position player, player]
Category: OFP PC
Operand types:
unit:
Object or Array
Compatibility:
Version 2.28 required.
Type of returned value:
Nothing
Description:
Orders the unit to get out from the vehicle (via the radio).
Example:
commandGetOut unitOne
Category: OFP
Compatibility:
Version 5501 required.
Type of returned value:
String
Description:
Return the name of the topmost commanding menu.
Category: OFP
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) (via the radio).
Example:
soldierOne commandMove getMarkerPos "MarkerMoveOne"
Category: OFP
Operand types:
unit:
Object or Array
radioName:
String
Compatibility:
Version 5501 required.
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.
Example:
soldierOne commandRadio "messageOne"
Category: OFP
Operand types:
unit:
Object or Array
Type of returned value:
Nothing
Description:
Orders the unit to stop (via the radio).
Note: the stop command is never finished; the unit will never be ready.
Example:
commandStop unitOne
Category: OFP
Operand types:
unit:
Object or Array
position:
Object
Type of returned value:
Nothing
Description:
Orders the unit to target the given target (via the radio).
Example:
soldierOne commandTarget player
Category: OFP
Operand types:
unit:
Object or Array
position:
Array
Type of returned value:
Nothing
Description:
Orders the unit to watch the given position (format Position) (via the radio).
Example:
soldierOne commandWatch getMarkerPos "MarkerMoveOne"
Category: OFP
Operand types:
unit:
Object or Array
target:
Object
Type of returned value:
Nothing
Description:
Orders the unit to watch the given target (via the radio).
Example:
soldierOne commandWatch player
Category: OFP
Operand types:
comment:
String
Compatibility:
Version 1.85 required.
Type of returned value:
Nothing
Description:
This function does nothing. It's used to create comments.
Example:
comment "This is a comment."
Category: Default
Operand types:
map:
Control
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Commit the current overlay.
Example:
commitOverlay _map
Category: Editor
Operand types:
expression:
String
Compatibility:
Version 2.60 required.
Type of returned value:
Code
Description:
Compile expression.
Example:
_function = "a = a + 1"; _compiled = compile _function; call _compiled;
Category: Default
Operand types:
FSM handle:
Number
Compatibility:
Version 5500 required.
Type of returned value:
Boolean
Description:
Check whether the given FSM completes. The FSM handle is the number returned by the execFSM command.
Category: OFP
Operand types:
[text1, text2, ...]:
Array
Compatibility:
Version 2.01 required.
Type of returned value:
Structured text
Description:
Creates a structured text by joining the given structured or plain texts.
Example:
txt = composeText ["First line", image "data\isniper.paa", lineBreak, "Second line"]
Category: OFP
Compatibility:
Version 2.35 required.
Type of returned value:
Config
Description:
Return root of config entries hierarchy.
Category: OFP PC
Operand types:
config:
Config
Compatibility:
Version 2.35 required.
Type of returned value:
String
Description:
Returns name of config entry.
Example:
_name = configName (configFile >> "CfgVehicles")
, result is "CfgVehicles"
Category: OFP PC
Compatibility:
Version 2.92 required.
Type of returned value:
Control
Description:
A non-existing control. This value is not equal to anything, including itself.
Category: OFP PC
Compatibility:
Version 5500 required.
Type of returned value:
String
Description:
Return the content of the (text) clipboard.
Category: OFP
Operand types:
text:
String
Compatibility:
Version 5500 required.
Type of returned value:
Nothing
Description:
Copy the text to the clipboard.
Category: OFP
Operand types:
groupTo:
Group
groupFrom:
Group
Compatibility:
Version 5500 required.
Type of returned value:
Nothing
Description:
Copy the chain of waypoints from source to target group. The target group will start to process waypoints from the first one.
Category: OFP
Operand types:
x:
Number
Type of returned value:
Number
Description:
The cosine of x, the argument is in degrees.
Example:
cos 60
, result is 0.5
Category: Default
Operand types:
config:
Config
Compatibility:
Version 2.35 required.
Type of returned value:
Number
Description:
Returns count of subentries.
Example:
_count = count (configFile >> "CfgVehicles")
Category: OFP PC
Operand types:
array:
Array
Type of returned value:
Number
Description:
The number of elements in the array.
Example:
count [0,0,1,2]
, result is 4
Category: Default
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.
It is calculated as follows:
1) Set the count to 0.
2) For each element in the array assign an element as _x and evaluate the condition expression. If it's true, increase the count.
Example:
"_x > 2" count [0, 1, 1, 2, 3, 3]
, result is 2
Category: Default
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.
Example:
player countEnemy list triggerOne
Category: OFP
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.
Example:
player countFriendly list triggerOne
Category: OFP
Operand types:
side:
Side
array:
Array
Type of returned value:
Number
Description:
Checks how many vehicles belong to the given side.
Example:
west countSide list triggerOne
Category: OFP
Operand types:
typeName:
String
array:
Array
Type of returned value:
Number
Description:
Counts how many vehicles in the array are of the given type. For types see CfgVehicles.
Example:
"Tank" countType list triggerOne
Category: OFP
Operand types:
unit:
Object
array:
Array
Type of returned value:
Number
Description:
Counts how many units in the array are considered unknown to the given unit.
Example:
player countUnknown list triggerOne
Category: OFP
Operand types:
[type, position, markers, placement, special]:
Array
Compatibility:
Version 2.89 required.
Type of returned value:
Object
Description:
Creates an (independent) agent (person) of the given type (type is a name of a subclass of CfgVehicles). If the markers array contains several marker names, the position of a random one is used. Otherwise, the given position is used. The unit is placed inside a circle with this position as its center and placement as its radius. Special properties can be: "NONE" and "FORM".
Example:
agent = createAgent ["SoldierWB", position player, [], 0, "FORM"]
Category: OFP
Operand types:
side:
Side
Compatibility:
Version 1.86 required.
Type of returned value:
Side
Description:
Creates a new AI center for the given side.
Example:
center = createCenter East
Category: OFP
Operand types:
name:
String
Compatibility:
Version 1.50 required.
Type of returned value:
Boolean
Description:
Creates a user dialog from the resource template name. If a user dialog already exists, it creates a child dialog of the topmost user dialog. The class name is searched in the description.ext file of the mission, the description.ext file of the campaign and the globlal resource.cpp file. The function returns its success.
Example:
_ok = createDialog "RscDisplayGame"
Category: Resistance
Operand types:
[subject, object, text]:
Array
Compatibility:
Version 5500 required.
Type of returned value:
String
Description:
Create a link to the section of diary given by subject. Record is selected based on given object (diary record, task or unit).
Example:
_link = createDiarySubject ["Group", player, "Player"]
Category: Identity
Operand types:
person:
Object
[subject, text(, task(, state))] or [subject, [title, text](, task(, state))]:
Array
Compatibility:
Version 2.53 required.
Type of returned value:
Diary record
Description:
Create a new record in a log.
Example:
_record = player createDiaryRecord ["diary", "Kill all enemies."]
Category: Identity
Operand types:
person:
Object
[subject, display name] or [subject, display name, picture]:
Array
Compatibility:
Version 2.92 required.
Type of returned value:
Number
Description:
Create a new subject page in a log.
Example:
_index = player createDiarySubject ["myPage", "My page"]
Category: Identity
Operand types:
parent:
Display
name:
String
Compatibility:
Version 2.53 required.
Type of returned value:
Nothing
Description:
Create child display of given display and load from resource "name".
Example:
_display createDisplay "RscObserver"
Category: OFP PC
Operand types:
[unit,resource]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Opens gear dialog for given unit.
Example:
CreateGearDialog [palyer,"RscDisplayGear"]
Category: OFP
Operand types:
side:
Side
Compatibility:
Version 1.86 required.
Type of returned value:
Group
Description:
Creates a new AI group for the given center (side).
Example:
group = createGroup East
Category: OFP
Operand types:
[side, position, idStatic, vehicle]:
Array
Compatibility:
Version 1.86 required.
Type of returned value:
Nothing
Description:
Adds a point guarded by the given side. If idStatic is not negative, the position of a static object with the given id is guarded. If the given vehicle is valid, the starting position of the vehicle is guarded, otherwise the given position is guarded.
Example:
point = createGuardedPoint [East, [0, 0], -1, vehicle player]
Category: OFP
Operand types:
[type, position, sizeX, sizeZ]:
Array
Compatibility:
Version 2.90 required.
Type of returned value:
Location
Description:
Create location of given type with given size at given position.
Category: Location
Operand types:
[name, position]:
Array
Compatibility:
Version 1.86 required.
Type of returned value:
String
Description:
Creates a new marker on the given position. The marker name has to be unique. The marker is created on all computers in a network session.
Example:
marker = createMarker [Marker1, position player]
Category: OFP
Operand types:
[name, position]:
Array
Compatibility:
Version 2.92 required.
Type of returned value:
String
Description:
Creates a new marker on the given position. The marker name has to be unique. The marker is only created on the computer where the command is called.
Example:
marker = createMarkerLocal [Marker1, position player]
Category: OFP
Operand types:
map:
Control
index:
Number
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Creates a previously added menu.
Category: Editor
Operand types:
[type, position, markers, placement]:
Array
Compatibility:
Version 2.32 required.
Type of returned value:
Object
Description:
Creates a mine of the given type (type is the name of the subclass of CfgVehicles). If the markers array contains several marker names, the position of a random one is used. Otherwise, the given position is used. The mine is placed inside a circle with this position as its center and placement as its radius.
Example:
mine = createMine ["MineMine", position player, [], 0]
Category: OFP
Operand types:
parent:
Display
root:
String
Compatibility:
Version 5140 required.
Type of returned value:
Display
Description:
Create single missions display as a child of given display. The mission dialog will be set to the directory given as an argument "root".
Example:
_display createMissionDisplay "Tutorial"
Category: OFP PC
Operand types:
person:
Object
[name] or [name, parentTask]:
Array
Compatibility:
Version 5500 required.
Type of returned value:
Task
Description:
Create a new simple task (subtask of parentTask).
Category: Identity
Operand types:
[type, position, markers, placement]:
Array
Compatibility:
Version 2.32 required.
Type of returned value:
Object
Description:
Creates a sound source of the given type (type is the name of the subclass of CfgVehicles). If the markers array contains several marker names, the position of a random one is used. Otherwise, the given position is used. The sound source is placed inside a circle with this position as its center and placement as its radius.
Example:
soundSource = createSoundSource ["LittleDog", position player, [], 0]
Category: OFP
Operand types:
teamMember:
[[type] or [type, parentTask], priority, name1, value1, name2, value2, ...]:
Array
Compatibility:
Version 2.62 required.
Type of returned value:
Task
Description:
Create a new AI task (subtask of parentTask). Type is name of registered task type.
Category: Identity
Operand types:
[type, position]:
Array
Compatibility:
Version 1.86 required.
Type of returned value:
Object
Description:
Creates a new trigger on the given position. An object of the given type is created; this type must be a class name in CfgNonAIVehicles or CfgVehicles with simulation=detector.
Example:
trigger = createTrigger["EmptyDetector", position player]
Category: OFP
Operand types:
group:
Group
[type, position, markers, placement, special]:
Array
Compatibility:
Version 2.32 required.
Type of returned value:
Object
Description:
Creates a unit (person) of the given type (type is a name of a subclass of CfgVehicles) and makes it a member of the given group. If the markers array contains several marker names, the position of a random one is used. Otherwise, the given position is used. The unit is placed inside a circle with this position as its center and placement as its radius. Special properties can be: "NONE" and "FORM".
Example:
unit = group player createUnit ["SoldierWB", position player, [], 0, "FORM"]
Category: OFP
Operand types:
type:
String
unitInfo:
Array
Compatibility:
Version 1.34 required.
Type of returned value:
Nothing
Description:
Creates a unit of the given type. The format of unitInfo is:
[pos (Position), group (Group), init (String), skill (Number), rank (String)].
Note: init, skill and rank are optional. Their default values are "", 0.5, "PRIVATE".
Example:
"SoldierWB" createUnit [getMarkerPos "barracks", groupAlpha]
Category: OFP
Operand types:
[type, position, markers, placement, special]:
Array
Compatibility:
Version 2.32 required.
Type of returned value:
Object
Description:
Creates a vehicle of the given type (type is the name of the subclass in CfgVehicles). If the markers array contains several marker names, the position of a random one is used. Otherwise, the given position is used. The vehicle is placed inside a circle with this position as center and placement as its radius. Special properties can be: "NONE", "FLY" and "FORM".
Example:
veh = createVehicle ["Cobra", position player, [], 0, "FLY"]
Category: OFP
Operand types:
type:
String
pos:
Array
Compatibility:
Version 1.34 required.
Type of returned value:
Object
Description:
Creates an empty vehicle of the given type. Pos is in format Position.
See CfgVehicles for possible type values.
Example:
_tank = "M1Abrams" createVehicle getmarkerpos "tankFactory"
Category: OFP
Operand types:
type:
String
pos:
Array
Compatibility:
Version 2.56 required.
Type of returned value:
Object
Description:
Creates an empty vehicle of the given type. Pos is in format Position.
See CfgVehicles for possible type values. Vehicle is not transferred through network in MP games.
Example:
_tank = "M1Abrams" createVehicleLocal getmarkerpos "tankFactory"
Category: OFP
Operand types:
vehicle:
Object
Type of returned value:
Array
Description:
Returns all units mounted in the given vehicle. If the vehicle is not a vehicle, but person, a list containing only persons is returned.
Example:
crew vehicle player
Category: OFP
Operand types:
control:
Control
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Launch actions attached to given (button based) control.
Example:
ctrlActivate _control
Category: OFP PC
Operand types:
control:
Control
[handler name, function]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Number
Description:
Add an event handler to the given control. Returns id of the handler or -1 when failed.
Example:
_id = _control ctrlAddEventHandler ["KeyDown", ""]
Category: OFP PC
Operand types:
control:
Control
Compatibility:
Version 5501 required.
Type of returned value:
Number
Description:
Returns number of seconds until auto-scroll starts. -2 if scrollbar not present.
Example:
_delay = ctrlAutoScrollDelay _control
Category: OFP PC
Operand types:
control:
Control
Compatibility:
Version 5501 required.
Type of returned value:
Boolean
Description:
True if auto-scroll should move back to start after it reach end.
Example:
_rewind = ctrlAutoScrollRewind _control
Category: OFP PC
Operand types:
control:
Control
Compatibility:
Version 5501 required.
Type of returned value:
Number
Description:
Returns number of seconds to auto-scroll one line. -1 if auto-scroll is disabled. -2 if scrollbar not present.
Example:
_speed = ctrlAutoScrollSpeed _control
Category: OFP PC
Operand types:
control:
Control
time:
Number
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Commit control animation.
Example:
_control ctrlCommit 2
Category: OFP PC
Operand types:
control:
Control
Compatibility:
Version 2.50 required.
Type of returned value:
Boolean
Description:
Check if the control animation is finished.
Example:
_done = ctrlCommitted _control
Category: OFP PC
Operand types:
[idc, enable]:
Array
Compatibility:
Version 1.50 required.
Type of returned value:
Nothing
Description:
Enables / disables the control with id idc of the topmost user dialog.
Example:
ctrlEnable [100, false]
Category: Resistance
Operand types:
control:
Control
enable:
Boolean
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Enable / disable given control.
Example:
_control ctrlEnable false
Category: OFP PC
Operand types:
control:
Control
Compatibility:
Version 2.50 required.
Type of returned value:
Boolean
Description:
Returns whether given control is enabled.
Example:
_ok = ctrlEnabled _control
Category: OFP PC
Operand types:
idc:
Number
Compatibility:
Version 1.50 required.
Type of returned value:
Boolean
Description:
Returns whether the control with id idc of the topmost user dialog is enabled.
Example:
_enabled = ctrlEnabled 100
Category: Resistance
Operand types:
control:
Control
Compatibility:
Version 2.50 required.
Type of returned value:
Number
Description:
Returns the current fade factor of control.
Example:
_scale = ctrlFade _control
Category: OFP PC
Operand types:
map:
Control
frame:
Array
Compatibility:
Version 1.92 required.
Type of returned value:
Nothing
Description:
Adds the next frame to the map animation. The format of frame is [time, zoom, position], the format of position is Position2D.
Example:
_map ctrlMapAnimAdd [1, 0.1, getMarkerPos "anim1"]
Category: OFP PC
Operand types:
control:
Control
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Clears the map animation.
Category: OFP PC
Operand types:
control:
Control
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Plays the map animation.
Category: OFP PC
Operand types:
control:
Control
Compatibility:
Version 2.92 required.
Type of returned value:
Boolean
Description:
Checks whether the map animation has finished.
Category: OFP PC
Operand types:
control:
Control
texture names:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Changes default cursor texture ("Track", "Move","Array", "Scroll") to custom one. To restore default texture, write empty string. If new texture does not exist, default cursor texture is used.
Example:
<map_control> ctrlMapCursor ["Track","customCursor"]
Category: OFP
Operand types:
control:
Control
Compatibility:
Version 5501 required.
Type of returned value:
Array
Description:
Returns description of map sign mouse cursor is over.
Category: OFP
Operand types:
control:
Control
Compatibility:
Version 2.92 required.
Type of returned value:
Number
Description:
Return the current scale of the map control.
Category: OFP PC
Operand types:
map:
Control
[x, y]:
Array
Compatibility:
Version 5127 required.
Type of returned value:
Array
Description:
Convert position in the map from screen coordinates to world coordinates.
Category: OFP PC
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.
Category: OFP PC
Operand types:
control:
Control
Compatibility:
Version 2.50 required.
Type of returned value:
Display
Description:
Returns container of given control.
Example:
_display = ctrlParent _control
Category: OFP PC
Operand types:
control:
Control
Compatibility:
Version 2.50 required.
Type of returned value:
Array
Description:
Returns the current position and size of control as [x, y, w, h] array.
Example:
_pos = ctrlPosition _control
Category: OFP PC
Operand types:
control:
Control
handler name:
String
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Remove all even handlers from the given control.
Example:
_control ctrlRemoveAllEventHandlers "KeyDown"
Category: OFP PC
Operand types:
control:
Control
[handler name, id]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Remove a given event handler from the given control.
Example:
_control ctrlRemoveEventHandler ["KeyDown", 0]
Category: OFP PC
Operand types:
control:
Control
Compatibility:
Version 5501 required.
Type of returned value:
Number
Description:
Returns the current scale of control.
Example:
_scale = ctrlScale _control
Category: OFP PC
Operand types:
display:
Control
color:
Array
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Sets text color of given control when control is selected. Color is in format Color.
Example:
_control ctrlSetActiveColor [1, 0, 0, 1]
Category: OFP PC
Operand types:
control:
Control
delay:
Number
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Sets number of second before auto-scroll starts.
Example:
_control ctrlSetAutoScrollDelay 5
Category: OFP PC
Operand types:
control:
Control
delay:
Boolean
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Defines if scroll should rewind when auto-scroll reach end.
Example:
_control ctrlSetAutoScrollDelay 5
Category: OFP PC
Operand types:
control:
Control
speed:
Number
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Sets number of second required to scroll to next line. If speed smaller than 0, auto-scroll is disabled.
Example:
_control ctrlSetAutoScrollSpeed 5
Category: OFP PC
Operand types:
display:
Control
color:
Array
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Sets background color of given control. Color is in format Color.
Example:
_control ctrlSetBackgroundColor [1, 0, 0, 1]
Category: OFP PC
Operand types:
control:
Control
[handler name, function]:
Array
Compatibility:
Version 2.54 required.
Type of returned value:
Nothing
Description:
Sets given event handler of given control
Example:
_control ctrlSetEventHandler ["KeyDown", ""]
Category: OFP PC
Operand types:
control:
Control
fade:
Number
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Sets wanted transparency for control animation.
Example:
_control ctrlSetFade 1
Category: OFP PC
Operand types:
control:
Control
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Set the input focus on given control.
Example:
ctrlSetFocus _control
Category: OFP PC
Operand types:
control:
Control
name:
String
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Sets the main font of given control.
Example:
_control ctrlSetFont "TahomaB"
Category: OFP PC
Operand types:
control:
Control
name:
String
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Sets H1 font of given HTML control.
Example:
_control ctrlSetFontH1 "TahomaB"
Category: OFP PC
Operand types:
control:
Control
name:
String
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Sets H1 bold font of given HTML control.
Example:
_control ctrlSetFontH1B "TahomaB"
Category: OFP PC
Operand types:
control:
Control
name:
String
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Sets H2 font of given HTML control.
Example:
_control ctrlSetFontH2 "TahomaB"
Category: OFP PC
Operand types:
control:
Control
name:
String
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Sets H2 bold font of given HTML control.
Example:
_control ctrlSetFontH2B "TahomaB"
Category: OFP PC
Operand types:
control:
Control
name:
String
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Sets H3 font of given HTML control.
Example:
_control ctrlSetFontH3 "TahomaB"
Category: OFP PC
Operand types:
control:
Control
name:
String
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Sets H3 bold font of given HTML control.
Example:
_control ctrlSetFontH3B "TahomaB"
Category: OFP PC
Operand types:
control:
Control
name:
String
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Sets H4 font of given HTML control.
Example:
_control ctrlSetFontH4 "TahomaB"
Category: OFP PC
Operand types:
control:
Control
name:
String
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Sets H4 bold font of given HTML control.
Example:
_control ctrlSetFontH4B "TahomaB"
Category: OFP PC
Operand types:
control:
Control
name:
String
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Sets H5 font of given HTML control.
Example:
_control ctrlSetFontH5 "TahomaB"
Category: OFP PC
Operand types:
control:
Control
name:
String
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Sets H5 bold font of given HTML control.
Example:
_control ctrlSetFontH5B "TahomaB"
Category: OFP PC
Operand types:
control:
Control
name:
String
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Sets H5 font of given HTML control.
Example:
_control ctrlSetFontH6 "TahomaB"
Category: OFP PC
Operand types:
control:
Control
name:
String
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Sets H6 bold font of given HTML control.
Example:
_control ctrlSetFontH6B "TahomaB"
Category: OFP PC
Operand types:
control:
Control
height:
Number
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Sets the main font size of given control.
Example:
_control ctrlSetFontHeight 0.05
Category: OFP PC
Operand types:
control:
Control
height:
Number
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Sets H1 font size of given HTML control.
Example:
_control ctrlSetFontHeightH1 0.05
Category: OFP PC
Operand types:
control:
Control
height:
Number
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Sets H2 font size of given HTML control.
Example:
_control ctrlSetFontHeightH2 0.05
Category: OFP PC
Operand types:
control:
Control
height:
Number
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Sets H3 font size of given HTML control.
Example:
_control ctrlSetFontHeightH3 0.05
Category: OFP PC
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 ctrlSetFontHeightH4 0.05
Category: OFP PC
Operand types:
control:
Control
height:
Number
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Sets H5 font size of given HTML control.
Example:
_control ctrlSetFontHeightH5 0.05
Category: OFP PC
Operand types:
control:
Control
height:
Number
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Sets H6 font size of given HTML control.
Example:
_control ctrlSetFontHeightH6 0.05
Category: OFP PC
Operand types:
control:
Control
name:
String
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Sets P font of given HTML control.
Example:
_control ctrlSetFontP "TahomaB"
Category: OFP PC
Operand types:
control:
Control
height:
Number
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Sets P font size of given HTML control.
Example:
_control ctrlSetFontHeightP 0.05
Category: OFP PC
Operand types:
control:
Control
name:
String
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Sets P bold font of given HTML control.
Example:
_control ctrlSetFontPB "TahomaB"
Category: OFP PC
Operand types:
display:
Control
color:
Array
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Sets background color of given control. Color is in format Color.
Example:
_control ctrlSetForegroundColor [1, 0, 0, 1]
Category: OFP PC
Operand types:
control:
Control
[x, y, w, h]:
Array
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Sets wanted position and size for control animation. Width and height are optional.
Example:
_control ctrlSetPosition [0.5, 0.5]
Category: OFP PC
Operand types:
control:
Control
scale:
Number
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Sets wanted scale for control animation. Top left corner remains same.
Example:
_control ctrlScale 0.5
Category: OFP PC
Operand types:
control:
Control
structured text:
Structured text
Compatibility:
Version 2.53 required.
Type of returned value:
Nothing
Description:
Set the structured text which will be displayed in structured text control.
Example:
_control ctrlSetStructuredText parseText "First line<img image=data\isniper.paa/><br/>Second line"
Category: OFP PC
Operand types:
[idc, text]:
Array
Compatibility:
Version 1.50 required.
Type of returned value:
Nothing
Description:
Sets the text that will be shown in the control with id idc of the topmost user dialog. This can be used for static texts, buttons, edit lines and active texts.
Example:
ctrlSetText [100, "Hello, world"]
Category: Resistance
Operand types:
control:
Control
text:
String
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Sets the text that will be shown in given control.
Example:
_control ctrlSetText "Hello, world."
Category: OFP PC
Operand types:
display:
Control
color:
Array
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Sets text color of given control. Color is in format Color.
Example:
_control ctrlSetTextColor [1, 0, 0, 1]
Category: OFP PC
Operand types:
display:
Control
text:
String
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Sets tooltip text of given control.
Example:
_control ctrlSetTooltip "tooltip"
Category: OFP PC
Operand types:
display:
Control
color:
Array
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Sets tooltip border color of given control. Color is in format Color.
Example:
_control ctrlSetTooltipColorBox [1, 0, 0, 1]
Category: OFP PC
Operand types:
display:
Control
color:
Array
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Sets tooltip background color of given control. Color is in format Color.
Example:
_control ctrlSetTooltipColorShade [1, 0, 0, 1]
Category: OFP PC
Operand types:
display:
Control
color:
Array
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Sets tooltip text color of given control. Color is in format Color.
Example:
_control ctrlSetTooltipColorText [1, 0, 0, 1]
Category: OFP PC
Operand types:
[idc, show]:
Array
Compatibility:
Version 1.50 required.
Type of returned value:
Nothing
Description:
Shows / hides the control with id idc of the topmost user dialog.
Example:
ctrlShow [100, true]
Category: Resistance
Operand types:
control:
Control
show:
Boolean
Compatibility:
Version 2.50 required.
Type of returned value:
Nothing
Description:
Show / hide given control.
Example:
_control ctrlShow false
Category: OFP PC
Operand types:
control:
Control
Compatibility:
Version 2.50 required.
Type of returned value:
Boolean
Description:
Returns whether given control is shown.
Example:
_ok = ctrlShown _control
Category: OFP PC
Operand types:
control:
Control
Compatibility:
Version 2.50 required.
Type of returned value:
String
Description:
Returns the text shown in given control.
Example:
_text = ctrlText _control
Category: OFP PC
Operand types:
idc:
Number
Compatibility:
Version 1.50 required.
Type of returned value:
String
Description:
Returns the text shown in the control with id idc of the topmost user dialog. This can be used for static texts, buttons, edit lines and active texts.
Example:
_message = ctrlText 100
Category: Resistance
Operand types:
control:
Control
Compatibility:
Version 2.56 required.
Type of returned value:
Number
Description:
Returns value representing type of control.
Example:
_type = ctrlType _control
Category: OFP PC
Operand types:
idc:
Number
Compatibility:
Version 1.50 required.
Type of returned value:
Boolean
Description:
Returns whether the control with id idc of the topmost user dialog is visible.
Example:
_visible = ctrlVisible 100
Category: Resistance
Operand types:
vehicle:
Object
Compatibility:
Version 2.92 required.
Type of returned value:
String
Description:
Return the current command type (empty string when no command).
Category: OFP
Operand types:
vehicle:
Object
Compatibility:
Version 5500 required.
Type of returned value:
String
Description:
Return the name of the type of the currently using magazine (on the primary turret for vehicles).
Category: OFP
Operand types:
person:
Object
Compatibility:
Version 5501 required.
Type of returned value:
Task
Description:
Return current task of given person.
Category: Identity
Operand types:
teamMember:
Compatibility:
Version 2.91 required.
Type of returned value:
Array
Description:
List all uncompleted tasks.
Category: Identity
Operand types:
group:
Group
Compatibility:
Version 5500 required.
Type of returned value:
Number
Description:
Return the index of the current waypoint.
Category: OFP
Operand types:
vehicle:
Object
Compatibility:
Version 5500 required.
Type of returned value:
String
Description:
Return the name of the currently selected weapon (on the primary turret for vehicles).
Category: OFP
Compatibility:
Version 5500 required.
Type of returned value:
Object
Description:
This is the entity pointed to by a players cursor.
Example:
alive cursorTarget
Category: OFP
Operand types:
layer:
Number
duration:
Number
Compatibility:
Version 5126 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.
Example:
0 cutFadeIn 1.0
Category: OFP
Operand types:
effect:
Array
Type of returned value:
Nothing
Description:
Object background - the argument uses format ["name","type",speed] or ["name","type"]. If speed is not given, it's assumed to be one.
The object can be defined in the description.ext file.
Example:
cutObj ["TVSet", "plain"]
Category: OFP
Operand types:
layer:
Number
effect:
Array
Compatibility:
Version 5126 required.
Type of returned value:
Nothing
Description:
Object 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 object can be defined in the description.ext file.
Example:
0 cutObj ["TVSet", "plain"]
Category: OFP
Operand types:
effect:
Array
Type of returned value:
Nothing
Description:
Resource background - the argument uses format ["name","type",speed] or ["name","type"]. If speed is not given, it's assumed to be one.
The resource can be defined in the description.ext file.
Example:
cutRsc ["binocular", "PLAIN"]
Category: OFP
Operand types:
layer:
Number
effect:
Array
Compatibility:
Version 5126 required.
Type of returned value:
Nothing
Description:
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
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
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
Operand types:
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
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
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
Type of returned value:
Number
Description:
Returns the time in the world, in hours.
Category: OFP
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
Operand types:
a:
Code
Type of returned value:
Nothing
Description:
see switch
Category: Default
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
Operand types:
side:
Side
Compatibility:
Version 1.86 required.
Type of returned value:
Nothing
Description:
Destroys the AI center of the given side.
Example:
deleteCenter East
Category: OFP
Operand types:
object:
Object
Compatibility:
Version 2.90 required.
Type of returned value:
Nothing
Description:
Delete a collection.
Category: OFP
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
Operand types:
group:
Group
Type of returned value:
Nothing
Description:
Destroys the given AI group.
Example:
deleteGroup group
Category: OFP
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
Operand types:
location:
Location
Compatibility:
Version 2.90 required.
Type of returned value:
Nothing
Description:
Delete the given location.
Category: Location
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
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
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
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
Operand types:
waypoint:
Array
Compatibility:
Version 1.86 required.
Type of returned value:
Nothing
Description:
Removes the waypoint.
Example:
deleteWaypoint [grp, 2]
Category: OFP
Operand types:
obj:
Object
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Detaches an object.
Example:
detach player
Category: OFP
Compatibility:
Version 5500 required.
Type of returned value:
Number
Description:
Returns average framerate over last 16 frames.
Category: OFP
Compatibility:
Version 5500 required.
Type of returned value:
Number
Description:
Returns minimal framerate. Calculated from the longest frame over last 16 frames.
Category: OFP
Compatibility:
Version 5500 required.
Type of returned value:
Number
Description:
Returns number of frame currently displayed .
Category: OFP
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
Compatibility:
Version 5501 required.
Type of returned value:
Number
Description:
Real time spent from the start of the game.
Category: OFP
Compatibility:
Version 1.78 required.
Type of returned value:
Boolean
Description:
Returns whether a user dialog is present.
Category: Resistance
Operand types:
person:
Object
name:
String
Compatibility:
Version 5501 required.
Type of returned value:
Boolean
Description:
Checks whether given subject is present in the diary of given person.
Category: Identity
Operand types:
flag:
String
Compatibility:
Version 5127 required.
Type of returned value:
Boolean
Description:
Check if given difficulty setting is currently enabled. For possible values of flag, see config class Flags in CfgDificulties.
Category: OFP
Operand types:
object:
Object
Compatibility:
Version 1.50 required.
Type of returned value:
Number
Description:
Returns the object heading in the range of 0 to 360.
Example:
direction player
Category: OFP
Operand types:
location:
Location
Compatibility:
Version 2.90 required.
Type of returned value:
Number
Description:
Return direction (angle) of given location.
Category: Location
Operand types:
unit:
Object
radioName:
String
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Sends the message to the direct channel. The message is defined in the description.ext file or radio protocol.
Example:
soldierOne directSay "messageOne"
Category: OFP
Operand types:
unit:
Object
section:
String
Type of returned value:
Nothing
Description:
Disables parts of the AI behaviour to get more control over a unit. Section is one of "TARGET" (disables watching assigned targets), "AUTOTARGET" (disables independed target assigning and watching of unknown targets) or "MOVE" (disables movement).
Example:
soldierOne disableAI "Move"
Category: OFP
Operand types:
unit:
Object
lock:
Boolean
Type of returned value:
Nothing
Description:
Lock / unlock the unit to using conversation. Implemented by the counter, so lock - unlock need to be matched.
Example:
player disableConversation true
Category: OFP
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Disable saving of script containing this command. After this, script can work with the data types which do not support serialization (UI types).
Category: Default
Operand types:
disable:
Boolean
Type of returned value:
Nothing
Description:
Disables all user input. This is normally used only in cutscenes to disable the player's controls.
Category: OFP
Operand types:
display:
Display
[handler name, function]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Number
Description:
Add an event handler to the given display. Returns id of the handler or -1 when failed.
Example:
_id = _display displayAddEventHandler ["KeyDown", ""]
Category: OFP PC
Operand types:
display:
Display
idc:
Number
Compatibility:
Version 2.50 required.
Type of returned value:
Control
Description:
Return child control with specified idc.
Example:
_control = _display displayCtrl 101
Category: OFP PC
Compatibility:
Version 2.92 required.
Type of returned value:
Display
Description:
A non-existing display. This value is not equal to anything, including itself.
Category: OFP PC
Operand types:
display:
Display
handler name:
String
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Remove all even handlers from the given display.
Example:
_display displayRemoveAllEventHandlers "KeyDown"
Category: OFP PC
Operand types:
display:
Display
[handler name, id]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Remove a given event handler from the given display.
Example:
_display displayRemoveEventHandler ["KeyDown", 0]
Category: OFP PC
Operand types:
display:
Display
[handler name, function]:
Array
Compatibility:
Version 2.54 required.
Type of returned value:
Nothing
Description:
Sets given event handler of given display.
Example:
_control displaySetEventHandler ["KeyDown", ""]
Category: OFP PC
Operand types:
team:
String
Compatibility:
Version 2.05 required.
Type of returned value:
Nothing
Description:
Dissolves the given team. All members become members of the main team. Possible team values are: "RED", "GREEN", "BLUE" or "YELLOW".
Example:
dissolveTeam "RED"
Category: OFP
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.
Example:
player distance leader player
Category: OFP
Operand types:
location1 or pos1:
location2 or pos2:
Compatibility:
Version 5501 required.
Type of returned value:
Number
Description:
Computes the distance between two locations or positions.
Category: Location
Compatibility:
Version 5129 required.
Type of returned value:
Number
Description:
Return the region where the game was sold (based on distribution id).
Category: OFP
Operand types:
with:
With Type
code:
Code
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Execute the code inside the given namespace.
Example:
with missionNamespace do {global=global+1}
Category: Default
Operand types:
forCommand:
for type
code:
Code
Type of returned value:
Any
Description:
End of for command, starts cycle
Example:
for "_x" from 20 to 10 step -2 do {..code..}
Category: Default
Operand types:
while:
While Type
code:
Code
Compatibility:
Version 1.85 required.
Type of returned value:
Nothing
Description:
Repeats the code while the condition is true. Note: the maximum repeat count for the loop is 10000. If the condition is still true after the loop was repeated 10000 times, the loop will be terminated and an error message is shown.
Example:
while "a>b" do {a=a+1}
Category: Default
Operand types:
switch:
Switch Type
block:
Code
Type of returned value:
Any
Description:
Switch form
Example:
switch (_a) do { case 1: {block}; case 2 : {block}; default {block};}
Category: Default
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 target is objNull, the unit is ordered to commence firing on its current target (set using doTarget or commandTarget).
Example:
soldierOne doFire objNull
Category: OFP
Operand types:
unit:
Object or Array
position:
Object
Type of returned value:
Nothing
Description:
Orders a unit to follow the given unit (silently).
Example:
soldierOne doFollow player
Category: OFP
Operand types:
unit(s):
Object or Array
[fsm name, position, target]:
Array
Compatibility:
Version 2.53 required.
Type of returned value:
Nothing
Description:
Orders a unit to process command defined by FSM file (silently).
Example:
soldierOne doFSM ["move.fsm", position player, player]
Category: OFP PC
Operand types:
unit:
Object or Array
Compatibility:
Version 2.28 required.
Type of returned value:
Nothing
Description:
Orders a unit to get out from the vehicle (silently).
Example:
doGetOut unitOne
Category: OFP
Operand types:
unit:
Object or Array
position:
Array
Type of returned value:
Nothing
Description:
Orders the unit to move to the given position (format Position) (silently).
Example:
soldierOne doMove getMarkerPos "MarkerMoveOne"
Category: OFP
Operand types:
unit:
Object or Array
Type of returned value:
Nothing
Description:
Orders the unit to stop (silently).
Note: the stop command is never finished; the unit will never be ready.
Example:
doStop unitOne
Category: OFP
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
Operand types:
unit:
Object or Array
position:
Array
Type of returned value:
Nothing
Description:
Orders the unit to watch the given position (format Position) (silently).
Example:
soldierOne doWatch getMarkerPos "MarkerMoveOne"
Category: OFP
Operand types:
unit:
Object or Array
target:
Object
Type of returned value:
Nothing
Description:
Orders the unit to watch the given target (silently).
Example:
soldierOne doWatch player
Category: OFP
Operand types:
map:
Control
[position1, position2, color]:
Array
Compatibility:
Version 2.35 required.
Type of returned value:
Nothing
Description:
Draw arrow in map.
Category: OFP PC
Operand types:
map:
Control
[center, a, b, angle, color, fill]:
Array
Compatibility:
Version 2.35 required.
Type of returned value:
Nothing
Description:
Draw ellipse in map.
Category: OFP PC
Operand types:
map:
Control
[texture, color, position, width, height, angle, text, shadow]:
Array
Compatibility:
Version 2.35 required.
Type of returned value:
Nothing
Description:
Draw icon in map.
Category: OFP PC
Operand types:
map:
Control
[position1, position2, color]:
Array
Compatibility:
Version 2.35 required.
Type of returned value:
Nothing
Description:
Draw line in map.
Category: OFP PC
Operand types:
map:
Control
[from, to, param type, line type, color]:
Array
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
The editor will draw a line between the two specified editor objects. Line type can be LINE or ARROW.
Category: Editor
Operand types:
map:
Control
location:
Location
Compatibility:
Version 2.90 required.
Type of returned value:
Nothing
Description:
Draw location in the map.
Category: Location PC
Operand types:
map:
Control
[center, a, b, angle, color, fill]:
Array
Compatibility:
Version 2.35 required.
Type of returned value:
Nothing
Description:
Draw rectangle in map.
Category: OFP PC
Operand types:
vehicle:
Object
Type of returned value:
Object
Description:
Returns the driver of the vehicle. If the vehicle is not a vehicle, but a person, the person is returned instead.
Example:
driver vehicle player
Category: OFP
Operand types:
array:
Array
Compatibility:
Version 1.50 required.
Type of returned value:
Nothing
Description:
Drops a particle into the scene. Array is in format ParticleArray.
Category: Resistance
Type of returned value:
Side
Description:
The East side.
Category: OFP
Operand types:
text:
String
Compatibility:
Version 2.00 required.
Type of returned value:
Nothing
Description:
Sends any text into the debugger console or the logfile.
Example:
echo "Text in logfile"
Category: Default
Operand types:
map:
Control
object:
String
Compatibility:
Version 2.92 required.
Type of returned value:
Any
Description:
Show the edit object dialog for the given object.
Category: Editor
Operand types:
map:
Control
[handler name, function]:
Array
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Sets given event handler of given editor.
Example:
_map editorSetEventHandler ["SelectObject", ""]
Category: Editor
Operand types:
vehicle:
Object
Compatibility:
Version 2.92 required.
Type of returned value:
Object
Description:
Returns the effective commander (who really commands) of the vehicle.
Category: OFP
Operand types:
ifCode:
Code
elseCode:
Code
Compatibility:
Version 1.85 required.
Type of returned value:
Array
Description:
Constructs an array that can be processed by then.
Example:
if (a>b) then {c=0} else {c=1}
Category: Default
Operand types:
vehicle:
Object
position:
String
Compatibility:
Version 2.92 required.
Type of returned value:
Number
Description:
Returns the number of available cargo, driver, gunner or commander positions in the vehicle.
Example:
_freePositions = (vehicle player) freePositions "cargo"
Category: OFP
Operand types:
unit:
Object
section:
String
Compatibility:
Version 2.53 required.
Type of returned value:
Nothing
Description:
Enables parts of the AI behaviour. Section is one of "TARGET" (enables watching assigned targets), "AUTOTARGET" (enables independed target assigning and watching of unknown targets) or "MOVE" (enables movement).
Example:
soldierOne enableAI "Move"
Category: OFP
Operand types:
group:
Object or Group
enable:
Boolean
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Set if leader can issue attack commands.
Category: OFP
Type of returned value:
Nothing
Description:
Enables the dialog buttons to be shown during the OnPlayerKilled script.
Category: OFP
Operand types:
enabled:
Boolean
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Enable/disable environmental effects (ambient life + sound).
Example:
enableEnvironment false
Category: OFP
Operand types:
enable:
Boolean
Type of returned value:
Nothing
Description:
Enables radio transmissions to be heard and seen on screen.
Category: OFP
Operand types:
object:
Object
enable:
Boolean
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Enable / disable reload right after magazine is empty.
Example:
_vehicle enableReload false
Category: OFP
Operand types:
enable or [enable, save]:
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Enable / disable saving of the game. When disabled, the autosave is created (if not forbidden by save == false).
Category: OFP
Operand types:
enable:
Boolean
Type of returned value:
Nothing
Description:
Enables radio transmissions to be heard and seen on screen. It does not affect KBTell conversations.
Category: OFP
Operand types:
entity:
Object
enable:
Boolean
Type of returned value:
Nothing
Description:
Enable / disable simulation for given entity.
Category: OFP
Operand types:
enable:
Boolean
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Enable / disable team switch.
Category: OFP
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Finish loading screen displaying (started by startLoadingScreen).
Category: OFP
Operand types:
end type:
String
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Finish the mission. The end type can be "CONTINUE", "KILLED", "LOSER", "END1", "END2", "END3", "END4", "END5", or "END6".
Category: OFP
Operand types:
vehicle:
Object
on:
Boolean
Compatibility:
Version 1.90 required.
Type of returned value:
Nothing
Description:
Switches the vehicle's engine on (true) or off (false).
Example:
vehicle player engineOn false
Category: OFP
Compatibility:
Version 5501 required.
Type of returned value:
Number
Description:
Estimated end of MP game converted to serverTime.
Category: OFP
Operand types:
timeLeft:
Number
Compatibility:
Version 1.34 required.
Type of returned value:
Nothing
Description:
Returns the estimated time left in the game. Using this function the designer can provide a "time left" estimate that is shown in the "Game in progress" screen or in the master browser. For missions with a hard set limit adjusted via Param1, the following example can be used in the init.sqs file.
Example:
estimatedTimeLeft Param1
Category: OFP
Operand types:
map:
Control
[object, argument]:
Array
Compatibility:
Version 2.35 required.
Type of returned value:
Any
Description:
Return object argument in mission editor.
Category: Editor
Operand types:
argument:
Any
script:
String
Type of returned value:
Nothing
Description:
Executes a script. Argument is passed to the script as local variable _this. The script is first searched in the mission folder, then in the campaign scripts subfolder and finally in the global scripts folder.
Example:
[player, jeepOne] exec "getIn.sqs"
Category: OFP
Operand types:
map:
Control
[object, script]:
Array
Compatibility:
Version 2.92 required.
Type of returned value:
Any
Description:
Execute an editor script for the specified object.
Example:
_map execEditorScript ["_team_1", "create"]
Category: Editor
Operand types:
filename:
String
Compatibility:
Version 5500 required.
Type of returned value:
Number
Description:
Execute the scripted FSM. The FSM file is first searched in the mission folder, then in the campaign scripts folder and finally in the global scripts folder. Return the FSM handler or 0 when failed.
Example:
execFSM "test.fsm"
Category: OFP
Operand types:
argument:
Any
filename:
String
Compatibility:
Version 5500 required.
Type of returned value:
Number
Description:
Execute the scripted FSM. Argument is passed to the FSM as local variable _this. The FSM file is first searched in the mission folder, then in the campaign scripts folder and finally in the global scripts folder. Return the FSM handler or 0 when failed.
Example:
player execFSM "test.fsm"
Category: OFP
Operand types:
filename:
String
Compatibility:
Version 2.58 required.
Type of returned value:
Script
Description:
Compile and execute function (sqf). The function is first searched in the mission folder, then in the campaign scripts folder and finally in the global scripts folder.
Example:
execVM "test.sqf"
Category: OFP PC
Operand types:
argument:
Any
filename:
String
Compatibility:
Version 2.60 required.
Type of returned value:
Script
Description:
Compile and execute function (sqf). Argument is passed to the script as local variable _this. The function is first searched in the mission folder, then in the campaign scripts folder and finally in the global scripts folder.
Example:
player execVM "test.sqf"
Category: OFP PC
Type of returned value:
Nothing
Description:
Exits the script.
Category: OFP
Operand types:
if:
If Type
code:
Code
Compatibility:
Version 2 required.
Type of returned value:
Any
Description:
if result of condition is true, evaluates code, and current block with result of code
Example:
if (_x>5) exitWith {echo "_x is too big";_x}
, result is [when _x is greater then 5, outputs message and terminates code in current level with value of _x
Category: Default
Operand types:
x:
Number
Type of returned value:
Number
Description:
The exponential value of x.
Example:
exp 1
, result is 2.7182
Category: Default
Operand types:
person:
Object
Compatibility:
Version 2.92 required.
Type of returned value:
Array
Description:
Return expected destination of unit as a [position, planningMode, forceReplan].
Category: OFP
Operand types:
unit:
Object
Compatibility:
Version 5501 required.
Type of returned value:
String
Description:
Gets unit faction. If faction is not defined, returns empty string.
Category: OFP
Operand types:
time:
Number
volume:
Number
Type of returned value:
Nothing
Description:
Causes a smooth change in the music volume. The change duration is given by time, the target volume by volume. The default music volume is 0.5.
Example:
5 fadeMusic 0
Category: OFP
Operand types:
time:
Number
volume:
Number
Type of returned value:
Nothing
Description:
Causes a smooth change in the radio volume. The change duration is given by time, the target volume by volume. The default radio volume is 1.0.
Example:
5 fadeRadio 0.1
Category: OFP
Operand types:
time:
Number
volume:
Number
Type of returned value:
Nothing
Description:
Causes a smooth change in the master volume. The change duration is given by time, the target volume by volume. The default master volume is 1.0.
Example:
5 fadeSound 0.1
Category: OFP
Operand types:
end type:
String
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Finish the mission. The end type can be "CONTINUE", "KILLED", "LOSER", "END1", "END2", "END3", "END4", "END5", or "END6". Mission saves will not be deleted.
Category: OFP
Type of returned value:
Boolean
Description:
Always false.
Category: Default
Operand types:
person:
Object
Compatibility:
Version 1.75 required.
Type of returned value:
Nothing
Description:
Adds magazines from the campaign pool to the person (depending on the weapons the person has).
Example:
fillWeaponsFromPool victor
Category: Resistance
Operand types:
array:
Array
x:
Any
Compatibility:
Version 2.92 required.
Type of returned value:
Number
Description:
Returns the position of the first array element that matches x, returns -1 if not found.
Example:
[0, 1, 2] find 1
, result is 1
Category: Default
Operand types:
object:
Object
[position, hidePosition, maxDist, minDist, visibilityPosition, ignoreObject]:
Array
Compatibility:
Version 2.92 required.
Type of returned value:
Object
Description:
Returns the object where the object should search for cover. The minDist, visibilityPosition and ignoreObject parameters are optional. visibilityPosition is used to select cover that can see a certain position. ignoreObject is an object that is ignored in visibility check.
Category: OFP
Operand types:
idd:
Number
Compatibility:
Version 2.54 required.
Type of returned value:
Display
Description:
Find display by its IDD.
Example:
_display = findDisplay 1
Category: OFP PC
Operand types:
map:
Control
value:
Any
Compatibility:
Version 2.92 required.
Type of returned value:
String
Description:
Return object that matches the provided reference.
Category: Editor
Operand types:
map:
Control
[type, name1, value1, ...]:
Array
Compatibility:
Version 2.35 required.
Type of returned value:
String
Description:
Return object of given type with given arguments. Use [type, game value] to search by object reference of a specific editor object type.
Category: Editor
Operand types:
center:
Array
[radius, maxDistance] or [radius, maxDistance, vehicleType]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Array
Description:
Search for the position nearest (up to maxDistance) to the center, with the free area (vehicle of the given type can be placed anywhere) of the given radius. When not found, empty array is returned.
Category: OFP
Operand types:
center:
Array
[radius, maxDistance]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Array
Description:
Check if findEmptyPosition can be called without waiting for files.
Category: OFP
Operand types:
object:
Object
position:
Object or Array
Compatibility:
Version 2.92 required.
Type of returned value:
Object
Description:
Find the nearest enemy from the specified position.
Category: OFP
Compatibility:
Version 2.33 required.
Type of returned value:
Nothing
Description:
Finish world initialization before mission is launched.
Category: OFP
Operand types:
x:
Number
Type of returned value:
Boolean
Description:
True, if number is finite (not infinite and valid number)
Example:
finite 10/0
, result is false
Category: Default
Operand types:
unit:
Object
weaponName:
String
Type of returned value:
Nothing
Description:
The unit will fire from the given weapon.
Example:
soldierOne fire "HandGrenade"
Category: OFP
Operand types:
unit:
Object
array:
Array
Type of returned value:
Nothing
Description:
The unit will fire from the given weapon. The array has format [muzzle, mode, magazine] or [muzzle, mode].
Example:
soldierOne fire ["throw","SmokeShell","SmokeShell"]
Category: OFP
Operand types:
unit:
Object
Type of returned value:
Object
Description:
If the unit has a flag, this flag is returned.
If not, objNull is returned.
Example:
flag player
Category: OFP
Operand types:
flag:
Object
Type of returned value:
Object
Description:
When used on a flag, the returned value is the person that has this flag.
When used on anything else, objNull is returned.
Example:
flagowner flagOne
Category: OFP
Operand types:
unit:
Object
Type of returned value:
Boolean
Description:
Checks whether the unit is fleeing. A dead or empty unit returns false.
Example:
fleeing player
Category: OFP
Operand types:
x:
Number
Type of returned value:
Number
Description:
The floor value of x.
Example:
floor 5.25
, result is 5
Category: Default
Operand types:
helicopter:
Object
height:
Number
Type of returned value:
Nothing
Description:
Sets the height level for the helicopter. The accepted range is from 50 to 1000.
Example:
cobraOne flyInHeight 150
Category: OFP
Compatibility:
Version 2.92 required.
Type of returned value:
Number
Description:
Return the current fog.
Category: OFP
Compatibility:
Version 2.92 required.
Type of returned value:
Number
Description:
Return the fog forecast.
Category: OFP
Operand types:
var:
String
Type of returned value:
for type
Description:
Starts for sequence, use in complette form(see example).
Example:
for "_x" from 1 to 10 do {debugLog _x;}
Category: Default
Operand types:
forspec:
Array
Type of returned value:
for type
Description:
creates cycle, using C like style. See example.
Example:
for [{_x=1},{_x<=10},{_x=_x+1}] do {debugLog _x;}
Category: Default
Type of returned value:
Nothing
Description:
Forces the mission to terminate.
Category: OFP
Operand types:
show:
Boolean
Compatibility:
Version 1.27 required.
Type of returned value:
Nothing
Description:
Forces the map to display.
Example:
forceMap true
Category: OFP
Operand types:
object:
Object
speed:
Number
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Force the speed of the given object.
Category: OFP
Operand types:
command:
Code
array:
Array
Type of returned value:
Nothing
Description:
Executes the given command for each element in array.
It's executed as follows:
for each element of array an element is assigned as _x and the command is executed.
Example:
"_x setdammage 1" forEach units group player
Category: Default
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, %2, etc. Each %x is replaced by the corresponding argument. %x may appear in the string in any order.
Example:
format ["%1 - %2 - %1", 1, "text"]
, result is "1 - text - 1"
Category: OFP
Operand types:
grp:
Object or Group
Type of returned value:
String
Description:
Returns the formation of the group ("COLUMN", "STAG COLUMN", "WEDGE", "ECH LEFT", "ECH RIGHT", "VEE" or "LINE").
Example:
formation group player
Category: OFP
Operand types:
person:
Object
Compatibility:
Version 2.92 required.
Type of returned value:
Number
Description:
Return the direction unit watching in formation.
Category: OFP
Operand types:
person:
Object
Compatibility:
Version 2.92 required.
Type of returned value:
Object
Description:
Return leader of the formation.
Category: OFP
Operand types:
person:
Object
Compatibility:
Version 2.92 required.
Type of returned value:
Array
Description:
Return list of units (drivers) in the formation.
Category: OFP
Operand types:
person:
Object
Compatibility:
Version 2.92 required.
Type of returned value:
Array
Description:
Return position of unit in the formation.
Category: OFP
Operand types:
person:
Object
Compatibility:
Version 2.92 required.
Type of returned value:
String
Description:
Return the current task of the unit in the formation.
Category: OFP
Operand types:
[format, arg1, arg2, ...]:
Array
Compatibility:
Version 2.01 required.
Type of returned value:
Structured text
Description:
Creates a structured text by replacing %1, %2, etc. in format by plain or structured texts given as arguments.
Example:
txt = formatText ["Image: %1", image "data\isniper.paa"]
Category: OFP
Operand types:
unit:
Object
Type of returned value:
Object
Description:
Returns the formation leader for the given unit. For dead units objNull is returned. The result is often the same as groupLeader, but not always.
Example:
formLeader player != leader player
Category: OFP
Operand types:
for "_var":
for type
b:
Number
Type of returned value:
for type
Description:
Continue sequence of 'for' command.
Example:
for "_x" from 10 to 20 do {..code..}
Category: Default
Operand types:
vehicle:
Object
Type of returned value:
Number
Description:
Checks how much fuel is left in the gas tank, in the range from 0 to 1.
Example:
fuel vehicle player
Category: OFP
Operand types:
control:
Control
Compatibility:
Version 5501 required.
Type of returned value:
String
Description:
Returns gear slot item name.
Example:
weapon = gearSlotData _control
Category: OFP PC
Operand types:
config:
Config
Compatibility:
Version 2.35 required.
Type of returned value:
Array
Description:
Extract array from config entry.
Example:
_array = getArray (configFile >> "CfgVehicles" >> "Thing" >> "threat")
Category: OFP PC
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
Operand types:
obj:
Object
Type of returned value:
Number
Description:
Returns the object heading in the range from 0 to 360.
Example:
getDir player
Category: OFP
Operand types:
map:
Control
Compatibility:
Version 2.92 required.
Type of returned value:
Object
Description:
Fetches a reference to the mission editor camera.
Category: Editor
Operand types:
map:
Control
Compatibility:
Version 2.92 required.
Type of returned value:
String
Description:
Returns the current mode of the editor.
Category: Editor
Operand types:
map:
Control
object:
String
Compatibility:
Version 2.92 required.
Type of returned value:
String
Description:
Returns the editor object scope of the specified editor object.
Category: Editor
Operand types:
side1:
Side
side2:
Side
Compatibility:
Version 5501 required.
Type of returned value:
Number
Description:
Returns if sides are friendly or hostile. For a value smaller than 0.6 it results in being enemy, otherwise it's friendly.
Example:
value = west getFriend east
Category: OFP
Operand types:
FSM handle:
Number
name:
String
Compatibility:
Version 5501 required.
Type of returned value:
Any
Description:
Return the value of variable in the variable space of given FSM. The FSM handle is the number returned by the execFSM command.
Category: OFP
Operand types:
group:
Group
ID:
Number
Compatibility:
Version 5501 required.
Type of returned value:
Array
Description:
Get group icon properties.
Example:
group getGroupIcon id
Category: OFP
Operand types:
group:
Group
Compatibility:
Version 5501 required.
Type of returned value:
Array
Description:
Returns group icons params. [color, text,scale, visible]
Example:
getGroupIconParams group
Category: OFP
Operand types:
group:
Group
Compatibility:
Version 5501 required.
Type of returned value:
Array
Description:
Returns all group icons.[[id,icon,[offsetx,offsety],[..],..]
Example:
getGroupIcons group
Category: OFP
Operand types:
object:
Object
enemy:
Object
Compatibility:
Version 2.92 required.
Type of returned value:
Array
Description:
Returns the hiding position in format Position. If enemy is null it is the some position in front of the object or enemy position otherwise.
Category: OFP
Operand types:
marker:
String
Compatibility:
Version 1.21 required.
Type of returned value:
String
Description:
Gets the marker color. See setMarkerColor.
Example:
getMarkerColor "MarkerOne"
Category: OFP
Operand types:
markerName:
String
Type of returned value:
Array
Description:
Returns the marker positon in format [x,z,y].
Example:
getMarkerPos "markerOne"
Category: OFP
Operand types:
marker:
String
Compatibility:
Version 1.21 required.
Type of returned value:
Array
Description:
Gets the marker size. See setMarkerSize.
Example:
getMarkerSize "MarkerOne"
Category: OFP
Operand types:
marker:
String
Compatibility:
Version 1.21 required.
Type of returned value:
String
Description:
Gets the type of the marker. See setMarkerType.
Example:
getMarkerType "MarkerOne"
Category: OFP
Operand types:
config:
Config
Compatibility:
Version 2.35 required.
Type of returned value:
Number
Description:
Extract number from config entry.
Example:
_array = getNumber (configFile >> "CfgVehicles" >> "Thing" >> "maxSpeed")
Category: OFP PC
Operand types:
map:
Control
[object, argument]:
Array
Compatibility:
Version 2.35 required.
Type of returned value:
String
Description:
Return name of object argument in mission editor.
Category: Editor
Operand types:
map:
Control
object:
String
Compatibility:
Version 2.92 required.
Type of returned value:
Array
Description:
Return a list of all the children of the specified object.
Category: Editor
Operand types:
map:
Control
object:
String
Compatibility:
Version 2.92 required.
Type of returned value:
Object
Description:
Return the proxy object associated with the given editor object.
Category: Editor
Operand types:
obj:
Object
Type of returned value:
Array
Description:
Returns the object position in format Position.
Example:
getPos player
Category: OFP
Operand types:
location:
Location
Compatibility:
Version 5501 required.
Type of returned value:
Array
Description:
Return (raw) position of given location.
Category: Location
Operand types:
obj:
Object
Compatibility:
Version 2.53 required.
Type of returned value:
Array
Description:
Returns the object position in format PositionASL.
Example:
getPosASL player
Category: OFP
Operand types:
object:
Object
speedMode:
String
Compatibility:
Version 2.92 required.
Type of returned value:
Number
Description:
Get the speed for the given speed mode. SpeedMode can be: "AUTO","SLOW","NORMAL","FAST".
Category: OFP
Operand types:
config:
Config
Compatibility:
Version 2.35 required.
Type of returned value:
String
Description:
Extract text from config entry.
Example:
_array = getText (configFile >> "CfgVehicles" >> "Thing" >> "icon")
Category: OFP PC
Operand types:
namespace:
Namespace
name:
String
Compatibility:
Version 5501 required.
Type of returned value:
Any
Description:
Return the value of variable in the given namespace.
Category: Default
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.
Category: OFP
Operand types:
location:
Location
name:
String
Compatibility:
Version 2.92 required.
Type of returned value:
Any
Description:
Return the value of variable in the variable space of given location.
Category: Location
Operand types:
object:
Object
name:
String
Compatibility:
Version 2.92 required.
Type of returned value:
Any
Description:
Return the value of variable in the variable space of given object.
Category: OFP
Operand types:
map:
Control
name:
String
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Get variable from the variable space of given map.
Category: Editor
Operand types:
task:
Task
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.
Category: Identity
Operand types:
waypoint:
Array
Compatibility:
Version 1.21 required.
Type of returned value:
Array
Description:
Gets the waypoint position. The format of waypoint is Waypoint.
Example:
getWPPos [groupOne, 1]
Category: OFP
Operand types:
unit(s):
Object or Array
position:
Object or Array
Compatibility:
Version 2.40 required.
Type of returned value:
Nothing
Description:
Control what the unit is glancing at (target or position) (format Position)
Example:
someSoldier glanceAt otherSoldier; otherSoldier glanceAt getMarkerPos "markerOne"
Category: OFP
Operand types:
unit:
Object
chatText:
String
Type of returned value:
Nothing
Description:
Types text to the global 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 globalChat "Show this text"
Category: OFP
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.ext file or radio protocol.
Example:
soldierOne globalRadio "messageOne"
Category: OFP
Operand types:
label:
String
Type of returned value:
Nothing
Description:
Only in scripts: go to given label. Note: the string argument is used here. Be sure to use double quotes around the label name in goto.
Example:
goto "Loop"
Category: OFP
Operand types:
obj:
Object
Type of returned value:
Group
Description:
Returns the group to which the given unit is assigned. For dead units, grpNull is returned.
Example:
group player == group leader player
Category: OFP
Operand types:
unit:
Object
chatText:
String
Type of returned value:
Nothing
Description:
Types text to the group 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 groupChat "Show this text"
Category: OFP
Compatibility:
Version 5501 required.
Type of returned value:
Boolean
Description:
Return if groups icon raises onClick and onOver events.
Category: OFP
Compatibility:
Version 5501 required.
Type of returned value:
Array
Description:
Return group icons are visible.
Category: OFP
Operand types:
unit:
Object
radioName:
String
Type of returned value:
Nothing
Description:
Sends the message to the group radio channel. The message is defined in the description.ext file or radio protocol.
Example:
soldierOne groupRadio "messageOne"
Category: OFP
Operand types:
unit:
Object
Compatibility:
Version 5501 required.
Type of returned value:
Array
Description:
Returns selected groups in sgroup.
Example:
array = groupSelectedUnits unit
Category: OFP
Operand types:
unit:
Object
[unit,bool]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Select unit from unit's group.
Example:
player groupSelectUnit [unit,true]
Category: OFP
Type of returned value:
Group
Description:
A non-existing group. This value is not equal to anything, including itself.
Example:
group player == objNull
, result is false
Category: OFP
Operand types:
vehicle:
Object
Type of returned value:
Object
Description:
Returns the gunner of the vehicle. If the vehicle is not a vehicle, but a person, the person is returned.
Example:
gunner vehicle player
Category: OFP
Compatibility:
Version 2.00 required.
Type of returned value:
Nothing
Description:
Stops the program into a debugger.
Example:
halt
Category: Default
Operand types:
soldier:
Object
Type of returned value:
Number
Description:
Checks whether the soldier's hands are hit (causing inaccurate aiming).
Example:
handsHit leader player
Category: OFP
Operand types:
unit:
Object
weaponName:
String
Type of returned value:
Boolean
Description:
Checks whether the unit has the given weapon.
Example:
player hasWeapon "M16"
Category: OFP
Operand types:
unit:
Object
Compatibility:
Version 5501 required.
Type of returned value:
Array
Description:
Returns selected groups in high command.
Example:
array = hcAllGroups unit
Category: OFP
Operand types:
unit:
Object
group:
Group
Compatibility:
Version 5501 required.
Type of returned value:
Array
Description:
Returns parameters describing group in high command bar. Return value is [string,float[4]]
Example:
unit hcGroupParams group
Category: OFP
Operand types:
group:
Group
Compatibility:
Version 5501 required.
Type of returned value:
Object
Description:
Returns group's HC commander.
Example:
hcLeader group
Category: OFP
Operand types:
unit:
Object
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Remove all groups from unit's high command bar.
Example:
hcRemoveAllGroups unit
Category: OFP
Operand types:
unit:
Object
group:
Group
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Removes group from unit's high command bar.
Example:
unit HCRemoveGroup group
Category: OFP
Operand types:
unit:
Object
Compatibility:
Version 5501 required.
Type of returned value:
Array
Description:
Returns selected groups in high command.
Example:
array = hcSelected unit
Category: OFP
Operand types:
unit:
Object
array:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Select given group in HC bar.
Example:
unit hcSelectGroup [group,true]
Category: OFP
Operand types:
unit:
Object
array:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Add group to unit's high command bar. Array parameters are group, group name and team (teammain, teamred, teamgreen, teamblue, teamyellow) . Group is the only necessary parameter.
Example:
unit hcSetGroup [group,"HQ","teamred"]
or
player hcSetGroup [group]
Category: OFP
Operand types:
bool:
Boolean
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Shows or hides HC bar. There must be some groups under hc command to show hc bar.
Example:
hcShowBar true
Category: OFP
Compatibility:
Version 5501 required.
Type of returned value:
Boolean
Description:
Return a list of all groups.
Category: OFP
Operand types:
person:
Object
Compatibility:
Version 2.10 required.
Type of returned value:
Nothing
Description:
Hides the body of the given person.
Example:
hideBody player
Category: OFP
Operand types:
text:
Text or String
Type of returned value:
Nothing
Description:
Shows a text hint. The text can contain several lines. \n is used to indicate the end of a line.
Example:
hint "Press W to move forward"
Category: OFP
Operand types:
text:
String
Type of returned value:
Nothing
Description:
Shows a text hint. The text can contain several lines. \n is used to indicate the end of a line. This hint has to be confirmed.
Example:
hintC "Press W to move forward"
Category: OFP
Operand types:
title:
String
text:
Structured text
Compatibility:
Version 2.01 required.
Type of returned value:
Nothing
Description:
Creates a hint dialog with the given title and text.
Category: OFP
Operand types:
title:
String
text:
String
Compatibility:
Version 2.01 required.
Type of returned value:
Nothing
Description:
Creates a hint dialog with the given title and text.
Category: OFP
Operand types:
title:
String
[text1, text2, ...]:
Array
Compatibility:
Version 2.01 required.
Type of returned value:
Nothing
Description:
Creates a hint dialog with the given title and text. Texts can be plain or structured.
Category: OFP
Operand types:
text:
Text or String
Type of returned value:
Nothing
Description:
Shows a text hint only when using cadet mode. The text can contain several lines. \n is used to indicate the end of a line.
Example:
hintCadet "Press W to move forward"
Category: OFP
Operand types:
text:
Text or String
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Same as hint, but without a sound.
Category: OFP
Operand types:
control:
Control
filename:
String
Compatibility:
Version 2.53 required.
Type of returned value:
Nothing
Description:
Load HTML from file to given control.
Example:
_control htmlLoad "briefing.html"
Category: OFP PC
Operand types:
condition:
Boolean
Compatibility:
Version 1.85 required.
Type of returned value:
If Type
Description:
The first part of the if command.
Example:
if (a>b) then {a=b}
Category: Default
Operand types:
filename:
String
Compatibility:
Version 2.01 required.
Type of returned value:
Structured text
Description:
Creates a structured text containing the given image.
Example:
txt1 = image "data\isniper.paa"
Category: OFP
Operand types:
map:
Control
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Imports all groups into the RTE.
Category: Editor
Operand types:
location:
Location
Compatibility:
Version 2.90 required.
Type of returned value:
Number
Description:
Return importance of given location.
Category: Location
Operand types:
x:
Any
array:
Array
Type of returned value:
Boolean
Description:
Checks whether x is equal to any element in the array.
Example:
1 in [0, 1, 2]
, result is true
Category: Default
Operand types:
position:
Array
location:
Location
Compatibility:
Version 2.92 required.
Type of returned value:
Boolean
Description:
Check if the position is inside area defined by the location.
Category: Location
Operand types:
soldier:
Object
vehicle:
Object
Type of returned value:
Boolean
Description:
Checks whether the soldier is mounted in the vehicle.
Example:
player in jeepOne
Category: OFP
Operand types:
fireplace:
Object
burn:
Boolean
Type of returned value:
Nothing
Description:
Controls fireplace buring. Set to true to inflame the fireplace.
Example:
fireplaceOne inflame true
Category: OFP
Operand types:
fireplace:
Object
Compatibility:
Version 1.04 required.
Type of returned value:
Boolean
Description:
Check if fireplace is inflamed (buring).
Example:
inflamed fireplaceOne
Category: OFP
Operand types:
[handler name, function]:
Array
Compatibility:
Version 2.91 required.
Type of returned value:
Nothing
Description:
Sets given event handler of in-game UI.
Category: OFP
Operand types:
config:
Config
Compatibility:
Version 2.92 required.
Type of returned value:
Config
Description:
Returns base entry of config entry.
Example:
_base = inheritsFrom (configFile >> "CfgVehicles" >> "Car")
Category: OFP PC
Compatibility:
Version 2.90 required.
Type of returned value:
Nothing
Description:
Initialize the ambient life.
Category: OFP
Operand types:
name:
String
Compatibility:
Version 5500 required.
Type of returned value:
Number
Description:
Return the state of input devices mapped to given input action (see CfgDefaultKeysMapping for action names).
Category: OFP
Operand types:
map:
Control
[type, value, [name1, value1, ...], subtype class]:
Array
Compatibility:
Version 2.92 required.
Type of returned value:
String
Description:
Insert an object to the editor and assign arguments. Create script is not called. Returns the ID of the new EditorObject. Subtype class is optional.
Category: Editor
Operand types:
[object, lod name]:
Array
[begin, end]:
Array
Compatibility:
Version 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.
Example:
[tank, "VIEW" intersect [[1500, 1500, 2], [1550, 1500, 2]]
Category: OFP
Operand types:
config:
Config
Compatibility:
Version 2.35 required.
Type of returned value:
Boolean
Description:
Check if config entry represents array.
Example:
_ok = isArray (configFile >> "CfgVehicles")
, result is false
Category: OFP PC
Operand types:
config:
Config
Compatibility:
Version 2.35 required.
Type of returned value:
Boolean
Description:
Check if config entry represents config class.
Example:
_ok = isClass (configFile >> "CfgVehicles")
, result is true
Category: OFP PC
Compatibility:
Version 5501 required.
Type of returned value:
Boolean
Description:
Return true for dedicated server.
Category: OFP
Operand types:
vehicle:
Object
Compatibility:
Version 1.90 required.
Type of returned value:
Boolean
Description:
Checks whether the engine is on.
Example:
on = isEngineOn vehicle player
Category: OFP
Operand types:
position:
Array
[float minDistance,float precizePos,float maxGradient,float gradientRadius,float onWater,bool onShore,object skipobj]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Array
Description:
Chek if given area is flat and emty.
Example:
newposition = position isFlatEmpty(10, 0, 0.5, 5, 0, false, player)
Category: OFP
Operand types:
person:
Object
Compatibility:
Version 2.92 required.
Type of returned value:
Boolean
Description:
Returns true if the specified person is subgroup leader.
Category: OFP
Operand types:
person:
Object
Compatibility:
Version 2.92 required.
Type of returned value:
Boolean
Description:
Return whether the person is hidden (reached the hiding position).
Category: OFP
Operand types:
keyName:
String
Compatibility:
Version 2.06 required.
Type of returned value:
Boolean
Description:
Checks whether the given key is active in the current user profile.
Example:
ok = isKeyActive "M04"
Category: OFP
Operand types:
object:
Object
typeName:
String
Compatibility:
Version 2.30 required.
Type of returned value:
Boolean
Description:
Checks whether the object is of the given type.
Example:
vehicle player isKindOf "Tank"
Category: OFP
Operand types:
typeName1:
String
typeName2:
String
Compatibility:
Version 5160 required.
Type of returned value:
Boolean
Description:
Checks whether the type typeName1 is inherited from the type typeName1.
Example:
"Tank" isKindOf "Land"
, result is true
Category: OFP
Operand types:
object:
Object
Compatibility:
Version 2.13 required.
Type of returned value:
Boolean
Description:
Checks whether the object is marked for weapons collection.
Example:
marked = isMarkedForCollection truck
Category: OFP
Compatibility:
Version 5501 required.
Type of returned value:
Boolean
Description:
Return true if multiPlayer.
Category: OFP
Operand types:
variable:
Compatibility:
Version 2.00 required.
Type of returned value:
Boolean
Description:
Tests whether the variable is null. The function returns true if the variable is null and false if it's not.
Example:
if (isNil("_pokus")) then {_pokus=0;}
Category: Default
Operand types:
location:
Location
Compatibility:
Version 5501 required.
Type of returned value:
Boolean
Description:
Check whether the value is null.
Category: Location
Operand types:
control:
Control
Compatibility:
Version 2.92 required.
Type of returned value:
Boolean
Description:
Checks whether the value is equal to controlNull.
Note: a==controlNull does not work, because controlNull is not equal to anything, even to itself.
Example:
isNull controlNull
, result is true
Category: OFP PC
Operand types:
grp:
Group
Type of returned value:
Boolean
Description:
Checks whether the value is equal to grpNull.
Note: a==GrpNull does not work, because grpNull is not equal to anything, even to itself.
Example:
isNull group player
, result is false
Category: OFP
Operand types:
task:
Task
Compatibility:
Version 5160 required.
Type of returned value:
Boolean
Description:
Checks whether the value is equal to taskNull.
Note: a==TaskNull does not work, because taskNull is not equal to anything, even to itself.
Example:
isNull taskNull
, result is true
Category: Identity
Operand types:
display:
Display
Compatibility:
Version 2.92 required.
Type of returned value:
Boolean
Description:
Checks whether the value is equal to displayNull.
Note: a==displayNull does not work, because displayNull is not equal to anything, even to itself.
Example:
isNull displayNull
, result is true
Category: OFP PC
Operand types:
obj:
Object
Type of returned value:
Boolean
Description:
Checks whether the value is equal to objNull.
Note: a==ObjNull does not work, because objNull is not equal to anything, even to itself.
Example:
isNull objNull
, result is true
Category: OFP
Operand types:
config:
Config
Compatibility:
Version 2.35 required.
Type of returned value:
Boolean
Description:
Check if config entry represents number.
Example:
_ok = isNumber (configFile >> "CfgVehicles")
, result is false
Category: OFP PC
Operand types:
position or object:
Object or Array
Compatibility:
Version 5501 required.
Type of returned value:
Boolean
Description:
Check whether given position is on road.
Category: OFP
Operand types:
person:
Object
Compatibility:
Version 2.92 required.
Type of returned value:
Boolean
Description:
Check if given person is the player.
Category: OFP
Operand types:
map:
Control
Compatibility:
Version 2.92 required.
Type of returned value:
Boolean
Description:
Returns true if the mission editor is operating in real time mode.
Example:
_isRealTime = isRealTime _map
Category: Editor
Compatibility:
Version 2.92 required.
Type of returned value:
Boolean
Description:
Returns true if the computer is the server.
Category: OFP
Operand types:
map:
Control
Compatibility:
Version 2.92 required.
Type of returned value:
Boolean
Description:
Returns true if the editor is set to draw 3D icons.
Category: Editor
Operand types:
config:
Config
Compatibility:
Version 2.35 required.
Type of returned value:
Boolean
Description:
Check if config entry represents text.
Example:
_ok = isText (configFile >> "CfgVehicles")
, result is false
Category: OFP PC
Operand types:
unit:
Object
Compatibility:
Version 5501 required.
Type of returned value:
Array
Description:
Returns an array of names of all special items of the vehicle.
Example:
items player
Category: OFP
Operand types:
unitArray:
Array
group:
Object or Group
Type of returned value:
Nothing
Description:
Joins all units in the array to the given group.
Note: the total number of group members cannot exceed 12.
Note: This function is unsupported in MP in version 1.33 and before.
Example:
[unitOne, unitTwo] join player
Category: OFP
Operand types:
unit:
Object
[group, id]:
Array
Type of returned value:
Nothing
Description:
Joins the unit to the given group, if position id is available, this one is used.
Example:
player joinAs [_group, 4]
Category: OFP
Operand types:
unit:
Object
[group, id]:
Array
Type of returned value:
Nothing
Description:
Joins the unit to the given group, if position id is available, this one is used. Avoid any radio communication related to joining.
Example:
player joinAsSilent [_group, 4]
Category: OFP
Operand types:
unitArray:
Array
group:
Object or Group
Type of returned value:
Nothing
Description:
Joins all units in the array to the given group. Avoid any radio communication related to joining.
Example:
[unitOne, unitTwo] joinSilent player
Category: OFP
Operand types:
person:
Object
filename:
String
Compatibility:
Version 2.42 required.
Type of returned value:
Boolean
Description:
Register knowledge base database to given person.
Example:
_unit kbAddDatabase "chat.txt"
Category: OFP PC
Operand types:
person:
Object
filename:
String
Compatibility:
Version 2.45 required.
Type of returned value:
Boolean
Description:
Register target list knowledge base database to given person.
Example:
_unit kbAddDatabase "chat.txt"
Category: OFP PC
Operand types:
person:
Object
[name, filename(, task type(, player event handler))]:
Array
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Register conversation topic to given person.
Category: OFP PC
Operand types:
person:
Object
name:
String
Compatibility:
Version 2.92 required.
Type of returned value:
Boolean
Description:
Check if conversation topic was registered to given person.
Category: OFP PC
Operand types:
person:
Object
[receiver, topic, sentence id, [argument name, argument value, argument text, argument speech], ...]:
Array
Compatibility:
Version 5500 required.
Type of returned value:
Nothing
Description:
Pass a non-verbal communication to the receiver.
Category: OFP PC
Operand types:
person:
Object
name:
String
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Unregister conversation topic from given person.
Category: OFP PC
Operand types:
person:
Object
[receiver, topic, sentence id, [argument name, argument value, argument text, argument speech], ...]:
Array
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Make the person tell to the receiver the sentence.
Category: OFP PC
Operand types:
person:
Object
[receiver, topic, sentence id, max. age]:
Array
Compatibility:
Version 5500 required.
Type of returned value:
Boolean
Description:
Check if given item was said by person to someone.
Category: OFP PC
Operand types:
dikCode:
Number
Compatibility:
Version 2.01 required.
Type of returned value:
Structured text
Description:
Returns a structured text, containing an image or name (if no image is found) of the button (on the keyboard, mouse or joystick) with the given code.
Example:
name = keyImage 28
, result is "Enter"
Category: OFP
Operand types:
dikCode:
Number
Compatibility:
Version 2.01 required.
Type of returned value:
String
Description:
Returns the name of a button (on the keyboard, mouse or joystick) with the given code.
Example:
name = keyName 28
, result is "Enter"
Category: OFP
Operand types:
unit:
Object or Group
target:
Object
Type of returned value:
Number
Description:
Checks whether the unit knows about the target (and how much). If the unit is a vehicle, the vehicle commander is considered instead.
Example:
soldierOne knowsAbout jeepOne
Category: OFP
Operand types:
side:
Side
target:
Object
Compatibility:
Version 5501 required.
Type of returned value:
Number
Description:
Checks whether the side knows about the target (and how much).
Example:
east knowsAbout jeepOne
Category: OFP
Operand types:
helicopter:
Object
mode:
String
Type of returned value:
Nothing
Description:
Forces a helicopter landing. The landing mode may be "LAND" (a complete stop), "GET IN" (hovering very low for another unit to get in), "GET OUT" (hovering low for another unit to get out) or "NONE" (cancel landing).
Example:
cobraOne land "LAND"
Category: OFP
Operand types:
airplane:
Object
airportId:
Number
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Order AI airplane to land at given airport
Example:
plane landAt 0
Category: OFP
Operand types:
helicopter:
Object
Compatibility:
Version 5501 required.
Type of returned value:
String
Description:
Return the result of helicopter landing position searching (performed after land command). The value can be "Found" (position found), "NotFound" (position not found), "NotReady" (position searching is still in progress) or empty string when wrong argument given.
Category: OFP
Operand types:
[idc, text]:
Array
Compatibility:
Version 1.50 required.
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. It returns the index of the newly added item.
Example:
_index = lbAdd [101, "First item"]
Category: Resistance
Operand types:
control:
Control
text:
String
Compatibility:
Version 2.91 required.
Type of returned value:
Number
Description:
Adds an item with the given text to the given listbox or combobox. It returns the index of the newly added item.
Example:
_index = _control lbAdd "First item"
Category: OFP PC
Operand types:
idc:
Number
Compatibility:
Version 1.50 required.
Type of returned value:
Nothing
Description:
Clears all items in the listbox or combobox with id idc of the topmost user dialog.
Example:
lbClear 101
Category: Resistance
Operand types:
control:
Control
Compatibility:
Version 2.91 required.
Type of returned value:
Nothing
Description:
Clears all items in the given listbox or combobox.
Example:
lbClear _control
Category: OFP PC
Operand types:
[idc, index]:
Array
Compatibility:
Version 1.50 required.
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. The color is returned in format Color.
Example:
_color = lbColor [101, 0]
Category: Resistance
Operand types:
control:
Control
index:
Number
Compatibility:
Version 2.91 required.
Type of returned value:
Array
Description:
Returns the text color of the item with the given index of the given listbox or combobox.
Example:
_color = _control lbColor 0
Category: OFP PC
Operand types:
idc:
Number
Compatibility:
Version 1.50 required.
Type of returned value:
Number
Description:
Returns the index of the selected item of the listbox or combobox with id idc of the topmost user dialog.
Example:
_index = lbCurSel 101
Category: Resistance
Operand types:
control:
Control
Compatibility:
Version 2.91 required.
Type of returned value:
Number
Description:
Returns the index of the selected item of the given listbox or combobox.
Example:
_index = lbCurSel _control
Category: OFP PC
Operand types:
[idc, index]:
Array
Compatibility:
Version 1.50 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.
Example:
_data = lbData [101, 0]
Category: Resistance
Operand types:
control:
Control
index:
Number
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 given listbox or combobox.
Example:
_data = _control lbData 0
Category: OFP PC
Operand types:
[idc, index]:
Array
Compatibility:
Version 1.50 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.
Example:
lbDelete [101, 0]
Category: Resistance
Operand types:
control:
Control
index:
Number
Compatibility:
Version 2.91 required.
Type of returned value:
Nothing
Description:
Removes the item with the given index from the given listbox or combobox.
Example:
_control lbDelete 0
Category: OFP PC
Operand types:
control:
Control
index:
Number
Compatibility:
Version 2.92 required.
Type of returned value:
Boolean
Description:
Check whether given row of the given listbox is selected.
Example:
_selected = _control lbIsSelected 0
Category: OFP PC
Operand types:
[idc, index]:
Array
Compatibility:
Version 1.50 required.
Type of returned value:
String
Description:
Returns the picture name of the item with the given index of the listbox or combobox with id idc of the topmost user dialog.
Example:
_picture = lbPicture [101, 0]
Category: Resistance
Operand types:
control:
Control
index:
Number
Compatibility:
Version 2.91 required.
Type of returned value:
String
Description:
Returns the picture name of the item with the given index of the given listbox or combobox.
Example:
_picture = _control lbPicture 0
Category: OFP PC
Operand types:
control:
Control
Compatibility:
Version 2.92 required.
Type of returned value:
Array
Description:
Returns the array of selected rows indices in the given listbox.
Example:
_indices = lbSelection _control
Category: OFP PC
Operand types:
[idc, index, color]:
Array
Compatibility:
Version 1.50 required.
Type of returned value:
Nothing
Description:
Sets the color of the item with the given index of the listbox or combobox with id idc of the topmost user dialog to the given color. Color is in format Color.
Example:
lbSetColor [101, 0, [0, 1, 0, 0.5]]
Category: Resistance
Operand types:
control:
Control
[index, color]:
Array
Compatibility:
Version 2.91 required.
Type of returned value:
Nothing
Description:
Sets the text color of the item with the given index of the given listbox or combobox. Color is in format Color.
Example:
_control lbSetColor [0, [0, 1, 0, 0.5]]
Category: OFP PC
Operand types:
[idc, index]:
Array
Compatibility:
Version 1.50 required.
Type of returned value:
Nothing
Description:
Selects the item with the given index of the listbox or combobox with id idc of the topmost user dialog.
Example:
lbSetCurSel [101, 0]
Category: Resistance
Operand types:
control:
Control
index:
Number
Compatibility:
Version 2.91 required.
Type of returned value:
Nothing
Description:
Selects the item with the given index of the given listbox or combobox.
Example:
_control lbSetCurSel 0
Category: OFP PC
Operand types:
[idc, index, data]:
Array
Compatibility:
Version 1.50 required.
Type of returned value:
Nothing
Description:
Sets the additional text (invisible) in the item with the given index of the listbox or combobox with id idc of the topmost user dialog to the given data.
Example:
lbSetData [101, 1, "#1"]
Category: Resistance
Operand types:
control:
Control
[index, data]:
Array
Compatibility:
Version 2.91 required.
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.
Example:
_control lbSetData [1, "#1"]
Category: OFP PC
Operand types:
[idc, index, name]:
Array
Compatibility:
Version 1.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. Name is the picture name. The picture is searched in the mission directory, the dtaExt subdirectory of the campaign directory and the dtaExt directory and the data bank (or directory).
Example:
lbSetPicture [101, 0, "iskoda"]
Category: Resistance
Operand types:
control:
Control
[index, name]:
Array
Compatibility:
Version 2.91 required.
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. The picture is searched in the mission directory, the dtaExt subdirectory of the campaign directory and the dtaExt directory and the data bank (or directory).
Example:
_control lbSetPicture [0, "iskoda"]
Category: OFP PC
Operand types:
control:
Control
[index, selected]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Set the selection state of the given row of the given listbox. Listbox must support multiple selection
Example:
_control lbSetSelection [0, true]
Category: OFP PC
Operand types:
[idc, index, value]:
Array
Compatibility:
Version 1.50 required.
Type of returned value:
Nothing
Description:
Sets the additional integer value in the item with the given index of the listbox or combobox with id idc of the topmost user dialog to the given value.
Example:
lbSetValue [101, 0, 1]
Category: Resistance
Operand types:
control:
Control
[index, value]:
Array
Compatibility:
Version 2.91 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:
_control lbSetValue [0, 1]
Category: OFP PC
Operand types:
control:
Control
Compatibility:
Version 2.91 required.
Type of returned value:
Number
Description:
Returns the number of items in the given listbox or combobox.
Example:
_n = lbSize _control
Category: OFP PC
Operand types:
idc:
Number
Compatibility:
Version 1.50 required.
Type of returned value:
Number
Description:
Returns the number of items in the listbox or combobox with id idc of the topmost user dialog.
Example:
_n = lbSize 101
Category: Resistance
Operand types:
control:
Control
Compatibility:
Version 5148 required.
Type of returned value:
Number
Description:
Sorts the given listbox or combobox by item text.
Example:
lbSort _control
Category: OFP PC
Operand types:
control:
Control
Compatibility:
Version 5148 required.
Type of returned value:
Number
Description:
Sorts the given listbox or combobox by item value.
Example:
lbSortByValue _control
Category: OFP PC
Operand types:
[idc, index]:
Array
Compatibility:
Version 1.50 required.
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.
Example:
_text = lbText [101, 0]
Category: Resistance
Operand types:
control:
Control
index:
Number
Compatibility:
Version 2.91 required.
Type of returned value:
String
Description:
Returns the shown text in the item with the given index of the given listbox or combobox.
Example:
_text = _control lbText 0
Category: OFP PC
Operand types:
[idc, index]:
Array
Compatibility:
Version 1.50 required.
Type of returned value:
Number
Description:
Returns the additional integer value in the item with the given index of the listbox or combobox with id idc of the topmost user dialog.
Example:
_value = lbValue [101, 0]
Category: Resistance
Operand types:
control:
Control
index:
Number
Compatibility:
Version 2.91 required.
Type of returned value:
Number
Description:
Returns the additional integer value in the item with the given index of the given listbox or combobox.
Example:
_value = _control lbValue 0
Category: OFP PC
Operand types:
unit:
Object
Type of returned value:
Object
Description:
Returns the group leader for the given unit. For dead units, objNull is returned.
Example:
leader player
Category: OFP
Operand types:
grp:
Group
Type of returned value:
Object
Description:
Returns the group leader for the given group. For a dead unit, grpNull is returned.
Example:
leader group player == leader player
Category: OFP
Operand types:
group:
Object
vehicle:
Object
Type of returned value:
Nothing
Description:
Ceases the using of the vehicle in the group. It unassigns all grouped units from the vehicle.
Example:
soldierOne leaveVehicle jeepOne
Category: OFP
Operand types:
group:
Group
vehicle:
Object
Type of returned value:
Nothing
Description:
Ceases the using of the vehicle in the group. It unassigns all grouped units from the vehicle.
Example:
groupOne leaveVehicle jeepOne
Category: OFP
Operand types:
unit:
Object
Compatibility:
Version 5501 required.
Type of returned value:
String
Description:
Returns the life state of the given unit.
Category: OFP
Operand types:
light:
Object
[object, position]:
Array
Compatibility:
Version 2.58 required.
Type of returned value:
Nothing
Description:
Attach light to given object (at given position).
Category: OFP
Operand types:
light:
Object
Compatibility:
Version 2.58 required.
Type of returned value:
Nothing
Description:
Detach light from object.
Category: OFP
Operand types:
lamppost:
Object
Compatibility:
Version 1.04 required.
Type of returned value:
String
Description:
Checks whether the lampost is turned on. Possible values are "ON", "OFF" and "AUTO" (auto means the lamp will be shining during the night automatically).
Example:
lightIsOn nearestObject [player, "StreetLamp"] != "OFF"
Category: OFP
Operand types:
object:
Object
speed:
Number
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Limit speed of given vehicle to given value (in km/h).
Category: OFP
Compatibility:
Version 2.01 required.
Type of returned value:
Structured text
Description:
Creates a structured text containing a line break.
Example:
txt3 = lineBreak
Category: OFP
Operand types:
trigger:
Object
Type of returned value:
Array
Description:
Returns a list of units that would activate the given trigger. For a trigger of type "Not present" the list is the same as the list that would be returned for type "Present".
Example:
list triggerOne
Category: OFP
Operand types:
map:
Control
type:
String
Compatibility:
Version 2.92 required.
Type of returned value:
Array
Description:
Return the list of all objects of given type.
Category: Editor
Operand types:
x:
Number
Type of returned value:
Number
Description:
The natural logarithm of x.
Example:
ln 10
, result is 2.302
Category: Default
Operand types:
[IDC,[[[text,text], [value,..], [data,..]], [[text,text], [value,..], [data,..]],]]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Number
Description:
Adds list of rows of strings.
Example:
_index = lnbAddRow [idc,[[[]],[[]]]] . Returns row index.
Category: Resistance
Operand types:
[idc, position]:
Array
Compatibility:
Version 1.50 required.
Type of returned value:
Number
Description:
Adds an column at given position. It returns the index of the newly added column.
Example:
_index = lnbAddColumn [105, 0.8]
Category: Resistance
Operand types:
control:
Control
position:
Number
Compatibility:
Version 5501 required.
Type of returned value:
Number
Description:
Adds an item with the given text to the given listbox or combobox. It returns the index of the newly added item.
Example:
_index = _control lbAdd "First item"
Category: OFP PC
Operand types:
[idc, [text, text,...]]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Number
Description:
Adds an row of strings.
Example:
_index = lnbAddRow [105, ["First column", "second column", ...]]. Returns row index.
Category: Resistance
Operand types:
control:
Control
[text1,text2,...]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Number
Description:
Adds an row to the end od 2d listbox . It returns the index of the newly added row.
Example:
_index = _control lnbAdd [t1,t2,t3,...]
Category: OFP PC
Operand types:
idc:
Number
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Clears all items in the 2D listbox.
Example:
lnbClear 101
Category: Resistance
Operand types:
control:
Control
Compatibility:
Version 2.91 required.
Type of returned value:
Nothing
Description:
Clears all items in the given listbox or combobox.
Example:
lbClear _control
Category: OFP PC
Operand types:
[idc, [row, column]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Array
Description:
Returns the text color of the item with the given position of the 2D listbox. The color is returned in format Color.
Example:
_color = lnbColor [101, [0,1]]
Category: Resistance
Operand types:
control:
Control
[row, column]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Array
Description:
Returns the text color of the item with the given position of the given 2D listbox.
Example:
_color = _control lnbColor [row, column]
Category: OFP PC
Operand types:
control:
Control
Compatibility:
Version 2.91 required.
Type of returned value:
Number
Description:
Returns the index of the selected item of the given listbox or combobox.
Example:
_index = lbCurSel _control
Category: OFP PC
Operand types:
idc:
Number
Compatibility:
Version 5501 required.
Type of returned value:
Number
Description:
Returns the index of the selected row id 2D listbox.
Example:
_row = lnbCurSel 105
Category: Resistance
Operand types:
[idc, [row, 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, [0,1]]
Category: Resistance
Operand types:
control:
Control
[row, 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 given 2D listbox.
Example:
_data = _control lnbData [row, column]
Category: OFP PC
Operand types:
[idc, index]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Removes column with given index.
Example:
lnbDeleteColumn [101, 0]
Category: Resistance
Operand types:
control:
Control
index:
Number
Compatibility:
Version 5501 required.
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
Operand types:
[idc, index]:
Array
Compatibility:
Version 1.50 required.
Type of returned value:
Nothing
Description:
Removes row with given index from the 2D listbox.
Example:
lnbDeleteRow [105, 0]
Category: Resistance
Operand types:
control:
Control
row:
Number
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Removes row with the given index from the given listbox or combobox.
Example:
_control lnbDelete 0
Category: OFP PC
Operand types:
control:
Control
Compatibility:
Version 2.91 required.
Type of returned value:
Array
Description:
Returns the index of the selected item of the given listbox or combobox.
Example:
_index = lbCurSel _control
Category: OFP PC
Operand types:
idc:
Number
Compatibility:
Version 5501 required.
Type of returned value:
Array
Description:
Returns the columns position in 2D listbox.
Example:
_n = lnbGetColumnsSize 105
Category: Resistance
Operand types:
[idc, [row, column]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
String
Description:
Returns the picture name of the item with the given position of the 2D listbox.
Example:
_picture = lnbPicture [101, [0,1]]
Category: Resistance
Operand types:
control:
Control
[row, column]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
String
Description:
Returns the picture name of the item with the given position of the given listbox or combobox.
Example:
_picture = _control lnbPicture [row, column]
Category: OFP PC
Operand types:
[idc, [row, column], color]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Sets the color of the item with the given position of the 2D listbox. Color is in format Color.
Example:
lnbSetColor [101, [0,1], [0, 1, 0, 0.5]]
Category: Resistance
Operand types:
control:
Control
[[row, column], color]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Sets the text color of the item with the given position of the given 2D listbox . Color is in format Color.
Example:
_control lnbSetColor [[row, column], [0, 1, 0, 0.5]]
Category: OFP PC
Operand types:
[idc, [row, column], data]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Sets the additional text (invisible) in the item with the given position of the 2D listbox.
Example:
lnbSetData [101, [0,1], "#1"]
Category: Resistance
Operand types:
control:
Control
[pos1,pos2,...]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Set position of 2d listbox columns.
Example:
_control lbSetColumnsPos [pos1,pos2,...]
Category: OFP PC
Operand types:
[idc, index]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Selects the row with the given index of the 2D listbox.
Example:
lnbSetCurSel [105, 0]
Category: Resistance
Operand types:
control:
Control
row:
Number
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Selects the item with the given index of the given listbox or combobox.
Example:
_control lbSetCurSel row
Category: OFP PC
Operand types:
[idc, [row, column], data]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Sets the additional text (invisible) in the item with the given position of the 2D listbox.
Example:
lnbSetData [101, [0,1], "#1"]
Category: Resistance
Operand types:
control:
Control
[[row, column], data]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Sets the additional text (invisible) in the item with the given position of the given 2D listbox to the given data.
Example:
_control lnbSetData [[row, column], "#1"]
Category: OFP PC
Operand types:
[idc, [row, column], name]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Sets the picture in the item with the given position of the 2D listbox. Name is the picture name. The picture is searched in the mission directory, the dtaExt subdirectory of the campaign directory and the dtaExt directory and the data bank (or directory).
Example:
lnbSetPicture [101, [0,1], "iskoda"]
Category: Resistance
Operand types:
control:
Control
[[row, column], name]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Sets the picture in the item with the given position of the given 2D listbox. Name is the picture name. The picture is searched in the mission directory, the dtaExt subdirectory of the campaign directory and the dtaExt directory and the data bank (or directory).
Example:
_control lnbSetPicture [[row, column], "iskoda"]
Category: OFP PC
Operand types:
[idc, [row, column], data]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Sets the additional text (invisible) in the item with the given position of the 2D listbox.
Example:
lnbSetData [101, [0,1], "#1"]
Category: Resistance
Operand types:
control:
Control
[[row, column], text]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Sets the additional text (invisible) in the item with the given index of the given 2D listbox to the given data.
Example:
_control lnbSetData [[row, column], "#1"]
Category: OFP PC
Operand types:
[idc, [row, column], value]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Sets the additional integer value in the item with the position index of the 2D listbox.
Example:
lnbSetValue [101, [0,1], 1]
Category: Resistance
Operand types:
control:
Control
[[row, column], value]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Sets the additional integer value in the item with the given position of the given 2D listbox to the given value.
Example:
_control lnbSetValue [[row, column], 1]
Category: OFP PC
Operand types:
idc:
Number
Compatibility:
Version 5501 required.
Type of returned value:
Array
Description:
Returns [X,Y] size of 2D listbox.
Example:
_n = lnbSize 105
Category: Resistance
Operand types:
control:
Control
Compatibility:
Version 2.91 required.
Type of returned value:
Array
Description:
Returns the number of items in the given listbox or combobox.
Example:
_n = lbSize _control
Category: OFP PC
Operand types:
[idc, [row, column]]:
Array
Compatibility:
Version 1.50 required.
Type of returned value:
String
Description:
Returns the shown text in the item with the given position of the 2D listbox.
Example:
_text = lnbText [101, [0,1]]
Category: Resistance
Operand types:
control:
Control
[row, column]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
String
Description:
Returns the shown text in the item with the given position of the given 2D listbox.
Example:
_text = _control lnbText [row, column]
Category: OFP PC
Operand types:
[idc, [row, column]:
Array
Compatibility:
Version 5501 required.
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, [0,1]]
Category: Resistance
Operand types:
control:
Control
[row, column]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Number
Description:
Returns the additional integer value in the item with the given position of the given 2D listbox.
Example:
_value = _control lnbValue [row, column]
Category: OFP PC
Operand types:
filename:
String
Compatibility:
Version 1.82 required.
Type of returned value:
String
Description:
Returns the content of the given file.
Example:
loadFile "myFunction.sqf"
, result is "if a>b then {a} else {b}"
Category: OFP
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Load a game from the autosave, if failed, restart the mission.
Category: OFP
Operand types:
person:
Object
name:
String
Compatibility:
Version 1.75 required.
Type of returned value:
Boolean
Description:
Loads person's identity from objects.sav file in campaign directory (from entry name).
Example:
player loadIdentity "playerIdentity"
Category: Resistance
Operand types:
map:
Control
config:
Config
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Creates the load overlay dialog for the specified type of overlay.
Category: Editor
Operand types:
object:
Object
name:
String
Compatibility:
Version 1.75 required.
Type of returned value:
Boolean
Description:
Loads object's properties from objects.sav file in campaign directory (from entry name).
Example:
player loadStatus "playerState"
Category: Resistance
Operand types:
obj:
Object
Type of returned value:
Boolean
Description:
MP: checks whether the given unit is local on the computer. This can be used when one or more activation fields or scripts need to be performed only on one computer.
In SP all objects are local. Note: all static objects are local on all computers.
Example:
local unitName
Category: OFP
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.csv file.
Example:
localize "STR_DN_FROG"
Category: OFP
Compatibility:
Version 5501 required.
Type of returned value:
Location
Description:
A non-existing location. This value is not equal to anything, including itself.
Category: Location
Operand types:
location:
Location
Compatibility:
Version 2.90 required.
Type of returned value:
Array
Description:
Return position of given location.
Category: Location
Operand types:
vehicle:
Object
lock:
Boolean
Type of returned value:
Nothing
Description:
Locks the vehicle (disables mounting / dismounting) for the player.
Example:
jeepOne lock true
Category: OFP
Operand types:
vehicle:
Object
lock:
Boolean
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Lock the all cargo positions of the vehicle.
Category: OFP
Operand types:
vehicle:
Object
[cargo index, lock]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Lock the cargo position of the vehicle.
Category: OFP
Operand types:
vehicle:
Object
lock:
Boolean
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Lock the driver position of the vehicle.
Category: OFP
Operand types:
unit:
Object
Type of returned value:
Boolean
Description:
Checks whether the vehicle is locked for the player. If it's locked, the player cannot mount / dismount without an order.
Example:
locked jeepOne
Category: OFP
Operand types:
vehicle:
Object
cargo index:
Number
Compatibility:
Version 5501 required.
Type of returned value:
Boolean
Description:
Check whether cargo position of the vehicle is locked.
Category: OFP
Operand types:
vehicle:
Object
Compatibility:
Version 5501 required.
Type of returned value:
Boolean
Description:
Check whether driver position of the vehicle turret is locked.
Category: OFP
Operand types:
vehicle:
Object
turret path:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Boolean
Description:
Check whether gunner position of the vehicle turret is locked.
Category: OFP
Operand types:
vehicle:
Object
[turret path, lock]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Lock the gunner position of the vehicle turret.
Category: OFP
Operand types:
group:
Object or Group
lockWP:
Boolean
Type of returned value:
Nothing
Description:
Disables switching to the next waypoint (the current waypoint will never complete while lockWp is used). This is sometimes used during cut-scenes.
Example:
groupOne lockWP true
Category: OFP
Operand types:
x:
Number
Type of returned value:
Number
Description:
The base-10 logarithm of x.
Example:
log 10
, result is 1
Category: Default
Operand types:
unit(s):
Object or Array
position:
Object or Array
Compatibility:
Version 2.40 required.
Type of returned value:
Nothing
Description:
Control what the unit is looking at (target or position) (format Position)
Example:
someSoldier lookAt otherSoldier; otherSoldier lookAt getMarkerPos "markerOne"
Category: OFP
Operand types:
map:
Control
position:
Array
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Center the map on, and point the camera at, the position.
Category: Editor
Operand types:
vehicle:
Object
Compatibility:
Version 1.75 required.
Type of returned value:
Array
Description:
Returns an array with the type names of all the vehicle's magazines.
Example:
magazines player
Category: Resistance
Operand types:
frame:
Array
Compatibility:
Version 1.27 required.
Type of returned value:
Nothing
Description:
Adds the next frame to the map animation. The format of frame is [time, zoom, position], the format of position is Position2D.
Example:
mapAnimAdd [1, 0.1, getMarkerPos "anim1"]
Category: OFP
Compatibility:
Version 1.27 required.
Type of returned value:
Nothing
Description:
Clears the map animation.
Category: OFP
Compatibility:
Version 1.27 required.
Type of returned value:
Nothing
Description:
Plays the map animation.
Category: OFP
Compatibility:
Version 1.27 required.
Type of returned value:
Boolean
Description:
Checks whether the map animation has finished.
Category: OFP
Operand types:
markerName:
String
Compatibility:
Version 5501 required.
Type of returned value:
Number
Description:
Gets the marker alpha. See setMarkerAlpha.
Example:
markerAlpha "MarkerOne"
Category: OFP
Operand types:
name:
String
Compatibility:
Version 5501 required.
Type of returned value:
String
Description:
Gets the marker brush. See setMarkerBrush.
Example:
markerBrush "MarkerOne"
Category: OFP
Operand types:
markerName:
String
Compatibility:
Version 1.50 required.
Type of returned value:
String
Description:
Gets the marker color. See setMarkerColor.
Note: this function is identical to getMarkerColor.
Example:
markerColor "MarkerOne"
Category: OFP
Operand types:
markerName:
String
Compatibility:
Version 2.92 required.
Type of returned value:
Array
Description:
Gets the marker direction. See setMarkerDir.
Example:
markerDir "MarkerOne"
Category: OFP
Operand types:
markerName:
String
Compatibility:
Version 1.50 required.
Type of returned value:
Array
Description:
Returns the marker positon in format [x,z,y].
Note: this function is identical to getMarkerPos.
Example:
markerPos "markerOne"
Category: OFP
Operand types:
name:
String
Compatibility:
Version 5501 required.
Type of returned value:
String
Description:
Gets the marker shape. See setMarkerShape.
Example:
markerShape "MarkerOne"
Category: OFP
Operand types:
markerName:
String
Compatibility:
Version 1.50 required.
Type of returned value:
Array
Description:
Gets the marker size. See setMarkerSize.
Note: this function is identical to getMarkerSize.
Example:
markerSize "MarkerOne"
Category: OFP
Operand types:
markerName:
String
Compatibility:
Version 2.92 required.
Type of returned value:
Array
Description:
Gets the marker text. See setMarkerText.
Example:
markerText "MarkerOne"
Category: OFP
Operand types:
markerName:
String
Compatibility:
Version 1.50 required.
Type of returned value:
String
Description:
Gets the type of the marker. See setMarkerType.
Note: this function is identical to getMarkerType.
Example:
markerType "MarkerOne"
Category: OFP
Operand types:
a:
Number
b:
Number
Type of returned value:
Number
Description:
The greater of a,b
Example:
3 max 2
, result is 3
Category: Default
Operand types:
a:
Number
b:
Number
Type of returned value:
Number
Description:
The smaller of a,b
Example:
3 min 2
, result is 2
Category: Default
Compatibility:
Version 2.90 required.
Type of returned value:
Config
Description:
Return root of mission description.ext entries hierarchy.
Category: OFP PC
Compatibility:
Version 1.80 required.
Type of returned value:
String
Description:
Returns the name of the current mission.
Category: OFP
Compatibility:
Version 5501 required.
Type of returned value:
Namespace
Description:
Return the global namespace attached to mission.
Category: OFP
Compatibility:
Version 1.80 required.
Type of returned value:
Array
Description:
Returns the time of the mission start in format [year, month, day, hour, minute, second].
Category: OFP
Operand types:
a:
Number
b:
Number
Type of returned value:
Number
Description:
The remainder of a divided by b. Note that the remainer is calculated in the real domain.
Example:
3 mod 2
, result is 1
Category: Default
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.
Category: OFP
Operand types:
unit:
Object
Compatibility:
Version 5500 required.
Type of returned value:
Number
Description:
Checks a current morale level of the unit (-1..+1).
Example:
morale leader player
, result is 0.5
Category: OFP
Operand types:
group:
Object or Group
pos:
Array
Type of returned value:
Nothing
Description:
Creates a move waypoint on the given position (format Position) and makes it the currently active group waypoint.
Example:
groupOne move getPos player
Category: OFP
Operand types:
soldier:
Object
vehicle:
Object
Type of returned value:
Nothing
Description:
Moves the soldier into the vehicle's cargo position. (Immediately, without animation).
Example:
soldierOne moveInCargo jeepOne
Category: OFP
Operand types:
soldier:
Object
[vehicle, CargoIndex]:
Array
Type of returned value:
Nothing
Description:
Moves the soldier into a vehicle's specified cargo position. (Immediately, without animation).
Example:
soldierOne moveInCargo jeepOne
Category: OFP
Operand types:
soldier:
Object
vehicle:
Object
Type of returned value:
Nothing
Description:
Moves the soldier into the vehicle's commander position. (Immediatetely, without animation).
Example:
soldierOne moveInCommander jeepOne
Category: OFP
Operand types:
soldier:
Object
vehicle:
Object
Type of returned value:
Nothing
Description:
Moves the soldier into the vehicle's driver position. (Immediately, without animation).
Example:
soldierOne moveInDriver jeepOne
Category: OFP
Operand types:
soldier:
Object
vehicle:
Object
Type of returned value:
Nothing
Description:
Moves the soldier into the vehicle's gunner position. (Immediately, without animation).
Example:
soldierOne moveInGunner jeepOne
Category: OFP
Operand types:
soldier:
Object
[vehicle, turret path]:
Array
Type of returned value:
Nothing
Description:
Moves the soldier into the vehicle's turret. (Immediately, without animation).
Example:
soldierOne moveInTurret [tank, [0, 0]]
Category: OFP
Operand types:
map:
Control
object:
String
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Shifts an editor object to the end of the objects array. This means that the object will be drawn last (after all other objects).
Category: Editor
Operand types:
soldier:
Object
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Moves the soldier out of vehicle. (Immediately, without animation).
Category: OFP
Operand types:
soldier:
Object
Compatibility:
Version 5500 required.
Type of returned value:
Number
Description:
Returns the current time of the most important RTM animation currently being played on the soldier.
Example:
moveTime player
Category: OFP PC
Operand types:
person:
Object
position:
Array
Compatibility:
Version 2.61 required.
Type of returned value:
Nothing
Description:
Low level command to person to move to given position.
Category: OFP
Operand types:
person:
Object
Compatibility:
Version 2.62 required.
Type of returned value:
Boolean
Description:
Check if latest low level moveTo command is finished.
Category: OFP
Operand types:
person:
Object
Compatibility:
Version 2.92 required.
Type of returned value:
Boolean
Description:
Check if latest low level moveTo command failed.
Category: OFP
Type of returned value:
Number
Description:
Checks the current music volume (set by fadeMusic).
Category: OFP
Operand types:
object:
Object
Type of returned value:
String
Description:
Returns the name of the variable assigned to the object in the mission editor. When used on a vehicle, the name of the first crew member is returned (in order: commander, driver, gunner).
Example:
name vehicle player
Category: OFP
Operand types:
location:
Location
Compatibility:
Version 2.90 required.
Type of returned value:
String
Description:
Return name of global vatiable containing given location.
Category: Location
Operand types:
position:
Object or Array
radius or [typeName, radius] or [[typeName1, typeName2, ...], radius]:
Compatibility:
Version 5501 required.
Type of returned value:
Array
Description:
Find entities in the circle with given radius. If typeName(s) is (are) given, only entities of given type (or its subtype) are listed.
Example:
_list = position player nearObjects 50
Category: OFP
Operand types:
obj:
Object
Type of returned value:
Object
Description:
Returns the nearest building to the given object.
Example:
neareastBuilding player
Category: OFP
Operand types:
[position, type]:
Array
Compatibility:
Version 2.90 required.
Type of returned value:
Location
Description:
Find the nearest location (to the given position) of given type.
Category: Location
Operand types:
[position, [types], distance, <position to sort from>]:
Array
Compatibility:
Version 2.92 required.
Type of returned value:
Array
Description:
Find the nearest locations (from the given position) of certain types, within the specified distance. If <position to sort from> is provided, locations will be ordered by distance from this point.
Category: Location
Operand types:
position:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Location
Description:
Find the nearest location (to the given position) having it speech non-empty.
Category: Location
Operand types:
pos:
Array
Type of returned value:
Object
Description:
Returns the nearest object of the given type to the given position or object.
Pos may be using format [x,y,z, "type"] or [object, "type"].
Example:
nearestObject [player, "StreetLamp"]
Category: OFP
Operand types:
position:
Array
type:
String
Compatibility:
Version 2.01 required.
Type of returned value:
Object
Description:
Find object nearest to given position with given type.
Example:
obj = position player nearestObject "Building"
Category: Resistance
Operand types:
position:
Array
id:
Number
Compatibility:
Version 2.01 required.
Type of returned value:
Object
Description:
Find object nearest to given position with given Visitor id.
Example:
obj = position player nearestObject 1234
Category: Resistance
Operand types:
pos:
Array
Compatibility:
Version 2.92 required.
Type of returned value:
Array
Description:
Returns a list of nearest objects of the given types to the given position or object, within the specified distance.
Pos may be using format [x,y,z, ["type",...], limit] or [object, ["type",...], limit].
Example:
nearestObjects [player, ["Car","Tank"], 200]
Category: OFP
Operand types:
position:
Object or Array
radius or [typeName, radius]:
Compatibility:
Version 2.92 required.
Type of returned value:
Array
Description:
Find objects in the circle with given radius. If typeName is given, only objects of given type (or its subtype) are listed.
Example:
_list = position player nearObjects 50
Category: OFP
Operand types:
position:
Object or Array
radius:
Number
Compatibility:
Version 5501 required.
Type of returned value:
Boolean
Description:
Check whether all data are loaded to nearObjects will return in reasonable time.
Example:
_ok = position player nearObjectsReady 50
Category: OFP
Operand types:
position or object:
Object or Array
radius:
Number
Compatibility:
Version 5500 required.
Type of returned value:
Array
Description:
Find the road segments within the circle of given radius.
Example:
_list = player nearRoads 50
Category: OFP
Operand types:
unit:
Object
radius:
Number
Type of returned value:
Array
Description:
Check target database of the unit for all targets in max. distance radius around it. The output is list of items: [position, type, side, subj. cost, object]
Category: OFP
Operand types:
vehicle:
Object
Compatibility:
Version 2.92 required.
Type of returned value:
Number
Description:
Return how much vehicle wants to reload its weapons.
Category: OFP
Operand types:
map:
Control
config:
Config
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Creates the new overlay dialog for the specified type of overlay.
Category: Editor
Operand types:
map:
Control
Compatibility:
Version 2.92 required.
Type of returned value:
Number
Description:
Returns the next available menu item index.
Category: Editor
Compatibility:
Version 2.92 required.
Type of returned value:
Number
Description:
Return the time (in seconds) when the next weather change will occur.
Category: OFP
Type of returned value:
Any
Description:
Nil value. This value can be used to undefine an existing variable.
Example:
variableToDestroy = nil
Category: Default
Operand types:
map:
Control
menu index:
Compatibility:
Version 2.92 required.
Type of returned value:
Number
Description:
Returns the total number of user-added menu items belonging to the given menu.
Category: Editor
Operand types:
a:
Boolean
Type of returned value:
Boolean
Description:
not a
Example:
not false
, result is true
Category: Default
Operand types:
[year,time]:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Array
Description:
Convert float number to date.
Example:
date = NumberToDate [2008,0.5324]
Category: OFP
Type of returned value:
Object
Description:
A non-existing object. This value is not equal to anything, including itself.
Example:
player == objNull
, result is false
Category: OFP
Operand types:
objective:
String
status:
String
Type of returned value:
Nothing
Description:
Sets the briefing objective status. Status may be one of: "ACTIVE", "FAILED", "DONE" or "HIDDEN".
Example:
"obj_1" objStatus "FAILED"
Category: OFP
Operand types:
sound:
String
Compatibility:
Version 1.75 required.
Type of returned value:
Nothing
Description:
Defines a sound (voice) that is played the first time when the Group section in the briefing is selected.
Example:
onBriefingGroup "GroupVoiceOver"
Category: Resistance
Operand types:
sound:
String
Compatibility:
Version 1.75 required.
Type of returned value:
Nothing
Description:
Defines a sound (voice) that is played the first time when the Notes section in the briefing is selected.
Example:
onBriefingNotes "NotesVoiceOver"
Category: Resistance
Operand types:
sound:
String
Compatibility:
Version 1.75 required.
Type of returned value:
Nothing
Description:
Defines a sound (voice) that is played the first time when the Plan section in the briefing is selected.
Example:
onBriefingPlan "PlanVoiceOver"
Category: Resistance
Operand types:
sound:
String
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Defines a sound (voice) that is played the first time when the Team switch section in the briefing is selected.
Example:
onBriefingTeamSwitch "TeamSwitchVoiceOver"
Category: Resistance
Operand types:
command:
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Defines an action performed when commnad mode change. Command receives
_isHighCommand bool
Category: OFP
Operand types:
map:
Control
command:
String
Compatibility:
Version 2.92 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,_alt bool key state
Category: Editor
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
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
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
Operand types:
command:
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Defines an action performed when HC group has been selected. Command receives
_group group selected group
_isSelected bool new selection state
Category: OFP
Operand types:
command:
Compatibility:
Version 1.91 required.
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,_alt bool key state
If the click is processed, command should return true.
Example:
onMapSingleClick """SoldierEG"" createUnit [_pos, group player]"
Category: Resistance
Operand types:
parameters:
Any
command:
Compatibility:
Version 5500 required.
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,_alt bool key state
_this any parameters passed to this function
If the click is processed, command should return true.
Example:
"SoldierEG" onMapSingleClick "_this createUnit [_pos, group player]"
Category: OFP
Operand types:
statement:
Compatibility:
Version 2.10 required.
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
Operand types:
statement:
Compatibility:
Version 2.10 required.
Type of returned value:
Nothing
Description:
This statement is launched whenever a player is disconnected from a MP session. Variables _id and _name are set.
Category: Resistance
Operand types:
command:
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Defines an action performed after the preload screen finished.
Category: OFP
Operand types:
command:
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Defines an action performed just before the preload screen started.
Category: OFP
Operand types:
map:
Control
command:
String
Compatibility:
Version 2.92 required.
Type of returned value:
Any
Description:
Defines an action performed when the user right clicks on the map and selects New Object. Set to empty for default behavior. Command receives:
_pos array position
Category: Editor
Operand types:
command:
Compatibility:
Version 5500 required.
Type of returned value:
Nothing
Description:
Defines an action performed when the team switch is finished. Command receives:
_from object previous unit
_to object current units
Category: OFP
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
Operand types:
unitArray:
Array
order:
Boolean
Type of returned value:
Nothing
Description:
Forces all units in the list to get in their assigned vehicle.
Example:
[unitOne, unitTwo] orderGetIn true
Category: OFP
Compatibility:
Version 2.92 required.
Type of returned value:
Number
Description:
Return the current overcast.
Category: OFP
Compatibility:
Version 2.92 required.
Type of returned value:
Number
Description:
Return the overcast forecast.
Category: OFP
Operand types:
object:
Object
Compatibility:
Version 5501 required.
Type of returned value:
Number
Description:
On server machine, return the ID of the client where the object is local. Otherwise return 0.
Category: OFP
Operand types:
string:
String
Compatibility:
Version 2.92 required.
Type of returned value:
Number
Description:
Parse string containing real number.
Example:
parseNumber "0.125"
Category: Default
Operand types:
text:
String
Compatibility:
Version 2.01 required.
Type of returned value:
Structured text
Description:
Creates a structured text by parsing the given XML description.
Example:
txt = parseText "First line<img image=data\isniper.paa/><br/>Second line"
Category: OFP
Compatibility:
Version 5501 required.
Type of returned value:
Namespace
Description:
Return the global namespace attached to config parser.
Category: OFP
Type of returned value:
Number
Description:
pi (180 degrees converted to radians)
Example:
pi
, result is 3.1415
Category: Default
Operand types:
obj:
Object
Compatibility:
Version 1.75 required.
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).
Category: Resistance
Compatibility:
Version 5501 required.
Type of returned value:
Array
Description:
Return a list of playable units (occupied by both AI or players).
Category: OFP
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.
Example:
soldierOne playAction "SitDown"
Category: OFP
Operand types:
soldier:
Object
action:
String
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
When used on a person, a smooth transition to the given action will be initiated, but all previous playAction are discarded.
Example:
soldierOne playActionNow "SitDown"
Category: OFP
Type of returned value:
Object
Description:
This is the person controlled by the player. In MP this value is different on each computer.
Example:
alive player
Category: OFP
Compatibility:
Version 2.92 required.
Type of returned value:
Number
Description:
Return the player remaining time to respawn.
Category: OFP
Compatibility:
Version 2.09 required.
Type of returned value:
Side
Description:
Returns the player's side. This is valid even when the player controlled person is dead (a difference from player side).
Category: OFP
Operand types:
side:
Side
Compatibility:
Version 1.80 required.
Type of returned value:
Number
Description:
Returns the number of players playing on the given side.
Category: OFP
Operand types:
soldier:
Object
moveName:
String
Compatibility:
Version 5500 required.
Type of returned value:
Nothing
Description:
When used on a person, a smooth transition to the given move will be initiated.
Example:
soldierOne playGesture "Wave"
Category: OFP
Operand types:
[campaign, mission] or [campaign, mission, skipBriefing]:
Array
Compatibility:
Version 2.19 required.
Type of returned value:
Nothing
Description:
The mission is launched (from the main menu). Both campaign and mission are given as their directory name. If the campaign is empty, a single mission is launched. If skipBriefing is true, the intro and briefing are skipped.
Example:
playMission["XOutrage","x05Negotiator.Noe"]
Category: OFP
Operand types:
soldier:
Object
moveName:
String
Type of returned value:
Nothing
Description:
When used on a person, a smooth transition to the given move will be initiated.
Example:
soldierOne playMove "Stand"
Category: OFP
Operand types:
soldier:
Object
moveName:
String
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
When used on a person, a smooth transition to the given move will be initiated, but all previous playAction are discarded.
Example:
soldierOne playMoveNow "Stand"
Category: OFP
Operand types:
nameAndPos:
Array
Type of returned value:
Nothing
Description:
Plays music defined in the description.ext file. The format of nameAndPos is [name,position]. Position is in seconds.
Example:
playMusic ["Track13", 30]
Category: OFP
Operand types:
name:
String
Type of returned value:
Nothing
Description:
Plays music defined in the description.ext file.
Example:
playMusic "musicname"
Category: OFP
Operand types:
[world, expression, config]:
Array
Compatibility:
Version 5500 required.
Type of returned value:
Nothing
Description:
Load the given world, launch an empty mission and execute the given expression. Config (optional) can reference to the config entry replacing description.ext for this mission.
Category: OFP
Operand types:
name:
String
Type of returned value:
Nothing
Description:
Plays a sound defined in the description.ext file.
Example:
playSound "soundname"
Category: OFP
Operand types:
object:
Object
Compatibility:
Version 1.50 required.
Type of returned value:
Array
Description:
Returns the object position in format Position.
Example:
position player
Category: OFP
Operand types:
location:
Location
Compatibility:
Version 2.90 required.
Type of returned value:
Array
Description:
Return (raw) position of given location.
Category: Location
Operand types:
position:
Array
Compatibility:
Version 2.52 required.
Type of returned value:
Array
Description:
Transform position from camera coordinate space to world coordinate space.
Example:
_worldPos = positionCameraToWorld _cameraPos
Category: OFP PC
Operand types:
map:
Control
[x, y]:
Array
Compatibility:
Version 2.54 required.
Type of returned value:
Array
Description:
Convert screen coordinates in map to world coordinates.
Category: OFP PC
Operand types:
map:
Control
position:
Array
Compatibility:
Version 2.54 required.
Type of returned value:
Array
Description:
Convert world coordinates to screen coordinates in map.
Category: OFP PC
Operand types:
number:
Number
array:
Array
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Set post process effect parameters
Example:
hndl ppEffectAdjust [0.0075, 0.0075, 0.1, 0.1]
Category: Visual
Operand types:
string:
String
array:
Array
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Adjust parameters for specified post process effect
Example:
"radialBlurr" ppEffectEnable []
Category: Visual
Operand types:
array:
Array
scalar:
Number
Compatibility:
Version 2.92 required.
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
Operand types:
number:
Number
number:
Number
Compatibility:
Version 2.92 required.
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
Operand types:
string:
String
number:
Number
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Set time when old pars are replaced by last set, if 0 set immediately
Example:
...
Category: Visual
Operand types:
effect:
Number
Compatibility:
Version 5501 required.
Type of returned value:
Boolean
Description:
Check whether given post process effect is commited
Category: Visual
Operand types:
effect:
String
Compatibility:
Version 5501 required.
Type of returned value:
Boolean
Description:
Check whether given post process effect is commited
Category: Visual
Operand types:
effect:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Array
Description:
Create post process effect specified by name and priority
Category: Visual
Operand types:
effect:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Number
Description:
Create post process effect specified by name and priority
Category: Visual
Operand types:
effect:
Array
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Create post process effect specified by name and priority
Category: Visual
Operand types:
effect:
Number
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Destroy post process effect given by handle
Category: Visual
Operand types:
number:
Number
bool:
Boolean
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Enable / disable post process effect
Example:
hndl ppEffectEnable true
Category: Visual
Operand types:
string:
String
bool:
Boolean
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Enable/disable specified post process effect, is overloaded form multiple effects.
Example:
"radialBlurr" ppEffectEnable true, ["chromAberration", "radialBlurr"] ppEffectEnable true
Category: Visual
Operand types:
array:
Array
bool:
Boolean
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Enable/disable specified post process effect, is overloaded form multiple effects.
Example:
"radialBlurr" ppEffectEnable true, ["chromAberration", "radialBlurr"] ppEffectEnable true
Category: Visual
Operand types:
entity:
Object
Compatibility:
Version 2.92 required.
Type of returned value:
Number
Description:
Return the precision of the given entity.
Category: OFP
Operand types:
position:
Array
Compatibility:
Version 2.50 required.
Type of returned value:
Boolean
Description:
Preload all textures and models around given position
Category: OFP
Operand types:
distance:
Number
object:
Object or String
Compatibility:
Version 2.50 required.
Type of returned value:
Boolean
Description:
Preload all data for given object.
Category: OFP
Operand types:
sound:
String
Compatibility:
Version 2.50 required.
Type of returned value:
Boolean
Description:
Make sure sound can start playing without any delay once we need it.
Category: OFP
Operand types:
effect:
Array
Type of returned value:
Boolean
Description:
Object title - argument uses format ["text","type",speed] or ["name","type"]. Speed is ignored.
Preload data
The object can be defined in the description.ext file.
Example:
titleObj ["BISLogo","plain"]
Category: OFP
Operand types:
effect:
Array
Type of returned value:
Boolean
Description:
Resource title - argument uses format ["name","type",speed] or ["name","type"]. Speed is ignored.
Preload data
The resource can be defined in the description.ext file.
Example:
titleRsc ["BIS", "PLAIN"]
Category: OFP
Operand types:
filename:
String
Compatibility:
Version 1.82 required.
Type of returned value:
String
Description:
Returns the preprocessed content of the given file. The preprocessor is C-like, it supports comments using // or /* and */ and macros defined with #define.
Example:
preprocessFile "myFunction.sqf"
, result is "if a>b then {a} else {b}"
Category: OFP
Operand types:
filename:
String
Compatibility:
Version 2.58 required.
Type of returned value:
String
Description:
Returns the preprocessed content of the given file. The preprocessor is C-like, it supports comments using // or /* and */ and macros defined with #define.
Example:
preprocessFileLineNumbers "myFunction.sqf"
, result is "if a>b then {a} else {b}"
Category: OFP
Operand types:
vehicle:
Object
Compatibility:
Version 1.75 required.
Type of returned value:
String
Description:
Returns the name of the vehicle's primary weapon (an empty string if there is none).
Example:
primaryWeapon player
Category: Resistance
Operand types:
task:
Task
Compatibility:
Version 2.91 required.
Type of returned value:
Number
Description:
Return the priority of the task.
Category: Identity
Operand types:
variable:
String or Array
Compatibility:
Version 1.85 required.
Type of returned value:
Nothing
Description:
Introduces one or more local variables in the innermost scope.
Category: Default
Operand types:
link:
String
Compatibility:
Version 5500 required.
Type of returned value:
Nothing
Description:
Open the diary screen on the record specified by link.
Category: Identity
Compatibility:
Version 2.33 required.
Type of returned value:
Nothing
Description:
Process commands stored using setVehicleInit.
Category: OFP
Operand types:
progress:
Number
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
If loading screen is show, set progress bar to the given value (from interval [0, 1])
Category: OFP
Operand types:
control:
Control
Compatibility:
Version 5500 required.
Type of returned value:
Number
Description:
Returns the current position in the progress bar.
Example:
_pos = progressPosition _control
Category: OFP PC
Operand types:
control:
Control
pos:
Number
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Sets the current position in the progress bar.
Example:
_control sliderSetPosition 0
Category: OFP PC
Operand types:
varName:
String
Type of returned value:
Nothing
Description:
Broadcasts the variable value to all computers.
Only type Number is supported in versions 1.33 and before.
The following types are supported since 1.34:
Number, Boolean, Object and Group.
Example:
publicVariable "CTFscoreOne"
Category: OFP
Operand types:
obj:
Object
Compatibility:
Version 1.75 required.
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.
Category: Resistance
Operand types:
name:
String
Compatibility:
Version 1.75 required.
Type of returned value:
Number
Description:
Returns the number of magazines of type name in the weapon pool (used in campaigns to transfer weapons to the next mission).
Category: Resistance
Operand types:
name:
String
Compatibility:
Version 1.75 required.
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).
Category: Resistance
Operand types:
x:
Number
Type of returned value:
Number
Description:
Converts x from degrees to radians.
Example:
rad 180
, result is 3.1415
Category: Default
Type of returned value:
Number
Description:
Checks the current radio volume (set by setRadioVolume).
Category: OFP
Compatibility:
Version 2.92 required.
Type of returned value:
Number
Description:
Return the current rain.
Category: OFP
Operand types:
x:
Number
Type of returned value:
Number
Description:
The random real value from 0 to x. (0<=random<1)
Example:
random 1
Category: Default
Operand types:
unit:
Object
Compatibility:
Version 2.92 required.
Type of returned value:
String
Description:
Return the rank of the given unit.
Category: OFP
Operand types:
unit:
Object
Compatibility:
Version 5500 required.
Type of returned value:
Number
Description:
Return the rank of the given unit for comparison.
Category: OFP
Operand types:
unit:
Object
Type of returned value:
Number
Description:
Checks the unit rating. This rating is increased for killing enemies, decreased for killing friendlies and can be changed by a mission designer.
Example:
rating player
Category: OFP
Operand types:
location:
Location
Compatibility:
Version 2.90 required.
Type of returned value:
Boolean
Description:
Check if given location has rectangular shape.
Category: Location
Operand types:
teamMember:
Compatibility:
Version 2.91 required.
Type of returned value:
Array
Description:
List all registered task types.
Category: Identity
Operand types:
teamMember:
entry name:
String
Compatibility:
Version 2.90 required.
Type of returned value:
Boolean
Description:
Register a new task type. Parameters are defined in the given config class (subclass of CfgTasks).
Category: Identity
Operand types:
vehicle:
Object
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Reload all weapons.
Category: OFP
Operand types:
vehicle:
Object
Compatibility:
Version 2.92 required.
Type of returned value:
Boolean
Description:
Check whether magazine is reloaded whenever emptied.
Category: OFP
Operand types:
who:
Object
whom:
Object
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Switch on remote control of the unit.
Example:
player remoteControl gunner _uav
Category: OFP
Operand types:
unit:
Object
index:
Number
Compatibility:
Version 1.11 required.
Type of returned value:
Nothing
Description:
Removes the action with the given id.
Example:
player removeAction 0
Category: OFP
Operand types:
object:
Object
handlerType:
String
Compatibility:
Version 1.85 required.
Type of returned value:
Nothing
Description:
Removes all event handlers of the given type which were added by addEventHandler.
Example:
player removeAllEventHandlers "killed"
Category: OFP
Operand types:
unit:
Object
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Removes all special items from the unit.
Example:
removeAllItems player
Category: OFP
Operand types:
unit:
Object
Type of returned value:
Nothing
Description:
Removes all weapons from the unit.
Example:
removeAllWeapons player
Category: OFP
Operand types:
map:
Control
[object, string identifier]:
Array
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Removes an icon for an editor object.
Category: Editor
Operand types:
map:
Control
[from, param type]:
Array
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Remove all drawn links for the given editor object for the given editor object type. Pass an empty string as param type to remove all draw links for an object.
Category: Editor
Operand types:
object:
Object
handler:
Array
Compatibility:
Version 1.85 required.
Type of returned value:
Nothing
Description:
Removes event handler added by addEventHandler. Format of handler is [type,index]. Index is returned by addEventHandler. When any handler is removed, all handler indices higher that the deleted one should be decremented.
Example:
player removeEventHandler ["killed",0]
Category: OFP
Operand types:
group:
Group
icon ID:
Number
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Remove icon with given ID from group.
Example:
group removeGroupIcon id
Category: OFP
Operand types:
unit:
Object
weaponName:
String or Array
Type of returned value:
Nothing
Description:
Removes the magazine from the unit. Note: you may create invalid combinations by using this function. When doing so, application behaviour is undefined.
Example:
player removeMagazine "M16"
Category: OFP
Operand types:
unit:
Object
weaponName:
String
Type of returned value:
Nothing
Description:
Removes all magazines of the given type from the unit. Note: you may create invalid combinations by using this function. When doing so, application behaviour is undefined.
Example:
player removeMagazines "M16"
Category: OFP
Operand types:
map:
Control
index of menu item to delete:
Number
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Removes a previously added menu item.
Category: Editor
Operand types:
map:
Control
text of menu item to delete:
String
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Removes a previously added menu item.
Category: Editor
Operand types:
person:
Object
task:
Task
Compatibility:
Version 5501 required.
Type of returned value:
Nothing
Description:
Remove a simple task from the list of simple tasks.
Category: Identity
Operand types:
person:
Object
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Remove a unit from the list of units available for team switch.
Category: OFP
Operand types:
unit:
Object
weaponName:
String
Type of returned value:
Nothing
Description:
Removes the weapon from the unit. Note: you may create invalid combinations by using this function. When doing so, application behaviour is undefined.
Example:
player removeWeapon "M16"
Category: OFP
Operand types:
version:
String
Compatibility:
Version 1.21 required.
Type of returned value:
Boolean
Description:
Checks whether the appropriate version of the application is available. If it's not, a warning message is shown and false is returned. The version format is "Major.Minor", e.g. "1.30".
Example:
requiredVersion "1.30"
Category: OFP
Type of returned value:
Side
Description:
The Resistance side.
Category: OFP
Operand types:
array:
Array
count:
Number
Compatibility:
Version 1.75 required.
Type of returned value:
Nothing
Description:
Changes the array size. This function can be used to add or remove elements from the array.
Example:
array resize 2
Category: Default
Operand types:
vehicle:
Object
[delay = -1, count = 0]:
Array
Compatibility:
Version 2.52 required.
Type of returned value:
Nothing
Description:
Set vehicle as respawnable in MP games. Delay is respawn delay, default respawnDelay from description.ext is used. Count tells how many respawns is processed (default unlimited).
Example:
car respawnVehicle [5.0, 3]
Category: OFP
Operand types:
map:
Control
Compatibility:
Version 2.92 required.
Type of returned value:
Nothing
Description:
Restarts the mission editor camera (if it was deleted by a script, for example).
Category: Editor
Operand types:
group:
Object or Group
unit:
Object
Type of returned value:
Nothing
Description:
Reveals the unit to the group. It does not matter whether the group can know about the unit or not.
Example:
soldierOne reveal soldierTwo
Category: OFP
Compatibility:
Version 5501 required.
Type of returned value:
Boolean
Description:
Return if mouse vertical axe is inverted.
Category: OFP
Operand types:
road segment:
Object
Compatibility:
Version 5500 required.
Type of returned value:
Array
Description:
Find the road segments connected to the given road segment.
Category: OFP
Operand types:
x:
Number
Type of returned value:
Number
Description:
The round value of x.
Example:
round -5.25
, result is -5
Category: Default
Compatibility:
Version 2.33 required.
Type of returned value:
Nothing
Description:
Launch init.sqs script.
Category: OFP
Compatibility:
Version 5501 required.
Type of returned value:
Number
Category: OFP
Compatibility:
Version 5501 required.
Type of returned value:
Number
Category: OFP
Compatibility:
Version 5501 required.
Type of returned value:
Number
Category: OFP
Compatibility:
Version 5501 required.
Type of returned value:
Number
Category: OFP
Type of returned value:
Nothing
Description:
Creates an autosave game (used for Retry).
Category: OFP
Operand types:
person:
Object
name:
String
Compatibility:
Version 1.75 required.
Type of returned value:
Boolean
Description:
Saves person's identity to objects.sav file in campa