Skip to content

Instantly share code, notes, and snippets.

@dedmen

dedmen/1.68 script cmds.json

Created March 28, 2017 18:59
Show Gist options
  • Save dedmen/e79c13bfcbd831e1665f7b1bb3500c01 to your computer and use it in GitHub Desktop.
Save dedmen/e79c13bfcbd831e1665f7b1bb3500c01 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
1.68 script cmds.json
This file has been truncated, but you can view the full file.
{
"functions": {
"!": [
{
"cat": "Default",
"desc": "not a",
"ex": "!true",
"exres": "false",
"name": "!",
"op": "!",
"rname": "a",
"since": ""
}
],
"+": [
{
"cat": "Default",
"desc": "unary plus: returns a",
"ex": "+4",
"exres": "4",
"name": "+",
"op": "+",
"rname": "a",
"since": ""
},
{
"cat": "Default",
"desc": "unary plus: returns a copy of the array",
"ex": "+ [0, 1, 2]",
"exres": "[0, 1, 2]",
"name": "+",
"op": "+",
"rname": "a",
"since": ""
}
],
"-": [
{
"cat": "Default",
"desc": "unary minus: zero minus a",
"ex": "- - 3",
"exres": "3",
"name": "-",
"op": "-",
"rname": "a",
"since": ""
}
],
"AGLToASL": [
{
"cat": "General",
"desc": "Converts a position from <ar>Position</ar> to <ar>PositionASL</ar> format.",
"ex": "AGLToASL (player modelToWorld [0,0,0])",
"exres": "",
"name": "agltoasl",
"op": "agltoasl",
"rname": "posAGL",
"since": ""
}
],
"AISFinishHeal": [
{
"cat": "General",
"desc": "AIS end state.",
"ex": "AISFinishHeal [wounded,medic,true]",
"exres": "",
"name": "aisfinishheal",
"op": "aisfinishheal",
"rname": "[unit,unit,bool]",
"since": "5501"
}
],
"ASLToAGL": [
{
"cat": "General",
"desc": "Converts a position from <ar>PositionASL</ar> to <ar>Position</ar> format.",
"ex": "ASLToAGL getPosASL player",
"exres": "",
"name": "asltoagl",
"op": "asltoagl",
"rname": "posASL",
"since": ""
}
],
"ASLToATL": [
{
"cat": "General",
"desc": "Converts a position from <ar>PositionASL</ar> to <ar>Position</ar> format.",
"ex": "ASLToATL getPosASL player",
"exres": "",
"name": "asltoatl",
"op": "asltoatl",
"rname": "pos",
"since": "OA 93641"
}
],
"ATLToASL": [
{
"cat": "General",
"desc": "Converts a position from <ar>Position</ar> to <ar>PositionASL</ar> format.",
"ex": "ATLToASL getPosATL player",
"exres": "",
"name": "atltoasl",
"op": "atltoasl",
"rname": "pos",
"since": "OA 93641"
}
],
"MenuClear": [
{
"cat": "General",
"desc": "Removes all entries from given menu strip.",
"ex": "example",
"exres": "",
"name": "menuclear",
"op": "menuclear",
"rname": "<MenuStripControl>",
"since": ""
},
{
"cat": "General",
"desc": "Removes all entries from given menu strip.",
"ex": "example",
"exres": "",
"name": "menuclear",
"op": "menuclear",
"rname": "<idc>",
"since": ""
}
],
"SoldierMagazines": [
{
"cat": "General",
"desc": "Get array with all magazines from vest.",
"ex": "",
"exres": "",
"name": "soldiermagazines",
"op": "soldiermagazines",
"rname": "unit",
"since": "5501"
}
],
"UAVControl": [
{
"cat": "General",
"desc": "Get list with unit connected to vehicle and position in that vehicle.",
"ex": "UAVControl cameraOn",
"exres": "",
"name": "uavcontrol",
"op": "uavcontrol",
"rname": "Uav",
"since": "109018"
}
],
"WFSideText": [
{
"cat": "General",
"desc": "Returns the unlocalized text value of a side as: East, West, Resistance, Civilian, or Unknown.",
"ex": "WFSideText West",
"exres": "",
"name": "wfsidetext",
"op": "wfsidetext",
"rname": "side",
"since": "1.04"
},
{
"cat": "General",
"desc": "Returns the unlocalized text value of a object's side as: East, West, Resistance, Civilian, or Unknown.",
"ex": "WFSideText player",
"exres": "",
"name": "wfsidetext",
"op": "wfsidetext",
"rname": "object",
"since": "5501"
},
{
"cat": "General",
"desc": "Returns the unlocalized text value of a group's side as: East, West, Resistance, Civilian, or Unknown.",
"ex": "WFSideText group player",
"exres": "",
"name": "wfsidetext",
"op": "wfsidetext",
"rname": "group",
"since": "5501"
}
],
"abs": [
{
"cat": "Default",
"desc": "The absolute value of x.",
"ex": "abs -3",
"exres": "3",
"name": "abs",
"op": "abs",
"rname": "x",
"since": ""
}
],
"acos": [
{
"cat": "Default",
"desc": "The arccosine of x, the result is in degrees.",
"ex": "acos 0.5",
"exres": "60",
"name": "acos",
"op": "acos",
"rname": "x",
"since": ""
}
],
"actionIDs": [
{
"cat": "General",
"desc": "Return array of IDs for user defined actions for specified entity",
"ex": "actionIDs player",
"exres": "",
"name": "actionids",
"op": "actionids",
"rname": "entity",
"since": ""
}
],
"actionKeys": [
{
"cat": "General",
"desc": "Returns a list of dikCodes of buttons assigned to the given user action.",
"ex": "array = actionKeys \"ReloadMagazine\"",
"exres": "",
"name": "actionkeys",
"op": "actionkeys",
"rname": "action",
"since": "2.01"
}
],
"actionKeysImages": [
{
"cat": "General",
"desc": "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.",
"ex": "text = actionKeysImages \"ReloadMagazine\"",
"exres": "",
"name": "actionkeysimages",
"op": "actionkeysimages",
"rname": "action or [action, maxKeys]",
"since": "2.01"
}
],
"actionKeysNames": [
{
"cat": "General",
"desc": "Returns a string of button names assigned to the given user action. A maximum of maxKeys keys is listed, 0=maximum possible. Sorted by inputDevicePriority with values 'Mouse','Keyboard','Stick','Gamepad','Trackir','Combo' (mouse and keyboard combinations),'Controler' (any controller other then mouse or keyboard). Other values are considered as 'Unsorted'. You can find the action names in config class ControllerSchemes.",
"ex": "list = actionKeysNames \"ReloadMagazine\"",
"exres": "",
"name": "actionkeysnames",
"op": "actionkeysnames",
"rname": "action or [action, maxKeys] or [action, maxKeys, inputDevicePriority]",
"since": "2.01"
}
],
"actionKeysNamesArray": [
{
"cat": "General",
"desc": "Returns a list of button names assigned to the given user action. A maximum of maxKeys keys is listed, 0=maximum possible. Sorted by inputDevicePriority with values 'Mouse','Keyboard','Stick','Gamepad','Trackir','Combo' (mouse and keyboard combinations),'Controler' (any controller other then mouse or keyboard). Other values are considered as 'Unsorted'. You can find the action names in config class ControllerSchemes.",
"ex": "list = actionKeysNames \"ReloadMagazine\"",
"exres": "",
"name": "actionkeysnamesarray",
"op": "actionkeysnamesarray",
"rname": "action or [action, maxKeys] or [action, maxKeys, inputDevicePriority]",
"since": "2.01"
}
],
"actionName": [
{
"cat": "General",
"desc": "Returns localized name of action.",
"ex": "name = actionName \"ReloadMagazine\"",
"exres": "",
"name": "actionname",
"op": "actionname",
"rname": "action",
"since": "2.01"
}
],
"activateAddons": [
{
"cat": "General",
"desc": "Activates the listed addons. The list of active addons is reinitialized during this function.",
"ex": "activateAddons [\"BISOFP\"]",
"exres": "",
"name": "activateaddons",
"op": "activateaddons",
"rname": "[addon1, ...]",
"since": "2.32"
}
],
"activateKey": [
{
"cat": "General",
"desc": "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.",
"ex": "activateKey \"M04\"",
"exres": "",
"name": "activatekey",
"op": "activatekey",
"rname": "keyName",
"since": "2.06"
}
],
"add3DENConnection": [
{
"cat": "General",
"desc": "Adds connection of given type between <from> items and <to> item.",
"ex": "",
"exres": "",
"name": "add3denconnection",
"op": "add3denconnection",
"rname": "[<type>, [<from>,...], <to>]",
"since": ""
}
],
"add3DENEventHandler": [
{
"cat": "General",
"desc": "Returns ID of registered event handler usefull for ex. when removing it.",
"ex": "",
"exres": "",
"name": "add3deneventhandler",
"op": "add3deneventhandler",
"rname": "[<type>, <code>]",
"since": ""
}
],
"addCamShake": [
{
"cat": "General",
"desc": "Adds camera shake source.",
"ex": "",
"exres": "",
"name": "addcamshake",
"op": "addcamshake",
"rname": "[power, duration, frequency]",
"since": "5501"
}
],
"addForceGeneratorRTD": [
{
"cat": "General",
"desc": "Add force generator to world. Returns force index.",
"ex": "",
"exres": "",
"name": "addforcegeneratorrtd",
"op": "addforcegeneratorrtd",
"rname": "[bool enabled, int type, vec3 strengh, vec3 position, vec3 radius, vec3 orientation, object AttachTo]",
"since": "TOH 81393"
}
],
"addItemPool": [
{
"cat": "General",
"desc": "Adds count items of type name into the weapon pool (used in the campaign to transfer weapons to the next mission).",
"ex": "",
"exres": "",
"name": "additempool",
"op": "additempool",
"rname": "",
"since": "1.75"
}
],
"addMagazinePool": [
{
"cat": "General",
"desc": "Adds count magazines of type name into the weapon pool (used in the campaign to transfer weapons to the next mission).",
"ex": "",
"exres": "",
"name": "addmagazinepool",
"op": "addmagazinepool",
"rname": "",
"since": "1.75"
}
],
"addMissionEventHandler": [
{
"cat": "General",
"desc": "Adds mission event handler. Every event will create an array named _this, which contains specific information about the particular event. The index of the currently added handler is returned.",
"ex": "_id = addMissionEventHandler [\"ended\",{_this exec \"missionEnded.sqs\"}]",
"exres": "",
"name": "addmissioneventhandler",
"op": "addmissioneventhandler",
"rname": "[type, command]",
"since": "TOH 85057"
}
],
"addMusicEventHandler": [
{
"cat": "General",
"desc": "Add an music track event handler. Returns id of the handler or -1 when failed.",
"ex": "_id = addMusicEventHandler [\"MusicStart\", \"hint format['Sample %1 start', _this select 0]\"]",
"exres": "",
"name": "addmusiceventhandler",
"op": "addmusiceventhandler",
"rname": "[type, function]",
"since": "92910"
}
],
"addSwitchableUnit": [
{
"cat": "General",
"desc": "Add a unit into the list of units available for team switch.",
"ex": "",
"exres": "",
"name": "addswitchableunit",
"op": "addswitchableunit",
"rname": "person",
"since": "2.92"
}
],
"addToRemainsCollector": [
{
"cat": "General",
"desc": "Flags given objects to me managed by unitRemove manager",
"ex": "addToRemainsCollector [unit1, unit2]",
"exres": "",
"name": "addtoremainscollector",
"op": "addtoremainscollector",
"rname": "array",
"since": ""
}
],
"addWeaponPool": [
{
"cat": "General",
"desc": "Adds count weapons of type name into the weapon pool (used in campaigns to transfer weapons to the next mission).",
"ex": "",
"exres": "",
"name": "addweaponpool",
"op": "addweaponpool",
"rname": "[name, count]",
"since": "1.75"
}
],
"agent": [
{
"cat": "Agents",
"desc": "Return a person for given agent.",
"ex": "_person = agent _agent",
"exres": "",
"name": "agent",
"op": "agent",
"rname": "agent",
"since": "2.90"
}
],
"aimPos": [
{
"cat": "General",
"desc": "Returns the position of the object other units can aim to in format <ar>PositionASL</ar>.",
"ex": "aimPos player",
"exres": "",
"name": "aimpos",
"op": "aimpos",
"rname": "obj",
"since": "OA 93598"
}
],
"airDensityRTD": [
{
"cat": "General",
"desc": "Returns air density in given altitude.",
"ex": "",
"exres": "",
"name": "airdensityrtd",
"op": "airdensityrtd",
"rname": "altitude",
"since": "TOH 81393"
}
],
"airportSide": [
{
"cat": "General",
"desc": "Checks a side of the airport.",
"ex": "airportSide 0",
"exres": "west",
"name": "airportside",
"op": "airportside",
"rname": "airportId",
"since": "2.92"
}
],
"alive": [
{
"cat": "General",
"desc": "Checks whether the given person, vehicle or building is't dead / destroyed.",
"ex": "alive player",
"exres": "",
"name": "alive",
"op": "alive",
"rname": "obj",
"since": ""
}
],
"allControls": [
{
"cat": "General",
"desc": "Returns a list of all controls from given display.",
"ex": "",
"exres": "",
"name": "allcontrols",
"op": "allcontrols",
"rname": "display",
"since": ""
}
],
"allMissionObjects": [
{
"cat": "General",
"desc": "Returns all mission objects with given type. ",
"ex": "allMissionObjects \"Air\"",
"exres": "",
"name": "allmissionobjects",
"op": "allmissionobjects",
"rname": "type",
"since": ""
}
],
"allSimpleObjects": [
{
"cat": "General",
"desc": "Returns a list of simple objects with given type. ",
"ex": "allSimpleObjects [\"B_Heli_Transport_01_F\"]",
"exres": "",
"name": "allsimpleobjects",
"op": "allsimpleobjects",
"rname": "type",
"since": "OA 94061"
}
],
"allTurrets": [
{
"cat": "General",
"desc": "Returns array with turrets in given vehicle. TRUE FALSE stands for return person turrets",
"ex": "allTurrets [vehicle player, true]",
"exres": "",
"name": "allturrets",
"op": "allturrets",
"rname": "[vehicle, includePersonTurrets]",
"since": ""
},
{
"cat": "General",
"desc": "Returns array with turrets in given vehicle",
"ex": "allTurrets vehicle player",
"exres": "",
"name": "allturrets",
"op": "allturrets",
"rname": "vehicle",
"since": ""
}
],
"allVariables": [
{
"cat": "Editor",
"desc": "Returns a list of all variables stored in given map.",
"ex": "",
"exres": "",
"name": "allvariables",
"op": "allvariables",
"rname": "map",
"since": ""
},
{
"cat": "Agents",
"desc": "Returns a list of all variables stored in given teamMember.",
"ex": "",
"exres": "",
"name": "allvariables",
"op": "allvariables",
"rname": "teamMember",
"since": ""
},
{
"cat": "General",
"desc": "Returns a list of all variables in given namespace. UI and profile namespaces are excluded",
"ex": "",
"exres": "",
"name": "allvariables",
"op": "allvariables",
"rname": "missionNameSpace",
"since": ""
},
{
"cat": "General",
"desc": "Returns a list of all variables stored in given object.",
"ex": "",
"exres": "",
"name": "allvariables",
"op": "allvariables",
"rname": "object",
"since": ""
},
{
"cat": "General",
"desc": "Returns a list of all variables stored in given group.",
"ex": "",
"exres": "",
"name": "allvariables",
"op": "allvariables",
"rname": "group",
"since": ""
},
{
"cat": "Identity",
"desc": "Returns a list of all variables stored in given task.",
"ex": "",
"exres": "",
"name": "allvariables",
"op": "allvariables",
"rname": "task",
"since": ""
},
{
"cat": "Location",
"desc": "Returns a list of all variables stored in given location.",
"ex": "",
"exres": "",
"name": "allvariables",
"op": "allvariables",
"rname": "location",
"since": ""
}
],
"animationNames": [
{
"cat": "General",
"desc": "returns list of animation than command Animate should accept",
"ex": "animationNames object",
"exres": "",
"name": "animationnames",
"op": "animationnames",
"rname": "entity",
"since": ""
}
],
"animationState": [
{
"cat": "General",
"desc": "Return the name of the current primary animation.",
"ex": "",
"exres": "",
"name": "animationstate",
"op": "animationstate",
"rname": "man",
"since": "2.92"
}
],
"asin": [
{
"cat": "Default",
"desc": "The arcsine of x, the result is in degrees.",
"ex": "asin 0.5",
"exres": "30",
"name": "asin",
"op": "asin",
"rname": "x",
"since": ""
}
],
"assert": [
{
"cat": "Default",
"desc": "Tests a condition and if the condition is false, halts the program.",
"ex": "assert (_x>0)",
"exres": "",
"name": "assert",
"op": "assert",
"rname": "codition",
"since": "2.00"
}
],
"assignedCargo": [
{
"cat": "General",
"desc": "Returns the list of soldiers assigned to the given vehicle as a cargo.",
"ex": "",
"exres": "",
"name": "assignedcargo",
"op": "assignedcargo",
"rname": "vehicle",
"since": "5501"
}
],
"assignedCommander": [
{
"cat": "General",
"desc": "Returns the soldier assigned to the given vehicle as a commander.",
"ex": "",
"exres": "",
"name": "assignedcommander",
"op": "assignedcommander",
"rname": "vehicle",
"since": "5501"
}
],
"assignedDriver": [
{
"cat": "General",
"desc": "Returns the soldier assigned to the given vehicle as a driver.",
"ex": "",
"exres": "",
"name": "assigneddriver",
"op": "assigneddriver",
"rname": "vehicle",
"since": "5501"
}
],
"assignedGunner": [
{
"cat": "General",
"desc": "Returns the soldier assigned to the given vehicle as a gunner.",
"ex": "",
"exres": "",
"name": "assignedgunner",
"op": "assignedgunner",
"rname": "vehicle",
"since": "5501"
}
],
"assignedItems": [
{
"cat": "General",
"desc": "Get array with all assigned items.",
"ex": "",
"exres": "",
"name": "assigneditems",
"op": "assigneditems",
"rname": "unit",
"since": "5501"
}
],
"assignedTarget": [
{
"cat": "General",
"desc": "Return the target assigned to the vehicle.",
"ex": "",
"exres": "",
"name": "assignedtarget",
"op": "assignedtarget",
"rname": "vehicle",
"since": "2.92"
}
],
"assignedTeam": [
{
"cat": "General",
"desc": "Checks which team does the vehicle (its commander unit) belong to.",
"ex": "assignedTeam soldier2",
"exres": "MAIN",
"name": "assignedteam",
"op": "assignedteam",
"rname": "vehicle",
"since": "2.05"
}
],
"assignedVehicle": [
{
"cat": "General",
"desc": "Return the vehicle person is assigned to.",
"ex": "",
"exres": "",
"name": "assignedvehicle",
"op": "assignedvehicle",
"rname": "person",
"since": "5130"
}
],
"assignedVehicleRole": [
{
"cat": "General",
"desc": "Return the position in vehicle person is assigned to.",
"ex": "",
"exres": "",
"name": "assignedvehiclerole",
"op": "assignedvehiclerole",
"rname": "person",
"since": "5130"
}
],
"atan": [
{
"cat": "Default",
"desc": "The arctangens of x, the result is in degrees.",
"ex": "atan 1",
"exres": "45",
"name": "atan",
"op": "atan",
"rname": "x",
"since": ""
}
],
"atg": [
{
"cat": "Default",
"desc": "The arctangens of x, the result is in degrees.",
"ex": "atg 1",
"exres": "45",
"name": "atg",
"op": "atg",
"rname": "x",
"since": ""
}
],
"attachedObject": [
{
"cat": "Location",
"desc": "Return object attached to given location.",
"ex": "",
"exres": "",
"name": "attachedobject",
"op": "attachedobject",
"rname": "location",
"since": "2.90"
}
],
"attachedObjects": [
{
"cat": "General",
"desc": "Returns list of attached objects.",
"ex": "attachedObjects player",
"exres": "",
"name": "attachedobjects",
"op": "attachedobjects",
"rname": "Unit",
"since": "116124"
}
],
"attachedTo": [
{
"cat": "General",
"desc": "Returns the object it is attach to.",
"ex": "attachedTo player",
"exres": "",
"name": "attachedto",
"op": "attachedto",
"rname": "Unit",
"since": "116124"
}
],
"attackEnabled": [
{
"cat": "General",
"desc": "Return whether leader can issue attack commands.",
"ex": "",
"exres": "",
"name": "attackenabled",
"op": "attackenabled",
"rname": "group",
"since": "2.92"
}
],
"backpack": [
{
"cat": "General",
"desc": "Returns a class of a backpack.",
"ex": "",
"exres": "",
"name": "backpack",
"op": "backpack",
"rname": "unit",
"since": "5501"
}
],
"backpackCargo": [
{
"cat": "General",
"desc": "Get array with backpacks from ammo box (or any general weapon holder container).",
"ex": "",
"exres": "",
"name": "backpackcargo",
"op": "backpackcargo",
"rname": "box",
"since": "5501"
}
],
"backpackContainer": [
{
"cat": "General",
"desc": "Returns container of a backpack.",
"ex": "",
"exres": "",
"name": "backpackcontainer",
"op": "backpackcontainer",
"rname": "unit",
"since": "5501"
}
],
"backpackItems": [
{
"cat": "General",
"desc": "Get array with all items from backpack.",
"ex": "",
"exres": "",
"name": "backpackitems",
"op": "backpackitems",
"rname": "unit",
"since": "5501"
}
],
"backpackMagazines": [
{
"cat": "General",
"desc": "Get array with all magazines from vest.",
"ex": "",
"exres": "",
"name": "backpackmagazines",
"op": "backpackmagazines",
"rname": "unit",
"since": "5501"
}
],
"behaviour": [
{
"cat": "General",
"desc": "Returns the behaviour mode of the given unit (\"CARELESS\",\"SAFE\",\"AWARE\",\"COMBAT\" or \"STEALTH\").",
"ex": "behaviour player",
"exres": "",
"name": "behaviour",
"op": "behaviour",
"rname": "unit",
"since": ""
}
],
"binocular": [
{
"cat": "General",
"desc": "Returns name of currently used binocular.",
"ex": "",
"exres": "",
"name": "binocular",
"op": "binocular",
"rname": "unit",
"since": "5501"
}
],
"boundingBox": [
{
"cat": "General",
"desc": "Returns a bounding box of given object in model coordinates space with size adjusted according to animation and destruction. The result is in format [[minX, minZ, minY], [maxX, maxZ, maxY]].",
"ex": "",
"exres": "",
"name": "boundingbox",
"op": "boundingbox",
"rname": "object",
"since": "2.92"
}
],
"boundingBoxReal": [
{
"cat": "General",
"desc": "Returns a bounding box of given object in model coordinates space. The result is in format [[minX, minZ, minY], [maxX, maxZ, maxY]].",
"ex": "boundingBoxReal cursorTarget",
"exres": "",
"name": "boundingboxreal",
"op": "boundingboxreal",
"rname": "obj",
"since": ""
}
],
"boundingCenter": [
{
"cat": "General",
"desc": "Returns the position of original (loaded) center of object in model coordinates. The result is in format [x, z, y]",
"ex": "",
"exres": "",
"name": "boundingcenter",
"op": "boundingcenter",
"rname": "object",
"since": "5501"
}
],
"breakOut": [
{
"cat": "Default",
"desc": "Breaks block out scope named 'name'. Nil is returned.",
"ex": "",
"exres": "",
"name": "breakout",
"op": "breakout",
"rname": "name",
"since": ""
}
],
"breakTo": [
{
"cat": "Default",
"desc": "Breaks block to scope named 'name'. Nil is returned.",
"ex": "",
"exres": "",
"name": "breakto",
"op": "breakto",
"rname": "name",
"since": ""
}
],
"buldozer_EnableRoadDiag": [
{
"cat": "General",
"desc": "",
"ex": "",
"exres": "",
"name": "buldozer_enableroaddiag",
"op": "buldozer_enableroaddiag",
"rname": "enable",
"since": "A3 94671"
}
],
"buldozer_LoadNewRoads": [
{
"cat": "General",
"desc": "",
"ex": "",
"exres": "",
"name": "buldozer_loadnewroads",
"op": "buldozer_loadnewroads",
"rname": "path",
"since": "A3 94671"
}
],
"buttonAction": [
{
"cat": "General",
"desc": "Returns the action assigned to the given button or active text. The action is any expression in this scripting language.",
"ex": "_action = buttonAction _button",
"exres": "",
"name": "buttonaction",
"op": "buttonaction",
"rname": "control",
"since": "2.92"
},
{
"cat": "General",
"desc": "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.",
"ex": "_action = buttonAction 100",
"exres": "",
"name": "buttonaction",
"op": "buttonaction",
"rname": "idc",
"since": "1.50"
}
],
"buttonSetAction": [
{
"cat": "General",
"desc": "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.",
"ex": "buttonSetAction [100, \"player exec \"\"reply.sqs\"\"\"]",
"exres": "",
"name": "buttonsetaction",
"op": "buttonsetaction",
"rname": "[idc, action]",
"since": "1.50"
}
],
"call": [
{
"cat": "Default",
"desc": "Executes the given code.",
"ex": "call {\"x=2\"}",
"exres": "",
"name": "call",
"op": "call",
"rname": "code",
"since": "1.85"
}
],
"camCommitted": [
{
"cat": "General",
"desc": "Checks whether the camera has finished committing.",
"ex": "camCommitted _camera",
"exres": "",
"name": "camcommitted",
"op": "camcommitted",
"rname": "camera",
"since": ""
}
],
"camDestroy": [
{
"cat": "General",
"desc": "Destroys the camera.",
"ex": "",
"exres": "",
"name": "camdestroy",
"op": "camdestroy",
"rname": "camera",
"since": ""
}
],
"camPreloaded": [
{
"cat": "General",
"desc": "Checks whether the camera has finished preloading.",
"ex": "camPreloaded _camera",
"exres": "",
"name": "campreloaded",
"op": "campreloaded",
"rname": "camera",
"since": "2.92"
}
],
"camTarget": [
{
"cat": "General",
"desc": "Returns camera's target.",
"ex": "camTarget _camera",
"exres": "",
"name": "camtarget",
"op": "camtarget",
"rname": "camera",
"since": "5501"
}
],
"camUseNVG": [
{
"cat": "General",
"desc": "Set / clear using of night vision during cutscenes.",
"ex": "",
"exres": "",
"name": "camusenvg",
"op": "camusenvg",
"rname": "set",
"since": "2.73"
}
],
"cameraEffectEnableHUD": [
{
"cat": "General",
"desc": "Enable / disable showing of in-game UI during currently active camera effect.",
"ex": "",
"exres": "",
"name": "cameraeffectenablehud",
"op": "cameraeffectenablehud",
"rname": "enable",
"since": "5501"
}
],
"cameraInterest": [
{
"cat": "General",
"desc": "Return camera interest for given entity.",
"ex": "",
"exres": "",
"name": "camerainterest",
"op": "camerainterest",
"rname": "entity",
"since": "2.57"
}
],
"canFire": [
{
"cat": "General",
"desc": "Checks whether the given vehicle is able to fire. It does not check for ammo, only for damage.",
"ex": "canFire vehicle player",
"exres": "",
"name": "canfire",
"op": "canfire",
"rname": "vehicle",
"since": ""
}
],
"canMove": [
{
"cat": "General",
"desc": "Checks whether the given vehicle is able to move. It does not test for fuel, only the damage status is checked.",
"ex": "canMove vehicle player",
"exres": "",
"name": "canmove",
"op": "canmove",
"rname": "vehicle",
"since": ""
}
],
"canStand": [
{
"cat": "General",
"desc": "Checks whether the given soldier is able to stand up.",
"ex": "canStand player",
"exres": "",
"name": "canstand",
"op": "canstand",
"rname": "soldier",
"since": ""
}
],
"canTriggerDynamicSimulation": [
{
"cat": "General",
"desc": "Returns true if given unit can activate dynamically disabled entities, otherwise return false",
"ex": "canTriggerDynamicSimulation player",
"exres": "",
"name": "cantriggerdynamicsimulation",
"op": "cantriggerdynamicsimulation",
"rname": "object",
"since": ""
}
],
"canUnloadInCombat": [
{
"cat": "General",
"desc": "Check if cargo of this vehicle want to get out when in combat.",
"ex": "",
"exres": "",
"name": "canunloadincombat",
"op": "canunloadincombat",
"rname": "vehicle",
"since": "5501"
}
],
"cancelSimpleTaskDestination": [
{
"cat": "Identity",
"desc": "Cancels a simple task destination",
"ex": "",
"exres": "",
"name": "cancelsimpletaskdestination",
"op": "cancelsimpletaskdestination",
"rname": "task",
"since": "5500"
}
],
"captive": [
{
"cat": "General",
"desc": "Checks whether the unit is a captive. If the unit is a vehicle, its commander is checked instead.",
"ex": "captive player",
"exres": "",
"name": "captive",
"op": "captive",
"rname": "unit",
"since": ""
}
],
"captiveNum": [
{
"cat": "General",
"desc": "Checks whether the unit is a captive. If the unit is a vehicle, its commander is checked instead.",
"ex": "captive player",
"exres": "",
"name": "captivenum",
"op": "captivenum",
"rname": "unit",
"since": ""
}
],
"case": [
{
"cat": "Default",
"desc": "see switch",
"ex": "",
"exres": "",
"name": "case",
"op": "case",
"rname": "b",
"since": ""
}
],
"cbChecked": [
{
"cat": "General",
"desc": "Returns the current state of CheckBox.",
"ex": "_checked = cbChecked _myCheckBox",
"exres": "",
"name": "cbchecked",
"op": "cbchecked",
"rname": "control",
"since": "2.50"
}
],
"ceil": [
{
"cat": "Default",
"desc": "The ceil value of x.",
"ex": "ceil 5.25",
"exres": "6",
"name": "ceil",
"op": "ceil",
"rname": "x",
"since": ""
}
],
"channelEnabled": [
{
"cat": "General",
"desc": "Returns availability of the chat and VoN for the given channel.",
"ex": "channelStatus = channelEnabled 1",
"exres": "",
"name": "channelenabled",
"op": "channelenabled",
"rname": "channel",
"since": ""
}
],
"checkAIFeature": [
{
"cat": "General",
"desc": "Check if given AI feature is currently enabled.",
"ex": "",
"exres": "",
"name": "checkaifeature",
"op": "checkaifeature",
"rname": "feature",
"since": "60220"
}
],
"className": [
{
"cat": "Location",
"desc": "Return short name of location. (used for scripting)",
"ex": "",
"exres": "",
"name": "classname",
"op": "classname",
"rname": "location",
"since": "80971 TOH"
}
],
"clear3DENInventory": [
{
"cat": "General",
"desc": "Clear saved state of entitie's inventory from SQM.",
"ex": "",
"exres": "",
"name": "clear3deninventory",
"op": "clear3deninventory",
"rname": "<entities>",
"since": ""
}
],
"clearAllItemsFromBackpack": [
{
"cat": "General",
"desc": "Removes all items from the backpack.",
"ex": "",
"exres": "",
"name": "clearallitemsfrombackpack",
"op": "clearallitemsfrombackpack",
"rname": "unit",
"since": ""
}
],
"clearBackpackCargo": [
{
"cat": "General",
"desc": "Removes all backpacks from ammo box (or any general weapon holder container).",
"ex": "clearBackpackCargo jeepOne",
"exres": "",
"name": "clearbackpackcargo",
"op": "clearbackpackcargo",
"rname": "box",
"since": ""
}
],
"clearBackpackCargoGlobal": [
{
"cat": "General",
"desc": "Removes all magazines from the vehicle cargo space. MP synchronized.",
"ex": "clearMagazineCargoGlobal jeepOne",
"exres": "",
"name": "clearbackpackcargoglobal",
"op": "clearbackpackcargoglobal",
"rname": "unit",
"since": ""
}
],
"clearGroupIcons": [
{
"cat": "General",
"desc": "Removes all icon from group.",
"ex": "clearGroupIcons group",
"exres": "",
"name": "cleargroupicons",
"op": "cleargroupicons",
"rname": "group",
"since": "5501"
}
],
"clearItemCargo": [
{
"cat": "General",
"desc": "Removes all items from ammo box (or any general weapon holder container).",
"ex": "clearItemCargo jeepOne",
"exres": "",
"name": "clearitemcargo",
"op": "clearitemcargo",
"rname": "box",
"since": ""
}
],
"clearItemCargoGlobal": [
{
"cat": "General",
"desc": "Removes all items from ammo box (or any general weapon holder container).",
"ex": "clearItemCargoGlobal jeepOne",
"exres": "",
"name": "clearitemcargoglobal",
"op": "clearitemcargoglobal",
"rname": "box",
"since": ""
}
],
"clearMagazineCargo": [
{
"cat": "General",
"desc": "Removes all magazines from the vehicle cargo space.",
"ex": "clearMagazineCargo jeepOne",
"exres": "",
"name": "clearmagazinecargo",
"op": "clearmagazinecargo",
"rname": "unit",
"since": ""
}
],
"clearMagazineCargoGlobal": [
{
"cat": "General",
"desc": "Removes all magazines from the vehicle cargo space. MP synchronized.",
"ex": "clearMagazineCargoGlobal jeepOne",
"exres": "",
"name": "clearmagazinecargoglobal",
"op": "clearmagazinecargoglobal",
"rname": "unit",
"since": ""
}
],
"clearOverlay": [
{
"cat": "Editor",
"desc": "Clear the current overlay.",
"ex": "clearOverlay _map",
"exres": "",
"name": "clearoverlay",
"op": "clearoverlay",
"rname": "map",
"since": "2.92"
}
],
"clearWeaponCargo": [
{
"cat": "General",
"desc": "Removes all weapons from the vehicle cargo space.",
"ex": "clearWeaponCargo jeepOne",
"exres": "",
"name": "clearweaponcargo",
"op": "clearweaponcargo",
"rname": "unit",
"since": ""
}
],
"clearWeaponCargoGlobal": [
{
"cat": "General",
"desc": "Removes all weapons from the vehicle cargo space. MP synchronized.",
"ex": "clearWeaponCargoGlobal jeepOne",
"exres": "",
"name": "clearweaponcargoglobal",
"op": "clearweaponcargoglobal",
"rname": "unit",
"since": ""
}
],
"closeDialog": [
{
"cat": "General",
"desc": "Closes the topmost user dialog as if a button with id idc was pressed.",
"ex": "closeDialog 1",
"exres": "",
"name": "closedialog",
"op": "closedialog",
"rname": "idc",
"since": "1.50"
}
],
"closeOverlay": [
{
"cat": "Editor",
"desc": "Closes the current overlay without committing.",
"ex": "",
"exres": "",
"name": "closeoverlay",
"op": "closeoverlay",
"rname": "map",
"since": "2.92"
}
],
"collapseObjectTree": [
{
"cat": "Editor",
"desc": "Collapse the object tree.",
"ex": "collapseObjectTree _map",
"exres": "",
"name": "collapseobjecttree",
"op": "collapseobjecttree",
"rname": "map",
"since": "2.92"
}
],
"collect3DENHistory": [
{
"cat": "General",
"desc": "Collects all history steps created by executing given code.",
"ex": "",
"exres": "",
"name": "collect3denhistory",
"op": "collect3denhistory",
"rname": "<code>",
"since": ""
}
],
"collectiveRTD": [
{
"cat": "General",
"desc": "Returns collective.",
"ex": "",
"exres": "",
"name": "collectivertd",
"op": "collectivertd",
"rname": "RTD_helicopter",
"since": "TOH 81984"
}
],
"combatMode": [
{
"cat": "General",
"desc": "Returns the combat mode of the given unit (\"BLUE\",\"GREEN\",\"YELLOW\" or \"RED\").",
"ex": "combatMode group player",
"exres": "",
"name": "combatmode",
"op": "combatmode",
"rname": "grp",
"since": ""
}
],
"commandGetOut": [
{
"cat": "General",
"desc": "Orders the unit to get out from the vehicle (via the radio).",
"ex": "commandGetOut unitOne",
"exres": "",
"name": "commandgetout",
"op": "commandgetout",
"rname": "unit",
"since": "2.28"
}
],
"commandStop": [
{
"cat": "General",
"desc": "Orders the unit to stop (via the radio).\r\nNote: the stop command is never finished; the unit will never be ready.",
"ex": "commandStop unitOne",
"exres": "",
"name": "commandstop",
"op": "commandstop",
"rname": "unit",
"since": ""
}
],
"commander": [
{
"cat": "General",
"desc": "Returns the commander of the vehicle. If the vehicle is not a vehicle, but a person, the person is returned instead.",
"ex": "commander vehicle player",
"exres": "",
"name": "commander",
"op": "commander",
"rname": "vehicle",
"since": ""
}
],
"comment": [
{
"cat": "Default",
"desc": "This function does nothing. It's used to create comments.",
"ex": "comment \"This is a comment.\"",
"exres": "",
"name": "comment",
"op": "comment",
"rname": "comment",
"since": "1.85"
}
],
"commitOverlay": [
{
"cat": "Editor",
"desc": "Commit the current overlay.",
"ex": "commitOverlay _map",
"exres": "",
"name": "commitoverlay",
"op": "commitoverlay",
"rname": "map",
"since": "2.92"
}
],
"compile": [
{
"cat": "Default",
"desc": "Compile expression.",
"ex": "_function = \"a = a + 1\"; _compiled = compile _function; call _compiled;",
"exres": "",
"name": "compile",
"op": "compile",
"rname": "expression",
"since": "2.60"
}
],
"compileFinal": [
{
"cat": "Default",
"desc": "Compile expression. Expression cannot be overridden.",
"ex": "_function = \"a = a + 1\"; _compiled = compile _function; call _compiled;",
"exres": "",
"name": "compilefinal",
"op": "compilefinal",
"rname": "expression",
"since": "2.60"
}
],
"completedFSM": [
{
"cat": "General",
"desc": "Check whether the given FSM completes. The FSM handle is the number returned by the execFSM command.",
"ex": "",
"exres": "",
"name": "completedfsm",
"op": "completedfsm",
"rname": "FSM handle",
"since": "5500"
}
],
"composeText": [
{
"cat": "General",
"desc": "Creates a structured text by joining the given structured or plain texts.",
"ex": "txt = composeText [\"First line\", image \"data\\isniper.paa\", lineBreak, \"Second line\"]",
"exres": "",
"name": "composetext",
"op": "composetext",
"rname": "[text1, text2, ...]",
"since": "2.01"
}
],
"configHierarchy": [
{
"cat": "General",
"desc": "Returns array of parent configs",
"ex": "configHierarchy (configFile >> \"CfgVehicles\" >> typeOf player)",
"exres": "",
"name": "confighierarchy",
"op": "confighierarchy",
"rname": "config",
"since": "2.92"
}
],
"configName": [
{
"cat": "General",
"desc": "Returns name of config entry.",
"ex": "_name = configName (configFile >> \"CfgVehicles\")",
"exres": "\"CfgVehicles\"",
"name": "configname",
"op": "configname",
"rname": "config",
"since": "2.35"
}
],
"configProperties": [
{
"cat": "General",
"desc": "Returns a list of all properties of the given class. Parameter is an array where first item is a target config class, second is string with condition (similar to configClasses), third is a bool: when set to true, the inherited properties are also included.",
"ex": "",
"exres": "",
"name": "configproperties",
"op": "configproperties",
"rname": "[config, condition, includeInherited]",
"since": "128352"
}
],
"configSourceAddonList": [
{
"cat": "General",
"desc": "Returns list of addons from which the given config class was loaded/updated.",
"ex": "configSourceAddonList (configFile >> \"CfgVehicles\" >> \"Car\")",
"exres": "",
"name": "configsourceaddonlist",
"op": "configsourceaddonlist",
"rname": "config",
"since": ""
}
],
"configSourceMod": [
{
"cat": "General",
"desc": "Returns modDir of the mod that given config class was loaded from.",
"ex": "configSourceMod (configFile >> \"CfgVehicles\" >> \"Car\")",
"exres": "",
"name": "configsourcemod",
"op": "configsourcemod",
"rname": "config",
"since": "128690"
}
],
"configSourceModList": [
{
"cat": "General",
"desc": "Returns an array of mods which modified the given config class.",
"ex": "configSourceModList (configFile >> \"CfgVehicles\" >> \"Car\")",
"exres": "",
"name": "configsourcemodlist",
"op": "configsourcemodlist",
"rname": "config",
"since": ""
}
],
"copyToClipboard": [
{
"cat": "General",
"desc": "Copy the text to the clipboard.",
"ex": "",
"exres": "",
"name": "copytoclipboard",
"op": "copytoclipboard",
"rname": "text",
"since": "5500"
}
],
"cos": [
{
"cat": "Default",
"desc": "The cosine of x, the argument is in degrees.",
"ex": "cos 60",
"exres": "0.5",
"name": "cos",
"op": "cos",
"rname": "x",
"since": ""
}
],
"count": [
{
"cat": "Default",
"desc": "The number of elements in the array.",
"ex": "count [0,0,1,2]",
"exres": "4",
"name": "count",
"op": "count",
"rname": "array",
"since": ""
},
{
"cat": "Default",
"desc": "Return a length of a given string.",
"ex": "count \"ArmA\"",
"exres": "4",
"name": "count",
"op": "count",
"rname": "string",
"since": "5195"
},
{
"cat": "General",
"desc": "Returns count of subentries.",
"ex": "_count = count (configFile >> \"CfgVehicles\")",
"exres": "",
"name": "count",
"op": "count",
"rname": "config",
"since": "2.35"
}
],
"create3DENComposition": [
{
"cat": "General",
"desc": "Creates new object composition based on given config based on CfgGroups.",
"ex": "",
"exres": "",
"name": "create3dencomposition",
"op": "create3dencomposition",
"rname": "[<path>, <position>]",
"since": ""
}
],
"create3DENEntity": [
{
"cat": "General",
"desc": "Creates new entity in given mode in 3DEN.",
"ex": "",
"exres": "",
"name": "create3denentity",
"op": "create3denentity",
"rname": "[<mode>, <className>, <position>]",
"since": ""
}
],
"createAgent": [
{
"cat": "General",
"desc": "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\".",
"ex": "agent = createAgent [\"SoldierWB\", position player, [], 0, \"FORM\"]",
"exres": "",
"name": "createagent",
"op": "createagent",
"rname": "[type, position, markers, placement, special]",
"since": "2.89"
}
],
"createCenter": [
{
"cat": "General",
"desc": "Creates a new AI center for the given side.",
"ex": "center = createCenter East",
"exres": "",
"name": "createcenter",
"op": "createcenter",
"rname": "side",
"since": "1.86"
}
],
"createDialog": [
{
"cat": "General",
"desc": "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.",
"ex": "_ok = createDialog \"RscDisplayGame\"",
"exres": "",
"name": "createdialog",
"op": "createdialog",
"rname": "name",
"since": "1.50"
}
],
"createDiaryLink": [
{
"cat": "Identity",
"desc": "Create a link to the section of diary given by subject. Record is selected based on given object (diary record, task or unit).",
"ex": "_link = createDiarySubject [\"Group\", player, \"Player\"]",
"exres": "",
"name": "creatediarylink",
"op": "creatediarylink",
"rname": "[subject, object, text]",
"since": "5500"
}
],
"createGearDialog": [
{
"cat": "General",
"desc": "Opens gear dialog for given unit.",
"ex": "CreateGearDialog [player,\"RscDisplayGear\"]",
"exres": "",
"name": "creategeardialog",
"op": "creategeardialog",
"rname": "[unit,resource]",
"since": "5501"
}
],
"createGroup": [
{
"cat": "General",
"desc": "Creates a new AI group for the given center (side).",
"ex": "group = createGroup East",
"exres": "",
"name": "creategroup",
"op": "creategroup",
"rname": "side",
"since": "1.86"
}
],
"createGuardedPoint": [
{
"cat": "General",
"desc": "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.",
"ex": "point = createGuardedPoint [East, [0, 0], -1, vehicle player]",
"exres": "",
"name": "createguardedpoint",
"op": "createguardedpoint",
"rname": "[side, position, idStatic, vehicle]",
"since": "1.86"
}
],
"createLocation": [
{
"cat": "Location",
"desc": "Create location of given type with given size at given position.",
"ex": "",
"exres": "",
"name": "createlocation",
"op": "createlocation",
"rname": "[type, position, sizeX, sizeZ]",
"since": "2.90"
}
],
"createMarker": [
{
"cat": "General",
"desc": "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.",
"ex": "marker = createMarker [Marker1, position player]",
"exres": "",
"name": "createmarker",
"op": "createmarker",
"rname": "[name, position]",
"since": "1.86"
}
],
"createMarkerLocal": [
{
"cat": "General",
"desc": "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.",
"ex": "marker = createMarkerLocal [Marker1, position player]",
"exres": "",
"name": "createmarkerlocal",
"op": "createmarkerlocal",
"rname": "[name, position]",
"since": "2.92"
}
],
"createMine": [
{
"cat": "General",
"desc": "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.",
"ex": "mine = createMine [\"MineMine\", position player, [], 0]",
"exres": "",
"name": "createmine",
"op": "createmine",
"rname": "[type, position, markers, placement]",
"since": "2.32"
}
],
"createSimpleObject": [
{
"cat": "General",
"desc": "Creates object with given shape. The given object will not be simulated (no PhysX, sound nor an interesting target for AI) allowing the placement of decorative objects with a very little network traffic.",
"ex": "decorativeTank = createObject [\"a3\u0007rmor_f_beta\u0007pc_tracked_01\u0007pc_tracked_01_rcws_f.p3d\", position]",
"exres": "",
"name": "createsimpleobject",
"op": "createsimpleobject",
"rname": "[shapeName / className, position]",
"since": "2.32"
}
],
"createSoundSource": [
{
"cat": "General",
"desc": "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.",
"ex": "soundSource = createSoundSource [\"LittleDog\", position player, [], 0]",
"exres": "",
"name": "createsoundsource",
"op": "createsoundsource",
"rname": "[type, position, markers, placement]",
"since": "2.32"
}
],
"createTeam": [
{
"cat": "Agents",
"desc": "Create a team and name it.",
"ex": "_team = createTeam [\"USMC_Team\", \"Fire Team Red\"]",
"exres": "",
"name": "createteam",
"op": "createteam",
"rname": "[type, name]",
"since": "2.90"
}
],
"createTrigger": [
{
"cat": "General",
"desc": "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. If global is false, detector is created only localy.",
"ex": "trigger = createTrigger[\"EmptyDetector\", position player, true]",
"exres": "",
"name": "createtrigger",
"op": "createtrigger",
"rname": "[type, position, global = true]",
"since": "1.86"
}
],
"createVehicle": [
{
"cat": "General",
"desc": "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\".",
"ex": "veh = createVehicle [\"Cobra\", position player, [], 0, \"FLY\"]",
"exres": "",
"name": "createvehicle",
"op": "createvehicle",
"rname": "[type, position, markers, placement, special]",
"since": "2.32"
}
],
"createVehicleCrew": [
{
"cat": "General",
"desc": "Creates crew to given vehicle.",
"ex": "createVehicleCrew vehicle0",
"exres": "",
"name": "createvehiclecrew",
"op": "createvehiclecrew",
"rname": "Vehicle",
"since": ""
}
],
"crew": [
{
"cat": "General",
"desc": "Returns all units mounted in the given vehicle. If the vehicle is not a vehicle, but person, a list containing only persons is returned.",
"ex": "crew vehicle player",
"exres": "",
"name": "crew",
"op": "crew",
"rname": "vehicle",
"since": ""
}
],
"ctrlActivate": [
{
"cat": "General",
"desc": "Launch actions attached to given (button based) control.",
"ex": "ctrlActivate _control",
"exres": "",
"name": "ctrlactivate",
"op": "ctrlactivate",
"rname": "control",
"since": "2.92"
}
],
"ctrlAngle": [
{
"cat": "General",
"desc": "Gets array of rotation info of the control in format: [angle, xCenter, yCenter]",
"ex": "_control ctrlAngle 0",
"exres": "",
"name": "ctrlangle",
"op": "ctrlangle",
"rname": "control",
"since": "2.50"
}
],
"ctrlAutoScrollDelay": [
{
"cat": "General",
"desc": "Returns number of seconds until auto-scroll starts. -2 if scrollbar not present.",
"ex": "_delay = ctrlAutoScrollDelay _control",
"exres": "",
"name": "ctrlautoscrolldelay",
"op": "ctrlautoscrolldelay",
"rname": "control",
"since": "5501"
}
],
"ctrlAutoScrollRewind": [
{
"cat": "General",
"desc": "True if auto-scroll should move back to start after it reach end.",
"ex": "_rewind = ctrlAutoScrollRewind _control",
"exres": "",
"name": "ctrlautoscrollrewind",
"op": "ctrlautoscrollrewind",
"rname": "control",
"since": "5501"
}
],
"ctrlAutoScrollSpeed": [
{
"cat": "General",
"desc": "Returns number of seconds to auto-scroll one line. -1 if auto-scroll is disabled. -2 if scrollbar not present.",
"ex": "_speed = ctrlAutoScrollSpeed _control",
"exres": "",
"name": "ctrlautoscrollspeed",
"op": "ctrlautoscrollspeed",
"rname": "control",
"since": "5501"
}
],
"ctrlChecked": [
{
"cat": "General",
"desc": "Returns the current state of textual checkbox.",
"ex": "_checked = ctrlChecked _control",
"exres": "",
"name": "ctrlchecked",
"op": "ctrlchecked",
"rname": "control",
"since": "2.50"
}
],
"ctrlClassName": [
{
"cat": "General",
"desc": "Returns class name of given control.",
"ex": "ctrlClassName ((FindDisplay 20000) displayCtrl 20001)",
"exres": "",
"name": "ctrlclassname",
"op": "ctrlclassname",
"rname": "control",
"since": ""
}
],
"ctrlCommitted": [
{
"cat": "General",
"desc": "Check if the control animation is finished.",
"ex": "_done = ctrlCommitted _control",
"exres": "",
"name": "ctrlcommitted",
"op": "ctrlcommitted",
"rname": "control",
"since": "2.50"
}
],
"ctrlDelete": [
{
"cat": "General",
"desc": "Deletes given control.",
"ex": "ctrlDelete ((FindDisplay 20000) displayCtrl 20001)",
"exres": "",
"name": "ctrldelete",
"op": "ctrldelete",
"rname": "control",
"since": ""
}
],
"ctrlEnable": [
{
"cat": "General",
"desc": "Enables / disables the control with id idc of the topmost user dialog.",
"ex": "ctrlEnable [100, false]",
"exres": "",
"name": "ctrlenable",
"op": "ctrlenable",
"rname": "[idc, enable]",
"since": "1.50"
}
],
"ctrlEnabled": [
{
"cat": "General",
"desc": "Returns whether given control is enabled.",
"ex": "_ok = ctrlEnabled _control",
"exres": "",
"name": "ctrlenabled",
"op": "ctrlenabled",
"rname": "control",
"since": "2.50"
},
{
"cat": "General",
"desc": "Returns whether the control with id idc of the topmost user dialog is enabled.",
"ex": "_enabled = ctrlEnabled 100",
"exres": "",
"name": "ctrlenabled",
"op": "ctrlenabled",
"rname": "idc",
"since": "1.50"
}
],
"ctrlFade": [
{
"cat": "General",
"desc": "Returns the current fade factor of control.",
"ex": "_scale = ctrlFade _control",
"exres": "",
"name": "ctrlfade",
"op": "ctrlfade",
"rname": "control",
"since": "2.50"
}
],
"ctrlHTMLLoaded": [
{
"cat": "General",
"desc": "Returns true when HTML content was successfully loaded.",
"ex": "_htmlLoaded ctrlHTMLLoaded _control",
"exres": "",
"name": "ctrlhtmlloaded",
"op": "ctrlhtmlloaded",
"rname": "control",
"since": "TOH 86547"
}
],
"ctrlIDC": [
{
"cat": "General",
"desc": "Returns control IDC.",
"ex": "IDC = ctrlIDC _control",
"exres": "",
"name": "ctrlidc",
"op": "ctrlidc",
"rname": "control",
"since": "A3 97270"
}
],
"ctrlIDD": [
{
"cat": "General",
"desc": "Returns display IDD.",
"ex": "IDD = ctrlIDD _display",
"exres": "",
"name": "ctrlidd",
"op": "ctrlidd",
"rname": "display",
"since": "A3 97270"
}
],
"ctrlMapAnimClear": [
{
"cat": "General",
"desc": "Clears the map animation.",
"ex": "",
"exres": "",
"name": "ctrlmapanimclear",
"op": "ctrlmapanimclear",
"rname": "control",
"since": "2.92"
}
],
"ctrlMapAnimCommit": [
{
"cat": "General",
"desc": "Plays the map animation.",
"ex": "",
"exres": "",
"name": "ctrlmapanimcommit",
"op": "ctrlmapanimcommit",
"rname": "control",
"since": "2.92"
}
],
"ctrlMapAnimDone": [
{
"cat": "General",
"desc": "Checks whether the map animation has finished.",
"ex": "",
"exres": "",
"name": "ctrlmapanimdone",
"op": "ctrlmapanimdone",
"rname": "control",
"since": "2.92"
}
],
"ctrlMapMouseOver": [
{
"cat": "General",
"desc": "Returns description of map sign mouse cursor is over in format [name<string>, id<GameValue>]. Recognized types: unit, vehicle, vehicleGroup, object, waypoint, trigger, marker, task, taskTooltip, customMark.",
"ex": "",
"exres": "",
"name": "ctrlmapmouseover",
"op": "ctrlmapmouseover",
"rname": "control",
"since": ""
}
],
"ctrlMapScale": [
{
"cat": "General",
"desc": "Return the current scale of the map control.",
"ex": "",
"exres": "",
"name": "ctrlmapscale",
"op": "ctrlmapscale",
"rname": "control",
"since": "2.92"
}
],
"ctrlModel": [
{
"cat": "General",
"desc": "Returns model setted in given control.",
"ex": "ctrlModel ((FindDisplay 20000) displayCtrl 20001)",
"exres": "",
"name": "ctrlmodel",
"op": "ctrlmodel",
"rname": "control",
"since": ""
}
],
"ctrlModelDirAndUp": [
{
"cat": "General",
"desc": "Returns orientation setted in given control.",
"ex": "ctrlModelOrientation ((FindDisplay 20000) displayCtrl 20001)",
"exres": "",
"name": "ctrlmodeldirandup",
"op": "ctrlmodeldirandup",
"rname": "control",
"since": ""
}
],
"ctrlModelScale": [
{
"cat": "General",
"desc": "Returns scale setted in given control object",
"ex": "ctrlModelScale ((FindDisplay 20000) displayCtrl 20001)",
"exres": "",
"name": "ctrlmodelscale",
"op": "ctrlmodelscale",
"rname": "control",
"since": ""
}
],
"ctrlParent": [
{
"cat": "General",
"desc": "Returns container of given control.",
"ex": "_display = ctrlParent _control",
"exres": "",
"name": "ctrlparent",
"op": "ctrlparent",
"rname": "control",
"since": "2.50"
}
],
"ctrlParentControlsGroup": [
{
"cat": "General",
"desc": "Returns parent control group of given control.",
"ex": "ctrlParentControlsGroup ctrl",
"exres": "",
"name": "ctrlparentcontrolsgroup",
"op": "ctrlparentcontrolsgroup",
"rname": "<Control>",
"since": ""
}
],
"ctrlPosition": [
{
"cat": "General",
"desc": "Returns the current position and size of control as [x, y, w, h] array.",
"ex": "_pos = ctrlPosition _control",
"exres": "",
"name": "ctrlposition",
"op": "ctrlposition",
"rname": "control",
"since": "2.50"
}
],
"ctrlScale": [
{
"cat": "General",
"desc": "Returns the current scale of control.",
"ex": "_scale = ctrlScale _control",
"exres": "",
"name": "ctrlscale",
"op": "ctrlscale",
"rname": "control",
"since": "5501"
}
],
"ctrlSetFocus": [
{
"cat": "General",
"desc": "Set the input focus on given control.",
"ex": "ctrlSetFocus _control",
"exres": "",
"name": "ctrlsetfocus",
"op": "ctrlsetfocus",
"rname": "control",
"since": "2.92"
}
],
"ctrlSetText": [
{
"cat": "General",
"desc": "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.",
"ex": "ctrlSetText [100, \"Hello, world\"]",
"exres": "",
"name": "ctrlsettext",
"op": "ctrlsettext",
"rname": "[idc, text]",
"since": "1.50"
}
],
"ctrlShow": [
{
"cat": "General",
"desc": "Shows / hides the control with id idc of the topmost user dialog.",
"ex": "ctrlShow [100, true]",
"exres": "",
"name": "ctrlshow",
"op": "ctrlshow",
"rname": "[idc, show]",
"since": "1.50"
}
],
"ctrlShown": [
{
"cat": "General",
"desc": "Returns whether given control is shown.",
"ex": "_ok = ctrlShown _control",
"exres": "",
"name": "ctrlshown",
"op": "ctrlshown",
"rname": "control",
"since": "2.50"
}
],
"ctrlText": [
{
"cat": "General",
"desc": "Returns the text shown in given control.",
"ex": "_text = ctrlText _control",
"exres": "",
"name": "ctrltext",
"op": "ctrltext",
"rname": "control",
"since": "2.50"
},
{
"cat": "General",
"desc": "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.",
"ex": "_message = ctrlText 100",
"exres": "",
"name": "ctrltext",
"op": "ctrltext",
"rname": "idc",
"since": "1.50"
}
],
"ctrlTextHeight": [
{
"cat": "General",
"desc": "Returns the text height.",
"ex": "h = ctrlTextHeight _control",
"exres": "",
"name": "ctrltextheight",
"op": "ctrltextheight",
"rname": "structuredText control",
"since": "TOH 84677"
}
],
"ctrlTextSecondary": [
{
"cat": "General",
"desc": "Returns the secondary text of the given control (if control is supporting a secondary text).",
"ex": "_text = ctrlTextSecondary _control",
"exres": "",
"name": "ctrltextsecondary",
"op": "ctrltextsecondary",
"rname": "control",
"since": ""
}
],
"ctrlType": [
{
"cat": "General",
"desc": "Returns value representing type of control.",
"ex": "_type = ctrlType _control",
"exres": "",
"name": "ctrltype",
"op": "ctrltype",
"rname": "control",
"since": "2.56"
}
],
"ctrlVisible": [
{
"cat": "General",
"desc": "Returns whether the control with id idc of the topmost user dialog is visible.",
"ex": "_visible = ctrlVisible 100",
"exres": "",
"name": "ctrlvisible",
"op": "ctrlvisible",
"rname": "idc",
"since": "1.50"
}
],
"curatorAddons": [
{
"cat": "General",
"desc": "Return list of addons allowed to given curator.",
"ex": "",
"exres": "",
"name": "curatoraddons",
"op": "curatoraddons",
"rname": "curatorObj",
"since": ""
}
],
"curatorCameraArea": [
{
"cat": "General",
"desc": "Return all curator camera areas.",
"ex": "",
"exres": "",
"name": "curatorcameraarea",
"op": "curatorcameraarea",
"rname": "curatorObj",
"since": ""
}
],
"curatorCameraAreaCeiling": [
{
"cat": "General",
"desc": "Return ceiling height for curator camera.",
"ex": "",
"exres": "",
"name": "curatorcameraareaceiling",
"op": "curatorcameraareaceiling",
"rname": "curatorObj",
"since": ""
}
],
"curatorEditableObjects": [
{
"cat": "General",
"desc": "Return all editable objects which belongs to a curator.",
"ex": "",
"exres": "",
"name": "curatoreditableobjects",
"op": "curatoreditableobjects",
"rname": "curatorObj",
"since": ""
}
],
"curatorEditingArea": [
{
"cat": "General",
"desc": "Returns all curator editing areas",
"ex": "",
"exres": "",
"name": "curatoreditingarea",
"op": "curatoreditingarea",
"rname": "curatorObj",
"since": ""
}
],
"curatorEditingAreaType": [
{
"cat": "General",
"desc": "Returns type of edit areas assigned to curator (blacklist/whitelist).",
"ex": "",
"exres": "",
"name": "curatoreditingareatype",
"op": "curatoreditingareatype",
"rname": "obj",
"since": ""
}
],
"curatorPoints": [
{
"cat": "General",
"desc": "Return number of points that curator have.",
"ex": "",
"exres": "",
"name": "curatorpoints",
"op": "curatorpoints",
"rname": "curatorObj",
"since": ""
}
],
"curatorRegisteredObjects": [
{
"cat": "General",
"desc": "Returns array with all objects that has curator registered and their settings.",
"ex": "",
"exres": "",
"name": "curatorregisteredobjects",
"op": "curatorregisteredobjects",
"rname": "curatorObj",
"since": ""
}
],
"curatorWaypointCost": [
{
"cat": "General",
"desc": "Return current price for placing waypoints (curator specific).",
"ex": "",
"exres": "",
"name": "curatorwaypointcost",
"op": "curatorwaypointcost",
"rname": "curatorObj",
"since": ""
}
],
"currentCommand": [
{
"cat": "General",
"desc": "Return the current command type (empty string when no command).",
"ex": "",
"exres": "",
"name": "currentcommand",
"op": "currentcommand",
"rname": "vehicle",
"since": "2.92"
}
],
"currentMagazine": [
{
"cat": "General",
"desc": "Return the name of the type of the currently using magazine (on the primary turret for vehicles).",
"ex": "",
"exres": "",
"name": "currentmagazine",
"op": "currentmagazine",
"rname": "vehicle",
"since": "5500"
}
],
"currentMagazineDetail": [
{
"cat": "General",
"desc": "Return the name of the type of the currently using magazine (on the primary turret for vehicles).",
"ex": "",
"exres": "",
"name": "currentmagazinedetail",
"op": "currentmagazinedetail",
"rname": "vehicle",
"since": "5500"
}
],
"currentMuzzle": [
{
"cat": "General",
"desc": "Returns current muzzle of unit's weapon.",
"ex": "",
"exres": "",
"name": "currentmuzzle",
"op": "currentmuzzle",
"rname": "gunner",
"since": "5501"
}
],
"currentTask": [
{
"cat": "Identity",
"desc": "Return current task of given person.",
"ex": "",
"exres": "",
"name": "currenttask",
"op": "currenttask",
"rname": "person",
"since": "5501"
}
],
"currentTasks": [
{
"cat": "Identity",
"desc": "List all uncompleted tasks.",
"ex": "",
"exres": "",
"name": "currenttasks",
"op": "currenttasks",
"rname": "teamMember",
"since": "2.91"
}
],
"currentThrowable": [
{
"cat": "General",
"desc": "Return the array with information about the currently selected throwable weapon in format [selectedThrowableMagazineClassName, selectedThrowMuzzle>, [id,creatorofthemagazine]].",
"ex": "",
"exres": "",
"name": "currentthrowable",
"op": "currentthrowable",
"rname": "player(soldier)",
"since": "5500"
}
],
"currentVisionMode": [
{
"cat": "General",
"desc": "Returns vision mode of unit's weapon. 0-dayTime, 1-night vision, 2-FLIR ",
"ex": "",
"exres": "",
"name": "currentvisionmode",
"op": "currentvisionmode",
"rname": "gunner",
"since": "5501"
}
],
"currentWaypoint": [
{
"cat": "General",
"desc": "Return the index of the current waypoint.",
"ex": "",
"exres": "",
"name": "currentwaypoint",
"op": "currentwaypoint",
"rname": "group",
"since": "5500"
}
],
"currentWeapon": [
{
"cat": "General",
"desc": "Return the name of the currently selected weapon (on the primary turret for vehicles).",
"ex": "",
"exres": "",
"name": "currentweapon",
"op": "currentweapon",
"rname": "vehicle",
"since": "5500"
}
],
"currentWeaponMode": [
{
"cat": "General",
"desc": "Returns current weapon mode of unit's weapon.",
"ex": "",
"exres": "",
"name": "currentweaponmode",
"op": "currentweaponmode",
"rname": "gunner",
"since": "5501"
}
],
"currentZeroing": [
{
"cat": "General",
"desc": "Returns zeroing of unit's weapon.",
"ex": "",
"exres": "",
"name": "currentzeroing",
"op": "currentzeroing",
"rname": "gunner",
"since": "5501"
}
],
"cutObj": [
{
"cat": "General",
"desc": "Object background - the argument uses format [\"name\",\"type\",speed, showInMap] or [\"name\",\"type\"]. If speed is not given, it's assumed to be one.\r\nThe object can be defined in the description.ext file.",
"ex": "cutObj [\"TVSet\", \"plain\"]",
"exres": "",
"name": "cutobj",
"op": "cutobj",
"rname": "effect",
"since": ""
}
],
"cutRsc": [
{
"cat": "General",
"desc": "Resource background - the argument uses format [\"name\",\"type\",speed, showInMap] or [\"name\",\"type\"]. If speed is not given, it's assumed to be one.\r\nThe resource can be defined in the description.ext file.",
"ex": "cutRsc [\"binocular\", \"PLAIN\"]",
"exres": "",
"name": "cutrsc",
"op": "cutrsc",
"rname": "effect",
"since": ""
}
],
"cutText": [
{
"cat": "General",
"desc": "Text background - the argument uses format [\"text\",\"type\",speed, showInMap] 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\".",
"ex": "cutText [\"\", \"BLACK OUT\"]",
"exres": "",
"name": "cuttext",
"op": "cuttext",
"rname": "effect",
"since": ""
}
],
"damage": [
{
"cat": "General",
"desc": "Returns the object damage in a range of 0 to 1. Note: this function is identical to <f>getDammage</f>.",
"ex": "damage player",
"exres": "",
"name": "damage",
"op": "damage",
"rname": "object",
"since": "1.50"
}
],
"dateToNumber": [
{
"cat": "General",
"desc": "Convert date to float number.",
"ex": "time = DateToNumber [year,month,day,hour,minute]",
"exres": "",
"name": "datetonumber",
"op": "datetonumber",
"rname": "date",
"since": "5501"
}
],
"deActivateKey": [
{
"cat": "General",
"desc": "Deactivates the given key from 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.",
"ex": "deActivateKey \"M04\"",
"exres": "",
"name": "deactivatekey",
"op": "deactivatekey",
"rname": "keyName",
"since": "93436"
}
],
"debriefingText": [
{
"cat": "General",
"desc": "Return debriefing text.",
"ex": "",
"exres": "",
"name": "debriefingtext",
"op": "debriefingtext",
"rname": "end",
"since": "81571"
}
],
"debugLog": [
{
"cat": "General",
"desc": "Dumps the argument's type and value to the debugging output.",
"ex": "debugLog player",
"exres": "",
"name": "debuglog",
"op": "debuglog",
"rname": "anything",
"since": ""
}
],
"default": [
{
"cat": "Default",
"desc": "see switch",
"ex": "",
"exres": "",
"name": "default",
"op": "default",
"rname": "a",
"since": ""
}
],
"deg": [
{
"cat": "Default",
"desc": "Converts x from radians to degrees.",
"ex": "deg 1",
"exres": "57.295",
"name": "deg",
"op": "deg",
"rname": "x",
"since": ""
}
],
"delete3DENEntities": [
{
"cat": "General",
"desc": "Deletes all given entities from 3DEN and adds entry to history.",
"ex": "",
"exres": "",
"name": "delete3denentities",
"op": "delete3denentities",
"rname": "<entities>",
"since": ""
}
],
"deleteCenter": [
{
"cat": "General",
"desc": "Destroys the AI center of the given side.",
"ex": "deleteCenter East",
"exres": "",
"name": "deletecenter",
"op": "deletecenter",
"rname": "side",
"since": "1.86"
}
],
"deleteCollection": [
{
"cat": "General",
"desc": "same as hideObject.",
"ex": "",
"exres": "",
"name": "deletecollection",
"op": "deletecollection",
"rname": "object",
"since": "2.90"
}
],
"deleteGroup": [
{
"cat": "General",
"desc": "Destroys the given AI group.",
"ex": "deleteGroup group",
"exres": "",
"name": "deletegroup",
"op": "deletegroup",
"rname": "group",
"since": ""
}
],
"deleteIdentity": [
{
"cat": "General",
"desc": "Deletes an identity created by saveIdentity from the campaign progress file.",
"ex": "deleteIdentity \"playerIdentity\"",
"exres": "",
"name": "deleteidentity",
"op": "deleteidentity",
"rname": "identityName",
"since": "1.75"
}
],
"deleteLocation": [
{
"cat": "Location",
"desc": "Delete the given location.",
"ex": "",
"exres": "",
"name": "deletelocation",
"op": "deletelocation",
"rname": "location",
"since": "2.90"
}
],
"deleteMarker": [
{
"cat": "General",
"desc": "Destroys the given marker. The marker is destroyed on all computers in a network session.",
"ex": "deleteMarker \"Marker1\"",
"exres": "",
"name": "deletemarker",
"op": "deletemarker",
"rname": "name",
"since": ""
}
],
"deleteMarkerLocal": [
{
"cat": "General",
"desc": "Destroys the given marker. The marker is only destroyed on the computer where the command is called.",
"ex": "deleteMarkerLocal \"Marker1\"",
"exres": "",
"name": "deletemarkerlocal",
"op": "deletemarkerlocal",
"rname": "name",
"since": "2.92"
}
],
"deleteSite": [
{
"cat": "General",
"desc": "Removes the site.",
"ex": "deleteSite tank",
"exres": "",
"name": "deletesite",
"op": "deletesite",
"rname": "site",
"since": "1.34"
}
],
"deleteStatus": [
{
"cat": "General",
"desc": "Deletes a status created by saveStatus from the campaign progress file.",
"ex": "deleteStatus \"playerState\"",
"exres": "",
"name": "deletestatus",
"op": "deletestatus",
"rname": "statusName",
"since": "1.75"
}
],
"deleteTeam": [
{
"cat": "Agents",
"desc": "Destroy given team.",
"ex": "deleteTeam _team",
"exres": "",
"name": "deleteteam",
"op": "deleteteam",
"rname": "team",
"since": "2.90"
}
],
"deleteVehicle": [
{
"cat": "General",
"desc": "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.",
"ex": "deleteVehicle tank",
"exres": "",
"name": "deletevehicle",
"op": "deletevehicle",
"rname": "object",
"since": "1.34"
}
],
"deleteWaypoint": [
{
"cat": "General",
"desc": "Removes the waypoint.",
"ex": "deleteWaypoint [grp, 2]",
"exres": "",
"name": "deletewaypoint",
"op": "deletewaypoint",
"rname": "waypoint",
"since": "1.86"
}
],
"detach": [
{
"cat": "General",
"desc": "Detaches an object.",
"ex": "detach player",
"exres": "",
"name": "detach",
"op": "detach",
"rname": "obj",
"since": "5501"
}
],
"detectedMines": [
{
"cat": "General",
"desc": "Returns list af all mines detected by given side.",
"ex": "detectedMines (side player)",
"exres": "",
"name": "detectedmines",
"op": "detectedmines",
"rname": "side",
"since": ""
}
],
"diag_captureFrame": [
{
"cat": "PerfLog",
"desc": "Capture the single frame, following after the number frames given as parameter.",
"ex": "",
"exres": "",
"name": "diag_captureframe",
"op": "diag_captureframe",
"rname": "frameNo",
"since": "5501"
}
],
"diag_captureFrameToFile": [
{
"cat": "PerfLog",
"desc": "Capture the single frame, following after the number frames given as parameter. Saves output into generated file.",
"ex": "",
"exres": "",
"name": "diag_captureframetofile",
"op": "diag_captureframetofile",
"rname": "frameNo",
"since": "115598"
}
],
"diag_captureSlowFrame": [
{
"cat": "PerfLog",
"desc": "Capture the first frame after offset frame, where section takes longer than the threshold (in seconds).",
"ex": "diag_captureSlowFrame [\"total\", 0.1, 0]",
"exres": "",
"name": "diag_captureslowframe",
"op": "diag_captureslowframe",
"rname": "[section, threshold, offset]",
"since": "5501"
}
],
"diag_codePerformance": [
{
"cat": "General",
"desc": "Runs the given code given number of times and then returns average time",
"ex": "diag_codePerformance [{a = 123;}, [], 10]",
"exres": "",
"name": "diag_codeperformance",
"op": "diag_codeperformance",
"rname": "[code, (arguments), (cycles)]",
"since": ""
}
],
"diag_dynamicSimulationEnd": [
{
"cat": "General",
"desc": "Ends dynamic simulation stats gathering and writes results into given file",
"ex": "diag_dynamicSimulationEnd dynSimLog",
"exres": "",
"name": "diag_dynamicsimulationend",
"op": "diag_dynamicsimulationend",
"rname": "filePath",
"since": ""
}
],
"diag_log": [
{
"cat": "General",
"desc": "Dumps the argument's type and value to the report file.",
"ex": "diag_log player",
"exres": "",
"name": "diag_log",
"op": "diag_log",
"rname": "anything",
"since": "5501"
}
],
"diag_logSlowFrame": [
{
"cat": "PerfLog",
"desc": "Log all frames, where section takes longer than the threshold (in seconds).",
"ex": "",
"exres": "",
"name": "diag_logslowframe",
"op": "diag_logslowframe",
"rname": "[section, threshold]",
"since": "5501"
}
],
"didJIPOwner": [
{
"cat": "General",
"desc": "Returns true if the current owner of given object has joined the game in progress, works only on Server, returns false on clients or in single player.",
"ex": "",
"exres": "",
"name": "didjipowner",
"op": "didjipowner",
"rname": "object",
"since": ""
}
],
"difficultyEnabled": [
{
"cat": "General",
"desc": "Obsolete. Use difficultyOption instead.",
"ex": "",
"exres": "",
"name": "difficultyenabled",
"op": "difficultyenabled",
"rname": "flag",
"since": "5127"
}
],
"difficultyOption": [
{
"cat": "General",
"desc": "Returns current value of given difficulty option. For possible values of option, see config class Options in CfgDificultyPresets.",
"ex": "difficultyOption \"friendlyTag\"",
"exres": "",
"name": "difficultyoption",
"op": "difficultyoption",
"rname": "option",
"since": ""
}
],
"direction": [
{
"cat": "General",
"desc": "Returns the object heading in the range of 0 to 360.",
"ex": "direction player",
"exres": "",
"name": "direction",
"op": "direction",
"rname": "object",
"since": "1.50"
},
{
"cat": "Location",
"desc": "Return direction (angle) of given location.",
"ex": "",
"exres": "",
"name": "direction",
"op": "direction",
"rname": "location",
"since": "2.90"
}
],
"disableRemoteSensors": [
{
"cat": "General",
"desc": "Units, that are not in a group with at least one local member, will not check visibility of other units. This will cause, that remote units will not have updated knowsAbout and it will save some CPU time.",
"ex": "disableRemoteSensors true",
"exres": "",
"name": "disableremotesensors",
"op": "disableremotesensors",
"rname": "bool",
"since": ""
}
],
"disableUserInput": [
{
"cat": "General",
"desc": "Disables all user input. This is normally used only in cutscenes to disable the player's controls.",
"ex": "",
"exres": "",
"name": "disableuserinput",
"op": "disableuserinput",
"rname": "disable",
"since": ""
}
],
"displayParent": [
{
"cat": "General",
"desc": "Returns the parent of a given diplay.",
"ex": "_display = displayParent _display",
"exres": "",
"name": "displayparent",
"op": "displayparent",
"rname": "display",
"since": ""
}
],
"dissolveTeam": [
{
"cat": "General",
"desc": "Dissolves the given team. All members become members of the main team. Possible team values are: \"RED\", \"GREEN\", \"BLUE\" or \"YELLOW\".",
"ex": "dissolveTeam \"RED\"",
"exres": "",
"name": "dissolveteam",
"op": "dissolveteam",
"rname": "team",
"since": "2.05"
}
],
"do3DENAction": [
{
"cat": "General",
"desc": "Processes given editor operation.",
"ex": "",
"exres": "",
"name": "do3denaction",
"op": "do3denaction",
"rname": "operation",
"since": ""
}
],
"doGetOut": [
{
"cat": "General",
"desc": "Orders a unit to get out from the vehicle (silently).",
"ex": "doGetOut unitOne",
"exres": "",
"name": "dogetout",
"op": "dogetout",
"rname": "unit",
"since": "2.28"
}
],
"doStop": [
{
"cat": "General",
"desc": "Orders the unit to stop (silently).\r\nNote: the stop command is never finished; the unit will never be ready.",
"ex": "doStop unitOne",
"exres": "",
"name": "dostop",
"op": "dostop",
"rname": "unit",
"since": ""
}
],
"drawIcon3D": [
{
"cat": "General",
"desc": "Draws an ingame icon at a given position.",
"ex": "drawIcon3D [\"#(argb,8,8,3)color(0,0.5,1,1)\", [1,1,1,1], position cursorTarget, 1, 1, 45, \"Target\", 1, 0.05, \"TahomaB\", \"left\", true]",
"exres": "",
"name": "drawicon3d",
"op": "drawicon3d",
"rname": "[texture, color, position, width, height, angle, text, shadow, textSize, font, textAlignment, drawSideArrows]",
"since": ""
}
],
"drawLine3D": [
{
"cat": "General",
"desc": "Draws a line of a given COLOR from START to END.",
"ex": "drawLine3D [position soldier, position cursorTarget, [1,1,1,1]]",
"exres": "",
"name": "drawline3d",
"op": "drawline3d",
"rname": "[start, end, color]",
"since": ""
}
],
"driver": [
{
"cat": "General",
"desc": "Returns the driver of the vehicle. If the vehicle is not a vehicle, but a person, the person is returned instead.",
"ex": "driver vehicle player",
"exres": "",
"name": "driver",
"op": "driver",
"rname": "vehicle",
"since": ""
}
],
"drop": [
{
"cat": "General",
"desc": "Drops a particle into the scene. Array is in format <ar>ParticleArray</ar>.",
"ex": "",
"exres": "",
"name": "drop",
"op": "drop",
"rname": "array",
"since": "1.50"
}
],
"dynamicSimulationDistance": [
{
"cat": "General",
"desc": "Returns what activation distance is set for given activation category. The recognized activation categories are \"Group\", \"Vehicle\", \"EmptyVehicle\" and \"Prop\".",
"ex": "dynamicSimulationDistance \"group\"",
"exres": "",
"name": "dynamicsimulationdistance",
"op": "dynamicsimulationdistance",
"rname": "dynamicSimulationClass",
"since": ""
}
],
"dynamicSimulationDistanceCoef": [
{
"cat": "General",
"desc": "Returns value of the given activation distance multiplier. Currently the only recognized activation multiplier is \"IsMoving\"",
"ex": "dynamicSimulationDistanceCoef \"IsMoving\"",
"exres": "",
"name": "dynamicsimulationdistancecoef",
"op": "dynamicsimulationdistancecoef",
"rname": "dynamicSimulationCoefClass",
"since": ""
}
],
"dynamicSimulationEnabled": [
{
"cat": "General",
"desc": "Returns if dynamic simulation is on for given object",
"ex": "dynamicSimulationEnabled table1",
"exres": "",
"name": "dynamicsimulationenabled",
"op": "dynamicsimulationenabled",
"rname": "entity",
"since": ""
},
{
"cat": "General",
"desc": "Returns if dynamic simulation is on for given group",
"ex": "dynamicSimulationEnabled (group soldier1)",
"exres": "",
"name": "dynamicsimulationenabled",
"op": "dynamicsimulationenabled",
"rname": "group",
"since": ""
}
],
"echo": [
{
"cat": "Default",
"desc": "Sends any text into the debugger console or the logfile.",
"ex": "echo \"Text in logfile\"",
"exres": "",
"name": "echo",
"op": "echo",
"rname": "text",
"since": "2.00"
}
],
"edit3DENMissionAttributes": [
{
"cat": "General",
"desc": "Openes configuration for given global attribute type.",
"ex": "",
"exres": "",
"name": "edit3denmissionattributes",
"op": "edit3denmissionattributes",
"rname": "<global attribute type>",
"since": ""
}
],
"effectiveCommander": [
{
"cat": "General",
"desc": "Returns the effective commander (who really commands) of the vehicle.",
"ex": "",
"exres": "",
"name": "effectivecommander",
"op": "effectivecommander",
"rname": "vehicle",
"since": "2.92"
}
],
"enableAudioFeature": [
{
"cat": "General",
"desc": "Enable/disable audio feature, features are: { \"lowpass\", \"building_interior\" }. Return previous state",
"ex": "prevState = enableAudioFeature [\"lowpass\", true]",
"exres": "",
"name": "enableaudiofeature",
"op": "enableaudiofeature",
"rname": "[audio feature name, enable/disable]",
"since": "129510"
}
],
"enableCamShake": [
{
"cat": "General",
"desc": "Enables/disables camera shakes.",
"ex": "",
"exres": "",
"name": "enablecamshake",
"op": "enablecamshake",
"rname": "true/false",
"since": "5501"
}
],
"enableCaustics": [
{
"cat": "General",
"desc": "Enable/disable caustics drawing.",
"ex": "",
"exres": "",
"name": "enablecaustics",
"op": "enablecaustics",
"rname": "enable",
"since": "81571"
}
],
"enableDebriefingStats": [
{
"cat": "General",
"desc": "Enable debriefing score table. The table will be displayed at specified coordinates.",
"ex": "enableDebriefingStats [0.1, 0.1, 0.8, 0.8]",
"exres": "",
"name": "enabledebriefingstats",
"op": "enabledebriefingstats",
"rname": "[left, top, width, height]",
"since": ""
}
],
"enableDiagLegend": [
{
"cat": "General",
"desc": "Enable or disable legend for diagnostic",
"ex": "enableDiagLegend false",
"exres": "",
"name": "enablediaglegend",
"op": "enablediaglegend",
"rname": "true/false",
"since": ""
}
],
"enableDynamicSimulationSystem": [
{
"cat": "General",
"desc": "Enables or disables whole dynamic simulation system",
"ex": "enableDynamicSimulation true",
"exres": "",
"name": "enabledynamicsimulationsystem",
"op": "enabledynamicsimulationsystem",
"rname": "enable",
"since": ""
}
],
"enableEngineArtillery": [
{
"cat": "General",
"desc": "Enables/disables engine's artillery.",
"ex": "",
"exres": "",
"name": "enableengineartillery",
"op": "enableengineartillery",
"rname": "true/false",
"since": "5501"
}
],
"enableEnvironment": [
{
"cat": "General",
"desc": "Enable/disable environmental effects (ambient life + sound).",
"ex": "enableEnvironment false or enableEnvironment [<enableAgents:Bool>,<enableSounds:Bool>]",
"exres": "",
"name": "enableenvironment",
"op": "enableenvironment",
"rname": "enabled",
"since": "2.92"
}
],
"enableRadio": [
{
"cat": "General",
"desc": "Enables radio transmissions to be heard and seen on screen.",
"ex": "",
"exres": "",
"name": "enableradio",
"op": "enableradio",
"rname": "enable",
"since": ""
}
],
"enableSatNormalOnDetail": [
{
"cat": "General",
"desc": "Enables/disables satellite normal map od detail maps.",
"ex": "",
"exres": "",
"name": "enablesatnormalondetail",
"op": "enablesatnormalondetail",
"rname": "true/false",
"since": "5501"
}
],
"enableSaving": [
{
"cat": "General",
"desc": "Enable / disable saving of the game. When disabled, the autosave is created (if not forbidden by save == false).",
"ex": "",
"exres": "",
"name": "enablesaving",
"op": "enablesaving",
"rname": "enable or [enable, save]",
"since": "5501"
}
],
"enableSentences": [
{
"cat": "General",
"desc": "Enables radio transmissions to be heard and seen on screen. It does not affect KBTell conversations.",
"ex": "",
"exres": "",
"name": "enablesentences",
"op": "enablesentences",
"rname": "enable",
"since": ""
}
],
"enableStressDamage": [
{
"cat": "General",
"desc": "Enable stress damage.",
"ex": "",
"exres": "",
"name": "enablestressdamage",
"op": "enablestressdamage",
"rname": "enable",
"since": "83393 TOH"
}
],
"enableTeamSwitch": [
{
"cat": "General",
"desc": "Enable / disable team switch.",
"ex": "",
"exres": "",
"name": "enableteamswitch",
"op": "enableteamswitch",
"rname": "enable",
"since": "2.92"
}
],
"enableTraffic": [
{
"cat": "General",
"desc": "Enable ambient traffic.",
"ex": "",
"exres": "",
"name": "enabletraffic",
"op": "enabletraffic",
"rname": "enable",
"since": "83700 TOH"
}
],
"enableWeaponDisassembly": [
{
"cat": "General",
"desc": "Controls player ability to disassemble any object",
"ex": "enableWeaponDisassembly false",
"exres": "",
"name": "enableweapondisassembly",
"op": "enableweapondisassembly",
"rname": "bool",
"since": ""
}
],
"endMission": [
{
"cat": "General",
"desc": "Finish the mission. The end type can be \"CONTINUE\", \"KILLED\", \"LOSER\", \"END1\", \"END2\", \"END3\", \"END4\", \"END5\", or \"END6\".",
"ex": "",
"exres": "",
"name": "endmission",
"op": "endmission",
"rname": "end type",
"since": "5501"
}
],
"enginesIsOnRTD": [
{
"cat": "General",
"desc": "Returns which engines are producing some work.",
"ex": "",
"exres": "",
"name": "enginesisonrtd",
"op": "enginesisonrtd",
"rname": "RTD_helicopter",
"since": "81393 TOH"
}
],
"enginesPowerRTD": [
{
"cat": "General",
"desc": "Power produced by engines in Watts.",
"ex": "",
"exres": "",
"name": "enginespowerrtd",
"op": "enginespowerrtd",
"rname": "RTD_Helicopter",
"since": "87008 TOH"
}
],
"enginesRpmRTD": [
{
"cat": "General",
"desc": "Returns all engines RPM.",
"ex": "",
"exres": "",
"name": "enginesrpmrtd",
"op": "enginesrpmrtd",
"rname": "RTD_helicopter",
"since": "TOH 81393"
}
],
"enginesTorqueRTD": [
{
"cat": "General",
"desc": "Torque produced by engines in Newton*meter.",
"ex": "",
"exres": "",
"name": "enginestorquertd",
"op": "enginestorquertd",
"rname": "RTD_Helicopter",
"since": "87008 TOH"
}
],
"entities": [
{
"cat": "General",
"desc": "Returns a list of entities with given type. ",
"ex": "entities \"Car\"",
"exres": "",
"name": "entities",
"op": "entities",
"rname": "type",
"since": "OA 94061"
},
{
"cat": "General",
"desc": "Returns a list of entities with given type. ",
"ex": "entities \"Car\"",
"exres": "",
"name": "entities",
"op": "entities",
"rname": "[includedClasses:array,excludedClasses:array]",
"since": "OA 94061"
}
],
"estimatedTimeLeft": [
{
"cat": "General",
"desc": "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.",
"ex": "estimatedTimeLeft Param1",
"exres": "",
"name": "estimatedtimeleft",
"op": "estimatedtimeleft",
"rname": "timeLeft",
"since": "1.34"
}
],
"everyBackpack": [
{
"cat": "General",
"desc": "Returns array of backpacks stored in given crate .e.g. used for accessing backpack content of a backpack on ground.",
"ex": "everyBackpack cursorTarget",
"exres": "",
"name": "everybackpack",
"op": "everybackpack",
"rname": "box",
"since": ""
}
],
"everyContainer": [
{
"cat": "General",
"desc": "Returns array of all containers(uniforms, vest, backpacks) stored in given crate .e.g. used for accessing container's content stored into ammoBox or ground.",
"ex": "everyContainer cursorTarget",
"exres": "",
"name": "everycontainer",
"op": "everycontainer",
"rname": "box",
"since": ""
}
],
"execFSM": [
{
"cat": "General",
"desc": "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.",
"ex": "execFSM \"test.fsm\"",
"exres": "",
"name": "execfsm",
"op": "execfsm",
"rname": "filename",
"since": "5500"
}
],
"execVM": [
{
"cat": "General",
"desc": "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.",
"ex": "execVM \"test.sqf\"",
"exres": "",
"name": "execvm",
"op": "execvm",
"rname": "filename",
"since": "2.58"
}
],
"exp": [
{
"cat": "Default",
"desc": "The exponential value of x.",
"ex": "exp 1",
"exres": "2.7182",
"name": "exp",
"op": "exp",
"rname": "x",
"since": ""
}
],
"expectedDestination": [
{
"cat": "General",
"desc": "Return expected destination of unit as a [position, planningMode, forceReplan].",
"ex": "",
"exres": "",
"name": "expecteddestination",
"op": "expecteddestination",
"rname": "person",
"since": "2.92"
}
],
"exportJIPMessages": [
{
"cat": "General",
"desc": "Exports list of JIP messages to a file.",
"ex": "exportJIPMessages \"myFileNameWithoutExtension\"",
"exres": "",
"name": "exportjipmessages",
"op": "exportjipmessages",
"rname": "filename",
"since": ""
}
],
"eyeDirection": [
{
"cat": "General",
"desc": "Returns the direction object is watching (eyes, or a vehicle primary observer).",
"ex": "eyeDirection player",
"exres": "",
"name": "eyedirection",
"op": "eyedirection",
"rname": "unit",
"since": "OA 93619"
}
],
"eyePos": [
{
"cat": "General",
"desc": "Returns the position of the object eye in format <ar>PositionASL</ar>.",
"ex": "eyePos player",
"exres": "",
"name": "eyepos",
"op": "eyepos",
"rname": "obj",
"since": "OA 93598"
}
],
"face": [
{
"cat": "General",
"desc": "Returns the face from identity of given object.",
"ex": "face player",
"exres": "",
"name": "face",
"op": "face",
"rname": "object",
"since": ""
}
],
"faction": [
{
"cat": "General",
"desc": "Gets unit faction. If faction is not defined, returns empty string.",
"ex": "",
"exres": "",
"name": "faction",
"op": "faction",
"rname": "unit",
"since": "5501"
}
],
"failMission": [
{
"cat": "General",
"desc": "Finish the mission. The end type can be \"CONTINUE\", \"KILLED\", \"LOSER\", \"END1\", \"END2\", \"END3\", \"END4\", \"END5\", or \"END6\". Mission saves will not be deleted.",
"ex": "",
"exres": "",
"name": "failmission",
"op": "failmission",
"rname": "end type",
"since": "5501"
}
],
"fillWeaponsFromPool": [
{
"cat": "General",
"desc": "Adds magazines from the campaign pool to the person (depending on the weapons the person has).",
"ex": "fillWeaponsFromPool victor",
"exres": "",
"name": "fillweaponsfrompool",
"op": "fillweaponsfrompool",
"rname": "person",
"since": "1.75"
}
],
"findDisplay": [
{
"cat": "General",
"desc": "Find display by its IDD.",
"ex": "_display = findDisplay 1",
"exres": "",
"name": "finddisplay",
"op": "finddisplay",
"rname": "idd",
"since": "2.54"
}
],
"finite": [
{
"cat": "Default",
"desc": "True, if number is finite (not infinite and valid number)",
"ex": "finite 10/0",
"exres": "false",
"name": "finite",
"op": "finite",
"rname": "x",
"since": ""
}
],
"firstBackpack": [
{
"cat": "General",
"desc": "Returns object of the first stored backpack in another weaponholder.e.g. used for accessing backpack content of a backpack on ground.",
"ex": "firstBackpack cursorTarget",
"exres": "",
"name": "firstbackpack",
"op": "firstbackpack",
"rname": "box",
"since": ""
}
],
"flag": [
{
"cat": "General",
"desc": "If the unit has a flag, this flag is returned.\r\nIf not, objNull is returned.",
"ex": "flag player",
"exres": "",
"name": "flag",
"op": "flag",
"rname": "unit",
"since": ""
}
],
"flagAnimationPhase": [
{
"cat": "General",
"desc": "Returns current animations phase of a flag",
"ex": "",
"exres": "",
"name": "flaganimationphase",
"op": "flaganimationphase",
"rname": "flag",
"since": ""
}
],
"flagOwner": [
{
"cat": "General",
"desc": "When used on a flag, the returned value is the person that has this flag.\r\nWhen used on anything else, objNull is returned.",
"ex": "flagowner flagOne",
"exres": "",
"name": "flagowner",
"op": "flagowner",
"rname": "flag",
"since": ""
}
],
"flagSide": [
{
"cat": "General",
"desc": "Returns the current side of the flag.",
"ex": "flagSide flag1",
"exres": "",
"name": "flagside",
"op": "flagside",
"rname": "flagpole",
"since": ""
}
],
"flagTexture": [
{
"cat": "General",
"desc": "Returns the current texture of the flag.",
"ex": "flagTexture flag1",
"exres": "",
"name": "flagtexture",
"op": "flagtexture",
"rname": "flagcarrier",
"since": ""
}
],
"fleeing": [
{
"cat": "General",
"desc": "Checks whether the unit is fleeing. A dead or empty unit returns false.",
"ex": "fleeing player",
"exres": "",
"name": "fleeing",
"op": "fleeing",
"rname": "unit",
"since": ""
}
],
"floor": [
{
"cat": "Default",
"desc": "The floor value of x.",
"ex": "floor 5.25 ",
"exres": "5",
"name": "floor",
"op": "floor",
"rname": "x",
"since": ""
}
],
"for": [
{
"cat": "Default",
"desc": "Starts for sequence, use in complete form(see example).",
"ex": "for \"_x\" from 1 to 10 do {debugLog _x;}",
"exres": "",
"name": "for",
"op": "for",
"rname": "var",
"since": ""
},
{
"cat": "Default",
"desc": "creates cycle, using C like style. See example.",
"ex": "for [{_x=1},{_x<=10},{_x=_x+1}] do {debugLog _x;}",
"exres": "",
"name": "for",
"op": "for",
"rname": "forspec",
"since": ""
}
],
"forceAtPositionRTD": [
{
"cat": "General",
"desc": "Add force generator to world. Returns force index.",
"ex": "",
"exres": "",
"name": "forceatpositionrtd",
"op": "forceatpositionrtd",
"rname": "position",
"since": "TOH 81393"
}
],
"forceGeneratorRTD": [
{
"cat": "General",
"desc": "Add force generator to world. Returns force index.",
"ex": "",
"exres": "",
"name": "forcegeneratorrtd",
"op": "forcegeneratorrtd",
"rname": "index",
"since": "TOH 81393"
}
],
"forceMap": [
{
"cat": "General",
"desc": "Forces the map to display.",
"ex": "forceMap true",
"exres": "",
"name": "forcemap",
"op": "forcemap",
"rname": "show",
"since": "1.27"
}
],
"forceRespawn": [
{
"cat": "General",
"desc": "Force respawns given unit (stays old \"killed\" body). Will not count score",
"ex": "",
"exres": "",
"name": "forcerespawn",
"op": "forcerespawn",
"rname": "targetUnit",
"since": ""
}
],
"formLeader": [
{
"cat": "General",
"desc": "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.",
"ex": "formLeader player != leader player",
"exres": "",
"name": "formleader",
"op": "formleader",
"rname": "unit",
"since": ""
}
],
"format": [
{
"cat": "General",
"desc": "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.",
"ex": "format [\"%1 - %2 - %1\", 1, \"text\"]",
"exres": "\"1 - text - 1\"",
"name": "format",
"op": "format",
"rname": "format",
"since": ""
}
],
"formatText": [
{
"cat": "General",
"desc": "Creates a structured text by replacing %1, %2, etc. in format by plain or structured texts given as arguments.",
"ex": "txt = formatText [\"Image: %1\", image \"data\\isniper.paa\"]",
"exres": "",
"name": "formattext",
"op": "formattext",
"rname": "[format, arg1, arg2, ...]",
"since": "2.01"
}
],
"formation": [
{
"cat": "General",
"desc": "Returns the formation of the group (\"COLUMN\", \"STAG COLUMN\", \"WEDGE\", \"ECH LEFT\", \"ECH RIGHT\", \"VEE\" or \"LINE\").",
"ex": "formation group player",
"exres": "",
"name": "formation",
"op": "formation",
"rname": "grp",
"since": ""
},
{
"cat": "Agents",
"desc": "Return a formation of given team.",
"ex": "_formation = formation _team",
"exres": "",
"name": "formation",
"op": "formation",
"rname": "team",
"since": "2.90"
}
],
"formationDirection": [
{
"cat": "General",
"desc": "Return the direction unit watching in formation.",
"ex": "",
"exres": "",
"name": "formationdirection",
"op": "formationdirection",
"rname": "person",
"since": "2.92"
}
],
"formationLeader": [
{
"cat": "General",
"desc": "Return leader of the formation.",
"ex": "",
"exres": "",
"name": "formationleader",
"op": "formationleader",
"rname": "person",
"since": "2.92"
}
],
"formationMembers": [
{
"cat": "General",
"desc": "Return list of units (drivers) in the formation.",
"ex": "",
"exres": "",
"name": "formationmembers",
"op": "formationmembers",
"rname": "person",
"since": "2.92"
}
],
"formationPosition": [
{
"cat": "General",
"desc": "Return position of unit in the formation.",
"ex": "",
"exres": "",
"name": "formationposition",
"op": "formationposition",
"rname": "person",
"since": "2.92"
}
],
"formationTask": [
{
"cat": "General",
"desc": "Return the current task of the unit in the formation.",
"ex": "",
"exres": "",
"name": "formationtask",
"op": "formationtask",
"rname": "person",
"since": "2.92"
}
],
"fromEditor": [
{
"cat": "Agents",
"desc": "Return if given team was inserted directly from mission editor.",
"ex": "_fromEditor = fromEditor _member",
"exres": "",
"name": "fromeditor",
"op": "fromeditor",
"rname": "teamMember",
"since": "2.90"
}
],
"fuel": [
{
"cat": "General",
"desc": "Checks how much fuel is left in the gas tank, in the range from 0 to 1.",
"ex": "fuel vehicle player",
"exres": "",
"name": "fuel",
"op": "fuel",
"rname": "vehicle",
"since": ""
}
],
"fullCrew": [
{
"cat": "General",
"desc": "Returns array with all crew inside given vehicle",
"ex": "fullCrew vehicle player",
"exres": "",
"name": "fullcrew",
"op": "fullcrew",
"rname": "vehicle",
"since": ""
},
{
"cat": "General",
"desc": "Returns array with all crew of given type inside given vehicle",
"ex": "fullCrew [vehicle player, \"turret\"]",
"exres": "",
"name": "fullcrew",
"op": "fullcrew",
"rname": "[vehicle, type]",
"since": ""
}
],
"gearIDCAmmoCount": [
{
"cat": "General",
"desc": "Returns ammo count of assigned magazine.",
"ex": "ammo = gearSlotAmmoCount IDC",
"exres": "",
"name": "gearidcammocount",
"op": "gearidcammocount",
"rname": "control IDC",
"since": "93869"
}
],
"gearSlotAmmoCount": [
{
"cat": "General",
"desc": "Returns ammo count of assigned magazine.",
"ex": "ammo = gearSlotAmmoCount _control",
"exres": "",
"name": "gearslotammocount",
"op": "gearslotammocount",
"rname": "control",
"since": "93869"
}
],
"gearSlotData": [
{
"cat": "General",
"desc": "Returns gear slot item name.",
"ex": "weapon = gearSlotData _control",
"exres": "",
"name": "gearslotdata",
"op": "gearslotdata",
"rname": "control",
"since": "5501"
}
],
"get3DENActionState": [
{
"cat": "General",
"desc": "Returns state of given operation.",
"ex": "",
"exres": "",
"name": "get3denactionstate",
"op": "get3denactionstate",
"rname": "operation",
"since": ""
}
],
"get3DENConnections": [
{
"cat": "General",
"desc": "Returns list of all connections related to given entity.",
"ex": "",
"exres": "",
"name": "get3denconnections",
"op": "get3denconnections",
"rname": "<entity>",
"since": ""
}
],
"get3DENEntity": [
{
"cat": "General",
"desc": "Finds entity with given ID in editor and returns it for use in scripts.",
"ex": "",
"exres": "",
"name": "get3denentity",
"op": "get3denentity",
"rname": "<entityID>",
"since": ""
}
],
"get3DENEntityID": [
{
"cat": "General",
"desc": "Returns 3DEN ID of given entity.",
"ex": "",
"exres": "",
"name": "get3denentityid",
"op": "get3denentityid",
"rname": "<entity>",
"since": ""
}
],
"get3DENGrid": [
{
"cat": "General",
"desc": "Gets grid size of given grid type.",
"ex": "",
"exres": "",
"name": "get3dengrid",
"op": "get3dengrid",
"rname": "<type>",
"since": ""
}
],
"get3DENLayerEntities": [
{
"cat": "General",
"desc": "Returns list of all items from inside of given layer.",
"ex": "",
"exres": "",
"name": "get3denlayerentities",
"op": "get3denlayerentities",
"rname": "<layerID>",
"since": ""
}
],
"get3DENSelected": [
{
"cat": "General",
"desc": "Return all selected objects of given type.",
"ex": "",
"exres": "",
"name": "get3denselected",
"op": "get3denselected",
"rname": "objectType",
"since": ""
}
],
"getAimingCoef": [
{
"cat": "General",
"desc": "Get current aiming coefficient (higher ~ less precise, default is 1)",
"ex": "getAimingCoef player",
"exres": "",
"name": "getaimingcoef",
"op": "getaimingcoef",
"rname": "unit",
"since": "132500"
}
],
"getAllEnvSoundControllers": [
{
"cat": "General",
"desc": "Return pairs of all environmental controllers",
"ex": "getAllEnvSoundControllers (position player)",
"exres": "",
"name": "getallenvsoundcontrollers",
"op": "getallenvsoundcontrollers",
"rname": "position",
"since": ""
}
],
"getAllHitPointsDamage": [
{
"cat": "General",
"desc": "Returns 3 arrays for easy cross reference: 1st - array of hit point names, 2nd - array of hit selection names, 3rd - array of damage values.",
"ex": "getAllHitPointsDamage player",
"exres": "",
"name": "getallhitpointsdamage",
"op": "getallhitpointsdamage",
"rname": "obj",
"since": ""
}
],
"getAllOwnedMines": [
{
"cat": "General",
"desc": "Get all mine objects this unit has ownership over.",
"ex": "getAllOwnedMines player",
"exres": "",
"name": "getallownedmines",
"op": "getallownedmines",
"rname": "unit",
"since": ""
}
],
"getAllSoundControllers": [
{
"cat": "General",
"desc": "Return pairs (name, value) of all vehicle controllers",
"ex": "getAllSoundControllers (vehicle player)",
"exres": "",
"name": "getallsoundcontrollers",
"op": "getallsoundcontrollers",
"rname": "vehicle",
"since": ""
}
],
"getAmmoCargo": [
{
"cat": "General",
"desc": "Returns the amount of ammo resources in the cargo space of a repair vehicle.",
"ex": "getAmmoCargo vehicle",
"exres": "",
"name": "getammocargo",
"op": "getammocargo",
"rname": "vehicle",
"since": ""
}
],
"getAnimAimPrecision": [
{
"cat": "General",
"desc": "Returns aim precision for current animation",
"ex": "getAnimAimPrecision player",
"exres": "",
"name": "getanimaimprecision",
"op": "getanimaimprecision",
"rname": "player",
"since": "133600"
}
],
"getAnimSpeedCoef": [
{
"cat": "General",
"desc": "Get coefficient for animation speed",
"ex": "getAnimSpeedCoef player",
"exres": "",
"name": "getanimspeedcoef",
"op": "getanimspeedcoef",
"rname": "soldier",
"since": ""
}
],
"getArray": [
{
"cat": "General",
"desc": "Extract array from config entry.",
"ex": "_array = getArray (configFile >> \"CfgVehicles\" >> \"Thing\" >> \"threat\")",
"exres": "",
"name": "getarray",
"op": "getarray",
"rname": "config",
"since": "2.35"
}
],
"getArtilleryAmmo": [
{
"cat": "General",
"desc": "Get list of all available magazines of artillery units in the list.",
"ex": "",
"exres": "",
"name": "getartilleryammo",
"op": "getartilleryammo",
"rname": "[unitlist]",
"since": "86000"
}
],
"getAssignedCuratorLogic": [
{
"cat": "General",
"desc": "Returns curator logic to which has given player access.",
"ex": "",
"exres": "",
"name": "getassignedcuratorlogic",
"op": "getassignedcuratorlogic",
"rname": "player",
"since": ""
}
],
"getAssignedCuratorUnit": [
{
"cat": "General",
"desc": "Returns unit assigned to curator logic.",
"ex": "",
"exres": "",
"name": "getassignedcuratorunit",
"op": "getassignedcuratorunit",
"rname": "curatorObj",
"since": ""
}
],
"getBackpackCargo": [
{
"cat": "General",
"desc": "Returns all backpacks names and count from ammo box (or any general weapon holder container).",
"ex": "getBackpackCargo jeepOne",
"exres": "",
"name": "getbackpackcargo",
"op": "getbackpackcargo",
"rname": "box",
"since": ""
}
],
"getBleedingRemaining": [
{
"cat": "General",
"desc": "Return reamining time of bleeding.",
"ex": "",
"exres": "",
"name": "getbleedingremaining",
"op": "getbleedingremaining",
"rname": "unit",
"since": "81571"
}
],
"getBurningValue": [
{
"cat": "General",
"desc": "Return amount of damage from fire.",
"ex": "",
"exres": "",
"name": "getburningvalue",
"op": "getburningvalue",
"rname": "unit",
"since": "81571"
}
],
"getCameraViewDirection": [
{
"cat": "General",
"desc": "Returns the direction the unit is looking in.",
"ex": "_viewDir = getCameraViewDirection player",
"exres": "",
"name": "getcameraviewdirection",
"op": "getcameraviewdirection",
"rname": "unit",
"since": ""
}
],
"getCenterOfMass": [
{
"cat": "General",
"desc": "Returns center of mass of an object",
"ex": "com = getCenterOfMass myEntity",
"exres": "",
"name": "getcenterofmass",
"op": "getcenterofmass",
"rname": "object",
"since": ""
}
],
"getConnectedUAV": [
{
"cat": "General",
"desc": "Returns UAV if unit has connection to some UAV.",
"ex": "getConnectedUAV player",
"exres": "",
"name": "getconnecteduav",
"op": "getconnecteduav",
"rname": "Unit",
"since": "106482"
}
],
"getContainerMaxLoad": [
{
"cat": "General",
"desc": "Returns max load of a given containerItem",
"ex": "",
"exres": "",
"name": "getcontainermaxload",
"op": "getcontainermaxload",
"rname": "containerItemName",
"since": "5501"
}
],
"getCustomAimCoef": [
{
"cat": "General",
"desc": "Returns custom aiming coefficient for weapon sway",
"ex": "getCustomAimingCoef player",
"exres": "",
"name": "getcustomaimcoef",
"op": "getcustomaimcoef",
"rname": "player",
"since": "133600"
}
],
"getDLCAssetsUsageByName": [
{
"cat": "General",
"desc": "Returns an array with the session and global time the asset has been used.",
"ex": "",
"exres": "",
"name": "getdlcassetsusagebyname",
"op": "getdlcassetsusagebyname",
"rname": "assetName",
"since": ""
}
],
"getDLCUsageTime": [
{
"cat": "General",
"desc": "Returns total time the assets of the given DLC has been used.",
"ex": "",
"exres": "",
"name": "getdlcusagetime",
"op": "getdlcusagetime",
"rname": "appId",
"since": ""
}
],
"getDLCs": [
{
"cat": "General",
"desc": "Returns list of appIds of game DLCs. Use filter param to get only certain DLCs: 0:all, 1:owned, 2:not owned",
"ex": "",
"exres": "",
"name": "getdlcs",
"op": "getdlcs",
"rname": "filter",
"since": ""
}
],
"getDammage": [
{
"cat": "General",
"desc": "Returns the object damage in the range from 0 to 1.",
"ex": "getDammage player",
"exres": "",
"name": "getdammage",
"op": "getdammage",
"rname": "obj",
"since": ""
}
],
"getDescription": [
{
"cat": "General",
"desc": "Returns the string representation of unit as an four slots array ([unit,uniform,vest,backpack])",
"ex": "getDescription player",
"exres": "",
"name": "getdescription",
"op": "getdescription",
"rname": "unit",
"since": ""
}
],
"getDir": [
{
"cat": "General",
"desc": "Returns the object heading in the range from 0 to 360.",
"ex": "getDir player",
"exres": "",
"name": "getdir",
"op": "getdir",
"rname": "obj",
"since": ""
}
],
"getDirVisual": [
{
"cat": "General",
"desc": "Returns the object heading in the range from 0 to 360.",
"ex": "getDir player",
"exres": "",
"name": "getdirvisual",
"op": "getdirvisual",
"rname": "obj",
"since": ""
}
],
"getEditorCamera": [
{
"cat": "Editor",
"desc": "Fetches a reference to the mission editor camera.",
"ex": "",
"exres": "",
"name": "geteditorcamera",
"op": "geteditorcamera",
"rname": "map",
"since": "2.92"
}
],
"getEditorMode": [
{
"cat": "Editor",
"desc": "Returns the current mode of the editor.",
"ex": "",
"exres": "",
"name": "geteditormode",
"op": "geteditormode",
"rname": "map",
"since": "2.92"
}
],
"getEngineTargetRPMRTD": [
{
"cat": "General",
"desc": "Returns target rpm of all engines.",
"ex": "",
"exres": "",
"name": "getenginetargetrpmrtd",
"op": "getenginetargetrpmrtd",
"rname": "RTD_helicopter",
"since": "TOH 81393"
}
],
"getFatigue": [
{
"cat": "General",
"desc": "Returns relative exhaustion of a unit [0..1]",
"ex": "getFatigue player",
"exres": "",
"name": "getfatigue",
"op": "getfatigue",
"rname": "unit",
"since": "5501"
}
],
"getFieldManualStartPage": [
{
"cat": "General",
"desc": "Returns array of the starting topic and hint the given field manual should display",
"ex": "",
"exres": "",
"name": "getfieldmanualstartpage",
"op": "getfieldmanualstartpage",
"rname": "display",
"since": ""
}
],
"getFuelCargo": [
{
"cat": "General",
"desc": "Returns the fuel amount in the cargo space of a refuelling vehicle.",
"ex": "getFuelCargo vehicle",
"exres": "",
"name": "getfuelcargo",
"op": "getfuelcargo",
"rname": "vehicle",
"since": ""
}
],
"getGroupIconParams": [
{
"cat": "General",
"desc": "Returns group icons params. [color, text,scale, visible]",
"ex": "getGroupIconParams group",
"exres": "",
"name": "getgroupiconparams",
"op": "getgroupiconparams",
"rname": "group",
"since": "5501"
}
],
"getGroupIcons": [
{
"cat": "General",
"desc": "Returns all group icons.[[id,icon,[offsetx,offsety],[..],..]",
"ex": "getGroupIcons group",
"exres": "",
"name": "getgroupicons",
"op": "getgroupicons",
"rname": "group",
"since": "5501"
}
],
"getItemCargo": [
{
"cat": "General",
"desc": "Returns all items names and count from ammo box (or any general weapon holder container).",
"ex": "getItemCargo jeepOne",
"exres": "",
"name": "getitemcargo",
"op": "getitemcargo",
"rname": "box",
"since": ""
}
],
"getMagazineCargo": [
{
"cat": "General",
"desc": "Returns all magazines names and count from ammo box (or any general weapon holder container).",
"ex": "getMagazineCargo jeepOne",
"exres": "",
"name": "getmagazinecargo",
"op": "getmagazinecargo",
"rname": "box",
"since": ""
}
],
"getMarkerColor": [
{
"cat": "General",
"desc": "Gets the marker color. See <f>setMarkerColor</f>.",
"ex": "getMarkerColor \"MarkerOne\"",
"exres": "",
"name": "getmarkercolor",
"op": "getmarkercolor",
"rname": "marker",
"since": "1.21"
}
],
"getMarkerPos": [
{
"cat": "General",
"desc": "Returns the marker positon in format [x,z,y].",
"ex": "getMarkerPos \"markerOne\"",
"exres": "",
"name": "getmarkerpos",
"op": "getmarkerpos",
"rname": "markerName",
"since": ""
}
],
"getMarkerSize": [
{
"cat": "General",
"desc": "Gets the marker size. See <f>setMarkerSize</f>.",
"ex": "getMarkerSize \"MarkerOne\"",
"exres": "",
"name": "getmarkersize",
"op": "getmarkersize",
"rname": "marker",
"since": "1.21"
}
],
"getMarkerType": [
{
"cat": "General",
"desc": "Gets the type of the marker. See <f>setMarkerType</f>.",
"ex": "getMarkerType \"MarkerOne\"",
"exres": "",
"name": "getmarkertype",
"op": "getmarkertype",
"rname": "marker",
"since": "1.21"
}
],
"getMass": [
{
"cat": "General",
"desc": "Returns mass of an object",
"ex": "mass = getMass myEntity",
"exres": "",
"name": "getmass",
"op": "getmass",
"rname": "object",
"since": ""
}
],
"getMissionConfig": [
{
"cat": "General",
"desc": "Returns config for given mission attribute",
"ex": "",
"exres": "",
"name": "getmissionconfig",
"op": "getmissionconfig",
"rname": "attributeName",
"since": ""
}
],
"getMissionConfigValue": [
{
"cat": "General",
"desc": "Returns value of given entry in mission config file",
"ex": "",
"exres": "",
"name": "getmissionconfigvalue",
"op": "getmissionconfigvalue",
"rname": "attributeName",
"since": ""
}
],
"getMissionLayerEntities": [
{
"cat": "General",
"desc": "Returns list of entities currently in mission form given layer.",
"ex": "",
"exres": "",
"name": "getmissionlayerentities",
"op": "getmissionlayerentities",
"rname": "<layer_name> or <layer_id>",
"since": ""
}
],
"getModelInfo": [
{
"cat": "General",
"desc": "Returns object's model info in format [modelName, modelPath, hasSkeleton]. Model path is suitable for use with <f>createSimpleObject</f> command.",
"ex": "",
"exres": "",
"name": "getmodelinfo",
"op": "getmodelinfo",
"rname": "object",
"since": ""
}
],
"getNumber": [
{
"cat": "General",
"desc": "Extract number from config entry.",
"ex": "_array = getNumber (configFile >> \"CfgVehicles\" >> \"Thing\" >> \"maxSpeed\")",
"exres": "",
"name": "getnumber",
"op": "getnumber",
"rname": "config",
"since": "2.35"
}
],
"getObjectDLC": [
{
"cat": "General",
"desc": "Returns an appId the object belongs to. The information is taken from it's model.",
"ex": "getObjectDLC cursorTarget",
"exres": "",
"name": "getobjectdlc",
"op": "getobjectdlc",
"rname": "Object",
"since": "128256"
}
],
"getObjectMaterials": [
{
"cat": "General",
"desc": "Returns a list of all custom materials assigned to given object.",
"ex": "_materials = getObjectMaterials player;",
"exres": "",
"name": "getobjectmaterials",
"op": "getobjectmaterials",
"rname": "object",
"since": "128600"
}
],
"getObjectTextures": [
{
"cat": "General",
"desc": "Returns a list of all custom textures assigned to given object.",
"ex": "_textures = getObjectTextures player;",
"exres": "",
"name": "getobjecttextures",
"op": "getobjecttextures",
"rname": "object",
"since": "128600"
}
],
"getObjectType": [
{
"cat": "General",
"desc": "Returns object type as Number",
"ex": "getObjectType player",
"exres": "",
"name": "getobjecttype",
"op": "getobjecttype",
"rname": "obj",
"since": ""
}
],
"getOxygenRemaining": [
{
"cat": "General",
"desc": "Return amount of remaining oxygen.",
"ex": "",
"exres": "",
"name": "getoxygenremaining",
"op": "getoxygenremaining",
"rname": "unit",
"since": "81571"
}
],
"getPersonUsedDLCs": [
{
"cat": "General",
"desc": "Returns list of all DLCs (appIds, both owned or not) the person is currently using.",
"ex": "getPersonUsedDLCs player",
"exres": "",
"name": "getpersonuseddlcs",
"op": "getpersonuseddlcs",
"rname": "Person",
"since": "128256"
}
],
"getPilotCameraDirection": [
{
"cat": "General",
"desc": "Returns pilot camera direction (model space)",
"ex": "vector = getPilotCameraDirection (vehicle player)",
"exres": "",
"name": "getpilotcameradirection",
"op": "getpilotcameradirection",
"rname": "planerOrHeli",
"since": ""
}
],
"getPilotCameraPosition": [
{
"cat": "General",
"desc": "Returns pilot camera position (model space)",
"ex": "vector = getPilotCameraPosition (vehicle player)",
"exres": "",
"name": "getpilotcameraposition",
"op": "getpilotcameraposition",
"rname": "planerOrHeli",
"since": ""
}
],
"getPilotCameraRotation": [
{
"cat": "General",
"desc": "Returns pilot camera orientation (model space)",
"ex": " rotation = getPilotCameraRotation (vehicle player)",
"exres": "",
"name": "getpilotcamerarotation",
"op": "getpilotcamerarotation",
"rname": "planerOrHeli",
"since": ""
}
],
"getPilotCameraTarget": [
{
"cat": "General",
"desc": "Returns position/target pilot camera is pointing at",
"ex": " target = getPilotCameraDirectionTarget (vehicle player)",
"exres": "",
"name": "getpilotcameratarget",
"op": "getpilotcameratarget",
"rname": "planerOrHeli",
"since": ""
}
],
"getPlayerChannel": [
{
"cat": "General",
"desc": "Returns channel the player currently speaks on. Returns -1 if there is no communication in progress.",
"ex": "channel = getPlayerChannel",
"exres": "",
"name": "getplayerchannel",
"op": "getplayerchannel",
"rname": "object",
"since": ""
}
],
"getPlayerScores": [
{
"cat": "General",
"desc": "MP: returns the unit's table of scores (infantry kills, soft vehicle kills, armor kills, air kills, deaths, total score).",
"ex": "getPlayerScores unitOne",
"exres": "",
"name": "getplayerscores",
"op": "getplayerscores",
"rname": "unit",
"since": ""
}
],
"getPlayerUID": [
{
"cat": "General",
"desc": "Get unique player id.",
"ex": "",
"exres": "",
"name": "getplayeruid",
"op": "getplayeruid",
"rname": "unit",
"since": "5501"
}
],
"getPos": [
{
"cat": "General",
"desc": "Returns the object position in format <ar>Position</ar>.",
"ex": "getPos player",
"exres": "",
"name": "getpos",
"op": "getpos",
"rname": "obj",
"since": ""
},
{
"cat": "Location",
"desc": "Return (raw) position of given location.",
"ex": "",
"exres": "",
"name": "getpos",
"op": "getpos",
"rname": "location",
"since": "5501"
}
],
"getPosASL": [
{
"cat": "General",
"desc": "Returns the object position in format <ar>PositionASL</ar>.",
"ex": "getPosASL player",
"exres": "",
"name": "getposasl",
"op": "getposasl",
"rname": "obj",
"since": "2.53"
}
],
"getPosASLVisual": [
{
"cat": "General",
"desc": "Returns the object rendered position in format <ar>PositionASL</ar>.",
"ex": "visiblePositionASL player",
"exres": "",
"name": "getposaslvisual",
"op": "getposaslvisual",
"rname": "object",
"since": "1.50"
}
],
"getPosASLW": [
{
"cat": "General",
"desc": "Returns the object position in format <ar>PositionASLW</ar>.",
"ex": "getPosASLW player",
"exres": "",
"name": "getposaslw",
"op": "getposaslw",
"rname": "obj",
"since": "2.92"
}
],
"getPosATL": [
{
"cat": "General",
"desc": "Returns the object position in format <ar>PositionATL</ar>.",
"ex": "getPosATL player",
"exres": "",
"name": "getposatl",
"op": "getposatl",
"rname": "obj",
"since": "2.53"
}
],
"getPosATLVisual": [
{
"cat": "General",
"desc": "Returns the object position in format <ar>PositionATL</ar>.",
"ex": "getPosATL player",
"exres": "",
"name": "getposatlvisual",
"op": "getposatlvisual",
"rname": "obj",
"since": "2.53"
}
],
"getPosVisual": [
{
"cat": "General",
"desc": "Returns the object rendered position in format <ar>Position</ar>.",
"ex": "visiblePosition player",
"exres": "",
"name": "getposvisual",
"op": "getposvisual",
"rname": "object",
"since": "1.50"
}
],
"getPosWorld": [
{
"cat": "General",
"desc": "Returns the object position in format <ar>PositionWorld</ar>.",
"ex": "getPosWorld player",
"exres": "",
"name": "getposworld",
"op": "getposworld",
"rname": "obj",
"since": "2.53"
}
],
"getRepairCargo": [
{
"cat": "General",
"desc": "Returns the amount or repair resources in the cargo space of a repair vehicle.",
"ex": "getRepairCargo vehicle",
"exres": "",
"name": "getrepaircargo",
"op": "getrepaircargo",
"rname": "vehicle",
"since": ""
}
],
"getRotorBrakeRTD": [
{
"cat": "General",
"desc": "Returns if rotorbrake is on.",
"ex": "",
"exres": "",
"name": "getrotorbrakertd",
"op": "getrotorbrakertd",
"rname": "RTD_helicopter",
"since": "81575 TOH"
}
],
"getShotParents": [
{
"cat": "General",
"desc": "Get the shot's parent and a unit which caused the shot to happen.",
"ex": "shotParents = getShotParents myProjectile",
"exres": "",
"name": "getshotparents",
"op": "getshotparents",
"rname": "shot",
"since": ""
}
],
"getSlingLoad": [
{
"cat": "General",
"desc": "Return object which is sling loaded by vehicle",
"ex": "getSlingLoad veh",
"exres": "",
"name": "getslingload",
"op": "getslingload",
"rname": "vehicle",
"since": "127138"
}
],
"getStamina": [
{
"cat": "General",
"desc": "Get current stamina (~ seconds until depletion)",
"ex": "getStamina player",
"exres": "",
"name": "getstamina",
"op": "getstamina",
"rname": "unit",
"since": "132500"
}
],
"getStatValue": [
{
"cat": "General",
"desc": "Returns value of the given stat. ",
"ex": "",
"exres": "",
"name": "getstatvalue",
"op": "getstatvalue",
"rname": "statName",
"since": ""
}
],
"getSuppression": [
{
"cat": "General",
"desc": "Gets the AI suppression level.",
"ex": "unit getSuppression",
"exres": "",
"name": "getsuppression",
"op": "getsuppression",
"rname": "unit",
"since": ""
}
],
"getTerrainHeightASL": [
{
"cat": "General",
"desc": "Returns terrain height above sea level.",
"ex": " z = getTerrainHeightASL [x,y]",
"exres": "",
"name": "getterrainheightasl",
"op": "getterrainheightasl",
"rname": "[x,y]",
"since": "1.18"
}
],
"getText": [
{
"cat": "General",
"desc": "Extract text from config entry.",
"ex": "_array = getText (configFile >> \"CfgVehicles\" >> \"Thing\" >> \"icon\")",
"exres": "",
"name": "gettext",
"op": "gettext",
"rname": "config",
"since": "2.35"
}
],
"getTrimOffsetRTD": [
{
"cat": "General",
"desc": "Returns controls trim offset.",
"ex": "",
"exres": "",
"name": "gettrimoffsetrtd",
"op": "gettrimoffsetrtd",
"rname": "RTD_helicopter",
"since": "TOH 81393"
}
],
"getUnitLoadout": [
{
"cat": "General",
"desc": "Get array with all assigned items, weapons, containers and its stored items.",
"ex": "",
"exres": "",
"name": "getunitloadout",
"op": "getunitloadout",
"rname": "unit",
"since": "5501"
},
{
"cat": "General",
"desc": "Get array with all assigned items, weapons, containers and its stored items.",
"ex": "",
"exres": "",
"name": "getunitloadout",
"op": "getunitloadout",
"rname": "className",
"since": "5501"
},
{
"cat": "General",
"desc": "Get array with all assigned items, weapons, containers and its stored items.",
"ex": "",
"exres": "",
"name": "getunitloadout",
"op": "getunitloadout",
"rname": "config",
"since": "5501"
}
],
"getVehicleCargo": [
{
"cat": "General",
"desc": "Get list of vehicles loaded inside this vehicle.",
"ex": "getVehicleCargo veh",
"exres": "",
"name": "getvehiclecargo",
"op": "getvehiclecargo",
"rname": "vehicle",
"since": "134497"
}
],
"getWPPos": [
{
"cat": "General",
"desc": "Gets the waypoint position. The format of waypoint is <ar>Waypoint</ar>.",
"ex": "getWPPos [groupOne, 1]",
"exres": "",
"name": "getwppos",
"op": "getwppos",
"rname": "waypoint",
"since": "1.21"
}
],
"getWeaponCargo": [
{
"cat": "General",
"desc": "Returns all weapons names and count from ammo box (or any general weapon holder container).",
"ex": "getWeaponCargo jeepOne",
"exres": "",
"name": "getweaponcargo",
"op": "getweaponcargo",
"rname": "box",
"since": ""
}
],
"getWeaponSway": [
{
"cat": "General",
"desc": "Returns current size of weapon sway of a given unit, in radians",
"ex": "getWeaponSway player",
"exres": "",
"name": "getweaponsway",
"op": "getweaponsway",
"rname": "unit",
"since": "133333"
}
],
"getWingsOrientationRTD": [
{
"cat": "General",
"desc": "Returns orientation of horizontaol stabilizers.",
"ex": "",
"exres": "",
"name": "getwingsorientationrtd",
"op": "getwingsorientationrtd",
"rname": "RTD_helicopter",
"since": "81575 TOH"
}
],
"getWingsPositionRTD": [
{
"cat": "General",
"desc": "Returns position of stabilizers.",
"ex": "",
"exres": "",
"name": "getwingspositionrtd",
"op": "getwingspositionrtd",
"rname": "RTD_helicopter",
"since": "81575 TOH"
}
],
"goggles": [
{
"cat": "General",
"desc": "Returns name of currently used goggles.",
"ex": "",
"exres": "",
"name": "goggles",
"op": "goggles",
"rname": "unit",
"since": "5501"
}
],
"goto": [
{
"cat": "General",
"desc": "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.",
"ex": "goto \"Loop\"",
"exres": "",
"name": "goto",
"op": "goto",
"rname": "label",
"since": ""
}
],
"group": [
{
"cat": "General",
"desc": "Returns the group to which the given unit is assigned. For dead units, grpNull is returned.",
"ex": "group player == group leader player",
"exres": "",
"name": "group",
"op": "group",
"rname": "obj",
"since": ""
}
],
"groupFromNetId": [
{
"cat": "General",
"desc": "Get group with given unique ID.",
"ex": "groupFromNetId (netId group player)",
"exres": "group player",
"name": "groupfromnetid",
"op": "groupfromnetid",
"rname": "id",
"since": ""
}
],
"groupID": [
{
"cat": "General",
"desc": "Returns group name.",
"ex": "name = groupID (group player)",
"exres": "",
"name": "groupid",
"op": "groupid",
"rname": "group",
"since": ""
}
],
"groupOwner": [
{
"cat": "General",
"desc": "Returns ID of client to which the group is local. Can be run only from server. When called from client, it always returns 0.",
"ex": "",
"exres": "",
"name": "groupowner",
"op": "groupowner",
"rname": "group",
"since": "5501"
}
],
"groupSelectedUnits": [
{
"cat": "General",
"desc": "Returns selected groups in sgroup.",
"ex": "array = groupSelectedUnits unit",
"exres": "",
"name": "groupselectedunits",
"op": "groupselectedunits",
"rname": "unit",
"since": "5501"
}
],
"gunner": [
{
"cat": "General",
"desc": "Returns the gunner of the vehicle. If the vehicle is not a vehicle, but a person, the person is returned.",
"ex": "gunner vehicle player",
"exres": "",
"name": "gunner",
"op": "gunner",
"rname": "vehicle",
"since": ""
}
],
"handgunItems": [
{
"cat": "General",
"desc": "Get array with all items assigned to a weapon.",
"ex": "",
"exres": "",
"name": "handgunitems",
"op": "handgunitems",
"rname": "unit",
"since": "5501"
}
],
"handgunMagazine": [
{
"cat": "General",
"desc": "Return the names of the types of currently loaded magazines in given weapon.",
"ex": "",
"exres": "",
"name": "handgunmagazine",
"op": "handgunmagazine",
"rname": "vehicle",
"since": "5500"
}
],
"handgunWeapon": [
{
"cat": "General",
"desc": "Returns the name of a units's handgun (an empty string if there is none).",
"ex": "handgunWeapon player",
"exres": "",
"name": "handgunweapon",
"op": "handgunweapon",
"rname": "unit",
"since": "1.75"
}
],
"handsHit": [
{
"cat": "General",
"desc": "Checks whether the soldier's hands are hit (causing inaccurate aiming).",
"ex": "handsHit leader player",
"exres": "",
"name": "handshit",
"op": "handshit",
"rname": "soldier",
"since": ""
}
],
"hasPilotCamera": [
{
"cat": "General",
"desc": "Returns true if planerOrHeli has pilot camera",
"ex": " bool = hasPilotCamera (vehicle player)",
"exres": "",
"name": "haspilotcamera",
"op": "haspilotcamera",
"rname": "planerOrHeli",
"since": ""
}
],
"hcAllGroups": [
{
"cat": "General",
"desc": "Returns selected groups in high command.",
"ex": "array = hcAllGroups unit",
"exres": "",
"name": "hcallgroups",
"op": "hcallgroups",
"rname": "unit",
"since": "5501"
}
],
"hcLeader": [
{
"cat": "General",
"desc": "Returns group's HC commander.",
"ex": "hcLeader group",
"exres": "",
"name": "hcleader",
"op": "hcleader",
"rname": "group",
"since": "5501"
}
],
"hcRemoveAllGroups": [
{
"cat": "General",
"desc": "Remove all groups from unit's high command bar.",
"ex": "hcRemoveAllGroups unit",
"exres": "",
"name": "hcremoveallgroups",
"op": "hcremoveallgroups",
"rname": "unit",
"since": "5501"
}
],
"hcSelected": [
{
"cat": "General",
"desc": "Returns selected groups in high command.",
"ex": "array = hcSelected unit",
"exres": "",
"name": "hcselected",
"op": "hcselected",
"rname": "unit",
"since": "5501"
}
],
"hcShowBar": [
{
"cat": "General",
"desc": "Shows or hides HC bar. There must be some groups under hc command to show hc bar.",
"ex": "hcShowBar true",
"exres": "",
"name": "hcshowbar",
"op": "hcshowbar",
"rname": "bool",
"since": "5501"
}
],
"headgear": [
{
"cat": "General",
"desc": "Returns name of currently used headgear.",
"ex": "",
"exres": "",
"name": "headgear",
"op": "headgear",
"rname": "unit",
"since": "5501"
}
],
"hideBody": [
{
"cat": "General",
"desc": "Hides the body of the given person.",
"ex": "hideBody player",
"exres": "",
"name": "hidebody",
"op": "hidebody",
"rname": "person",
"since": "2.10"
}
],
"hideObject": [
{
"cat": "General",
"desc": "Hide object (cannot hide static objects).",
"ex": "",
"exres": "",
"name": "hideobject",
"op": "hideobject",
"rname": "object",
"since": "2.90"
}
],
"hideObjectGlobal": [
{
"cat": "General",
"desc": "Hide object globally (cannot hide static objects). Only from server",
"ex": "",
"exres": "",
"name": "hideobjectglobal",
"op": "hideobjectglobal",
"rname": "object",
"since": "2.90"
}
],
"hint": [
{
"cat": "General",
"desc": "Shows a text hint. The text can contain several lines. \\n is used to indicate the end of a line.",
"ex": "hint \"Press W to move forward\"",
"exres": "",
"name": "hint",
"op": "hint",
"rname": "text",
"since": ""
}
],
"hintC": [
{
"cat": "General",
"desc": "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.",
"ex": "hintC \"Press W to move forward\"",
"exres": "",
"name": "hintc",
"op": "hintc",
"rname": "text",
"since": ""
}
],
"hintCadet": [
{
"cat": "General",
"desc": "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.",
"ex": "hintCadet \"Press W to move forward\"",
"exres": "",
"name": "hintcadet",
"op": "hintcadet",
"rname": "text",
"since": ""
}
],
"hintSilent": [
{
"cat": "General",
"desc": "Same as <f>hint</f>, but without a sound.",
"ex": "",
"exres": "",
"name": "hintsilent",
"op": "hintsilent",
"rname": "text",
"since": "5501"
}
],
"hmd": [
{
"cat": "General",
"desc": "Returns name of currently used HMD.",
"ex": "",
"exres": "",
"name": "hmd",
"op": "hmd",
"rname": "unit",
"since": "5501"
}
],
"hostMission": [
{
"cat": "General",
"desc": "Host the MP mission described by config class. Should be called as a reaction to some UI action in some dialog.",
"ex": "",
"exres": "",
"name": "hostmission",
"op": "hostmission",
"rname": "[Config,Display]",
"since": "1.54"
}
],
"if": [
{
"cat": "Default",
"desc": "The first part of the if command.",
"ex": "if (a>b) then {a=b}",
"exres": "",
"name": "if",
"op": "if",
"rname": "condition",
"since": "1.85"
}
],
"image": [
{
"cat": "General",
"desc": "Creates a structured text containing the given image.",
"ex": "txt1 = image \"data\\isniper.paa\"",
"exres": "",
"name": "image",
"op": "image",
"rname": "filename",
"since": "2.01"
}
],
"importAllGroups": [
{
"cat": "Editor",
"desc": "Imports all groups into the RTE.",
"ex": "",
"exres": "",
"name": "importallgroups",
"op": "importallgroups",
"rname": "map",
"since": "2.92"
}
],
"importance": [
{
"cat": "Location",
"desc": "Return importance of given location.",
"ex": "",
"exres": "",
"name": "importance",
"op": "importance",
"rname": "location",
"since": "2.90"
}
],
"inGameUISetEventHandler": [
{
"cat": "General",
"desc": "Sets given event handler of in-game UI.",
"ex": "",
"exres": "",
"name": "ingameuiseteventhandler",
"op": "ingameuiseteventhandler",
"rname": "[handler name, function]",
"since": "2.91"
}
],
"incapacitatedState": [
{
"cat": "General",
"desc": "Returns the incapacitated state of the given unit.",
"ex": "",
"exres": "",
"name": "incapacitatedstate",
"op": "incapacitatedstate",
"rname": "unit",
"since": "5501"
}
],
"inflamed": [
{
"cat": "General",
"desc": "Check if fireplace is inflamed (burning).",
"ex": "inflamed fireplaceOne",
"exres": "",
"name": "inflamed",
"op": "inflamed",
"rname": "fireplace",
"since": "1.04"
}
],
"inheritsFrom": [
{
"cat": "General",
"desc": "Returns base entry of config entry.",
"ex": "_base = inheritsFrom (configFile >> \"CfgVehicles\" >> \"Car\")",
"exres": "",
"name": "inheritsfrom",
"op": "inheritsfrom",
"rname": "config",
"since": "2.92"
}
],
"inputAction": [
{
"cat": "General",
"desc": "Return the state of input devices mapped to given input action (see CfgDefaultKeysMapping for action names).",
"ex": "",
"exres": "",
"name": "inputaction",
"op": "inputaction",
"rname": "name",
"since": "5500"
}
],
"isAbleToBreathe": [
{
"cat": "General",
"desc": "Return whether the unit is diving.",
"ex": "",
"exres": "",
"name": "isabletobreathe",
"op": "isabletobreathe",
"rname": "unit",
"since": "81571"
}
],
"isAgent": [
{
"cat": "Agents",
"desc": "Check if team member is an agent.",
"ex": "",
"exres": "",
"name": "isagent",
"op": "isagent",
"rname": "teamMember",
"since": "2.92"
}
],
"isAimPrecisionEnabled": [
{
"cat": "General",
"desc": "Returns true if procedural aiming precision affects weapon sway",
"ex": "isAimPrecisionEnabled player",
"exres": "",
"name": "isaimprecisionenabled",
"op": "isaimprecisionenabled",
"rname": "player",
"since": "133600"
}
],
"isArray": [
{
"cat": "General",
"desc": "Check if config entry represents array.",
"ex": "_ok = isArray (configFile >> \"CfgVehicles\")",
"exres": "false",
"name": "isarray",
"op": "isarray",
"rname": "config",
"since": "2.35"
}
],
"isAutoHoverOn": [
{
"cat": "General",
"desc": "Returns true if vehicle has enabled auto hover",
"ex": "",
"exres": "",
"name": "isautohoveron",
"op": "isautohoveron",
"rname": "vehicle",
"since": "5501"
}
],
"isAutoStartUpEnabledRTD": [
{
"cat": "General",
"desc": "Returns true if automatic start up action is enabled.",
"ex": "",
"exres": "",
"name": "isautostartupenabledrtd",
"op": "isautostartupenabledrtd",
"rname": "RTD_helicopter",
"since": "81393 TOH"
}
],
"isAutoTrimOnRTD": [
{
"cat": "General",
"desc": "Returns true if autotrim is enabled.",
"ex": "",
"exres": "",
"name": "isautotrimonrtd",
"op": "isautotrimonrtd",
"rname": "RTD_helicopter",
"since": "TOH 81393"
}
],
"isAutonomous": [
{
"cat": "General",
"desc": "Return true if UAV is in autonomous mode.",
"ex": "uavAuto = isAutonomous uav",
"exres": "",
"name": "isautonomous",
"op": "isautonomous",
"rname": "Uav",
"since": ""
}
],
"isBleeding": [
{
"cat": "General",
"desc": "Return whether the unit is bleeding.",
"ex": "",
"exres": "",
"name": "isbleeding",
"op": "isbleeding",
"rname": "unit",
"since": "81571"
}
],
"isBurning": [
{
"cat": "General",
"desc": "Return whether the unit is burning.",
"ex": "",
"exres": "",
"name": "isburning",
"op": "isburning",
"rname": "unit",
"since": "81571"
}
],
"isClass": [
{
"cat": "General",
"desc": "Check if config entry represents config class.",
"ex": "_ok = isClass (configFile >> \"CfgVehicles\")",
"exres": "true",
"name": "isclass",
"op": "isclass",
"rname": "config",
"since": "2.35"
}
],
"isCollisionLightOn": [
{
"cat": "General",
"desc": "Checks whether the collision light is on.(non-vehicle param returns false)",
"ex": "on = isLightOn vehicle player",
"exres": "",
"name": "iscollisionlighton",
"op": "iscollisionlighton",
"rname": "vehicle",
"since": ""
}
],
"isCopilotEnabled": [
{
"cat": "General",
"desc": "Returns true if copilots actions are enabled.",
"ex": "enabled = isCopilotEnabled (vehicle player)",
"exres": "",
"name": "iscopilotenabled",
"op": "iscopilotenabled",
"rname": "vehicle",
"since": "TOH 81021"
}
],
"isDLCAvailable": [
{
"cat": "General",
"desc": "Returns true if the DLC is marked as available.",
"ex": "",
"exres": "123896",
"name": "isdlcavailable",
"op": "isdlcavailable",
"rname": "appId",
"since": ""
}
],
"isEngineOn": [
{
"cat": "General",
"desc": "Checks whether the engine is on. ",
"ex": "on = isEngineOn vehicle player",
"exres": "",
"name": "isengineon",
"op": "isengineon",
"rname": "vehicle",
"since": "1.90"
}
],
"isForcedWalk": [
{
"cat": "General",
"desc": "Returns true if player is forced to walk",
"ex": "",
"exres": "",
"name": "isforcedwalk",
"op": "isforcedwalk",
"rname": "player",
"since": "5501"
}
],
"isFormationLeader": [
{
"cat": "General",
"desc": "Returns true if the specified person is subgroup leader.",
"ex": "",
"exres": "",
"name": "isformationleader",
"op": "isformationleader",
"rname": "person",
"since": "2.92"
}
],
"isGroupDeletedWhenEmpty": [
{
"cat": "General",
"desc": "Returns wheather given group is garbage collected or not",
"ex": "isGroupDeletedWhenEmpty (player group)",
"exres": "",
"name": "isgroupdeletedwhenempty",
"op": "isgroupdeletedwhenempty",
"rname": "<group>",
"since": ""
}
],
"isHidden": [
{
"cat": "General",
"desc": "Return whether the person is hidden (reached the hiding position).",
"ex": "",
"exres": "",
"name": "ishidden",
"op": "ishidden",
"rname": "person",
"since": "2.92"
}
],
"isInRemainsCollector": [
{
"cat": "General",
"desc": "Returns true if object will be managed by the unitRemove manager",
"ex": "isInRemainsCollector player",
"exres": "",
"name": "isinremainscollector",
"op": "isinremainscollector",
"rname": "object",
"since": ""
}
],
"isKeyActive": [
{
"cat": "General",
"desc": "Checks whether the given key is active in the current user profile.",
"ex": "ok = isKeyActive \"M04\"",
"exres": "",
"name": "iskeyactive",
"op": "iskeyactive",
"rname": "keyName",
"since": "2.06"
}
],
"isLightOn": [
{
"cat": "General",
"desc": "Checks whether the light is on.(non-vehicle param returns false)",
"ex": "on = isLightOn vehicle player",
"exres": "",
"name": "islighton",
"op": "islighton",
"rname": "vehicle",
"since": ""
}
],
"isLocalized": [
{
"cat": "General",
"desc": "Checks whether given string name is localized.",
"ex": "isLocalized \"STR_DN_SNAKE\"",
"exres": "",
"name": "islocalized",
"op": "islocalized",
"rname": "stringName",
"since": "85897 TOH"
}
],
"isManualFire": [
{
"cat": "General",
"desc": "Returns true if manual fire is on.",
"ex": "",
"exres": "",
"name": "ismanualfire",
"op": "ismanualfire",
"rname": "vehicle",
"since": "5501"
}
],
"isMarkedForCollection": [
{
"cat": "General",
"desc": "Checks whether the object is marked for weapons collection.",
"ex": "marked = isMarkedForCollection truck",
"exres": "",
"name": "ismarkedforcollection",
"op": "ismarkedforcollection",
"rname": "object",
"since": "2.13"
}
],
"isNil": [
{
"cat": "Default",
"desc": "Tests whether the variable is null. The function returns true if the variable is null and false if it's not.",
"ex": "if (isNil(\"_pokus\")) then {_pokus=0;}",
"exres": "",
"name": "isnil",
"op": "isnil",
"rname": "variable",
"since": "2.00"
}
],
"isNull": [
{
"cat": "General",
"desc": "Checks whether the value is equal to objNull.\r\nNote: a==ObjNull does not work, because objNull is not equal to anything, even to itself.",
"ex": "isNull objNull",
"exres": "true",
"name": "isnull",
"op": "isnull",
"rname": "obj",
"since": ""
},
{
"cat": "General",
"desc": "Checks whether the value is equal to grpNull.\r\nNote: a==GrpNull does not work, because grpNull is not equal to anything, even to itself.",
"ex": "isNull group player",
"exres": "false",
"name": "isnull",
"op": "isnull",
"rname": "grp",
"since": ""
},
{
"cat": "General",
"desc": "Checks whether the value is equal to scriptNull.\r\nNote: script == scriptNull does not work, because scriptNull is not equal to anything, even to itself.",
"ex": "isNull scriptNull",
"exres": "true",
"name": "isnull",
"op": "isnull",
"rname": "script",
"since": ""
},
{
"cat": "General",
"desc": "Checks whether the value is equal to configNull.",
"ex": "isNull configNull",
"exres": "true",
"name": "isnull",
"op": "isnull",
"rname": "config",
"since": ""
},
{
"cat": "General",
"desc": "Checks whether the value is equal to displayNull.\r\nNote: a==displayNull does not work, because displayNull is not equal to anything, even to itself.",
"ex": "isNull displayNull",
"exres": "true",
"name": "isnull",
"op": "isnull",
"rname": "display",
"since": "2.92"
},
{
"cat": "General",
"desc": "Checks whether the value is equal to controlNull.\r\nNote: a==controlNull does not work, because controlNull is not equal to anything, even to itself.",
"ex": "isNull controlNull",
"exres": "true",
"name": "isnull",
"op": "isnull",
"rname": "control",
"since": "2.92"
},
{
"cat": "General",
"desc": "Checks whether the value is equal to objNetNull.\r\nNote: a==ObjNetNull does not work, because objNetNull is not equal to anything, even to itself.",
"ex": "isNull objNetNull",
"exres": "true",
"name": "isnull",
"op": "isnull",
"rname": "NetObject",
"since": "69527"
},
{
"cat": "Identity",
"desc": "Checks whether the value is equal to taskNull.\r\nNote: a==TaskNull does not work, because taskNull is not equal to anything, even to itself.",
"ex": "isNull taskNull",
"exres": "true",
"name": "isnull",
"op": "isnull",
"rname": "task",
"since": "5160"
},
{
"cat": "Location",
"desc": "Check whether the value is null.",
"ex": "",
"exres": "",
"name": "isnull",
"op": "isnull",
"rname": "location",
"since": "5501"
}
],
"isNumber": [
{
"cat": "General",
"desc": "Check if config entry represents number.",
"ex": "_ok = isNumber (configFile >> \"CfgVehicles\")",
"exres": "false",
"name": "isnumber",
"op": "isnumber",
"rname": "config",
"since": "2.35"
}
],
"isObjectHidden": [
{
"cat": "General",
"desc": "Checks visibility of an object.",
"ex": "",
"exres": "",
"name": "isobjecthidden",
"op": "isobjecthidden",
"rname": "object",
"since": "2.90"
}
],
"isObjectRTD": [
{
"cat": "General",
"desc": "Returns true if RTD model is loaded.",
"ex": "",
"exres": "",
"name": "isobjectrtd",
"op": "isobjectrtd",
"rname": "helicopter",
"since": "TOH 81393"
}
],
"isOnRoad": [
{
"cat": "General",
"desc": "Check whether given position is on road.",
"ex": "",
"exres": "",
"name": "isonroad",
"op": "isonroad",
"rname": "position or object",
"since": "5501"
}
],
"isPlayer": [
{
"cat": "General",
"desc": "Check if given person is the player.",
"ex": "",
"exres": "",
"name": "isplayer",
"op": "isplayer",
"rname": "person",
"since": "2.92"
}
],
"isRealTime": [
{
"cat": "Editor",
"desc": "Returns true if the mission editor is operating in real time mode.",
"ex": "_isRealTime = isRealTime _map",
"exres": "",
"name": "isrealtime",
"op": "isrealtime",
"rname": "map",
"since": "2.92"
}
],
"isShowing3DIcons": [
{
"cat": "Editor",
"desc": "Returns true if the editor is set to draw 3D icons.",
"ex": "",
"exres": "",
"name": "isshowing3dicons",
"op": "isshowing3dicons",
"rname": "map",
"since": "2.92"
}
],
"isSimpleObject": [
{
"cat": "General",
"desc": "Check weather given entity is simple object or not",
"ex": "isSimpleObject myObj",
"exres": "",
"name": "issimpleobject",
"op": "issimpleobject",
"rname": "<entity>",
"since": ""
}
],
"isSprintAllowed": [
{
"cat": "General",
"desc": "Returns true if player is allowed to sprint",
"ex": "",
"exres": "",
"name": "issprintallowed",
"op": "issprintallowed",
"rname": "player",
"since": "129500"
}
],
"isStaminaEnabled": [
{
"cat": "General",
"desc": "Check if stamina depletion is enabled",
"ex": "isStaminaEnabled player",
"exres": "",
"name": "isstaminaenabled",
"op": "isstaminaenabled",
"rname": "unit",
"since": "132500"
}
],
"isText": [
{
"cat": "General",
"desc": "Check if config entry represents text.",
"ex": "_ok = isText (configFile >> \"CfgVehicles\")",
"exres": "false",
"name": "istext",
"op": "istext",
"rname": "config",
"since": "2.35"
}
],
"isTouchingGround": [
{
"cat": "General",
"desc": "Returns true if object is touching the ground.",
"ex": "isTouchingGround vehicle",
"exres": "",
"name": "istouchingground",
"op": "istouchingground",
"rname": "object",
"since": "5501"
}
],
"isTurnedOut": [
{
"cat": "General",
"desc": "Returns true if the given unit is turned out. Default is false.",
"ex": "_isTurnedOut = isTurnedOut soldier",
"exres": "",
"name": "isturnedout",
"op": "isturnedout",
"rname": "unit",
"since": ""
}
],
"isUAVConnected": [
{
"cat": "General",
"desc": "Returns true if UAV is connected to some terminal.",
"ex": "isUAVConnected cursorTarget",
"exres": "",
"name": "isuavconnected",
"op": "isuavconnected",
"rname": "Uav",
"since": "106264"
}
],
"isVehicleCargo": [
{
"cat": "General",
"desc": "Return transporting vehicle if vehicle loaded in one.",
"ex": "isVehicleCargo veh",
"exres": "",
"name": "isvehiclecargo",
"op": "isvehiclecargo",
"rname": "vehicle",
"since": "134497"
}
],
"isWalking": [
{
"cat": "General",
"desc": "Returns true walk is toggled.",
"ex": "",
"exres": "",
"name": "iswalking",
"op": "iswalking",
"rname": "soldier",
"since": "5501"
}
],
"isWeaponDeployed": [
{
"cat": "General",
"desc": "Returns true if weapon is currently deployed",
"ex": "isWeaponDeployed player",
"exres": "",
"name": "isweapondeployed",
"op": "isweapondeployed",
"rname": "unit",
"since": "128934"
}
],
"isWeaponRested": [
{
"cat": "General",
"desc": "Returns true if weapon is currently rested",
"ex": "isWeaponRested player",
"exres": "",
"name": "isweaponrested",
"op": "isweaponrested",
"rname": "unit",
"since": "123800"
}
],
"itemCargo": [
{
"cat": "General",
"desc": "Get array with items from ammo box (or any general weapon holder container). ",
"ex": "",
"exres": "",
"name": "itemcargo",
"op": "itemcargo",
"rname": "box",
"since": "5501"
}
],
"items": [
{
"cat": "General",
"desc": "Returns only items that are not magazines/explosives/grenades. Includes also items that are linked on unit (i.e. includes assignedItems array)",
"ex": "",
"exres": "",
"name": "items",
"op": "items",
"rname": "unit",
"since": "5501"
}
],
"itemsWithMagazines": [
{
"cat": "General",
"desc": "Get array with all inventory items.",
"ex": "",
"exres": "",
"name": "itemswithmagazines",
"op": "itemswithmagazines",
"rname": "unit",
"since": "5501"
}
],
"keyImage": [
{
"cat": "General",
"desc": "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.",
"ex": "name = keyImage 28",
"exres": "\"Enter\"",
"name": "keyimage",
"op": "keyimage",
"rname": "dikCode",
"since": "2.01"
}
],
"keyName": [
{
"cat": "General",
"desc": "Returns the name of a button (on the keyboard, mouse or joystick) with the given code.",
"ex": "name = keyName 28",
"exres": "\"Enter\"",
"name": "keyname",
"op": "keyname",
"rname": "dikCode",
"since": "2.01"
}
],
"landResult": [
{
"cat": "General",
"desc": "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.",
"ex": "",
"exres": "",
"name": "landresult",
"op": "landresult",
"rname": "helicopter",
"since": "5501"
}
],
"laserTarget": [
{
"cat": "General",
"desc": "Returns target created by gunner in given vehicle.",
"ex": "",
"exres": "",
"name": "lasertarget",
"op": "lasertarget",
"rname": "vehicle",
"since": "5501"
}
],
"lbAdd": [
{
"cat": "General",
"desc": "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.",
"ex": "_index = lbAdd [101, \"First item\"]",
"exres": "",
"name": "lbadd",
"op": "lbadd",
"rname": "[idc, text]",
"since": "1.50"
}
],
"lbClear": [
{
"cat": "General",
"desc": "Clears all items in the given listbox or combobox.",
"ex": "lbClear _control",
"exres": "",
"name": "lbclear",
"op": "lbclear",
"rname": "control",
"since": "2.91"
},
{
"cat": "General",
"desc": "Clears all items in the listbox or combobox with id idc of the topmost user dialog.",
"ex": "lbClear 101",
"exres": "",
"name": "lbclear",
"op": "lbclear",
"rname": "idc",
"since": "1.50"
}
],
"lbColor": [
{
"cat": "General",
"desc": "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 <ar>Color</ar>.",
"ex": "_color = lbColor [101, 0]",
"exres": "",
"name": "lbcolor",
"op": "lbcolor",
"rname": "[idc, index]",
"since": "1.50"
}
],
"lbColorRight": [
{
"cat": "General",
"desc": "Returns the text color of the secondary text (right aligned) 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 <ar>Color</ar>.",
"ex": "_color = lbColorRight [101, 0]",
"exres": "",
"name": "lbcolorright",
"op": "lbcolorright",
"rname": "[idc, index]",
"since": ""
}
],
"lbCurSel": [
{
"cat": "General",
"desc": "Returns the index of the selected item of the given listbox or combobox.",
"ex": "_index = lbCurSel _control",
"exres": "",
"name": "lbcursel",
"op": "lbcursel",
"rname": "control",
"since": "2.91"
},
{
"cat": "General",
"desc": "Returns the index of the selected item of the listbox or combobox with id idc of the topmost user dialog.",
"ex": "_index = lbCurSel 101",
"exres": "",
"name": "lbcursel",
"op": "lbcursel",
"rname": "idc",
"since": "1.50"
}
],
"lbData": [
{
"cat": "General",
"desc": "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.",
"ex": "_data = lbData [101, 0]",
"exres": "",
"name": "lbdata",
"op": "lbdata",
"rname": "[idc, index]",
"since": "1.50"
}
],
"lbDelete": [
{
"cat": "General",
"desc": "Removes the item with the given index from the listbox or combobox with id idc of the topmost user dialog.",
"ex": "lbDelete [101, 0]",
"exres": "",
"name": "lbdelete",
"op": "lbdelete",
"rname": "[idc, index]",
"since": "1.50"
}
],
"lbPicture": [
{
"cat": "General",
"desc": "Returns the picture name of the item with the given index of the listbox or combobox with id idc of the topmost user dialog.",
"ex": "_picture = lbPicture [101, 0]",
"exres": "",
"name": "lbpicture",
"op": "lbpicture",
"rname": "[idc, index]",
"since": "1.50"
}
],
"lbPictureRight": [
{
"cat": "General",
"desc": "Returns the second (right aligned) picture name of the item with the given index of the listbox or combobox with id idc of the topmost user dialog.",
"ex": "_picture = lbPictureRight [101, 0]",
"exres": "",
"name": "lbpictureright",
"op": "lbpictureright",
"rname": "[idc, index]",
"since": ""
}
],
"lbSelection": [
{
"cat": "General",
"desc": "Returns the array of selected rows indices in the given listbox.",
"ex": "_indices = lbSelection _control",
"exres": "",
"name": "lbselection",
"op": "lbselection",
"rname": "control",
"since": "2.92"
}
],
"lbSetColor": [
{
"cat": "General",
"desc": "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 <ar>Color</ar>.",
"ex": "lbSetColor [101, 0, [0, 1, 0, 0.5]]",
"exres": "",
"name": "lbsetcolor",
"op": "lbsetcolor",
"rname": "[idc, index, color]",
"since": "1.50"
}
],
"lbSetColorRight": [
{
"cat": "General",
"desc": "Sets the color of the secondary text (right aligned) 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 <ar>Color</ar>.",
"ex": "lbSetColorRight [101, 0, [0, 1, 0, 0.5]]",
"exres": "",
"name": "lbsetcolorright",
"op": "lbsetcolorright",
"rname": "[idc, index, color]",
"since": ""
}
],
"lbSetCurSel": [
{
"cat": "General",
"desc": "Selects the item with the given index of the listbox or combobox with id idc of the topmost user dialog.",
"ex": "lbSetCurSel [101, 0]",
"exres": "",
"name": "lbsetcursel",
"op": "lbsetcursel",
"rname": "[idc, index]",
"since": "1.50"
}
],
"lbSetData": [
{
"cat": "General",
"desc": "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.",
"ex": "lbSetData [101, 1, \"#1\"]",
"exres": "",
"name": "lbsetdata",
"op": "lbsetdata",
"rname": "[idc, index, data]",
"since": "1.50"
}
],
"lbSetPicture": [
{
"cat": "General",
"desc": "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).",
"ex": "lbSetPicture [101, 0, \"iskoda\"]",
"exres": "",
"name": "lbsetpicture",
"op": "lbsetpicture",
"rname": "[idc, index, name]",
"since": "1.50"
}
],
"lbSetPictureColor": [
{
"cat": "General",
"desc": "Sets the color of item's picture with the given index of the listbox with id idc of the topmost user dialog to the given color. Color is in format <ar>Color</ar>. (color which consists from only zeros means disable this override)",
"ex": "lbSetPictureColor [101, 0, [0, 1, 0, 0.5]]",
"exres": "",
"name": "lbsetpicturecolor",
"op": "lbsetpicturecolor",
"rname": "[idc, index, color]",
"since": "1.50"
}
],
"lbSetPictureColorDisabled": [
{
"cat": "General",
"desc": "Sets the disabled color of item's picture with the given index of the listbox with id idc of the topmost user dialog to the given color. Color is in format <ar>Color</ar>. (color which consists from only zeros means disable this override)",
"ex": "lbSetPictureColorDisabled [101, 0, [0, 1, 0, 0.5]]",
"exres": "",
"name": "lbsetpicturecolordisabled",
"op": "lbsetpicturecolordisabled",
"rname": "[idc, index, color]",
"since": "1.50"
}
],
"lbSetPictureColorSelected": [
{
"cat": "General",
"desc": "Sets the selected color of item's picture with the given index of the listbox with id idc of the topmost user dialog to the given color. Color is in format <ar>Color</ar>. (color which consists from only zeros means disable this override)",
"ex": "lbSetPictureColorSelected [101, 0, [0, 1, 0, 0.5]]",
"exres": "",
"name": "lbsetpicturecolorselected",
"op": "lbsetpicturecolorselected",
"rname": "[idc, index, color]",
"since": "1.50"
}
],
"lbSetPictureRight": [
{
"cat": "General",
"desc": "Sets the second (right aligned) 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).",
"ex": "lbSetPictureRight [101, 0, \"iskoda\"]",
"exres": "",
"name": "lbsetpictureright",
"op": "lbsetpictureright",
"rname": "[idc, index, name]",
"since": "1.50"
}
],
"lbSetSelectColor": [
{
"cat": "General",
"desc": "Sets the select 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 <ar>Color</ar>.",
"ex": "lbSetSelectColor [101, 0, [0, 1, 0, 0.5]]",
"exres": "",
"name": "lbsetselectcolor",
"op": "lbsetselectcolor",
"rname": "[idc, index, color]",
"since": "1.50"
}
],
"lbSetSelectColorRight": [
{
"cat": "General",
"desc": "Sets the select color of the secondary text (right aligned) 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 <ar>Color</ar>.",
"ex": "lbSetSelectColorRight [101, 0, [0, 1, 0, 0.5]]",
"exres": "",
"name": "lbsetselectcolorright",
"op": "lbsetselectcolorright",
"rname": "[idc, index, color]",
"since": ""
}
],
"lbSetText": [
{
"cat": "General",
"desc": "Returns the secondary shown text in the item with the given index of the listbox or combobox with id idc of the topmost user dialog.",
"ex": "_text = lbTextRight [101, 0]",
"exres": "",
"name": "lbsettext",
"op": "lbsettext",
"rname": "[idc, index, \"text\"]",
"since": ""
}
],
"lbSetTooltip": [
{
"cat": "General",
"desc": "Sets tooltip for item with the given index of the listbox or combobox with id idc of the topmost user dialog to the given data.",
"ex": "lbSetTooltip [101, 1, \"tooltip\"]",
"exres": "",
"name": "lbsettooltip",
"op": "lbsettooltip",
"rname": "[idc, index, tooltip]",
"since": ""
}
],
"lbSetValue": [
{
"cat": "General",
"desc": "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.",
"ex": "lbSetValue [101, 0, 1]",
"exres": "",
"name": "lbsetvalue",
"op": "lbsetvalue",
"rname": "[idc, index, value]",
"since": "1.50"
}
],
"lbSize": [
{
"cat": "General",
"desc": "Returns the number of items in the given listbox or combobox.",
"ex": "_n = lbSize _control",
"exres": "",
"name": "lbsize",
"op": "lbsize",
"rname": "control",
"since": "2.91"
},
{
"cat": "General",
"desc": "Returns the number of items in the listbox or combobox with id idc of the topmost user dialog.",
"ex": "_n = lbSize 101",
"exres": "",
"name": "lbsize",
"op": "lbsize",
"rname": "idc",
"since": "1.50"
}
],
"lbSort": [
{
"cat": "General",
"desc": "Sorts the given listbox or combobox by item text.",
"ex": "lbSort _control",
"exres": "",
"name": "lbsort",
"op": "lbsort",
"rname": "control",
"since": "5148"
},
{
"cat": "General",
"desc": "Sorts the given listbox or combobox by item text, order can be \"asc\" for ascending or \"desc\" for descending.",
"ex": "lbSort [_control, \"desc\"]",
"exres": "",
"name": "lbsort",
"op": "lbsort",
"rname": "[control, order]",
"since": "5148"
}
],
"lbSortByValue": [
{
"cat": "General",
"desc": "Sorts the given listbox or combobox by item value.",
"ex": "lbSortByValue _control",
"exres": "",
"name": "lbsortbyvalue",
"op": "lbsortbyvalue",
"rname": "control",
"since": "5148"
}
],
"lbText": [
{
"cat": "General",
"desc": "Returns the shown text in the item with the given index of the listbox or combobox with id idc of the topmost user dialog.",
"ex": "_text = lbText [101, 0]",
"exres": "",
"name": "lbtext",
"op": "lbtext",
"rname": "[idc, index]",
"since": "1.50"
}
],
"lbTextRight": [
{
"cat": "General",
"desc": "Returns the secondary shown text in the item with the given index of the listbox or combobox with id idc of the topmost user dialog.",
"ex": "_text = lbTextRight [101, 0]",
"exres": "",
"name": "lbtextright",
"op": "lbtextright",
"rname": "[idc, index]",
"since": ""
}
],
"lbValue": [
{
"cat": "General",
"desc": "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.",
"ex": "_value = lbValue [101, 0]",
"exres": "",
"name": "lbvalue",
"op": "lbvalue",
"rname": "[idc, index]",
"since": "1.50"
}
],
"leader": [
{
"cat": "General",
"desc": "Returns the group leader for the given unit. For dead units, objNull is returned.",
"ex": "leader player",
"exres": "",
"name": "leader",
"op": "leader",
"rname": "unit",
"since": ""
},
{
"cat": "General",
"desc": "Returns the group leader for the given group. For a dead unit, grpNull is returned.",
"ex": "leader group player == leader player",
"exres": "",
"name": "leader",
"op": "leader",
"rname": "grp",
"since": ""
},
{
"cat": "Agents",
"desc": "Return the leader of given team.",
"ex": "",
"exres": "",
"name": "leader",
"op": "leader",
"rname": "team",
"since": "2.92"
}
],
"leaderboardDeInit": [
{
"cat": "General",
"desc": "Deletes internal class for the leaderboard with given name. Returns true if the board has been found and deinitialized.",
"ex": "leaderboardDeInit \"TT01\"",
"exres": "",
"name": "leaderboarddeinit",
"op": "leaderboarddeinit",
"rname": "boardName",
"since": ""
}
],
"leaderboardGetRows": [
{
"cat": "General",
"desc": "Returns an array with values for the given leaderboard, the array is in format: [[player1Name, score, rank, [details]], [player2Name, score, rank, [details]], [player3Name, score, rank, [details]] ... ]; This can be called after the one of the row request function has been called and successfully finished!",
"ex": "leaderboardGetRows \"TT01\"",
"exres": "",
"name": "leaderboardgetrows",
"op": "leaderboardgetrows",
"rname": "boardName",
"since": ""
}
],
"leaderboardInit": [
{
"cat": "General",
"desc": "Initialize the leaderboard structure for board with given name. Returns true if the board is already initialized.",
"ex": "leaderboardInit \"TT01\"",
"exres": "",
"name": "leaderboardinit",
"op": "leaderboardinit",
"rname": "boardName",
"since": ""
}
],
"leaderboardRequestRowsFriends": [
{
"cat": "General",
"desc": "Requests given leaderboard to download friends rows from the given leaderboard;",
"ex": "leaderboardRequestRowsFriends \"TT01\"",
"exres": "",
"name": "leaderboardrequestrowsfriends",
"op": "leaderboardrequestrowsfriends",
"rname": "boardName",
"since": ""
}
],
"leaderboardRequestRowsGlobal": [
{
"cat": "General",
"desc": "Requests given leaderboard to download values from global table; rowOffset:how many rows are skipped; rowsRequested: max. number of rows downloaded. Returns true if request has been started.",
"ex": "leaderboardRequestRowsGlobal [\"TT01\", 0, 10]",
"exres": "",
"name": "leaderboardrequestrowsglobal",
"op": "leaderboardrequestrowsglobal",
"rname": "[boardName, rowOffset, rowsRequested]",
"since": ""
}
],
"leaderboardRequestRowsGlobalAroundUser": [
{
"cat": "General",
"desc": "Requests given leaderboard to download rows around the user position in the table; rowOffset:offset from user position (ex. -5 = five position before user etc.); rowsRequested: max. number of rows downloaded; Returns true if request has been started.",
"ex": "leaderboardRequestRowsGlobalAroundUser [\"TT01\", -5, 10]",
"exres": "",
"name": "leaderboardrequestrowsglobalarounduser",
"op": "leaderboardrequestrowsglobalarounduser",
"rname": "[boardName, rowOffset, rowsRequested]",
"since": ""
}
],
"leaderboardState": [
{
"cat": "General",
"desc": "returns state of the board with given name. 0: Busy (async. operation in progress); 1: Async. operation ended with success; 2: Async. operation ended with error; 3: Invalid board (bad board name, not initialized etc.).",
"ex": "",
"exres": "",
"name": "leaderboardstate",
"op": "leaderboardstate",
"rname": "boardName",
"since": ""
}
],
"leaderboardsRequestUploadScore": [
{
"cat": "General",
"desc": "Starts async. operation to upload score to board with given name, value always overwrite the current value in the board. The details array is optional. The board has to be initialized before the call.",
"ex": "leaderboardsRequestUploadScore [\"TT01\", 1234, [5,6,7,8]]",
"exres": "",
"name": "leaderboardsrequestuploadscore",
"op": "leaderboardsrequestuploadscore",
"rname": "[boardName, score, [details]]",
"since": ""
}
],
"leaderboardsRequestUploadScoreKeepBest": [
{
"cat": "General",
"desc": "Starts async. operation to upload score to board with given name, value is only stored to board if it's better than one already in the board. The details array is optional. The board has to be initialized before the call.",
"ex": "leaderboardsRequestUploadScore [\"TT01\", 1234, [5,6,7,8]]",
"exres": "",
"name": "leaderboardsrequestuploadscorekeepbest",
"op": "leaderboardsrequestuploadscorekeepbest",
"rname": "[boardName, score, [details]]",
"since": ""
}
],
"lifeState": [
{
"cat": "General",
"desc": "Returns the life state of the given unit.",
"ex": "",
"exres": "",
"name": "lifestate",
"op": "lifestate",
"rname": "unit",
"since": "5501"
}
],
"lightDetachObject": [
{
"cat": "General",
"desc": "Detach light from object.",
"ex": "",
"exres": "",
"name": "lightdetachobject",
"op": "lightdetachobject",
"rname": "light",
"since": "2.58"
}
],
"lightIsOn": [
{
"cat": "General",
"desc": "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).",
"ex": "lightIsOn nearestObject [player, \"StreetLamp\"] != \"OFF\"",
"exres": "",
"name": "lightison",
"op": "lightison",
"rname": "lamppost",
"since": "1.04"
}
],
"lineIntersects": [
{
"cat": "General",
"desc": "Returns true, if line intersect with any object.",
"ex": "lineIntersects [begPos, endPos, withObj, ignoreObj]",
"exres": "",
"name": "lineintersects",
"op": "lineintersects",
"rname": "array",
"since": "TOH 81021"
}
],
"lineIntersectsObjs": [
{
"cat": "General",
"desc": "Returns list of objects intersected by given line. Filters (can be combined): CF_ONLY_WATER=1,CF_NEAREST_CONTACT=2,CF_ONLY_STATIC=4,CF_ONLY_DYNAMIC=8,CF_FIRST_CONTACT=16,CF_ALL_OBJECTS=32 (usable only with CF_FIRST_CONTACT and it will check one contact per object)",
"ex": "lineIntersectsObjs [begPos, endPos, withObj, ignoreObj, sortByDist, flags]",
"exres": "",
"name": "lineintersectsobjs",
"op": "lineintersectsobjs",
"rname": "array",
"since": "A3 114110"
}
],
"lineIntersectsSurfaces": [
{
"cat": "General",
"desc": "Returns list of objects and points on surfaces intersected by given line",
"ex": "lineIntersectsSurfaces [eyePos player, aimPos tgt, player]",
"exres": "",
"name": "lineintersectssurfaces",
"op": "lineintersectssurfaces",
"rname": "array",
"since": ""
}
],
"lineIntersectsWith": [
{
"cat": "General",
"desc": "Returns list of objects intersected by given line.",
"ex": "lineIntersectsWith [begPos, endPos, withObj, ignoreObj, sortByDist]",
"exres": "",
"name": "lineintersectswith",
"op": "lineintersectswith",
"rname": "array",
"since": "TOH 81021"
}
],
"linearConversion": [
{
"cat": "General",
"desc": "Converts value in interval [min, max] to newMin + a*(max-min)/(newMax - newMin), potentially clamps the final value.",
"ex": "linearConversion [4, 8, 5, 0, 1, false]",
"exres": "",
"name": "linearconversion",
"op": "linearconversion",
"rname": "[min, max, value, newMin, newMax, clamp]",
"since": ""
}
],
"list": [
{
"cat": "General",
"desc": "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\".",
"ex": "list triggerOne",
"exres": "",
"name": "list",
"op": "list",
"rname": "trigger",
"since": ""
}
],
"ln": [
{
"cat": "Default",
"desc": "The natural logarithm of x.",
"ex": "ln 10",
"exres": "2.302",
"name": "ln",
"op": "ln",
"rname": "x",
"since": ""
}
],
"lnbAddArray": [
{
"cat": "General",
"desc": "Adds list of rows of strings.",
"ex": "_index = lnbAddArray [idc,[[[text,text,text], [value], [data]], [[text,text,text], [value, value], [data]]]] . Returns row index.",
"exres": "",
"name": "lnbaddarray",
"op": "lnbaddarray",
"rname": "[IDC,[[[text,text], [value,..], [data,..]], [[text,text], [value,..], [data,..]],]]",
"since": "5501"
}
],
"lnbAddColumn": [
{
"cat": "General",
"desc": "Adds an column at given position. It returns the index of the newly added column.",
"ex": "_index = lnbAddColumn [105, 0.8]",
"exres": "",
"name": "lnbaddcolumn",
"op": "lnbaddcolumn",
"rname": "[idc, position]",
"since": "1.50"
}
],
"lnbAddRow": [
{
"cat": "General",
"desc": "Adds an row of strings.",
"ex": "_index = lnbAddRow [105, [\"First column\", \"second column\", ...]]. Returns row index.",
"exres": "",
"name": "lnbaddrow",
"op": "lnbaddrow",
"rname": "[idc, [text, text,...]]",
"since": "5501"
}
],
"lnbClear": [
{
"cat": "General",
"desc": "Clears all items in the given listbox or combobox.",
"ex": "lbClear _control",
"exres": "",
"name": "lnbclear",
"op": "lnbclear",
"rname": "control",
"since": "2.91"
},
{
"cat": "General",
"desc": "Clears all items in the 2D listbox.",
"ex": "lnbClear 101",
"exres": "",
"name": "lnbclear",
"op": "lnbclear",
"rname": "idc",
"since": "5501"
}
],
"lnbColor": [
{
"cat": "General",
"desc": "Returns the text color of the item with the given position of the 2D listbox. The color is returned in format <ar>Color</ar>.",
"ex": "_color = lnbColor [101, [0,1]]",
"exres": "",
"name": "lnbcolor",
"op": "lnbcolor",
"rname": "[idc, [row, column]",
"since": "5501"
}
],
"lnbColorRight": [
{
"cat": "General",
"desc": "Returns the secondary text (right aligned) color of the item with the given position of the 2D listbox. The color is returned in format <ar>Color</ar>.",
"ex": "_color = lnbColorRight [101, [0,1]]",
"exres": "",
"name": "lnbcolorright",
"op": "lnbcolorright",
"rname": "[idc, [row, column]",
"since": ""
}
],
"lnbCurSelRow": [
{
"cat": "General",
"desc": "Returns the index of the selected item of the given listbox or combobox.",
"ex": "_index = lbCurSel _control",
"exres": "",
"name": "lnbcurselrow",
"op": "lnbcurselrow",
"rname": "control",
"since": "2.91"
},
{
"cat": "General",
"desc": "Returns the index of the selected row id 2D listbox.",
"ex": "_row = lnbCurSel 105",
"exres": "",
"name": "lnbcurselrow",
"op": "lnbcurselrow",
"rname": "idc",
"since": "5501"
}
],
"lnbData": [
{
"cat": "General",
"desc": "Returns the additional text (invisible) in an item with the given position of the 2D listbox.",
"ex": "_data = lnbData [101, [0,1]]",
"exres": "",
"name": "lnbdata",
"op": "lnbdata",
"rname": "[idc, [row, column]",
"since": "5501"
}
],
"lnbDeleteColumn": [
{
"cat": "General",
"desc": "Removes column with given index.",
"ex": "lnbDeleteColumn [101, 0]",
"exres": "",
"name": "lnbdeletecolumn",
"op": "lnbdeletecolumn",
"rname": "[idc, index]",
"since": "5501"
}
],
"lnbDeleteRow": [
{
"cat": "General",
"desc": "Removes row with given index from the 2D listbox.",
"ex": "lnbDeleteRow [105, 0]",
"exres": "",
"name": "lnbdeleterow",
"op": "lnbdeleterow",
"rname": "[idc, index]",
"since": "1.50"
}
],
"lnbGetColumnsPosition": [
{
"cat": "General",
"desc": "Returns the index of the selected item of the given listbox or combobox.",
"ex": "_index = lbCurSel _control",
"exres": "",
"name": "lnbgetcolumnsposition",
"op": "lnbgetcolumnsposition",
"rname": "control",
"since": "2.91"
},
{
"cat": "General",
"desc": "Returns the columns position in 2D listbox.",
"ex": "_n = lnbGetColumnsSize 105",
"exres": "",
"name": "lnbgetcolumnsposition",
"op": "lnbgetcolumnsposition",
"rname": "idc",
"since": "5501"
}
],
"lnbPicture": [
{
"cat": "General",
"desc": "Returns the picture name of the item with the given position of the 2D listbox.",
"ex": "_picture = lnbPicture [101, [0,1]]",
"exres": "",
"name": "lnbpicture",
"op": "lnbpicture",
"rname": "[idc, [row, column]",
"since": "5501"
}
],
"lnbPictureRight": [
{
"cat": "General",
"desc": "Returns the second (right aligned) picture name of the item with the given position of the 2D listbox.",
"ex": "_picture = lnbPictureRight [101, [0,1]]",
"exres": "",
"name": "lnbpictureright",
"op": "lnbpictureright",
"rname": "[idc, [row, column]",
"since": ""
}
],
"lnbSetColor": [
{
"cat": "General",
"desc": "Sets the color of the item with the given position of the 2D listbox. Color is in format <ar>Color</ar>.",
"ex": "lnbSetColor [101, [0,1], [0, 1, 0, 0.5]]",
"exres": "",
"name": "lnbsetcolor",
"op": "lnbsetcolor",
"rname": "[idc, [row, column], color]",
"since": "5501"
}
],
"lnbSetColorRight": [
{
"cat": "General",
"desc": "Sets the color of the secondary text (right aligned) of the item with the given position of the 2D listbox. Color is in format <ar>Color</ar>.",
"ex": "lnbSetColorRight [101, [0,1], [0, 1, 0, 0.5]]",
"exres": "",
"name": "lnbsetcolorright",
"op": "lnbsetcolorright",
"rname": "[idc, [row, column], color]",
"since": ""
}
],
"lnbSetCurSelRow": [
{
"cat": "General",
"desc": "Selects the row with the given index of the 2D listbox.",
"ex": "lnbSetCurSel [105, 0]",
"exres": "",
"name": "lnbsetcurselrow",
"op": "lnbsetcurselrow",
"rname": "[idc, index]",
"since": "5501"
}
],
"lnbSetData": [
{
"cat": "General",
"desc": "Sets the additional text (invisible) in the item with the given position of the 2D listbox.",
"ex": "lnbSetData [101, [0,1], \"#1\"]",
"exres": "",
"name": "lnbsetdata",
"op": "lnbsetdata",
"rname": "[idc, [row, column], data]",
"since": "5501"
}
],
"lnbSetPicture": [
{
"cat": "General",
"desc": "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).",
"ex": "lnbSetPicture [101, [0,1], \"iskoda\"]",
"exres": "",
"name": "lnbsetpicture",
"op": "lnbsetpicture",
"rname": "[idc, [row, column], name]",
"since": "5501"
}
],
"lnbSetPictureColor": [
{
"cat": "General",
"desc": "Sets the picture color in the item with the given position of the 2D listbox.",
"ex": "lnbSetPictureColor [101, [0,1], [1,0,1,1]]",
"exres": "",
"name": "lnbsetpicturecolor",
"op": "lnbsetpicturecolor",
"rname": "[idc, [row, column], [r,g,b,a]]",
"since": ""
}
],
"lnbSetPictureColorRight": [
{
"cat": "General",
"desc": "Sets the second (right aligned) picture color in the item with the given position of the 2D listbox.",
"ex": "lnbSetPictureColorRight [101, [0,1], [1,0,1,1]]",
"exres": "",
"name": "lnbsetpicturecolorright",
"op": "lnbsetpicturecolorright",
"rname": "[idc, [row, column], [r,g,b,a]]",
"since": ""
}
],
"lnbSetPictureColorSelected": [
{
"cat": "General",
"desc": "Sets the picture color in the item with the given position of the 2D listbox.",
"ex": "lnbSetPictureColor [101, [0,1], [1,0,1,1]]",
"exres": "",
"name": "lnbsetpicturecolorselected",
"op": "lnbsetpicturecolorselected",
"rname": "[idc, [row, column], [r,g,b,a]]",
"since": ""
}
],
"lnbSetPictureColorSelectedRight": [
{
"cat": "General",
"desc": "Sets the second (right aligned) picture color in the item with the given position of the 2D listbox.",
"ex": "lnbSetPictureColorRight [101, [0,1], [1,0,1,1]]",
"exres": "",
"name": "lnbsetpicturecolorselectedright",
"op": "lnbsetpicturecolorselectedright",
"rname": "[idc, [row, column], [r,g,b,a]]",
"since": ""
}
],
"lnbSetPictureRight": [
{
"cat": "General",
"desc": "Sets the second (right aligned) 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).",
"ex": "lnbSetPictureRight [101, [0,1], \"iskoda\"]",
"exres": "",
"name": "lnbsetpictureright",
"op": "lnbsetpictureright",
"rname": "[idc, [row, column], name]",
"since": ""
}
],
"lnbSetText": [
{
"cat": "General",
"desc": "Sets the additional text (invisible) in the item with the given position of the 2D listbox.",
"ex": "lnbSetData [101, [0,1], \"#1\"]",
"exres": "",
"name": "lnbsettext",
"op": "lnbsettext",
"rname": "[idc, [row, column], data]",
"since": "5501"
}
],
"lnbSetTextRight": [
{
"cat": "General",
"desc": "Sets the additional text (invisible) in the item with the given position of the 2D listbox.",
"ex": "lnbSetData [101, [0,1], \"#1\"]",
"exres": "",
"name": "lnbsettextright",
"op": "lnbsettextright",
"rname": "[idc, [row, column], data]",
"since": "5501"
}
],
"lnbSetValue": [
{
"cat": "General",
"desc": "Sets the additional integer value in the item with the position index of the 2D listbox.",
"ex": "lnbSetValue [101, [0,1], 1]",
"exres": "",
"name": "lnbsetvalue",
"op": "lnbsetvalue",
"rname": "[idc, [row, column], value]",
"since": "5501"
}
],
"lnbSize": [
{
"cat": "General",
"desc": "Returns the number of items in the given listbox or combobox.",
"ex": "_n = lbSize _control",
"exres": "",
"name": "lnbsize",
"op": "lnbsize",
"rname": "control",
"since": "2.91"
},
{
"cat": "General",
"desc": "Returns [X,Y] size of 2D listbox.",
"ex": "_n = lnbSize 105",
"exres": "",
"name": "lnbsize",
"op": "lnbsize",
"rname": "idc",
"since": "5501"
}
],
"lnbSort": [
{
"cat": "General",
"desc": "Sorts given multicolumn listbox by texts in given column in ascending or descending order.",
"ex": "lnbSort [_idc, 0, false]",
"exres": "",
"name": "lnbsort",
"op": "lnbsort",
"rname": "[<control_IDC>, <column>(, <order>)]",
"since": ""
}
],
"lnbSortByValue": [
{
"cat": "General",
"desc": "Sorts given multicolumn listbox by values in given column in ascending or descending order.",
"ex": "lnbSortByValue [_idc, 0, false]",
"exres": "",
"name": "lnbsortbyvalue",
"op": "lnbsortbyvalue",
"rname": "[<control_IDC>, <column>(, <order>)]",
"since": ""
}
],
"lnbText": [
{
"cat": "General",
"desc": "Returns the shown text in the item with the given position of the 2D listbox.",
"ex": "_text = lnbText [101, [0,1]]",
"exres": "",
"name": "lnbtext",
"op": "lnbtext",
"rname": "[idc, [row, column]]",
"since": "1.50"
}
],
"lnbTextRight": [
{
"cat": "General",
"desc": "Returns the shown secondary text (right aligned) in the item with the given position of the 2D listbox.",
"ex": "_text = lnbTextRight [101, [0,1]]",
"exres": "",
"name": "lnbtextright",
"op": "lnbtextright",
"rname": "[idc, [row, column]]",
"since": ""
}
],
"lnbValue": [
{
"cat": "General",
"desc": "Returns the additional integer value in the item with the given position of the 2D listbox.",
"ex": "_value = lnbValue [101, [0,1]]",
"exres": "",
"name": "lnbvalue",
"op": "lnbvalue",
"rname": "[idc, [row, column]",
"since": "5501"
}
],
"lnbsetColumnsPos": [
{
"cat": "General",
"desc": "Sets the additional text (invisible) in the item with the given position of the 2D listbox.",
"ex": "lnbSetData [101, [0,1], \"#1\"]",
"exres": "",
"name": "lnbsetcolumnspos",
"op": "lnbsetcolumnspos",
"rname": "[idc, [row, column], data]",
"since": "5501"
}
],
"load": [
{
"cat": "General",
"desc": "Returns current sum of mass from items stored in all unit's containers.",
"ex": "load player",
"exres": "",
"name": "load",
"op": "load",
"rname": "unit",
"since": "5501"
}
],
"loadAbs": [
{
"cat": "General",
"desc": "Returns current sum of mass from items stored in a all unit's containers, linked items and weapons.",
"ex": "loadAbs player",
"exres": "",
"name": "loadabs",
"op": "loadabs",
"rname": "unit",
"since": "5501"
}
],
"loadBackpack": [
{
"cat": "General",
"desc": "Returns current sum of mass from items stored in a backpack.",
"ex": "loadBackpack player",
"exres": "",
"name": "loadbackpack",
"op": "loadbackpack",
"rname": "unit",
"since": "5501"
}
],
"loadFile": [
{
"cat": "General",
"desc": "Returns contents of a given file. On dedicated server/client connected to a dedicated server, if allowedLoadFileExtensions parameter is used in the DS config file this only returns contents of a file if the file extension is listed in it. The list should contain at least the following extensions: hpp, sqs, sqf, fsm, cpp, paa, txt, xml, inc, ext, sqm, ods, fxy, lip, csv, kb, bik, bikn, html, biedi. Note, this list may not be completely up to date",
"ex": "loadFile \"myFunction.sqf\"",
"exres": "\"if a>b then {a} else {b}\"",
"name": "loadfile",
"op": "loadfile",
"rname": "filename",
"since": "1.82"
}
],
"loadUniform": [
{
"cat": "General",
"desc": "Returns current sum of mass from items stored in a uniform.",
"ex": "loadUniform player",
"exres": "",
"name": "loaduniform",
"op": "loaduniform",
"rname": "unit",
"since": "5501"
}
],
"loadVest": [
{
"cat": "General",
"desc": "Returns current sum of mass from items stored in a vest.",
"ex": "loadVest player",
"exres": "",
"name": "loadvest",
"op": "loadvest",
"rname": "unit",
"since": "5501"
}
],
"local": [
{
"cat": "General",
"desc": "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.\r\nIn SP all objects are local. Note: all static objects are local on all computers.",
"ex": "local unitName",
"exres": "",
"name": "local",
"op": "local",
"rname": "obj",
"since": ""
},
{
"cat": "General",
"desc": "MP: checks whether the given group is local on the computer.",
"ex": "local group1",
"exres": "",
"name": "local",
"op": "local",
"rname": "grp",
"since": ""
}
],
"localize": [
{
"cat": "General",
"desc": "Replaces the string with the given name with the corresponding localized text from the stringtable.csv file.",
"ex": "localize \"STR_DN_FROG\"",
"exres": "",
"name": "localize",
"op": "localize",
"rname": "stringName",
"since": ""
}
],
"locationPosition": [
{
"cat": "Location",
"desc": "Return position of given location.",
"ex": "",
"exres": "",
"name": "locationposition",
"op": "locationposition",
"rname": "location",
"since": "2.90"
}
],
"lockIdentity": [
{
"cat": "General",
"desc": "Locks identity of a person. This will disable default identity.",
"ex": "unit lockIdentity",
"exres": "",
"name": "lockidentity",
"op": "lockidentity",
"rname": "person",
"since": ""
}
],
"locked": [
{
"cat": "General",
"desc": "Checks whether the vehicle is locked for the player. If it's locked, the player cannot mount / dismount without an order. 0 - Unlocked, 1 - Default, 2 - Locked, 3 - Locked for player",
"ex": "locked jeepOne",
"exres": "",
"name": "locked",
"op": "locked",
"rname": "unit",
"since": ""
}
],
"lockedDriver": [
{
"cat": "General",
"desc": "Check whether driver position of the vehicle turret is locked.",
"ex": "",
"exres": "",
"name": "lockeddriver",
"op": "lockeddriver",
"rname": "vehicle",
"since": "5501"
}
],
"log": [
{
"cat": "Default",
"desc": "The base-10 logarithm of x.",
"ex": "log 10",
"exres": "1",
"name": "log",
"op": "log",
"rname": "x",
"since": ""
}
],
"logNetwork": [
{
"cat": "General",
"desc": "Registers new log file for recording a network traffic, returns handle for the log.",
"ex": "logNetwork \"myLog.txt\"",
"exres": "",
"name": "lognetwork",
"op": "lognetwork",
"rname": "[filename, filter]",
"since": ""
}
],
"logNetworkTerminate": [
{
"cat": "General",
"desc": "Terminates a network log file with given handle",
"ex": "logNetworkTerminate _handle",
"exres": "",
"name": "lognetworkterminate",
"op": "lognetworkterminate",
"rname": "logHandle",
"since": ""
}
],
"magazineCargo": [
{
"cat": "General",
"desc": "Get array with magazines from ammo box (or any general weapon holder container). ",
"ex": "",
"exres": "",
"name": "magazinecargo",
"op": "magazinecargo",
"rname": "box ",
"since": "5501"
}
],
"magazines": [
{
"cat": "General",
"desc": "Returns an array with the type names of all the vehicle's magazines.",
"ex": "magazines player",
"exres": "",
"name": "magazines",
"op": "magazines",
"rname": "vehicle",
"since": "1.75"
}
],
"magazinesAllTurrets": [
{
"cat": "General",
"desc": "Returns an array with the type names of all the vehicle's magazines and ammo count.",
"ex": "magazinesAllTurrets tank",
"exres": "",
"name": "magazinesallturrets",
"op": "magazinesallturrets",
"rname": "vehicle",
"since": "1.75"
}
],
"magazinesAmmo": [
{
"cat": "General",
"desc": "Returns an array of subarrays with the type names and ammo left of all the vehicle's magazines.",
"ex": "magazinesAmmo player",
"exres": "",
"name": "magazinesammo",
"op": "magazinesammo",
"rname": "vehicle",
"since": "1.75"
}
],
"magazinesAmmoCargo": [
{
"cat": "General",
"desc": "Returns an array of subarrays with the type names and ammo left of all the vehicle's cargo magazines.",
"ex": "magazinesAmmoCargo vehicle player",
"exres": "",
"name": "magazinesammocargo",
"op": "magazinesammocargo",
"rname": "vehicle",
"since": "1.75"
}
],
"magazinesAmmoFull": [
{
"cat": "General",
"desc": "Returns an array of subarrays with the type names and ammo left of all the vehicle's magazines.",
"ex": "magazinesAmmoFull player",
"exres": "",
"name": "magazinesammofull",
"op": "magazinesammofull",
"rname": "vehicle",
"since": "1.75"
}
],
"magazinesDetail": [
{
"cat": "General",
"desc": "Returns an array with the type names of all the unit's magazines.",
"ex": "magazines player",
"exres": "",
"name": "magazinesdetail",
"op": "magazinesdetail",
"rname": "unit",
"since": "1.75"
}
],
"magazinesDetailBackpack": [
{
"cat": "General",
"desc": "Returns an array with the type names of all the unit's backpack magazines.",
"ex": "magazinesBackpack player",
"exres": "",
"name": "magazinesdetailbackpack",
"op": "magazinesdetailbackpack",
"rname": "unit",
"since": "1.75"
}
],
"magazinesDetailUniform": [
{
"cat": "General",
"desc": "Returns an array with the type names of all the unit's uniform magazines.",
"ex": "magazinesUniform player",
"exres": "",
"name": "magazinesdetailuniform",
"op": "magazinesdetailuniform",
"rname": "unit",
"since": "1.75"
}
],
"magazinesDetailVest": [
{
"cat": "General",
"desc": "Returns an array with the type names of all the unit's vest magazines.",
"ex": "magazinesVest player",
"exres": "",
"name": "magazinesdetailvest",
"op": "magazinesdetailvest",
"rname": "unit",
"since": "1.75"
}
],
"mapAnimAdd": [
{
"cat": "General",
"desc": "Adds the next frame to the map animation. The format of frame is [time, zoom, position], the format of position is <ar>Position2D</ar>.",
"ex": "mapAnimAdd [1, 0.1, getMarkerPos \"anim1\"]",
"exres": "",
"name": "mapanimadd",
"op": "mapanimadd",
"rname": "frame",
"since": "1.27"
}
],
"mapCenterOnCamera": [
{
"cat": "General",
"desc": "center minimap on camera",
"ex": "",
"exres": "",
"name": "mapcenteroncamera",
"op": "mapcenteroncamera",
"rname": "map",
"since": "2.90"
}
],
"mapGridPosition": [
{
"cat": "General",
"desc": "Returns the position as map coords.",
"ex": "mapGridPosition player",
"exres": "",
"name": "mapgridposition",
"op": "mapgridposition",
"rname": "object",
"since": "5501"
}
],
"markerAlpha": [
{
"cat": "General",
"desc": "Gets the marker alpha. See <f>setMarkerAlpha</f>.",
"ex": "markerAlpha \"MarkerOne\"",
"exres": "",
"name": "markeralpha",
"op": "markeralpha",
"rname": "markerName",
"since": "5501"
}
],
"markerBrush": [
{
"cat": "General",
"desc": "Gets the marker brush. See <f>setMarkerBrush</f>.",
"ex": "markerBrush \"MarkerOne\"",
"exres": "",
"name": "markerbrush",
"op": "markerbrush",
"rname": "name",
"since": "5501"
}
],
"markerColor": [
{
"cat": "General",
"desc": "Gets the marker color. See <f>setMarkerColor</f>.\r\nNote: this function is identical to <f>getMarkerColor</f>.",
"ex": "markerColor \"MarkerOne\"",
"exres": "",
"name": "markercolor",
"op": "markercolor",
"rname": "markerName",
"since": "1.50"
}
],
"markerDir": [
{
"cat": "General",
"desc": "Gets the marker direction. See <f>setMarkerDir</f>.",
"ex": "markerDir \"MarkerOne\"",
"exres": "",
"name": "markerdir",
"op": "markerdir",
"rname": "markerName",
"since": "2.92"
}
],
"markerPos": [
{
"cat": "General",
"desc": "Returns the marker position in format [x,z,y].\r\nNote: this function is identical to <f>getMarkerPos</f>.",
"ex": "markerPos \"markerOne\"",
"exres": "",
"name": "markerpos",
"op": "markerpos",
"rname": "markerName",
"since": "1.50"
}
],
"markerShape": [
{
"cat": "General",
"desc": "Gets the marker shape. See <f>setMarkerShape</f>.",
"ex": "markerShape \"MarkerOne\"",
"exres": "",
"name": "markershape",
"op": "markershape",
"rname": "name",
"since": "5501"
}
],
"markerSize": [
{
"cat": "General",
"desc": "Gets the marker size. See <f>setMarkerSize</f>.\r\nNote: this function is identical to <f>getMarkerSize</f>.",
"ex": "markerSize \"MarkerOne\"",
"exres": "",
"name": "markersize",
"op": "markersize",
"rname": "markerName",
"since": "1.50"
}
],
"markerText": [
{
"cat": "General",
"desc": "Gets the marker text. See <f>setMarkerText</f>.",
"ex": "markerText \"MarkerOne\"",
"exres": "",
"name": "markertext",
"op": "markertext",
"rname": "markerName",
"since": "2.92"
}
],
"markerType": [
{
"cat": "General",
"desc": "Gets the type of the marker. See <f>setMarkerType</f>.\r\nNote: this function is identical to <f>getMarkerType</f>.",
"ex": "markerType \"MarkerOne\"",
"exres": "",
"name": "markertype",
"op": "markertype",
"rname": "markerName",
"since": "1.50"
}
],
"members": [
{
"cat": "Agents",
"desc": "Return a list of members in given team.",
"ex": "_members = members _team",
"exres": "",
"name": "members",
"op": "members",
"rname": "team",
"since": "2.90"
}
],
"menuAction": [
{
"cat": "General",
"desc": "Returns action stored in item on given path.",
"ex": "example",
"exres": "",
"name": "menuaction",
"op": "menuaction",
"rname": "[<idc>, <path>]",
"since": ""
}
],
"menuAdd": [
{
"cat": "General",
"desc": "Adds new submenu entry into item on given path.",
"ex": "example",
"exres": "",
"name": "menuadd",
"op": "menuadd",
"rname": "[<idc>, <path>, <text>]",
"since": ""
}
],
"menuChecked": [
{
"cat": "General",
"desc": "Returns if item on given path is checked or not.",
"ex": "example",
"exres": "",
"name": "menuchecked",
"op": "menuchecked",
"rname": "[<idc>, <path>]",
"since": ""
}
],
"menuCollapse": [
{
"cat": "General",
"desc": "Collapses item on given path and all its childs.",
"ex": "example",
"exres": "",
"name": "menucollapse",
"op": "menucollapse",
"rname": "[<idc>, <path>]",
"since": ""
}
],
"menuData": [
{
"cat": "General",
"desc": "Returns data stored in menu entry on given path",
"ex": "example",
"exres": "",
"name": "menudata",
"op": "menudata",
"rname": "[<idc>, <path>]",
"since": ""
}
],
"menuDelete": [
{
"cat": "General",
"desc": "Deletes menu entry on given path.",
"ex": "example",
"exres": "",
"name": "menudelete",
"op": "menudelete",
"rname": "[<idc>, <path>]",
"since": ""
}
],
"menuEnable": [
{
"cat": "General",
"desc": "Enables disabled menu entry on given path.",
"ex": "example",
"exres": "",
"name": "menuenable",
"op": "menuenable",
"rname": "[<idc>, <path>]",
"since": ""
}
],
"menuEnabled": [
{
"cat": "General",
"desc": "Returns if menu entry on given path is enabled or not.",
"ex": "example",
"exres": "",
"name": "menuenabled",
"op": "menuenabled",
"rname": "[<idc>, <path>]",
"since": ""
}
],
"menuExpand": [
{
"cat": "General",
"desc": "Expands given menu entry on given path and all its parents so entry is visible.",
"ex": "example",
"exres": "",
"name": "menuexpand",
"op": "menuexpand",
"rname": "[<idc>, <path>]",
"since": ""
}
],
"menuHover": [
{
"cat": "General",
"desc": "Returns path to menu entry mouse is currently hovering over.",
"ex": "example",
"exres": "",
"name": "menuhover",
"op": "menuhover",
"rname": "<MenuStripControl>",
"since": ""
},
{
"cat": "General",
"desc": "Returns path to menu entry mouse is currently hovering over.",
"ex": "example",
"exres": "",
"name": "menuhover",
"op": "menuhover",
"rname": "<idc>",
"since": ""
}
],
"menuPicture": [
{
"cat": "General",
"desc": "Returns picture set into item on given path",
"ex": "example",
"exres": "",
"name": "menupicture",
"op": "menupicture",
"rname": "[<idc>, <path>]",
"since": ""
}
],
"menuSetAction": [
{
"cat": "General",
"desc": "Sets new action into menu entry on given path.",
"ex": "example",
"exres": "",
"name": "menusetaction",
"op": "menusetaction",
"rname": "[<idc>, <path>, <action>]",
"since": ""
}
],
"menuSetCheck": [
{
"cat": "General",
"desc": "Sets item on given path to be checked or not.",
"ex": "example",
"exres": "",
"name": "menusetcheck",
"op": "menusetcheck",
"rname": "[<idc>, <path>, <bool>]",
"since": ""
}
],
"menuSetData": [
{
"cat": "General",
"desc": "Sets new data into item on given path.",
"ex": "example",
"exres": "",
"name": "menusetdata",
"op": "menusetdata",
"rname": "[<idc>, <path>, <data>]",
"since": ""
}
],
"menuSetPicture": [
{
"cat": "General",
"desc": "Sets new picture into menu entry on given path.",
"ex": "example",
"exres": "",
"name": "menusetpicture",
"op": "menusetpicture",
"rname": "[<idc>, <path>, <picture>]",
"since": ""
}
],
"menuSetValue": [
{
"cat": "General",
"desc": "Sets new value into menu entry on given path.",
"ex": "example",
"exres": "",
"name": "menusetvalue",
"op": "menusetvalue",
"rname": "[<idc>, <path>, value]",
"since": ""
}
],
"menuShortcut": [
{
"cat": "General",
"desc": "Returns shortcut related to menu entry on given path.",
"ex": "example",
"exres": "",
"name": "menushortcut",
"op": "menushortcut",
"rname": "[<idc>, <path>]",
"since": ""
}
],
"menuShortcutText": [
{
"cat": "General",
"desc": "Returns string containing shortcut text for menu itme on given path.",
"ex": "example",
"exres": "",
"name": "menushortcuttext",
"op": "menushortcuttext",
"rname": "[<idc>, <path>]",
"since": ""
}
],
"menuSize": [
{
"cat": "General",
"desc": "Returns how many sub entries is in item on given path.",
"ex": "example",
"exres": "",
"name": "menusize",
"op": "menusize",
"rname": "[<idc>, <path>]",
"since": ""
}
],
"menuSort": [
{
"cat": "General",
"desc": "Sorts subentries of item on given path by their text.",
"ex": "example",
"exres": "",
"name": "menusort",
"op": "menusort",
"rname": "[<idc>, <path>, <reversed>]",
"since": ""
}
],
"menuText": [
{
"cat": "General",
"desc": "Returns current text set in menu entry on given path.",
"ex": "example",
"exres": "",
"name": "menutext",
"op": "menutext",
"rname": "[<idc>, <path>]",
"since": ""
}
],
"menuURL": [
{
"cat": "General",
"desc": "Returns current URL set in entry on given path.",
"ex": "example",
"exres": "",
"name": "menuurl",
"op": "menuurl",
"rname": "[<idc>, <path>]",
"since": ""
}
],
"menuValue": [
{
"cat": "General",
"desc": "Returns current value set in menu entry on given path.",
"ex": "example",
"exres": "",
"name": "menuvalue",
"op": "menuvalue",
"rname": "[<idc>, <path>]",
"since": ""
}
],
"mineActive": [
{
"cat": "General",
"desc": "Checks whether the given mine is active",
"ex": "active mine",
"exres": "",
"name": "mineactive",
"op": "mineactive",
"rname": "obj",
"since": ""
}
],
"modParams": [
{
"cat": "General",
"desc": "Returns list of mod parameters according to given options, values are in same order as the given options. Available options: name, picture, logo, logoOver, logoSmall, tooltip, tooltipowned, action, actionName, overview, hidePicture, hideName, defaultMod, serverOnly, active",
"ex": "modParams [\"Kart\", [\"name\", \"logo\", \"picture\"]]",
"exres": "",
"name": "modparams",
"op": "modparams",
"rname": "[modName, [options]]",
"since": ""
}
],
"moonPhase": [
{
"cat": "General",
"desc": "Returns the moon phase on the specified date.",
"ex": "hint str moonPhase date",
"exres": "",
"name": "moonphase",
"op": "moonphase",
"rname": "[year, month, day, hour, minute]",
"since": ""
}
],
"morale": [
{
"cat": "General",
"desc": "Checks a current morale level of the unit (-1..+1).",
"ex": "morale leader player",
"exres": "0.5",
"name": "morale",
"op": "morale",
"rname": "unit",
"since": "5500"
}
],
"move3DENCamera": [
{
"cat": "General",
"desc": "Moves 3DEN camera to given position.",
"ex": "",
"exres": "",
"name": "move3dencamera",
"op": "move3dencamera",
"rname": "<position, useOffset>",
"since": ""
}
],
"moveOut": [
{
"cat": "General",
"desc": "Moves the soldier out of vehicle. (Immediately, without animation).",
"ex": "",
"exres": "",
"name": "moveout",
"op": "moveout",
"rname": "soldier",
"since": "5501"
}
],
"moveTime": [
{
"cat": "General",
"desc": "Returns the current time of the most important RTM animation currently being played on the soldier.",
"ex": "moveTime player",
"exres": "",
"name": "movetime",
"op": "movetime",
"rname": "soldier",
"since": "5500"
}
],
"moveToCompleted": [
{
"cat": "General",
"desc": "Check if latest low level moveTo command is finished.",
"ex": "",
"exres": "",
"name": "movetocompleted",
"op": "movetocompleted",
"rname": "person",
"since": "2.62"
}
],
"moveToFailed": [
{
"cat": "General",
"desc": "Check if latest low level moveTo command failed.",
"ex": "",
"exres": "",
"name": "movetofailed",
"op": "movetofailed",
"rname": "person",
"since": "2.92"
}
],
"name": [
{
"cat": "General",
"desc": "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).",
"ex": "name vehicle player",
"exres": "",
"name": "name",
"op": "name",
"rname": "object",
"since": ""
},
{
"cat": "Location",
"desc": "Return name of global vatiable containing given location.",
"ex": "",
"exres": "",
"name": "name",
"op": "name",
"rname": "location",
"since": "2.90"
}
],
"nameSound": [
{
"cat": "General",
"desc": "Returns the nameSound of the variable assigned to the object in the mission editor.",
"ex": "nameSound player",
"exres": "",
"name": "namesound",
"op": "namesound",
"rname": "object",
"since": ""
}
],
"nearestBuilding": [
{
"cat": "General",
"desc": "Returns the nearest building to the given object.",
"ex": "neareastBuilding player",
"exres": "",
"name": "nearestbuilding",
"op": "nearestbuilding",
"rname": "obj",
"since": ""
},
{
"cat": "General",
"desc": "Returns the nearest building to the given position.",
"ex": "neareastBuilding position player",
"exres": "",
"name": "nearestbuilding",
"op": "nearestbuilding",
"rname": "pos",
"since": "OA 93648"
}
],
"nearestLocation": [
{
"cat": "Location",
"desc": "Find the nearest location (to the given position) of given type.",
"ex": "",
"exres": "",
"name": "nearestlocation",
"op": "nearestlocation",
"rname": "[position, type]",
"since": "2.90"
}
],
"nearestLocationWithDubbing": [
{
"cat": "Location",
"desc": "Find the nearest location (to the given position) having it speech non-empty.",
"ex": "",
"exres": "",
"name": "nearestlocationwithdubbing",
"op": "nearestlocationwithdubbing",
"rname": "position",
"since": "5501"
}
],
"nearestLocations": [
{
"cat": "Location",
"desc": "Find the nearest locations (from the given position) of certain types, within the specified distance. If &lt;position to sort from&gt; is provided, locations will be ordered by distance from this point.",
"ex": "",
"exres": "",
"name": "nearestlocations",
"op": "nearestlocations",
"rname": "[position, [types], distance, <position to sort from>]",
"since": "2.92"
}
],
"nearestObject": [
{
"cat": "General",
"desc": "Returns the nearest object of the given type to the given position or object.\r\nPos may be using format [x,y,z, \"type\"] or [object, \"type\"].",
"ex": "nearestObject [player, \"StreetLamp\"]",
"exres": "",
"name": "nearestobject",
"op": "nearestobject",
"rname": "pos",
"since": ""
}
],
"nearestObjects": [
{
"cat": "General",
"desc": "Returns a list of nearest objects of the given types to the given position or object, within the specified distance.\r\nPos may be using format [x,y,z, [\"type\",...], limit] or [object, [\"type\",...], limit].",
"ex": "nearestObjects [player, [\"Car\",\"Tank\"], 200]",
"exres": "",
"name": "nearestobjects",
"op": "nearestobjects",
"rname": "[pos,[map types], radius, testIn2D]",
"since": "2.92"
}
],
"nearestTerrainObjects": [
{
"cat": "General",
"desc": "Returns a list of nearest objects of the given map types to the given position or object, within the specified distance. The returned list can be sorted or unsorted.\r\nPos may be using format [x,y,z, [\"map type\",...], limit] or [object, [\"map type\",...], limit].",
"ex": "nearestTerrainObjects [player, [\"church\",\"chapel\"], 200, true]",
"exres": "",
"name": "nearestterrainobjects",
"op": "nearestterrainobjects",
"rname": "[pos,[map types], radius, sorted, testIn2D]",
"since": "2.92"
}
],
"needReload": [
{
"cat": "General",
"desc": "Return how much vehicle wants to reload its weapons.",
"ex": "",
"exres": "",
"name": "needreload",
"op": "needreload",
"rname": "vehicle",
"since": "2.92"
}
],
"netId": [
{
"cat": "General",
"desc": "Unique ID of an object.",
"ex": "netId player",
"exres": "1:8965",
"name": "netid",
"op": "netid",
"rname": "object",
"since": ""
},
{
"cat": "General",
"desc": "Unique ID of a group.",
"ex": "netId (group player)",
"exres": "1:5623",
"name": "netid",
"op": "netid",
"rname": "group",
"since": ""
}
],
"nextMenuItemIndex": [
{
"cat": "Editor",
"desc": "Returns the next available menu item index.",
"ex": "",
"exres": "",
"name": "nextmenuitemindex",
"op": "nextmenuitemindex",
"rname": "map",
"since": "2.92"
}
],
"not": [
{
"cat": "Default",
"desc": "not a",
"ex": "not false",
"exres": "true",
"name": "not",
"op": "not",
"rname": "a",
"since": ""
}
],
"numberOfEnginesRTD": [
{
"cat": "General",
"desc": "Returns number of engines helicopter has.",
"ex": "",
"exres": "",
"name": "numberofenginesrtd",
"op": "numberofenginesrtd",
"rname": "RTD_helicopter",
"since": "TOH 81393"
}
],
"numberToDate": [
{
"cat": "General",
"desc": "Convert float number to date.",
"ex": "date = NumberToDate [2008,0.5324]",
"exres": "",
"name": "numbertodate",
"op": "numbertodate",
"rname": "[year,time]",
"since": "5501"
}
],
"objectCurators": [
{
"cat": "General",
"desc": "Returns array with all curators which can edit given object.",
"ex": "",
"exres": "",
"name": "objectcurators",
"op": "objectcurators",
"rname": "obj",
"since": ""
}
],
"objectFromNetId": [
{
"cat": "General",
"desc": "Get object with given unique ID.",
"ex": "objectFromNetId netId player",
"exres": "player",
"name": "objectfromnetid",
"op": "objectfromnetid",
"rname": "id",
"since": ""
}
],
"objectParent": [
{
"cat": "General",
"desc": "Returns object's parent.",
"ex": "",
"exres": "",
"name": "objectparent",
"op": "objectparent",
"rname": "object",
"since": ""
}
],
"onBriefingGroup": [
{
"cat": "General",
"desc": "Defines a sound (voice) that is played the first time when the Group section in the briefing is selected.",
"ex": "onBriefingGroup \"GroupVoiceOver\"",
"exres": "",
"name": "onbriefinggroup",
"op": "onbriefinggroup",
"rname": "sound",
"since": "1.75"
}
],
"onBriefingNotes": [
{
"cat": "General",
"desc": "Defines a sound (voice) that is played the first time when the Notes section in the briefing is selected.",
"ex": "onBriefingNotes \"NotesVoiceOver\"",
"exres": "",
"name": "onbriefingnotes",
"op": "onbriefingnotes",
"rname": "sound",
"since": "1.75"
}
],
"onBriefingPlan": [
{
"cat": "General",
"desc": "Defines a sound (voice) that is played the first time when the Plan section in the briefing is selected.",
"ex": "onBriefingPlan \"PlanVoiceOver\"",
"exres": "",
"name": "onbriefingplan",
"op": "onbriefingplan",
"rname": "sound",
"since": "1.75"
}
],
"onBriefingTeamSwitch": [
{
"cat": "General",
"desc": "Defines a sound (voice) that is played the first time when the Team switch section in the briefing is selected.",
"ex": "onBriefingTeamSwitch \"TeamSwitchVoiceOver\"",
"exres": "",
"name": "onbriefingteamswitch",
"op": "onbriefingteamswitch",
"rname": "sound",
"since": "2.92"
}
],
"onCommandModeChanged": [
{
"cat": "General",
"desc": "Defines an action performed when command mode change. Command receives <br/>\r\n_isHighCommand <t>bool</t> ",
"ex": "",
"exres": "",
"name": "oncommandmodechanged",
"op": "oncommandmodechanged",
"rname": "command",
"since": "5501"
}
],
"onEachFrame": [
{
"cat": "General",
"desc": "Defines an action performed on each frame (even when game is paused). Code is performed synchronously, cannot contain any sleep or wait.",
"ex": "onEachFrame {}",
"exres": "",
"name": "oneachframe",
"op": "oneachframe",
"rname": "command",
"since": "97871"
}
],
"onGroupIconClick": [
{
"cat": "General",
"desc": "Defines an action performed when player clicked on group marker (3D or in a map)",
"ex": "",
"exres": "",
"name": "ongroupiconclick",
"op": "ongroupiconclick",
"rname": "command",
"since": "5501"
}
],
"onGroupIconOverEnter": [
{
"cat": "General",
"desc": "Defines an action performed when player clicked on group marker (3D or in a map)",
"ex": "",
"exres": "",
"name": "ongroupiconoverenter",
"op": "ongroupiconoverenter",
"rname": "command",
"since": "5501"
}
],
"onGroupIconOverLeave": [
{
"cat": "General",
"desc": "Defines an action performed when player clicked on group marker (3D or in a map)",
"ex": "",
"exres": "",
"name": "ongroupiconoverleave",
"op": "ongroupiconoverleave",
"rname": "command",
"since": "5501"
}
],
"onHCGroupSelectionChanged": [
{
"cat": "General",
"desc": "Defines an action performed when HC group has been selected. Command receives <br/>\r\n_group <t>group</t> selected group <br/>\r\n_isSelected <t>bool</t> new selection state",
"ex": "",
"exres": "",
"name": "onhcgroupselectionchanged",
"op": "onhcgroupselectionchanged",
"rname": "command",
"since": "5501"
}
],
"onMapSingleClick": [
{
"cat": "General",
"desc": "Defines an action performed when the user clicks on the map. Command receives:<br/>\r\n<br/>\r\n_pos <t>array</t> position<br/>\r\n_units <t>array</t> selected units<br/>\r\n_shift,_alt <t>bool</t> key state<br/>\r\n<br/>If the click is processed, command should return true.",
"ex": "onMapSingleClick \"\"\"SoldierEG\"\" createUnit [_pos, group player]\"",
"exres": "",
"name": "onmapsingleclick",
"op": "onmapsingleclick",
"rname": "command",
"since": "1.91"
}
],
"onPlayerConnected": [
{
"cat": "General",
"desc": "This statement is launched whenever a player is connected to a MP session. Variables _id, _name and _uid are set. See also getPlayerUID, kickUID, banUID.",
"ex": "",
"exres": "",
"name": "onplayerconnected",
"op": "onplayerconnected",
"rname": "statement",
"since": "2.10"
}
],
"onPlayerDisconnected": [
{
"cat": "General",
"desc": "This statement is launched whenever a player is disconnected from a MP session. Variables _id, _name and _uid are set.",
"ex": "",
"exres": "",
"name": "onplayerdisconnected",
"op": "onplayerdisconnected",
"rname": "statement",
"since": "2.10"
}
],
"onPreloadFinished": [
{
"cat": "General",
"desc": "Defines an action performed after the preload screen finished.",
"ex": "",
"exres": "",
"name": "onpreloadfinished",
"op": "onpreloadfinished",
"rname": "command",
"since": "5501"
}
],
"onPreloadStarted": [
{
"cat": "General",
"desc": "Defines an action performed just before the preload screen started.",
"ex": "",
"exres": "",
"name": "onpreloadstarted",
"op": "onpreloadstarted",
"rname": "command",
"since": "5501"
}
],
"onTeamSwitch": [
{
"cat": "General",
"desc": "Defines an action performed when the team switch is finished. Command receives:<br/>\r\n<br/>\r\n_from <t>object</t> previous unit<br/>\r\n_to <t>object</t> current units<br/>\r\n<br/>",
"ex": "",
"exres": "",
"name": "onteamswitch",
"op": "onteamswitch",
"rname": "command",
"since": "5500"
}
],
"openDLCPage": [
{
"cat": "General",
"desc": "Opens a Steam page of the app with given appId. Only works for known appId (game + linked DLCs)",
"ex": "openDLCPage 288520",
"exres": "",
"name": "opendlcpage",
"op": "opendlcpage",
"rname": "appId",
"since": ""
}
],
"openMap": [
{
"cat": "General",
"desc": "Show player's map. If forced, cannot be closed.",
"ex": "openMap [true,true]",
"exres": "",
"name": "openmap",
"op": "openmap",
"rname": "[show, forced]",
"since": "5501"
},
{
"cat": "General",
"desc": "Show player's map. If forced, cannot be closed.",
"ex": "openMap true",
"exres": "",
"name": "openmap",
"op": "openmap",
"rname": "show",
"since": "5501"
}
],
"openYoutubeVideo": [
{
"cat": "General",
"desc": "Opens Steam overlay with the given YT video. The YT url is the end of the video page url. Example: for 'https://www.youtube.com/watch?v=DXIoEUq8YE8' set youTubeUrl to 'watch?v=DXIoEUq8YE8'",
"ex": "",
"exres": "",
"name": "openyoutubevideo",
"op": "openyoutubevideo",
"rname": "youTubeUrl",
"since": ""
}
],
"owner": [
{
"cat": "General",
"desc": "On server machine, return the ID of the client where the object is local. Otherwise return 0.",
"ex": "",
"exres": "",
"name": "owner",
"op": "owner",
"rname": "object",
"since": "5501"
}
],
"param": [
{
"cat": "General",
"desc": "Parses _this param inside a script by given index and returns the value",
"ex": "[1,2,3] call {_two = param [1,25]};",
"exres": "",
"name": "param",
"op": "param",
"rname": "array",
"since": ""
}
],
"params": [
{
"cat": "General",
"desc": "Parses _this param inside a script into array of private variables",
"ex": "[1,2,3] call {params [\"_one\",\"_two\",\"_three\"]};",
"exres": "",
"name": "params",
"op": "params",
"rname": "array",
"since": ""
}
],
"parseNumber": [
{
"cat": "Default",
"desc": "Parse string containing real number.",
"ex": "parseNumber \"0.125\"",
"exres": "",
"name": "parsenumber",
"op": "parsenumber",
"rname": "string",
"since": "2.92"
},
{
"cat": "Default",
"desc": "Parse boolean into 1 or 0",
"ex": "parseNumber true",
"exres": "",
"name": "parsenumber",
"op": "parsenumber",
"rname": "boolean",
"since": "2.92"
}
],
"parseSimpleArray": [
{
"cat": "Default",
"desc": "Parses formatted as simple array string into array. Simple array consists of numbers, strings, booleans and arrays of all of the above",
"ex": "parseSimpleArray \"[1,true,[1,2,3]]\"",
"exres": "",
"name": "parsesimplearray",
"op": "parsesimplearray",
"rname": "stringArray",
"since": ""
}
],
"parseText": [
{
"cat": "General",
"desc": "Creates a structured text by parsing the given XML description.",
"ex": "txt = parseText \"First line&lt;img image=data\\isniper.paa/&gt;&ltbr/&gt;Second line\"",
"exres": "",
"name": "parsetext",
"op": "parsetext",
"rname": "text",
"since": "2.01"
}
],
"pickWeaponPool": [
{
"cat": "General",
"desc": "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).",
"ex": "",
"exres": "",
"name": "pickweaponpool",
"op": "pickweaponpool",
"rname": "obj",
"since": "1.75"
}
],
"pitch": [
{
"cat": "General",
"desc": "Returns the pitch of the variable assigned to the object in the mission editor.",
"ex": "pitch player",
"exres": "",
"name": "pitch",
"op": "pitch",
"rname": "object",
"since": ""
}
],
"playMission": [
{
"cat": "General",
"desc": "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.",
"ex": "playMission[\"XOutrage\",\"x05Negotiator.Noe\"]",
"exres": "",
"name": "playmission",
"op": "playmission",
"rname": "[campaign, mission] or [campaign, mission, skipBriefing]",
"since": "2.19"
}
],
"playMusic": [
{
"cat": "General",
"desc": "Plays music defined in the description.ext file.",
"ex": "playMusic \"musicname\"",
"exres": "",
"name": "playmusic",
"op": "playmusic",
"rname": "name",
"since": ""
},
{
"cat": "General",
"desc": "Plays music defined in the description.ext file. The format of nameAndPos is [name,position]. Position is in seconds.",
"ex": "playMusic [\"Track13\", 30]",
"exres": "",
"name": "playmusic",
"op": "playmusic",
"rname": "nameAndPos",
"since": ""
}
],
"playScriptedMission": [
{
"cat": "General",
"desc": "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.",
"ex": "",
"exres": "",
"name": "playscriptedmission",
"op": "playscriptedmission",
"rname": "[world, expression, config, (ignoreChildWindow)]",
"since": "5500"
}
],
"playSound": [
{
"cat": "General",
"desc": "Plays a sound defined in the description.ext file.",
"ex": "playSound \"soundname\"",
"exres": "",
"name": "playsound",
"op": "playsound",
"rname": "name",
"since": ""
},
{
"cat": "General",
"desc": "Plays a sound defined in the description.ext file. Accomodation set to false disable sound volume changes.",
"ex": "playSound [\"soundname\", false]",
"exres": "",
"name": "playsound",
"op": "playsound",
"rname": "name, enable / disable sound volume accomodation",
"since": ""
}
],
"playSound3D": [
{
"cat": "General",
"desc": "Plays a sound with given filename. Position of the source object in world coordinates. Distance is how far is sound audible (0 = no max distance). At least 2 parameters must be added.",
"ex": "playSound3D [\"A3\\Sounds_F\\sfx\\blip1.wav\", player] or playSound3D [\"A3\\Sounds_F\\sfx\\blip1.wav\", player, false, getPos player, 1, 1, 0]",
"exres": "",
"name": "playsound3d",
"op": "playsound3d",
"rname": "[\"filename\", source, isInside, position, volume, frequency, distance]",
"since": ""
}
],
"playableSlotsNumber": [
{
"cat": "General",
"desc": "Returns the number of available slots in mission per side (both empty and taken). In singleplayer mission, it returns number of playable units per side.",
"ex": "",
"exres": "",
"name": "playableslotsnumber",
"op": "playableslotsnumber",
"rname": "side",
"since": ""
}
],
"playersNumber": [
{
"cat": "General",
"desc": "Returns the number of players playing on the given side.",
"ex": "",
"exres": "",
"name": "playersnumber",
"op": "playersnumber",
"rname": "side",
"since": "1.80"
}
],
"position": [
{
"cat": "General",
"desc": "Returns the object position in format <ar>Position</ar>.",
"ex": "position player",
"exres": "",
"name": "position",
"op": "position",
"rname": "object",
"since": "1.50"
},
{
"cat": "Location",
"desc": "Return (raw) position of given location.",
"ex": "",
"exres": "",
"name": "position",
"op": "position",
"rname": "location",
"since": "2.90"
}
],
"positionCameraToWorld": [
{
"cat": "General",
"desc": "Transform position from camera coordinate space to world coordinate space.",
"ex": "_worldPos = positionCameraToWorld _cameraPos",
"exres": "",
"name": "positioncameratoworld",
"op": "positioncameratoworld",
"rname": "position",
"since": "2.52"
}
],
"ppEffectCommitted": [
{
"cat": "Visual",
"desc": "Check whether given post process effect is commited",
"ex": "",
"exres": "",
"name": "ppeffectcommitted",
"op": "ppeffectcommitted",
"rname": "effect",
"since": "5501"
},
{
"cat": "Visual",
"desc": "Check whether given post process effect is commited",
"ex": "",
"exres": "",
"name": "ppeffectcommitted",
"op": "ppeffectcommitted",
"rname": "effect",
"since": "5501"
}
],
"ppEffectCreate": [
{
"cat": "Visual",
"desc": "Create post process effect specified by name and priority",
"ex": "",
"exres": "",
"name": "ppeffectcreate",
"op": "ppeffectcreate",
"rname": "effect",
"since": "5501"
}
],
"ppEffectDestroy": [
{
"cat": "Visual",
"desc": "Destroy post process effect given by handle",
"ex": "",
"exres": "",
"name": "ppeffectdestroy",
"op": "ppeffectdestroy",
"rname": "effect",
"since": "5501"
},
{
"cat": "Visual",
"desc": "Create post process effect specified by name and priority",
"ex": "",
"exres": "",
"name": "ppeffectdestroy",
"op": "ppeffectdestroy",
"rname": "effect",
"since": "5501"
}
],
"ppEffectEnabled": [
{
"cat": "Visual",
"desc": "Check whether given post process effect is enabled",
"ex": "",
"exres": "",
"name": "ppeffectenabled",
"op": "ppeffectenabled",
"rname": "effect",
"since": "5501"
}
],
"precision": [
{
"cat": "General",
"desc": "Return the precision of the given entity.",
"ex": "",
"exres": "",
"name": "precision",
"op": "precision",
"rname": "entity",
"since": "2.92"
}
],
"preloadCamera": [
{
"cat": "General",
"desc": "Preload all textures and models around given position",
"ex": "",
"exres": "",
"name": "preloadcamera",
"op": "preloadcamera",
"rname": "position",
"since": "2.50"
}
],
"preloadSound": [
{
"cat": "General",
"desc": "Make sure sound can start playing without any delay once we need it.",
"ex": "",
"exres": "",
"name": "preloadsound",
"op": "preloadsound",
"rname": "sound",
"since": "2.50"
}
],
"preloadTitleObj": [
{
"cat": "General",
"desc": "Object title - argument uses format [\"text\",\"type\",speed, showInMap] or [\"name\",\"type\"]. Speed is ignored.\r\nPreload data\r\nThe object can be defined in the description.ext file.",
"ex": "titleObj [\"BISLogo\",\"plain\"]",
"exres": "",
"name": "preloadtitleobj",
"op": "preloadtitleobj",
"rname": "effect",
"since": ""
}
],
"preloadTitleRsc": [
{
"cat": "General",
"desc": "Resource title - argument uses format [\"name\",\"type\",speed, showInMap] or [\"name\",\"type\"]. Speed is ignored.\r\nPreload data\r\nThe resource can be defined in the description.ext file.",
"ex": "titleRsc [\"BIS\", \"PLAIN\"]",
"exres": "",
"name": "preloadtitlersc",
"op": "preloadtitlersc",
"rname": "effect",
"since": ""
}
],
"preprocessFile": [
{
"cat": "General",
"desc": "Returns the preprocessed content of the given file. The preprocessor is C-like, it supports comments using // or /* and */ and macros defined with #define. On dedicated server/client connected to a dedicated server, if allowedPreprocessFileExtensions parameter is used in the DS config file this only returns contents of a given file if the file extension is listed in it. The list should containt at least the following extensions: hpp, sqs, sqf, fsm, cpp, paa, txt, xml, inc, ext, sqm, ods, fxy, lip, csv, kb, bik, bikn, html, biedi. Note, this list may not be completely up to date",
"ex": "preprocessFile \"myFunction.sqf\"",
"exres": "\"if a>b then {a} else {b}\"",
"name": "preprocessfile",
"op": "preprocessfile",
"rname": "filename",
"since": "1.82"
}
],
"preprocessFileLineNumbers": [
{
"cat": "General",
"desc": "Returns the preprocessed contents of a given file. The preprocessor is C-like, it supports comments using // or /* and */ and macros defined with #define. On dedicated server/client connected to a dedicated server, if allowedPreprocessFileExtensions parameter is used in the DS config file this only returns contents of a given file if the file extension is listed in it. The list should containt at least the following extensions: hpp, sqs, sqf, fsm, cpp, paa, txt, xml, inc, ext, sqm, ods, fxy, lip, csv, kb, bik, bikn, html, biedi. Note, this list may not be completely up to date.",
"ex": "preprocessFileLineNumbers \"myFunction.sqf\"",
"exres": "\"if a>b then {a} else {b}\"",
"name": "preprocessfilelinenumbers",
"op": "preprocessfilelinenumbers",
"rname": "filename",
"since": "2.58"
}
],
"primaryWeapon": [
{
"cat": "General",
"desc": "Returns the name of the vehicle's primary weapon (an empty string if there is none).",
"ex": "primaryWeapon player",
"exres": "",
"name": "primaryweapon",
"op": "primaryweapon",
"rname": "vehicle",
"since": "1.75"
}
],
"primaryWeaponItems": [
{
"cat": "General",
"desc": "Get array with all items assigned to a weapon.",
"ex": "",
"exres": "",
"name": "primaryweaponitems",
"op": "primaryweaponitems",
"rname": "unit",
"since": "5501"
}
],
"primaryWeaponMagazine": [
{
"cat": "General",
"desc": "Return the names of the types of currently loaded magazines in given weapon.",
"ex": "",
"exres": "",
"name": "primaryweaponmagazine",
"op": "primaryweaponmagazine",
"rname": "vehicle",
"since": "5500"
}
],
"priority": [
{
"cat": "Identity",
"desc": "Return the priority of the task.",
"ex": "",
"exres": "",
"name": "priority",
"op": "priority",
"rname": "task",
"since": "2.91"
}
],
"private": [
{
"cat": "Default",
"desc": "Introduces one or more local variables in the innermost scope.",
"ex": "",
"exres": "",
"name": "private",
"op": "private",
"rname": "variable",
"since": "1.85"
}
],
"processDiaryLink": [
{
"cat": "Identity",
"desc": "Open the diary screen on the record specified by link.",
"ex": "",
"exres": "",
"name": "processdiarylink",
"op": "processdiarylink",
"rname": "link",
"since": "5500"
}
],
"progressLoadingScreen": [
{
"cat": "General",
"desc": "If loading screen is show, set progress bar to the given value (from interval [0, 1])",
"ex": "",
"exres": "",
"name": "progressloadingscreen",
"op": "progressloadingscreen",
"rname": "progress",
"since": "5501"
}
],
"progressPosition": [
{
"cat": "General",
"desc": "Returns the current position in the progress bar.",
"ex": "_pos = progressPosition _control",
"exres": "",
"name": "progressposition",
"op": "progressposition",
"rname": "control",
"since": "5500"
}
],
"publicVariable": [
{
"cat": "General",
"desc": "Broadcasts the variable value to all computers.\r\nOnly type <t>Number</t> is supported in versions 1.33 and before.\r\nThe following types are supported since 1.34:\r\n<t>Number</t>, <t>Boolean</t>, <t>Object</t> and <t>Group</t>.",
"ex": "publicVariable \"CTFscoreOne\"",
"exres": "",
"name": "publicvariable",
"op": "publicvariable",
"rname": "varName",
"since": ""
}
],
"publicVariableServer": [
{
"cat": "General",
"desc": "Send the variable value to the server computer.\r\nOnly type <t>Number</t> is supported in versions 1.33 and before.\r\nThe following types are supported since 1.34:\r\n<t>Number</t>, <t>Boolean</t>, <t>Object</t> and <t>Group</t>.",
"ex": "publicVariableServer \"CTFscoreOne\"",
"exres": "",
"name": "publicvariableserver",
"op": "publicvariableserver",
"rname": "varName",
"since": ""
}
],
"putWeaponPool": [
{
"cat": "General",
"desc": "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.",
"ex": "",
"exres": "",
"name": "putweaponpool",
"op": "putweaponpool",
"rname": "obj",
"since": "1.75"
}
],
"queryItemsPool": [
{
"cat": "General",
"desc": "Returns the number of items of type name in the weapon pool (used in campaigns to transfer weapons to the next mission).",
"ex": "",
"exres": "",
"name": "queryitemspool",
"op": "queryitemspool",
"rname": "name",
"since": "1.75"
}
],
"queryMagazinePool": [
{
"cat": "General",
"desc": "Returns the number of magazines of type name in the weapon pool (used in campaigns to transfer weapons to the next mission).",
"ex": "",
"exres": "",
"name": "querymagazinepool",
"op": "querymagazinepool",
"rname": "name",
"since": "1.75"
}
],
"queryWeaponPool": [
{
"cat": "General",
"desc": "Returns the number of weapons of type name in the weapon pool (used in campaigns to transfer weapons to the next mission).",
"ex": "",
"exres": "",
"name": "queryweaponpool",
"op": "queryweaponpool",
"rname": "name",
"since": "1.75"
}
],
"rad": [
{
"cat": "Default",
"desc": "Converts x from degrees to radians.",
"ex": "rad 180",
"exres": "3.1415",
"name": "rad",
"op": "rad",
"rname": "x",
"since": ""
}
],
"radioChannelCreate": [
{
"cat": "General",
"desc": "Create Custom Radio Channel with given callSign color, callSign format and units. sentenceColorType sets color for sentences - true for colorMessageProtocol otherwise colorMessage. Returns index to identify/manipulate the created Custom Channel.",
"ex": "",
"exres": "",
"name": "radiochannelcreate",
"op": "radiochannelcreate",
"rname": "[[r,g,b,a], label, callSign, [unit1,unit2,...], sentenceColorType]",
"since": "81210 TOH"
}
],
"random": [
{
"cat": "Default",
"desc": "The random real value from min to max with average of mid",
"ex": "random [0,5,10]",
"exres": "",
"name": "random",
"op": "random",
"rname": "[min, mid, max]",
"since": ""
},
{
"cat": "Default",
"desc": "The random real value from 0 to x. (0&lt;=random&lt;1)",
"ex": "random 1",
"exres": "",
"name": "random",
"op": "random",
"rname": "x",
"since": ""
}
],
"rank": [
{
"cat": "General",
"desc": "Return the rank of the given unit.",
"ex": "",
"exres": "",
"name": "rank",
"op": "rank",
"rname": "unit",
"since": "2.92"
}
],
"rankId": [
{
"cat": "General",
"desc": "Return the rank of the given unit for comparison.",
"ex": "",
"exres": "",
"name": "rankid",
"op": "rankid",
"rname": "unit",
"since": "5500"
}
],
"rating": [
{
"cat": "General",
"desc": "Checks the unit rating. This rating is increased for killing enemies, decreased for killing friendlies and can be changed by a mission designer.",
"ex": "rating player",
"exres": "",
"name": "rating",
"op": "rating",
"rname": "unit",
"since": ""
}
],
"rectangular": [
{
"cat": "Location",
"desc": "Check if given location has rectangular shape.",
"ex": "",
"exres": "",
"name": "rectangular",
"op": "rectangular",
"rname": "location",
"since": "2.90"
}
],
"registeredTasks": [
{
"cat": "Identity",
"desc": "List all registered task types.",
"ex": "",
"exres": "",
"name": "registeredtasks",
"op": "registeredtasks",
"rname": "teamMember",
"since": "2.91"
}
],
"reload": [
{
"cat": "General",
"desc": "Reload all weapons.",
"ex": "",
"exres": "",
"name": "reload",
"op": "reload",
"rname": "vehicle",
"since": "2.92"
}
],
"reloadEnabled": [
{
"cat": "General",
"desc": "Check whether magazine is reloaded whenever emptied.",
"ex": "",
"exres": "",
"name": "reloadenabled",
"op": "reloadenabled",
"rname": "vehicle",
"since": "2.92"
}
],
"remoteExec": [
{
"cat": "General",
"desc": "Executes the function remotely by spawning it. Returns nil in case of error. If JIP is requested it returns an unique JIP id string.",
"ex": "uniquejipID = remoteExec [\"disableDebriefingStats\", 0, true]; remoteExec [\"disableDebriefingStats\", 0, \"jipID2\"]",
"exres": "",
"name": "remoteexec",
"op": "remoteexec",
"rname": "[funcName, targets, jipID]",
"since": ""
}
],
"remoteExecCall": [
{
"cat": "General",
"desc": "Executes the function remotely by calling it. Returns nil in case of error. If JIP is requested it returns an unique JIP id string.",
"ex": "uniquejipID = remoteExecCall [\"disableDebriefingStats\", 0, true]; remoteExecCall [\"disableDebriefingStats\", 0, \"jipID2\"]",
"exres": "",
"name": "remoteexeccall",
"op": "remoteexeccall",
"rname": "[funcName, targets, jipID]",
"since": ""
}
],
"remove3DENConnection": [
{
"cat": "General",
"desc": "Removes connection of given type between <from> items and <to> item.",
"ex": "",
"exres": "",
"name": "remove3denconnection",
"op": "remove3denconnection",
"rname": "[<type>, [<from>,...], <to>]",
"since": ""
}
],
"remove3DENEventHandler": [
{
"cat": "General",
"desc": "Removes event handler with given ID.",
"ex": "",
"exres": "",
"name": "remove3deneventhandler",
"op": "remove3deneventhandler",
"rname": "[<type>, <id>]",
"since": ""
}
],
"remove3DENLayer": [
{
"cat": "General",
"desc": "Deletes whole layer and moves items from within it into the parent of deleted layer.",
"ex": "",
"exres": "",
"name": "remove3denlayer",
"op": "remove3denlayer",
"rname": "<layerID>",
"since": ""
}
],
"removeAll3DENEventHandlers": [
{
"cat": "General",
"desc": "Removes all registered even handlers",
"ex": "",
"exres": "",
"name": "removeall3deneventhandlers",
"op": "removeall3deneventhandlers",
"rname": "<type>",
"since": ""
}
],
"removeAllActions": [
{
"cat": "General",
"desc": "Removes the action with the given id.",
"ex": "removeAllActions player",
"exres": "",
"name": "removeallactions",
"op": "removeallactions",
"rname": "unit",
"since": ""
}
],
"removeAllAssignedItems": [
{
"cat": "General",
"desc": "Removes all linked items from gear (map, compass, headgear, goggles etc.).",
"ex": "",
"exres": "",
"name": "removeallassigneditems",
"op": "removeallassigneditems",
"rname": "unit",
"since": "5501"
}
],
"removeAllContainers": [
{
"cat": "General",
"desc": "Removes all containers from the unit.",
"ex": "removeAllContainers player",
"exres": "",
"name": "removeallcontainers",
"op": "removeallcontainers",
"rname": "unit",
"since": ""
}
],
"removeAllCuratorAddons": [
{
"cat": "General",
"desc": "Restrict access to all addons for given curator.",
"ex": "",
"exres": "",
"name": "removeallcuratoraddons",
"op": "removeallcuratoraddons",
"rname": "curatorObj",
"since": ""
}
],
"removeAllCuratorCameraAreas": [
{
"cat": "General",
"desc": "Delete all curator camera areas.",
"ex": "",
"exres": "",
"name": "removeallcuratorcameraareas",
"op": "removeallcuratorcameraareas",
"rname": "curatorObj",
"since": ""
}
],
"removeAllCuratorEditingAreas": [
{
"cat": "General",
"desc": "Delete all curator edit areas.",
"ex": "",
"exres": "",
"name": "removeallcuratoreditingareas",
"op": "removeallcuratoreditingareas",
"rname": "curatorObj",
"since": ""
}
],
"removeAllHandgunItems": [
{
"cat": "General",
"desc": "Removes all items from weapon except magazine.",
"ex": "",
"exres": "",
"name": "removeallhandgunitems",
"op": "removeallhandgunitems",
"rname": "unit",
"since": "5501"
}
],
"removeAllItems": [
{
"cat": "General",
"desc": "Removes all items from the uniform, vest and backpack.",
"ex": "",
"exres": "",
"name": "removeallitems",
"op": "removeallitems",
"rname": "unit",
"since": "5501"
}
],
"removeAllItemsWithMagazines": [
{
"cat": "General",
"desc": "Removes all items from the uniform, vest and backpack.",
"ex": "",
"exres": "",
"name": "removeallitemswithmagazines",
"op": "removeallitemswithmagazines",
"rname": "unit",
"since": "5501"
}
],
"removeAllMissionEventHandlers": [
{
"cat": "General",
"desc": "Removes all event handlers of the given type which were added by <f>addMissionEventHandler</f>.",
"ex": "removeAllMissionEventHandlers \"ended\"",
"exres": "",
"name": "removeallmissioneventhandlers",
"op": "removeallmissioneventhandlers",
"rname": "type",
"since": "TOH 85057"
}
],
"removeAllMusicEventHandlers": [
{
"cat": "General",
"desc": "Remove all music track event handlers.",
"ex": "removeAllMusicEventHandlers \"MusicStart\"",
"exres": "",
"name": "removeallmusiceventhandlers",
"op": "removeallmusiceventhandlers",
"rname": "type",
"since": "92910"
}
],
"removeAllOwnedMines": [
{
"cat": "General",
"desc": "Remove ownership over all remotely detonable mines from the unit.",
"ex": "removeAllOwnedMines player",
"exres": "",
"name": "removeallownedmines",
"op": "removeallownedmines",
"rname": "unit",
"since": ""
}
],
"removeAllPrimaryWeaponItems": [
{
"cat": "General",
"desc": "Removes all items from weapon except magazine.",
"ex": "",
"exres": "",
"name": "removeallprimaryweaponitems",
"op": "removeallprimaryweaponitems",
"rname": "unit",
"since": "5501"
}
],
"removeAllWeapons": [
{
"cat": "General",
"desc": "Removes all weapons from the unit.",
"ex": "removeAllWeapons player",
"exres": "",
"name": "removeallweapons",
"op": "removeallweapons",
"rname": "unit",
"since": ""
}
],
"removeBackpack": [
{
"cat": "General",
"desc": "Remove backpack from unit.",
"ex": "removeBackpack player",
"exres": "",
"name": "removebackpack",
"op": "removebackpack",
"rname": "unit",
"since": "5501"
}
],
"removeBackpackGlobal": [
{
"cat": "General",
"desc": "Remove backpack from unit(even non-local).",
"ex": "removeBackpackGlobal player",
"exres": "",
"name": "removebackpackglobal",
"op": "removebackpackglobal",
"rname": "unit",
"since": "5501"
}
],
"removeFromRemainsCollector": [
{
"cat": "General",
"desc": "Removes flag from given objects to be managed by unitRemove manager",
"ex": "removeFromRemainsCollector [unit1, unit2]",
"exres": "",
"name": "removefromremainscollector",
"op": "removefromremainscollector",
"rname": "array",
"since": ""
}
],
"removeGoggles": [
{
"cat": "General",
"desc": "Remove goggles from unit.",
"ex": "removeBackpack player",
"exres": "",
"name": "removegoggles",
"op": "removegoggles",
"rname": "unit",
"since": "5501"
}
],
"removeHeadgear": [
{
"cat": "General",
"desc": "Remove headgear from unit.",
"ex": "removeBackpack player",
"exres": "",
"name": "removeheadgear",
"op": "removeheadgear",
"rname": "unit",
"since": "5501"
}
],
"removeMissionEventHandler": [
{
"cat": "General",
"desc": "Removes event handler added by <f>addMissionEventHandler</f>. Id is returned by addMissionEventHandler. When any handler is removed, all handler indices higher that the deleted one should be decremented.",
"ex": "removeMissionEventHandler [\"ended\",0]",
"exres": "",
"name": "removemissioneventhandler",
"op": "removemissioneventhandler",
"rname": "[type, id]",
"since": "TOH 85057"
}
],
"removeMusicEventHandler": [
{
"cat": "General",
"desc": "Remove specified music track event handler.",
"ex": "removeMusicEventHandler [\"MusicTerminate\", \"1\"]",
"exres": "",
"name": "removemusiceventhandler",
"op": "removemusiceventhandler",
"rname": "[type, id]",
"since": "92910"
}
],
"removeSwitchableUnit": [
{
"cat": "General",
"desc": "Remove a unit from the list of units available for team switch.",
"ex": "",
"exres": "",
"name": "removeswitchableunit",
"op": "removeswitchableunit",
"rname": "person",
"since": "2.92"
}
],
"removeUniform": [
{
"cat": "General",
"desc": "Remove uniform from unit.",
"ex": "removeBackpack player",
"exres": "",
"name": "removeuniform",
"op": "removeuniform",
"rname": "unit",
"since": "5501"
}
],
"removeVest": [
{
"cat": "General",
"desc": "Remove vest from unit.",
"ex": "removeBackpack player",
"exres": "",
"name": "removevest",
"op": "removevest",
"rname": "unit",
"since": "5501"
}
],
"requiredVersion": [
{
"cat": "General",
"desc": "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\".",
"ex": "requiredVersion \"1.30\"",
"exres": "",
"name": "requiredversion",
"op": "requiredversion",
"rname": "version",
"since": "1.21"
}
],
"resetSubgroupDirection": [
{
"cat": "General",
"desc": "Reset direction of subgroup.",
"ex": "resetSubgroupDirection unit",
"exres": "",
"name": "resetsubgroupdirection",
"op": "resetsubgroupdirection",
"rname": "subgroup member",
"since": "TOH 83721"
}
],
"resources": [
{
"cat": "Agents",
"desc": "Return a list of the resources belonging to a team.",
"ex": "",
"exres": "",
"name": "resources",
"op": "resources",
"rname": "teamMember",
"since": "2.92"
}
],
"restartEditorCamera": [
{
"cat": "Editor",
"desc": "Restarts the mission editor camera (if it was deleted by a script, for example).",
"ex": "",
"exres": "",
"name": "restarteditorcamera",
"op": "restarteditorcamera",
"rname": "map",
"since": "2.92"
}
],
"reverse": [
{
"cat": "Default",
"desc": "Reverse elements position in the array([0,1,2] -> [2,1,0]).",
"ex": "reverse [0,1,2]",
"exres": "",
"name": "reverse",
"op": "reverse",
"rname": "array",
"since": ""
}
],
"roadAt": [
{
"cat": "General",
"desc": "Returns the road the object or position is on.",
"ex": "onEachFrame { hint str(roadAt player); }",
"exres": "",
"name": "roadat",
"op": "roadat",
"rname": "object or position",
"since": ""
}
],
"roadsConnectedTo": [
{
"cat": "General",
"desc": "Find the road segments connected to the given road segment.",
"ex": "",
"exres": "",
"name": "roadsconnectedto",
"op": "roadsconnectedto",
"rname": "road segment",
"since": "5500"
}
],
"roleDescription": [
{
"cat": "General",
"desc": "Returns friendly role description from editor",
"ex": "roleDescription player",
"exres": "Medic",
"name": "roledescription",
"op": "roledescription",
"rname": "player",
"since": ""
}
],
"ropeAttachEnabled": [
{
"cat": "General",
"desc": "Check if the vehicle can be attached to ropes",
"ex": "",
"exres": "",
"name": "ropeattachenabled",
"op": "ropeattachenabled",
"rname": "vehicle",
"since": "126046"
}
],
"ropeAttachedObjects": [
{
"cat": "General",
"desc": "Returns list of attached objects on ropes",
"ex": "ropeAttachedObjects obj",
"exres": "",
"name": "ropeattachedobjects",
"op": "ropeattachedobjects",
"rname": "vehicle",
"since": "126041"
}
],
"ropeAttachedTo": [
{
"cat": "General",
"desc": "Returns the object it is attached to by rope",
"ex": "ropeAttachedTo obj",
"exres": "",
"name": "ropeattachedto",
"op": "ropeattachedto",
"rname": "vehicle",
"since": "126041"
}
],
"ropeCreate": [
{
"cat": "General",
"desc": "Create instance of rope object attached on vehicle",
"ex": "ropeCreate [veh1, [0,0,-2], veh2, [0,0,0], 10] or ropeCreate [veh1, [0,0,-2], 10] or ropeCreate [veh1, [0,0,-2], veh2, [0,0,0], 10, [], [\"ropeend\", [0,0,-1]]]",
"exres": "",
"name": "ropecreate",
"op": "ropecreate",
"rname": "[fromObject, fromPoint, toObject, toPoint, (length), ([ropeStart, downDir]), ([ropeEnd, downDir])]",
"since": "116464"
}
],
"ropeCut": [
{
"cat": "General",
"desc": "Cut rope and detach rope from vehicle",
"ex": "ropeCut [rope, 5]",
"exres": "",
"name": "ropecut",
"op": "ropecut",
"rname": "[rope, distance]",
"since": "116464"
}
],
"ropeDestroy": [
{
"cat": "General",
"desc": "Destroy rope and detach rope from vehicle",
"ex": "ropeDestroy rope",
"exres": "",
"name": "ropedestroy",
"op": "ropedestroy",
"rname": "rope",
"since": "116464"
}
],
"ropeEndPosition": [
{
"cat": "General",
"desc": "Return rope end positions",
"ex": "[start position, end position] ropeEndPosition ropeObj",
"exres": "",
"name": "ropeendposition",
"op": "ropeendposition",
"rname": "rope",
"since": "116464"
}
],
"ropeLength": [
{
"cat": "General",
"desc": "Return rope length (set by ropeCreate, ropeCut, ropeUnwind)",
"ex": "ropeLength rope",
"exres": "",
"name": "ropelength",
"op": "ropelength",
"rname": "rope",
"since": "116464"
}
],
"ropeUnwind": [
{
"cat": "General",
"desc": "Unwind rope to target length. Use relative parameter for change rope length +/- from current length",
"ex": "ropeUnwind [rope, 3, 10]",
"exres": "",
"name": "ropeunwind",
"op": "ropeunwind",
"rname": "[rope, speed, targetLength, (relative)]",
"since": "116464"
}
],
"ropeUnwound": [
{
"cat": "General",
"desc": "False if unwiding in progress, otherwise true",
"ex": "ropeUnwound rope",
"exres": "",
"name": "ropeunwound",
"op": "ropeunwound",
"rname": "rope",
"since": "116464"
}
],
"ropes": [
{
"cat": "General",
"desc": "Return vehicle ropes",
"ex": "ropes vehicle player",
"exres": "",
"name": "ropes",
"op": "ropes",
"rname": "vehicle",
"since": "116464"
}
],
"rotorsForcesRTD": [
{
"cat": "General",
"desc": "Returns force produced by rotors.",
"ex": "",
"exres": "",
"name": "rotorsforcesrtd",
"op": "rotorsforcesrtd",
"rname": "RTD_helicopter",
"since": "TOH 81393"
}
],
"rotorsRpmRTD": [
{
"cat": "General",
"desc": "Returns rotors RPM.",
"ex": "",
"exres": "",
"name": "rotorsrpmrtd",
"op": "rotorsrpmrtd",
"rname": "RTD_helicopter",
"since": "TOH 81393"
}
],
"round": [
{
"cat": "Default",
"desc": "The round value of x.",
"ex": "round -5.25",
"exres": "-5",
"name": "round",
"op": "round",
"rname": "x",
"since": ""
}
],
"save3DENInventory": [
{
"cat": "General",
"desc": "Saves current state of entitie's inventory to SQM.",
"ex": "",
"exres": "",
"name": "save3deninventory",
"op": "save3deninventory",
"rname": "<entities>",
"since": ""
}
],
"saveOverlay": [
{
"cat": "Editor",
"desc": "Save the current overlay.",
"ex": "saveOverlay _map",
"exres": "",
"name": "saveoverlay",
"op": "saveoverlay",
"rname": "map",
"since": "2.92"
}
],
"saveVar": [
{
"cat": "General",
"desc": "Saves the variable value into the global campaign space. The variable is then available to all following missions in the campaign.",
"ex": "saveVar \"varOne\"",
"exres": "",
"name": "savevar",
"op": "savevar",
"rname": "varName",
"since": ""
}
],
"scopeName": [
{
"cat": "Default",
"desc": "defines name of current scope. Name is visible in debugger, and name is also used as reference in some commands. Scope name can be defined only once per scope.",
"ex": "",
"exres": "",
"name": "scopename",
"op": "scopename",
"rname": "name",
"since": ""
}
],
"score": [
{
"cat": "General",
"desc": "MP: returns the unit's score.",
"ex": "score unitOne",
"exres": "",
"name": "score",
"op": "score",
"rname": "unit",
"since": ""
}
],
"scoreSide": [
{
"cat": "General",
"desc": "MP: returns side score.",
"ex": "score west",
"exres": "",
"name": "scoreside",
"op": "scoreside",
"rname": "side",
"since": ""
}
],
"screenToWorld": [
{
"cat": "General",
"desc": "Returns the position on landscape (in world coordinates) corresponding to the given point on screen (in UI coordinates).",
"ex": "",
"exres": "",
"name": "screentoworld",
"op": "screentoworld",
"rname": "position",
"since": "5501"
}
],
"screenshot": [
{
"cat": "General",
"desc": "Captures a screenshot and stores it in \\Documents\\Arma 3\\Screenshots\\. If filename is empty, it will be auto-generated. Must have .png extension. Folder size is limited by \"maxScreenShotFolderSizeMB\" velu in profile. ",
"ex": "screenshot \"mission1\\image.png\"",
"exres": "",
"name": "screenshot",
"op": "screenshot",
"rname": "filename",
"since": ""
}
],
"scriptDone": [
{
"cat": "General",
"desc": "Check if script is already finished",
"ex": "",
"exres": "",
"name": "scriptdone",
"op": "scriptdone",
"rname": "script",
"since": "2.50"
}
],
"scriptName": [
{
"cat": "Default",
"desc": "Assign a friendly name to the VM script this command is executed from.",
"ex": "scriptName \"Trading\"",
"exres": "",
"name": "scriptname",
"op": "scriptname",
"rname": "name",
"since": "5501"
}
],
"scudState": [
{
"cat": "General",
"desc": "Returns the current state of the given scud launcher. The following states are recognized: 0 - No activity, 1 - Launch preparation, 2 - Launch prepared, 3 - Ignition and 4 - Launched. Note: non-integral values are used to indicate a transition between states.",
"ex": "scudState scudOne>=4",
"exres": "",
"name": "scudstate",
"op": "scudstate",
"rname": "scud",
"since": "1.28"
}
],
"secondaryWeapon": [
{
"cat": "General",
"desc": "Returns the name of a vehicle's secondary weapon (an empty string if there is none).",
"ex": "secondaryWeapon player",
"exres": "",
"name": "secondaryweapon",
"op": "secondaryweapon",
"rname": "vehicle",
"since": "1.75"
}
],
"secondaryWeaponItems": [
{
"cat": "General",
"desc": "Get array with all items assigned to a weapon.",
"ex": "",
"exres": "",
"name": "secondaryweaponitems",
"op": "secondaryweaponitems",
"rname": "unit",
"since": "5501"
}
],
"secondaryWeaponMagazine": [
{
"cat": "General",
"desc": "Return the names of the types of currently loaded magazines in given weapon.",
"ex": "",
"exres": "",
"name": "secondaryweaponmagazine",
"op": "secondaryweaponmagazine",
"rname": "vehicle",
"since": "5500"
}
],
"selectBestPlaces": [
{
"cat": "General",
"desc": "Find the places with the max. value of _expression in the given area.",
"ex": "",
"exres": "",
"name": "selectbestplaces",
"op": "selectbestplaces",
"rname": "[_position, _radius, _expression, _precision, _sourcesCount]",
"since": "5500"
}
],
"selectMax": [
{
"cat": "Default",
"desc": "Returns array element with maximum value",
"ex": "selectMax [1,2,3]",
"exres": "3",
"name": "selectmax",
"op": "selectmax",
"rname": "array",
"since": ""
}
],
"selectMin": [
{
"cat": "Default",
"desc": "Returns array element with minimum value",
"ex": "selectMin [1,2,3]",
"exres": "1",
"name": "selectmin",
"op": "selectmin",
"rname": "array",
"since": ""
}
],
"selectPlayer": [
{
"cat": "General",
"desc": "Switch player to given unit.",
"ex": "selectPlayer aP",
"exres": "",
"name": "selectplayer",
"op": "selectplayer",
"rname": "unit",
"since": "2.33"
}
],
"selectRandom": [
{
"cat": "Default",
"desc": "Returns random element of given array",
"ex": "selectRandom [1,2,3]",
"exres": "",
"name": "selectrandom",
"op": "selectrandom",
"rname": "array",
"since": ""
}
],
"selectedEditorObjects": [
{
"cat": "Editor",
"desc": "Returns a list of currently selected editor objects.",
"ex": "",
"exres": "",
"name": "selectededitorobjects",
"op": "selectededitorobjects",
"rname": "map",
"since": "2.92"
}
],
"selectionNames": [
{
"cat": "General",
"desc": "returns list of modelSelections",
"ex": "selectionNames object",
"exres": "",
"name": "selectionnames",
"op": "selectionnames",
"rname": "entity",
"since": ""
}
],
"sendAUMessage": [
{
"cat": "General",
"desc": "Send the command to the list of clients or some count of clients.",
"ex": "SendAUMessage [[dpnid1, dpnid2], \"ConnectTo: 192.168.1.66\"]",
"exres": "",
"name": "sendaumessage",
"op": "sendaumessage",
"rname": "[count|[clientList], \"command\"]",
"since": ""
}
],
"sendUDPMessage": [
{
"cat": "General",
"desc": "Send message to given address using UDP protocol.",
"ex": "",
"exres": "",
"name": "sendudpmessage",
"op": "sendudpmessage",
"rname": "[ip,port,\"message\"]",
"since": "5501"
}
],
"serverCommand": [
{
"cat": "General",
"desc": "Process the specified server command.\r\nThe Server command string is identical to that used in chat line in MP.\r\nThis command needs to be executed from UI handler to succeed.",
"ex": "serverCommand \"#kick friendlykiller\"",
"exres": "",
"name": "servercommand",
"op": "servercommand",
"rname": "server command",
"since": ""
}
],
"serverCommandAvailable": [
{
"cat": "General",
"desc": "Checks whether current user is able to process the specified server command. See also <f>serverCommand</f>",
"ex": "serverCommandAvailable \"#kick\"",
"exres": "",
"name": "servercommandavailable",
"op": "servercommandavailable",
"rname": "server command",
"since": ""
}
],
"serverCommandExecutable": [
{
"cat": "General",
"desc": "Checks whether current user is able to execute the specified server command.\r\nThis command needs to be executed from UI handler to succeed and mirrors serverCommand behavior. See also <f>serverCommand</f>",
"ex": "serverCommandExecutable \"#kick\"",
"exres": "",
"name": "servercommandexecutable",
"op": "servercommandexecutable",
"rname": "server command",
"since": ""
}
],
"set3DENAttributes": [
{
"cat": "General",
"desc": "Returns TRUE if change was processed.",
"ex": "",
"exres": "",
"name": "set3denattributes",
"op": "set3denattributes",
"rname": "[[[<entities>],<attributeType>,<value>], ....]",
"since": ""
}
],
"set3DENGrid": [
{
"cat": "General",
"desc": "Sets grid size for given grid type.",
"ex": "",
"exres": "",
"name": "set3dengrid",
"op": "set3dengrid",
"rname": "[<type>, <value>]",
"since": ""
}
],
"set3DENIconsVisible": [
{
"cat": "General",
"desc": "Enables or disables icons visibility in 3DEN",
"ex": "",
"exres": "",
"name": "set3deniconsvisible",
"op": "set3deniconsvisible",
"rname": "[<map:bool>, <scene:bool>]",
"since": ""
}
],
"set3DENLinesVisible": [
{
"cat": "General",
"desc": "Enables or disables lines visibility in 3DEN",
"ex": "",
"exres": "",
"name": "set3denlinesvisible",
"op": "set3denlinesvisible",
"rname": "[<map:bool>, <scene:bool>]",
"since": ""
}
],
"set3DENMissionAttributes": [
{
"cat": "General",
"desc": "Sets given attribute into the engine.",
"ex": "",
"exres": "",
"name": "set3denmissionattributes",
"op": "set3denmissionattributes",
"rname": "[[<section>, <class>, <value>],...]",
"since": ""
}
],
"set3DENModelsVisible": [
{
"cat": "General",
"desc": "Enables or disables lines visibility in 3DEN",
"ex": "",
"exres": "",
"name": "set3denmodelsvisible",
"op": "set3denmodelsvisible",
"rname": "[<map:bool>, <scene:bool>]",
"since": ""
}
],
"set3DENSelected": [
{
"cat": "General",
"desc": "Changes selection in 3den to what is inside entities array.",
"ex": "",
"exres": "",
"name": "set3denselected",
"op": "set3denselected",
"rname": "<entities>",
"since": ""
}
],
"setAccTime": [
{
"cat": "General",
"desc": "Sets the time acceleration coeficient. It can also be used to slow down time in cutscenes.",
"ex": "setAccTime 0.1",
"exres": "",
"name": "setacctime",
"op": "setacctime",
"rname": "accFactor",
"since": ""
}
],
"setAperture": [
{
"cat": "General",
"desc": "Sets custom camera apreture (-1 to do it automatically).",
"ex": "",
"exres": "",
"name": "setaperture",
"op": "setaperture",
"rname": "set",
"since": "2.73"
}
],
"setApertureNew": [
{
"cat": "General",
"desc": "Sets custom camera apreture (-1 to do it automatically).",
"ex": "",
"exres": "",
"name": "setaperturenew",
"op": "setaperturenew",
"rname": "[min, std, max, std lum]",
"since": "86000"
}
],
"setArmoryPoints": [
{
"cat": "General",
"desc": "Store the given amount of armory points.",
"ex": "",
"exres": "",
"name": "setarmorypoints",
"op": "setarmorypoints",
"rname": "points",
"since": "5500"
}
],
"setCamShakeDefParams": [
{
"cat": "General",
"desc": "Sets camera shake default params.",
"ex": "",
"exres": "",
"name": "setcamshakedefparams",
"op": "setcamshakedefparams",
"rname": "[power, duration, maxDistance, frequency, minSpeed, minMass, caliberCoefHit, caliberCoefFire, vehicleCoef]",
"since": "5501"
}
],
"setCamShakeParams": [
{
"cat": "General",
"desc": "Sets camera shake params.",
"ex": "",
"exres": "",
"name": "setcamshakeparams",
"op": "setcamshakeparams",
"rname": "[posCoef, rotXCoef, rotYCoef, rotZCoef, interp]",
"since": "5501"
}
],
"setCompassOscillation": [
{
"cat": "General",
"desc": "Set Compass Oscillation.",
"ex": "",
"exres": "",
"name": "setcompassoscillation",
"op": "setcompassoscillation",
"rname": "[angle, frequencyMin, frequencyMax]",
"since": ""
}
],
"setCurrentChannel": [
{
"cat": "General",
"desc": "Sets given channel as current channel",
"ex": "channelSet = setCurrentChannel 2",
"exres": "",
"name": "setcurrentchannel",
"op": "setcurrentchannel",
"rname": "channel",
"since": ""
}
],
"setDate": [
{
"cat": "General",
"desc": "Sets the actual mission date and time.",
"ex": "",
"exres": "",
"name": "setdate",
"op": "setdate",
"rname": "[year, month, day, hour, minute]",
"since": "1.86"
}
],
"setDefaultCamera": [
{
"cat": "General",
"desc": "Sets the position and direction for camera used after camera is set on no object (e.g. leaving a multiplayer game).",
"ex": "setDefaultCamera [ [ 5000,5000,200], [1,1,-1] ]",
"exres": "",
"name": "setdefaultcamera",
"op": "setdefaultcamera",
"rname": "[ position, direction = [0,0,-1]]",
"since": "106482"
}
],
"setDetailMapBlendPars": [
{
"cat": "General",
"desc": "Sets the detail texture map blend pars.",
"ex": "setDetailMapBlendPars [20, 50]",
"exres": "",
"name": "setdetailmapblendpars",
"op": "setdetailmapblendpars",
"rname": "[fullDetail, noDetail]",
"since": "TOH 81984"
}
],
"setGroupIconsSelectable": [
{
"cat": "General",
"desc": "Sets if group icons raises onclick and onover events.",
"ex": "selectableGroupIcons true",
"exres": "",
"name": "setgroupiconsselectable",
"op": "setgroupiconsselectable",
"rname": "bool",
"since": "5501"
}
],
"setGroupIconsVisible": [
{
"cat": "General",
"desc": "Sets if group icons are visible.",
"ex": "showGroupIcons [true,true]",
"exres": "",
"name": "setgroupiconsvisible",
"op": "setgroupiconsvisible",
"rname": "array",
"since": "5501"
}
],
"setHUDMovementLevels": [
{
"cat": "General",
"desc": "Set min/max movement borders displayed in HUD gauges. Use -1 to skip some value.Speed [m/s],alt [m], dir [deg]. Use [-1,-1,-1] to keep current position",
"ex": "SetHUDMovementLevels [20,30,-1,-1,0.23,2.1]",
"exres": "",
"name": "sethudmovementlevels",
"op": "sethudmovementlevels",
"rname": "[min speed, max speed, min alt, max alt, min dir, max dir, position[x,y,z] or target]",
"since": "TOH 81021"
}
],
"setHorizonParallaxCoef": [
{
"cat": "General",
"desc": "Sets coef used to shift horizon position based on camera height (use 0 to disable shifting).",
"ex": "",
"exres": "",
"name": "sethorizonparallaxcoef",
"op": "sethorizonparallaxcoef",
"rname": "coef",
"since": "89730"
}
],
"setLocalWindParams": [
{
"cat": "General",
"desc": "Sets parameters for local wind emiters (like helicopters). Default [1.0, 1.0]",
"ex": "",
"exres": "",
"name": "setlocalwindparams",
"op": "setlocalwindparams",
"rname": "[strength, diameter]",
"since": "2.92"
}
],
"setMousePosition": [
{
"cat": "General",
"desc": "Move (UI) mouse pointer to specified position of the screen.",
"ex": "setMousePosition [0.5, 0.5]",
"exres": "",
"name": "setmouseposition",
"op": "setmouseposition",
"rname": "[x, y]",
"since": "2.91"
}
],
"setMusicEventHandler": [
{
"cat": "General",
"desc": "Sets given music track event handler.",
"ex": "setMusicEventHandler [\"MusicTerminate\", \"\"]",
"exres": "",
"name": "setmusiceventhandler",
"op": "setmusiceventhandler",
"rname": "[type, function]",
"since": "92910"
}
],
"setObjectViewDistance": [
{
"cat": "General",
"desc": "Sets the rendering distance of objects.",
"ex": "setobjectviewdistance 2000",
"exres": "",
"name": "setobjectviewdistance",
"op": "setobjectviewdistance",
"rname": "distance",
"since": ""
},
{
"cat": "General",
"desc": "Sets the rendering distance of objects.",
"ex": "setobjectviewdistance [2000,50]",
"exres": "",
"name": "setobjectviewdistance",
"op": "setobjectviewdistance",
"rname": "[vehiclesZ, shadowsZ]",
"since": ""
}
],
"setPlayable": [
{
"cat": "General",
"desc": "Create MP role for the unit.",
"ex": "setPlayable aP",
"exres": "",
"name": "setplayable",
"op": "setplayable",
"rname": "unit",
"since": "2.92"
}
],
"setPlayerRespawnTime": [
{
"cat": "General",
"desc": "Set the time interval to wait on player respawn. It is set to mission default on mission start again.",
"ex": "",
"exres": "",
"name": "setplayerrespawntime",
"op": "setplayerrespawntime",
"rname": "time interval",
"since": "1.57"
}
],
"setShadowDistance": [
{
"cat": "General",
"desc": "Sets the shadows rendering distance.",
"ex": "setShadowDistance 1000",
"exres": "",
"name": "setshadowdistance",
"op": "setshadowdistance",
"rname": "newDistance",
"since": "TOH 80934"
}
],
"setSimulWeatherLayers": [
{
"cat": "General",
"desc": "Sets simul weather layers",
"ex": "",
"exres": "",
"name": "setsimulweatherlayers",
"op": "setsimulweatherlayers",
"rname": "layers",
"since": ""
}
],
"setStaminaScheme": [
{
"cat": "General",
"desc": "Set stamina bar color",
"ex": "setStaminaScheme(\"Default\"). The scheme can be \"Normal\", \"FastDrain\", \"Exhausted\", \"Default\"",
"exres": "",
"name": "setstaminascheme",
"op": "setstaminascheme",
"rname": "scheme",
"since": "5501"
}
],
"setStatValue": [
{
"cat": "General",
"desc": "Sets a value to given stat. ",
"ex": "",
"exres": "",
"name": "setstatvalue",
"op": "setstatvalue",
"rname": "[statName, value]",
"since": ""
}
],
"setSystemOfUnits": [
{
"cat": "General",
"desc": "Set system of units. 0 for metric, 1 for mixed, 2 for imperial.",
"ex": "",
"exres": "",
"name": "setsystemofunits",
"op": "setsystemofunits",
"rname": "value",
"since": "1.18"
}
],
"setTerrainGrid": [
{
"cat": "General",
"desc": "Sets the desired terrain resolution (in meters). For default landscapes the supported resolutions are: 50, 25, 12.5, 6.25 and 3.125. If you select an unsupported resolution, the nearest supported resolution is used instead.",
"ex": "setTerrainGrid 12.5",
"exres": "",
"name": "setterraingrid",
"op": "setterraingrid",
"rname": "grid",
"since": "1.75"
}
],
"setTimeMultiplier": [
{
"cat": "General",
"desc": "Time multiplier for in game time.",
"ex": "setTimeMultiplier 60",
"exres": "",
"name": "settimemultiplier",
"op": "settimemultiplier",
"rname": "multiplier",
"since": ""
}
],
"setTrafficDensity": [
{
"cat": "General",
"desc": "Set the density of ambient cars in a rectangle (in cars per kilometer).",
"ex": "",
"exres": "",
"name": "settrafficdensity",
"op": "settrafficdensity",
"rname": "[density, xMin, xMax, zMin, zMax]",
"since": "83700 TOH"
}
],
"setTrafficDistance": [
{
"cat": "General",
"desc": "Set maximum ambient traffic draw distance (in 2D).",
"ex": "",
"exres": "",
"name": "settrafficdistance",
"op": "settrafficdistance",
"rname": "distance",
"since": "83700 TOH"
}
],
"setTrafficGap": [
{
"cat": "General",
"desc": "Set the average gap between ambient cars in a rectangle (in meters).",
"ex": "",
"exres": "",
"name": "settrafficgap",
"op": "settrafficgap",
"rname": "[gap, xMin, xMax, zMin, zMax]",
"since": "83700 TOH"
}
],
"setTrafficSpeed": [
{
"cat": "General",
"desc": "Set ambient traffic speed in a rectangle (in kilometers per hour).",
"ex": "",
"exres": "",
"name": "settrafficspeed",
"op": "settrafficspeed",
"rname": "[speed, xMin, xMax, zMin, zMax]",
"since": "83700 TOH"
}
],
"setViewDistance": [
{
"cat": "General",
"desc": "Sets the rendering distance. Default is 900 meters. The accepted range is from 500 to 5000 meters.",
"ex": "setviewdistance 2000",
"exres": "",
"name": "setviewdistance",
"op": "setviewdistance",
"rname": "distance",
"since": ""
}
],
"setWind": [
{
"cat": "General",
"desc": "Set current (forced == false) or permanent (forced == true) wind direction and force.",
"ex": "",
"exres": "",
"name": "setwind",
"op": "setwind",
"rname": "[x, z, forced]",
"since": "5501"
}
],
"setWindDir": [
{
"cat": "General",
"desc": "Set current wind direction and force.",
"ex": "",
"exres": "",
"name": "setwinddir",
"op": "setwinddir",
"rname": "[x, z]",
"since": "2.92"
}
],
"showChat": [
{
"cat": "General",
"desc": "Shows/hides the whole chat window.",
"ex": "showChat false",
"exres": "",
"name": "showchat",
"op": "showchat",
"rname": "true/false",
"since": ""
}
],
"showCinemaBorder": [
{
"cat": "General",
"desc": "Forces drawing of the cinema borders. This is normally used in cutscenes to indicate the player has no control.",
"ex": "",
"exres": "",
"name": "showcinemaborder",
"op": "showcinemaborder",
"rname": "show",
"since": ""
}
],
"showCommandingMenu": [
{
"cat": "General",
"desc": "Create the commanding menu described by the given config class. When class name is empty, current commanding menu is hidden.",
"ex": "",
"exres": "",
"name": "showcommandingmenu",
"op": "showcommandingmenu",
"rname": "class name",
"since": "5500"
}
],
"showCompass": [
{
"cat": "General",
"desc": "Enables the compass (the default is true).",
"ex": "",
"exres": "",
"name": "showcompass",
"op": "showcompass",
"rname": "show",
"since": ""
}
],
"showCuratorCompass": [
{
"cat": "General",
"desc": "Hides or shows compass in curator interface.",
"ex": "",
"exres": "",
"name": "showcuratorcompass",
"op": "showcuratorcompass",
"rname": "show?",
"since": ""
}
],
"showGps": [
{
"cat": "General",
"desc": "Enables the GPS receiver (the default is false).",
"ex": "",
"exres": "",
"name": "showgps",
"op": "showgps",
"rname": "show",
"since": ""
}
],
"showHUD": [
{
"cat": "General",
"desc": "Enable / disable showing of HUD.",
"ex": "",
"exres": "",
"name": "showhud",
"op": "showhud",
"rname": "enable",
"since": "5501"
},
{
"cat": "General",
"desc": "Enable / disable showing of particular HUD elements.",
"ex": "",
"exres": "",
"name": "showhud",
"op": "showhud",
"rname": "[hud, info, radar, compass, direction, menu, group, cursors]",
"since": "5501"
}
],
"showMap": [
{
"cat": "General",
"desc": "Enables the map (the default is true).",
"ex": "showMap true",
"exres": "",
"name": "showmap",
"op": "showmap",
"rname": "show",
"since": ""
}
],
"showPad": [
{
"cat": "General",
"desc": "Enables the notepad (the default is true).",
"ex": "",
"exres": "",
"name": "showpad",
"op": "showpad",
"rname": "show",
"since": ""
}
],
"showRadio": [
{
"cat": "General",
"desc": "Enables the radio (the default is false).",
"ex": "",
"exres": "",
"name": "showradio",
"op": "showradio",
"rname": "show",
"since": ""
}
],
"showScoretable": [
{
"cat": "General",
"desc": "Shows/Hides score table, 1 to force visible, 0 to force invisible, -1 default",
"ex": "",
"exres": "",
"name": "showscoretable",
"op": "showscoretable",
"rname": "show",
"since": ""
}
],
"showSubtitles": [
{
"cat": "General",
"desc": "Enable / disable showing of subtitles. Return the previous state.",
"ex": "",
"exres": "",
"name": "showsubtitles",
"op": "showsubtitles",
"rname": "enable",
"since": "5501"
}
],
"showUAVFeed": [
{
"cat": "General",
"desc": "Show UAV view.",
"ex": "showUAVFeed true",
"exres": "",
"name": "showuavfeed",
"op": "showuavfeed",
"rname": "show",
"since": "5501"
}
],
"showWarrant": [
{
"cat": "General",
"desc": "Obsolete.\r\nEnables the ID card (the default is false).",
"ex": "",
"exres": "",
"name": "showwarrant",
"op": "showwarrant",
"rname": "show",
"since": ""
}
],
"showWatch": [
{
"cat": "General",
"desc": "Enables the watch (the default is true).",
"ex": "",
"exres": "",
"name": "showwatch",
"op": "showwatch",
"rname": "show",
"since": ""
}
],
"showWaypoints": [
{
"cat": "General",
"desc": "Shows/Hides task HUD markers and waypoints that will fade out in time. Dependable on difficulty settings",
"ex": "",
"exres": "",
"name": "showwaypoints",
"op": "showwaypoints",
"rname": "show",
"since": ""
}
],
"side": [
{
"cat": "General",
"desc": "Returns the side of the unit.",
"ex": "side player == west",
"exres": "",
"name": "side",
"op": "side",
"rname": "unit",
"since": ""
},
{
"cat": "General",
"desc": "Returns the side of the group.",
"ex": "side group player == west",
"exres": "",
"name": "side",
"op": "side",
"rname": "group",
"since": "5501"
},
{
"cat": "Location",
"desc": "Return target side of given location.",
"ex": "",
"exres": "",
"name": "side",
"op": "side",
"rname": "location",
"since": "2.90"
}
],
"simpleTasks": [
{
"cat": "Identity",
"desc": "Return all simple tasks assigned to given person.",
"ex": "",
"exres": "",
"name": "simpletasks",
"op": "simpletasks",
"rname": "person",
"since": "5501"
}
],
"simulCloudDensity": [
{
"cat": "General",
"desc": "Returns density of clouds at given position.",
"ex": "",
"exres": "",
"name": "simulclouddensity",
"op": "simulclouddensity",
"rname": "position",
"since": ""
}
],
"simulCloudOcclusion": [
{
"cat": "General",
"desc": "Returns clouds occlusion between two given points (0 = no clouds, 1 = full clouds).",
"ex": "",
"exres": "",
"name": "simulcloudocclusion",
"op": "simulcloudocclusion",
"rname": "[position1, position2]",
"since": ""
}
],
"simulInClouds": [
{
"cat": "General",
"desc": "Returns if given position is in clouds.",
"ex": "",
"exres": "",
"name": "simulinclouds",
"op": "simulinclouds",
"rname": "position",
"since": ""
}
],
"simulationEnabled": [
{
"cat": "General",
"desc": "Check if the entity has enabled simulation.",
"ex": "",
"exres": "",
"name": "simulationenabled",
"op": "simulationenabled",
"rname": "entity",
"since": "5500"
}
],
"sin": [
{
"cat": "Default",
"desc": "The sine of x, the argument is in degrees.",
"ex": "sin 30",
"exres": "0.5",
"name": "sin",
"op": "sin",
"rname": "x",
"since": ""
}
],
"size": [
{
"cat": "Location",
"desc": "Return size of given location (width, height).",
"ex": "",
"exres": "",
"name": "size",
"op": "size",
"rname": "location",
"since": "2.90"
}
],
"sizeOf": [
{
"cat": "General",
"desc": "Return the size of the entity of given type.",
"ex": "",
"exres": "",
"name": "sizeof",
"op": "sizeof",
"rname": "typeName",
"since": "5160"
}
],
"skill": [
{
"cat": "General",
"desc": "Returns the current level of ability of the person.",
"ex": "skill player",
"exres": "",
"name": "skill",
"op": "skill",
"rname": "person",
"since": "1.75"
}
],
"skipTime": [
{
"cat": "General",
"desc": "Skips the specified time. Daytime is adjusted, a weather change is estimated and no changes to any units are done. Duration is in hours.",
"ex": "skipTime 2.5",
"exres": "",
"name": "skiptime",
"op": "skiptime",
"rname": "duration",
"since": ""
}
],
"sleep": [
{
"cat": "General",
"desc": "Suspend execution of script for given time.",
"ex": "sleep 0.5",
"exres": "",
"name": "sleep",
"op": "sleep",
"rname": "delay",
"since": "2.60"
}
],
"sliderPosition": [
{
"cat": "General",
"desc": "Returns the current thumb position of the given slider.",
"ex": "_pos = sliderPosition _control",
"exres": "",
"name": "sliderposition",
"op": "sliderposition",
"rname": "control",
"since": "2.92"
},
{
"cat": "General",
"desc": "Returns the current thumb position of the slider with id idc of the topmost user dialog.",
"ex": "_pos = sliderPosition 101",
"exres": "",
"name": "sliderposition",
"op": "sliderposition",
"rname": "idc",
"since": "1.79"
}
],
"sliderRange": [
{
"cat": "General",
"desc": "Returns the limits (as an array [min, max]) of the given slider.",
"ex": "_limits = sliderRange _control",
"exres": "",
"name": "sliderrange",
"op": "sliderrange",
"rname": "control",
"since": "2.92"
},
{
"cat": "General",
"desc": "Returns the limits (as an array [min, max]) of the slider with id idc of the topmost user dialog.",
"ex": "_limits = sliderRange 100",
"exres": "",
"name": "sliderrange",
"op": "sliderrange",
"rname": "idc",
"since": "1.79"
}
],
"sliderSetPosition": [
{
"cat": "General",
"desc": "Sets the current thumb position of the slider with id idc of the topmost user dialog.",
"ex": "sliderSetPosition [100, 0]",
"exres": "",
"name": "slidersetposition",
"op": "slidersetposition",
"rname": "[idc, pos]",
"since": "1.79"
}
],
"sliderSetRange": [
{
"cat": "General",
"desc": "Sets the limits of the slider with id idc of the topmost user dialog.",
"ex": "sliderSetRange [100, 0, 10]",
"exres": "",
"name": "slidersetrange",
"op": "slidersetrange",
"rname": "[idc, min, max]",
"since": "1.79"
}
],
"sliderSetSpeed": [
{
"cat": "General",
"desc": "Sets the speed (a click on the arrow results in a move per line. A click on the scale outside the thumb results in a move per page) of the slider with id idc of the topmost user dialog.",
"ex": "sliderSetSpeed [100, 0.5, 2.0]",
"exres": "",
"name": "slidersetspeed",
"op": "slidersetspeed",
"rname": "[idc, line, page]",
"since": "1.79"
}
],
"sliderSpeed": [
{
"cat": "General",
"desc": "Returns the speed (as an array [line, page]) of the given slider.",
"ex": "_speed = sliderSpeed _control",
"exres": "",
"name": "sliderspeed",
"op": "sliderspeed",
"rname": "control",
"since": "2.92"
},
{
"cat": "General",
"desc": "Returns the speed (as an array [line, page]) of the slider with id idc of the topmost user dialog.",
"ex": "_speed = sliderSpeed",
"exres": "",
"name": "sliderspeed",
"op": "sliderspeed",
"rname": "idc",
"since": "1.79"
}
],
"someAmmo": [
{
"cat": "General",
"desc": "Checks whether the unit has some ammo remaining.",
"ex": "someAmmo vehicle player",
"exres": "",
"name": "someammo",
"op": "someammo",
"rname": "unit",
"since": ""
}
],
"speaker": [
{
"cat": "General",
"desc": "Returns the speaker of the variable assigned to the object in the mission editor.",
"ex": "speaker player",
"exres": "",
"name": "speaker",
"op": "speaker",
"rname": "object",
"since": ""
}
],
"speed": [
{
"cat": "General",
"desc": "Returns the object speed (in km/h).",
"ex": "speed player",
"exres": "",
"name": "speed",
"op": "speed",
"rname": "obj",
"since": ""
}
],
"speedMode": [
{
"cat": "General",
"desc": "Returns the speed mode of the group (\"LIMITED\", \"NORMAL\" or \"FULL\").",
"ex": "speedMode group player",
"exres": "",
"name": "speedmode",
"op": "speedmode",
"rname": "grp",
"since": ""
}
],
"sqrt": [
{
"cat": "Default",
"desc": "The square root of x.",
"ex": "sqrt 9",
"exres": "3",
"name": "sqrt",
"op": "sqrt",
"rname": "x",
"since": ""
}
],
"squadParams": [
{
"cat": "General",
"desc": "Returns data about squad of given unit loaded from squad.xml",
"ex": "",
"exres": "",
"name": "squadparams",
"op": "squadparams",
"rname": "unit",
"since": ""
}
],
"stance": [
{
"cat": "General",
"desc": "Returns the stance of the given unit.",
"ex": "",
"exres": "",
"name": "stance",
"op": "stance",
"rname": "unit",
"since": "5501"
}
],
"startLoadingScreen": [
{
"cat": "General",
"desc": "Shows loading screen with the given text, using the given resource. When loading screen is shown, simulation and scene drawing is disabled, scripts run at full speed.",
"ex": "",
"exres": "",
"name": "startloadingscreen",
"op": "startloadingscreen",
"rname": "[text] or [text, resource]",
"since": "5501"
}
],
"stopEngineRTD": [
{
"cat": "General",
"desc": "Instant engines stop.",
"ex": "",
"exres": "",
"name": "stopenginertd",
"op": "stopenginertd",
"rname": "RTD_helicopter",
"since": "TOH 81393"
}
],
"stopped": [
{
"cat": "General",
"desc": "Checks whether the unit is stopped using the \"stop\" command.",
"ex": "stopped jeepOne",
"exres": "",
"name": "stopped",
"op": "stopped",
"rname": "unit",
"since": ""
}
],
"str": [
{
"cat": "Default",
"desc": "Converts any variable to a string.",
"ex": "str(2+3)",
"exres": "\"5\"",
"name": "str",
"op": "str",
"rname": "any value",
"since": "2.00"
}
],
"supportInfo": [
{
"cat": "Default",
"desc": "Creates list of supported operators and type. Each field of array has format: \"x:name\" where x is 't' - type, 'n' - nullary operator, 'u' - unary operator, 'b' - binary operator. 'name' is operator's/type's name (in case operator, type of input operands is included). `mask` parameter can be empty string, or one of field. In this case, function returns empty array, if operator is not included in list. `mask` can contain wildcards, for example: *:name, t:*, t:name* or *:*.",
"ex": "supportInfo \"b:select*\"",
"exres": "[\"b:ARRAY select SCALAR\",\"b:ARRAY select BOOL\"]",
"name": "supportinfo",
"op": "supportinfo",
"rname": "mask",
"since": "2.00"
}
],
"surfaceIsWater": [
{
"cat": "General",
"desc": "Returns whether water is on given position.",
"ex": "",
"exres": "",
"name": "surfaceiswater",
"op": "surfaceiswater",
"rname": "[x, y]",
"since": "2.58"
}
],
"surfaceNormal": [
{
"cat": "General",
"desc": "Returns surface normal on given position.",
"ex": "",
"exres": "",
"name": "surfacenormal",
"op": "surfacenormal",
"rname": "[x, y]",
"since": "86233"
}
],
"surfaceType": [
{
"cat": "General",
"desc": "Returns what surface is on given position.",
"ex": "",
"exres": "",
"name": "surfacetype",
"op": "surfacetype",
"rname": "[x, y]",
"since": "2.58"
}
],
"switch": [
{
"cat": "Default",
"desc": "Begins switch form",
"ex": "switch (_a) do { case 1: {block}; case 2 : {block}; default {block};}",
"exres": "",
"name": "switch",
"op": "switch",
"rname": "exp",
"since": ""
}
],
"switchCamera": [
{
"cat": "General",
"desc": "Switches camera to the given unit without changing the camera mode",
"ex": "switchCamera cursorTarget",
"exres": "",
"name": "switchcamera",
"op": "switchcamera",
"rname": "unit",
"since": ""
}
],
"synchronizedObjects": [
{
"cat": "General",
"desc": "Return the list of objects synchronized with the given unit/trigger.",
"ex": "",
"exres": "",
"name": "synchronizedobjects",
"op": "synchronizedobjects",
"rname": "unit/trigger",
"since": "5501"
}
],
"synchronizedTriggers": [
{
"cat": "General",
"desc": "Return the list of triggers synchronized with a given waypoint.",
"ex": "synchronizedTriggers [group player, 1]",
"exres": "",
"name": "synchronizedtriggers",
"op": "synchronizedtriggers",
"rname": "waypoint",
"since": ""
}
],
"synchronizedWaypoints": [
{
"cat": "General",
"desc": "Return the list of waypoints synchronized with a given trigger.",
"ex": "synchronizedWaypoints trigger1",
"exres": "",
"name": "synchronizedwaypoints",
"op": "synchronizedwaypoints",
"rname": "trigger",
"since": ""
},
{
"cat": "General",
"desc": "Return the list of waypoints synchronized with a given waypoint.",
"ex": "synchronizedWaypoints [group player, 1]",
"exres": "",
"name": "synchronizedwaypoints",
"op": "synchronizedwaypoints",
"rname": "waypoint",
"since": ""
}
],
"systemChat": [
{
"cat": "General",
"desc": "Types text to the system radio channel.\r\nNote: 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.",
"ex": "systemChat \"Dam of Peace\"",
"exres": "",
"name": "systemchat",
"op": "systemchat",
"rname": "chatText",
"since": ""
}
],
"tan": [
{
"cat": "Default",
"desc": "The tangens of x, the argument is in degrees.",
"ex": "tan 45",
"exres": "1",
"name": "tan",
"op": "tan",
"rname": "x",
"since": ""
}
],
"taskAlwaysVisible": [
{
"cat": "Identity",
"desc": "Returns true if task is flagged to be always visible or false if not. (always visible in 3D).",
"ex": "",
"exres": "",
"name": "taskalwaysvisible",
"op": "taskalwaysvisible",
"rname": "task",
"since": ""
}
],
"taskChildren": [
{
"cat": "Identity",
"desc": "Return the child tasks of the specified task.",
"ex": "",
"exres": "",
"name": "taskchildren",
"op": "taskchildren",
"rname": "task",
"since": "2.92"
}
],
"taskCompleted": [
{
"cat": "Identity",
"desc": "Return if task is completed. (state Succeeded, Failed or Canceled)",
"ex": "",
"exres": "",
"name": "taskcompleted",
"op": "taskcompleted",
"rname": "task",
"since": "2.89"
}
],
"taskCustomData": [
{
"cat": "Identity",
"desc": "Returns array of custom data [icon,iconText,descriptionText] as defined via setSimpleTaskCustomData",
"ex": "",
"exres": "",
"name": "taskcustomdata",
"op": "taskcustomdata",
"rname": "task",
"since": ""
}
],
"taskDescription": [
{
"cat": "Identity",
"desc": "Returns the descripction of the task.",
"ex": "",
"exres": "",
"name": "taskdescription",
"op": "taskdescription",
"rname": "task",
"since": "5501"
}
],
"taskDestination": [
{
"cat": "Identity",
"desc": "Returns the position of the task (as specified by destination parameter in config).",
"ex": "",
"exres": "",
"name": "taskdestination",
"op": "taskdestination",
"rname": "task",
"since": "2.92"
}
],
"taskHint": [
{
"cat": "General",
"desc": "Shows info about new,changed or failed task. The text can contain several lines. \\n is used to indicate the end of a line.",
"ex": "taskHint \"Capture town.\"",
"exres": "",
"name": "taskhint",
"op": "taskhint",
"rname": "text",
"since": ""
}
],
"taskMarkerOffset": [
{
"cat": "General",
"desc": "Returns model space position for the task marker",
"ex": "taskMarkerOffset player",
"exres": "",
"name": "taskmarkeroffset",
"op": "taskmarkeroffset",
"rname": "obj",
"since": "1.58"
}
],
"taskParent": [
{
"cat": "Identity",
"desc": "Return the parent task of the specified task.",
"ex": "",
"exres": "",
"name": "taskparent",
"op": "taskparent",
"rname": "task",
"since": "2.92"
}
],
"taskResult": [
{
"cat": "Identity",
"desc": "Return the result of the given task.",
"ex": "",
"exres": "",
"name": "taskresult",
"op": "taskresult",
"rname": "task",
"since": "2.92"
}
],
"taskState": [
{
"cat": "Identity",
"desc": "Return the state of the given task.",
"ex": "",
"exres": "",
"name": "taskstate",
"op": "taskstate",
"rname": "task",
"since": "2.89"
}
],
"taskType": [
{
"cat": "Identity",
"desc": "Returns the task type name.",
"ex": "",
"exres": "",
"name": "tasktype",
"op": "tasktype",
"rname": "task",
"since": ""
}
],
"teamMember": [
{
"cat": "Agents",
"desc": "Return an agent for given person.",
"ex": "_agent = teamMember player",
"exres": "",
"name": "teammember",
"op": "teammember",
"rname": "person",
"since": "2.90"
}
],
"teamName": [
{
"cat": "Agents",
"desc": "Return a name of given team.",
"ex": "_name = teamName _team",
"exres": "",
"name": "teamname",
"op": "teamname",
"rname": "team",
"since": "2.90"
}
],
"teamType": [
{
"cat": "Agents",
"desc": "Return a type of given team.",
"ex": "_type = teamType _team",
"exres": "",
"name": "teamtype",
"op": "teamtype",
"rname": "team",
"since": "2.90"
}
],
"terminate": [
{
"cat": "General",
"desc": "Terminate (abort) the script",
"ex": "",
"exres": "",
"name": "terminate",
"op": "terminate",
"rname": "script",
"since": "2.50"
}
],
"terrainIntersect": [
{
"cat": "General",
"desc": "Checks for intersection of terrain between two positions. Returns true if intersects with terrain",
"ex": "_doesIntersect = terrainIntersect [ position player, position enemy1 ];",
"exres": "",
"name": "terrainintersect",
"op": "terrainintersect",
"rname": "[ position begin, position end ]",
"since": "A3 89671"
}
],
"terrainIntersectASL": [
{
"cat": "General",
"desc": "Checks for intersection of terrain between two positions. Returns true if intersects with terrain",
"ex": "_doesIntersect = terrainIntersectASL [ getposAsl player, getposAsl enemy1 ];",
"exres": "",
"name": "terrainintersectasl",
"op": "terrainintersectasl",
"rname": "[ positionASL begin, positionASL end ]",
"since": "OA 93671"
}
],
"terrainIntersectAtASL": [
{
"cat": "General",
"desc": "Checks for intersection of terrain between two positions. Returns resulting position if intersects with terrain or [0,0,0] if not",
"ex": "_intersectPos = terrainIntersectAtASL [ getposAsl player, getposAsl enemy1 ];",
"exres": "",
"name": "terrainintersectatasl",
"op": "terrainintersectatasl",
"rname": "[ positionASL begin, positionASL end ]",
"since": ""
}
],
"text": [
{
"cat": "General",
"desc": "Creates a structured text containing the given plain text.",
"ex": "txt2 = text \"Hello world.\"",
"exres": "",
"name": "text",
"op": "text",
"rname": "text",
"since": "2.01"
},
{
"cat": "Location",
"desc": "Return text attached to given location.",
"ex": "",
"exres": "",
"name": "text",
"op": "text",
"rname": "location",
"since": "2.90"
}
],
"textLog": [
{
"cat": "General",
"desc": "Dumps the argument value into the debugging output.",
"ex": "textLog player",
"exres": "",
"name": "textlog",
"op": "textlog",
"rname": "anything",
"since": ""
}
],
"textLogFormat": [
{
"cat": "General",
"desc": "Shortcut to textLog format [format, arg1, arg2, ...] (for better performance in retail version).",
"ex": "",
"exres": "",
"name": "textlogformat",
"op": "textlogformat",
"rname": "[format, arg1, arg2, ...]",
"since": "5501"
}
],
"tg": [
{
"cat": "Default",
"desc": "The tangens of x, the argument is in degrees.",
"ex": "tg 45",
"exres": "1",
"name": "tg",
"op": "tg",
"rname": "x",
"since": ""
}
],
"throw": [
{
"cat": "Default",
"desc": "Throws an exception. The exception is processed by first catch block. See <f>try</f>.",
"ex": "throw \"invalid argument\"",
"exres": "",
"name": "throw",
"op": "throw",
"rname": "expression",
"since": ""
}
],
"titleCut": [
{
"cat": "General",
"desc": "Obsolete.",
"ex": "",
"exres": "",
"name": "titlecut",
"op": "titlecut",
"rname": "effect",
"since": ""
}
],
"titleFadeOut": [
{
"cat": "General",
"desc": "Terminate the title effect and set duration of the fade out phase to the given time.",
"ex": "titleFadeIn 1.0",
"exres": "",
"name": "titlefadeout",
"op": "titlefadeout",
"rname": "duration",
"since": "5126"
}
],
"titleObj": [
{
"cat": "General",
"desc": "Object title - the argument uses format [\"text\",\"type\",speed, showInMap] or [\"name\",\"type\"]. If speed is not given, it's assumed to be one.\r\nThe object can be defined in the description.ext file.",
"ex": "titleObj [\"BISLogo\",\"plain\"]",
"exres": "",
"name": "titleobj",
"op": "titleobj",
"rname": "effect",
"since": ""
}
],
"titleRsc": [
{
"cat": "General",
"desc": "Resource title - the argument uses format [\"name\",\"type\",speed, showInMap] or [\"name\",\"type\"]. If speed is not given, it's assumed to be one.\r\nResource can be defined in the description.ext file.",
"ex": "titleRsc [\"BIS\", \"PLAIN\"]",
"exres": "",
"name": "titlersc",
"op": "titlersc",
"rname": "effect",
"since": ""
}
],
"titleText": [
{
"cat": "General",
"desc": "Text title - the argument uses format [\"text\",\"type\",speed, showInMap] or [\"text\",\"type\"]. If speed is not given, it's assumed to be one.",
"ex": "titleText [\"Show this text\", \"PLAIN\"]",
"exres": "",
"name": "titletext",
"op": "titletext",
"rname": "effect",
"since": ""
}
],
"toArray": [
{
"cat": "Default",
"desc": "Convert the string to the array of characters.",
"ex": "toArray \"ArmA\"",
"exres": "[65, 114, 109, 65]",
"name": "toarray",
"op": "toarray",
"rname": "string",
"since": "5195"
}
],
"toLower": [
{
"cat": "Default",
"desc": "Convert the string to lower case.",
"ex": "toLower \"ArmA\"",
"exres": "\"arma\"",
"name": "tolower",
"op": "tolower",
"rname": "string",
"since": "5195"
}
],
"toString": [
{
"cat": "Default",
"desc": "Convert the array of characters to the string.",
"ex": "toString [65, 114, 109, 65]",
"exres": "\"ArmA\"",
"name": "tostring",
"op": "tostring",
"rname": "characters",
"since": "5195"
}
],
"toUpper": [
{
"cat": "Default",
"desc": "Convert the string to upper case.",
"ex": "toUpper \"ArmA\"",
"exres": "\"ARMA\"",
"name": "toupper",
"op": "toupper",
"rname": "string",
"since": "5195"
}
],
"triggerActivated": [
{
"cat": "General",
"desc": "Returns true if the trigger has been activated.",
"ex": "",
"exres": "",
"name": "triggeractivated",
"op": "triggeractivated",
"rname": "trigger",
"since": "5501"
}
],
"triggerActivation": [
{
"cat": "General",
"desc": "Returns trigger activation in the form [by, type, repeating]",
"ex": "",
"exres": "",
"name": "triggeractivation",
"op": "triggeractivation",
"rname": "trigger",
"since": "5501"
}
],
"triggerArea": [
{
"cat": "General",
"desc": "Returns trigger area in the form [a, b, angle, rectangle]",
"ex": "",
"exres": "",
"name": "triggerarea",
"op": "triggerarea",
"rname": "trigger",
"since": "5501"
}
],
"triggerAttachedVehicle": [
{
"cat": "General",
"desc": "Returns vehicle attached to the trigger (for example using <f>triggerAttachVehicle</f>)",
"ex": "",
"exres": "",
"name": "triggerattachedvehicle",
"op": "triggerattachedvehicle",
"rname": "trigger",
"since": "5101"
}
],
"triggerStatements": [
{
"cat": "General",
"desc": "Returns trigger statements in the form [cond, activ, desactiv]",
"ex": "",
"exres": "",
"name": "triggerstatements",
"op": "triggerstatements",
"rname": "trigger",
"since": "5501"
}
],
"triggerText": [
{
"cat": "General",
"desc": "Returns trigger text.",
"ex": "",
"exres": "",
"name": "triggertext",
"op": "triggertext",
"rname": "trigger",
"since": "5501"
}
],
"triggerTimeout": [
{
"cat": "General",
"desc": "Returns trigger timeout in the form [min, mid, max, interruptable]",
"ex": "",
"exres": "",
"name": "triggertimeout",
"op": "triggertimeout",
"rname": "trigger",
"since": "5501"
}
],
"triggerTimeoutCurrent": [
{
"cat": "General",
"desc": "Returns trigger timeout or -1 if countdown is not in progress.",
"ex": "triggerTimeoutCurrent triggerOne",
"exres": "",
"name": "triggertimeoutcurrent",
"op": "triggertimeoutcurrent",
"rname": "trigger",
"since": "112547"
}
],
"triggerType": [
{
"cat": "General",
"desc": "Returns trigger type.",
"ex": "",
"exres": "",
"name": "triggertype",
"op": "triggertype",
"rname": "trigger",
"since": "5501"
}
],
"try": [
{
"cat": "Default",
"desc": "Defines try-catch structure. This is structured exception block. Any thrown exception in try block is caught in catch block. The structured exception block has following form<pre>try //begin of try-catch block\n{\n //block, that can throw exception\n}\ncatch{\n //block, that process an exception. Exception is described in _exception variable\n}</pre>;\n",
"ex": "",
"exres": "",
"name": "try",
"op": "try",
"rname": "code",
"since": ""
}
],
"tvAdd": [
{
"cat": "General",
"desc": "Adds an item with given text to Tree View with given idc under specified path (zero based).",
"ex": "tvAdd [101, [0], \"First item\"]",
"exres": "",
"name": "tvadd",
"op": "tvadd",
"rname": "[idc, [path], text]",
"since": "106345"
}
],
"tvClear": [
{
"cat": "General",
"desc": "Removes all items from Tree View with given idc.",
"ex": "tvClear 101",
"exres": "",
"name": "tvclear",
"op": "tvclear",
"rname": "idc",
"since": "106345"
},
{
"cat": "General",
"desc": "Removes all items from Tree View with given idc.",
"ex": "tvClear 101",
"exres": "",
"name": "tvclear",
"op": "tvclear",
"rname": "idc",
"since": "106345"
}
],
"tvCollapse": [
{
"cat": "General",
"desc": "Collapses tree item pointed to by path. IDC means id of parent Tree View.",
"ex": "tvCollapse [101,[0]]",
"exres": "",
"name": "tvcollapse",
"op": "tvcollapse",
"rname": "[idc, [path]]",
"since": "106345"
}
],
"tvCollapseAll": [
{
"cat": "General",
"desc": "Collapses whole tree. IDC means id of Tree to collapse.",
"ex": "tvCollapseAll 101",
"exres": "",
"name": "tvcollapseall",
"op": "tvcollapseall",
"rname": "idc",
"since": "106345"
},
{
"cat": "General",
"desc": "Collapses whole tree. IDC means id of Tree to collapse.",
"ex": "tvCollapseAll ctrl",
"exres": "",
"name": "tvcollapseall",
"op": "tvcollapseall",
"rname": "ctrl",
"since": "106345"
}
],
"tvCount": [
{
"cat": "General",
"desc": "Returns children count of item on given path. IDC means id of parent Tree View.",
"ex": "tvCount [101,[0]]",
"exres": "",
"name": "tvcount",
"op": "tvcount",
"rname": "[idc, [path]]",
"since": "106345"
}
],
"tvCurSel": [
{
"cat": "General",
"desc": "Returns path to currently selected item. IDC means id of parent Tree View.",
"ex": "tvCurSel 101",
"exres": "",
"name": "tvcursel",
"op": "tvcursel",
"rname": "idc",
"since": "106345"
},
{
"cat": "General",
"desc": "Returns path to currently selected item. IDC means id of parent Tree View.",
"ex": "tvCurSel 101",
"exres": "",
"name": "tvcursel",
"op": "tvcursel",
"rname": "idc",
"since": "106345"
}
],
"tvData": [
{
"cat": "General",
"desc": "Returns string data from item on given path. IDC means id of parent Tree View.",
"ex": "tvData [101,[0]]",
"exres": "",
"name": "tvdata",
"op": "tvdata",
"rname": "[idc, [path]]",
"since": "106345"
}
],
"tvDelete": [
{
"cat": "General",
"desc": "Removes an item on given path from Tree View with given idc.",
"ex": "tvDelete [101, [0,0]]",
"exres": "",
"name": "tvdelete",
"op": "tvdelete",
"rname": "[idc, [path]]",
"since": "106345"
}
],
"tvExpand": [
{
"cat": "General",
"desc": "Expands tree item pointed to by path. IDC means id of parent Tree View.",
"ex": "tvExpand [101,[0]]",
"exres": "",
"name": "tvexpand",
"op": "tvexpand",
"rname": "[idc, [path]]",
"since": "106345"
}
],
"tvExpandAll": [
{
"cat": "General",
"desc": "Expands whole tree. IDC means id of Tree to expand.",
"ex": "tvExpandAll 101",
"exres": "",
"name": "tvexpandall",
"op": "tvexpandall",
"rname": "idc",
"since": "106345"
},
{
"cat": "General",
"desc": "Expands whole tree. IDC means id of Tree to expand.",
"ex": "tvExpandAll ctrl",
"exres": "",
"name": "tvexpandall",
"op": "tvexpandall",
"rname": "ctrl",
"since": "106345"
}
],
"tvPicture": [
{
"cat": "General",
"desc": "Returns name of picture from item pointed to by path. IDC means id of parent Tree View.",
"ex": "tvPicture [101,[0]]",
"exres": "",
"name": "tvpicture",
"op": "tvpicture",
"rname": "[idc, [path]]",
"since": "106345"
}
],
"tvPictureRight": [
{
"cat": "General",
"desc": "Returns name of picture from item pointed to by path. IDC means id of parent Tree View.",
"ex": "tvPicture [101,[0]]",
"exres": "",
"name": "tvpictureright",
"op": "tvpictureright",
"rname": "[idc, [path]]",
"since": "106345"
}
],
"tvSetCurSel": [
{
"cat": "General",
"desc": "Sets cursor to given item on given path. IDC means id of parent Tree View.",
"ex": "tvSetCurSel [101,[0]]",
"exres": "",
"name": "tvsetcursel",
"op": "tvsetcursel",
"rname": "[idc, [path]]",
"since": "106345"
}
],
"tvSetData": [
{
"cat": "General",
"desc": "Sets string data to item on given path. IDC means id of parent Tree View.",
"ex": "tvSetData [101,[0],\"Test data\"]",
"exres": "",
"name": "tvsetdata",
"op": "tvsetdata",
"rname": "[idc, [path], \"data\"]",
"since": "106345"
}
],
"tvSetPicture": [
{
"cat": "General",
"desc": "Sets picture to item selected by path. IDC means id of parent Tree View. Name is the picture name. The picture is searched in the mission directory",
"ex": "tvSetPicture [101,[0],\"picture\"]",
"exres": "",
"name": "tvsetpicture",
"op": "tvsetpicture",
"rname": "[idc, [path],name]",
"since": "106345"
}
],
"tvSetPictureColor": [
{
"cat": "General",
"desc": "Sets color of picture to item selected by path. IDC means id of parent Tree View.",
"ex": "tvSetPictureColor [101,[0],[1,0,1,1]]",
"exres": "",
"name": "tvsetpicturecolor",
"op": "tvsetpicturecolor",
"rname": "[idc, [path], [r,g,b,a]]",
"since": "106345"
}
],
"tvSetPictureRight": [
{
"cat": "General",
"desc": "Sets picture to item selected by path. IDC means id of parent Tree View. Name is the picture name. The picture is searched in the mission directory",
"ex": "tvSetPicture [101,[0],\"picture\"]",
"exres": "",
"name": "tvsetpictureright",
"op": "tvsetpictureright",
"rname": "[idc, [path],name]",
"since": "106345"
}
],
"tvSetPictureRightColor": [
{
"cat": "General",
"desc": "Sets color of picture to item selected by path. IDC means id of parent Tree View.",
"ex": "tvSetPictureColor [101,[0],[1,0,1,1]]",
"exres": "",
"name": "tvsetpicturerightcolor",
"op": "tvsetpicturerightcolor",
"rname": "[idc, [path], [r,g,b,a]]",
"since": "106345"
}
],
"tvSetText": [
{
"cat": "General",
"desc": "Sets text in the item on given path. IDC means id of parent Tree View.",
"ex": "tvText [101,[0]]",
"exres": "",
"name": "tvsettext",
"op": "tvsettext",
"rname": "[idc, [path], \"text\"]",
"since": "106345"
}
],
"tvSetTooltip": [
{
"cat": "General",
"desc": "Sets tooltip for item with the given index of the tree view with id idc of the topmost user dialog to the given data.",
"ex": "tvSetTooltip [101, 1, \"tooltip\"]",
"exres": "",
"name": "tvsettooltip",
"op": "tvsettooltip",
"rname": "[idc, index, tooltip]",
"since": ""
}
],
"tvSetValue": [
{
"cat": "General",
"desc": "Sets scalar data to item on given path. IDC means id of parent Tree View.",
"ex": "tvSetValue [101,[0], 555]",
"exres": "",
"name": "tvsetvalue",
"op": "tvsetvalue",
"rname": "[idc, [path], val]",
"since": "106345"
}
],
"tvSort": [
{
"cat": "General",
"desc": "Sorts children of given item by data. Param reversed is optional. IDC means id of parent Tree View.",
"ex": "tvSort [101,[0],false]",
"exres": "",
"name": "tvsort",
"op": "tvsort",
"rname": "[idc,[path],reversed]",
"since": "106345"
}
],
"tvSortByValue": [
{
"cat": "General",
"desc": "Sorts children of given item by value. Param reversed is optional. IDC means id of parent Tree View.",
"ex": "tvSort [101,[0],false]",
"exres": "",
"name": "tvsortbyvalue",
"op": "tvsortbyvalue",
"rname": "[idc,[path],reversed]",
"since": "106345"
}
],
"tvText": [
{
"cat": "General",
"desc": "Returns shown text in the item on given path. IDC means id of parent Tree View.",
"ex": "tvText [101,[0]]",
"exres": "",
"name": "tvtext",
"op": "tvtext",
"rname": "[idc, [path]]",
"since": "106345"
}
],
"tvTooltip": [
{
"cat": "General",
"desc": "Returns the tooltip of the item in the given path of the treeview with id idc of the topmost user dialog.",
"ex": "_text = lbText [101, 0]",
"exres": "",
"name": "tvtooltip",
"op": "tvtooltip",
"rname": "[idc, path]",
"since": "1.50"
}
],
"tvValue": [
{
"cat": "General",
"desc": "Returns scalar data from item on given path. IDC means id of parent Tree View.",
"ex": "tvValue [101,[0]]",
"exres": "",
"name": "tvvalue",
"op": "tvvalue",
"rname": "[idc, [path]]",
"since": "106345"
}
],
"type": [
{
"cat": "Identity",
"desc": "Return the type of the task.",
"ex": "",
"exres": "",
"name": "type",
"op": "type",
"rname": "task",
"since": "2.91"
},
{
"cat": "Location",
"desc": "Return type of given location.",
"ex": "",
"exres": "",
"name": "type",
"op": "type",
"rname": "location",
"since": "2.90"
}
],
"typeName": [
{
"cat": "Default",
"desc": "Returns type-name of expression. Type is returned as string",
"ex": "typeName \"hello\"",
"exres": "\"string\"",
"name": "typename",
"op": "typename",
"rname": "any",
"since": "2.00"
}
],
"typeOf": [
{
"cat": "General",
"desc": "Returns the name of the type of the given object.",
"ex": "typeOf player",
"exres": "\"SoldierWB\"",
"name": "typeof",
"op": "typeof",
"rname": "object",
"since": "1.91"
}
],
"uisleep": [
{
"cat": "General",
"desc": "Suspend execution of script for given uitime.",
"ex": "uisleep 0.5",
"exres": "",
"name": "uisleep",
"op": "uisleep",
"rname": "delay",
"since": "5501"
}
],
"unassignCurator": [
{
"cat": "General",
"desc": "Unassign curator (will destroy both sides of connection).",
"ex": "",
"exres": "",
"name": "unassigncurator",
"op": "unassigncurator",
"rname": "curatorObj",
"since": ""
}
],
"unassignTeam": [
{
"cat": "General",
"desc": "Unassigns the vehicle (its commander unit) from his team. This is equal to vehicle assignTeam \"MAIN\".",
"ex": "unassignTeam soldier2",
"exres": "",
"name": "unassignteam",
"op": "unassignteam",
"rname": "vehicle",
"since": "2.05"
}
],
"unassignVehicle": [
{
"cat": "General",
"desc": "The person is unassigned from the vehicle. If he is currently inside, the group leader will issue an order to disembark.",
"ex": "unassignVehicle player",
"exres": "",
"name": "unassignvehicle",
"op": "unassignvehicle",
"rname": "unit",
"since": ""
}
],
"underwater": [
{
"cat": "General",
"desc": "Return whether object is fully underwater.",
"ex": "",
"exres": "",
"name": "underwater",
"op": "underwater",
"rname": "object",
"since": "81571"
}
],
"uniform": [
{
"cat": "General",
"desc": "Returns name of currently used uniform.",
"ex": "",
"exres": "",
"name": "uniform",
"op": "uniform",
"rname": "unit",
"since": "5501"
}
],
"uniformContainer": [
{
"cat": "General",
"desc": "Returns container of currently used uniform.",
"ex": "",
"exres": "",
"name": "uniformcontainer",
"op": "uniformcontainer",
"rname": "unit",
"since": "5501"
}
],
"uniformItems": [
{
"cat": "General",
"desc": "Get array with all items from uniform.",
"ex": "",
"exres": "",
"name": "uniformitems",
"op": "uniformitems",
"rname": "unit",
"since": "5501"
}
],
"uniformMagazines": [
{
"cat": "General",
"desc": "Get array with all magazines from vest.",
"ex": "",
"exres": "",
"name": "uniformmagazines",
"op": "uniformmagazines",
"rname": "unit",
"since": "5501"
}
],
"unitAddons": [
{
"cat": "General",
"desc": "Get list with addons which unitClass belongs to.",
"ex": "unitAddons unitClass",
"exres": "",
"name": "unitaddons",
"op": "unitaddons",
"rname": "unitClass",
"since": ""
}
],
"unitAimPosition": [
{
"cat": "General",
"desc": "Returns future unit aiming position.",
"ex": "",
"exres": "",
"name": "unitaimposition",
"op": "unitaimposition",
"rname": "object",
"since": "1.62"
}
],
"unitAimPositionVisual": [
{
"cat": "General",
"desc": "Returns actual unit aiming position (also used to draw group markers).",
"ex": "",
"exres": "",
"name": "unitaimpositionvisual",
"op": "unitaimpositionvisual",
"rname": "object",
"since": "1.62"
}
],
"unitBackpack": [
{
"cat": "General",
"desc": "Returns unit's backpack.",
"ex": "",
"exres": "",
"name": "unitbackpack",
"op": "unitbackpack",
"rname": "unit",
"since": "5501"
}
],
"unitIsUAV": [
{
"cat": "General",
"desc": "Returns true if the unit type is UAV - coresponding to transport param \"isUAV\").",
"ex": "",
"exres": "",
"name": "unitisuav",
"op": "unitisuav",
"rname": "object",
"since": "1.62"
}
],
"unitPos": [
{
"cat": "General",
"desc": "Return the unit position rules.",
"ex": "",
"exres": "",
"name": "unitpos",
"op": "unitpos",
"rname": "person",
"since": "2.92"
}
],
"unitReady": [
{
"cat": "General",
"desc": "Checks whether the unit is ready. A unit is busy when it's given an order like \"move\", until the command is finished.",
"ex": "unitReady player",
"exres": "",
"name": "unitready",
"op": "unitready",
"rname": "unit",
"since": ""
}
],
"unitRecoilCoefficient": [
{
"cat": "General",
"desc": "Returns unit's custom recoil coefficient.",
"ex": " coef = unitRecoilCoefficient player",
"exres": "",
"name": "unitrecoilcoefficient",
"op": "unitrecoilcoefficient",
"rname": "soldier",
"since": "90707"
}
],
"units": [
{
"cat": "General",
"desc": "Returns an array with all the units in the group.",
"ex": "player in units group player",
"exres": "",
"name": "units",
"op": "units",
"rname": "grp",
"since": ""
},
{
"cat": "General",
"desc": "Returns an array with all the units in the group of the given object. For a destroyed object an empty array is returned.",
"ex": "player in units player",
"exres": "",
"name": "units",
"op": "units",
"rname": "unit",
"since": ""
}
],
"unlockAchievement": [
{
"cat": "General",
"desc": "Unlock the given achievement.",
"ex": "",
"exres": "",
"name": "unlockachievement",
"op": "unlockachievement",
"rname": "name",
"since": "5501"
}
],
"updateObjectTree": [
{
"cat": "Editor",
"desc": "Update the editor object tree.",
"ex": "",
"exres": "",
"name": "updateobjecttree",
"op": "updateobjecttree",
"rname": "map",
"since": "2.92"
}
],
"useAIOperMapObstructionTest": [
{
"cat": "General",
"desc": "Enable or disable secondary obstruction test on road paths",
"ex": "useAIOperMapObstructionTest true",
"exres": "",
"name": "useaiopermapobstructiontest",
"op": "useaiopermapobstructiontest",
"rname": "true/false",
"since": ""
}
],
"useAISteeringComponent": [
{
"cat": "General",
"desc": "Enable or disable new ai driving routines.",
"ex": "useAISteeringComponent true",
"exres": "",
"name": "useaisteeringcomponent",
"op": "useaisteeringcomponent",
"rname": "true/false",
"since": ""
}
],
"vectorDir": [
{
"cat": "General",
"desc": "Return object's direction vector in world coordinates as [x, z, y].",
"ex": "",
"exres": "",
"name": "vectordir",
"op": "vectordir",
"rname": "obj",
"since": "2.61"
}
],
"vectorDirVisual": [
{
"cat": "General",
"desc": "Return object's direction vector in world coordinates as [x, z, y].",
"ex": "",
"exres": "",
"name": "vectordirvisual",
"op": "vectordirvisual",
"rname": "obj",
"since": "2.61"
}
],
"vectorMagnitude": [
{
"cat": "General",
"desc": "Magnitude of a vector",
"ex": "vectorMagnitude [0,8,7]",
"exres": "",
"name": "vectormagnitude",
"op": "vectormagnitude",
"rname": "array",
"since": ""
}
],
"vectorMagnitudeSqr": [
{
"cat": "General",
"desc": "Squared magnitude of a vector",
"ex": "vectorMagnitudeSqr [4,1,3]",
"exres": "",
"name": "vectormagnitudesqr",
"op": "vectormagnitudesqr",
"rname": "array",
"since": ""
}
],
"vectorNormalized": [
{
"cat": "General",
"desc": "Normalized vector (unit vector), if original vector is zero, result is a zero vector as well",
"ex": "vectorNormalized [4,1,3]",
"exres": "",
"name": "vectornormalized",
"op": "vectornormalized",
"rname": "array",
"since": ""
}
],
"vectorUp": [
{
"cat": "General",
"desc": "Return object's up vector in world coordinates as [x, z, y].",
"ex": "",
"exres": "",
"name": "vectorup",
"op": "vectorup",
"rname": "obj",
"since": "2.61"
}
],
"vectorUpVisual": [
{
"cat": "General",
"desc": "Return object's up vector in world coordinates as [x, z, y].",
"ex": "",
"exres": "",
"name": "vectorupvisual",
"op": "vectorupvisual",
"rname": "obj",
"since": "2.61"
}
],
"vehicle": [
{
"cat": "General",
"desc": "Returns the vehicle in which the given unit is mounted. If there is none, the unit is returned.",
"ex": "vehicle player != player",
"exres": "",
"name": "vehicle",
"op": "vehicle",
"rname": "unit",
"since": ""
}
],
"vehicleCargoEnabled": [
{
"cat": "General",
"desc": "Check if the vehicle has enabled transporting other vehicles or not.",
"ex": "vehicleCargoEnabled veh",
"exres": "",
"name": "vehiclecargoenabled",
"op": "vehiclecargoenabled",
"rname": "vehicle",
"since": "126046"
}
],
"vehicleVarName": [
{
"cat": "General",
"desc": "Returns the name of the variable which contains a reference to this object.",
"ex": "",
"exres": "",
"name": "vehiclevarname",
"op": "vehiclevarname",
"rname": "object",
"since": "2.91"
}
],
"velocity": [
{
"cat": "General",
"desc": "Returns the velocity (speed vector) of the vehicle as an array with format [x, z, y].",
"ex": "",
"exres": "",
"name": "velocity",
"op": "velocity",
"rname": "vehicle",
"since": "1.80"
}
],
"velocityModelSpace": [
{
"cat": "General",
"desc": "Returns the velocity (speed vector) of the vehicle as an array with format [x, z, y]. Vector is in model space",
"ex": "",
"exres": "",
"name": "velocitymodelspace",
"op": "velocitymodelspace",
"rname": "vehicle",
"since": "1.80"
}
],
"verifySignature": [
{
"cat": "General",
"desc": "Check if file is signed by any key present in game keys folders. Note: On client, it does not check against the keys accepted by server.",
"ex": "",
"exres": "",
"name": "verifysignature",
"op": "verifysignature",
"rname": "filename",
"since": "2.91"
}
],
"vest": [
{
"cat": "General",
"desc": "Returns name of currently used vest.",
"ex": "",
"exres": "",
"name": "vest",
"op": "vest",
"rname": "unit",
"since": "5501"
}
],
"vestContainer": [
{
"cat": "General",
"desc": "Returns container of currently used vest.",
"ex": "",
"exres": "",
"name": "vestcontainer",
"op": "vestcontainer",
"rname": "unit",
"since": "5501"
}
],
"vestItems": [
{
"cat": "General",
"desc": "Get array with all items from vest.",
"ex": "",
"exres": "",
"name": "vestitems",
"op": "vestitems",
"rname": "unit",
"since": "5501"
}
],
"vestMagazines": [
{
"cat": "General",
"desc": "Get array with all magazines from vest.",
"ex": "",
"exres": "",
"name": "vestmagazines",
"op": "vestmagazines",
"rname": "unit",
"since": "5501"
}
],
"visiblePosition": [
{
"cat": "General",
"desc": "Returns the object rendered position in format <ar>Position</ar>.",
"ex": "visiblePosition player",
"exres": "",
"name": "visibleposition",
"op": "visibleposition",
"rname": "object",
"since": "1.50"
}
],
"visiblePositionASL": [
{
"cat": "General",
"desc": "Returns the object rendered position in format <ar>PositionASL</ar>.",
"ex": "visiblePositionASL player",
"exres": "",
"name": "visiblepositionasl",
"op": "visiblepositionasl",
"rname": "object",
"since": "1.50"
}
],
"waitUntil": [
{
"cat": "Default",
"desc": "Suspend execution of script until condition is satisfied.",
"ex": "_i = 0; waitUntil {_i = _i + 1; _i >= 100}",
"exres": "",
"name": "waituntil",
"op": "waituntil",
"rname": "condition",
"since": "2.60"
}
],
"waypointAttachedObject": [
{
"cat": "General",
"desc": "Gets the object attached to the waypoint.",
"ex": "waypointAttachedObject [groupOne, 1]",
"exres": "",
"name": "waypointattachedobject",
"op": "waypointattachedobject",
"rname": "waypoint",
"since": "5500"
}
],
"waypointAttachedVehicle": [
{
"cat": "General",
"desc": "Gets the vehicle attached to the waypoint.",
"ex": "waypointAttachedVehicle [groupOne, 1]",
"exres": "",
"name": "waypointattachedvehicle",
"op": "waypointattachedvehicle",
"rname": "waypoint",
"since": "5500"
}
],
"waypointBehaviour": [
{
"cat": "General",
"desc": "Gets the waypoint behavior.",
"ex": "waypointBehaviour [groupOne, 1]",
"exres": "",
"name": "waypointbehaviour",
"op": "waypointbehaviour",
"rname": "waypoint",
"since": "5500"
}
],
"waypointCombatMode": [
{
"cat": "General",
"desc": "Gets the waypoint combat mode.",
"ex": "waypointCombatMode [groupOne, 1]",
"exres": "",
"name": "waypointcombatmode",
"op": "waypointcombatmode",
"rname": "waypoint",
"since": "5500"
}
],
"waypointCompletionRadius": [
{
"cat": "General",
"desc": "Gets the radius around the waypoint where is the waypoint completed.",
"ex": "_radius = waypointCompletionRadius [groupOne, 1]",
"exres": "",
"name": "waypointcompletionradius",
"op": "waypointcompletionradius",
"rname": "waypoint",
"since": "5500"
}
],
"waypointDescription": [
{
"cat": "General",
"desc": "Gets the waypoint description.",
"ex": "waypointDescription [groupOne, 1]",
"exres": "",
"name": "waypointdescription",
"op": "waypointdescription",
"rname": "waypoint",
"since": "5500"
}
],
"waypointForceBehaviour": [
{
"cat": "General",
"desc": "Returns true if the waypoint behavior is forced.",
"ex": "waypointForceBehaviour [groupOne, 1]",
"exres": "",
"name": "waypointforcebehaviour",
"op": "waypointforcebehaviour",
"rname": "waypoint",
"since": "5500"
}
],
"waypointFormation": [
{
"cat": "General",
"desc": "Gets the waypoint formation.",
"ex": "waypointFormation [groupOne, 1]",
"exres": "",
"name": "waypointformation",
"op": "waypointformation",
"rname": "waypoint",
"since": "5500"
}
],
"waypointHousePosition": [
{
"cat": "General",
"desc": "Gets the house position assigned to the waypoint.",
"ex": "waypointHousePosition [groupOne, 1]",
"exres": "",
"name": "waypointhouseposition",
"op": "waypointhouseposition",
"rname": "waypoint",
"since": "5500"
}
],
"waypointLoiterRadius": [
{
"cat": "General",
"desc": "Gets the waypoint loiter radius. Waypoint uses format <ar>Waypoint</ar>.\r\n",
"ex": "waypointLoiterRadius [groupOne, 1]",
"exres": "",
"name": "waypointloiterradius",
"op": "waypointloiterradius",
"rname": "waypoint",
"since": "1.50"
}
],
"waypointLoiterType": [
{
"cat": "General",
"desc": "Gets the waypoint loiter type. Waypoint uses format <ar>Waypoint</ar>.\r\n",
"ex": "waypointLoiterRadius [groupOne, 1]",
"exres": "",
"name": "waypointloitertype",
"op": "waypointloitertype",
"rname": "waypoint",
"since": "1.50"
}
],
"waypointName": [
{
"cat": "General",
"desc": "Gets the waypoint name.",
"ex": "waypointName [groupOne, 1]",
"exres": "",
"name": "waypointname",
"op": "waypointname",
"rname": "waypoint",
"since": "98979"
}
],
"waypointPosition": [
{
"cat": "General",
"desc": "Gets the waypoint position. Waypoint uses format <ar>Waypoint</ar>.\r\nNote: this function is identical to <f>getWaypointPosition</f>.",
"ex": "waypointPosition [groupOne, 1]",
"exres": "",
"name": "waypointposition",
"op": "waypointposition",
"rname": "waypoint",
"since": "1.50"
}
],
"waypointScript": [
{
"cat": "General",
"desc": "Gets the waypoint script.",
"ex": "waypointScript [groupOne, 1]",
"exres": "",
"name": "waypointscript",
"op": "waypointscript",
"rname": "waypoint",
"since": "5500"
}
],
"waypointShow": [
{
"cat": "General",
"desc": "Gets the waypoint show/hide status.",
"ex": "waypointShow [groupOne, 1]",
"exres": "",
"name": "waypointshow",
"op": "waypointshow",
"rname": "waypoint",
"since": "5500"
}
],
"waypointSpeed": [
{
"cat": "General",
"desc": "Gets the waypoint speed.",
"ex": "waypointSpeed [groupOne, 1]",
"exres": "",
"name": "waypointspeed",
"op": "waypointspeed",
"rname": "waypoint",
"since": "5500"
}
],
"waypointStatements": [
{
"cat": "General",
"desc": "Gets the waypoint statements.",
"ex": "waypointStatements [groupOne, 1]",
"exres": "",
"name": "waypointstatements",
"op": "waypointstatements",
"rname": "waypoint",
"since": "5500"
}
],
"waypointTimeout": [
{
"cat": "General",
"desc": "Gets the waypoint timeout values.",
"ex": "waypointTimeout [groupOne, 1]",
"exres": "",
"name": "waypointtimeout",
"op": "waypointtimeout",
"rname": "waypoint",
"since": "5500"
}
],
"waypointTimeoutCurrent": [
{
"cat": "General",
"desc": "Gets the current waypoint timeout or -1 if countdown is not in progress.",
"ex": "waypointTimeoutCurrent groupOne",
"exres": "",
"name": "waypointtimeoutcurrent",
"op": "waypointtimeoutcurrent",
"rname": "waypoint",
"since": "112547"
}
],
"waypointType": [
{
"cat": "General",
"desc": "Gets the waypoint type.",
"ex": "waypointType [groupOne, 1]",
"exres": "",
"name": "waypointtype",
"op": "waypointtype",
"rname": "waypoint",
"since": "5500"
}
],
"waypointVisible": [
{
"cat": "General",
"desc": "Gets waypoint visibility.",
"ex": "visible = waypointVisible [groupOne, 1]",
"exres": "",
"name": "waypointvisible",
"op": "waypointvisible",
"rname": "waypoint",
"since": "5500"
}
],
"waypoints": [
{
"cat": "General",
"desc": "Return the list of waypoints for given group.",
"ex": "",
"exres": "",
"name": "waypoints",
"op": "waypoints",
"rname": "group",
"since": "5129"
}
],
"waypointsEnabledUAV": [
{
"cat": "General",
"desc": "Returns if player can set waypoints for given UAV in AV terminal",
"ex": "waypointsEnabledUAV vehicle",
"exres": "",
"name": "waypointsenableduav",
"op": "waypointsenableduav",
"rname": "vehicle",
"since": "129341"
}
],
"weaponCargo": [
{
"cat": "General",
"desc": "Get array with weapons from ammo box (or any general weapon holder container). ",
"ex": "",
"exres": "",
"name": "weaponcargo",
"op": "weaponcargo",
"rname": "box",
"since": "5501"
}
],
"weaponInertia": [
{
"cat": "General",
"desc": "Returns current rate of how much the weapon view is distorted because of quick aiming",
"ex": "weaponInertia player",
"exres": "",
"name": "weaponinertia",
"op": "weaponinertia",
"rname": "soldier",
"since": ""
}
],
"weaponLowered": [
{
"cat": "General",
"desc": "True if given soldier's weapon is lowered.",
"ex": "weaponLowered player",
"exres": "",
"name": "weaponlowered",
"op": "weaponlowered",
"rname": "soldier",
"since": ""
}
],
"weaponState": [
{
"cat": "General",
"desc": "Returns the current weapon state as an array of strings in the follow format [WeaponName, MuzzleName, ModeName, MagazineName].",
"ex": "weaponState player or weaponState [vehicle player,[0]]",
"exres": "",
"name": "weaponstate",
"op": "weaponstate",
"rname": "Gunner or [veh,turret path]",
"since": "5790"
}
],
"weapons": [
{
"cat": "General",
"desc": "Returns an array of names of all the vehicle's weapons.",
"ex": "weapons player",
"exres": "",
"name": "weapons",
"op": "weapons",
"rname": "vehicle",
"since": "1.75"
}
],
"weaponsItems": [
{
"cat": "General",
"desc": "Returns an array with subarrays contains class names and also names of connected items of all the vehicle's weapons like [['arifle_MX_ACO_pointer_F','','acc_pointer_IR','optic_Aco',['30Rnd_65x39_caseless_mag',29]]]",
"ex": "weaponsItems player",
"exres": "",
"name": "weaponsitems",
"op": "weaponsitems",
"rname": "vehicle",
"since": "1.75"
}
],
"weaponsItemsCargo": [
{
"cat": "General",
"desc": "Returns an array with subarrays contains class names and also names of connected items of all the vehicle's cargo weapons like [['arifle_MX_ACO_pointer_F','','acc_pointer_IR','optic_Aco',['30Rnd_65x39_caseless_mag',29]]]",
"ex": "weaponsItemsCargo vehicle player",
"exres": "",
"name": "weaponsitemscargo",
"op": "weaponsitemscargo",
"rname": "vehicle",
"since": "1.75"
}
],
"weightRTD": [
{
"cat": "General",
"desc": "Returns weight of helicopter.",
"ex": " [fuselage weight, crew weight, fuel weight, custom weight, weapons weight]",
"exres": "",
"name": "weightrtd",
"op": "weightrtd",
"rname": "helicopter",
"since": "TOH 81393"
}
],
"while": [
{
"cat": "Default",
"desc": "The first part of the while contruct.",
"ex": "while \"x<10\" do {x=x+1}",
"exres": "",
"name": "while",
"op": "while",
"rname": "condition",
"since": "1.85"
}
],
"wingsForcesRTD": [
{
"cat": "General",
"desc": "Returns force produced by wings.",
"ex": "",
"exres": "",
"name": "wingsforcesrtd",
"op": "wingsforcesrtd",
"rname": "RTD_helicopter",
"since": "TOH 81393"
}
],
"with": [
{
"cat": "Default",
"desc": "The first part of the with contruct.",
"ex": "with missionNamespace do {global=global+1}",
"exres": "",
"name": "with",
"op": "with",
"rname": "namespace",
"since": "5501"
}
],
"worldToScreen": [
{
"cat": "General",
"desc": "Converts position in world space into screen (UI) space.",
"ex": "",
"exres": "",
"name": "worldtoscreen",
"op": "worldtoscreen",
"rname": "position",
"since": "5501"
}
]
},
"nulars": {
"HUDMovementLevels": {
"cat": "General",
"desc": "Returns movement borders for HUD [min speed, max speed, min alt, max alt, min dir, max dir, position[x,y,z] or target]",
"ex": "",
"exres": "",
"name": "hudmovementlevels",
"op": "hudmovementlevels",
"since": "83446 TOH"
},
"accTime": {
"cat": "General",
"desc": "Returns the current time acceleration factor.",
"ex": "",
"exres": "",
"name": "acctime",
"op": "acctime",
"since": ""
},
"activatedAddons": {
"cat": "General",
"desc": "",
"ex": "",
"exres": "",
"name": "activatedaddons",
"op": "activatedaddons",
"since": "5501"
},
"agents": {
"cat": "Agents",
"desc": "Return a list of agents in the current mission.",
"ex": "_agents = agents",
"exres": "",
"name": "agents",
"op": "agents",
"since": "2.92"
},
"airDensityCurveRTD": {
"cat": "General",
"desc": "Returns air density curve graph.",
"ex": "",
"exres": "",
"name": "airdensitycurvertd",
"op": "airdensitycurvertd",
"since": "TOH 81393"
},
"all3DENEntities": {
"cat": "General",
"desc": "Returns array with all registered entities in format: [<objects>,<groups>,<triggers>,<logics>,<waypoints>,<markers>]",
"ex": "",
"exres": "",
"name": "all3denentities",
"op": "all3denentities",
"since": ""
},
"allCurators": {
"cat": "General",
"desc": "Returns list of all curators.",
"ex": "",
"exres": "",
"name": "allcurators",
"op": "allcurators",
"since": ""
},
"allCutLayers": {
"cat": "General",
"desc": "Returns a list of all layer names currently used by cutXXXX commands.",
"ex": "",
"exres": "",
"name": "allcutlayers",
"op": "allcutlayers",
"since": ""
},
"allDead": {
"cat": "General",
"desc": "Return a list of dead units and destroyed vehicles. Dead unit might be inside vehicle.,",
"ex": "",
"exres": "",
"name": "alldead",
"op": "alldead",
"since": "5501"
},
"allDeadMen": {
"cat": "General",
"desc": "Return a list of dead units. Dead unit might be inside vehicle.,",
"ex": "",
"exres": "",
"name": "alldeadmen",
"op": "alldeadmen",
"since": "5501"
},
"allDisplays": {
"cat": "General",
"desc": "Returns list of all displays registered in engine.",
"ex": "",
"exres": "",
"name": "alldisplays",
"op": "alldisplays",
"since": ""
},
"allGroups": {
"cat": "General",
"desc": "Return a list of all groups.",
"ex": "",
"exres": "",
"name": "allgroups",
"op": "allgroups",
"since": "5501"
},
"allMapMarkers": {
"cat": "General",
"desc": "Return all markers in map.",
"ex": "",
"exres": "",
"name": "allmapmarkers",
"op": "allmapmarkers",
"since": "97274 A3"
},
"allMines": {
"cat": "General",
"desc": "Returns an array of all mines in game.",
"ex": "allMines",
"exres": "[listOfAllMines]",
"name": "allmines",
"op": "allmines",
"since": ""
},
"allPlayers": {
"cat": "General",
"desc": "Return a list of all players.",
"ex": "",
"exres": "",
"name": "allplayers",
"op": "allplayers",
"since": "5501"
},
"allSites": {
"cat": "General",
"desc": "Return a list of all sites.",
"ex": "",
"exres": "",
"name": "allsites",
"op": "allsites",
"since": "5501"
},
"allUnits": {
"cat": "General",
"desc": "Return a list of all units (all persons except agents).",
"ex": "",
"exres": "",
"name": "allunits",
"op": "allunits",
"since": "5501"
},
"allUnitsUAV": {
"cat": "General",
"desc": "Return a list of all UAV units.",
"ex": "",
"exres": "",
"name": "allunitsuav",
"op": "allunitsuav",
"since": "106264"
},
"armoryPoints": {
"cat": "General",
"desc": "Return the stored value of armory points.",
"ex": "",
"exres": "",
"name": "armorypoints",
"op": "armorypoints",
"since": "5500"
},
"benchmark": {
"cat": "General",
"desc": "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.",
"ex": "? benchmark>2000 : setviewdistance 2000",
"exres": "",
"name": "benchmark",
"op": "benchmark",
"since": ""
},
"blufor": {
"cat": "General",
"desc": "Pre-defined variable for the blufor side.",
"ex": "",
"exres": "",
"name": "blufor",
"op": "blufor",
"since": ""
},
"briefingName": {
"cat": "General",
"desc": "Returns the name of the current briefing.",
"ex": "",
"exres": "",
"name": "briefingname",
"op": "briefingname",
"since": ""
},
"buldozer_IsEnabledRoadDiag": {
"cat": "General",
"desc": "Is enabled road diag in buldozer?",
"ex": "true/false",
"exres": "",
"name": "buldozer_isenabledroaddiag",
"op": "buldozer_isenabledroaddiag",
"since": ""
},
"buldozer_reloadOperMap": {
"cat": "General",
"desc": "Reload oper map visible in costMap diag tool.",
"ex": "",
"exres": "",
"name": "buldozer_reloadopermap",
"op": "buldozer_reloadopermap",
"since": "98474 A3"
},
"cadetMode": {
"cat": "General",
"desc": "Returns true if the mission is played in cadet mode and false in veteran mode.",
"ex": "",
"exres": "",
"name": "cadetmode",
"op": "cadetmode",
"since": ""
},
"cameraOn": {
"cat": "General",
"desc": "Returns the vehicle to which the camera is attached.",
"ex": "",
"exres": "",
"name": "cameraon",
"op": "cameraon",
"since": "1.56"
},
"cameraView": {
"cat": "General",
"desc": "Return type of camera.",
"ex": "",
"exres": "",
"name": "cameraview",
"op": "cameraview",
"since": "5501"
},
"campaignConfigFile": {
"cat": "General",
"desc": "Return root of campaign description.ext entries hierarchy.",
"ex": "",
"exres": "",
"name": "campaignconfigfile",
"op": "campaignconfigfile",
"since": "2.90"
},
"canSuspend": {
"cat": "General",
"desc": "Returns true if usage of sleep, uiSleep or waitUntil commands is allowed in the current scope.",
"ex": "if (!canSuspend) exitWith { false };",
"exres": "",
"name": "cansuspend",
"op": "cansuspend",
"since": ""
},
"cheatsEnabled": {
"cat": "General",
"desc": "Checks whether cheats are enabled (whether the designers' version is running).",
"ex": "",
"exres": "",
"name": "cheatsenabled",
"op": "cheatsenabled",
"since": "1.56"
},
"civilian": {
"cat": "General",
"desc": "The Civilian side.",
"ex": "",
"exres": "",
"name": "civilian",
"op": "civilian",
"since": ""
},
"clearForcesRTD": {
"cat": "General",
"desc": "Remove all force generators from wolrd.",
"ex": "",
"exres": "",
"name": "clearforcesrtd",
"op": "clearforcesrtd",
"since": "TOH 81393"
},
"clearItemPool": {
"cat": "General",
"desc": "Removes all magazines from the weapon pool (this is used in campaigns to transfer weapons to the next mission).",
"ex": "",
"exres": "",
"name": "clearitempool",
"op": "clearitempool",
"since": "1.75"
},
"clearMagazinePool": {
"cat": "General",
"desc": "Removes all magazines from the weapon pool (this is used in campaigns to transfer weapons to the next mission).",
"ex": "",
"exres": "",
"name": "clearmagazinepool",
"op": "clearmagazinepool",
"since": "1.75"
},
"clearRadio": {
"cat": "General",
"desc": "Clean up the content of radio protocol history.",
"ex": "",
"exres": "",
"name": "clearradio",
"op": "clearradio",
"since": "2.73"
},
"clearWeaponPool": {
"cat": "General",
"desc": "Removes all weapons from the weapon pool (this is used in campaigns to transfer weapons to the next mission).",
"ex": "",
"exres": "",
"name": "clearweaponpool",
"op": "clearweaponpool",
"since": "1.75"
},
"clientOwner": {
"cat": "General",
"desc": "Returns client's owner id",
"ex": "",
"exres": "",
"name": "clientowner",
"op": "clientowner",
"since": ""
},
"commandingMenu": {
"cat": "General",
"desc": "Return the name of the topmost commanding menu.",
"ex": "",
"exres": "",
"name": "commandingmenu",
"op": "commandingmenu",
"since": "5501"
},
"configFile": {
"cat": "General",
"desc": "Return root of config entries hierarchy.",
"ex": "",
"exres": "",
"name": "configfile",
"op": "configfile",
"since": "2.35"
},
"configNull": {
"cat": "General",
"desc": "A non-existing config",
"ex": "",
"exres": "",
"name": "confignull",
"op": "confignull",
"since": ""
},
"controlNull": {
"cat": "General",
"desc": "A non-existing control. This value is not equal to anything, including itself.",
"ex": "",
"exres": "",
"name": "controlnull",
"op": "controlnull",
"since": "2.92"
},
"copyFromClipboard": {
"cat": "General",
"desc": "Return the content of the (text) clipboard.",
"ex": "",
"exres": "",
"name": "copyfromclipboard",
"op": "copyfromclipboard",
"since": "5500"
},
"curatorCamera": {
"cat": "General",
"desc": "Returns curator camera object.",
"ex": "",
"exres": "",
"name": "curatorcamera",
"op": "curatorcamera",
"since": ""
},
"curatorMouseOver": {
"cat": "General",
"desc": "Returns curator mouse over object.",
"ex": "",
"exres": "",
"name": "curatormouseover",
"op": "curatormouseover",
"since": ""
},
"curatorSelected": {
"cat": "General",
"desc": "Returns list of all curator selected items.",
"ex": "",
"exres": "",
"name": "curatorselected",
"op": "curatorselected",
"since": ""
},
"current3DENOperation": {
"cat": "General",
"desc": "Name of the operation in progress.",
"ex": "",
"exres": "",
"name": "current3denoperation",
"op": "current3denoperation",
"since": ""
},
"currentChannel": {
"cat": "General",
"desc": "Return index of player's currently selected chat channel.",
"ex": "",
"exres": "",
"name": "currentchannel",
"op": "currentchannel",
"since": ""
},
"currentNamespace": {
"cat": "General",
"desc": "Return the current namespace code runs in",
"ex": "",
"exres": "",
"name": "currentnamespace",
"op": "currentnamespace",
"since": "5501"
},
"cursorObject": {
"cat": "General",
"desc": "This is the object pointed to by a players cursor.",
"ex": "alive cursorObject",
"exres": "",
"name": "cursorobject",
"op": "cursorobject",
"since": ""
},
"cursorTarget": {
"cat": "General",
"desc": "This is the entity pointed to by a players cursor.",
"ex": "alive cursorTarget",
"exres": "",
"name": "cursortarget",
"op": "cursortarget",
"since": "5500"
},
"date": {
"cat": "General",
"desc": "Return the actual mission date and time as an array [year, month, day, hour, minute].",
"ex": "",
"exres": "",
"name": "date",
"op": "date",
"since": "2.92"
},
"dayTime": {
"cat": "General",
"desc": "Returns the time in the world, in hours.",
"ex": "",
"exres": "",
"name": "daytime",
"op": "daytime",
"since": ""
},
"diag_activeMissionFSMs": {
"cat": "General",
"desc": "Returns array with active Mission FSMs [[name, state, timeout],[name, state, timeout],...]",
"ex": "",
"exres": "",
"name": "diag_activemissionfsms",
"op": "diag_activemissionfsms",
"since": "5501"
},
"diag_activeSQFScripts": {
"cat": "General",
"desc": "Returns array with active SQFs [[name, fileName, isRunning, currentLine],[name, fileName, isRunning, currentLine],...]",
"ex": "",
"exres": "",
"name": "diag_activesqfscripts",
"op": "diag_activesqfscripts",
"since": "5501"
},
"diag_activeSQSScripts": {
"cat": "General",
"desc": "Returns array with active SQSs [[name, fileName, isRunning, currentLine],[name, fileName, isRunning, currentLine],...]",
"ex": "",
"exres": "",
"name": "diag_activesqsscripts",
"op": "diag_activesqsscripts",
"since": "5501"
},
"diag_activeScripts": {
"cat": "General",
"desc": "Returns an array with active scripts count [spawned SQFs, execVMed SQFs, FSMs, SQSes]",
"ex": "",
"exres": "",
"name": "diag_activescripts",
"op": "diag_activescripts",
"since": "5501"
},
"diag_fps": {
"cat": "General",
"desc": "Returns average framerate over last 16 frames.",
"ex": "",
"exres": "",
"name": "diag_fps",
"op": "diag_fps",
"since": "5500"
},
"diag_fpsmin": {
"cat": "General",
"desc": "Returns minimal framerate. Calculated from the longest frame over last 16 frames.",
"ex": "",
"exres": "",
"name": "diag_fpsmin",
"op": "diag_fpsmin",
"since": "5500"
},
"diag_frameno": {
"cat": "General",
"desc": "Returns number of frame currently displayed .",
"ex": "",
"exres": "",
"name": "diag_frameno",
"op": "diag_frameno",
"since": "5500"
},
"diag_tickTime": {
"cat": "General",
"desc": "Real time spent from the start of the game.",
"ex": "",
"exres": "",
"name": "diag_ticktime",
"op": "diag_ticktime",
"since": "5501"
},
"dialog": {
"cat": "General",
"desc": "Returns whether a user dialog is present.",
"ex": "",
"exres": "",
"name": "dialog",
"op": "dialog",
"since": "1.78"
},
"didJip": {
"cat": "General",
"desc": "Returns true if the local client joined the game in progress. Returns false in single player.",
"ex": "",
"exres": "",
"name": "didjip",
"op": "didjip",
"since": ""
},
"difficulty": {
"cat": "General",
"desc": "Return difficulty.",
"ex": "difficulty",
"exres": "",
"name": "difficulty",
"op": "difficulty",
"since": ""
},
"difficultyEnabledRTD": {
"cat": "General",
"desc": "Returns true if rotorlib simulation is enabled. Forcing by mission is included.",
"ex": "",
"exres": "",
"name": "difficultyenabledrtd",
"op": "difficultyenabledrtd",
"since": ""
},
"disableDebriefingStats": {
"cat": "General",
"desc": "Disable debriefing score table.",
"ex": "disableDebriefingStats",
"exres": "",
"name": "disabledebriefingstats",
"op": "disabledebriefingstats",
"since": ""
},
"disableSerialization": {
"cat": "Default",
"desc": "Disable saving of script containing this command. After this, script can work with the data types which do not support serialization (UI types).",
"ex": "",
"exres": "",
"name": "disableserialization",
"op": "disableserialization",
"since": "5501"
},
"displayNull": {
"cat": "General",
"desc": "A non-existing display. This value is not equal to anything, including itself.",
"ex": "",
"exres": "",
"name": "displaynull",
"op": "displaynull",
"since": "2.92"
},
"distributionRegion": {
"cat": "General",
"desc": "Return the region where the game was sold (based on distribution id).",
"ex": "",
"exres": "",
"name": "distributionregion",
"op": "distributionregion",
"since": "5129"
},
"dynamicSimulationSystemEnabled": {
"cat": "General",
"desc": "Returns if dynamic simulation system is enabled or not.",
"ex": "dynamicSimulationEnabled",
"exres": "",
"name": "dynamicsimulationsystemenabled",
"op": "dynamicsimulationsystemenabled",
"since": ""
},
"east": {
"cat": "General",
"desc": "The East side.",
"ex": "",
"exres": "",
"name": "east",
"op": "east",
"since": ""
},
"enableEndDialog": {
"cat": "General",
"desc": "Enables the dialog buttons to be shown during the OnPlayerKilled script.",
"ex": "",
"exres": "",
"name": "enableenddialog",
"op": "enableenddialog",
"since": ""
},
"endLoadingScreen": {
"cat": "General",
"desc": "Finish loading screen displaying (started by startLoadingScreen).",
"ex": "",
"exres": "",
"name": "endloadingscreen",
"op": "endloadingscreen",
"since": "5501"
},
"environmentEnabled": {
"cat": "General",
"desc": "[agents,environment]",
"ex": "Get array of ambient life & environment sounds state.",
"exres": "",
"name": "environmentenabled",
"op": "environmentenabled",
"since": ""
},
"estimatedEndServerTime": {
"cat": "General",
"desc": "Estimated end of MP game converted to serverTime.",
"ex": "",
"exres": "",
"name": "estimatedendservertime",
"op": "estimatedendservertime",
"since": "5501"
},
"exit": {
"cat": "General",
"desc": "Exits the script.",
"ex": "",
"exres": "",
"name": "exit",
"op": "exit",
"since": ""
},
"false": {
"cat": "Default",
"desc": "Always false.",
"ex": "",
"exres": "",
"name": "false",
"op": "false",
"since": ""
},
"finishMissionInit": {
"cat": "General",
"desc": "Finish world initialization before mission is launched.",
"ex": "",
"exres": "",
"name": "finishmissioninit",
"op": "finishmissioninit",
"since": "2.33"
},
"fog": {
"cat": "General",
"desc": "Return the current fog.",
"ex": "",
"exres": "",
"name": "fog",
"op": "fog",
"since": "2.92"
},
"fogForecast": {
"cat": "General",
"desc": "Return the fog forecast.",
"ex": "",
"exres": "",
"name": "fogforecast",
"op": "fogforecast",
"since": "2.92"
},
"fogParams": {
"cat": "General",
"desc": "Returns actual params for fog.",
"ex": "",
"exres": "",
"name": "fogparams",
"op": "fogparams",
"since": ""
},
"forceEnd": {
"cat": "General",
"desc": "Forces the mission to terminate.",
"ex": "",
"exres": "",
"name": "forceend",
"op": "forceend",
"since": ""
},
"forceWeatherChange": {
"cat": "General",
"desc": "Forces saved wanted settings for weather to be actual. (BEWARE: Will cause lag)",
"ex": "",
"exres": "",
"name": "forceweatherchange",
"op": "forceweatherchange",
"since": "5501"
},
"forcedMap": {
"cat": "General",
"desc": "Returns if map is forced in an array [forceMapForced, openMapForced]",
"ex": "isForcedMap = forcedMap",
"exres": "",
"name": "forcedmap",
"op": "forcedmap",
"since": "1.62"
},
"freeLook": {
"cat": "General",
"desc": "Returns true if freelook is active.",
"ex": "",
"exres": "",
"name": "freelook",
"op": "freelook",
"since": "84446 TOH"
},
"get3DENCamera": {
"cat": "General",
"desc": "Get 3den's camera object",
"ex": "",
"exres": "",
"name": "get3dencamera",
"op": "get3dencamera",
"since": ""
},
"get3DENIconsVisible": {
"cat": "General",
"desc": "Returns icons visibility in 3DEN",
"ex": "",
"exres": "",
"name": "get3deniconsvisible",
"op": "get3deniconsvisible",
"since": ""
},
"get3DENLinesVisible": {
"cat": "General",
"desc": "Returns lines visibility in 3DEN",
"ex": "",
"exres": "",
"name": "get3denlinesvisible",
"op": "get3denlinesvisible",
"since": ""
},
"get3DENMouseOver": {
"cat": "General",
"desc": "Get what is under mouse in 3den",
"ex": "",
"exres": "",
"name": "get3denmouseover",
"op": "get3denmouseover",
"since": ""
},
"getArtilleryComputerSettings": {
"cat": "General",
"desc": "Returns settings from artillery computer currently opened by player.",
"ex": "",
"exres": "",
"name": "getartillerycomputersettings",
"op": "getartillerycomputersettings",
"since": "5501"
},
"getClientState": {
"cat": "General",
"desc": "Return client state in network game",
"ex": "",
"exres": "",
"name": "getclientstate",
"op": "getclientstate",
"since": "112583"
},
"getClientStateNumber": {
"cat": "General",
"desc": "Return client state in network game",
"ex": "",
"exres": "",
"name": "getclientstatenumber",
"op": "getclientstatenumber",
"since": ""
},
"getDLCAssetsUsage": {
"cat": "General",
"desc": "Returns an array of the DLC usage times. Returned array contain DLC item in this format: [[name, dlcAppId, sessionTime, totalTime], [name, dlcAppId, sessionTime, totalTime], ...]",
"ex": "",
"exres": "",
"name": "getdlcassetsusage",
"op": "getdlcassetsusage",
"since": ""
},
"getElevationOffset": {
"cat": "General",
"desc": "Returns the map elevation offset from [map]/config.cpp",
"ex": "",
"exres": "",
"name": "getelevationoffset",
"op": "getelevationoffset",
"since": ""
},
"getMissionDLCs": {
"cat": "General",
"desc": "Returns list of DLCs that are used in the mission. List is created only from units listed in mission.sqm and doesn't detect units created by scripts!",
"ex": "list of DLCs detected for the mission",
"exres": "",
"name": "getmissiondlcs",
"op": "getmissiondlcs",
"since": ""
},
"getMissionLayers": {
"cat": "General",
"desc": "Name of the operation in progress.",
"ex": "",
"exres": "",
"name": "getmissionlayers",
"op": "getmissionlayers",
"since": ""
},
"getMousePosition": {
"cat": "General",
"desc": "Returns Position of the mouse on the screen in UI coordinates.",
"ex": "",
"exres": "",
"name": "getmouseposition",
"op": "getmouseposition",
"since": ""
},
"getObjectViewDistance": {
"cat": "General",
"desc": "Returns object and shadow view distance.",
"ex": "",
"exres": "",
"name": "getobjectviewdistance",
"op": "getobjectviewdistance",
"since": "5501"
},
"getRemoteSensorsDisabled": {
"cat": "General",
"desc": "Returns true if sensors are computing visibility only for groups that have at least one local unit.",
"ex": "",
"exres": "",
"name": "getremotesensorsdisabled",
"op": "getremotesensorsdisabled",
"since": ""
},
"getResolution": {
"cat": "General",
"desc": "returns [width, height, 2D viewport Width, 2D viewport Height, aspect ration, UI scale]",
"ex": "",
"exres": "",
"name": "getresolution",
"op": "getresolution",
"since": "5501"
},
"getShadowDistance": {
"cat": "General",
"desc": "Get the shadows rendering distance.",
"ex": "_dist = getShadowDistance",
"exres": "",
"name": "getshadowdistance",
"op": "getshadowdistance",
"since": "TOH 80934"
},
"getTerrainGrid": {
"cat": "General",
"desc": "Returns the current size of the terrain grid.",
"ex": "gridSize = getTerrainGrid;",
"exres": "",
"name": "getterraingrid",
"op": "getterraingrid",
"since": ""
},
"getTotalDLCUsageTime": {
"cat": "General",
"desc": "Returns total DLC usage time in this game session",
"ex": "",
"exres": "",
"name": "gettotaldlcusagetime",
"op": "gettotaldlcusagetime",
"since": ""
},
"groupIconSelectable": {
"cat": "General",
"desc": "Return if groups icon raises onClick and onOver events.",
"ex": "",
"exres": "",
"name": "groupiconselectable",
"op": "groupiconselectable",
"since": "5501"
},
"groupIconsVisible": {
"cat": "General",
"desc": "Return group icons are visible.",
"ex": "",
"exres": "",
"name": "groupiconsvisible",
"op": "groupiconsvisible",
"since": "5501"
},
"grpNull": {
"cat": "General",
"desc": "A non-existing group. This value is not equal to anything, including itself.",
"ex": "group player == objNull",
"exres": "false",
"name": "grpnull",
"op": "grpnull",
"since": ""
},
"gusts": {
"cat": "General",
"desc": "Return the current gusts value.",
"ex": "",
"exres": "",
"name": "gusts",
"op": "gusts",
"since": "2.92"
},
"halt": {
"cat": "Default",
"desc": "Stops the program into a debugger.",
"ex": "halt",
"exres": "",
"name": "halt",
"op": "halt",
"since": "2.00"
},
"hasInterface": {
"cat": "General",
"desc": "Returns true if the computer has an inteface (a real player). False for a dedicated server or for a headless client.",
"ex": "",
"exres": "",
"name": "hasinterface",
"op": "hasinterface",
"since": "101030"
},
"hcShownBar": {
"cat": "General",
"desc": "Return true if the HC bar is shown/active.",
"ex": "",
"exres": "",
"name": "hcshownbar",
"op": "hcshownbar",
"since": "5501"
},
"humidity": {
"cat": "General",
"desc": "Return the current humidity value.",
"ex": "",
"exres": "",
"name": "humidity",
"op": "humidity",
"since": "2.92"
},
"independent": {
"cat": "General",
"desc": "Pre-defined variable for the independent side.",
"ex": "",
"exres": "",
"name": "independent",
"op": "independent",
"since": ""
},
"initAmbientLife": {
"cat": "General",
"desc": "Initialize the ambient life.",
"ex": "",
"exres": "",
"name": "initambientlife",
"op": "initambientlife",
"since": "2.90"
},
"is3DEN": {
"cat": "General",
"desc": "Returns true while in 3DEN",
"ex": "",
"exres": "",
"name": "is3den",
"op": "is3den",
"since": ""
},
"is3DENMultiplayer": {
"cat": "General",
"desc": "Returns true if 3DEN is running in MP mode",
"ex": "",
"exres": "",
"name": "is3denmultiplayer",
"op": "is3denmultiplayer",
"since": ""
},
"isAutotest": {
"cat": "General",
"desc": "Returns true if game was started with autotest parameter",
"ex": "isAutotest",
"exres": "",
"name": "isautotest",
"op": "isautotest",
"since": "125531"
},
"isDedicated": {
"cat": "General",
"desc": "Return true for dedicated server.",
"ex": "",
"exres": "",
"name": "isdedicated",
"op": "isdedicated",
"since": "5501"
},
"isFilePatchingEnabled": {
"cat": "General",
"desc": "Returns true if file patching is enabled on the machine. Returns false otherwise",
"ex": "",
"exres": "",
"name": "isfilepatchingenabled",
"op": "isfilepatchingenabled",
"since": ""
},
"isInstructorFigureEnabled": {
"cat": "General",
"desc": "True if instructor figure is enabled in Game Options.",
"ex": "isInstructorFigureEnabled",
"exres": "true or false",
"name": "isinstructorfigureenabled",
"op": "isinstructorfigureenabled",
"since": ""
},
"isMultiplayer": {
"cat": "General",
"desc": "Return true if multiPlayer.",
"ex": "",
"exres": "",
"name": "ismultiplayer",
"op": "ismultiplayer",
"since": "5501"
},
"isMultiplayerSolo": {
"cat": "General",
"desc": "Returns true when playing the game in solo multiplayer.",
"ex": "_return = isMultiplayerSolo",
"exres": "",
"name": "ismultiplayersolo",
"op": "ismultiplayersolo",
"since": "1.64"
},
"isPipEnabled": {
"cat": "General",
"desc": "Returns true if PiP is enabled.",
"ex": "",
"exres": "",
"name": "ispipenabled",
"op": "ispipenabled",
"since": "85325 TOH"
},
"isRemoteExecuted": {
"cat": "General",
"desc": "Returns true if code was remotely executed via remoteExec.",
"ex": "_remoteExecuted = isRemoteExecuted;",
"exres": "",
"name": "isremoteexecuted",
"op": "isremoteexecuted",
"since": ""
},
"isRemoteExecutedJIP": {
"cat": "General",
"desc": "Returns true if JIP code was remotely executed via remoteExec.",
"ex": "_remoteExecutedJIP = isRemoteExecutedJIP;",
"exres": "",
"name": "isremoteexecutedjip",
"op": "isremoteexecutedjip",
"since": ""
},
"isServer": {
"cat": "General",
"desc": "Returns true if the computer is the server.",
"ex": "",
"exres": "",
"name": "isserver",
"op": "isserver",
"since": "2.92"
},
"isSteamMission": {
"cat": "General",
"desc": "Returns true if mission is started from the steam.",
"ex": "",
"exres": "",
"name": "issteammission",
"op": "issteammission",
"since": ""
},
"isStreamFriendlyUIEnabled": {
"cat": "General",
"desc": "True if stream friendly UI is enabled in Game Options.",
"ex": "isStreamFriendlyUIEnabled",
"exres": "true or false",
"name": "isstreamfriendlyuienabled",
"op": "isstreamfriendlyuienabled",
"since": ""
},
"isStressDamageEnabled": {
"cat": "General",
"desc": "Returns true if stress damage is enabled.",
"ex": "",
"exres": "",
"name": "isstressdamageenabled",
"op": "isstressdamageenabled",
"since": "TOH 83393"
},
"isTutHintsEnabled": {
"cat": "General",
"desc": "True if tutorial hints are enabled in Game Options.",
"ex": "isTutHintsEnabled",
"exres": "true or false",
"name": "istuthintsenabled",
"op": "istuthintsenabled",
"since": ""
},
"language": {
"cat": "General",
"desc": "Returns current game language.",
"ex": "",
"exres": "",
"name": "language",
"op": "language",
"since": "87005 TOH"
},
"libraryCredits": {
"cat": "General",
"desc": "Copyright information needed by libraries used.",
"ex": "libraryCredits",
"exres": "[['Real Virtuality','(C) 2012 Bohemia Interactive','All rights reserved']]",
"name": "librarycredits",
"op": "librarycredits",
"since": "94439"
},
"libraryDisclaimers": {
"cat": "General",
"desc": "Disclaimer information needed by libraries used (duplicate disclaimers are removed).",
"ex": "libraryDisclaimers",
"exres": "['All rights reserved']",
"name": "librarydisclaimers",
"op": "librarydisclaimers",
"since": "94439"
},
"lightnings": {
"cat": "General",
"desc": "Return lightnings value.",
"ex": "",
"exres": "",
"name": "lightnings",
"op": "lightnings",
"since": "2.92"
},
"lineBreak": {
"cat": "General",
"desc": "Creates a structured text containing a line break.",
"ex": "txt3 = lineBreak",
"exres": "",
"name": "linebreak",
"op": "linebreak",
"since": "2.01"
},
"loadGame": {
"cat": "General",
"desc": "Load a game from the autosave, if failed, restart the mission.",
"ex": "",
"exres": "",
"name": "loadgame",
"op": "loadgame",
"since": "5501"
},
"locationNull": {
"cat": "Location",
"desc": "A non-existing location. This value is not equal to anything, including itself.",
"ex": "",
"exres": "",
"name": "locationnull",
"op": "locationnull",
"since": "5501"
},
"logEntities": {
"cat": "General",
"desc": "Creates a log file containing a list of all game entites in scene.,",
"ex": "",
"exres": "",
"name": "logentities",
"op": "logentities",
"since": "5501"
},
"mapAnimClear": {
"cat": "General",
"desc": "Clears the map animation.",
"ex": "",
"exres": "",
"name": "mapanimclear",
"op": "mapanimclear",
"since": "1.27"
},
"mapAnimCommit": {
"cat": "General",
"desc": "Plays the map animation.",
"ex": "",
"exres": "",
"name": "mapanimcommit",
"op": "mapanimcommit",
"since": "1.27"
},
"mapAnimDone": {
"cat": "General",
"desc": "Checks whether the map animation has finished.",
"ex": "",
"exres": "",
"name": "mapanimdone",
"op": "mapanimdone",
"since": "1.27"
},
"markAsFinishedOnSteam": {
"cat": "General",
"desc": "Marks current mission and finished on steam. Returns true is Steam query is successfully started or false otherwise.",
"ex": "",
"exres": "",
"name": "markasfinishedonsteam",
"op": "markasfinishedonsteam",
"since": ""
},
"missionConfigFile": {
"cat": "General",
"desc": "Return root of mission description.ext entries hierarchy.",
"ex": "",
"exres": "",
"name": "missionconfigfile",
"op": "missionconfigfile",
"since": "2.90"
},
"missionDifficulty": {
"cat": "General",
"desc": "Return difficulty that has been forced for this mission, returns -1 if difficulty is not forced and it's used one from player's options.",
"ex": "difficulty",
"exres": "",
"name": "missiondifficulty",
"op": "missiondifficulty",
"since": ""
},
"missionName": {
"cat": "General",
"desc": "Returns the name of the current mission.",
"ex": "",
"exres": "",
"name": "missionname",
"op": "missionname",
"since": "1.80"
},
"missionNamespace": {
"cat": "General",
"desc": "Return the global namespace attached to mission.",
"ex": "",
"exres": "",
"name": "missionnamespace",
"op": "missionnamespace",
"since": "5501"
},
"missionStart": {
"cat": "General",
"desc": "Returns the time of the mission start in format [year, month, day, hour, minute, second].",
"ex": "",
"exres": "",
"name": "missionstart",
"op": "missionstart",
"since": "1.80"
},
"missionVersion": {
"cat": "General",
"desc": "Returns the version of the current mission.",
"ex": "",
"exres": "",
"name": "missionversion",
"op": "missionversion",
"since": ""
},
"moonIntensity": {
"cat": "General",
"desc": "Returns moon light intensity.",
"ex": "",
"exres": "",
"name": "moonintensity",
"op": "moonintensity",
"since": "93989"
},
"musicVolume": {
"cat": "General",
"desc": "Checks the current music volume (set by <f>fadeMusic</f>).",
"ex": "",
"exres": "",
"name": "musicvolume",
"op": "musicvolume",
"since": ""
},
"netObjNull": {
"cat": "General",
"desc": "A non-existing object. This value is not equal to anything, including itself.",
"ex": "myNetObject == objNetNull",
"exres": "false",
"name": "netobjnull",
"op": "netobjnull",
"since": "69527"
},
"nextWeatherChange": {
"cat": "General",
"desc": "Return the time (in seconds) when the next weather change will occur.",
"ex": "",
"exres": "",
"name": "nextweatherchange",
"op": "nextweatherchange",
"since": "2.92"
},
"nil": {
"cat": "Default",
"desc": "Nil value. This value can be used to undefine an existing variable.",
"ex": "variableToDestroy = nil",
"exres": "",
"name": "nil",
"op": "nil",
"since": ""
},
"objNull": {
"cat": "General",
"desc": "A non-existing object. This value is not equal to anything, including itself.",
"ex": "player == objNull",
"exres": "false",
"name": "objnull",
"op": "objnull",
"since": ""
},
"openCuratorInterface": {
"cat": "General",
"desc": "Force opens curator interface.",
"ex": "",
"exres": "",
"name": "opencuratorinterface",
"op": "opencuratorinterface",
"since": ""
},
"opfor": {
"cat": "General",
"desc": "Pre-defined variable for the opfor side.",
"ex": "",
"exres": "",
"name": "opfor",
"op": "opfor",
"since": ""
},
"overcast": {
"cat": "General",
"desc": "Return the current overcast.",
"ex": "",
"exres": "",
"name": "overcast",
"op": "overcast",
"since": "2.92"
},
"overcastForecast": {
"cat": "General",
"desc": "Return the overcast forecast.",
"ex": "",
"exres": "",
"name": "overcastforecast",
"op": "overcastforecast",
"since": "2.92"
},
"parsingNamespace": {
"cat": "General",
"desc": "Return the global namespace attached to config parser.",
"ex": "",
"exres": "",
"name": "parsingnamespace",
"op": "parsingnamespace",
"since": "5501"
},
"particlesQuality": {
"cat": "General",
"desc": "Return current settings for particles quality.",
"ex": "",
"exres": "",
"name": "particlesquality",
"op": "particlesquality",
"since": "5501"
},
"pi": {
"cat": "Default",
"desc": "pi (180 degrees converted to radians)",
"ex": "pi",
"exres": "3.1415",
"name": "pi",
"op": "pi",
"since": ""
},
"pixelGrid": {
"cat": "General",
"desc": "returns grid size based on screen resolution, UI size and configs: uiScaleFactor, uiScaleMaxGrids",
"ex": "gridHeight = pixelH * pixelGrid",
"exres": "",
"name": "pixelgrid",
"op": "pixelgrid",
"since": "1.60"
},
"pixelGridBase": {
"cat": "General",
"desc": "Returns grid size based on screen resolution.",
"ex": "gridBaseHeight = pixelH * pixelGridBase",
"exres": "",
"name": "pixelgridbase",
"op": "pixelgridbase",
"since": "1.62"
},
"pixelGridNoUIScale": {
"cat": "General",
"desc": "returns grid size based on screen resolution and configs: uiScaleFactor, uiScaleMaxGrids",
"ex": "gridHeightNoUIScale = pixelH * pixelGridNoUIScale",
"exres": "",
"name": "pixelgridnouiscale",
"op": "pixelgridnouiscale",
"since": "1.62"
},
"pixelH": {
"cat": "General",
"desc": "returns height of one pixel for current resolution",
"ex": "_pixelHeight = pixelH",
"exres": "",
"name": "pixelh",
"op": "pixelh",
"since": "1.60"
},
"pixelW": {
"cat": "General",
"desc": "returns width of one pixel for current resolution",
"ex": "_pixelWidth = pixelW",
"exres": "",
"name": "pixelw",
"op": "pixelw",
"since": "1.60"
},
"playableUnits": {
"cat": "General",
"desc": "Return a list of playable units (occupied by both AI or players).",
"ex": "",
"exres": "",
"name": "playableunits",
"op": "playableunits",
"since": "5501"
},
"player": {
"cat": "General",
"desc": "This is the person controlled by the player. In MP this value is different on each computer.",
"ex": "alive player",
"exres": "",
"name": "player",
"op": "player",
"since": ""
},
"playerRespawnTime": {
"cat": "General",
"desc": "Return the player remaining time to respawn.",
"ex": "",
"exres": "",
"name": "playerrespawntime",
"op": "playerrespawntime",
"since": "2.92"
},
"playerSide": {
"cat": "General",
"desc": "Returns the player's side. This is valid even when the player controlled person is dead (a difference from player side).",
"ex": "",
"exres": "",
"name": "playerside",
"op": "playerside",
"since": "2.09"
},
"productVersion": {
"cat": "General",
"desc": "Return the product name, version, build and flag if game is modded in form [\"product name\", \"product short name\", version*100, \"build number\", \"build\", customMods, platform]",
"ex": "productVersion",
"exres": "[\"ArmA 3\", \"Arma3\", 137, 87840, \"Development\", true, \"Windows\"]",
"name": "productversion",
"op": "productversion",
"since": ""
},
"profileName": {
"cat": "General",
"desc": "Return profile name.",
"ex": "",
"exres": "",
"name": "profilename",
"op": "profilename",
"since": "90916 A3"
},
"profileNameSteam": {
"cat": "General",
"desc": "Returns name of the current Steam profile.",
"ex": "",
"exres": "",
"name": "profilenamesteam",
"op": "profilenamesteam",
"since": ""
},
"profileNamespace": {
"cat": "General",
"desc": "Return the global namespace attached to user profile.",
"ex": "",
"exres": "",
"name": "profilenamespace",
"op": "profilenamespace",
"since": "80872 TOH"
},
"radioVolume": {
"cat": "General",
"desc": "Checks the current radio volume (set by <f>setRadioVolume</f>).",
"ex": "",
"exres": "",
"name": "radiovolume",
"op": "radiovolume",
"since": ""
},
"rain": {
"cat": "General",
"desc": "Return the current rain.",
"ex": "",
"exres": "",
"name": "rain",
"op": "rain",
"since": "2.92"
},
"rainbow": {
"cat": "General",
"desc": "Return the current rainbow intensity.",
"ex": "",
"exres": "",
"name": "rainbow",
"op": "rainbow",
"since": "2.92"
},
"resetCamShake": {
"cat": "General",
"desc": "Resets all camera shakes.",
"ex": "",
"exres": "",
"name": "resetcamshake",
"op": "resetcamshake",
"since": "5501"
},
"resistance": {
"cat": "General",
"desc": "The Resistance side.",
"ex": "",
"exres": "",
"name": "resistance",
"op": "resistance",
"since": ""
},
"reversedMouseY": {
"cat": "General",
"desc": "Return if mouse vertical axe is inverted.",
"ex": "",
"exres": "",
"name": "reversedmousey",
"op": "reversedmousey",
"since": "5501"
},
"runInitScript": {
"cat": "General",
"desc": "Launch init.sqs script.",
"ex": "",
"exres": "",
"name": "runinitscript",
"op": "runinitscript",
"since": "2.33"
},
"safeZoneH": {
"cat": "General",
"desc": "",
"ex": "",
"exres": "",
"name": "safezoneh",
"op": "safezoneh",
"since": "5501"
},
"safeZoneW": {
"cat": "General",
"desc": "",
"ex": "",
"exres": "",
"name": "safezonew",
"op": "safezonew",
"since": "5501"
},
"safeZoneWAbs": {
"cat": "General",
"desc": "",
"ex": "",
"exres": "",
"name": "safezonewabs",
"op": "safezonewabs",
"since": "5501"
},
"safeZoneX": {
"cat": "General",
"desc": "",
"ex": "",
"exres": "",
"name": "safezonex",
"op": "safezonex",
"since": "5501"
},
"safeZoneXAbs": {
"cat": "General",
"desc": "",
"ex": "",
"exres": "",
"name": "safezonexabs",
"op": "safezonexabs",
"since": "5501"
},
"safeZoneY": {
"cat": "General",
"desc": "",
"ex": "",
"exres": "",
"name": "safezoney",
"op": "safezoney",
"since": "5501"
},
"saveGame": {
"cat": "General",
"desc": "Creates an autosave game (used for Retry).",
"ex": "",
"exres": "",
"name": "savegame",
"op": "savegame",
"since": ""
},
"saveJoysticks": {
"cat": "General",
"desc": "Saves joysticks key mappings into the joysticks.cfg file. Engine add these joysticks to the Joystick Scheme mapping dialog in options controls section.",
"ex": "",
"exres": "",
"name": "savejoysticks",
"op": "savejoysticks",
"since": ""
},
"saveProfileNamespace": {
"cat": "General",
"desc": "Saves the variables stored in profileNamespace to user profile.",
"ex": "",
"exres": "",
"name": "saveprofilenamespace",
"op": "saveprofilenamespace",
"since": "80872 TOH"
},
"savingEnabled": {
"cat": "General",
"desc": "Check if saving the game is enabled.",
"ex": "",
"exres": "",
"name": "savingenabled",
"op": "savingenabled",
"since": "5501"
},
"scriptNull": {
"cat": "General",
"desc": "A non-existing script. This value is not equal to anything, including itself.",
"ex": "script == scriptNull",
"exres": "false",
"name": "scriptnull",
"op": "scriptnull",
"since": ""
},
"selectNoPlayer": {
"cat": "General",
"desc": "Switch player to no unit.",
"ex": "",
"exres": "",
"name": "selectnoplayer",
"op": "selectnoplayer",
"since": "5501"
},
"serverName": {
"cat": "General",
"desc": "Returns server hostname as it appears in server browser",
"ex": "",
"exres": "",
"name": "servername",
"op": "servername",
"since": "1.80"
},
"serverTime": {
"cat": "General",
"desc": "Server time synchronized to clients.",
"ex": "",
"exres": "",
"name": "servertime",
"op": "servertime",
"since": "5501"
},
"shownArtilleryComputer": {
"cat": "General",
"desc": "Checks whether the player has the artillery computer currently enabled.",
"ex": "",
"exres": "",
"name": "shownartillerycomputer",
"op": "shownartillerycomputer",
"since": ""
},
"shownChat": {
"cat": "General",
"desc": "Checks whether the player chat is visible.",
"ex": "",
"exres": "",
"name": "shownchat",
"op": "shownchat",
"since": ""
},
"shownCompass": {
"cat": "General",
"desc": "Checks whether the player has the compass enabled.",
"ex": "",
"exres": "",
"name": "showncompass",
"op": "showncompass",
"since": ""
},
"shownCuratorCompass": {
"cat": "General",
"desc": "Returns true if compass is shown.",
"ex": "",
"exres": "",
"name": "showncuratorcompass",
"op": "showncuratorcompass",
"since": ""
},
"shownGps": {
"cat": "General",
"desc": "Checks whether the player has the GPS receiver enabled.",
"ex": "",
"exres": "",
"name": "showngps",
"op": "showngps",
"since": ""
},
"shownHUD": {
"cat": "General",
"desc": "Returns array of booleans corresponding to visible HUD elements [hud, info, radar, compass, direction, menu, group, cursors]",
"ex": "",
"exres": "",
"name": "shownhud",
"op": "shownhud",
"since": ""
},
"shownMap": {
"cat": "General",
"desc": "Checks whether the player has the map enabled.",
"ex": "",
"exres": "",
"name": "shownmap",
"op": "shownmap",
"since": ""
},
"shownPad": {
"cat": "General",
"desc": "Checks whether the player has the notebook enabled.",
"ex": "",
"exres": "",
"name": "shownpad",
"op": "shownpad",
"since": ""
},
"shownRadio": {
"cat": "General",
"desc": "Checks whether the player has the radio transmitter enabled.",
"ex": "",
"exres": "",
"name": "shownradio",
"op": "shownradio",
"since": ""
},
"shownScoretable": {
"cat": "General",
"desc": "Returns state of scoretable, 0, 1 or -1 (forced not visible, forced visible, default).",
"ex": "",
"exres": "",
"name": "shownscoretable",
"op": "shownscoretable",
"since": ""
},
"shownUAVFeed": {
"cat": "General",
"desc": "True if UAV view is visible.",
"ex": "",
"exres": "",
"name": "shownuavfeed",
"op": "shownuavfeed",
"since": "5501"
},
"shownWarrant": {
"cat": "General",
"desc": "Checks whether the player has the ID card enabled.\r\n(Obsolete).",
"ex": "",
"exres": "",
"name": "shownwarrant",
"op": "shownwarrant",
"since": ""
},
"shownWatch": {
"cat": "General",
"desc": "Checks whether the player has the watch enabled.",
"ex": "",
"exres": "",
"name": "shownwatch",
"op": "shownwatch",
"since": ""
},
"sideAmbientLife": {
"cat": "General",
"desc": "The Ambient Life side",
"ex": "",
"exres": "",
"name": "sideambientlife",
"op": "sideambientlife",
"since": ""
},
"sideEmpty": {
"cat": "General",
"desc": "The Empty side",
"ex": "",
"exres": "",
"name": "sideempty",
"op": "sideempty",
"since": ""
},
"sideEnemy": {
"cat": "General",
"desc": "The Enemy side (used for renegades).",
"ex": "",
"exres": "",
"name": "sideenemy",
"op": "sideenemy",
"since": "1.78"
},
"sideFriendly": {
"cat": "General",
"desc": "The Friendly side (used for captives).",
"ex": "",
"exres": "",
"name": "sidefriendly",
"op": "sidefriendly",
"since": "1.78"
},
"sideLogic": {
"cat": "General",
"desc": "The Logic side.",
"ex": "",
"exres": "",
"name": "sidelogic",
"op": "sidelogic",
"since": "1.86"
},
"sideUnknown": {
"cat": "General",
"desc": "The unknown side.",
"ex": "",
"exres": "",
"name": "sideunknown",
"op": "sideunknown",
"since": "5501"
},
"simulWeatherSync": {
"cat": "General",
"desc": "Synchronizes SW with arma weather, generates all keyframes.",
"ex": "",
"exres": "",
"name": "simulweathersync",
"op": "simulweathersync",
"since": ""
},
"slingLoadAssistantShown": {
"cat": "General",
"desc": "Return true if Sling Load Assistant is shown.",
"ex": "slingLoadAssistantShown",
"exres": "",
"name": "slingloadassistantshown",
"op": "slingloadassistantshown",
"since": "126800"
},
"soundVolume": {
"cat": "General",
"desc": "Checks the current sound volume (set by <f>setSoundVolume</f>).",
"ex": "",
"exres": "",
"name": "soundvolume",
"op": "soundvolume",
"since": ""
},
"sunOrMoon": {
"cat": "General",
"desc": "Returns sun to moon transition state.",
"ex": "",
"exres": "",
"name": "sunormoon",
"op": "sunormoon",
"since": "93989"
},
"switchableUnits": {
"cat": "General",
"desc": "Return a list of units accessible through team switch.",
"ex": "",
"exres": "",
"name": "switchableunits",
"op": "switchableunits",
"since": "2.92"
},
"systemOfUnits": {
"cat": "General",
"desc": "Returns 0 for metric, 1 for mixed (ground units uses metric, air units uses imperial) and 2 for imperial.",
"ex": "",
"exres": "",
"name": "systemofunits",
"op": "systemofunits",
"since": "5501"
},
"taskNull": {
"cat": "Identity",
"desc": "A non-existing task. This value is not equal to anything, including itself.",
"ex": "taskNull == taskNull",
"exres": "false",
"name": "tasknull",
"op": "tasknull",
"since": "5153"
},
"teamMemberNull": {
"cat": "Agents",
"desc": "A non-existing team member. This value is not equal to anything, including itself.",
"ex": "_teamMember == teamMemberNull",
"exres": "false",
"name": "teammembernull",
"op": "teammembernull",
"since": ""
},
"teamSwitch": {
"cat": "General",
"desc": "Invoke the team switch dialog (force it even when conditions are not met).",
"ex": "",
"exres": "",
"name": "teamswitch",
"op": "teamswitch",
"since": "2.92"
},
"teamSwitchEnabled": {
"cat": "General",
"desc": "Check if tam switch is currently enabled.",
"ex": "",
"exres": "",
"name": "teamswitchenabled",
"op": "teamswitchenabled",
"since": "2.92"
},
"teams": {
"cat": "Agents",
"desc": "Return a list of teams in the current mission.",
"ex": "_teams = teams",
"exres": "",
"name": "teams",
"op": "teams",
"since": "2.92"
},
"time": {
"cat": "General",
"desc": "Returns the time that elapsed since the mission started (in seconds).",
"ex": "",
"exres": "",
"name": "time",
"op": "time",
"since": ""
},
"timeMultiplier": {
"cat": "General",
"desc": "Returns game time multiplier setted to speed up game time",
"ex": "multiplier",
"exres": "",
"name": "timemultiplier",
"op": "timemultiplier",
"since": ""
},
"true": {
"cat": "Default",
"desc": "Always true.",
"ex": "",
"exres": "",
"name": "true",
"op": "true",
"since": ""
},
"uiNamespace": {
"cat": "General",
"desc": "Return the global namespace attached to user interface.",
"ex": "",
"exres": "",
"name": "uinamespace",
"op": "uinamespace",
"since": "5501"
},
"userInputDisabled": {
"cat": "General",
"desc": "Returns true when all user input is disabled.",
"ex": "disabled = userInputDisabled;",
"exres": "",
"name": "userinputdisabled",
"op": "userinputdisabled",
"since": ""
},
"vehicles": {
"cat": "General",
"desc": "Return a list of vehicles in the current mission.",
"ex": "_vehicles = vehicles",
"exres": "",
"name": "vehicles",
"op": "vehicles",
"since": "2.92"
},
"viewDistance": {
"cat": "General",
"desc": "Returns the rendering distance.",
"ex": "",
"exres": "",
"name": "viewdistance",
"op": "viewdistance",
"since": "5501"
},
"visibleCompass": {
"cat": "General",
"desc": "Checks whether the player has the compass opened and visible.",
"ex": "",
"exres": "",
"name": "visiblecompass",
"op": "visiblecompass",
"since": ""
},
"visibleGps": {
"cat": "General",
"desc": "Checks whether the player has the GPS receiver opened and visible.",
"ex": "",
"exres": "",
"name": "visiblegps",
"op": "visiblegps",
"since": ""
},
"visibleMap": {
"cat": "General",
"desc": "Return true if the main map is shown (active).",
"ex": "",
"exres": "",
"name": "visiblemap",
"op": "visiblemap",
"since": "5501"
},
"visibleScoretable": {
"cat": "General",
"desc": "Checks whether the scoretable is visible.",
"ex": "",
"exres": "",
"name": "visiblescoretable",
"op": "visiblescoretable",
"since": ""
},
"visibleWatch": {
"cat": "General",
"desc": "Checks whether the player has the watch opened and visible.",
"ex": "",
"exres": "",
"name": "visiblewatch",
"op": "visiblewatch",
"since": ""
},
"waves": {
"cat": "General",
"desc": "Return waves value.",
"ex": "",
"exres": "",
"name": "waves",
"op": "waves",
"since": "2.92"
},
"west": {
"cat": "General",
"desc": "The West side.",
"ex": "",
"exres": "",
"name": "west",
"op": "west",
"since": ""
},
"wind": {
"cat": "General",
"desc": "Return the current wind vector.",
"ex": "",
"exres": "",
"name": "wind",
"op": "wind",
"since": "2.92"
},
"windDir": {
"cat": "General",
"desc": "Return the current wind azimut.",
"ex": "",
"exres": "",
"name": "winddir",
"op": "winddir",
"since": "2.92"
},
"windRTD": {
"cat": "General",
"desc": "Returns wind strength and direction.",
"ex": "",
"exres": "",
"name": "windrtd",
"op": "windrtd",
"since": "TOH 81393"
},
"windStr": {
"cat": "General",
"desc": "Return the current wind strength.",
"ex": "",
"exres": "",
"name": "windstr",
"op": "windstr",
"since": "2.92"
},
"worldName": {
"cat": "General",
"desc": "Return the name of the currently loaded world.",
"ex": "",
"exres": "",
"name": "worldname",
"op": "worldname",
"since": "2.92"
},
"worldSize": {
"cat": "General",
"desc": "Return the name of the currently loaded world.",
"ex": "",
"exres": "",
"name": "worldsize",
"op": "worldsize",
"since": "2.92"
}
},
"operators": {
"!=": [
{
"cat": "Default",
"desc": "a is not equal to b",
"ex": "counter != 4",
"exres": "",
"lname": "a",
"name": "!=",
"op": "!=",
"rname": "b",
"since": ""
},
{
"cat": "Default",
"desc": "a is not equal to b (case insensitive)",
"ex": "nameOfPlayer != \"John Doe\"",
"exres": "",
"lname": "a",
"name": "!=",
"op": "!=",
"rname": "b",
"since": ""
},
{
"cat": "General",
"desc": "Checks whether two objects are different. If either of them is objNull, true is returned.",
"ex": "vehicle player != player",
"exres": "",
"lname": "obj1",
"name": "!=",
"op": "!=",
"rname": "obj2",
"since": ""
},
{
"cat": "General",
"desc": "Checks whether two groups are different. If either of them is grpNull, true is returned.",
"ex": "group player != group soldierOne",
"exres": "",
"lname": "grp1",
"name": "!=",
"op": "!=",
"rname": "grp2",
"since": ""
},
{
"cat": "General",
"desc": "Checks whether two side values are different.",
"ex": "side player != west",
"exres": "",
"lname": "side1",
"name": "!=",
"op": "!=",
"rname": "side2",
"since": ""
},
{
"cat": "General",
"desc": "Checks whether two structured text values are different.",
"ex": "",
"exres": "",
"lname": "text1",
"name": "!=",
"op": "!=",
"rname": "text2",
"since": "2.01"
},
{
"cat": "General",
"desc": "Checks whether two config entries are different.",
"ex": "",
"exres": "",
"lname": "config1",
"name": "!=",
"op": "!=",
"rname": "config2",
"since": "2.58"
},
{
"cat": "General",
"desc": "Checks whether two displays are different.",
"ex": "",
"exres": "",
"lname": "display1",
"name": "!=",
"op": "!=",
"rname": "display2",
"since": "2.50"
},
{
"cat": "General",
"desc": "Checks whether two controls are different.",
"ex": "",
"exres": "",
"lname": "control1",
"name": "!=",
"op": "!=",
"rname": "control2",
"since": "2.50"
},
{
"cat": "Agents",
"desc": "Checks whether two team members are different. If either of them is teamMemberNull, true is returned.",
"ex": "teamMember player != _teamMember",
"exres": "",
"lname": "teamMember1",
"name": "!=",
"op": "!=",
"rname": "teamMember2",
"since": "2.90"
},
{
"cat": "General",
"desc": "Checks whether two objects are different. If either of them is netObjNull, true is returned.",
"ex": "_myJoint != _myWinch",
"exres": "",
"lname": "netObj1",
"name": "!=",
"op": "!=",
"rname": "netObj2",
"since": "69527"
},
{
"cat": "Identity",
"desc": "Checks whether two tasks are different.",
"ex": "",
"exres": "",
"lname": "task1",
"name": "!=",
"op": "!=",
"rname": "task2",
"since": "2.92"
},
{
"cat": "Location",
"desc": "Checks whether two locations are different. If either of them is null, true is returned.",
"ex": "",
"exres": "",
"lname": "location1",
"name": "!=",
"op": "!=",
"rname": "location2",
"since": ""
}
],
"%": [
{
"cat": "Default",
"desc": "The remainder of a divided by b. Note that the remainder is calculated in the real domain.",
"ex": "4.5 % 3",
"exres": "1.5",
"lname": "a",
"name": "%",
"op": "%",
"rname": "b",
"since": ""
}
],
"&&": [
{
"cat": "Default",
"desc": "a and b",
"ex": "alive player && alive leader player",
"exres": "",
"lname": "a",
"name": "&&",
"op": "&&",
"rname": "b",
"since": ""
},
{
"cat": "Default",
"desc": "a and b, b evaluated only when a is true",
"ex": "alive player && {alive leader player}",
"exres": "",
"lname": "a",
"name": "&&",
"op": "&&",
"rname": "b",
"since": ""
}
],
"*": [
{
"cat": "Default",
"desc": "a multiplied by b",
"ex": "iCounter*3",
"exres": "",
"lname": "a",
"name": "*",
"op": "*",
"rname": "b",
"since": ""
}
],
"+": [
{
"cat": "Default",
"desc": "a plus b",
"ex": "counter + 1",
"exres": "",
"lname": "a",
"name": "+",
"op": "+",
"rname": "b",
"since": ""
},
{
"cat": "Default",
"desc": "stringA and stringB are concatenated.",
"ex": "\"I\" + \" am\" + \" blind\"",
"exres": "\"I am blind\"",
"lname": "stringA",
"name": "+",
"op": "+",
"rname": "stringB",
"since": ""
},
{
"cat": "Default",
"desc": "arrayA and arrayB are concatenated.",
"ex": "[0, 1, 2] + [1, 2, 3]",
"exres": "[0, 1, 2, 1, 2, 3]",
"lname": "arrayA",
"name": "+",
"op": "+",
"rname": "arrayB",
"since": ""
}
],
"-": [
{
"cat": "Default",
"desc": "a minus b",
"ex": "counter - 1",
"exres": "",
"lname": "a",
"name": "-",
"op": "-",
"rname": "b",
"since": ""
},
{
"cat": "Default",
"desc": "All elements in arrayB are removed from arrayA.",
"ex": "[0, 1, 2, 4, 0, 1, 2, 3, 4, 5] - [1, 2, 3]",
"exres": "[0, 4, 0, 4, 5]",
"lname": "arrayA",
"name": "-",
"op": "-",
"rname": "arrayB",
"since": ""
}
],
"/": [
{
"cat": "Default",
"desc": "a divided by b",
"ex": "enemyStrenght/3",
"exres": "",
"lname": "a",
"name": "/",
"op": "/",
"rname": "b",
"since": ""
},
{
"cat": "General",
"desc": "Returns subentry of config entry with given name (alias for >>).",
"ex": "configFile / \"CfgVehicles\"",
"exres": "",
"lname": "config",
"name": "/",
"op": "/",
"rname": "name",
"since": "2.92"
}
],
":": [
{
"cat": "Default",
"desc": "see switch",
"ex": "",
"exres": "",
"lname": "a",
"name": ":",
"op": ":",
"rname": "b",
"since": ""
}
],
"<": [
{
"cat": "Default",
"desc": "a lesser than b",
"ex": "counter < 4",
"exres": "",
"lname": "a",
"name": "<",
"op": "<",
"rname": "b",
"since": ""
}
],
"<=": [
{
"cat": "Default",
"desc": "a lesser or equal than b",
"ex": "player distance redCar <= 100",
"exres": "",
"lname": "a",
"name": "<=",
"op": "<=",
"rname": "b",
"since": ""
}
],
"==": [
{
"cat": "Default",
"desc": "a equal to b",
"ex": "counter == 4",
"exres": "",
"lname": "a",
"name": "==",
"op": "==",
"rname": "b",
"since": ""
},
{
"cat": "Default",
"desc": "a equal to b (case insensitive)",
"ex": "nameOfPlayer == \"John Doe\"",
"exres": "",
"lname": "a",
"name": "==",
"op": "==",
"rname": "b",
"since": ""
},
{
"cat": "General",
"desc": "Checks whether two objects are the same. If either of them is objNull, false is returned.",
"ex": "player == leader player",
"exres": "",
"lname": "obj1",
"name": "==",
"op": "==",
"rname": "obj2",
"since": ""
},
{
"cat": "General",
"desc": "Checks whether two groups are the same. If either of them is grpNull, false is returned.",
"ex": "group player == group soldierOne",
"exres": "",
"lname": "grp1",
"name": "==",
"op": "==",
"rname": "grp2",
"since": ""
},
{
"cat": "General",
"desc": "Checks whether two side values are equal.",
"ex": "side player == west",
"exres": "",
"lname": "side1",
"name": "==",
"op": "==",
"rname": "side2",
"since": ""
},
{
"cat": "General",
"desc": "Checks whether two structured text values are equal.",
"ex": "",
"exres": "",
"lname": "text1",
"name": "==",
"op": "==",
"rname": "text2",
"since": "2.01"
},
{
"cat": "General",
"desc": "Checks whether two config entries are equal.",
"ex": "",
"exres": "",
"lname": "config1",
"name": "==",
"op": "==",
"rname": "config2",
"since": "2.58"
},
{
"cat": "General",
"desc": "Checks whether two displays are equal.",
"ex": "",
"exres": "",
"lname": "display1",
"name": "==",
"op": "==",
"rname": "display2",
"since": "2.50"
},
{
"cat": "General",
"desc": "Checks whether two controls are equal.",
"ex": "",
"exres": "",
"lname": "control1",
"name": "==",
"op": "==",
"rname": "control2",
"since": "2.50"
},
{
"cat": "Agents",
"desc": "Checks whether two team members are the same. If either of them is teamMemberNull, false is returned.",
"ex": "teamMember player == _teamMember",
"exres": "",
"lname": "teamMember1",
"name": "==",
"op": "==",
"rname": "teamMember2",
"since": "2.90"
},
{
"cat": "General",
"desc": "Checks whether two objects are the same. If either of them is netObjNull, false is returned.",
"ex": "_myJoint == _myWinch",
"exres": "",
"lname": "netObj1",
"name": "==",
"op": "==",
"rname": "netObj2",
"since": "69527"
},
{
"cat": "Identity",
"desc": "Checks whether two tasks are equal.",
"ex": "",
"exres": "",
"lname": "task1",
"name": "==",
"op": "==",
"rname": "task2",
"since": "2.92"
},
{
"cat": "Location",
"desc": "Checks whether two locations are the same. If either of them is null, false is returned.",
"ex": "",
"exres": "",
"lname": "location1",
"name": "==",
"op": "==",
"rname": "location2",
"since": ""
}
],
">": [
{
"cat": "Default",
"desc": "a greater than b",
"ex": "counter > 4",
"exres": "",
"lname": "a",
"name": ">",
"op": ">",
"rname": "b",
"since": ""
}
],
">=": [
{
"cat": "Default",
"desc": "a greater or equal than b",
"ex": "player distance redCar < 100",
"exres": "",
"lname": "a",
"name": ">=",
"op": ">=",
"rname": "b",
"since": ""
}
],
">>": [
{
"cat": "General",
"desc": "Returns subentry of config entry with given name.",
"ex": "configFile >> \"CfgVehicles\"",
"exres": "",
"lname": "config",
"name": ">>",
"op": ">>",
"rname": "name",
"since": "2.35"
}
],
"AddMagazineAmmoCargo": [
{
"cat": "General",
"desc": "Adds magazines to the weapon cargo space. This is used for infantry weapons. MP synchronized. The format of magazines is [magazineName, count, ammo].\r\nFor magazineName values see <cl>CfgWeapons</cl>.",
"ex": "rearmTruckOne AddMagazineAmmoCargo [\"M16\", 2,12]",
"exres": "",
"lname": "unit",
"name": "addmagazineammocargo",
"op": "addmagazineammocargo",
"rname": "magazines",
"since": ""
}
],
"SwimInDepth": [
{
"cat": "General",
"desc": "Sets the target depth level for swimming soldier.",
"ex": "soldier SwimInDepth -20",
"exres": "",
"lname": "unit",
"name": "swimindepth",
"op": "swimindepth",
"rname": "height",
"since": "2.92"
}
],
"^": [
{
"cat": "Default",
"desc": "a raised to the power of b",
"ex": "count^4",
"exres": "",
"lname": "a",
"name": "^",
"op": "^",
"rname": "b",
"since": ""
}
],
"action": [
{
"cat": "General",
"desc": "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.",
"ex": "soldierOne action [\"eject\", vehicle soldierOne]",
"exres": "",
"lname": "unit",
"name": "action",
"op": "action",
"rname": "action",
"since": ""
}
],
"actionParams": [
{
"cat": "General",
"desc": "Returns array with user added action params in format of addAction",
"ex": "player actionParams 0",
"exres": "",
"lname": "unit",
"name": "actionparams",
"op": "actionparams",
"rname": "actionID",
"since": "1.64"
}
],
"add3DENLayer": [
{
"cat": "General",
"desc": "Creates new entity layer with given name",
"ex": "0 add3DENLayer \"My layer 01\"",
"exres": "",
"lname": "<layerID>",
"name": "add3denlayer",
"op": "add3denlayer",
"rname": "<name>",
"since": ""
}
],
"addAction": [
{
"cat": "General",
"desc": "Creates an action and returns its ID. It uses the following algorithm: the first action added to the given vehicle has ID zero, the next vehicle has ID one, etc.",
"ex": "player addAction [\"Hello\", \"hello.sqs\"]; player addAction [\"Hello2\", { hint \"Hello!\"} ]",
"exres": "",
"lname": "unit",
"name": "addaction",
"op": "addaction",
"rname": "[action, script filename or code(, arguments, priority, showWindow, hideOnUse, shortcut, condition, radius, showUnconscious)]",
"since": "1.10"
}
],
"addBackpack": [
{
"cat": "General",
"desc": "Adds the backpack to the unit. ",
"ex": "player addBackpack \"usbackpack\"",
"exres": "",
"lname": "unit",
"name": "addbackpack",
"op": "addbackpack",
"rname": "backpackName",
"since": ""
}
],
"addBackpackCargo": [
{
"cat": "General",
"desc": "Adds bacpacks to the cargo space. The format of backpacks is [backpacksName, count].\r\nFor backpacksName values see <cl>CfgWeapons</cl>.",
"ex": "rearmTruckOne addBackpackCargo [\"DSHKM_TK_GUE_Bag_EP1\", 2]",
"exres": "",
"lname": "unit",
"name": "addbackpackcargo",
"op": "addbackpackcargo",
"rname": "backpacks",
"since": ""
}
],
"addBackpackCargoGlobal": [
{
"cat": "General",
"desc": "Adds bacpacks to the cargo space. MP synchronized. The format of backpacks is [backpacksName, count].\r\nFor backpacksName values see <cl>CfgWeapons</cl>.",
"ex": "rearmTruckOne addBackpackCargo [\"DSHKM_TK_GUE_Bag_EP1\", 2]",
"exres": "",
"lname": "unit",
"name": "addbackpackcargoglobal",
"op": "addbackpackcargoglobal",
"rname": "backpacks",
"since": ""
}
],
"addBackpackGlobal": [
{
"cat": "General",
"desc": "Adds the backpack to the unit(even non-local) ",
"ex": "player addBackpackGlobal \"usbackpack\"",
"exres": "",
"lname": "unit",
"name": "addbackpackglobal",
"op": "addbackpackglobal",
"rname": "backpackName",
"since": ""
}
],
"addCuratorAddons": [
{
"cat": "General",
"desc": "Allow curator use of given addon.",
"ex": "curator addCuratorAddons [addon1, addon2]",
"exres": "",
"lname": "curatorObj",
"name": "addcuratoraddons",
"op": "addcuratoraddons",
"rname": "[addons]",
"since": ""
}
],
"addCuratorCameraArea": [
{
"cat": "General",
"desc": "Adds or changes curator camera area (depends on if ID is allready used)",
"ex": "",
"exres": "",
"lname": "curatorObj",
"name": "addcuratorcameraarea",
"op": "addcuratorcameraarea",
"rname": "[cameraAreaID, [position],radius]",
"since": ""
}
],
"addCuratorEditableObjects": [
{
"cat": "General",
"desc": "Register objects which can be edited by a curator.",
"ex": "0 addCuratorEditableObjects [cursorTarget, true]",
"exres": "",
"lname": "curatorObj",
"name": "addcuratoreditableobjects",
"op": "addcuratoreditableobjects",
"rname": "[[objects],addCrew = true]",
"since": ""
}
],
"addCuratorEditingArea": [
{
"cat": "General",
"desc": "Adds or changes curator edit area (depends on if ID is allready used)",
"ex": "",
"exres": "",
"lname": "curatorObj",
"name": "addcuratoreditingarea",
"op": "addcuratoreditingarea",
"rname": "[editAreaID, [position], radius]",
"since": ""
}
],
"addCuratorPoints": [
{
"cat": "General",
"desc": "Adds or removes curator points.",
"ex": "0 addCuratorPoints 0.5",
"exres": "",
"lname": "curatorObj",
"name": "addcuratorpoints",
"op": "addcuratorpoints",
"rname": "number of points",
"since": ""
}
],
"addEditorObject": [
{
"cat": "Editor",
"desc": "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.",
"ex": "",
"exres": "",
"lname": "map",
"name": "addeditorobject",
"op": "addeditorobject",
"rname": "[type, [name1, value1, ...], subtype class]",
"since": "2.92"
}
],
"addEventHandler": [
{
"cat": "General",
"desc": "The format of handler is [type,command]. Check scripting topic Event handlers for more information. The index of the currently added handler is returned.",
"ex": "player addEventHandler [\"killed\",{_this exec \"playerKilled.sqs\"}]",
"exres": "",
"lname": "object",
"name": "addeventhandler",
"op": "addeventhandler",
"rname": "handler",
"since": "1.85"
}
],
"addGoggles": [
{
"cat": "General",
"desc": "Create a new item and try to link them into goggles slot.",
"ex": "",
"exres": "",
"lname": "unit",
"name": "addgoggles",
"op": "addgoggles",
"rname": "type",
"since": ""
}
],
"addGroupIcon": [
{
"cat": "General",
"desc": "Add icon to a group. Returns icon ID",
"ex": "id = group addGroupIcon[\"b_inf\",[offsetX,ofsetY]]",
"exres": "",
"lname": "group",
"name": "addgroupicon",
"op": "addgroupicon",
"rname": "properties",
"since": "5501"
}
],
"addHandgunItem": [
{
"cat": "General",
"desc": "Adds item to the weapon cargo space. This is used for infantry weapons.",
"ex": "player addHandgunItem \"ItemClassName\"",
"exres": "",
"lname": "unit",
"name": "addhandgunitem",
"op": "addhandgunitem",
"rname": "item",
"since": ""
}
],
"addHeadgear": [
{
"cat": "General",
"desc": "Create a new item and try to link them into headgear slot",
"ex": "",
"exres": "",
"lname": "unit",
"name": "addheadgear",
"op": "addheadgear",
"rname": "weapons",
"since": ""
}
],
"addItem": [
{
"cat": "General",
"desc": "Create new item and store it to to the inventory. ",
"ex": "",
"exres": "",
"lname": "unit",
"name": "additem",
"op": "additem",
"rname": "item",
"since": ""
}
],
"addItemCargo": [
{
"cat": "General",
"desc": "Create new items and store them to the weapon holder.",
"ex": "rearmTruckOne addItemCargo [\"optic_ARCO\", 10]",
"exres": "",
"lname": "unit",
"name": "additemcargo",
"op": "additemcargo",
"rname": "[item, count]",
"since": ""
}
],
"addItemCargoGlobal": [
{
"cat": "General",
"desc": "Create new items and store them to the weapon holder.",
"ex": "rearmTruckOne addItemCargo [\"optic_ARCO\", 10]",
"exres": "",
"lname": "unit",
"name": "additemcargoglobal",
"op": "additemcargoglobal",
"rname": "[item, count]",
"since": ""
}
],
"addItemToBackpack": [
{
"cat": "General",
"desc": "Create new item and store it to soldier's backpack",
"ex": "",
"exres": "",
"lname": "unit",
"name": "additemtobackpack",
"op": "additemtobackpack",
"rname": "item",
"since": ""
}
],
"addItemToUniform": [
{
"cat": "General",
"desc": "Create new item and store it to soldier's uniform",
"ex": "",
"exres": "",
"lname": "unit",
"name": "additemtouniform",
"op": "additemtouniform",
"rname": "item",
"since": ""
}
],
"addItemToVest": [
{
"cat": "General",
"desc": "Create new item and store it to soldier's vest",
"ex": "",
"exres": "",
"lname": "unit",
"name": "additemtovest",
"op": "additemtovest",
"rname": "item",
"since": ""
}
],
"addLiveStats": [
{
"cat": "General",
"desc": "Xbox Live MP only: adds score to the Xbox Live Statistics score for the given unit (or the commander unit of the given vehicle).",
"ex": "player addLiveStats 10",
"exres": "",
"lname": "unit",
"name": "addlivestats",
"op": "addlivestats",
"rname": "score",
"since": "2.10"
}
],
"addMPEventHandler": [
{
"cat": "General",
"desc": "The format of handler is [type,command]. Check scripting topic Event handlers for more information. The index of the currently added handler is returned.",
"ex": "player addMPEventHandler [\"mpkilled\",{_this exec \"playerKilled.sqs\"}]",
"exres": "",
"lname": "object",
"name": "addmpeventhandler",
"op": "addmpeventhandler",
"rname": "handler",
"since": "1.85"
}
],
"addMagazine": [
{
"cat": "General",
"desc": "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.",
"ex": "player addMagazine \"M16\"",
"exres": "",
"lname": "unit",
"name": "addmagazine",
"op": "addmagazine",
"rname": "magazineName",
"since": ""
},
{
"cat": "General",
"desc": "Adds a magazine to the unit and sets ammo count. Note: you may create invalid combinations by using this function, for example by adding 20 grenades. When doing so, application behaviour is undefined.",
"ex": "player addMagazine [\"M16\",15]",
"exres": "",
"lname": "unit",
"name": "addmagazine",
"op": "addmagazine",
"rname": "[magazineName, ammo count]",
"since": ""
}
],
"addMagazineCargo": [
{
"cat": "General",
"desc": "Adds magazines to the weapon cargo space. This is used for infantry weapons. The format of magazines is [magazineName, count].\r\nFor magazineName values see <cl>CfgWeapons</cl>.",
"ex": "rearmTruckOne addMagazineCargo [\"M16\", 10]",
"exres": "",
"lname": "unit",
"name": "addmagazinecargo",
"op": "addmagazinecargo",
"rname": "magazines",
"since": ""
}
],
"addMagazineCargoGlobal": [
{
"cat": "General",
"desc": "Adds magazines to the weapon cargo space. This is used for infantry weapons. MP synchronized. The format of magazines is [magazineName, count].\r\nFor magazineName values see <cl>CfgWeapons</cl>.",
"ex": "rearmTruckOne addMagazineCargo [\"M16\", 10]",
"exres": "",
"lname": "unit",
"name": "addmagazinecargoglobal",
"op": "addmagazinecargoglobal",
"rname": "magazines",
"since": ""
}
],
"addMagazineGlobal": [
{
"cat": "General",
"desc": "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.",
"ex": "player addMagazineGlobal \"M16\"",
"exres": "",
"lname": "unit",
"name": "addmagazineglobal",
"op": "addmagazineglobal",
"rname": "magazineName",
"since": ""
}
],
"addMagazineTurret": [
{
"cat": "General",
"desc": "Adds a magazine to the turret. Use turret path [-1] for driver's turret. Note: you may create invalid combinations by using this function, for example by adding 20 grenades. When doing so, application behaviour is undefined.",
"ex": "player addMagazine \"M16\"",
"exres": "",
"lname": "transport",
"name": "addmagazineturret",
"op": "addmagazineturret",
"rname": "[magazineName, turret path, (ammo count)]",
"since": ""
}
],
"addMagazines": [
{
"cat": "General",
"desc": "Adds magazines to the unit.",
"ex": "player addMagazines [\"magazine name\",count]",
"exres": "",
"lname": "unit",
"name": "addmagazines",
"op": "addmagazines",
"rname": "[magazineName, count]",
"since": ""
}
],
"addMenu": [
{
"cat": "Editor",
"desc": "Adds a new menu button. Priority is optional.",
"ex": "",
"exres": "",
"lname": "map",
"name": "addmenu",
"op": "addmenu",
"rname": "[text,priority]",
"since": "2.92"
}
],
"addMenuItem": [
{
"cat": "Editor",
"desc": "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).",
"ex": "",
"exres": "",
"lname": "map",
"name": "addmenuitem",
"op": "addmenuitem",
"rname": "[menu or index,text,command,priority]",
"since": "2.92"
}
],
"addOwnedMine": [
{
"cat": "General",
"desc": "Set ownership over a remotely detonatable mine to the unit.",
"ex": "player addOwnedMine SuperMine",
"exres": "",
"lname": "unit",
"name": "addownedmine",
"op": "addownedmine",
"rname": "item",
"since": ""
}
],
"addPlayerScores": [
{
"cat": "General",
"desc": "MP server only: adds player score.",
"ex": "unit addPlayerScores [0, 1, 0, 0, 1];",
"exres": "",
"lname": "unit",
"name": "addplayerscores",
"op": "addplayerscores",
"rname": "[killsInfantry , killsSoft, killsArmor, killsAir, killed]",
"since": ""
}
],
"addPrimaryWeaponItem": [
{
"cat": "General",
"desc": "Adds item to the weapon cargo space of primary weapon.",
"ex": "player addPrimaryWeaponItem \"ItemClassName\"",
"exres": "",
"lname": "unit",
"name": "addprimaryweaponitem",
"op": "addprimaryweaponitem",
"rname": "item",
"since": ""
}
],
"addPublicVariableEventHandler": [
{
"cat": "General",
"desc": "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.",
"ex": "\"alarm\" addPublicVariableEventHandler {_this execVM \"alarm.sqf\"}",
"exres": "",
"lname": "name",
"name": "addpublicvariableeventhandler",
"op": "addpublicvariableeventhandler",
"rname": "code",
"since": ""
},
{
"cat": "General",
"desc": "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. For namespaces, only missionNamespace is allowed as a target.",
"ex": "\"alarm\" addPublicVariableEventHandler [grp, {_this execVM \"alarm.sqf\"}]",
"exres": "",
"lname": "name",
"name": "addpublicvariableeventhandler",
"op": "addpublicvariableeventhandler",
"rname": "[target, code]",
"since": ""
}
],
"addRating": [
{
"cat": "General",
"desc": "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.",
"ex": "player addRating 1000",
"exres": "",
"lname": "unit",
"name": "addrating",
"op": "addrating",
"rname": "number",
"since": ""
}
],
"addResources": [
{
"cat": "Agents",
"desc": "Add (register) resources to the team member.",
"ex": "teamMember _agent addResources [\"Arms\", \"Legs\"]",
"exres": "",
"lname": "teamMember",
"name": "addresources",
"op": "addresources",
"rname": "[resource1, resource2, ...]",
"since": "2.90"
}
],
"addScore": [
{
"cat": "General",
"desc": "MP only: adds unit score. This is shown in the \"I\" MP screen as the total score.",
"ex": "player addScore 10",
"exres": "",
"lname": "unit",
"name": "addscore",
"op": "addscore",
"rname": "score",
"since": ""
}
],
"addScoreSide": [
{
"cat": "General",
"desc": "MP only: adds side score. This is shown in the \"I\" MP screen as the total score.",
"ex": "side addScore 10",
"exres": "",
"lname": "side",
"name": "addscoreside",
"op": "addscoreside",
"rname": "score",
"since": ""
}
],
"addSecondaryWeaponItem": [
{
"cat": "General",
"desc": "Adds item to the weapon cargo space of secondary weapon.",
"ex": "player addSecondaryWeaponItem \"ItemClassName\"",
"exres": "",
"lname": "unit",
"name": "addsecondaryweaponitem",
"op": "addsecondaryweaponitem",
"rname": "item",
"since": ""
}
],
"addTeamMember": [
{
"cat": "Agents",
"desc": "Add given member to given team.",
"ex": "_team addTeamMember _teamMember",
"exres": "",
"lname": "team",
"name": "addteammember",
"op": "addteammember",
"rname": "member",
"since": "2.90"
}
],
"addUniform": [
{
"cat": "General",
"desc": "Create a new uniform and try to link it into uniform slot(given uniform has to be supported by allowedUniforms list of target soldier).",
"ex": "",
"exres": "",
"lname": "unit",
"name": "adduniform",
"op": "adduniform",
"rname": "type",
"since": ""
}
],
"addVehicle": [
{
"cat": "General",
"desc": "Tells the group it owns the vehicle now.",
"ex": "",
"exres": "",
"lname": "group",
"name": "addvehicle",
"op": "addvehicle",
"rname": "vehicle",
"since": "5128"
}
],
"addVest": [
{
"cat": "General",
"desc": "Create a new vest and try to link it into vest slot.",
"ex": "",
"exres": "",
"lname": "unit",
"name": "addvest",
"op": "addvest",
"rname": "type",
"since": ""
}
],
"addWaypoint": [
{
"cat": "General",
"desc": "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].",
"ex": "grp addWaypoint [position player, 0]",
"exres": "",
"lname": "group",
"name": "addwaypoint",
"op": "addwaypoint",
"rname": "[center, radius] or [center, radius, index] or [center, radius, index, name]",
"since": "1.86"
}
],
"addWeapon": [
{
"cat": "General",
"desc": "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.",
"ex": "player addWeapon \"AK74\"",
"exres": "",
"lname": "unit",
"name": "addweapon",
"op": "addweapon",
"rname": "weaponName",
"since": ""
}
],
"addWeaponCargo": [
{
"cat": "General",
"desc": "Adds weapons to the weapon cargo space. This is used for infantry weapons. The format of weapons is [weaponName, count].\r\nFor weaponName values see <cl>CfgWeapons</cl>.",
"ex": "rearmTruckOne addWeaponCargo [\"M16\", 10]",
"exres": "",
"lname": "unit",
"name": "addweaponcargo",
"op": "addweaponcargo",
"rname": "weapons",
"since": ""
}
],
"addWeaponCargoGlobal": [
{
"cat": "General",
"desc": "Adds weapons to the weapon cargo space. This is used for infantry weapons. MP synchronized. The format of weapons is [weaponName, count].\r\nFor weaponName values see <cl>CfgWeapons</cl>.",
"ex": "rearmTruckOne addWeaponCargo [\"M16\", 10]",
"exres": "",
"lname": "unit",
"name": "addweaponcargoglobal",
"op": "addweaponcargoglobal",
"rname": "weapons",
"since": ""
}
],
"addWeaponGlobal": [
{
"cat": "General",
"desc": "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.",
"ex": "player addWeaponGlobal \"AK74\"",
"exres": "",
"lname": "unit",
"name": "addweaponglobal",
"op": "addweaponglobal",
"rname": "weaponName",
"since": ""
}
],
"addWeaponItem": [
{
"cat": "General",
"desc": "Adds item to the weapon cargo space of a given weapon.",
"ex": "player addWeaponItem [\"WeaponClassName\",\"ItemClassName\"]",
"exres": "",
"lname": "unit",
"name": "addweaponitem",
"op": "addweaponitem",
"rname": "[weapon,item]",
"since": ""
}
],
"addWeaponTurret": [
{
"cat": "General",
"desc": "Adds the weapon to the given vehicle's turret. ",
"ex": "vehicle player addWeaponTurret [\"Horn\",[0,0]]",
"exres": "",
"lname": "vehicle",
"name": "addweaponturret",
"op": "addweaponturret",
"rname": "[weaponName,turret array]",
"since": ""
}
],
"aimedAtTarget": [
{
"cat": "General",
"desc": "Returns how good is weapon aimed to target.",
"ex": "bool = vehicle AimedAtTarget [target]; bool = vehicle AimedAtTarget [target,1]",
"exres": "",
"lname": "vehicle",
"name": "aimedattarget",
"op": "aimedattarget",
"rname": "[target, weapon]",
"since": "5501"
}
],
"allow3DMode": [
{
"cat": "Editor",
"desc": "Allow/dissallow 3D mode.",
"ex": "",
"exres": "",
"lname": "map",
"name": "allow3dmode",
"op": "allow3dmode",
"rname": "bool",
"since": "2.92"
}
],
"allowCrewInImmobile": [
{
"cat": "General",
"desc": "If true, units can be in vehicle with broken tracks/wheels.",
"ex": "vehicle allowCrewInImmobile true",
"exres": "",
"lname": "vehicle",
"name": "allowcrewinimmobile",
"op": "allowcrewinimmobile",
"rname": "bool",
"since": "86244"
}
],
"allowCuratorLogicIgnoreAreas": [
{
"cat": "General",
"desc": "Allow curator placing and working with modules outside of edit areas.",
"ex": "curator allowCuratorLogicIgnoreAreas true",
"exres": "",
"lname": "curatorObj",
"name": "allowcuratorlogicignoreareas",
"op": "allowcuratorlogicignoreareas",
"rname": "allow?",
"since": ""
}
],
"allowDamage": [
{
"cat": "General",
"desc": "Obsolete.",
"ex": "",
"exres": "",
"lname": "obj",
"name": "allowdamage",
"op": "allowdamage",
"rname": "allow",
"since": ""
}
],
"allowDammage": [
{
"cat": "General",
"desc": "Obsolete.",
"ex": "",
"exres": "",
"lname": "obj",
"name": "allowdammage",
"op": "allowdammage",
"rname": "allow",
"since": ""
}
],
"allowFileOperations": [
{
"cat": "Editor",
"desc": "Allow/dissallow file ops (load/save etc).",
"ex": "",
"exres": "",
"lname": "map",
"name": "allowfileoperations",
"op": "allowfileoperations",
"rname": "bool",
"since": "2.92"
}
],
"allowFleeing": [
{
"cat": "General",
"desc": "Sets the group courage. The less courage, the sooner the group will start fleeing. 0 means maximum courage, while 1 means always fleeing.",
"ex": "soldierOne allowFleeing 0",
"exres": "",
"lname": "unit",
"name": "allowfleeing",
"op": "allowfleeing",
"rname": "courage",
"since": ""
}
],
"allowGetIn": [
{
"cat": "General",
"desc": "Allows the getting in of vehicles of all units in the list.",
"ex": "[unitOne, unitTwo] allowGetIn false",
"exres": "",
"lname": "unitArray",
"name": "allowgetin",
"op": "allowgetin",
"rname": "allow",
"since": ""
}
],
"allowSprint": [
{
"cat": "General",
"desc": "Force player to run/jog if set to false.",
"ex": "player allowSprint false",
"exres": "",
"lname": "player",
"name": "allowsprint",
"op": "allowsprint",
"rname": "enabled",
"since": "129500"
}
],
"ammo": [
{
"cat": "General",
"desc": "Counts how many shots the unit has left for the currently loaded magazine of given muzzle type.",
"ex": "player ammo \"M16\"",
"exres": "",
"lname": "gunner or vehicle",
"name": "ammo",
"op": "ammo",
"rname": "muzzle",
"since": ""
}
],
"and": [
{
"cat": "Default",
"desc": "a and b",
"ex": "alive player and alive leader player",
"exres": "",
"lname": "a",
"name": "and",
"op": "and",
"rname": "b",
"since": ""
},
{
"cat": "Default",
"desc": "a and b, b evaluated only when a is true",
"ex": "alive player and alive leader player",
"exres": "",
"lname": "a",
"name": "and",
"op": "and",
"rname": "b",
"since": ""
}
],
"animate": [
{
"cat": "General",
"desc": "Process animation on object. Animation is defined in config file. Wanted animation phase is set to phase.",
"ex": "house animate [\"doors1\", 1]",
"exres": "",
"lname": "object",
"name": "animate",
"op": "animate",
"rname": "[animation, phase, instant = false or speedCoef = 1.0]",
"since": "1.75"
}
],
"animateDoor": [
{
"cat": "General",
"desc": "Process animation of door on vehicle. Animation is defined in config file. Wanted animation phase is set to phase.",
"ex": "heli animateDoor [\"doors1\", 1, false]",
"exres": "",
"lname": "object",
"name": "animatedoor",
"op": "animatedoor",
"rname": "[doorname, phase, now]",
"since": "TOH 83638"
}
],
"animateSource": [
{
"cat": "General",
"desc": "Process animation on object. Animation is defined by source name in model config.",
"ex": "house animateSource [\"AllDoors\", 1]",
"exres": "",
"lname": "object",
"name": "animatesource",
"op": "animatesource",
"rname": "[animation, phase, instant = false]",
"since": "134736"
}
],
"animationPhase": [
{
"cat": "General",
"desc": "Return animation phase of animation on object.",
"ex": "house animationPhase \"doors1\"",
"exres": "",
"lname": "object",
"name": "animationphase",
"op": "animationphase",
"rname": "animation",
"since": "1.75"
}
],
"animationSourcePhase": [
{
"cat": "General",
"desc": "Return animation phase (started by \"animateSource\") of animation on object.",
"ex": "house animationSourcePhase \"AllDoors\"",
"exres": "",
"lname": "object",
"name": "animationsourcephase",
"op": "animationsourcephase",
"rname": "animation",
"since": "134736"
}
],
"append": [
{
"cat": "Default",
"desc": "Appends arrayB to arrayA",
"ex": "arrayA=[0, 1]; arrayA append [2, 3]",
"exres": "[0, 1, 2, 3] in arrayA",
"lname": "arrayA",
"name": "append",
"op": "append",
"rname": "arrayB",
"since": ""
}
],
"apply": [
{
"cat": "Default",
"desc": "Applies code to each element of array and returns resulting array",
"ex": "[1,2,3] apply {_x * 2}",
"exres": "",
"lname": "array",
"name": "apply",
"op": "apply",
"rname": "code",
"since": ""
}
],
"arrayIntersect": [
{
"cat": "Default",
"desc": "Returns array containing common and also elements for both arrays",
"ex": "[1, 1, 2, 1, 5] arrayIntersect [1, 1, 2, 6]",
"exres": "[1, 2]",
"lname": "array",
"name": "arrayintersect",
"op": "arrayintersect",
"rname": "array",
"since": ""
}
],
"assignAsCargo": [
{
"cat": "General",
"desc": "Assigns the soldier to the cargo / passenger space of the given vehicle.",
"ex": "player assignAsCargo tankOne",
"exres": "",
"lname": "soldier",
"name": "assignascargo",
"op": "assignascargo",
"rname": "vehicle",
"since": ""
}
],
"assignAsCargoIndex": [
{
"cat": "General",
"desc": "Assigns the character to a specific cargo / passenger index of the given vehicle.",
"ex": "player assignAsCargoIndex [tankOne,1]",
"exres": "",
"lname": "soldier",
"name": "assignascargoindex",
"op": "assignascargoindex",
"rname": "[vehicle, index]",
"since": ""
}
],
"assignAsCommander": [
{
"cat": "General",
"desc": "Assigns the soldier as commander of the given vehicle.",
"ex": "player assignAsCommander tankOne",
"exres": "",
"lname": "soldier",
"name": "assignascommander",
"op": "assignascommander",
"rname": "vehicle",
"since": ""
}
],
"assignAsDriver": [
{
"cat": "General",
"desc": "Assigns the soldier as driver of the given vehicle.",
"ex": "player assignAsDriver tankOne",
"exres": "",
"lname": "soldier",
"name": "assignasdriver",
"op": "assignasdriver",
"rname": "vehicle",
"since": ""
}
],
"assignAsGunner": [
{
"cat": "General",
"desc": "Assigns the soldier as gunner of the given vehicle.",
"ex": "player assignAsGunner tankOne",
"exres": "",
"lname": "soldier",
"name": "assignasgunner",
"op": "assignasgunner",
"rname": "vehicle",
"since": ""
}
],
"assignAsTurret": [
{
"cat": "General",
"desc": "Assigns the soldier to turret.",
"ex": "player assignAsTurret [tankOne, [0,0]]",
"exres": "",
"lname": "unit",
"name": "assignasturret",
"op": "assignasturret",
"rname": "[vehicle, [turretPath]]",
"since": "82993 TOH"
}
],
"assignCurator": [
{
"cat": "General",
"desc": "Assign player as curator. 2 players cannot act as one Zeus.",
"ex": "player assignCurator curator",
"exres": "",
"lname": "player",
"name": "assigncurator",
"op": "assigncurator",
"rname": "curatorObj",
"since": ""
}
],
"assignItem": [
{
"cat": "General",
"desc": "Assigns existing item from inventory (uniform, vest, backpack) to a correct slot.",
"ex": "",
"exres": "",
"lname": "unit",
"name": "assignitem",
"op": "assignitem",
"rname": "item",
"since": ""
}
],
"assignTeam": [
{
"cat": "General",
"desc": "Assigns the vehicle (specifically its commander unit) to the given team. The possible team values are: \"MAIN\", \"RED\", \"GREEN\", \"BLUE\" and \"YELLOW\".",
"ex": "soldier2 assignTeam \"RED\"",
"exres": "",
"lname": "vehicle",
"name": "assignteam",
"op": "assignteam",
"rname": "team",
"since": "2.05"
}
],
"assignToAirport": [
{
"cat": "General",
"desc": "Set airport to be used by AI on getout",
"ex": "plane assignToAirport 0",
"exres": "",
"lname": "airplane",
"name": "assigntoairport",
"op": "assigntoairport",
"rname": "airportId",
"since": "2.92"
}
],
"atan2": [
{
"cat": "Default",
"desc": "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.",
"ex": "5 atan2 3",
"exres": "59.0362",
"lname": "x",
"name": "atan2",
"op": "atan2",
"rname": "y",
"since": ""
}
],
"attachObject": [
{
"cat": "Location",
"desc": "Attach a object to given location.",
"ex": "",
"exres": "",
"lname": "location",
"name": "attachobject",
"op": "attachobject",
"rname": "object",
"since": "2.90"
}
],
"attachTo": [
{
"cat": "General",
"desc": "Attaches an object to another object. The offset is applied to the object center unless a memory point is provided.",
"ex": "player attachTo [car, [0,2,0],hatch1]",
"exres": "",
"lname": "obj",
"name": "attachto",
"op": "attachto",
"rname": "[obj,offset,MemPoint]",
"since": "1.18"
}
],
"backpackSpaceFor": [
{
"cat": "General",
"desc": "Returns how much space is in backpack for given weapon or magazine.",
"ex": "[weapons, magazines] = backpack backpackSpaceFor \"m16\"",
"exres": "",
"lname": "backpack",
"name": "backpackspacefor",
"op": "backpackspacefor",
"rname": "weapon or magazine type",
"since": "5501"
}
],
"breakOut": [
{
"cat": "Default",
"desc": "Exits the given scope with given value",
"ex": "call {scopeName \"main\"; call {123 breakOut \"main\"}}",
"exres": "",
"lname": "anything",
"name": "breakout",
"op": "breakout",
"rname": "scopename",
"since": "1.75"
}
],
"buildingExit": [
{
"cat": "General",
"desc": "Returns the given indexed exit in a building. The returned value is in format <ar>Position</ar>.",
"ex": "buildingExit [building, 1]",
"exres": "",
"lname": "building",
"name": "buildingexit",
"op": "buildingexit",
"rname": "index",
"since": ""
}
],
"buildingPos": [
{
"cat": "General",
"desc": "Returns the given indexed position in a building. The returned value is in format <ar>Position</ar>.",
"ex": "building buildingPos 1",
"exres": "",
"lname": "building",
"name": "buildingpos",
"op": "buildingpos",
"rname": "index",
"since": ""
}
],
"buttonSetAction": [
{
"cat": "General",
"desc": "Assigns an action to the given button or active text. Action is any expression in this scripting language.",
"ex": "_control buttonSetAction \"player exec \"\"reply.sqs\"\"\"",
"exres": "",
"lname": "control",
"name": "buttonsetaction",
"op": "buttonsetaction",
"rname": "action",
"since": "2.91"
}
],
"call": [
{
"cat": "Default",
"desc": "Executes the function body. Argument pars is passed as _this.",
"ex": "[1,2] call {(_this select 0)+(_this select 1)}",
"exres": "3",
"lname": "pars",
"name": "call",
"op": "call",
"rname": "body",
"since": "1.85"
}
],
"callExtension": [
{
"cat": "General",
"desc": "Execute an extension function",
"ex": "handle = \"pipes\" callExtension \"openPipe(pipe)\"",
"exres": "",
"lname": "extension",
"name": "callextension",
"op": "callextension",
"rname": "functionWithArguments",
"since": ""
},
{
"cat": "General",
"desc": "Execute an extension function with additional arguments",
"ex": "handle = \"pipes\" callExtension [\"openPipe\",[arg1, ..., argN]]",
"exres": "",
"lname": "extension",
"name": "callextension",
"op": "callextension",
"rname": "functionWithArguments",
"since": ""
}
],
"camCommand": [
{
"cat": "General",
"desc": "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\".",
"ex": "_camera camCommand \"Manual on\"",
"exres": "",
"lname": "camera",
"name": "camcommand",
"op": "camcommand",
"rname": "command",
"since": ""
}
],
"camCommit": [
{
"cat": "General",
"desc": "Commits the camera changes smoothly over time. A time of zero results in an immediate change.",
"ex": "_camera camCommit 5",
"exres": "",
"lname": "camera",
"name": "camcommit",
"op": "camcommit",
"rname": "time",
"since": ""
}
],
"camCommitPrepared": [
{
"cat": "General",
"desc": "Commits the prepared camera changes smoothly over time. A time of zero results in an immediate change.",
"ex": "_camera camCommit 5",
"exres": "",
"lname": "camera",
"name": "camcommitprepared",
"op": "camcommitprepared",
"rname": "time",
"since": "2.95"
}
],
"camConstuctionSetParams": [
{
"cat": "General",
"desc": "Sets construction camera parameters.",
"ex": "_camera camConstuctionSetParams [getpos player,50,20]",
"exres": "",
"lname": "camera",
"name": "camconstuctionsetparams",
"op": "camconstuctionsetparams",
"rname": "[[x,y,z],radius, max above land]",
"since": "5501"
}
],
"camCreate": [
{
"cat": "General",
"desc": "Creates a camera or an actor of the given type on the given initial position (format <ar>Position</ar>). Its type is one of \"CAMERA\" or \"SEAGULL\".",
"ex": "_camera = camCreate getPos player",
"exres": "",
"lname": "type",
"name": "camcreate",
"op": "camcreate",
"rname": "position",
"since": ""
}
],
"camPreload": [
{
"cat": "General",
"desc": "Preload the scene for he prepared camera. Time gives timeout, zero means no (infinite) timeout.",
"ex": "_camera camCommit 5",
"exres": "",
"lname": "camera",
"name": "campreload",
"op": "campreload",
"rname": "time",
"since": "2.95"
}
],
"camPrepareBank": [
{
"cat": "General",
"desc": "Prepares the camera bank angle. See also <f>camPreload</f> and <f>camCommitPrepared</f>.",
"ex": "_camera camPrepareBank -0.1",
"exres": "",
"lname": "camera",
"name": "campreparebank",
"op": "campreparebank",
"rname": "bank",
"since": "2.95"
}
],
"camPrepareDir": [
{
"cat": "General",
"desc": "Prepares the camera heading. See also <f>camPreload</f> and <f>camCommitPrepared</f>.",
"ex": "_camera camPrepareDir 150",
"exres": "",
"lname": "camera",
"name": "campreparedir",
"op": "campreparedir",
"rname": "direction",
"since": "2.95"
}
],
"camPrepareDive": [
{
"cat": "General",
"desc": "Prepares the camera dive angle. See also <f>camPreload</f> and <f>camCommitPrepared</f>.",
"ex": "_camera camPrepareDive -0.1",
"exres": "",
"lname": "camera",
"name": "campreparedive",
"op": "campreparedive",
"rname": "dive",
"since": "2.95"
}
],
"camPrepareFocus": [
{
"cat": "General",
"desc": "focusRange is in format [distance,blur].\r\nPrepares the camera focus blur. See also <f>camPreload</f> and <f>camCommitPrepared</f>.",
"ex": "_camera camPrepareFocus [50, 1]",
"exres": "",
"lname": "camera",
"name": "campreparefocus",
"op": "campreparefocus",
"rname": "focusRange",
"since": "2.95"
}
],
"camPrepareFov": [
{
"cat": "General",
"desc": "Prepares the camera field of view (zoom). See also <f>camPreload</f> and <f>camCommitPrepared</f>.",
"ex": "_camera camPrepareFov 0.1",
"exres": "",
"lname": "camera",
"name": "campreparefov",
"op": "campreparefov",
"rname": "fieldOfView",
"since": "2.95"
}
],
"camPrepareFovRange": [
{
"cat": "General",
"desc": "Prepares the camera field of view range for auto zooming. See also <f>camPreload</f> and <f>camCommitPrepared</f>.",
"ex": "_camera camPrepareFovRange [0.1, 0.5]",
"exres": "",
"lname": "camera",
"name": "campreparefovrange",
"op": "campreparefovrange",
"rname": "fovRange",
"since": "2.95"
}
],
"camPreparePos": [
{
"cat": "General",
"desc": "Prepares the camera position (format <ar>Position</ar>). See also <f>camPreload</f> and <f>camCommitPrepared</f>.",
"ex": "_camera camPreparePos getPos player",
"exres": "",
"lname": "camera",
"name": "campreparepos",
"op": "campreparepos",
"rname": "position",
"since": "2.95"
}
],
"camPrepareRelPos": [
{
"cat": "General",
"desc": "Prepares the camera position relative to the current position of the currect target (see <f>camPrepareTarget</f>). See also <f>camPreload</f> and <f>camCommitPrepared</f>.",
"ex": "_camera camPrepareRelPos [10,5]",
"exres": "",
"lname": "camera",
"name": "campreparerelpos",
"op": "campreparerelpos",
"rname": "position",
"since": "2.95"
}
],
"camPrepareTarget": [
{
"cat": "General",
"desc": "Prepares the camera target. See also <f>camPreload</f> and <f>camCommitPrepared</f>.",
"ex": "_camera camPrepareTarget player",
"exres": "",
"lname": "camera",
"name": "campreparetarget",
"op": "campreparetarget",
"rname": "target",
"since": "2.95"
},
{
"cat": "General",
"desc": "Prepares the camera target to a position (format <ar>Position</ar>). See also <f>camPreload</f> and <f>camCommitPrepared</f>.",
"ex": "_camera camPrepareTarget getPos player",
"exres": "",
"lname": "camera",
"name": "campreparetarget",
"op": "campreparetarget",
"rname": "position",
"since": "2.95"
}
],
"camSetBank": [
{
"cat": "General",
"desc": "Sets the camera bank angle. It does not automatically commit changes.",
"ex": "_camera camSetBank -0.1",
"exres": "",
"lname": "camera",
"name": "camsetbank",
"op": "camsetbank",
"rname": "bank",
"since": ""
}
],
"camSetDir": [
{
"cat": "General",
"desc": "Sets the camera heading. It does not automatically commit changes.",
"ex": "_camera camSetDir [1, 0, 0]",
"exres": "",
"lname": "camera",
"name": "camsetdir",
"op": "camsetdir",
"rname": "direction",
"since": ""
}
],
"camSetDive": [
{
"cat": "General",
"desc": "Sets the camera dive angle. It does not automatically commit changes.",
"ex": "_camera camSetDive -0.1",
"exres": "",
"lname": "camera",
"name": "camsetdive",
"op": "camsetdive",
"rname": "dive",
"since": ""
}
],
"camSetFocus": [
{
"cat": "General",
"desc": "focusRange is in format [distance,blur].\r\nSets the camera focus blur. It does not automatically commit changes.",
"ex": "_camera camSetFocus [50, 1]",
"exres": "",
"lname": "camera",
"name": "camsetfocus",
"op": "camsetfocus",
"rname": "focusRange",
"since": ""
}
],
"camSetFov": [
{
"cat": "General",
"desc": "Sets the camera field of view (zoom). It does not automatically commit changes.",
"ex": "_camera camSetFov 0.1",
"exres": "",
"lname": "camera",
"name": "camsetfov",
"op": "camsetfov",
"rname": "fieldOfView",
"since": ""
}
],
"camSetFovRange": [
{
"cat": "General",
"desc": "Sets the camera field of view range for auto zooming. It does not automatically commit changes.",
"ex": "_camera camSetFovRange [0.1, 0.5]",
"exres": "",
"lname": "camera",
"name": "camsetfovrange",
"op": "camsetfovrange",
"rname": "fovRange",
"since": ""
}
],
"camSetPos": [
{
"cat": "General",
"desc": "Sets the camera position (format <ar>Position</ar>). It does not automatically commit changes.",
"ex": "_camera camSetPos getPos player",
"exres": "",
"lname": "camera",
"name": "camsetpos",
"op": "camsetpos",
"rname": "position",
"since": ""
}
],
"camSetRelPos": [
{
"cat": "General",
"desc": "Sets the camera position relative to the current position of the currect target (see <f>camSetTarget</f>). It does not automatically commit changes.",
"ex": "_camera camSetRelPos [10,5]",
"exres": "",
"lname": "camera",
"name": "camsetrelpos",
"op": "camsetrelpos",
"rname": "position",
"since": ""
}
],
"camSetTarget": [
{
"cat": "General",
"desc": "Sets the camera target. It does not automatically commit changes.",
"ex": "_camera camSetTarget player",
"exres": "",
"lname": "camera",
"name": "camsettarget",
"op": "camsettarget",
"rname": "target",
"since": ""
},
{
"cat": "General",
"desc": "Sets the camera target to a position (format <ar>Position</ar>). It does not automatically commit changes.",
"ex": "_camera camSetTarget getPos player",
"exres": "",
"lname": "camera",
"name": "camsettarget",
"op": "camsettarget",
"rname": "position",
"since": ""
}
],
"cameraEffect": [
{
"cat": "General",
"desc": "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).",
"ex": "cameraEffect [\"External\", \"Back\"]",
"exres": "",
"lname": "camera",
"name": "cameraeffect",
"op": "cameraeffect",
"rname": "effect",
"since": ""
}
],
"canAdd": [
{
"cat": "General",
"desc": "Check if given object(or group of objects) can be stored into target entity",
"ex": "",
"exres": "",
"lname": "unit",
"name": "canadd",
"op": "canadd",
"rname": "item",
"since": ""
}
],
"canAddItemToBackpack": [
{
"cat": "General",
"desc": "Check if given object(or group of objects) can be stored into soldier's uniform",
"ex": "",
"exres": "",
"lname": "unit",
"name": "canadditemtobackpack",
"op": "canadditemtobackpack",
"rname": "item",
"since": ""
}
],
"canAddItemToUniform": [
{
"cat": "General",
"desc": "Check if given object(or group of objects) can be stored into soldier's uniform",
"ex": "",
"exres": "",
"lname": "unit",
"name": "canadditemtouniform",
"op": "canadditemtouniform",
"rname": "item",
"since": ""
}
],
"canAddItemToVest": [
{
"cat": "General",
"desc": "Check if given object(or group of objects) can be stored into soldier's uniform",
"ex": "",
"exres": "",
"lname": "unit",
"name": "canadditemtovest",
"op": "canadditemtovest",
"rname": "item",
"since": ""
}
],
"canSlingLoad": [
{
"cat": "General",
"desc": "Returns true if it is possible to sling load cargo",
"ex": "veh1 canSlingLoad veh2",
"exres": "",
"lname": "vehicle",
"name": "canslingload",
"op": "canslingload",
"rname": "cargo",
"since": "127138"
}
],
"canVehicleCargo": [
{
"cat": "General",
"desc": "Returns bool array if it is possible to load cargo inside vehicle and if possible to load cargo into empty vehicle",
"ex": "veh canVehicleCargo cargo",
"exres": "",
"lname": "vehicle",
"name": "canvehiclecargo",
"op": "canvehiclecargo",
"rname": "cargo",
"since": "134497"
}
],
"catch": [
{
"cat": "Default",
"desc": "processes code, when exception is thrown in <f>try</f> block",
"ex": "",
"exres": "",
"lname": "try-Block",
"name": "catch",
"op": "catch",
"rname": "code",
"since": ""
}
],
"cbSetChecked": [
{
"cat": "General",
"desc": "Sets the current state of CheckBox.",
"ex": "_myCheckBox cbSetChecked true;",
"exres": "",
"lname": "control",
"name": "cbsetchecked",
"op": "cbsetchecked",
"rname": "enabled",
"since": "2.50"
}
],
"checkVisibility": [
{
"cat": "General",
"desc": "Check visibility between two points. ",
"ex": "visibility = [unit, \"VIEW\"] checkVisibility [[1500, 1500, 2], [1550, 1500, 2]]",
"exres": "",
"lname": "[ignored object, lod name, (ignored object 2)]",
"name": "checkvisibility",
"op": "checkvisibility",
"rname": "[begin, end]",
"since": "12532"
}
],
"clear3DENAttribute": [
{
"cat": "General",
"desc": "Returns TRUE if change was processed.",
"ex": "0 set3DENAttribute [\"Name\", \"MyEntity\"]",
"exres": "",
"lname": "<entity>",
"name": "clear3denattribute",
"op": "clear3denattribute",
"rname": "<attributeType>",
"since": ""
}
],
"closeDisplay": [
{
"cat": "General",
"desc": "Close given display.",
"ex": "_display closeDisplay IDC_OK",
"exres": "",
"lname": "display",
"name": "closedisplay",
"op": "closedisplay",
"rname": "exitcode",
"since": "2.53"
}
],
"commandArtilleryFire": [
{
"cat": "General",
"desc": "Orders a unit to reaload defined magazine commence fire burst on the given position (via the radio).",
"ex": "mortar1 commandArtilleryFire [[3000, 120, 1000], \"8Rnd_82mm_Mo_shells\", 3]",
"exres": "",
"lname": "unit",
"name": "commandartilleryfire",
"op": "commandartilleryfire",
"rname": "[position, type, rounds]",
"since": ""
}
],
"commandChat": [
{
"cat": "General",
"desc": "Types text to the command radio channel.\r\nNote: 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.",
"ex": "soldierOne commandChat \"Show this text\"",
"exres": "",
"lname": "unit",
"name": "commandchat",
"op": "commandchat",
"rname": "chatText",
"since": "5501"
}
],
"commandFSM": [
{
"cat": "General",
"desc": "Orders a unit to process command defined by FSM file (via the radio).",
"ex": "soldierOne commandFSM [\"move.fsm\", position player, player]",
"exres": "",
"lname": "unit(s)",
"name": "commandfsm",
"op": "commandfsm",
"rname": "[fsm name, position, target]",
"since": "2.53"
}
],
"commandFire": [
{
"cat": "General",
"desc": "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).",
"ex": "soldierOne commandFire player",
"exres": "",
"lname": "unit",
"name": "commandfire",
"op": "commandfire",
"rname": "target",
"since": ""
}
],
"commandFollow": [
{
"cat": "General",
"desc": "Orders a unit to follow the given unit (via the radio).",
"ex": "soldierOne commandFollow player",
"exres": "",
"lname": "unit",
"name": "commandfollow",
"op": "commandfollow",
"rname": "formationLeader",
"since": ""
}
],
"commandMove": [
{
"cat": "General",
"desc": "Orders the unit to move to the given position (format <ar>Position</ar>) (via the radio).",
"ex": "soldierOne commandMove getMarkerPos \"MarkerMoveOne\"",
"exres": "",
"lname": "unit",
"name": "commandmove",
"op": "commandmove",
"rname": "position",
"since": ""
}
],
"commandRadio": [
{
"cat": "General",
"desc": "Sends the message to the command radio channel. The message is defined in the description.ext file or radio protocol.",
"ex": "soldierOne commandRadio \"messageOne\"",
"exres": "",
"lname": "unit",
"name": "commandradio",
"op": "commandradio",
"rname": "radioName",
"since": "5501"
}
],
"commandSuppressiveFire": [
{
"cat": "General",
"desc": "Orders a unit to suppress given position or target (via the radio).",
"ex": "soldier commandSuppressiveFire [3000, 120, 1000]",
"exres": "",
"lname": "unit",
"name": "commandsuppressivefire",
"op": "commandsuppressivefire",
"rname": "position or target",
"since": ""
}
],
"commandTarget": [
{
"cat": "General",
"desc": "Orders the unit to target the given target (via the radio).",
"ex": "soldierOne commandTarget player",
"exres": "",
"lname": "unit",
"name": "commandtarget",
"op": "commandtarget",
"rname": "position",
"since": ""
}
],
"commandWatch": [
{
"cat": "General",
"desc": "Orders the unit to watch the given position (format <ar>Position</ar>) (via the radio).",
"ex": "soldierOne commandWatch getMarkerPos \"MarkerMoveOne\"",
"exres": "",
"lname": "unit",
"name": "commandwatch",
"op": "commandwatch",
"rname": "position",
"since": ""
},
{
"cat": "General",
"desc": "Orders the unit to watch the given target (via the radio).",
"ex": "soldierOne commandWatch player",
"exres": "",
"lname": "unit",
"name": "commandwatch",
"op": "commandwatch",
"rname": "target",
"since": ""
}
],
"configClasses": [
{
"cat": "General",
"desc": "Returns an array of config entries which meet the criteria in the code.",
"ex": "(getnumber _x >> vbs_entity) == 1 configClasses (configfile >> CfgWeapons)",
"exres": "",
"lname": "condition",
"name": "configclasses",
"op": "configclasses",
"rname": "config",
"since": "2.35"
}
],
"connectTerminalToUAV": [
{
"cat": "General",
"desc": "Connect person with UAV terminal to UAV unit, or disconnect when UAV==objNull",
"ex": "player connectTerminalToUAV cursorTarget/objNull",
"exres": "",
"lname": "person",
"name": "connectterminaltouav",
"op": "connectterminaltouav",
"rname": "UAV",
"since": "106264"
}
],
"controlsGroupCtrl": [
{
"cat": "General",
"desc": "Return child control with specified idc.",
"ex": "_control = _controlsGroup controlsGroupCtrl 101",
"exres": "",
"lname": "controlsGroup",
"name": "controlsgroupctrl",
"op": "controlsgroupctrl",
"rname": "idc",
"since": "2.50"
}
],
"copyWaypoints": [
{
"cat": "General",
"desc": "Copy the chain of waypoints from source to target group. The target group will start to process waypoints from the first one.",
"ex": "",
"exres": "",
"lname": "groupTo",
"name": "copywaypoints",
"op": "copywaypoints",
"rname": "groupFrom",
"since": "5500"
}
],
"count": [
{
"cat": "Default",
"desc": "Counts the elements in the array for which the given condition is true.\r\n\r\nIt is calculated as follows:\r\n\r\n1) Set the count to 0.\r\n2) For each element in the array assign an element as _x and evaluate the condition expression. If it's true, increase the count.",
"ex": "\"_x > 2\" count [0, 1, 1, 2, 3, 3]",
"exres": "2",
"lname": "condition",
"name": "count",
"op": "count",
"rname": "array",
"since": ""
}
],
"countEnemy": [
{
"cat": "General",
"desc": "Counts how many units in the array are considered enemy by the given unit.",
"ex": "player countEnemy list triggerOne",
"exres": "",
"lname": "unit",
"name": "countenemy",
"op": "countenemy",
"rname": "array",
"since": ""
}
],
"countFriendly": [
{
"cat": "General",
"desc": "Counts how many units in the array are considered friendly by the given unit.",
"ex": "player countFriendly list triggerOne",
"exres": "",
"lname": "unit",
"name": "countfriendly",
"op": "countfriendly",
"rname": "array",
"since": ""
}
],
"countSide": [
{
"cat": "General",
"desc": "Checks how many vehicles belong to the given side.",
"ex": "west countSide list triggerOne",
"exres": "",
"lname": "side",
"name": "countside",
"op": "countside",
"rname": "array",
"since": ""
}
],
"countType": [
{
"cat": "General",
"desc": "Counts how many vehicles in the array are of the given type. For types see <cl>CfgVehicles</cl>.",
"ex": "\"Tank\" countType list triggerOne",
"exres": "",
"lname": "typeName",
"name": "counttype",
"op": "counttype",
"rname": "array",
"since": ""
}
],
"countUnknown": [
{
"cat": "General",
"desc": "Counts how many units in the array are considered unknown to the given unit.",
"ex": "player countUnknown list triggerOne",
"exres": "",
"lname": "unit",
"name": "countunknown",
"op": "countunknown",
"rname": "array",
"since": ""
}
],
"create3DENEntity": [
{
"cat": "General",
"desc": "Creates new entity of given (entity mode) in 3DEN inside given group",
"ex": "(group player) create3DENEntity [\"Object\", \"B_Soldier_F\", position player]",
"exres": "",
"lname": "<group>",
"name": "create3denentity",
"op": "create3denentity",
"rname": "[<mode>, <className>, <position>]",
"since": ""
}
],
"createDiaryRecord": [
{
"cat": "Identity",
"desc": "Create a new record in a log.",
"ex": "_record = player createDiaryRecord [\"diary\", \"Kill all enemies.\"]",
"exres": "",
"lname": "person",
"name": "creatediaryrecord",
"op": "creatediaryrecord",
"rname": "[subject, text(, task(, state))] or [subject, [title, text](, task(, state))]",
"since": "2.53"
}
],
"createDiarySubject": [
{
"cat": "Identity",
"desc": "Create a new subject page in a log.",
"ex": "_index = player createDiarySubject [\"myPage\", \"My page\"]",
"exres": "",
"lname": "person",
"name": "creatediarysubject",
"op": "creatediarysubject",
"rname": "[subject, display name] or [subject, display name, picture]",
"since": "2.92"
}
],
"createDisplay": [
{
"cat": "General",
"desc": "Create child display of given display and load from resource \"name\".",
"ex": "_display createDisplay \"RscObserver\"",
"exres": "",
"lname": "parent",
"name": "createdisplay",
"op": "createdisplay",
"rname": "name",
"since": "2.53"
}
],
"createMPCampaignDisplay": [
{
"cat": "General",
"desc": "Create a MP campaign display.",
"ex": "(findDisplay 0) createMPMissionsDisplay \"Apex_Protocol\";",
"exres": "",
"lname": "parentDisplay",
"name": "creatempcampaigndisplay",
"op": "creatempcampaigndisplay",
"rname": "folderClass",
"since": ""
}
],
"createMenu": [
{
"cat": "Editor",
"desc": "Creates a previously added menu.",
"ex": "",
"exres": "",
"lname": "map",
"name": "createmenu",
"op": "createmenu",
"rname": "index",
"since": "2.92"
}
],
"createMissionDisplay": [
{
"cat": "General",
"desc": "Create single missions display as a child of given display. The mission dialog will be set to the directory given as an argument \"root\".",
"ex": "_display createMissionDisplay \"Test missions\"",
"exres": "",
"lname": "parent",
"name": "createmissiondisplay",
"op": "createmissiondisplay",
"rname": "root",
"since": "5140"
},
{
"cat": "General",
"desc": "Create single missions display as a child of given display. The mission dialog will be set to the directory given as an argument \"root\". Mission space defines container's config class name.",
"ex": "_display createMissionDisplay [\"\",\"Tutorial\"]",
"exres": "",
"lname": "parent",
"name": "createmissiondisplay",
"op": "createmissiondisplay",
"rname": "[root, missions space]",
"since": "5140"
}
],
"createSimpleTask": [
{
"cat": "Identity",
"desc": "Create a new simple task (subtask of parentTask).",
"ex": "",
"exres": "",
"lname": "person",
"name": "createsimpletask",
"op": "createsimpletask",
"rname": "[name] or [name, parentTask]",
"since": "5500"
}
],
"createSite": [
{
"cat": "General",
"desc": "OBSOLETE DO NOT USE!!! Creates a new site.",
"ex": "",
"exres": "",
"lname": "type",
"name": "createsite",
"op": "createsite",
"rname": "pos",
"since": "1.34"
}
],
"createTask": [
{
"cat": "Identity",
"desc": "Create a new AI task (subtask of parentTask). Type is name of registered task type.",
"ex": "",
"exres": "",
"lname": "teamMember",
"name": "createtask",
"op": "createtask",
"rname": "[[type] or [type, parentTask], priority, name1, value1, name2, value2, ...]",
"since": "2.62"
}
],
"createUnit": [
{
"cat": "General",
"desc": "Creates a unit of the given type. The format of unitInfo is:\r\n[pos (<ar>Position</ar>), group (<t>Group</t>), init (<t>String</t>), skill (<t>Number</t>), rank (<t>String</t>)].\r\nNote: init, skill and rank are optional. Their default values are \"\", 0.5, \"PRIVATE\".",
"ex": "\"SoldierWB\" createUnit [getMarkerPos \"barracks\", groupAlpha]",
"exres": "",
"lname": "type",
"name": "createunit",
"op": "createunit",
"rname": "unitInfo",
"since": "1.34"
},
{
"cat": "General",
"desc": "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\".",
"ex": "unit = group player createUnit [\"SoldierWB\", position player, [], 0, \"FORM\"]",
"exres": "",
"lname": "group",
"name": "createunit",
"op": "createunit",
"rname": "[type, position, markers, placement, special]",
"since": "2.32"
}
],
"createVehicle": [
{
"cat": "General",
"desc": "Creates an empty vehicle of the given type. Pos is in format <ar>Position</ar>.\r\nSee <cl>CfgVehicles</cl> for possible type values.",
"ex": "_tank = \"M1Abrams\" createVehicle getmarkerpos \"tankFactory\"",
"exres": "",
"lname": "type",
"name": "createvehicle",
"op": "createvehicle",
"rname": "pos",
"since": "1.34"
}
],
"createVehicleLocal": [
{
"cat": "General",
"desc": "Creates an empty vehicle of the given type. Pos is in format <ar>Position</ar>.\r\nSee <cl>CfgVehicles</cl> for possible type values. Vehicle is not transferred through network in MP games.",
"ex": "_tank = \"M1Abrams\" createVehicleLocal getmarkerpos \"tankFactory\"",
"exres": "",
"lname": "type",
"name": "createvehiclelocal",
"op": "createvehiclelocal",
"rname": "pos",
"since": "2.56"
}
],
"ctrlAddEventHandler": [
{
"cat": "General",
"desc": "Add an event handler to the given control. Returns id of the handler or -1 when failed.",
"ex": "_id = _control ctrlAddEventHandler [\"KeyDown\", \"\"]",
"exres": "",
"lname": "control",
"name": "ctrladdeventhandler",
"op": "ctrladdeventhandler",
"rname": "[handler name, function]",
"since": "5501"
}
],
"ctrlCommit": [
{
"cat": "General",
"desc": "Commit control animation.",
"ex": "_control ctrlCommit 2",
"exres": "",
"lname": "control",
"name": "ctrlcommit",
"op": "ctrlcommit",
"rname": "time",
"since": "2.50"
}
],
"ctrlCreate": [
{
"cat": "General",
"desc": "Creates new control in given display. The control is created in given groupControl (optional)",
"ex": "ctrl ctrlCreate [\"RscText\", 1234]",
"exres": "",
"lname": "parent_display",
"name": "ctrlcreate",
"op": "ctrlcreate",
"rname": "[baseClass, idc, groupControl]",
"since": "2.35"
}
],
"ctrlEnable": [
{
"cat": "General",
"desc": "Enable / disable given control.",
"ex": "_control ctrlEnable false",
"exres": "",
"lname": "control",
"name": "ctrlenable",
"op": "ctrlenable",
"rname": "enable",
"since": "2.50"
}
],
"ctrlMapAnimAdd": [
{
"cat": "General",
"desc": "Adds the next frame to the map animation. The format of frame is [time, zoom, position], the format of position is <ar>Position2D</ar>.",
"ex": "_map ctrlMapAnimAdd [1, 0.1, getMarkerPos \"anim1\"]",
"exres": "",
"lname": "map",
"name": "ctrlmapanimadd",
"op": "ctrlmapanimadd",
"rname": "frame",
"since": "1.92"
}
],
"ctrlMapCursor": [
{
"cat": "General",
"desc": "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.",
"ex": "<map_control> ctrlMapCursor [\"Track\",\"customCursor\"]",
"exres": "",
"lname": "control",
"name": "ctrlmapcursor",
"op": "ctrlmapcursor",
"rname": "texture names",
"since": "5501"
}
],
"ctrlMapScreenToWorld": [
{
"cat": "General",
"desc": "Convert position in the map from screen coordinates to world coordinates.",
"ex": "",
"exres": "",
"lname": "map",
"name": "ctrlmapscreentoworld",
"op": "ctrlmapscreentoworld",
"rname": "[x, y]",
"since": "5127"
}
],
"ctrlMapWorldToScreen": [
{
"cat": "General",
"desc": "Convert position in the map from world coordinates to screen coordinates.",
"ex": "",
"exres": "",
"lname": "map",
"name": "ctrlmapworldtoscreen",
"op": "ctrlmapworldtoscreen",
"rname": "position",
"since": "5127"
}
],
"ctrlRemoveAllEventHandlers": [
{
"cat": "General",
"desc": "Remove all even handlers from the given control.",
"ex": "_control ctrlRemoveAllEventHandlers \"KeyDown\"",
"exres": "",
"lname": "control",
"name": "ctrlremovealleventhandlers",
"op": "ctrlremovealleventhandlers",
"rname": "handler name",
"since": "5501"
}
],
"ctrlRemoveEventHandler": [
{
"cat": "General",
"desc": "Remove a given event handler from the given control.",
"ex": "_control ctrlRemoveEventHandler [\"KeyDown\", 0]",
"exres": "",
"lname": "control",
"name": "ctrlremoveeventhandler",
"op": "ctrlremoveeventhandler",
"rname": "[handler name, id]",
"since": "5501"
}
],
"ctrlSetActiveColor": [
{
"cat": "General",
"desc": "Sets text color of given control when control is selected. Color is in format <ar>Color</ar>.",
"ex": "_control ctrlSetActiveColor [1, 0, 0, 1]",
"exres": "",
"lname": "display",
"name": "ctrlsetactivecolor",
"op": "ctrlsetactivecolor",
"rname": "color",
"since": "2.50"
}
],
"ctrlSetAngle": [
{
"cat": "General",
"desc": "Sets the rotation of the control.",
"ex": "_control ctrlSetAngle [25, 0.5, 0.5]",
"exres": "",
"lname": "control",
"name": "ctrlsetangle",
"op": "ctrlsetangle",
"rname": "[angle, xCenter, yCenter]",
"since": "2.50"
}
],
"ctrlSetAutoScrollDelay": [
{
"cat": "General",
"desc": "Sets number of second before auto-scroll starts.",
"ex": "_control ctrlSetAutoScrollDelay 5",
"exres": "",
"lname": "control",
"name": "ctrlsetautoscrolldelay",
"op": "ctrlsetautoscrolldelay",
"rname": "delay",
"since": "5501"
}
],
"ctrlSetAutoScrollRewind": [
{
"cat": "General",
"desc": "Defines if scroll should rewind when auto-scroll reach end.",
"ex": "_control ctrlSetAutoScrollDelay 5",
"exres": "",
"lname": "control",
"name": "ctrlsetautoscrollrewind",
"op": "ctrlsetautoscrollrewind",
"rname": "delay",
"since": "5501"
}
],
"ctrlSetAutoScrollSpeed": [
{
"cat": "General",
"desc": "Sets number of second required to scroll to next line. If speed smaller than 0, auto-scroll is disabled.",
"ex": "_control ctrlSetAutoScrollSpeed 5",
"exres": "",
"lname": "control",
"name": "ctrlsetautoscrollspeed",
"op": "ctrlsetautoscrollspeed",
"rname": "speed",
"since": "5501"
}
],
"ctrlSetBackgroundColor": [
{
"cat": "General",
"desc": "Sets background color of given control. Color is in format <ar>Color</ar>.",
"ex": "_control ctrlSetBackgroundColor [1, 0, 0, 1]",
"exres": "",
"lname": "display",
"name": "ctrlsetbackgroundcolor",
"op": "ctrlsetbackgroundcolor",
"rname": "color",
"since": "2.50"
}
],
"ctrlSetChecked": [
{
"cat": "General",
"desc": "Sets checked state of checkbox.",
"ex": "_control ctrlSetChecked true",
"exres": "",
"lname": "control",
"name": "ctrlsetchecked",
"op": "ctrlsetchecked",
"rname": "enabled",
"since": "2.50"
}
],
"ctrlSetDisabledColor": [
{
"cat": "General",
"desc": "Sets text color of given control when control is disabled. Color is in format <ar>Color</ar>.",
"ex": "_control ctrlSetDisabledColor [1, 0, 0, 1]",
"exres": "",
"lname": "control",
"name": "ctrlsetdisabledcolor",
"op": "ctrlsetdisabledcolor",
"rname": "color",
"since": ""
}
],
"ctrlSetEventHandler": [
{
"cat": "General",
"desc": "Sets given event handler of given control",
"ex": "_control ctrlSetEventHandler [\"KeyDown\", \"\"]",
"exres": "",
"lname": "control",
"name": "ctrlseteventhandler",
"op": "ctrlseteventhandler",
"rname": "[handler name, function]",
"since": "2.54"
}
],
"ctrlSetFade": [
{
"cat": "General",
"desc": "Sets wanted transparency for control animation.",
"ex": "_control ctrlSetFade 1",
"exres": "",
"lname": "control",
"name": "ctrlsetfade",
"op": "ctrlsetfade",
"rname": "fade",
"since": "2.50"
}
],
"ctrlSetFont": [
{
"cat": "General",
"desc": "Sets the main font of given control.",
"ex": "_control ctrlSetFont \"TahomaB\"",
"exres": "",
"lname": "control",
"name": "ctrlsetfont",
"op": "ctrlsetfont",
"rname": "name",
"since": "2.50"
}
],
"ctrlSetFontH1": [
{
"cat": "General",
"desc": "Sets H1 font of given HTML control.",
"ex": "_control ctrlSetFontH1 \"TahomaB\"",
"exres": "",
"lname": "control",
"name": "ctrlsetfonth1",
"op": "ctrlsetfonth1",
"rname": "name",
"since": "2.50"
}
],
"ctrlSetFontH1B": [
{
"cat": "General",
"desc": "Sets H1 bold font of given HTML control.",
"ex": "_control ctrlSetFontH1B \"TahomaB\"",
"exres": "",
"lname": "control",
"name": "ctrlsetfonth1b",
"op": "ctrlsetfonth1b",
"rname": "name",
"since": "2.50"
}
],
"ctrlSetFontH2": [
{
"cat": "General",
"desc": "Sets H2 font of given HTML control.",
"ex": "_control ctrlSetFontH2 \"TahomaB\"",
"exres": "",
"lname": "control",
"name": "ctrlsetfonth2",
"op": "ctrlsetfonth2",
"rname": "name",
"since": "2.50"
}
],
"ctrlSetFontH2B": [
{
"cat": "General",
"desc": "Sets H2 bold font of given HTML control.",
"ex": "_control ctrlSetFontH2B \"TahomaB\"",
"exres": "",
"lname": "control",
"name": "ctrlsetfonth2b",
"op": "ctrlsetfonth2b",
"rname": "name",
"since": "2.50"
}
],
"ctrlSetFontH3": [
{
"cat": "General",
"desc": "Sets H3 font of given HTML control.",
"ex": "_control ctrlSetFontH3 \"TahomaB\"",
"exres": "",
"lname": "control",
"name": "ctrlsetfonth3",
"op": "ctrlsetfonth3",
"rname": "name",
"since": "2.50"
}
],
"ctrlSetFontH3B": [
{
"cat": "General",
"desc": "Sets H3 bold font of given HTML control.",
"ex": "_control ctrlSetFontH3B \"TahomaB\"",
"exres": "",
"lname": "control",
"name": "ctrlsetfonth3b",
"op": "ctrlsetfonth3b",
"rname": "name",
"since": "2.50"
}
],
"ctrlSetFontH4": [
{
"cat": "General",
"desc": "Sets H4 font of given HTML control.",
"ex": "_control ctrlSetFontH4 \"TahomaB\"",
"exres": "",
"lname": "control",
"name": "ctrlsetfonth4",
"op": "ctrlsetfonth4",
"rname": "name",
"since": "2.50"
}
],
"ctrlSetFontH4B": [
{
"cat": "General",
"desc": "Sets H4 bold font of given HTML control.",
"ex": "_control ctrlSetFontH4B \"TahomaB\"",
"exres": "",
"lname": "control",
"name": "ctrlsetfonth4b",
"op": "ctrlsetfonth4b",
"rname": "name",
"since": "2.50"
}
],
"ctrlSetFontH5": [
{
"cat": "General",
"desc": "Sets H5 font of given HTML control.",
"ex": "_control ctrlSetFontH5 \"TahomaB\"",
"exres": "",
"lname": "control",
"name": "ctrlsetfonth5",
"op": "ctrlsetfonth5",
"rname": "name",
"since": "2.50"
}
],
"ctrlSetFontH5B": [
{
"cat": "General",
"desc": "Sets H5 bold font of given HTML control.",
"ex": "_control ctrlSetFontH5B \"TahomaB\"",
"exres": "",
"lname": "control",
"name": "ctrlsetfonth5b",
"op": "ctrlsetfonth5b",
"rname": "name",
"since": "2.50"
}
],
"ctrlSetFontH6": [
{
"cat": "General",
"desc": "Sets H5 font of given HTML control.",
"ex": "_control ctrlSetFontH6 \"TahomaB\"",
"exres": "",
"lname": "control",
"name": "ctrlsetfonth6",
"op": "ctrlsetfonth6",
"rname": "name",
"since": "2.50"
}
],
"ctrlSetFontH6B": [
{
"cat": "General",
"desc": "Sets H6 bold font of given HTML control.",
"ex": "_control ctrlSetFontH6B \"TahomaB\"",
"exres": "",
"lname": "control",
"name": "ctrlsetfonth6b",
"op": "ctrlsetfonth6b",
"rname": "name",
"since": "2.50"
}
],
"ctrlSetFontHeight": [
{
"cat": "General",
"desc": "Sets the main font size of given control.",
"ex": "_control ctrlSetFontHeight 0.05",
"exres": "",
"lname": "control",
"name": "ctrlsetfontheight",
"op": "ctrlsetfontheight",
"rname": "height",
"since": "2.50"
}
],
"ctrlSetFontHeightH1": [
{
"cat": "General",
"desc": "Sets H1 font size of given HTML control.",
"ex": "_control ctrlSetFontHeightH1 0.05",
"exres": "",
"lname": "control",
"name": "ctrlsetfontheighth1",
"op": "ctrlsetfontheighth1",
"rname": "height",
"since": "2.50"
}
],
"ctrlSetFontHeightH2": [
{
"cat": "General",
"desc": "Sets H2 font size of given HTML control.",
"ex": "_control ctrlSetFontHeightH2 0.05",
"exres": "",
"lname": "control",
"name": "ctrlsetfontheighth2",
"op": "ctrlsetfontheighth2",
"rname": "height",
"since": "2.50"
}
],
"ctrlSetFontHeightH3": [
{
"cat": "General",
"desc": "Sets H3 font size of given HTML control.",
"ex": "_control ctrlSetFontHeightH3 0.05",
"exres": "",
"lname": "control",
"name": "ctrlsetfontheighth3",
"op": "ctrlsetfontheighth3",
"rname": "height",
"since": "2.50"
}
],
"ctrlSetFontHeightH4": [
{
"cat": "General",
"desc": "Sets H4 font size of given HTML control.",
"ex": "_control ctrlSetFontHeightH4 0.05",
"exres": "",
"lname": "control",
"name": "ctrlsetfontheighth4",
"op": "ctrlsetfontheighth4",
"rname": "height",
"since": "2.50"
}
],
"ctrlSetFontHeightH5": [
{
"cat": "General",
"desc": "Sets H5 font size of given HTML control.",
"ex": "_control ctrlSetFontHeightH5 0.05",
"exres": "",
"lname": "control",
"name": "ctrlsetfontheighth5",
"op": "ctrlsetfontheighth5",
"rname": "height",
"since": "2.50"
}
],
"ctrlSetFontHeightH6": [
{
"cat": "General",
"desc": "Sets H6 font size of given HTML control.",
"ex": "_control ctrlSetFontHeightH6 0.05",
"exres": "",
"lname": "control",
"name": "ctrlsetfontheighth6",
"op": "ctrlsetfontheighth6",
"rname": "height",
"since": "2.50"
}
],
"ctrlSetFontHeightSecondary": [
{
"cat": "General",
"desc": "Sets the font size of the secondary text of given control.",
"ex": "_control ctrlSetFontHeightSecondary 0.05",
"exres": "",
"lname": "control",
"name": "ctrlsetfontheightsecondary",
"op": "ctrlsetfontheightsecondary",
"rname": "height",
"since": ""
}
],
"ctrlSetFontP": [
{
"cat": "General",
"desc": "Sets P font of given HTML control.",
"ex": "_control ctrlSetFontP \"TahomaB\"",
"exres": "",
"lname": "control",
"name": "ctrlsetfontp",
"op": "ctrlsetfontp",
"rname": "name",
"since": "2.50"
},
{
"cat": "General",
"desc": "Sets P font size of given HTML control.",
"ex": "_control ctrlSetFontHeightP 0.05",
"exres": "",
"lname": "control",
"name": "ctrlsetfontp",
"op": "ctrlsetfontp",
"rname": "height",
"since": "2.50"
}
],
"ctrlSetFontPB": [
{
"cat": "General",
"desc": "Sets P bold font of given HTML control.",
"ex": "_control ctrlSetFontPB \"TahomaB\"",
"exres": "",
"lname": "control",
"name": "ctrlsetfontpb",
"op": "ctrlsetfontpb",
"rname": "name",
"since": "2.50"
}
],
"ctrlSetFontSecondary": [
{
"cat": "General",
"desc": "Sets the font of the secondary text in given control.",
"ex": "_control ctrlSetFontSecondary \"TahomaB\"",
"exres": "",
"lname": "control",
"name": "ctrlsetfontsecondary",
"op": "ctrlsetfontsecondary",
"rname": "name",
"since": ""
}
],
"ctrlSetForegroundColor": [
{
"cat": "General",
"desc": "Sets background color of given control. Color is in format <ar>Color</ar>.",
"ex": "_control ctrlSetForegroundColor [1, 0, 0, 1]",
"exres": "",
"lname": "display",
"name": "ctrlsetforegroundcolor",
"op": "ctrlsetforegroundcolor",
"rname": "color",
"since": "2.50"
}
],
"ctrlSetModel": [
{
"cat": "General",
"desc": "Sets model to draw as control object.",
"ex": "ctrl ctrlSetModel \"\\a3\\Ui_f\\objects\\Compass.p3d\"",
"exres": "",
"lname": "ctrl",
"name": "ctrlsetmodel",
"op": "ctrlsetmodel",
"rname": "model",
"since": "2.35"
}
],
"ctrlSetModelDirAndUp": [
{
"cat": "General",
"desc": "Sets orientation to control object.",
"ex": "ctrl ctrlSetDirection [dir, up]",
"exres": "",
"lname": "ctrl",
"name": "ctrlsetmodeldirandup",
"op": "ctrlsetmodeldirandup",
"rname": "[direction, up]",
"since": "2.35"
}
],
"ctrlSetModelScale": [
{
"cat": "General",
"desc": "Sets given scale into control.",
"ex": "ctrl ctrlSetModelScale 1",
"exres": "",
"lname": "ctrl",
"name": "ctrlsetmodelscale",
"op": "ctrlsetmodelscale",
"rname": "scale",
"since": "2.35"
}
],
"ctrlSetPosition": [
{
"cat": "General",
"desc": "Sets wanted position and size for control animation. Width and height are optional.",
"ex": "_control ctrlSetPosition [0.5, 0.5]",
"exres": "",
"lname": "control",
"name": "ctrlsetposition",
"op": "ctrlsetposition",
"rname": "[x, y, w, h]",
"since": "2.50"
}
],
"ctrlSetScale": [
{
"cat": "General",
"desc": "Sets wanted scale for control animation. Top left corner remains same.",
"ex": "_control ctrlScale 0.5",
"exres": "",
"lname": "control",
"name": "ctrlsetscale",
"op": "ctrlsetscale",
"rname": "scale",
"since": "5501"
}
],
"ctrlSetStructuredText": [
{
"cat": "General",
"desc": "Set the structured text which will be displayed in structured text control.",
"ex": "_control ctrlSetStructuredText parseText \"First line&lt;img image=data\\isniper.paa/&gt;&ltbr/&gt;Second line\"",
"exres": "",
"lname": "control",
"name": "ctrlsetstructuredtext",
"op": "ctrlsetstructuredtext",
"rname": "structured text",
"since": "2.53"
}
],
"ctrlSetText": [
{
"cat": "General",
"desc": "Sets the text that will be shown in given control.",
"ex": "_control ctrlSetText \"Hello, world.\"",
"exres": "",
"lname": "control",
"name": "ctrlsettext",
"op": "ctrlsettext",
"rname": "text",
"since": "2.50"
}
],
"ctrlSetTextColor": [
{
"cat": "General",
"desc": "Sets text color of given control. Color is in format <ar>Color</ar>.",
"ex": "_control ctrlSetTextColor [1, 0, 0, 1]",
"exres": "",
"lname": "display",
"name": "ctrlsettextcolor",
"op": "ctrlsettextcolor",
"rname": "color",
"since": "2.50"
}
],
"ctrlSetTextColorSecondary": [
{
"cat": "General",
"desc": "Sets text color of the secondary text of given control. Color is in format <ar>Color</ar>.",
"ex": "_control ctrlSetTextColorSecondary [1, 0, 0, 1]",
"exres": "",
"lname": "display",
"name": "ctrlsettextcolorsecondary",
"op": "ctrlsettextcolorsecondary",
"rname": "color",
"since": ""
}
],
"ctrlSetTextSecondary": [
{
"cat": "General",
"desc": "Sets the secondary text that will be shown in given control.",
"ex": "_control ctrlSetTextSecondary \"Hello, world.\"",
"exres": "",
"lname": "control",
"name": "ctrlsettextsecondary",
"op": "ctrlsettextsecondary",
"rname": "text",
"since": ""
}
],
"ctrlSetTooltip": [
{
"cat": "General",
"desc": "Sets tooltip text of given control.",
"ex": "_control ctrlSetTooltip \"tooltip\"",
"exres": "",
"lname": "display",
"name": "ctrlsettooltip",
"op": "ctrlsettooltip",
"rname": "text",
"since": "2.92"
}
],
"ctrlSetTooltipColorBox": [
{
"cat": "General",
"desc": "Sets tooltip border color of given control. Color is in format <ar>Color</ar>.",
"ex": "_control ctrlSetTooltipColorBox [1, 0, 0, 1]",
"exres": "",
"lname": "display",
"name": "ctrlsettooltipcolorbox",
"op": "ctrlsettooltipcolorbox",
"rname": "color",
"since": "2.92"
}
],
"ctrlSetTooltipColorShade": [
{
"cat": "General",
"desc": "Sets tooltip background color of given control. Color is in format <ar>Color</ar>.",
"ex": "_control ctrlSetTooltipColorShade [1, 0, 0, 1]",
"exres": "",
"lname": "display",
"name": "ctrlsettooltipcolorshade",
"op": "ctrlsettooltipcolorshade",
"rname": "color",
"since": "2.92"
}
],
"ctrlSetTooltipColorText": [
{
"cat": "General",
"desc": "Sets tooltip text color of given control. Color is in format <ar>Color</ar>.",
"ex": "_control ctrlSetTooltipColorText [1, 0, 0, 1]",
"exres": "",
"lname": "display",
"name": "ctrlsettooltipcolortext",
"op": "ctrlsettooltipcolortext",
"rname": "color",
"since": "2.92"
}
],
"ctrlShow": [
{
"cat": "General",
"desc": "Show / hide given control.",
"ex": "_control ctrlShow false",
"exres": "",
"lname": "control",
"name": "ctrlshow",
"op": "ctrlshow",
"rname": "show",
"since": "2.50"
}
],
"curatorCoef": [
{
"cat": "General",
"desc": "Returns current coeficient setting",
"ex": "0 curatorCoef \"Place\"",
"exres": "",
"lname": "curatorObj",
"name": "curatorcoef",
"op": "curatorcoef",
"rname": "action",
"since": ""
}
],
"currentMagazineDetailTurret": [
{
"cat": "General",
"desc": "Return the name of the type of the currently using magazine on specified turret.",
"ex": "vehicle currentMagazineDetailTurret [0]",
"exres": "",
"lname": "vehicle",
"name": "currentmagazinedetailturret",
"op": "currentmagazinedetailturret",
"rname": "turret path",
"since": ""
}
],
"currentMagazineTurret": [
{
"cat": "General",
"desc": "Return the name of the type of the currently using magazine on specified turret.",
"ex": "vehicle currentMagazineTurret [0]",
"exres": "",
"lname": "vehicle",
"name": "currentmagazineturret",
"op": "currentmagazineturret",
"rname": "turret path",
"since": ""
}
],
"currentWeaponTurret": [
{
"cat": "General",
"desc": "Return the name of the currently selected weapon on specified turret.",
"ex": "vehicle currentWeaponTurret [0]",
"exres": "",
"lname": "vehicle",
"name": "currentweaponturret",
"op": "currentweaponturret",
"rname": "turret path",
"since": ""
}
],
"customChat": [
{
"cat": "General",
"desc": "Sends the chat message to the custom radio channel.",
"ex": "sweetBoy customChat [1,\"Hi, any sweetgirls to chat?\"]",
"exres": "",
"lname": "unit",
"name": "customchat",
"op": "customchat",
"rname": "[chan ix, string]",
"since": "81375 TOH"
}
],
"customRadio": [
{
"cat": "General",
"desc": "Sends the message to the custom radio channel. The message is defined in the description.ext file or radio protocol.",
"ex": "soldierOne customRadio [1,\"WordEnemy\"]",
"exres": "",
"lname": "unit",
"name": "customradio",
"op": "customradio",
"rname": "[chan ix, string]",
"since": "81375 TOH"
}
],
"cutFadeOut": [
{
"cat": "General",
"desc": "Terminate the effect in the given layer and set duration of the fade out phase to the given time.",
"ex": "\"layer1\" cutFadeOut 1.0",
"exres": "",
"lname": "layerName",
"name": "cutfadeout",
"op": "cutfadeout",
"rname": "duration",
"since": ""
},
{
"cat": "General",
"desc": "Terminate the effect in the given layer and set duration of the fade out phase to the given time.",
"ex": "0 cutFadeIn 1.0",
"exres": "",
"lname": "layer",
"name": "cutfadeout",
"op": "cutfadeout",
"rname": "duration",
"since": "5126"
}
],
"cutObj": [
{
"cat": "General",
"desc": "Object background - the right argument uses format [\"name\",\"type\",speed] or [\"name\",\"type\"]. If speed is not given, it's assumed to be one.\r\nThe left argument defines layer in which the effect is shown.\r\nThe object can be defined in the description.ext file.",
"ex": "\"layer1\" cutObj [\"TVSet\", \"plain\"]",
"exres": "",
"lname": "layerName",
"name": "cutobj",
"op": "cutobj",
"rname": "effect",
"since": ""
},
{
"cat": "General",
"desc": "Object background - the right argument uses format [\"name\",\"type\",speed] or [\"name\",\"type\"]. If speed is not given, it's assumed to be one.\r\nThe left argument define layer in which the effect is show, 0 is the back most.\r\nThe object can be defined in the description.ext file.",
"ex": "0 cutObj [\"TVSet\", \"plain\"]",
"exres": "",
"lname": "layer",
"name": "cutobj",
"op": "cutobj",
"rname": "effect",
"since": "5126"
}
],
"cutRsc": [
{
"cat": "General",
"desc": "Resource background - the right argument uses format [\"name\",\"type\",speed] or [\"name\",\"type\"]. If speed is not given, it's assumed to be one.\r\nThe left argument defines layer in which the effect is shown.\r\nThe resource can be defined in the description.ext file.",
"ex": "\"layer1\" cutRsc [\"binocular\", \"PLAIN\"]",
"exres": "",
"lname": "layerName",
"name": "cutrsc",
"op": "cutrsc",
"rname": "effect",
"since": ""
},
{
"cat": "General",
"desc": "Resource background - the right argument uses format [\"name\",\"type\",speed] or [\"name\",\"type\"]. If speed is not given, it's assumed to be one.\r\nThe left argument define layer in which the effect is show, 0 is the back most.\r\nThe resource can be defined in the description.ext file.",
"ex": "0 cutRsc [\"binocular\", \"PLAIN\"]",
"exres": "",
"lname": "layer",
"name": "cutrsc",
"op": "cutrsc",
"rname": "effect",
"since": "5126"
}
],
"cutText": [
{
"cat": "General",
"desc": "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\".\r\nThe left argument defines layer in which the effect is shown.",
"ex": "\"layer1\" cutText [\"\", \"BLACK OUT\"]",
"exres": "",
"lname": "layerName",
"name": "cuttext",
"op": "cuttext",
"rname": "effect",
"since": ""
},
{
"cat": "General",
"desc": "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\".\r\nThe left argument define layer in which the effect is show, 0 is the back most.",
"ex": "0 cutText [\"\", \"BLACK OUT\"]",
"exres": "",
"lname": "layer",
"name": "cuttext",
"op": "cuttext",
"rname": "effect",
"since": "5126"
}
],
"debugFSM": [
{
"cat": "General",
"desc": "Switch FSM debug log on/off.",
"ex": "BIS_grpMainFSM debugFSM true",
"exres": "",
"lname": "FSM handle",
"name": "debugfsm",
"op": "debugfsm",
"rname": "true",
"since": "5501"
}
],
"deleteAt": [
{
"cat": "Default",
"desc": "Remove element at given index(and use them as a return value).",
"ex": "array DeleteAt 4",
"exres": "",
"lname": "array",
"name": "deleteat",
"op": "deleteat",
"rname": "index",
"since": "1.75"
}
],
"deleteEditorObject": [
{
"cat": "Editor",
"desc": "Delete the editor object. Requires all editor object links to be removed prior.",
"ex": "",
"exres": "",
"lname": "map",
"name": "deleteeditorobject",
"op": "deleteeditorobject",
"rname": "object",
"since": "2.92"
}
],
"deleteGroupWhenEmpty": [
{
"cat": "General",
"desc": "Enable or disable garbage collection of given group when its empty",
"ex": "deleteGroupWhenEmpty ",
"exres": "",
"lname": "group",
"name": "deletegroupwhenempty",
"op": "deletegroupwhenempty",
"rname": "garbageCollect",
"since": ""
}
],
"deleteRange": [
{
"cat": "Default",
"desc": "Removes n consequent elements starting at given index.",
"ex": "array deleteRange [2,8]",
"exres": "",
"lname": "array",
"name": "deleterange",
"op": "deleterange",
"rname": "[index,count]",
"since": "1.75"
}
],
"deleteResources": [
{
"cat": "Agents",
"desc": "Delete (unregister) resources of the team member.",
"ex": "teamMember _agent deleteResources [\"Legs\"]",
"exres": "",
"lname": "teamMember",
"name": "deleteresources",
"op": "deleteresources",
"rname": "[resource1, resource2, ...]",
"since": "2.90"
}
],
"deleteVehicleCrew": [
{
"cat": "General",
"desc": "Deletes vehicle from vehicle even if crew is already dead.",
"ex": "car deleteVehicleCrew soldier",
"exres": "",
"lname": "vehicle",
"name": "deletevehiclecrew",
"op": "deletevehiclecrew",
"rname": "crew",
"since": "2.35"
}
],
"diarySubjectExists": [
{
"cat": "Identity",
"desc": "Checks whether given subject is present in the diary of given person.",
"ex": "",
"exres": "",
"lname": "person",
"name": "diarysubjectexists",
"op": "diarysubjectexists",
"rname": "name",
"since": "5501"
}
],
"directSay": [
{
"cat": "General",
"desc": "Sends the message to the direct channel. The message is defined in the description.ext file or radio protocol.",
"ex": "soldierOne directSay \"messageOne\"",
"exres": "",
"lname": "unit",
"name": "directsay",
"op": "directsay",
"rname": "radioName",
"since": "5501"
}
],
"disableAI": [
{
"cat": "General",
"desc": "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), \"MOVE\" (disables movement), \"SUPPRESSION\" (disable suppression being accumulated out of danger events), \"AIMINGERROR\" (disable distractions on aiming), \"CHECKVISIBLE\" (disable visibility raycasts), \"COVER\" (disable usage of cover), \"AUTOCOMBAT\" (disable autonomous switching to combat mode), \"ALL\" to disable everything",
"ex": "soldierOne disableAI \"Move\"",
"exres": "",
"lname": "unit",
"name": "disableai",
"op": "disableai",
"rname": "section",
"since": ""
}
],
"disableCollisionWith": [
{
"cat": "General",
"desc": "Disable collision between vehicles.",
"ex": "",
"exres": "",
"lname": "vehicle",
"name": "disablecollisionwith",
"op": "disablecollisionwith",
"rname": "vehicle",
"since": "TOH 85355"
}
],
"disableConversation": [
{
"cat": "General",
"desc": "Lock / unlock the unit to using conversation. Implemented by the counter, so lock - unlock need to be matched.",
"ex": "player disableConversation true",
"exres": "",
"lname": "unit",
"name": "disableconversation",
"op": "disableconversation",
"rname": "lock",
"since": ""
}
],
"disableNVGEquipment": [
{
"cat": "General",
"desc": "Enable/disable transport vision modes(Nv)",
"ex": "",
"exres": "",
"lname": "vehicle",
"name": "disablenvgequipment",
"op": "disablenvgequipment",
"rname": "enable/disable",
"since": ""
}
],
"disableTIEquipment": [
{
"cat": "General",
"desc": "Enable/disable transport vision modes(Ti)",
"ex": "",
"exres": "",
"lname": "vehicle",
"name": "disabletiequipment",
"op": "disabletiequipment",
"rname": "enable/disable",
"since": ""
}
],
"disableUAVConnectability": [
{
"cat": "General",
"desc": "disable unit's AV terminal(s) connecting to UAV",
"ex": "unit DisableUAVConnectability [uav, true]",
"exres": "",
"lname": "object",
"name": "disableuavconnectability",
"op": "disableuavconnectability",
"rname": "[uav, checkAllItems]",
"since": ""
}
],
"displayAddEventHandler": [
{
"cat": "General",
"desc": "Add an event handler to the given display. Returns id of the handler or -1 when failed.",
"ex": "_id = _display displayAddEventHandler [\"KeyDown\", \"\"]",
"exres": "",
"lname": "display",
"name": "displayaddeventhandler",
"op": "displayaddeventhandler",
"rname": "[handler name, function]",
"since": "5501"
}
],
"displayCtrl": [
{
"cat": "General",
"desc": "Return child control with specified idc.",
"ex": "_control = _display displayCtrl 101",
"exres": "",
"lname": "display",
"name": "displayctrl",
"op": "displayctrl",
"rname": "idc",
"since": "2.50"
}
],
"displayRemoveAllEventHandlers": [
{
"cat": "General",
"desc": "Remove all even handlers from the given display.",
"ex": "_display displayRemoveAllEventHandlers \"KeyDown\"",
"exres": "",
"lname": "display",
"name": "displayremovealleventhandlers",
"op": "displayremovealleventhandlers",
"rname": "handler name",
"since": "5501"
}
],
"displayRemoveEventHandler": [
{
"cat": "General",
"desc": "Remove a given event handler from the given display.",
"ex": "_display displayRemoveEventHandler [\"KeyDown\", 0]",
"exres": "",
"lname": "display",
"name": "displayremoveeventhandler",
"op": "displayremoveeventhandler",
"rname": "[handler name, id]",
"since": "5501"
}
],
"displaySetEventHandler": [
{
"cat": "General",
"desc": "Sets given event handler of given display.",
"ex": "_control displaySetEventHandler [\"KeyDown\", \"\"]",
"exres": "",
"lname": "display",
"name": "displayseteventhandler",
"op": "displayseteventhandler",
"rname": "[handler name, function]",
"since": "2.54"
}
],
"distance": [
{
"cat": "General",
"desc": "Computes the distance between two objects or positions.",
"ex": "player distance leader player",
"exres": "",
"lname": "obj1 or pos1",
"name": "distance",
"op": "distance",
"rname": "obj2 or pos2",
"since": ""
},
{
"cat": "Location",
"desc": "Computes the distance between two locations or positions.",
"ex": "",
"exres": "",
"lname": "location1",
"name": "distance",
"op": "distance",
"rname": "location2",
"since": "5501"
},
{
"cat": "Location",
"desc": "Computes the distance between two locations or positions.",
"ex": "",
"exres": "",
"lname": "location1",
"name": "distance",
"op": "distance",
"rname": "pos2",
"since": "5501"
},
{
"cat": "Location",
"desc": "Computes the distance between two locations or positions.",
"ex": "",
"exres": "",
"lname": "pos1",
"name": "distance",
"op": "distance",
"rname": "location2",
"since": "5501"
}
],
"distance2D": [
{
"cat": "General",
"desc": "Computes the 2D distance between two objects or positions.",
"ex": "player distance2D leader player",
"exres": "",
"lname": "obj1 or pos1",
"name": "distance2d",
"op": "distance2d",
"rname": "obj2 or pos2",
"since": ""
}
],
"distanceSqr": [
{
"cat": "General",
"desc": "Computes the distance square between two objects or positions.",
"ex": "player distanceSqr (leader player)",
"exres": "",
"lname": "obj1 or pos1",
"name": "distancesqr",
"op": "distancesqr",
"rname": "obj2 or pos2",
"since": ""
},
{
"cat": "Location",
"desc": "Computes the distance square between two locations or positions.",
"ex": "",
"exres": "",
"lname": "location1",
"name": "distancesqr",
"op": "distancesqr",
"rname": "location2",
"since": "5501"
},
{
"cat": "Location",
"desc": "Computes the distance square between two locations or positions.",
"ex": "",
"exres": "",
"lname": "location1",
"name": "distancesqr",
"op": "distancesqr",
"rname": "pos2",
"since": "5501"
},
{
"cat": "Location",
"desc": "Computes the distance square between two locations or positions.",
"ex": "",
"exres": "",
"lname": "pos1",
"name": "distancesqr",
"op": "distancesqr",
"rname": "location2",
"since": "5501"
}
],
"do": [
{
"cat": "Default",
"desc": "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.",
"ex": "while \"a>b\" do {a=a+1}",
"exres": "",
"lname": "while",
"name": "do",
"op": "do",
"rname": "code",
"since": "1.85"
},
{
"cat": "Default",
"desc": "Execute the code inside the given namespace.",
"ex": "with missionNamespace do {global=global+1}",
"exres": "",
"lname": "with",
"name": "do",
"op": "do",
"rname": "code",
"since": "5501"
},
{
"cat": "Default",
"desc": "End of for command, starts cycle",
"ex": "for \"_x\" from 20 to 10 step -2 do {..code..}",
"exres": "",
"lname": "forCommand",
"name": "do",
"op": "do",
"rname": "code",
"since": ""
},
{
"cat": "Default",
"desc": "Switch form",
"ex": "switch (_a) do { case 1: {block}; case 2 : {block}; default {block};}",
"exres": "",
"lname": "switch",
"name": "do",
"op": "do",
"rname": "block",
"since": ""
}
],
"doArtilleryFire": [
{
"cat": "General",
"desc": "Orders a unit to reaload defined magazine commence fire burst on the given position (silently).",
"ex": "mortar1 doArtilleryFire [[3000, 120, 1000], \"8Rnd_82mm_Mo_shells\", 3]",
"exres": "",
"lname": "unit",
"name": "doartilleryfire",
"op": "doartilleryfire",
"rname": "[position, type, rounds]",
"since": ""
}
],
"doFSM": [
{
"cat": "General",
"desc": "Orders a unit to process command defined by FSM file (silently).",
"ex": "soldierOne doFSM [\"move.fsm\", position player, player]",
"exres": "",
"lname": "unit(s)",
"name": "dofsm",
"op": "dofsm",
"rname": "[fsm name, position, target]",
"since": "2.53"
}
],
"doFire": [
{
"cat": "General",
"desc": "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).",
"ex": "soldierOne doFire objNull",
"exres": "",
"lname": "unit",
"name": "dofire",
"op": "dofire",
"rname": "target",
"since": ""
}
],
"doFollow": [
{
"cat": "General",
"desc": "Orders a unit to follow the given unit (silently).",
"ex": "soldierOne doFollow player",
"exres": "",
"lname": "unit",
"name": "dofollow",
"op": "dofollow",
"rname": "position",
"since": ""
}
],
"doMove": [
{
"cat": "General",
"desc": "Orders the unit to move to the given position (format <ar>Position</ar>) (silently).",
"ex": "soldierOne doMove getMarkerPos \"MarkerMoveOne\"",
"exres": "",
"lname": "unit",
"name": "domove",
"op": "domove",
"rname": "position",
"since": ""
}
],
"doSuppressiveFire": [
{
"cat": "General",
"desc": "Orders a unit to suppress given position or target (silently).",
"ex": "soldier doSuppressiveFire [3000, 120, 1000]",
"exres": "",
"lname": "unit",
"name": "dosuppressivefire",
"op": "dosuppressivefire",
"rname": "position or target",
"since": ""
}
],
"doTarget": [
{
"cat": "General",
"desc": "Orders the unit to target the given target (silently).",
"ex": "soldierOne doTarget player",
"exres": "",
"lname": "unit",
"name": "dotarget",
"op": "dotarget",
"rname": "position",
"since": ""
}
],
"doWatch": [
{
"cat": "General",
"desc": "Orders the unit to watch the given position (format <ar>Position</ar>) (silently).",
"ex": "soldierOne doWatch getMarkerPos \"MarkerMoveOne\"",
"exres": "",
"lname": "unit",
"name": "dowatch",
"op": "dowatch",
"rname": "position",
"since": ""
},
{
"cat": "General",
"desc": "Orders the unit to watch the given target (silently).",
"ex": "soldierOne doWatch player",
"exres": "",
"lname": "unit",
"name": "dowatch",
"op": "dowatch",
"rname": "target",
"since": ""
}
],
"doorPhase": [
{
"cat": "General",
"desc": "Return animation phase of door on vehicle.",
"ex": "heli doorPhase \"gunnerDoor\"",
"exres": "",
"lname": "object",
"name": "doorphase",
"op": "doorphase",
"rname": "animation",
"since": "TOH 83638"
}
],
"drawArrow": [
{
"cat": "General",
"desc": "Draw arrow in map.",
"ex": "",
"exres": "",
"lname": "map",
"name": "drawarrow",
"op": "drawarrow",
"rname": "[position1, position2, color]",
"since": "2.35"
}
],
"drawEllipse": [
{
"cat": "General",
"desc": "Draw ellipse in map.",
"ex": "",
"exres": "",
"lname": "map",
"name": "drawellipse",
"op": "drawellipse",
"rname": "[center, a, b, angle, color, fill]",
"since": "2.35"
}
],
"drawIcon": [
{
"cat": "General",
"desc": "Draw icon in map.",
"ex": "control drawIcon [ \"#(argb,8,8,3)color(0,1,0,1)\", [1,1,1,1], position player, 10, 10,1, userText, 1, 0.2, \"TahomaB\", \"right\"",
"exres": "",
"lname": "map",
"name": "drawicon",
"op": "drawicon",
"rname": "[texture, color, position, width, height, angle, text, shadow, textSize, font, align]",
"since": "2.35"
}
],
"drawLine": [
{
"cat": "General",
"desc": "Draw line in map.",
"ex": "",
"exres": "",
"lname": "map",
"name": "drawline",
"op": "drawline",
"rname": "[position1, position2, color]",
"since": "2.35"
}
],
"drawLink": [
{
"cat": "Editor",
"desc": "The editor will draw a line between the two specified editor objects. Line type can be LINE or ARROW.",
"ex": "",
"exres": "",
"lname": "map",
"name": "drawlink",
"op": "drawlink",
"rname": "[from, to, param type, line type, color]",
"since": "2.92"
}
],
"drawLocation": [
{
"cat": "Location PC",
"desc": "Draw location in the map.",
"ex": "",
"exres": "",
"lname": "map",
"name": "drawlocation",
"op": "drawlocation",
"rname": "location",
"since": "2.90"
}
],
"drawPolygon": [
{
"cat": "General",
"desc": "Draw a polygon on the map.",
"ex": "findDisplay 12 displayCtrl 51 ctrlAddEventHandler [\"Draw\", { _this select 0 drawPolygon[[[100, 50, 0], [50, 100, 0], [0, 0, 0]], [0, 0, 0, 1]]; }]; ",
"exres": "",
"lname": "map",
"name": "drawpolygon",
"op": "drawpolygon",
"rname": "[[pos1, pos2,...], color]",
"since": ""
}
],
"drawRectangle": [
{
"cat": "General",
"desc": "Draw rectangle in map.",
"ex": "",
"exres": "",
"lname": "map",
"name": "drawrectangle",
"op": "drawrectangle",
"rname": "[center, a, b, angle, color, fill]",
"since": "2.35"
}
],
"editObject": [
{
"cat": "Editor",
"desc": "Show the edit object dialog for the given object.",
"ex": "",
"exres": "",
"lname": "map",
"name": "editobject",
"op": "editobject",
"rname": "object",
"since": "2.92"
}
],
"editorSetEventHandler": [
{
"cat": "Editor",
"desc": "Sets given event handler of given editor.",
"ex": "_map editorSetEventHandler [\"SelectObject\", \"\"]",
"exres": "",
"lname": "map",
"name": "editorseteventhandler",
"op": "editorseteventhandler",
"rname": "[handler name, function]",
"since": "2.92"
}
],
"else": [
{
"cat": "Default",
"desc": "Constructs an array that can be processed by <f>then</f>.",
"ex": "if (a>b) then {c=0} else {c=1}",
"exres": "",
"lname": "ifCode",
"name": "else",
"op": "else",
"rname": "elseCode",
"since": "1.85"
}
],
"emptyPositions": [
{
"cat": "General",
"desc": "Returns the number of available cargo, driver, gunner or commander positions in the vehicle.",
"ex": "_freePositions = (vehicle player) freePositions \"cargo\"",
"exres": "",
"lname": "vehicle",
"name": "emptypositions",
"op": "emptypositions",
"rname": "position",
"since": "2.92"
}
],
"enableAI": [
{
"cat": "General",
"desc": "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), \"MOVE\" (enables movement), \"SUPPRESSION\" (enables suppression being accumulated out of danger events), \"AIMINGERROR\" (enables distractions on aiming), \"CHECKVISIBLE\" (enables visibility raycasts), \"COVER\" (enable usage of cover), \"AUTOCOMBAT\" (enable autonomous switching to combat mode)",
"ex": "soldierOne enableAI \"Move\"), \"ALL\" to enable everything",
"exres": "",
"lname": "unit",
"name": "enableai",
"op": "enableai",
"rname": "section",
"since": "2.53"
}
],
"enableAIFeature": [
{
"cat": "General",
"desc": "Enable/disable given AI feature. Feature may be one of: \"AwareFormationSoft\", \"CombatFormationSoft\".",
"ex": "\"AwareFormationSoft\" enableAIFeature true",
"exres": "",
"lname": "feature",
"name": "enableaifeature",
"op": "enableaifeature",
"rname": "enabled",
"since": "60220"
}
],
"enableAimPrecision": [
{
"cat": "General",
"desc": "Set whether animation's aim precision affects weapon sway.",
"ex": "player enableAimPrecision false",
"exres": "",
"lname": "player",
"name": "enableaimprecision",
"op": "enableaimprecision",
"rname": "enabled",
"since": "129500"
}
],
"enableAttack": [
{
"cat": "General",
"desc": "Set if leader can issue attack commands.",
"ex": "",
"exres": "",
"lname": "group",
"name": "enableattack",
"op": "enableattack",
"rname": "enable",
"since": "2.92"
}
],
"enableAutoStartUpRTD": [
{
"cat": "General",
"desc": "enables automatic start up action,",
"ex": "",
"exres": "",
"lname": "RTD_helicopter",
"name": "enableautostartuprtd",
"op": "enableautostartuprtd",
"rname": "enabled",
"since": "TOH 81393"
}
],
"enableAutoTrimRTD": [
{
"cat": "General",
"desc": "eanbles autoTrim",
"ex": "",
"exres": "",
"lname": "RTD_helicopter",
"name": "enableautotrimrtd",
"op": "enableautotrimrtd",
"rname": "bool",
"since": "TOH 81393"
}
],
"enableChannel": [
{
"cat": "General",
"desc": "Enables/disables chat channel.",
"ex": "1 enableChannel true",
"exres": "",
"lname": "channel",
"name": "enablechannel",
"op": "enablechannel",
"rname": "enabled",
"since": ""
},
{
"cat": "General",
"desc": "Enables/disables chat channel.",
"ex": "1 enableChannel [true, false]",
"exres": "",
"lname": "channel",
"name": "enablechannel",
"op": "enablechannel",
"rname": "[enableChat, enableVoN]",
"since": ""
}
],
"enableCollisionWith": [
{
"cat": "General",
"desc": "Enable collision between vehicles.",
"ex": "",
"exres": "",
"lname": "vehicle",
"name": "enablecollisionwith",
"op": "enablecollisionwith",
"rname": "vehicle",
"since": "TOH 85355"
}
],
"enableCopilot": [
{
"cat": "General",
"desc": "Enables copilot actions.",
"ex": "",
"exres": "",
"lname": "vehicle",
"name": "enablecopilot",
"op": "enablecopilot",
"rname": "enable",
"since": "TOH"
}
],
"enableDynamicSimulation": [
{
"cat": "General",
"desc": "Enables or disables dynamic simulation on given non ai object.",
"ex": "table1 enableDynamicSimulation true",
"exres": "",
"lname": "vehicle1",
"name": "enabledynamicsimulation",
"op": "enabledynamicsimulation",
"rname": "enable",
"since": ""
},
{
"cat": "General",
"desc": "Enables or disables dynamic simulation on given group",
"ex": "(group soldier1) enableDynamicSimulation true",
"exres": "",
"lname": "group1",
"name": "enabledynamicsimulation",
"op": "enabledynamicsimulation",
"rname": "enable",
"since": ""
}
],
"enableFatigue": [
{
"cat": "General",
"desc": "[deprecated] Replaced by enableStamina",
"ex": "",
"exres": "",
"lname": "",
"name": "enablefatigue",
"op": "enablefatigue",
"rname": "",
"since": ""
}
],
"enableGunLights": [
{
"cat": "General",
"desc": "Tells AI units to force the gun light on (forceOn), off (forceOff) or set it automatically when in combat mode (auto)",
"ex": "groupOne enableGunLights \"forceOff\"",
"exres": "",
"lname": "group",
"name": "enablegunlights",
"op": "enablegunlights",
"rname": "mode",
"since": ""
}
],
"enableIRLasers": [
{
"cat": "General",
"desc": "Enable/disable using IR lasers for AI",
"ex": "groupOne enableIRLasers true",
"exres": "",
"lname": "group",
"name": "enableirlasers",
"op": "enableirlasers",
"rname": "enable",
"since": ""
}
],
"enableMimics": [
{
"cat": "General",
"desc": "Enables/disables mimics on a given unit",
"ex": "cursorTarget enableMimics false",
"exres": "",
"lname": "unit",
"name": "enablemimics",
"op": "enablemimics",
"rname": "enabled",
"since": ""
}
],
"enablePersonTurret": [
{
"cat": "General",
"desc": "Enables/disables usage of PersonTurret",
"ex": "heli enablePersonTurret [[1], true]",
"exres": "",
"lname": "vehicle",
"name": "enablepersonturret",
"op": "enablepersonturret",
"rname": "[turret path, enable]",
"since": ""
}
],
"enableReload": [
{
"cat": "General",
"desc": "Enable / disable reload right after magazine is empty.",
"ex": "_vehicle enableReload false",
"exres": "",
"lname": "object",
"name": "enablereload",
"op": "enablereload",
"rname": "enable",
"since": "2.92"
}
],
"enableRopeAttach": [
{
"cat": "General",
"desc": "Enable / disable ability to attach ropes or to be attached to ropes for given vehicle",
"ex": "",
"exres": "",
"lname": "vehicle",
"name": "enableropeattach",
"op": "enableropeattach",
"rname": "enable",
"since": "126046"
}
],
"enableSimulation": [
{
"cat": "General",
"desc": "Enable / disable simulation for given entity.",
"ex": "",
"exres": "",
"lname": "entity",
"name": "enablesimulation",
"op": "enablesimulation",
"rname": "enable",
"since": ""
}
],
"enableSimulationGlobal": [
{
"cat": "General",
"desc": "Enable / disable simulation for given entity globally. Only from server",
"ex": "",
"exres": "",
"lname": "entity",
"name": "enablesimulationglobal",
"op": "enablesimulationglobal",
"rname": "enable",
"since": ""
}
],
"enableStamina": [
{
"cat": "General",
"desc": "Enable/disable stamina system",
"ex": "player enableStamina false",
"exres": "",
"lname": "unit",
"name": "enablestamina",
"op": "enablestamina",
"rname": "enabled",
"since": "132500"
}
],
"enableUAVConnectability": [
{
"cat": "General",
"desc": "enable unit's AV terminal(s) connecting to UAV",
"ex": "unit enableUAVConnectability [uav, true]",
"exres": "",
"lname": "object",
"name": "enableuavconnectability",
"op": "enableuavconnectability",
"rname": "[uav, checkAllItems]",
"since": ""
}
],
"enableUAVWaypoints": [
{
"cat": "General",
"desc": "Enable/disable option to set waypoints for UAV unit in AV terminal",
"ex": "vehicle enableUAVWaypoints false",
"exres": "",
"lname": "vehicle",
"name": "enableuavwaypoints",
"op": "enableuavwaypoints",
"rname": "bool",
"since": "129341"
}
],
"enableVehicleCargo": [
{
"cat": "General",
"desc": "Enable/disable option to transport other vehicles (if configured) or be transported.",
"ex": "veh enableVehicleCargo true",
"exres": "",
"lname": "vehicle",
"name": "enablevehiclecargo",
"op": "enablevehiclecargo",
"rname": "true",
"since": "134497"
}
],
"enableWeaponDisassembly": [
{
"cat": "General",
"desc": "Controls player ability to disassemble given object",
"ex": "weapon enableWeaponDisassembly false",
"exres": "",
"lname": "object",
"name": "enableweapondisassembly",
"op": "enableweapondisassembly",
"rname": "bool",
"since": ""
}
],
"engineOn": [
{
"cat": "General",
"desc": "Switches the vehicle's engine on (true) or off (false).",
"ex": "vehicle player engineOn false",
"exres": "",
"lname": "vehicle",
"name": "engineon",
"op": "engineon",
"rname": "on",
"since": "1.90"
}
],
"evalObjectArgument": [
{
"cat": "Editor",
"desc": "Return object argument in mission editor.",
"ex": "",
"exres": "",
"lname": "map",
"name": "evalobjectargument",
"op": "evalobjectargument",
"rname": "[object, argument]",
"since": "2.35"
}
],
"exec": [
{
"cat": "General",
"desc": "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.",
"ex": "[player, jeepOne] exec \"getIn.sqs\"",
"exres": "",
"lname": "argument",
"name": "exec",
"op": "exec",
"rname": "script",
"since": ""
}
],
"execEditorScript": [
{
"cat": "Editor",
"desc": "Execute an editor script for the specified object.",
"ex": "_map execEditorScript [\"_team_1\", \"create\"]",
"exres": "",
"lname": "map",
"name": "execeditorscript",
"op": "execeditorscript",
"rname": "[object, script]",
"since": "2.92"
}
],
"execFSM": [
{
"cat": "General",
"desc": "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.",
"ex": "player execFSM \"test.fsm\"",
"exres": "",
"lname": "argument",
"name": "execfsm",
"op": "execfsm",
"rname": "filename",
"since": "5500"
}
],
"execVM": [
{
"cat": "General",
"desc": "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.",
"ex": "player execVM \"test.sqf\"",
"exres": "",
"lname": "argument",
"name": "execvm",
"op": "execvm",
"rname": "filename",
"since": "2.60"
}
],
"exitWith": [
{
"cat": "Default",
"desc": "if result of condition is true, evaluates code, and current block with result of code",
"ex": "if (_x>5) exitWith {echo \"_x is too big\";_x}",
"exres": "[when _x is greater then 5, outputs message and terminates code in current level with value of _x",
"lname": "if",
"name": "exitwith",
"op": "exitwith",
"rname": "code",
"since": "2"
}
],
"fadeMusic": [
{
"cat": "General",
"desc": "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.",
"ex": "5 fadeMusic 0",
"exres": "",
"lname": "time",
"name": "fademusic",
"op": "fademusic",
"rname": "volume",
"since": ""
}
],
"fadeRadio": [
{
"cat": "General",
"desc": "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.",
"ex": "5 fadeRadio 0.1",
"exres": "",
"lname": "time",
"name": "faderadio",
"op": "faderadio",
"rname": "volume",
"since": ""
}
],
"fadeSound": [
{
"cat": "General",
"desc": "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.",
"ex": "5 fadeSound 0.1",
"exres": "",
"lname": "time",
"name": "fadesound",
"op": "fadesound",
"rname": "volume",
"since": ""
}
],
"fadeSpeech": [
{
"cat": "General",
"desc": "Causes a smooth change in the master speech volume. The change duration is given by time, the target volume by volume. The default master volume is 1.0.",
"ex": "5 fadeSound 0.1",
"exres": "",
"lname": "time",
"name": "fadespeech",
"op": "fadespeech",
"rname": "volume",
"since": ""
}
],
"find": [
{
"cat": "Default",
"desc": "Returns the position of the first array element that matches x, returns -1 if not found.",
"ex": "[0, 1, 2] find 1",
"exres": "1",
"lname": "array",
"name": "find",
"op": "find",
"rname": "x",
"since": "2.92"
},
{
"cat": "Default",
"desc": "returns index of the first occurrence of str2 in str1, -1 if not found",
"ex": "\"Hello\" find \"ell\"",
"exres": "1",
"lname": "source string",
"name": "find",
"op": "find",
"rname": "string we are looking for",
"since": "5195"
}
],
"findCover": [
{
"cat": "General",
"desc": "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.",
"ex": "",
"exres": "",
"lname": "object",
"name": "findcover",
"op": "findcover",
"rname": "[position, hidePosition, maxDist, minDist, visibilityPosition, ignoreObject]",
"since": "2.92"
}
],
"findEditorObject": [
{
"cat": "Editor",
"desc": "Return object of given type with given arguments. Use [type, game value] to search by object reference of a specific editor object type.",
"ex": "",
"exres": "",
"lname": "map",
"name": "findeditorobject",
"op": "findeditorobject",
"rname": "[type, name1, value1, ...]",
"since": "2.35"
},
{
"cat": "Editor",
"desc": "Return object that matches the provided reference.",
"ex": "",
"exres": "",
"lname": "map",
"name": "findeditorobject",
"op": "findeditorobject",
"rname": "value",
"since": "2.92"
}
],
"findEmptyPosition": [
{
"cat": "General",
"desc": "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.",
"ex": "",
"exres": "",
"lname": "center",
"name": "findemptyposition",
"op": "findemptyposition",
"rname": "[radius, maxDistance] or [radius, maxDistance, vehicleType]",
"since": "5501"
}
],
"findEmptyPositionReady": [
{
"cat": "General",
"desc": "Check if findEmptyPosition can be called without waiting for files.",
"ex": "",
"exres": "",
"lname": "center",
"name": "findemptypositionready",
"op": "findemptypositionready",
"rname": "[radius, maxDistance]",
"since": "5501"
}
],
"findNearestEnemy": [
{
"cat": "General",
"desc": "Find the nearest enemy from the specified position.",
"ex": "",
"exres": "",
"lname": "object",
"name": "findnearestenemy",
"op": "findnearestenemy",
"rname": "position",
"since": "2.92"
}
],
"fire": [
{
"cat": "General",
"desc": "The unit will fire from the given weapon.",
"ex": "soldierOne fire \"HandGrenade\"",
"exres": "",
"lname": "unit",
"name": "fire",
"op": "fire",
"rname": "weaponName",
"since": ""
},
{
"cat": "General",
"desc": "The unit will fire from the given weapon. The array has format [muzzle, mode, magazine] or [muzzle, mode].",
"ex": "soldierOne fire [\"throw\",\"SmokeShell\",\"SmokeShell\"]",
"exres": "",
"lname": "unit",
"name": "fire",
"op": "fire",
"rname": "array",
"since": ""
}
],
"fireAtTarget": [
{
"cat": "General",
"desc": "Gunner in unit's vehicle fire at given target. If weapon is not given, current is used.",
"ex": "bool = vehicle FireAtTarget [target]; bool = player FireAtTarget [target,1]",
"exres": "",
"lname": "vehicle",
"name": "fireattarget",
"op": "fireattarget",
"rname": "[target, weapon]",
"since": "5501"
}
],
"flyInHeight": [
{
"cat": "General",
"desc": "Sets the height level for the helicopter. The accepted range is from 50 to 1000. Final height is max(flyInHeight, flyInHeightASL).",
"ex": "cobraOne flyInHeight 150",
"exres": "",
"lname": "helicopter or airplane",
"name": "flyinheight",
"op": "flyinheight",
"rname": "height",
"since": ""
}
],
"flyInHeightASL": [
{
"cat": "General",
"desc": "Sets the minimal ASL height. Final height is max(flyInHeight, flyInHeightASL).",
"ex": "cobraOne flyInHeightASL [200, 100, 400]",
"exres": "",
"lname": "helicopter or airplane",
"name": "flyinheightasl",
"op": "flyinheightasl",
"rname": "[height - careless/safe/aware, height - combat, height - stealth]",
"since": ""
}
],
"forEach": [
{
"cat": "Default",
"desc": "Executes the given command for each element in array.\r\nIt's executed as follows:\r\n\r\nfor each element of array an element is assigned as _x and the command is executed.",
"ex": "\"_x setdammage 1\" forEach units group player",
"exres": "",
"lname": "command",
"name": "foreach",
"op": "foreach",
"rname": "array",
"since": ""
}
],
"forEachMember": [
{
"cat": "Agents",
"desc": "Executes the given command for each member of the team (recursively).",
"ex": "",
"exres": "",
"lname": "command",
"name": "foreachmember",
"op": "foreachmember",
"rname": "team",
"since": "2.92"
}
],
"forEachMemberAgent": [
{
"cat": "Agents",
"desc": "Executes the given command for each agent member of the team (recursively).",
"ex": "",
"exres": "",
"lname": "command",
"name": "foreachmemberagent",
"op": "foreachmemberagent",
"rname": "team",
"since": "2.92"
}
],
"forEachMemberTeam": [
{
"cat": "Agents",
"desc": "Executes the given command for each team member of the team (recursively).",
"ex": "",
"exres": "",
"lname": "command",
"name": "foreachmemberteam",
"op": "foreachmemberteam",
"rname": "team",
"since": "2.92"
}
],
"forceAddUniform": [
{
"cat": "General",
"desc": "Create a new uniform and hard link it into uniform slot(without any restrictions).",
"ex": "",
"exres": "",
"lname": "unit",
"name": "forceadduniform",
"op": "forceadduniform",
"rname": "type",
"since": ""
}
],
"forceFollowRoad": [
{
"cat": "General",
"desc": "Sets the vehicle to always stays on the road.",
"ex": "vehicle forceFollowRoad true",
"exres": "",
"lname": "vehicle",
"name": "forcefollowroad",
"op": "forcefollowroad",
"rname": "true/false",
"since": ""
}
],
"forceSpeed": [
{
"cat": "General",
"desc": "Force the speed of the given object.",
"ex": "",
"exres": "",
"lname": "object",
"name": "forcespeed",
"op": "forcespeed",
"rname": "speed",
"since": "2.92"
}
],
"forceWalk": [
{
"cat": "General",
"desc": "Force player to walk.",
"ex": "player forceWalk true",
"exres": "",
"lname": "player",
"name": "forcewalk",
"op": "forcewalk",
"rname": "force walk",
"since": "5501"
}
],
"forceWeaponFire": [
{
"cat": "General",
"desc": "The unit will be forced to fire from the given weapon.",
"ex": "soldierOne forceWeaponFire [\"arifle_MX_F\",0]",
"exres": "",
"lname": "unit",
"name": "forceweaponfire",
"op": "forceweaponfire",
"rname": "[weapon, mode]",
"since": ""
}
],
"from": [
{
"cat": "Default",
"desc": "Continue sequence of 'for' command.",
"ex": "for \"_x\" from 10 to 20 do {..code..}",
"exres": "",
"lname": "for \"_var\"",
"name": "from",
"op": "from",
"rname": "b",
"since": ""
}
],
"get3DENAttribute": [
{
"cat": "General",
"desc": "Reads attribute value from given object.",
"ex": "obj get3DENAttribute \"name\"",
"exres": "",
"lname": "editorObject",
"name": "get3denattribute",
"op": "get3denattribute",
"rname": "attributeType",
"since": ""
},
{
"cat": "General",
"desc": "Reads attribute value from given group.",
"ex": "grp get3DENAttribute \"name\"",
"exres": "",
"lname": "editorGroup",
"name": "get3denattribute",
"op": "get3denattribute",
"rname": "attributeType",
"since": ""
},
{
"cat": "General",
"desc": "Reads attribute value from given waypoint.",
"ex": "wp get3DENAttribute \"name\"",
"exres": "",
"lname": "editorWaypoint",
"name": "get3denattribute",
"op": "get3denattribute",
"rname": "attributeType",
"since": ""
},
{
"cat": "General",
"desc": "Reads attribute value from given marker.",
"ex": "marker get3DENAttribute \"name\"",
"exres": "",
"lname": "editorMarker",
"name": "get3denattribute",
"op": "get3denattribute",
"rname": "attributeType",
"since": ""
},
{
"cat": "General",
"desc": "Reads attribute value from given editor object.",
"ex": "objID get3DENAttribute \"name\"",
"exres": "",
"lname": "editorMarker",
"name": "get3denattribute",
"op": "get3denattribute",
"rname": "attributeType",
"since": ""
}
],
"get3DENMissionAttribute": [
{
"cat": "General",
"desc": "Returns current value set in given global attribute",
"ex": "\"Scenario\" get3DENMissionAttribute \"author\"",
"exres": "",
"lname": "<section>",
"name": "get3denmissionattribute",
"op": "get3denmissionattribute",
"rname": "<class>",
"since": ""
}
],
"getArtilleryETA": [
{
"cat": "General",
"desc": "Get ETA in seconds for given atrillery unit, it's magazineType and target position. Returns negative value if fire is not possible.",
"ex": "",
"exres": "",
"lname": "unit",
"name": "getartilleryeta",
"op": "getartilleryeta",
"rname": "[position, magazineType]",
"since": ""
}
],
"getCargoIndex": [
{
"cat": "General",
"desc": "Returns the index of the unit in Cargo",
"ex": "_index = _Jeep getCargoIndex player",
"exres": "",
"lname": "vehicle",
"name": "getcargoindex",
"op": "getcargoindex",
"rname": "Unit",
"since": ""
}
],
"getDir": [
{
"cat": "General",
"desc": "Returns azimuth from obj1 to obj2",
"ex": "unit1 getDir unit2",
"exres": "",
"lname": "obj1 or pos1",
"name": "getdir",
"op": "getdir",
"rname": "obj2 or pos2",
"since": ""
}
],
"getEditorObjectScope": [
{
"cat": "Editor",
"desc": "Returns the editor object scope of the specified editor object.",
"ex": "",
"exres": "",
"lname": "map",
"name": "geteditorobjectscope",
"op": "geteditorobjectscope",
"rname": "object",
"since": "2.92"
}
],
"getEnvSoundController": [
{
"cat": "General",
"desc": "Return specified controller value",
"ex": "(position player) getEnvSoundController \"sea\"",
"exres": "",
"lname": "position",
"name": "getenvsoundcontroller",
"op": "getenvsoundcontroller",
"rname": "name",
"since": ""
}
],
"getFSMVariable": [
{
"cat": "General",
"desc": "Return the value of variable in the variable space of given FSM. The FSM handle is the number returned by the execFSM command.",
"ex": "",
"exres": "",
"lname": "FSM handle",
"name": "getfsmvariable",
"op": "getfsmvariable",
"rname": "name or [name, default value]",
"since": "5501"
}
],
"getFriend": [
{
"cat": "General",
"desc": "Returns if sides are friendly or hostile. For a value smaller than 0.6 it results in being enemy, otherwise it's friendly.",
"ex": "value = west getFriend east",
"exres": "",
"lname": "side1",
"name": "getfriend",
"op": "getfriend",
"rname": "side2",
"since": "5501"
}
],
"getGroupIcon": [
{
"cat": "General",
"desc": "Get group icon properties.",
"ex": "group getGroupIcon id",
"exres": "",
"lname": "group",
"name": "getgroupicon",
"op": "getgroupicon",
"rname": "ID",
"since": "5501"
}
],
"getHideFrom": [
{
"cat": "General",
"desc": "Returns the hiding position in format <ar>Position</ar>. If enemy is null it is the some position in front of the object or enemy position otherwise.",
"ex": "",
"exres": "",
"lname": "object",
"name": "gethidefrom",
"op": "gethidefrom",
"rname": "enemy",
"since": "2.92"
}
],
"getHit": [
{
"cat": "General",
"desc": "Return current level of damage for a specific selection.",
"ex": "(vehicle player) getHit \"hitEngine\"",
"exres": "",
"lname": "vehicle",
"name": "gethit",
"op": "gethit",
"rname": "selectionName",
"since": "5501"
}
],
"getHitIndex": [
{
"cat": "General",
"desc": "Return current level of damage for a specific Hit Point (specified by its hit part index). All hit points can be obtained with getAllHitPointsDamage command.",
"ex": "vehicle player getHitIndex 0",
"exres": "",
"lname": "object",
"name": "gethitindex",
"op": "gethitindex",
"rname": "index",
"since": "2.30"
}
],
"getHitPointDamage": [
{
"cat": "General",
"desc": "Return current level of damage for a specific Hit Point (specified by its config class).",
"ex": "(vehicle player) getHitPointDamage \"hitEngine\"",
"exres": "",
"lname": "vehicle",
"name": "gethitpointdamage",
"op": "gethitpointdamage",
"rname": "hitpointName",
"since": "5501"
}
],
"getObjectArgument": [
{
"cat": "Editor",
"desc": "Return name of object argument in mission editor.",
"ex": "",
"exres": "",
"lname": "map",
"name": "getobjectargument",
"op": "getobjectargument",
"rname": "[object, argument]",
"since": "2.35"
}
],
"getObjectChildren": [
{
"cat": "Editor",
"desc": "Return a list of all the children of the specified object.",
"ex": "",
"exres": "",
"lname": "map",
"name": "getobjectchildren",
"op": "getobjectchildren",
"rname": "object",
"since": "2.92"
}
],
"getObjectProxy": [
{
"cat": "Editor",
"desc": "Return the proxy object associated with the given editor object.",
"ex": "",
"exres": "",
"lname": "map",
"name": "getobjectproxy",
"op": "getobjectproxy",
"rname": "object",
"since": "2.92"
}
],
"getPos": [
{
"cat": "General",
"desc": "Returns position at given distance and azimuth from current object or position",
"ex": "unit1 getPos [30,20]",
"exres": "",
"lname": "obj or pos",
"name": "getpos",
"op": "getpos",
"rname": "[dist, azimuth]",
"since": ""
}
],
"getRelDir": [
{
"cat": "General",
"desc": "Returns relative direction from obj1 to obj2",
"ex": "unit1 getRelDir unit2",
"exres": "",
"lname": "obj1",
"name": "getreldir",
"op": "getreldir",
"rname": "obj2 or pos2",
"since": ""
}
],
"getRelPos": [
{
"cat": "General",
"desc": "Returns position at given distance and relative direction from current object",
"ex": "unit1 getRelPos [30,20]",
"exres": "",
"lname": "obj",
"name": "getrelpos",
"op": "getrelpos",
"rname": "[dist, reldir]",
"since": ""
}
],
"getSoundController": [
{
"cat": "General",
"desc": "Return specified controller value",
"ex": "(vehicle player) getSoundController \"rpm\"",
"exres": "",
"lname": "vehicle",
"name": "getsoundcontroller",
"op": "getsoundcontroller",
"rname": "name",
"since": ""
}
],
"getSoundControllerResult": [
{
"cat": "General",
"desc": "Calculate expression value",
"ex": "(vehicle player) getSoundControllerResult (configfile >> \"CfgVehicles\" >> \"MRAP_01_base_F\" >> \"Sounds\" >> \"Engine\" >> \"volume\")",
"exres": "",
"lname": "vehicle",
"name": "getsoundcontrollerresult",
"op": "getsoundcontrollerresult",
"rname": "config",
"since": ""
}
],
"getSpeed": [
{
"cat": "General",
"desc": "Get the speed for the given speed mode. SpeedMode can be: \"AUTO\",\"SLOW\",\"NORMAL\",\"FAST\".",
"ex": "",
"exres": "",
"lname": "object",
"name": "getspeed",
"op": "getspeed",
"rname": "speedMode",
"since": "2.92"
}
],
"getUnitTrait": [
{
"cat": "General",
"desc": "Gets trait from given soldier",
"ex": "player getUnitTrait \"Medic\"",
"exres": "",
"lname": "player",
"name": "getunittrait",
"op": "getunittrait",
"rname": "<skill_name>",
"since": ""
}
],
"getVariable": [
{
"cat": "General",
"desc": "Returns the value of given variable set on given UI display",
"ex": "",
"exres": "",
"lname": "object",
"name": "getvariable",
"op": "getvariable",
"rname": "name or [name, defaultValue]",
"since": ""
},
{
"cat": "General",
"desc": "Returns the value of given variable set on given UI control",
"ex": "",
"exres": "",
"lname": "control",
"name": "getvariable",
"op": "getvariable",
"rname": "name or [name, defaultValue]",
"since": ""
},
{
"cat": "General",
"desc": "Return the value of variable in the variable space of given object.",
"ex": "",
"exres": "",
"lname": "object",
"name": "getvariable",
"op": "getvariable",
"rname": "name",
"since": "2.92"
},
{
"cat": "General",
"desc": "Return the value of variable in the variable space of given object. If not found, default value is returned.",
"ex": "",
"exres": "",
"lname": "object",
"name": "getvariable",
"op": "getvariable",
"rname": "[name, default value]",
"since": "2.92"
},
{
"cat": "General",
"desc": "Return the value of variable in the variable space of given group.",
"ex": "",
"exres": "",
"lname": "group",
"name": "getvariable",
"op": "getvariable",
"rname": "name",
"since": "5501"
},
{
"cat": "General",
"desc": "Return the value of variable in the variable space of given group. If not found, default value is returned.",
"ex": "",
"exres": "",
"lname": "group",
"name": "getvariable",
"op": "getvariable",
"rname": "[name, dafault value]",
"since": "5501"
},
{
"cat": "General",
"desc": "Return the value of variable in the given namespace.",
"ex": "",
"exres": "",
"lname": "namespace",
"name": "getvariable",
"op": "getvariable",
"rname": "name",
"since": "5501"
},
{
"cat": "General",
"desc": "Return the value of variable in the given namespace. If not found, default value is returned.",
"ex": "",
"exres": "",
"lname": "namespace",
"name": "getvariable",
"op": "getvariable",
"rname": "[name, default value]",
"since": "80915 TOH"
},
{
"cat": "Agents",
"desc": "Return the value of variable in the variable space of given team member.",
"ex": "",
"exres": "",
"lname": "teamMember",
"name": "getvariable",
"op": "getvariable",
"rname": "name",
"since": "2.92"
},
{
"cat": "Agents",
"desc": "Return the value of variable in the variable space of given team member.",
"ex": "",
"exres": "",
"lname": "teamMember",
"name": "getvariable",
"op": "getvariable",
"rname": "[name, default value]",
"since": "2.92"
},
{
"cat": "Identity",
"desc": "Return the value of variable in the variable space of given task.",
"ex": "",
"exres": "",
"lname": "task",
"name": "getvariable",
"op": "getvariable",
"rname": "name",
"since": "2.92"
},
{
"cat": "Identity",
"desc": "Return the value of variable in the variable space of given task.",
"ex": "",
"exres": "",
"lname": "task",
"name": "getvariable",
"op": "getvariable",
"rname": "name",
"since": "2.92"
},
{
"cat": "Location",
"desc": "Return the value of variable in the variable space of given location.",
"ex": "",
"exres": "",
"lname": "location",
"name": "getvariable",
"op": "getvariable",
"rname": "name",
"since": "2.92"
},
{
"cat": "Location",
"desc": "Return the value of variable in the variable space of given location.",
"ex": "",
"exres": "",
"lname": "location",
"name": "getvariable",
"op": "getvariable",
"rname": "name",
"since": "2.92"
}
],
"glanceAt": [
{
"cat": "General",
"desc": "Control what the unit is glancing at (target or position) (format <ar>Position</ar>)",
"ex": "someSoldier glanceAt otherSoldier; otherSoldier glanceAt getMarkerPos \"markerOne\"",
"exres": "",
"lname": "unit(s)",
"name": "glanceat",
"op": "glanceat",
"rname": "position",
"since": "2.40"
}
],
"globalChat": [
{
"cat": "General",
"desc": "Types text to the global radio channel.\r\nNote: 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.",
"ex": "soldierOne globalChat \"Show this text\"",
"exres": "",
"lname": "unit",
"name": "globalchat",
"op": "globalchat",
"rname": "chatText",
"since": ""
}
],
"globalRadio": [
{
"cat": "General",
"desc": "Sends the message to the global radio channel. The message is defined in the description.ext file or radio protocol.",
"ex": "soldierOne globalRadio \"messageOne\"",
"exres": "",
"lname": "unit",
"name": "globalradio",
"op": "globalradio",
"rname": "radioName",
"since": ""
}
],
"groupChat": [
{
"cat": "General",
"desc": "Types text to the group radio channel.\r\nNote: 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.",
"ex": "soldierOne groupChat \"Show this text\"",
"exres": "",
"lname": "unit",
"name": "groupchat",
"op": "groupchat",
"rname": "chatText",
"since": ""
}
],
"groupRadio": [
{
"cat": "General",
"desc": "Sends the message to the group radio channel. The message is defined in the description.ext file or radio protocol.",
"ex": "soldierOne groupRadio \"messageOne\"",
"exres": "",
"lname": "unit",
"name": "groupradio",
"op": "groupradio",
"rname": "radioName",
"since": ""
}
],
"groupSelectUnit": [
{
"cat": "General",
"desc": "Select unit from unit's group.",
"ex": "player groupSelectUnit [unit,true]",
"exres": "",
"lname": "unit",
"name": "groupselectunit",
"op": "groupselectunit",
"rname": "[unit,bool]",
"since": "5501"
}
],
"hasWeapon": [
{
"cat": "General",
"desc": "Checks whether the unit has the given weapon.",
"ex": "player hasWeapon \"M16\"",
"exres": "",
"lname": "unit",
"name": "hasweapon",
"op": "hasweapon",
"rname": "weaponName",
"since": ""
}
],
"hcGroupParams": [
{
"cat": "General",
"desc": "Returns parameters describing group in high command bar. Return value is [string,float[4]]",
"ex": "unit hcGroupParams group",
"exres": "",
"lname": "unit",
"name": "hcgroupparams",
"op": "hcgroupparams",
"rname": "group",
"since": "5501"
}
],
"hcRemoveGroup": [
{
"cat": "General",
"desc": "Removes group from unit's high command bar.",
"ex": "unit HCRemoveGroup group",
"exres": "",
"lname": "unit",
"name": "hcremovegroup",
"op": "hcremovegroup",
"rname": "group",
"since": "5501"
}
],
"hcSelectGroup": [
{
"cat": "General",
"desc": "Select given group in HC bar.",
"ex": "unit hcSelectGroup [group,true]",
"exres": "",
"lname": "unit",
"name": "hcselectgroup",
"op": "hcselectgroup",
"rname": "array",
"since": "5501"
}
],
"hcSetGroup": [
{
"cat": "General",
"desc": "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.",
"ex": "unit hcSetGroup [group,\"HQ\",\"teamred\"] \n or \n player hcSetGroup [group]",
"exres": "",
"lname": "unit",
"name": "hcsetgroup",
"op": "hcsetgroup",
"rname": "array",
"since": "5501"
}
],
"hideObject": [
{
"cat": "General",
"desc": "Hide object (cannot hide static objects).",
"ex": "player hideObject true",
"exres": "",
"lname": "object",
"name": "hideobject",
"op": "hideobject",
"rname": "hidden",
"since": "2.92"
}
],
"hideObjectGlobal": [
{
"cat": "General",
"desc": "Hide object (cannot hide static objects).",
"ex": "player hideObject true",
"exres": "",
"lname": "object",
"name": "hideobjectglobal",
"op": "hideobjectglobal",
"rname": "hidden",
"since": "2.92"
}
],
"hideSelection": [
{
"cat": "General",
"desc": "Hides or enables the given selection of the object.",
"ex": "object hideAnimationSelection [\"zasleh\", true]",
"exres": "",
"lname": "object",
"name": "hideselection",
"op": "hideselection",
"rname": "hide",
"since": "1.75"
}
],
"hintC": [
{
"cat": "General",
"desc": "Creates a hint dialog with the given title and text.",
"ex": "",
"exres": "",
"lname": "title",
"name": "hintc",
"op": "hintc",
"rname": "text",
"since": "2.01"
},
{
"cat": "General",
"desc": "Creates a hint dialog with the given title and text.",
"ex": "",
"exres": "",
"lname": "title",
"name": "hintc",
"op": "hintc",
"rname": "text",
"since": "2.01"
},
{
"cat": "General",
"desc": "Creates a hint dialog with the given title and text. Texts can be plain or structured.",
"ex": "",
"exres": "",
"lname": "title",
"name": "hintc",
"op": "hintc",
"rname": "[text1, text2, ...]",
"since": "2.01"
}
],
"htmlLoad": [
{
"cat": "General",
"desc": "Load HTML from file to given control. On dedicated server/client connected to a dedicated server, if allowedHTMLloadExtensions parameter is specified in the DS config file this can only succeed if a given file extension is listed in it. The list should containt at least the following extensions: txt, htm, html, xml. Note, this list may not be completely up to date",
"ex": "_control htmlLoad \"briefing.html\"",
"exres": "",
"lname": "control",
"name": "htmlload",
"op": "htmlload",
"rname": "filename",
"since": "2.53"
}
],
"in": [
{
"cat": "Default",
"desc": "Checks whether x is equal to any element in the array.",
"ex": "1 in [0, 1, 2]",
"exres": "true",
"lname": "x",
"name": "in",
"op": "in",
"rname": "array",
"since": ""
},
{
"cat": "General",
"desc": "Checks whether the soldier is mounted in the vehicle.",
"ex": "player in jeepOne",
"exres": "",
"lname": "soldier",
"name": "in",
"op": "in",
"rname": "vehicle",
"since": ""
},
{
"cat": "Location",
"desc": "Check if the position is inside area defined by the location.",
"ex": "",
"exres": "",
"lname": "position",
"name": "in",
"op": "in",
"rname": "location",
"since": "2.92"
}
],
"inArea": [
{
"cat": "General",
"desc": "Checks whether the position is in trigger area",
"ex": "player inArea trigger1",
"exres": "",
"lname": "position",
"name": "inarea",
"op": "inarea",
"rname": "trigger",
"since": ""
},
{
"cat": "General",
"desc": "Checks whether the position is in marker area",
"ex": "player inArea \"marker1\"",
"exres": "",
"lname": "position",
"name": "inarea",
"op": "inarea",
"rname": "marker",
"since": ""
},
{
"cat": "General",
"desc": "Checks whether the position is in area defined by array",
"ex": "player inArea [[123,123,0], 10, 10, 0, true]",
"exres": "",
"lname": "position",
"name": "inarea",
"op": "inarea",
"rname": "array",
"since": ""
},
{
"cat": "Location",
"desc": "Checks whether the object is in location area",
"ex": "player inArea myLocation",
"exres": "",
"lname": "object",
"name": "inarea",
"op": "inarea",
"rname": "location",
"since": ""
},
{
"cat": "Location",
"desc": "Checks whether the position is in location area",
"ex": "position player inArea myLocation",
"exres": "",
"lname": "position",
"name": "inarea",
"op": "inarea",
"rname": "location",
"since": ""
}
],
"inAreaArray": [
{
"cat": "General",
"desc": "Filters given array of objects / positions by given trigger area",
"ex": "[allVehicles] inAreaArray trigger1",
"exres": "",
"lname": "position",
"name": "inareaarray",
"op": "inareaarray",
"rname": "trigger",
"since": ""
},
{
"cat": "General",
"desc": "Filters given array of objects / positions by given marker area",
"ex": "[allVehicles] inAreaArray \"marker1\"",
"exres": "",
"lname": "position",
"name": "inareaarray",
"op": "inareaarray",
"rname": "marker",
"since": ""
},
{
"cat": "General",
"desc": "Filters given array of objects / positions by given trigger area",
"ex": "[allVehicles] inAreaArray [[123,123,0], 10, 10, 0, true]",
"exres": "",
"lname": "position",
"name": "inareaarray",
"op": "inareaarray",
"rname": "array",
"since": ""
},
{
"cat": "Location",
"desc": "Checks whether the position is in location area",
"ex": "position player inArea myLocation",
"exres": "",
"lname": "position",
"name": "inareaarray",
"op": "inareaarray",
"rname": "location",
"since": ""
}
],
"inPolygon": [
{
"cat": "General",
"desc": "Calculates wheater position is inside given polygon.",
"ex": "[100,100,0] inPolygon [[0,0,0], [1000,1000,0], [1000,0,0]]",
"exres": "",
"lname": "position",
"name": "inpolygon",
"op": "inpolygon",
"rname": "[<polygon_vectors>]",
"since": ""
}
],
"inRangeOfArtillery": [
{
"cat": "General",
"desc": "Returns true if all given units are able to fire at given position with given magazineType.",
"ex": "",
"exres": "",
"lname": "pos",
"name": "inrangeofartillery",
"op": "inrangeofartillery",
"rname": "[[unit1, unit2, ...], magazineType]",
"since": ""
}
],
"inflame": [
{
"cat": "General",
"desc": "Controls fireplace buring. Set to true to inflame the fireplace.",
"ex": "fireplaceOne inflame true",
"exres": "",
"lname": "fireplace",
"name": "inflame",
"op": "inflame",
"rname": "burn",
"since": ""
}
],
"insertEditorObject": [
{
"cat": "Editor",
"desc": "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.",
"ex": "",
"exres": "",
"lname": "map",
"name": "inserteditorobject",
"op": "inserteditorobject",
"rname": "[type, value, [name1, value1, ...], subtype class]",
"since": "2.92"
}
],
"intersect": [
{
"cat": "General",
"desc": "Find named selection in object which is in specified lod intersected by given section of a line.",
"ex": "[tank, \"VIEW\" intersect [[1500, 1500, 2], [1550, 1500, 2]]",
"exres": "",
"lname": "[object, lod name]",
"name": "intersect",
"op": "intersect",
"rname": "[begin, end]",
"since": "2.53"
}
],
"isEqualTo": [
{
"cat": "General",
"desc": "Performs strict comparison between var1 and var2 and returns true if equal otherwise false.",
"ex": "_arr1 = [1,2,[3]];\n_arr2 = [1,2,[3]];\nif (_arr1 isEqualTo _arr2) then {hint \"arrays match!\"};",
"exres": "",
"lname": "var1",
"name": "isequalto",
"op": "isequalto",
"rname": "var2",
"since": "5501"
}
],
"isEqualType": [
{
"cat": "General",
"desc": "Checks if type of provided value matches the expected type",
"ex": "_var isEqualType []",
"exres": "",
"lname": "anything",
"name": "isequaltype",
"op": "isequaltype",
"rname": "anything",
"since": ""
}
],
"isEqualTypeAll": [
{
"cat": "General",
"desc": "Checks if types of all elements of provided array match specific type",
"ex": "[1,2,3,4,5] isEqualTypeAll 0",
"exres": "",
"lname": "array",
"name": "isequaltypeall",
"op": "isequaltypeall",
"rname": "anything",
"since": ""
}
],
"isEqualTypeAny": [
{
"cat": "General",
"desc": "Checks if given value matches any of the types in test array",
"ex": "_pos isEqualTypeAny [[],objNull]",
"exres": "",
"lname": "anything",
"name": "isequaltypeany",
"op": "isequaltypeany",
"rname": "array",
"since": ""
}
],
"isEqualTypeArray": [
{
"cat": "General",
"desc": "Checks if types of types of all elements of provided array match types of another array exactly",
"ex": "[1,true,\"three\"] isEqualTypeArray [0,true,0,\"\"]",
"exres": "",
"lname": "array",
"name": "isequaltypearray",
"op": "isequaltypearray",
"rname": "array",
"since": ""
}
],
"isEqualTypeParams": [
{
"cat": "General",
"desc": "Checks if the types of provided params match the expected types",
"ex": "[1,player,\"ok\"] isEqualTypeParams [0,objNull,\"\"]",
"exres": "",
"lname": "array",
"name": "isequaltypeparams",
"op": "isequaltypeparams",
"rname": "array",
"since": ""
}
],
"isFlashlightOn": [
{
"cat": "General",
"desc": "Return if there is a linked and enabled flashlight on a given weapon.",
"ex": "player IsFlashlightOn (currentWeapon player)",
"exres": "",
"lname": "unit",
"name": "isflashlighton",
"op": "isflashlighton",
"rname": "weapon",
"since": ""
}
],
"isFlatEmpty": [
{
"cat": "General",
"desc": "Chek if given area is flat and emty.",
"ex": "newposition = position isFlatEmpty(10, 0, 0.5, 5, 0, false, player)",
"exres": "",
"lname": "position",
"name": "isflatempty",
"op": "isflatempty",
"rname": "[float minDistance,float precizePos,float maxGradient,float gradientRadius,float onWater,bool onShore,object skipobj]",
"since": "5501"
}
],
"isIRLaserOn": [
{
"cat": "General",
"desc": "",
"ex": "Return if there is a linked and enabled IR on a given weapon.",
"exres": "player IsIRLaserOn (currentWeapon player)",
"lname": "unit",
"name": "isirlaseron",
"op": "isirlaseron",
"rname": "weapon",
"since": ""
}
],
"isKindOf": [
{
"cat": "General",
"desc": "Checks whether the type typeName1 is inherited from the type typeName1.",
"ex": "\"Tank\" isKindOf \"Land\"",
"exres": "true",
"lname": "typeName1",
"name": "iskindof",
"op": "iskindof",
"rname": "typeName2",
"since": "5160"
},
{
"cat": "General",
"desc": "Checks whether the type typeName1 is inherited from the type typeName1.",
"ex": "\"Tank\" isKindOf [\"Land\", configFile >> \"CfgVehicles\"];",
"exres": "true",
"lname": "typeName1",
"name": "iskindof",
"op": "iskindof",
"rname": "[typeName2, config]",
"since": "5160"
},
{
"cat": "General",
"desc": "Checks whether the object is of the given type.",
"ex": "vehicle player isKindOf \"Tank\"",
"exres": "",
"lname": "object",
"name": "iskindof",
"op": "iskindof",
"rname": "typeName",
"since": "2.30"
}
],
"isUAVConnectable": [
{
"cat": "General",
"desc": "return true, if UAV is connectable by AV terminal(s)",
"ex": "connetable = unit isUAVConnectable [uav, true]",
"exres": "",
"lname": "object",
"name": "isuavconnectable",
"op": "isuavconnectable",
"rname": "[uav, checkAllItems]",
"since": ""
}
],
"isUniformAllowed": [
{
"cat": "General",
"desc": "Check whether given uniform can be dressed by target soldier.",
"ex": "",
"exres": "",
"lname": "unit",
"name": "isuniformallowed",
"op": "isuniformallowed",
"rname": "type",
"since": ""
}
],
"join": [
{
"cat": "General",
"desc": "Joins all units in the array to the given group.\r\nNote: the total number of group members cannot exceed 12.\r\nNote: This function is unsupported in MP in version 1.33 and before.",
"ex": "[unitOne, unitTwo] join player",
"exres": "",
"lname": "unitArray",
"name": "join",
"op": "join",
"rname": "group",
"since": ""
}
],
"joinAs": [
{
"cat": "General",
"desc": "Joins the unit to the given group, if position id is available, this one is used.",
"ex": "player joinAs [_group, 4]",
"exres": "",
"lname": "unit",
"name": "joinas",
"op": "joinas",
"rname": "[group, id]",
"since": ""
}
],
"joinAsSilent": [
{
"cat": "General",
"desc": "Joins the unit to the given group, if position id is available, this one is used. Avoid any radio communication related to joining.",
"ex": "player joinAsSilent [_group, 4]",
"exres": "",
"lname": "unit",
"name": "joinassilent",
"op": "joinassilent",
"rname": "[group, id]",
"since": ""
}
],
"joinSilent": [
{
"cat": "General",
"desc": "Joins all units in the array to the given group. Avoid any radio communication related to joining.",
"ex": "[unitOne, unitTwo] joinSilent player",
"exres": "",
"lname": "unitArray",
"name": "joinsilent",
"op": "joinsilent",
"rname": "group",
"since": ""
}
],
"joinString": [
{
"cat": "Default",
"desc": "Joins array into string with given delimiter",
"ex": "[1,2,3] joinString \":\"",
"exres": "",
"lname": "array",
"name": "joinstring",
"op": "joinstring",
"rname": "string",
"since": ""
}
],
"kbAddDatabase": [
{
"cat": "General",
"desc": "Register knowledge base database to given person.",
"ex": "_unit kbAddDatabase \"chat.txt\"",
"exres": "",
"lname": "person",
"name": "kbadddatabase",
"op": "kbadddatabase",
"rname": "filename",
"since": "2.42"
}
],
"kbAddDatabaseTargets": [
{
"cat": "General",
"desc": "Register target list knowledge base database to given person.",
"ex": "_unit kbAddDatabase \"chat.txt\"",
"exres": "",
"lname": "person",
"name": "kbadddatabasetargets",
"op": "kbadddatabasetargets",
"rname": "filename",
"since": "2.45"
}
],
"kbAddTopic": [
{
"cat": "General",
"desc": "Register conversation topic to given person.",
"ex": "",
"exres": "",
"lname": "person",
"name": "kbaddtopic",
"op": "kbaddtopic",
"rname": "[name, filename(, task type(, player event handler))]",
"since": "2.92"
}
],
"kbHasTopic": [
{
"cat": "General",
"desc": "Check if conversation topic was registered to given person.",
"ex": "",
"exres": "",
"lname": "person",
"name": "kbhastopic",
"op": "kbhastopic",
"rname": "name",
"since": "2.92"
}
],
"kbReact": [
{
"cat": "General",
"desc": "Pass a non-verbal communication to the receiver.",
"ex": "",
"exres": "",
"lname": "person",
"name": "kbreact",
"op": "kbreact",
"rname": "[receiver, topic, sentence id, [argument name, argument value, argument text, argument speech], ...]",
"since": "5500"
}
],
"kbRemoveTopic": [
{
"cat": "General",
"desc": "Unregister conversation topic from given person.",
"ex": "",
"exres": "",
"lname": "person",
"name": "kbremovetopic",
"op": "kbremovetopic",
"rname": "name",
"since": "2.92"
}
],
"kbTell": [
{
"cat": "General",
"desc": "Make the person tell to the receiver the sentence. Last parameter can be false/true to force radio channel selection, or number 1..10 to force possible CustomChannel, or radio channel name 'GLOBAL','SIDE','GROUP','VEHICLE','DIRECT','COMMAND'.",
"ex": "",
"exres": "",
"lname": "person",
"name": "kbtell",
"op": "kbtell",
"rname": "[receiver, topic, sentence id, [argument name, argument value, argument text, argument speech], ...]",
"since": "2.92"
}
],
"kbWasSaid": [
{
"cat": "General",
"desc": "Check if given item was said by person to someone.",
"ex": "",
"exres": "",
"lname": "person",
"name": "kbwassaid",
"op": "kbwassaid",
"rname": "[receiver, topic, sentence id, max. age]",
"since": "5500"
}
],
"knowsAbout": [
{
"cat": "General",
"desc": "Checks whether the unit knows about the target (and how much). If the unit is a vehicle, the vehicle commander is considered instead.",
"ex": "soldierOne knowsAbout jeepOne",
"exres": "",
"lname": "unit",
"name": "knowsabout",
"op": "knowsabout",
"rname": "target",
"since": ""
},
{
"cat": "General",
"desc": "Checks whether the side knows about the target (and how much).",
"ex": "east knowsAbout jeepOne",
"exres": "",
"lname": "side",
"name": "knowsabout",
"op": "knowsabout",
"rname": "target",
"since": "5501"
}
],
"land": [
{
"cat": "General",
"desc": "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).",
"ex": "cobraOne land \"LAND\"",
"exres": "",
"lname": "helicopter",
"name": "land",
"op": "land",
"rname": "mode",
"since": ""
}
],
"landAt": [
{
"cat": "General",
"desc": "Order AI airplane to land at given airport",
"ex": "plane landAt 0",
"exres": "",
"lname": "airplane",
"name": "landat",
"op": "landat",
"rname": "airportId",
"since": "2.92"
}
],
"lbAdd": [
{
"cat": "General",
"desc": "Adds an item with the given text to the given listbox or combobox. It returns the index of the newly added item.",
"ex": "_index = _control lbAdd \"First item\"",
"exres": "",
"lname": "control",
"name": "lbadd",
"op": "lbadd",
"rname": "text",
"since": "2.91"
}
],
"lbColor": [
{
"cat": "General",
"desc": "Returns the text color of the item with the given index of the given listbox or combobox.",
"ex": "_color = _control lbColor 0",
"exres": "",
"lname": "control",
"name": "lbcolor",
"op": "lbcolor",
"rname": "index",
"since": "2.91"
}
],
"lbColorRight": [
{
"cat": "General",
"desc": "Returns the text color of the secondary text (right aligned) of the item with the given index of the given listbox or combobox.",
"ex": "_color = _control lbColorRight 0",
"exres": "",
"lname": "control",
"name": "lbcolorright",
"op": "lbcolorright",
"rname": "index",
"since": ""
}
],
"lbData": [
{
"cat": "General",
"desc": "Returns the additional text (invisible) in an item with the given index of the given listbox or combobox.",
"ex": "_data = _control lbData 0",
"exres": "",
"lname": "control",
"name": "lbdata",
"op": "lbdata",
"rname": "index",
"since": "2.91"
}
],
"lbDelete": [
{
"cat": "General",
"desc": "Removes the item with the given index from the given listbox or combobox.",
"ex": "_control lbDelete 0",
"exres": "",
"lname": "control",
"name": "lbdelete",
"op": "lbdelete",
"rname": "index",
"since": "2.91"
}
],
"lbIsSelected": [
{
"cat": "General",
"desc": "Check whether given row of the given listbox is selected.",
"ex": "_selected = _control lbIsSelected 0",
"exres": "",
"lname": "control",
"name": "lbisselected",
"op": "lbisselected",
"rname": "index",
"since": "2.92"
}
],
"lbPicture": [
{
"cat": "General",
"desc": "Returns the picture name of the item with the given index of the given listbox or combobox.",
"ex": "_picture = _control lbPicture 0",
"exres": "",
"lname": "control",
"name": "lbpicture",
"op": "lbpicture",
"rname": "index",
"since": "2.91"
}
],
"lbPictureRight": [
{
"cat": "General",
"desc": "Returns the second (right aligned) picture name of the item with the given index of the given listbox or combobox.",
"ex": "_picture = _control lbPictureRight 0",
"exres": "",
"lname": "control",
"name": "lbpictureright",
"op": "lbpictureright",
"rname": "index",
"since": "2.91"
}
],
"lbSetColor": [
{
"cat": "General",
"desc": "Sets the text color of the item with the given index of the given listbox or combobox. Color is in format <ar>Color</ar>.",
"ex": "_control lbSetColor [0, [0, 1, 0, 0.5]]",
"exres": "",
"lname": "control",
"name": "lbsetcolor",
"op": "lbsetcolor",
"rname": "[index, color]",
"since": "2.91"
}
],
"lbSetColorRight": [
{
"cat": "General",
"desc": "Sets the text color of the secondary text (right aligned) of the item with the given index of the given listbox or combobox. Color is in format <ar>Color</ar>.",
"ex": "_control lbSetColorRight [0, [0, 1, 0, 0.5]]",
"exres": "",
"lname": "control",
"name": "lbsetcolorright",
"op": "lbsetcolorright",
"rname": "[index, color]",
"since": ""
}
],
"lbSetCurSel": [
{
"cat": "General",
"desc": "Selects the item with the given index of the given listbox or combobox.",
"ex": "_control lbSetCurSel 0",
"exres": "",
"lname": "control",
"name": "lbsetcursel",
"op": "lbsetcursel",
"rname": "index",
"since": "2.91"
}
],
"lbSetData": [
{
"cat": "General",
"desc": "Sets the additional text (invisible) in the item with the given index of the given listbox or combobox to the given data.",
"ex": "_control lbSetData [1, \"#1\"]",
"exres": "",
"lname": "control",
"name": "lbsetdata",
"op": "lbsetdata",
"rname": "[index, data]",
"since": "2.91"
}
],
"lbSetPicture": [
{
"cat": "General",
"desc": "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).",
"ex": "_control lbSetPicture [0, \"iskoda\"]",
"exres": "",
"lname": "control",
"name": "lbsetpicture",
"op": "lbsetpicture",
"rname": "[index, name]",
"since": "2.91"
}
],
"lbSetPictureColor": [
{
"cat": "General",
"desc": "Sets the color of the picture of the item with the given index of the given listbox or combobox. Color is in format <ar>Color</ar>. (color which consists from only zeros means disable this override)",
"ex": "_control lbSetColor [0, [0, 1, 0, 0.5]]",
"exres": "",
"lname": "control",
"name": "lbsetpicturecolor",
"op": "lbsetpicturecolor",
"rname": "[index, color]",
"since": "2.91"
}
],
"lbSetPictureColorDisabled": [
{
"cat": "General",
"desc": "Sets the color of the picture of the item with the given index of the given listbox or combobox when control is disabled. Color is in format <ar>Color</ar>. (color which consists from only zeros means disable this override)",
"ex": "_control lbSetColor [0, [0, 1, 0, 0.5]]",
"exres": "",
"lname": "control",
"name": "lbsetpicturecolordisabled",
"op": "lbsetpicturecolordisabled",
"rname": "[index, color]",
"since": "2.91"
}
],
"lbSetPictureColorSelected": [
{
"cat": "General",
"desc": "Sets the color of the picture of the item with the given index of the given listbox or combobox when item is selected. Color is in format <ar>Color</ar>. (color which consists from only zeros means disable this override)",
"ex": "_control lbSetColor [0, [0, 1, 0, 0.5]]",
"exres": "",
"lname": "control",
"name": "lbsetpicturecolorselected",
"op": "lbsetpicturecolorselected",
"rname": "[index, color]",
"since": "2.91"
}
],
"lbSetPictureRight": [
{
"cat": "General",
"desc": "Sets the second (right aligned) 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).",
"ex": "_control lbSetPictureRight [0, \"iskoda\"]",
"exres": "",
"lname": "control",
"name": "lbsetpictureright",
"op": "lbsetpictureright",
"rname": "[index, name]",
"since": "2.91"
}
],
"lbSetPictureRightColor": [
{
"cat": "General",
"desc": "Sets the color of the second (right aligned) picture of the of the item with the given index of the given listbox or combobox. Color is in format <ar>Color</ar>. (color which consists from only zeros means disable this override)",
"ex": "_control lbSetPictureRightColor [0, [0, 1, 0, 0.5]]",
"exres": "",
"lname": "control",
"name": "lbsetpicturerightcolor",
"op": "lbsetpicturerightcolor",
"rname": "[index, color]",
"since": "2.91"
}
],
"lbSetPictureRightColorDisabled": [
{
"cat": "General",
"desc": "Sets the color of the second (right aligned) picture of the item with the given index of the given listbox or combobox when control is disabled. Color is in format <ar>Color</ar>. (color which consists from only zeros means disable this override)",
"ex": "_control lbSetPictureRightColorDisabled [0, [0, 1, 0, 0.5]]",
"exres": "",
"lname": "control",
"name": "lbsetpicturerightcolordisabled",
"op": "lbsetpicturerightcolordisabled",
"rname": "[index, color]",
"since": "2.91"
}
],
"lbSetPictureRightColorSelected": [
{
"cat": "General",
"desc": "Sets the color of the second (right aligned) picture of the item with the given index of the given listbox or combobox when item is selected. Color is in format <ar>Color</ar>. (color which consists from only zeros means disable this override)",
"ex": "_control lbSetPictureRightColorSelected [0, [0, 1, 0, 0.5]]",
"exres": "",
"lname": "control",
"name": "lbsetpicturerightcolorselected",
"op": "lbsetpicturerightcolorselected",
"rname": "[index, color]",
"since": "2.91"
}
],
"lbSetSelectColor": [
{
"cat": "General",
"desc": "Sets the text select color of the item with the given index of the given listbox or combobox. Color is in format <ar>Color</ar>.",
"ex": "_control lbSetSelectColor [0, [0, 1, 0, 0.5]]",
"exres": "",
"lname": "control",
"name": "lbsetselectcolor",
"op": "lbsetselectcolor",
"rname": "[index, color]",
"since": "2.91"
}
],
"lbSetSelectColorRight": [
{
"cat": "General",
"desc": "Sets the text select color of the secondary text (right aligned) of the item with the given index of the given listbox or combobox. Color is in format <ar>Color</ar>.",
"ex": "_control lbSetSelectColorRight [0, [0, 1, 0, 0.5]]",
"exres": "",
"lname": "control",
"name": "lbsetselectcolorright",
"op": "lbsetselectcolorright",
"rname": "[index, color]",
"since": ""
}
],
"lbSetSelected": [
{
"cat": "General",
"desc": "Set the selection state of the given row of the given listbox. Listbox must support multiple selection",
"ex": "_control lbSetSelection [0, true]",
"exres": "",
"lname": "control",
"name": "lbsetselected",
"op": "lbsetselected",
"rname": "[index, selected]",
"since": "5501"
}
],
"lbSetText": [
{
"cat": "General",
"desc": "Sets the text in the item with the given index of the given listbox or combobox to the given data.",
"ex": "_control lbSetText [1, \"#1\"]",
"exres": "",
"lname": "control",
"name": "lbsettext",
"op": "lbsettext",
"rname": "[index, text]",
"since": "1.18"
}
],
"lbSetTextRight": [
{
"cat": "General",
"desc": "Sets the secondary text (right aligned) in the item with the given index of the given listbox or combobox to the given data.",
"ex": "_control lbSetTextRight [1, \"#1\"]",
"exres": "",
"lname": "control",
"name": "lbsettextright",
"op": "lbsettextright",
"rname": "[index, text]",
"since": ""
}
],
"lbSetTooltip": [
{
"cat": "General",
"desc": "Sets tooltip for item with the given index of the given listbox or combobox to the given data.",
"ex": "_control lbSetData [1, \"tooltip\"]",
"exres": "",
"lname": "control",
"name": "lbsettooltip",
"op": "lbsettooltip",
"rname": "[index, tooltip]",
"since": ""
}
],
"lbSetValue": [
{
"cat": "General",
"desc": "Sets the additional integer value in the item with the given index of the given listbox or combobox to the given value.",
"ex": "_control lbSetValue [0, 1]",
"exres": "",
"lname": "control",
"name": "lbsetvalue",
"op": "lbsetvalue",
"rname": "[index, value]",
"since": "2.91"
}
],
"lbText": [
{
"cat": "General",
"desc": "Returns the shown text in the item with the given index of the given listbox or combobox.",
"ex": "_text = _control lbText 0",
"exres": "",
"lname": "control",
"name": "lbtext",
"op": "lbtext",
"rname": "index",
"since": "2.91"
}
],
"lbTextRight": [
{
"cat": "General",
"desc": "Returns the second text (right aligned) in the item with the given index of the given listbox or combobox.",
"ex": "_text = _control lbTextRight 0",
"exres": "",
"lname": "control",
"name": "lbtextright",
"op": "lbtextright",
"rname": "index",
"since": ""
}
],
"lbValue": [
{
"cat": "General",
"desc": "Returns the additional integer value in the item with the given index of the given listbox or combobox.",
"ex": "_value = _control lbValue 0",
"exres": "",
"lname": "control",
"name": "lbvalue",
"op": "lbvalue",
"rname": "index",
"since": "2.91"
}
],
"leaveVehicle": [
{
"cat": "General",
"desc": "Ceases the using of the vehicle in the group. It unassigns all grouped units from the vehicle.",
"ex": "soldierOne leaveVehicle jeepOne",
"exres": "",
"lname": "group",
"name": "leavevehicle",
"op": "leavevehicle",
"rname": "vehicle",
"since": ""
},
{
"cat": "General",
"desc": "Ceases the using of the vehicle in the group. It unassigns all grouped units from the vehicle.",
"ex": "groupOne leaveVehicle jeepOne",
"exres": "",
"lname": "group",
"name": "leavevehicle",
"op": "leavevehicle",
"rname": "vehicle",
"since": ""
}
],
"lightAttachObject": [
{
"cat": "General",
"desc": "Attach light to given object (at given position).",
"ex": "",
"exres": "",
"lname": "light",
"name": "lightattachobject",
"op": "lightattachobject",
"rname": "[object, position]",
"since": "2.58"
}
],
"limitSpeed": [
{
"cat": "General",
"desc": "Limit speed of given vehicle to given value (in km/h).",
"ex": "",
"exres": "",
"lname": "object",
"name": "limitspeed",
"op": "limitspeed",
"rname": "speed",
"since": "2.92"
}
],
"linkItem": [
{
"cat": "General",
"desc": "Create and assign new item to the soldier's body.(NVG, radio, ...)",
"ex": "",
"exres": "",
"lname": "unit",
"name": "linkitem",
"op": "linkitem",
"rname": "item",
"since": ""
}
],
"listObjects": [
{
"cat": "Editor",
"desc": "Return the list of all objects of given type.",
"ex": "",
"exres": "",
"lname": "map",
"name": "listobjects",
"op": "listobjects",
"rname": "type",
"since": "2.92"
}
],
"lnbAddColumn": [
{
"cat": "General",
"desc": "Adds an item with the given text to the given listbox or combobox. It returns the index of the newly added item.",
"ex": "_index = _control lbAdd \"First item\"",
"exres": "",
"lname": "control",
"name": "lnbaddcolumn",
"op": "lnbaddcolumn",
"rname": "position",
"since": "5501"
}
],
"lnbAddRow": [
{
"cat": "General",
"desc": "Adds an row to the end od 2d listbox . It returns the index of the newly added row.",
"ex": "_index = _control lnbAdd [t1,t2,t3,...]",
"exres": "",
"lname": "control",
"name": "lnbaddrow",
"op": "lnbaddrow",
"rname": "[text1,text2,...]",
"since": "5501"
}
],
"lnbColor": [
{
"cat": "General",
"desc": "Returns the text color of the item with the given position of the given 2D listbox.",
"ex": "_color = _control lnbColor [row, column]",
"exres": "",
"lname": "control",
"name": "lnbcolor",
"op": "lnbcolor",
"rname": "[row, column]",
"since": "5501"
}
],
"lnbColorRight": [
{
"cat": "General",
"desc": "Returns the text color of the secondary text (right aligned) of the item with the given position of the given 2D listbox.",
"ex": "_color = _control lnbColorRight [row, column]",
"exres": "",
"lname": "control",
"name": "lnbcolorright",
"op": "lnbcolorright",
"rname": "[row, column]",
"since": ""
}
],
"lnbData": [
{
"cat": "General",
"desc": "Returns the additional text (invisible) in an item with the given position of the given 2D listbox.",
"ex": "_data = _control lnbData [row, column]",
"exres": "",
"lname": "control",
"name": "lnbdata",
"op": "lnbdata",
"rname": "[row, column]",
"since": "5501"
}
],
"lnbDeleteColumn": [
{
"cat": "General",
"desc": "Removes the item with the given index from the given listbox or combobox.",
"ex": "_control lbDelete 0",
"exres": "",
"lname": "control",
"name": "lnbdeletecolumn",
"op": "lnbdeletecolumn",
"rname": "index",
"since": "5501"
}
],
"lnbDeleteRow": [
{
"cat": "General",
"desc": "Removes row with the given index from the given listbox or combobox.",
"ex": "_control lnbDelete 0",
"exres": "",
"lname": "control",
"name": "lnbdeleterow",
"op": "lnbdeleterow",
"rname": "row",
"since": "5501"
}
],
"lnbPicture": [
{
"cat": "General",
"desc": "Returns the picture name of the item with the given position of the given listbox or combobox.",
"ex": "_picture = _control lnbPicture [row, column]",
"exres": "",
"lname": "control",
"name": "lnbpicture",
"op": "lnbpicture",
"rname": "[row, column]",
"since": "5501"
}
],
"lnbPictureRight": [
{
"cat": "General",
"desc": "Returns the name of the second (right aligned) picture of the item with the given position of the given listbox or combobox.",
"ex": "_picture = _control lnbPictureRight [row, column]",
"exres": "",
"lname": "control",
"name": "lnbpictureright",
"op": "lnbpictureright",
"rname": "[row, column]",
"since": "5501"
}
],
"lnbSetColor": [
{
"cat": "General",
"desc": "Sets the text color of the item with the given position of the given 2D listbox . Color is in format <ar>Color</ar>.",
"ex": "_control lnbSetColor [[row, column], [0, 1, 0, 0.5]]",
"exres": "",
"lname": "control",
"name": "lnbsetcolor",
"op": "lnbsetcolor",
"rname": "[[row, column], color]",
"since": "5501"
}
],
"lnbSetColorRight": [
{
"cat": "General",
"desc": "Sets the text color of the secondary text (right aligned) of the item with the given position of the given 2D listbox . Color is in format <ar>Color</ar>.",
"ex": "_control lnbSetColorRight [[row, column], [0, 1, 0, 0.5]]",
"exres": "",
"lname": "control",
"name": "lnbsetcolorright",
"op": "lnbsetcolorright",
"rname": "[[row, column], color]",
"since": ""
}
],
"lnbSetColumnsPos": [
{
"cat": "General",
"desc": "Set position of 2d listbox columns.",
"ex": "_control lbSetColumnsPos [pos1,pos2,...]",
"exres": "",
"lname": "control",
"name": "lnbsetcolumnspos",
"op": "lnbsetcolumnspos",
"rname": "[pos1,pos2,...]",
"since": "5501"
}
],
"lnbSetCurSelRow": [
{
"cat": "General",
"desc": "Selects the item with the given index of the given listbox or combobox.",
"ex": "_control lbSetCurSel row",
"exres": "",
"lname": "control",
"name": "lnbsetcurselrow",
"op": "lnbsetcurselrow",
"rname": "row",
"since": "5501"
}
],
"lnbSetData": [
{
"cat": "General",
"desc": "Sets the additional text (invisible) in the item with the given position of the given 2D listbox to the given data.",
"ex": "_control lnbSetData [[row, column], \"#1\"]",
"exres": "",
"lname": "control",
"name": "lnbsetdata",
"op": "lnbsetdata",
"rname": "[[row, column], data]",
"since": "5501"
}
],
"lnbSetPicture": [
{
"cat": "General",
"desc": "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).",
"ex": "_control lnbSetPicture [[row, column], \"iskoda\"]",
"exres": "",
"lname": "control",
"name": "lnbsetpicture",
"op": "lnbsetpicture",
"rname": "[[row, column], name]",
"since": ""
}
],
"lnbSetPictureColor": [
{
"cat": "General",
"desc": "Sets the picture color in the item with the given position of the given 2D listbox.",
"ex": "_control lnbSetPictureColor [[row, column], [1,0,1,1]]",
"exres": "",
"lname": "control",
"name": "lnbsetpicturecolor",
"op": "lnbsetpicturecolor",
"rname": "[[row, column], [r,g,b,a]]",
"since": ""
}
],
"lnbSetPictureColorRight": [
{
"cat": "General",
"desc": "Sets the second (right aligned) picture color in the item with the given position of the given 2D listbox.",
"ex": "_control lnbSetPictureColorRight [[row, column], [1,0,1,1]]",
"exres": "",
"lname": "control",
"name": "lnbsetpicturecolorright",
"op": "lnbsetpicturecolorright",
"rname": "[[row, column], [r,g,b,a]]",
"since": ""
}
],
"lnbSetPictureColorSelected": [
{
"cat": "General",
"desc": "Sets the picture color in the item with the given position of the given 2D listbox.",
"ex": "_control lnbSetPictureColor [[row, column], [1,0,1,1]]",
"exres": "",
"lname": "control",
"name": "lnbsetpicturecolorselected",
"op": "lnbsetpicturecolorselected",
"rname": "[[row, column], [r,g,b,a]]",
"since": ""
}
],
"lnbSetPictureColorSelectedRight": [
{
"cat": "General",
"desc": "Sets the second (right aligned) picture color in the item with the given position of the given 2D listbox.",
"ex": "_control lnbSetPictureColorRight [[row, column], [1,0,1,1]]",
"exres": "",
"lname": "control",
"name": "lnbsetpicturecolorselectedright",
"op": "lnbsetpicturecolorselectedright",
"rname": "[[row, column], [r,g,b,a]]",
"since": ""
}
],
"lnbSetPictureRight": [
{
"cat": "General",
"desc": "Sets the second (right aligned) 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).",
"ex": "_control lnbSetPictureRight [[row, column], \"iskoda\"]",
"exres": "",
"lname": "control",
"name": "lnbsetpictureright",
"op": "lnbsetpictureright",
"rname": "[[row, column], name]",
"since": ""
}
],
"lnbSetText": [
{
"cat": "General",
"desc": "Sets the additional text (invisible) in the item with the given index of the given 2D listbox to the given data.",
"ex": "_control lnbSetData [[row, column], \"#1\"]",
"exres": "",
"lname": "control",
"name": "lnbsettext",
"op": "lnbsettext",
"rname": "[[row, column], text]",
"since": "5501"
}
],
"lnbSetTextRight": [
{
"cat": "General",
"desc": "Sets the secondary (right aligned) text in the item with the given index of the given 2D listbox to the given data.",
"ex": "_control lnbSetTextRight [[row, column], \"#1\"]",
"exres": "",
"lname": "control",
"name": "lnbsettextright",
"op": "lnbsettextright",
"rname": "[[row, column], text]",
"since": ""
}
],
"lnbSetValue": [
{
"cat": "General",
"desc": "Sets the additional integer value in the item with the given position of the given 2D listbox to the given value.",
"ex": "_control lnbSetValue [[row, column], 1]",
"exres": "",
"lname": "control",
"name": "lnbsetvalue",
"op": "lnbsetvalue",
"rname": "[[row, column], value]",
"since": "5501"
}
],
"lnbSort": [
{
"cat": "General",
"desc": "Sorts given listnbox by texts in given column.",
"ex": "_control lnbSort [0, false]",
"exres": "",
"lname": "control",
"name": "lnbsort",
"op": "lnbsort",
"rname": "[column(, order)]",
"since": ""
}
],
"lnbSortByValue": [
{
"cat": "General",
"desc": "Sorts given listnbox by values in given column.",
"ex": "_control lnbSortByValue [0, false]",
"exres": "",
"lname": "control",
"name": "lnbsortbyvalue",
"op": "lnbsortbyvalue",
"rname": "[column(, order)]",
"since": ""
}
],
"lnbText": [
{
"cat": "General",
"desc": "Returns the shown text in the item with the given position of the given 2D listbox.",
"ex": "_text = _control lnbText [row, column]",
"exres": "",
"lname": "control",
"name": "lnbtext",
"op": "lnbtext",
"rname": "[row, column]",
"since": "5501"
}
],
"lnbTextRight": [
{
"cat": "General",
"desc": "Returns the shown secondary (right aligned) text in the item with the given position of the given 2D listbox.",
"ex": "_text = _control lnbTextRight [row, column]",
"exres": "",
"lname": "control",
"name": "lnbtextright",
"op": "lnbtextright",
"rname": "[row, column]",
"since": ""
}
],
"lnbValue": [
{
"cat": "General",
"desc": "Returns the additional integer value in the item with the given position of the given 2D listbox.",
"ex": "_value = _control lnbValue [row, column]",
"exres": "",
"lname": "control",
"name": "lnbvalue",
"op": "lnbvalue",
"rname": "[row, column]",
"since": "5501"
}
],
"loadIdentity": [
{
"cat": "General",
"desc": "Loads person's identity from objects.sav file in campaign directory (from entry name).",
"ex": "player loadIdentity \"playerIdentity\"",
"exres": "",
"lname": "person",
"name": "loadidentity",
"op": "loadidentity",
"rname": "name",
"since": "1.75"
}
],
"loadMagazine": [
{
"cat": "General",
"desc": "Initiates the loading action on active weapon of the given turret.",
"ex": "vehicle player loadMagazine [[0],\"m256\",\"20Rnd_120mmHE_M1A2\"]",
"exres": "",
"lname": "vehicle",
"name": "loadmagazine",
"op": "loadmagazine",
"rname": "[[turret path],magazine name]",
"since": "86244"
}
],
"loadOverlay": [
{
"cat": "Editor",
"desc": "Creates the load overlay dialog for the specified type of overlay.",
"ex": "",
"exres": "",
"lname": "map",
"name": "loadoverlay",
"op": "loadoverlay",
"rname": "config",
"since": "2.92"
}
],
"loadStatus": [
{
"cat": "General",
"desc": "Loads object's properties from objects.sav file in campaign directory (from entry name).",
"ex": "player loadStatus \"playerState\"",
"exres": "",
"lname": "object",
"name": "loadstatus",
"op": "loadstatus",
"rname": "name",
"since": "1.75"
}
],
"lock": [
{
"cat": "General",
"desc": "Locks the vehicle (disables mounting / dismounting) for the player.",
"ex": "jeepOne lock true",
"exres": "",
"lname": "vehicle",
"name": "lock",
"op": "lock",
"rname": "lock",
"since": ""
},
{
"cat": "General",
"desc": "Locks the vehicle (disables mounting / dismounting) for the player. 0 - Unlocked, 1 - Default, 2 - Locked, 3 - Locked for player",
"ex": "jeepOne lock 3",
"exres": "",
"lname": "vehicle",
"name": "lock",
"op": "lock",
"rname": "lock",
"since": ""
}
],
"lockCameraTo": [
{
"cat": "General",
"desc": "Lock/unlock camera to target",
"ex": "uav lockCameraTo [vehicle, [0, 0]]",
"exres": "",
"lname": "transport",
"name": "lockcamerato",
"op": "lockcamerato",
"rname": "[object/position/objNull, [turretPath]]",
"since": ""
}
],
"lockCargo": [
{
"cat": "General",
"desc": "Lock the cargo position of the vehicle.",
"ex": "",
"exres": "",
"lname": "vehicle",
"name": "lockcargo",
"op": "lockcargo",
"rname": "[cargo index, lock]",
"since": "5501"
},
{
"cat": "General",
"desc": "Lock the all cargo positions of the vehicle.",
"ex": "",
"exres": "",
"lname": "vehicle",
"name": "lockcargo",
"op": "lockcargo",
"rname": "lock",
"since": "5501"
}
],
"lockDriver": [
{
"cat": "General",
"desc": "Lock the driver position of the vehicle.",
"ex": "",
"exres": "",
"lname": "vehicle",
"name": "lockdriver",
"op": "lockdriver",
"rname": "lock",
"since": "5501"
}
],
"lockTurret": [
{
"cat": "General",
"desc": "Lock the gunner position of the vehicle turret.",
"ex": "",
"exres": "",
"lname": "vehicle",
"name": "lockturret",
"op": "lockturret",
"rname": "[turret path, lock]",
"since": "5501"
}
],
"lockWp": [
{
"cat": "General",
"desc": "Disables switching to the next waypoint (the current waypoint will never complete while lockWp is used). This is sometimes used during cut-scenes.",
"ex": "groupOne lockWP true",
"exres": "",
"lname": "group",
"name": "lockwp",
"op": "lockwp",
"rname": "lockWP",
"since": ""
}
],
"lockedCargo": [
{
"cat": "General",
"desc": "Check whether cargo position of the vehicle is locked.",
"ex": "",
"exres": "",
"lname": "vehicle",
"name": "lockedcargo",
"op": "lockedcargo",
"rname": "cargo index",
"since": "5501"
}
],
"lockedTurret": [
{
"cat": "General",
"desc": "Check whether gunner position of the vehicle turret is locked.",
"ex": "",
"exres": "",
"lname": "vehicle",
"name": "lockedturret",
"op": "lockedturret",
"rname": "turret path",
"since": "5501"
}
],
"lookAt": [
{
"cat": "General",
"desc": "Control what the unit is looking at (target or position) (format <ar>Position</ar>)",
"ex": "someSoldier lookAt otherSoldier; otherSoldier lookAt getMarkerPos \"markerOne\"",
"exres": "",
"lname": "unit(s)",
"name": "lookat",
"op": "lookat",
"rname": "position",
"since": "2.40"
}
],
"lookAtPos": [
{
"cat": "Editor",
"desc": "Center the map on, and point the camera at, the position.",
"ex": "",
"exres": "",
"lname": "map",
"name": "lookatpos",
"op": "lookatpos",
"rname": "position",
"since": "2.92"
}
],
"magazineTurretAmmo": [
{
"cat": "General",
"desc": "Returns ammo count of given type from given turret.",
"ex": "vehicle player ammoTurret [\"cls\", [0]]",
"exres": "",
"lname": "vehicle",
"name": "magazineturretammo",
"op": "magazineturretammo",
"rname": "[magazineClass, turretPath]",
"since": "2.35"
}
],
"magazinesTurret": [
{
"cat": "General",
"desc": "Returns all magazines of given turret. Use turret path [-1] for drivers turret.",
"ex": "vehicle player magazinesTurret [0,0]",
"exres": "",
"lname": "vehicle",
"name": "magazinesturret",
"op": "magazinesturret",
"rname": "turretPath",
"since": "5501"
}
],
"mapCenterOnCamera": [
{
"cat": "General",
"desc": "Enable / disable continuous centering the map on the camera position",
"ex": "",
"exres": "",
"lname": "control",
"name": "mapcenteroncamera",
"op": "mapcenteroncamera",
"rname": "enable",
"since": "5501"
}
],
"max": [
{
"cat": "Default",
"desc": "The greater of a,b",
"ex": "3 max 2",
"exres": "3",
"lname": "a",
"name": "max",
"op": "max",
"rname": "b",
"since": ""
}
],
"menuAction": [
{
"cat": "General",
"desc": "Returns action stored in item on given path.",
"ex": "example",
"exres": "",
"lname": "<MenuStripControl>",
"name": "menuaction",
"op": "menuaction",
"rname": "<path>",
"since": ""
}
],
"menuAdd": [
{
"cat": "General",
"desc": "Adds new submenu entry into item on given path.",
"ex": "example",
"exres": "",
"lname": "<MenuStripControl>",
"name": "menuadd",
"op": "menuadd",
"rname": "[<path>, <text>]",
"since": ""
}
],
"menuChecked": [
{
"cat": "General",
"desc": "Returns if item on given path is checked or not.",
"ex": "example",
"exres": "",
"lname": "<MenuStripControl>",
"name": "menuchecked",
"op": "menuchecked",
"rname": "<path>",
"since": ""
}
],
"menuCollapse": [
{
"cat": "General",
"desc": "Collapses item on given path and all its childs.",
"ex": "example",
"exres": "",
"lname": "<MenuStripControl>",
"name": "menucollapse",
"op": "menucollapse",
"rname": "<path>",
"since": ""
}
],
"menuData": [
{
"cat": "General",
"desc": "Returns data stored in menu entry on given path",
"ex": "example",
"exres": "",
"lname": "<MenuStripControl>",
"name": "menudata",
"op": "menudata",
"rname": "<path>",
"since": ""
}
],
"menuDelete": [
{
"cat": "General",
"desc": "Deletes menu entry on given path.",
"ex": "example",
"exres": "",
"lname": "<MenuStripControl>",
"name": "menudelete",
"op": "menudelete",
"rname": "<path>",
"since": ""
}
],
"menuEnable": [
{
"cat": "General",
"desc": "Enables disabled menu entry on given path.",
"ex": "example",
"exres": "",
"lname": "<MenuStripControl>",
"name": "menuenable",
"op": "menuenable",
"rname": "<path>",
"since": ""
}
],
"menuEnabled": [
{
"cat": "General",
"desc": "Returns if menu entry on given path is enabled or not.",
"ex": "example",
"exres": "",
"lname": "<MenuStripControl>",
"name": "menuenabled",
"op": "menuenabled",
"rname": "<path>",
"since": ""
}
],
"menuExpand": [
{
"cat": "General",
"desc": "Expands given menu entry on given path and all its parents so entry is visible.",
"ex": "example",
"exres": "",
"lname": "<MenuStripControl>",
"name": "menuexpand",
"op": "menuexpand",
"rname": "<path>",
"since": ""
}
],
"menuPicture": [
{
"cat": "General",
"desc": "Returns picture set into item on given path",
"ex": "example",
"exres": "",
"lname": "<MenuStripControl>",
"name": "menupicture",
"op": "menupicture",
"rname": "<path>",
"since": ""
}
],
"menuSetAction": [
{
"cat": "General",
"desc": "Sets new action into menu entry on given path.",
"ex": "example",
"exres": "",
"lname": "<MenuStripControl>",
"name": "menusetaction",
"op": "menusetaction",
"rname": "[<path>, <action>]",
"since": ""
}
],
"menuSetCheck": [
{
"cat": "General",
"desc": "Sets item on given path to be checked or not.",
"ex": "example",
"exres": "",
"lname": "<MenuStripControl>",
"name": "menusetcheck",
"op": "menusetcheck",
"rname": "[<path>, <bool>]",
"since": ""
}
],
"menuSetData": [
{
"cat": "General",
"desc": "Sets new data into item on given path.",
"ex": "example",
"exres": "",
"lname": "<MenuStripControl>",
"name": "menusetdata",
"op": "menusetdata",
"rname": "[<path>, <data>]",
"since": ""
}
],
"menuSetPicture": [
{
"cat": "General",
"desc": "Sets new picture into menu entry on given path.",
"ex": "example",
"exres": "",
"lname": "<MenuStripControl>",
"name": "menusetpicture",
"op": "menusetpicture",
"rname": "[<path>, <picture>]",
"since": ""
}
],
"menuSetValue": [
{
"cat": "General",
"desc": "Sets new value into menu entry on given path.",
"ex": "example",
"exres": "",
"lname": "<MenuStripControl>",
"name": "menusetvalue",
"op": "menusetvalue",
"rname": "[<path>, value]",
"since": ""
}
],
"menuShortcut": [
{
"cat": "General",
"desc": "Returns shortcut related to menu entry on given path.",
"ex": "example",
"exres": "",
"lname": "<MenuStripControl>",
"name": "menushortcut",
"op": "menushortcut",
"rname": "<path>",
"since": ""
}
],
"menuShortcutText": [
{
"cat": "General",
"desc": "Returns text describing shortcut set to item on given path.",
"ex": "example",
"exres": "",
"lname": "<MenuStripControl>",
"name": "menushortcuttext",
"op": "menushortcuttext",
"rname": "<path>",
"since": ""
}
],
"menuSize": [
{
"cat": "General",
"desc": "Returns how many sub entries is in item on given path.",
"ex": "example",
"exres": "",
"lname": "<MenuStripControl>",
"name": "menusize",
"op": "menusize",
"rname": "<path>",
"since": ""
}
],
"menuSort": [
{
"cat": "General",
"desc": "Sorts subentries of item on given path by their text.",
"ex": "example",
"exres": "",
"lname": "<MenuStripControl>",
"name": "menusort",
"op": "menusort",
"rname": "[<path>, <reversed>]",
"since": ""
}
],
"menuText": [
{
"cat": "General",
"desc": "Returns current text set in menu entry on given path.",
"ex": "example",
"exres": "",
"lname": "<MenuStripControl>",
"name": "menutext",
"op": "menutext",
"rname": "<path>",
"since": ""
}
],
"menuURL": [
{
"cat": "General",
"desc": "Returns current URL set in entry on given path.",
"ex": "example",
"exres": "",
"lname": "<MenuStripControl>",
"name": "menuurl",
"op": "menuurl",
"rname": "<path>",
"since": ""
}
],
"menuValue": [
{
"cat": "General",
"desc": "Returns current value set in menu entry on given path.",
"ex": "example",
"exres": "",
"lname": "<MenuStripControl>",
"name": "menuvalue",
"op": "menuvalue",
"rname": "<path>",
"since": ""
}
],
"min": [
{
"cat": "Default",
"desc": "The smaller of a,b",
"ex": "3 min 2",
"exres": "2",
"lname": "a",
"name": "min",
"op": "min",
"rname": "b",
"since": ""
}
],
"mineDetectedBy": [
{
"cat": "General",
"desc": "Returns true if mine is detected by given side",
"ex": "mine mineDetectedBy (side player)",
"exres": "",
"lname": "mine",
"name": "minedetectedby",
"op": "minedetectedby",
"rname": "side",
"since": ""
}
],
"mod": [
{
"cat": "Default",
"desc": "The remainder of a divided by b. Note that the remainer is calculated in the real domain.",
"ex": "3 mod 2",
"exres": "1",
"lname": "a",
"name": "mod",
"op": "mod",
"rname": "b",
"since": ""
}
],
"modelToWorld": [
{
"cat": "General",
"desc": "Converts position from object model space to world space.",
"ex": "",
"exres": "",
"lname": "object",
"name": "modeltoworld",
"op": "modeltoworld",
"rname": "modelPos",
"since": "2.92"
}
],
"modelToWorldVisual": [
{
"cat": "General",
"desc": "Converts position from object model space to world space in render time.",
"ex": "",
"exres": "",
"lname": "object",
"name": "modeltoworldvisual",
"op": "modeltoworldvisual",
"rname": "modelPos",
"since": "2.92"
}
],
"move": [
{
"cat": "General",
"desc": "Creates a move waypoint on the given position (format <ar>Position</ar>) and makes it the currently active group waypoint.",
"ex": "groupOne move getPos player",
"exres": "",
"lname": "group",
"name": "move",
"op": "move",
"rname": "pos",
"since": ""
}
],
"moveInAny": [
{
"cat": "General",
"desc": "Attemps to move unit in any free position in vehicle",
"ex": "player moveInAny vehicle",
"exres": "",
"lname": "unit",
"name": "moveinany",
"op": "moveinany",
"rname": "vehicle",
"since": ""
}
],
"moveInCargo": [
{
"cat": "General",
"desc": "Moves the soldier into the vehicle's cargo position. (Immediately, without animation).",
"ex": "soldierOne moveInCargo jeepOne",
"exres": "",
"lname": "soldier",
"name": "moveincargo",
"op": "moveincargo",
"rname": "vehicle",
"since": ""
},
{
"cat": "General",
"desc": "Moves the soldier into a vehicle's specified cargo position. (Immediately, without animation).",
"ex": "soldierOne moveInCargo jeepOne",
"exres": "",
"lname": "soldier",
"name": "moveincargo",
"op": "moveincargo",
"rname": "[vehicle, CargoIndex]",
"since": ""
}
],
"moveInCommander": [
{
"cat": "General",
"desc": "Moves the soldier into the vehicle's commander position. (Immediatetely, without animation).",
"ex": "soldierOne moveInCommander jeepOne",
"exres": "",
"lname": "soldier",
"name": "moveincommander",
"op": "moveincommander",
"rname": "vehicle",
"since": ""
}
],
"moveInDriver": [
{
"cat": "General",
"desc": "Moves the soldier into the vehicle's driver position. (Immediately, without animation).",
"ex": "soldierOne moveInDriver jeepOne",
"exres": "",
"lname": "soldier",
"name": "moveindriver",
"op": "moveindriver",
"rname": "vehicle",
"since": ""
}
],
"moveInGunner": [
{
"cat": "General",
"desc": "Moves the soldier into the vehicle's gunner position. (Immediately, without animation).",
"ex": "soldierOne moveInGunner jeepOne",
"exres": "",
"lname": "soldier",
"name": "moveingunner",
"op": "moveingunner",
"rname": "vehicle",
"since": ""
}
],
"moveInTurret": [
{
"cat": "General",
"desc": "Moves the soldier into the vehicle's turret. (Immediately, without animation).",
"ex": "soldierOne moveInTurret [tank, [0, 0]]",
"exres": "",
"lname": "soldier",
"name": "moveinturret",
"op": "moveinturret",
"rname": "[vehicle, turret path]",
"since": ""
}
],
"moveObjectToEnd": [
{
"cat": "Editor",
"desc": "Shifts an editor object to the end of the objects array. This means that the object will be drawn last (after all other objects).",
"ex": "",
"exres": "",
"lname": "map",
"name": "moveobjecttoend",
"op": "moveobjecttoend",
"rname": "object",
"since": "2.92"
}
],
"moveTo": [
{
"cat": "General",
"desc": "Low level command to person to move to given position.",
"ex": "",
"exres": "",
"lname": "person",
"name": "moveto",
"op": "moveto",
"rname": "position",
"since": "2.61"
}
],
"nMenuItems": [
{
"cat": "Editor",
"desc": "Returns the total number of user-added menu items belonging to the given menu.",
"ex": "",
"exres": "",
"lname": "map",
"name": "nmenuitems",
"op": "nmenuitems",
"rname": "menu index",
"since": "2.92"
}
],
"nearEntities": [
{
"cat": "General",
"desc": "Find entities in the circle with given radius. If typeName(s) is (are) given, only entities of given type (or its subtype) are listed.",
"ex": "_list = position player nearObjects 50",
"exres": "",
"lname": "position",
"name": "nearentities",
"op": "nearentities",
"rname": "radius or [typeName, radius] or [[typeName1, typeName2, ...], radius]",
"since": "5501"
}
],
"nearObjects": [
{
"cat": "General",
"desc": "Find objects in the circle with given radius. If typeName is given, only objects of given type (or its subtype) are listed.",
"ex": "_list = position player nearObjects 50",
"exres": "",
"lname": "position",
"name": "nearobjects",
"op": "nearobjects",
"rname": "radius or [typeName, radius]",
"since": "2.92"
}
],
"nearObjectsReady": [
{
"cat": "General",
"desc": "Check whether all data are loaded to nearObjects will return in reasonable time.",
"ex": "_ok = position player nearObjectsReady 50",
"exres": "",
"lname": "position",
"name": "nearobjectsready",
"op": "nearobjectsready",
"rname": "radius",
"since": "5501"
}
],
"nearRoads": [
{
"cat": "General",
"desc": "Find the road segments within the circle of given radius.",
"ex": "_list = player nearRoads 50",
"exres": "",
"lname": "position or object",
"name": "nearroads",
"op": "nearroads",
"rname": "radius",
"since": "5500"
}
],
"nearSupplies": [
{
"cat": "General",
"desc": "Find objects in the circle with given radius. If typeName is given, only objects of given type (or its subtype) are listed.",
"ex": "_list = position player nearSuplies 50",
"exres": "",
"lname": "position",
"name": "nearsupplies",
"op": "nearsupplies",
"rname": "radius or [typeName, radius]",
"since": "2.92"
}
],
"nearTargets": [
{
"cat": "General",
"desc": "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]",
"ex": "",
"exres": "",
"lname": "unit",
"name": "neartargets",
"op": "neartargets",
"rname": "radius",
"since": ""
}
],
"nearestObject": [
{
"cat": "General",
"desc": "Find object nearest to given position with given type.",
"ex": "obj = position player nearestObject \"Building\"",
"exres": "",
"lname": "position",
"name": "nearestobject",
"op": "nearestobject",
"rname": "type",
"since": "2.01"
},
{
"cat": "General",
"desc": "Find object nearest to given position with given Visitor id.",
"ex": "obj = position player nearestObject 1234",
"exres": "",
"lname": "position",
"name": "nearestobject",
"op": "nearestobject",
"rname": "id",
"since": "2.01"
}
],
"newOverlay": [
{
"cat": "Editor",
"desc": "Creates the new overlay dialog for the specified type of overlay.",
"ex": "",
"exres": "",
"lname": "map",
"name": "newoverlay",
"op": "newoverlay",
"rname": "config",
"since": "2.92"
}
],
"objStatus": [
{
"cat": "General",
"desc": "Sets the briefing objective status. Status may be one of: \"ACTIVE\", \"FAILED\", \"DONE\" or \"HIDDEN\".",
"ex": "\"obj_1\" objStatus \"FAILED\"",
"exres": "",
"lname": "objective",
"name": "objstatus",
"op": "objstatus",
"rname": "status",
"since": ""
}
],
"onDoubleClick": [
{
"cat": "Editor",
"desc": "Defines an action performed when the user double clicks on the map. Command receives:<br/>\r\n<br/>\r\n_pos <t>array</t> position<br/>\r\n_units <t>array</t> selected units<br/>\r\n_shift,_alt <t>bool</t> key state",
"ex": "",
"exres": "",
"lname": "map",
"name": "ondoubleclick",
"op": "ondoubleclick",
"rname": "command",
"since": "2.92"
}
],
"onMapSingleClick": [
{
"cat": "General",
"desc": "Defines an action performed when the user clicks on the map. Command receives:<br/>\r\n<br/>\r\n_pos <t>array</t> position<br/>\r\n_units <t>array</t> selected units<br/>\r\n_shift,_alt <t>bool</t> key state<br/>\r\n_this <t>any</t> parameters passed to this function<br/>\r\n<br/>If the click is processed, command should return true.",
"ex": "\"SoldierEG\" onMapSingleClick \"_this createUnit [_pos, group player]\"",
"exres": "",
"lname": "parameters",
"name": "onmapsingleclick",
"op": "onmapsingleclick",
"rname": "command",
"since": "5500"
}
],
"onShowNewObject": [
{
"cat": "Editor",
"desc": "Defines an action performed when the user right clicks on the map and selects New Object. Set to empty for default behavior. Command receives:<br/>\r\n<br/>\r\n_pos <t>array</t> position",
"ex": "",
"exres": "",
"lname": "map",
"name": "onshownewobject",
"op": "onshownewobject",
"rname": "command",
"since": "2.92"
}
],
"or": [
{
"cat": "Default",
"desc": "a or b",
"ex": "not alive player or not alive leader player",
"exres": "",
"lname": "a",
"name": "or",
"op": "or",
"rname": "b",
"since": ""
},
{
"cat": "Default",
"desc": "a or b, b evaluated only when a is false",
"ex": "not alive player or not alive leader player",
"exres": "",
"lname": "a",
"name": "or",
"op": "or",
"rname": "b",
"since": ""
}
],
"orderGetIn": [
{
"cat": "General",
"desc": "Forces all units in the list to get in their assigned vehicle.",
"ex": "[unitOne, unitTwo] orderGetIn true",
"exres": "",
"lname": "unitArray",
"name": "ordergetin",
"op": "ordergetin",
"rname": "order",
"since": ""
}
],
"param": [
{
"cat": "General",
"desc": "Parses array of params by given index and returns the value",
"ex": "_two = [1,2,3] param [1,25];",
"exres": "",
"lname": "anything",
"name": "param",
"op": "param",
"rname": "array",
"since": ""
}
],
"params": [
{
"cat": "General",
"desc": "Parses array of params into array of private variables",
"ex": "[1,2,3] params [\"_one\",\"_two\",\"_three\"];",
"exres": "",
"lname": "anything",
"name": "params",
"op": "params",
"rname": "array",
"since": ""
}
],
"playAction": [
{
"cat": "General",
"desc": "When used on a person, a smooth transition to the given action will be initiated.",
"ex": "soldierOne playAction \"SitDown\"",
"exres": "",
"lname": "soldier",
"name": "playaction",
"op": "playaction",
"rname": "action",
"since": "5500"
}
],
"playActionNow": [
{
"cat": "General",
"desc": "When used on a person, a smooth transition to the given action will be initiated, but all previous playAction are discarded.",
"ex": "soldierOne playActionNow \"SitDown\"",
"exres": "",
"lname": "soldier",
"name": "playactionnow",
"op": "playactionnow",
"rname": "action",
"since": "5501"
}
],
"playGesture": [
{
"cat": "General",
"desc": "When used on a person, a smooth transition to the given move will be initiated.",
"ex": "soldierOne playGesture \"Wave\"",
"exres": "",
"lname": "soldier",
"name": "playgesture",
"op": "playgesture",
"rname": "moveName",
"since": "5500"
}
],
"playMove": [
{
"cat": "General",
"desc": "When used on a person, a smooth transition to the given move will be initiated.",
"ex": "soldierOne playMove \"Stand\"",
"exres": "",
"lname": "soldier",
"name": "playmove",
"op": "playmove",
"rname": "moveName",
"since": ""
}
],
"playMoveNow": [
{
"cat": "General",
"desc": "When used on a person, a smooth transition to the given move will be initiated, but all previous playAction are discarded.",
"ex": "soldierOne playMoveNow \"Stand\"",
"exres": "",
"lname": "soldier",
"name": "playmovenow",
"op": "playmovenow",
"rname": "moveName",
"since": "5501"
}
],
"posScreenToWorld": [
{
"cat": "General",
"desc": "Convert screen coordinates in map to world coordinates.",
"ex": "",
"exres": "",
"lname": "map",
"name": "posscreentoworld",
"op": "posscreentoworld",
"rname": "[x, y]",
"since": "2.54"
}
],
"posWorldToScreen": [
{
"cat": "General",
"desc": "Convert world coordinates to screen coordinates in map.",
"ex": "",
"exres": "",
"lname": "map",
"name": "posworldtoscreen",
"op": "posworldtoscreen",
"rname": "position",
"since": "2.54"
}
],
"ppEffectAdjust": [
{
"cat": "Visual",
"desc": "Adjust parameters for specified post process effect",
"ex": "\"radialBlurr\" ppEffectEnable []",
"exres": "",
"lname": "string",
"name": "ppeffectadjust",
"op": "ppeffectadjust",
"rname": "array",
"since": "2.92"
},
{
"cat": "Visual",
"desc": "Set post process effect parameters",
"ex": "hndl ppEffectAdjust [0.0075, 0.0075, 0.1, 0.1]",
"exres": "",
"lname": "number",
"name": "ppeffectadjust",
"op": "ppeffectadjust",
"rname": "array",
"since": "2.92"
}
],
"ppEffectCommit": [
{
"cat": "Visual",
"desc": "Set time when old pars are replaced by last set, if 0 set immediately",
"ex": "...",
"exres": "",
"lname": "string",
"name": "ppeffectcommit",
"op": "ppeffectcommit",
"rname": "number",
"since": "2.92"
},
{
"cat": "Visual",
"desc": "Set time when old pars are replaced by last set, if 0 set immediately",
"ex": "hndl ppEffectCommit 0",
"exres": "",
"lname": "number",
"name": "ppeffectcommit",
"op": "ppeffectcommit",
"rname": "number",
"since": "2.92"
},
{
"cat": "Visual",
"desc": "Set time when old pars are replaced by last set, if 0 set immediately",
"ex": "hndl ppEffectCommit 0",
"exres": "",
"lname": "array",
"name": "ppeffectcommit",
"op": "ppeffectcommit",
"rname": "scalar",
"since": "2.92"
}
],
"ppEffectEnable": [
{
"cat": "Visual",
"desc": "Enable/disable specified post process effect, is overloaded form multiple effects.",
"ex": "\"radialBlurr\" ppEffectEnable true, [\"chromAberration\", \"radialBlurr\"] ppEffectEnable true",
"exres": "",
"lname": "string",
"name": "ppeffectenable",
"op": "ppeffectenable",
"rname": "bool",
"since": "2.92"
},
{
"cat": "Visual",
"desc": "Enable/disable specified post process effect, is overloaded form multiple effects.",
"ex": "\"radialBlurr\" ppEffectEnable true, [\"chromAberration\", \"radialBlurr\"] ppEffectEnable true",
"exres": "",
"lname": "array",
"name": "ppeffectenable",
"op": "ppeffectenable",
"rname": "bool",
"since": "2.92"
},
{
"cat": "Visual",
"desc": "Enable / disable post process effect",
"ex": "hndl ppEffectEnable true",
"exres": "",
"lname": "number",
"name": "ppeffectenable",
"op": "ppeffectenable",
"rname": "bool",
"since": "2.92"
}
],
"ppEffectForceInNVG": [
{
"cat": "Visual",
"desc": "Forces to use PP effect in NVG",
"ex": "",
"exres": "",
"lname": "number",
"name": "ppeffectforceinnvg",
"op": "ppeffectforceinnvg",
"rname": "bool",
"since": "91000"
}
],
"preloadObject": [
{
"cat": "General",
"desc": "Preload all data for given object.",
"ex": "",
"exres": "",
"lname": "distance",
"name": "preloadobject",
"op": "preloadobject",
"rname": "object",
"since": "2.50"
}
],
"progressSetPosition": [
{
"cat": "General",
"desc": "Sets the current position in the progress bar.",
"ex": "_control sliderSetPosition 0",
"exres": "",
"lname": "control",
"name": "progresssetposition",
"op": "progresssetposition",
"rname": "pos",
"since": "2.92"
}
],
"publicVariableClient": [
{
"cat": "General",
"desc": "Send the variable value to the client computer.\r\nOnly type <t>Number</t> is supported in versions 1.33 and before.\r\nThe following types are supported since 1.34:\r\n<t>Number</t>, <t>Boolean</t>, <t>Object</t> and <t>Group</t>.",
"ex": "3 publicVariableClient \"CTFscoreOne\"",
"exres": "",
"lname": "clientId",
"name": "publicvariableclient",
"op": "publicvariableclient",
"rname": "varName",
"since": ""
}
],
"pushBack": [
{
"cat": "Default",
"desc": "Add and element into the end of a given array.",
"ex": "array push_back \"Hello\"",
"exres": "",
"lname": "array",
"name": "pushback",
"op": "pushback",
"rname": "element",
"since": "1.75"
}
],
"pushBackUnique": [
{
"cat": "Default",
"desc": "Add and element into the end of a given array only if same element is not here already.",
"ex": "array pushBackUnique \"Hello\"",
"exres": "",
"lname": "array",
"name": "pushbackunique",
"op": "pushbackunique",
"rname": "element",
"since": "1.75"
}
],
"radioChannelAdd": [
{
"cat": "General",
"desc": "Add the units to the custom radio channel.",
"ex": "",
"exres": "",
"lname": "chan ix",
"name": "radiochanneladd",
"op": "radiochanneladd",
"rname": "[units]",
"since": "81375 TOH"
}
],
"radioChannelRemove": [
{
"cat": "General",
"desc": "Remove the units from the custom radio channel.",
"ex": "",
"exres": "",
"lname": "chan ix",
"name": "radiochannelremove",
"op": "radiochannelremove",
"rname": "[units]",
"since": "81375 TOH"
}
],
"radioChannelSetCallSign": [
{
"cat": "General",
"desc": "Set the custom channel call sign.",
"ex": "",
"exres": "",
"lname": "chan ix",
"name": "radiochannelsetcallsign",
"op": "radiochannelsetcallsign",
"rname": "callSign",
"since": "81375 TOH"
}
],
"radioChannelSetLabel": [
{
"cat": "General",
"desc": "Set the custom channel label.",
"ex": "",
"exres": "",
"lname": "chan ix",
"name": "radiochannelsetlabel",
"op": "radiochannelsetlabel",
"rname": "label",
"since": "81375 TOH"
}
],
"random": [
{
"cat": "General",
"desc": "Returns random number but always the same as long as you provide same seed",
"ex": "12345 random 10",
"exres": "",
"lname": "seed",
"name": "random",
"op": "random",
"rname": "max",
"since": ""
}
],
"registerTask": [
{
"cat": "Identity",
"desc": "Register a new task type. Parameters are defined in the given config class (subclass of CfgTasks).",
"ex": "",
"exres": "",
"lname": "teamMember",
"name": "registertask",
"op": "registertask",
"rname": "entry name",
"since": "2.90"
}
],
"remoteControl": [
{
"cat": "General",
"desc": "Switch on remote control of the unit.",
"ex": "player remoteControl gunner _uav",
"exres": "",
"lname": "who",
"name": "remotecontrol",
"op": "remotecontrol",
"rname": "whom",
"since": "5501"
}
],
"remoteExec": [
{
"cat": "General",
"desc": "Executes the function remotely by spawning it. Returns nil in case of error. If JIP is requested it returns an unique JIP id string.",
"ex": "uniquejipID = \"Hello\" remoteExec [\"hint\", [2,3,player], true]; \"Hello again\" remoteExec [\"hint\", 0, \"jipID2\"]",
"exres": "",
"lname": "funcName",
"name": "remoteexec",
"op": "remoteexec",
"rname": "[funcParams, targets, jipID]",
"since": ""
}
],
"remoteExecCall": [
{
"cat": "General",
"desc": "Executes the function remotely by calling it. Returns nil in case of error. If JIP is requested it returns an unique JIP id string.",
"ex": "uniquejipID = \"Hello\" remoteExecCall [\"hint\", [2,3,player], true]; \"Hello again\" remoteExecCall [\"hint\", 0, \"jipID2\"]",
"exres": "",
"lname": "funcName",
"name": "remoteexeccall",
"op": "remoteexeccall",
"rname": "[funcParams, targets, jipID]",
"since": ""
}
],
"removeAction": [
{
"cat": "General",
"desc": "Removes the action with the given id.",
"ex": "player removeAction 0",
"exres": "",
"lname": "unit",
"name": "removeaction",
"op": "removeaction",
"rname": "index",
"since": "1.11"
}
],
"removeAllEventHandlers": [
{
"cat": "General",
"desc": "Removes all event handlers of the given type which were added by <f>addEventHandler</f>.",
"ex": "player removeAllEventHandlers \"killed\"",
"exres": "",
"lname": "object",
"name": "removealleventhandlers",
"op": "removealleventhandlers",
"rname": "handlerType",
"since": "1.85"
}
],
"removeAllMPEventHandlers": [
{
"cat": "General",
"desc": "Removes all MP event handlers of the given type which were added by <f>addMPEventHandler</f>.",
"ex": "player removeAllMPEventHandlers \"mpkilled\"",
"exres": "",
"lname": "object",
"name": "removeallmpeventhandlers",
"op": "removeallmpeventhandlers",
"rname": "handlerType",
"since": "1.85"
}
],
"removeCuratorAddons": [
{
"cat": "General",
"desc": "Restrict curator use of given addon.",
"ex": "curator removeCuratorAddons [addon1, addon2]",
"exres": "",
"lname": "curatorObj",
"name": "removecuratoraddons",
"op": "removecuratoraddons",
"rname": "[addons]",
"since": ""
}
],
"removeCuratorCameraArea": [
{
"cat": "General",
"desc": "Removes curator camera area",
"ex": "",
"exres": "",
"lname": "curatorObj",
"name": "removecuratorcameraarea",
"op": "removecuratorcameraarea",
"rname": "cameraAreaID",
"since": ""
}
],
"removeCuratorEditableObjects": [
{
"cat": "General",
"desc": "Unregister objects which can be edited by a curator.",
"ex": "0 removeCuratorEditableObjects [cursorTarget, true]",
"exres": "",
"lname": "curatorObj",
"name": "removecuratoreditableobjects",
"op": "removecuratoreditableobjects",
"rname": "[[object],removeCrew = true]",
"since": ""
}
],
"removeCuratorEditingArea": [
{
"cat": "General",
"desc": "Removes editing area for given curator",
"ex": "",
"exres": "",
"lname": "curatorObj",
"name": "removecuratoreditingarea",
"op": "removecuratoreditingarea",
"rname": "editAreaID",
"since": ""
}
],
"removeDrawIcon": [
{
"cat": "Editor",
"desc": "Removes an icon for an editor object.",
"ex": "",
"exres": "",
"lname": "map",
"name": "removedrawicon",
"op": "removedrawicon",
"rname": "[object, string identifier]",
"since": "2.92"
}
],
"removeDrawLinks": [
{
"cat": "Editor",
"desc": "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.",
"ex": "",
"exres": "",
"lname": "map",
"name": "removedrawlinks",
"op": "removedrawlinks",
"rname": "[from, param type]",
"since": "2.92"
}
],
"removeEventHandler": [
{
"cat": "General",
"desc": "Removes event handler added by <f>addEventHandler</f>. 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.",
"ex": "player removeEventHandler [\"killed\",0]",
"exres": "",
"lname": "object",
"name": "removeeventhandler",
"op": "removeeventhandler",
"rname": "handler",
"since": "1.85"
}
],
"removeGroupIcon": [
{
"cat": "General",
"desc": "Remove icon with given ID from group.",
"ex": "group removeGroupIcon id",
"exres": "",
"lname": "group",
"name": "removegroupicon",
"op": "removegroupicon",
"rname": "icon ID",
"since": "5501"
}
],
"removeHandgunItem": [
{
"cat": "General",
"desc": "Removes given item from the weapon cargo space.",
"ex": "player removeHandgunItem \"ItemClassName\"",
"exres": "",
"lname": "unit",
"name": "removehandgunitem",
"op": "removehandgunitem",
"rname": "item",
"since": ""
}
],
"removeItem": [
{
"cat": "General",
"desc": "Remove item from the inventory.",
"ex": "",
"exres": "",
"lname": "unit",
"name": "removeitem",
"op": "removeitem",
"rname": "item",
"since": ""
}
],
"removeItemFromBackpack": [
{
"cat": "General",
"desc": "Remove item from soldier's uniform.",
"ex": "",
"exres": "",
"lname": "unit",
"name": "removeitemfrombackpack",
"op": "removeitemfrombackpack",
"rname": "item",
"since": ""
}
],
"removeItemFromUniform": [
{
"cat": "General",
"desc": "Remove item from soldier's uniform.",
"ex": "",
"exres": "",
"lname": "unit",
"name": "removeitemfromuniform",
"op": "removeitemfromuniform",
"rname": "item",
"since": ""
}
],
"removeItemFromVest": [
{
"cat": "General",
"desc": "Remove item from soldier's uniform.",
"ex": "",
"exres": "",
"lname": "unit",
"name": "removeitemfromvest",
"op": "removeitemfromvest",
"rname": "item",
"since": ""
}
],
"removeItems": [
{
"cat": "General",
"desc": "Remove all items with given template from the inventory.",
"ex": "",
"exres": "",
"lname": "unit",
"name": "removeitems",
"op": "removeitems",
"rname": "item",
"since": ""
}
],
"removeMPEventHandler": [
{
"cat": "General",
"desc": "Removes MP event handler added by <f>addMPEventHandler</f>. Format of handler is [type,index]. Index is returned by addMPEventHandler. When any handler is removed, all handler indices higher that the deleted one should be decremented.",
"ex": "player removeMPEventHandler [\"killed\",0]",
"exres": "",
"lname": "object",
"name": "removempeventhandler",
"op": "removempeventhandler",
"rname": "handler",
"since": "1.85"
}
],
"removeMagazine": [
{
"cat": "General",
"desc": "Removes the magazine from the unit. Note: you may create invalid combinations by using this function. When doing so, application behaviour is undefined.",
"ex": "player removeMagazine \"M16\"",
"exres": "",
"lname": "unit",
"name": "removemagazine",
"op": "removemagazine",
"rname": "weaponName",
"since": ""
}
],
"removeMagazineGlobal": [
{
"cat": "General",
"desc": "Removes the magazine from the unit. Note: you may create invalid combinations by using this function. When doing so, application behaviour is undefined.",
"ex": "player removeMagazineGlobal \"M16\"",
"exres": "",
"lname": "unit",
"name": "removemagazineglobal",
"op": "removemagazineglobal",
"rname": "weaponName",
"since": ""
}
],
"removeMagazineTurret": [
{
"cat": "General",
"desc": "Removes the magazine from the turret. Use turret path [-1] for driver's turret. Note: you may create invalid combinations by using this function. When doing so, application behaviour is undefined.",
"ex": "vehicle player removeMagazine [\"60rnd_cmflaremagazine\",[-1]]",
"exres": "",
"lname": "transport",
"name": "removemagazineturret",
"op": "removemagazineturret",
"rname": "[weaponName, turret path]",
"since": ""
}
],
"removeMagazines": [
{
"cat": "General",
"desc": "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.",
"ex": "player removeMagazines \"M16\"",
"exres": "",
"lname": "unit",
"name": "removemagazines",
"op": "removemagazines",
"rname": "weaponName",
"since": ""
}
],
"removeMagazinesTurret": [
{
"cat": "General",
"desc": "Removes all magazines of the given type from the unit. Use turret path [-1] for driver's turret. Note: you may create invalid combinations by using this function. When doing so, application behaviour is undefined.",
"ex": "vehicle player removeMagazines [\"60rnd_cmflaremagazine\",,[-1]]",
"exres": "",
"lname": "transport",
"name": "removemagazinesturret",
"op": "removemagazinesturret",
"rname": "[weaponName, turret path]",
"since": ""
}
],
"removeMenuItem": [
{
"cat": "Editor",
"desc": "Removes a previously added menu item.",
"ex": "",
"exres": "",
"lname": "map",
"name": "removemenuitem",
"op": "removemenuitem",
"rname": "index of menu item to delete",
"since": "2.92"
},
{
"cat": "Editor",
"desc": "Removes a previously added menu item.",
"ex": "",
"exres": "",
"lname": "map",
"name": "removemenuitem",
"op": "removemenuitem",
"rname": "text of menu item to delete",
"since": "2.92"
}
],
"removeOwnedMine": [
{
"cat": "General",
"desc": "Remove ownership over a remotely detonatable mine from the unit.",
"ex": "player removeOwnedMine SuperMine",
"exres": "",
"lname": "unit",
"name": "removeownedmine",
"op": "removeownedmine",
"rname": "item",
"since": ""
}
],
"removePrimaryWeaponItem": [
{
"cat": "General",
"desc": "Removes given item from the weapon cargo space.",
"ex": "player removePrimaryWeaponItem \"ItemClassName\"",
"exres": "",
"lname": "unit",
"name": "removeprimaryweaponitem",
"op": "removeprimaryweaponitem",
"rname": "item",
"since": ""
}
],
"removeSecondaryWeaponItem": [
{
"cat": "General",
"desc": "Removes given item from the weapon cargo space.",
"ex": "player removeSecondaryWeaponItem \"ItemClassName\"",
"exres": "",
"lname": "unit",
"name": "removesecondaryweaponitem",
"op": "removesecondaryweaponitem",
"rname": "item",
"since": ""
}
],
"removeSimpleTask": [
{
"cat": "Identity",
"desc": "Remove a simple task from the list of simple tasks.",
"ex": "",
"exres": "",
"lname": "person",
"name": "removesimpletask",
"op": "removesimpletask",
"rname": "task",
"since": "5501"
}
],
"removeTeamMember": [
{
"cat": "Agents",
"desc": "Remove given member from given team.",
"ex": "_team removeTeamMember _teamMember",
"exres": "",
"lname": "team",
"name": "removeteammember",
"op": "removeteammember",
"rname": "member",
"since": "2.90"
}
],
"removeWeapon": [
{
"cat": "General",
"desc": "Removes the weapon from the unit. Note: you may create invalid combinations by using this function. When doing so, application behaviour is undefined.",
"ex": "player removeWeapon \"M16\"",
"exres": "",
"lname": "unit",
"name": "removeweapon",
"op": "removeweapon",
"rname": "weaponName",
"since": ""
}
],
"removeWeaponAttachmentCargo": [
{
"cat": "General",
"desc": "Remove attachment linked to a weapon from the vehicle cargo space.",
"ex": "rearmTruckOne RemoveWeaponAttachment[weaponID,creatorID,\"attachment\"]",
"exres": "",
"lname": "vehicle(with supply)",
"name": "removeweaponattachmentcargo",
"op": "removeweaponattachmentcargo",
"rname": "[weaponID,creatorID,\"weaponAttachment\"]",
"since": ""
}
],
"removeWeaponCargo": [
{
"cat": "General",
"desc": "Remove weapon from the vehicle cargo space.",
"ex": "rearmTruckOne removeWeaponCargo [19, 1]",
"exres": "",
"lname": "vehicle(with supply)",
"name": "removeweaponcargo",
"op": "removeweaponcargo",
"rname": "[weaponID,creatorID]",
"since": ""
}
],
"removeWeaponGlobal": [
{
"cat": "General",
"desc": "Removes the weapon from the unit. Note: you may create invalid combinations by using this function. When doing so, application behaviour is undefined.",
"ex": "player removeWeaponGobal \"M16\"",
"exres": "",
"lname": "unit",
"name": "removeweaponglobal",
"op": "removeweaponglobal",
"rname": "weaponName",
"since": ""
}
],
"removeWeaponTurret": [
{
"cat": "General",
"desc": "Removes the weapon from the given vehicle's turret. ",
"ex": "vehicle player aremoveWeaponTurret [\"Horn\",[0,0]]",
"exres": "",
"lname": "vehicle",
"name": "removeweaponturret",
"op": "removeweaponturret",
"rname": "[weaponName,turret array]",
"since": ""
}
],
"resize": [
{
"cat": "Default",
"desc": "Changes the array size. This function can be used to add or remove elements from the array.",
"ex": "array resize 2",
"exres": "",
"lname": "array",
"name": "resize",
"op": "resize",
"rname": "count",
"since": "1.75"
}
],
"respawnVehicle": [
{
"cat": "General",
"desc": "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).",
"ex": "car respawnVehicle [5.0, 3]",
"exres": "",
"lname": "vehicle",
"name": "respawnvehicle",
"op": "respawnvehicle",
"rname": "[delay = -1, count = 0]",
"since": "2.52"
}
],
"reveal": [
{
"cat": "General",
"desc": "Reveals the unit to the group. It does not matter whether the group can know about the unit or not.",
"ex": "soldierOne reveal soldierTwo",
"exres": "",
"lname": "group",
"name": "reveal",
"op": "reveal",
"rname": "unit",
"since": ""
},
{
"cat": "General",
"desc": "Reveals the unit to the group. It does not matter whether the group can know about the unit or not.",
"ex": "soldierOne reveal [soldierTwo,1.5]",
"exres": "",
"lname": "group",
"name": "reveal",
"op": "reveal",
"rname": "unit",
"since": ""
}
],
"revealMine": [
{
"cat": "General",
"desc": "Sets given mine as known to the side.",
"ex": "",
"exres": "",
"lname": "side",
"name": "revealmine",
"op": "revealmine",
"rname": "mine",
"since": "1.86"
}
],
"ropeAttachTo": [
{
"cat": "General",
"desc": "Attach vehicle to rope with optional offset",
"ex": "[veh, [0,0,0], [0,0,-1]] ropeAttachTo rope",
"exres": "",
"lname": "[vehicle, (toPoint), (ropeEndDownDir)]",
"name": "ropeattachto",
"op": "ropeattachto",
"rname": "rope",
"since": "116464"
}
],
"ropeDetach": [
{
"cat": "General",
"desc": "Detach vehicle from rope",
"ex": "vehicle ropeDetachFrom rope",
"exres": "",
"lname": "vehicle",
"name": "ropedetach",
"op": "ropedetach",
"rname": "rope",
"since": "116464"
}
],
"saveIdentity": [
{
"cat": "General",
"desc": "Saves person's identity to objects.sav file in campaign directory as entry name.",
"ex": "player saveIdentity \"playerIdentity\"",
"exres": "",
"lname": "person",
"name": "saveidentity",
"op": "saveidentity",
"rname": "name",
"since": "1.75"
}
],
"saveStatus": [
{
"cat": "General",
"desc": "Saves object's properties to objects.sav file in campaign directory as entry name.",
"ex": "player saveStatus \"playerState\"",
"exres": "",
"lname": "object",
"name": "savestatus",
"op": "savestatus",
"rname": "name",
"since": "1.75"
}
],
"say": [
{
"cat": "General",
"desc": "The unit will play the given sound. If the unit is a person, it will also pefrorm the corresponding lipsync effect. The sound is defined in the description.ext file. If target is given, titles will be written to the conversation history.",
"ex": "soldierOne say \"speechId\"",
"exres": "",
"lname": "unit or [unit, target]",
"name": "say",
"op": "say",
"rname": "speechName",
"since": ""
},
{
"cat": "General",
"desc": "The format of speechName is [sound, maxTitlesDistance] or [sound, maxTitlesDistance, speed]. The unit will play the given sound. If the unit is a person, it will also pefrorm the corresponding lipsync effect. If the camera is not withing the given range, the title is not shown. The sound is defined in the description.ext file. If target is given, titles will be written to the conversation history.",
"ex": "",
"exres": "",
"lname": "unit or [unit, target]",
"name": "say",
"op": "say",
"rname": "speechName",
"since": "1.75"
}
],
"say2D": [
{
"cat": "General",
"desc": "Functionally same as Say, only difference is sound played as 2D (mono) allways.",
"ex": "soldierOne say \"speechId\"",
"exres": "",
"lname": "unit or [unit, target]",
"name": "say2d",
"op": "say2d",
"rname": "speechName",
"since": "5501"
},
{
"cat": "General",
"desc": "Functionally same as Say, only difference is sound played as 2D (mono) allways.",
"ex": "",
"exres": "",
"lname": "unit or [unit, target]",
"name": "say2d",
"op": "say2d",
"rname": "speechName",
"since": "5501"
}
],
"say3D": [
{
"cat": "General",
"desc": "Functionally same as Say, only difference is sound played as 3D allways.",
"ex": "soldierOne say \"speechId\"",
"exres": "",
"lname": "unit or [unit, target]",
"name": "say3d",
"op": "say3d",
"rname": "speechName",
"since": "5501"
},
{
"cat": "General",
"desc": "Functionally same as Say, only difference is sound played as 3D allways.",
"ex": "",
"exres": "",
"lname": "unit or [unit, target]",
"name": "say3d",
"op": "say3d",
"rname": "speechName",
"since": "5501"
}
],
"select": [
{
"cat": "Default",
"desc": "Selects index element of the array. Index 0 denotes the first element, 1 the second, etc.",
"ex": "[1, 2, 3] select 1",
"exres": "2",
"lname": "array",
"name": "select",
"op": "select",
"rname": "index",
"since": ""
},
{
"cat": "Default",
"desc": "If the index is false, this selects the first element of the array. If it is true, it selects the second one.",
"ex": "",
"exres": "",
"lname": "array",
"name": "select",
"op": "select",
"rname": "index",
"since": ""
},
{
"cat": "Default",
"desc": "Extracts the elements from array between 'start' and 'start+length'.",
"ex": "",
"exres": "",
"lname": "array",
"name": "select",
"op": "select",
"rname": "[start,length]",
"since": ""
},
{
"cat": "Default",
"desc": "Extracts the characters in a string between 'start' and 'start+length'.",
"ex": "\"Hello\" select [1,2]",
"exres": "\"el\"",
"lname": "source string",
"name": "select",
"op": "select",
"rname": "[start,length]",
"since": "5195"
},
{
"cat": "Default",
"desc": "If the code returns true current array element is selected and added to the resulting array",
"ex": "",
"exres": "",
"lname": "array",
"name": "select",
"op": "select",
"rname": "code",
"since": ""
},
{
"cat": "General",
"desc": "Returns subentry with given index.",
"ex": "(configFile >> \"CfgVehicles\") select 0",
"exres": "",
"lname": "config",
"name": "select",
"op": "select",
"rname": "index",
"since": "2.35"
}
],
"selectDiarySubject": [
{
"cat": "Identity",
"desc": "Select the subject page in a log.",
"ex": "",
"exres": "",
"lname": "person",
"name": "selectdiarysubject",
"op": "selectdiarysubject",
"rname": "subject",
"since": "5500"
}
],
"selectEditorObject": [
{
"cat": "Editor",
"desc": "Select an editor object. Does not un-select previously selected objects.",
"ex": "",
"exres": "",
"lname": "map",
"name": "selecteditorobject",
"op": "selecteditorobject",
"rname": "object",
"since": "2.92"
}
],
"selectLeader": [
{
"cat": "General",
"desc": "Select group leader.",
"ex": "group player selectLeader player",
"exres": "",
"lname": "group",
"name": "selectleader",
"op": "selectleader",
"rname": "unit",
"since": "2.33"
}
],
"selectWeapon": [
{
"cat": "General",
"desc": "Selects the given weapon.\r\nFor weapon values see <cl>CfgWeapons</cl>.",
"ex": "soldierOne selectWeapon \"LAWLauncher\"",
"exres": "",
"lname": "unit",
"name": "selectweapon",
"op": "selectweapon",
"rname": "weapon",
"since": "1.27"
}
],
"selectWeaponTurret": [
{
"cat": "General",
"desc": "Selects the given weapon on specified turret",
"ex": "tank selectWeaponTurret [\"LAWLauncher\", [0]]",
"exres": "",
"lname": "vehicle",
"name": "selectweaponturret",
"op": "selectweaponturret",
"rname": "[weapon, turret path]",
"since": ""
}
],
"selectionPosition": [
{
"cat": "General",
"desc": "Search for selection in the object model (first in the memory level, then in other levels). Or search for selection in the given memory level of object model (Memory, Geometry, FireGeometry, LandContact, HitPoints). Returns position in model space.",
"ex": "",
"exres": "",
"lname": "object",
"name": "selectionposition",
"op": "selectionposition",
"rname": "selectionName or [selectionName, lodName]",
"since": "2.92"
}
],
"sendSimpleCommand": [
{
"cat": "General",
"desc": "Sends a simple command to the vehicle's driver / gunner.",
"ex": "vehicle player sendSimpleCommand \"STOP\"",
"exres": "",
"lname": "object",
"name": "sendsimplecommand",
"op": "sendsimplecommand",
"rname": "command",
"since": "2.26"
}
],
"sendTask": [
{
"cat": "Identity",
"desc": "Create a new AI task (subtask of parentTask). Type is name of registered task type.",
"ex": "",
"exres": "",
"lname": "sender",
"name": "sendtask",
"op": "sendtask",
"rname": "[receiver, [type] or [type, parentTask], priority, name1, value1, name2, value2, ...]",
"since": "2.92"
}
],
"sendTaskResult": [
{
"cat": "Identity",
"desc": "Send a result of the task to the task sender.",
"ex": "",
"exres": "",
"lname": "task",
"name": "sendtaskresult",
"op": "sendtaskresult",
"rname": "[state, result, sentence]",
"since": "2.92"
}
],
"serverCommand": [
{
"cat": "General",
"desc": "Process the specified server command\nThis command needs to be executed from UI handler to succeed.",
"ex": "\"password\" serverCommand \"#kick friendlykiller\"",
"exres": "",
"lname": "password",
"name": "servercommand",
"op": "servercommand",
"rname": "server command",
"since": ""
}
],
"set": [
{
"cat": "Default",
"desc": "Format of element is [index, value].\r\nChanges an element of the given array. If the element does not exist, index+1 is called to create it.",
"ex": "array set [0, \"Hello\"]",
"exres": "",
"lname": "array",
"name": "set",
"op": "set",
"rname": "element",
"since": "1.75"
}
],
"set3DENAttribute": [
{
"cat": "General",
"desc": "Returns TRUE if change was processed.",
"ex": "0 set3DENAttribute [\"Name\", \"MyEntity\"]",
"exres": "",
"lname": "<entity>",
"name": "set3denattribute",
"op": "set3denattribute",
"rname": "[<attributeType>,<value>]",
"since": ""
}
],
"set3DENLayer": [
{
"cat": "General",
"desc": "Sets given editor entity to be in given layer.",
"ex": "\"myMarker\" set3DENLayer 0",
"exres": "",
"lname": "<entity>",
"name": "set3denlayer",
"op": "set3denlayer",
"rname": "<layerID>",
"since": ""
}
],
"set3DENMissionAttribute": [
{
"cat": "General",
"desc": "Sets given value into global 3DEN attribute",
"ex": "\"Scenario\" get3DENMissionAttribute [\"author\", \"MyAuthor\"]",
"exres": "",
"lname": "<section>",
"name": "set3denmissionattribute",
"op": "set3denmissionattribute",
"rname": "[<class>, <value>]",
"since": ""
}
],
"set3DENObjectType": [
{
"cat": "General",
"desc": "Swaps type of all listed editorObjects to given objectClassName.",
"ex": "(get3DENSelected \"Object\") set3DENObjectType \"B_Soldier_F\"",
"exres": "",
"lname": "[editorObjects]",
"name": "set3denobjecttype",
"op": "set3denobjecttype",
"rname": "objectClassName",
"since": ""
}
],
"setActualCollectiveRTD": [
{
"cat": "General",
"desc": "Set wanted RPM of given motor, use index -1 for all motors.",
"ex": "",
"exres": "",
"lname": "RTD_helicopter",
"name": "setactualcollectivertd",
"op": "setactualcollectivertd",
"rname": "Set starting collective.",
"since": "TOH 81393"
}
],
"setAirportSide": [
{
"cat": "General",
"desc": "Set owner of the airport",
"ex": "0 setAirportSide east",
"exres": "",
"lname": "airportId",
"name": "setairportside",
"op": "setairportside",
"rname": "side",
"since": "2.92"
}
],
"setAmmo": [
{
"cat": "General",
"desc": "Set how many shots the unit has left for the loaded magazine in the given weapon type.",
"ex": "player setAmmo [\"M16\",5]",
"exres": "",
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment