Not a member of Pastebin yet?
Sign Up,
it unlocks many cool features!
- Name: -
- Description: Extend expression
- Category: Simple expression
- Address: 0x123B090
- Arg1: val
- Arg2: expr
- Name: -
- Description: Extend expression
- Category: Simple expression
- Address: 0x123B090
- Arg1: val
- Arg2: expr
- Name: -
- Description: Extend expression
- Category: Simple expression
- Address: 0x12390F0
- Arg1: expr1
- Arg2: expr2
- Name: -
- Description: Extend expression
- Category: Simple expression
- Address: 0x1239120
- Arg1: expr
- Arg2: val
- Name: -
- Description: Extend expression
- Category: Simple expression
- Address: 0x1238ED0
- Example: -daylight
- Arg1: expr
- Name: -
- Description: Extend expression
- Category: Simple expression
- Address: 0x12390F0
- Arg1: expr1
- Arg2: expr2
- Name: -
- Description: Extend expression
- Category: Simple expression
- Address: 0x1239120
- Arg1: expr
- Arg2: val
- Name: *
- Description: Extend expression
- Category: Simple expression
- Address: 0x123AF20
- Arg1: val
- Arg2: expr
- Name: *
- Description: Extend expression
- Category: Simple expression
- Address: 0x1238EA0
- Arg1: expr
- Arg2: val
- Name: *
- Description: Extend expression
- Category: Simple expression
- Address: 0x1238E70
- Arg1: expr1
- Arg2: expr2
- Name: *
- Description: Extend expression
- Category: Simple expression
- Address: 0x1238E70
- Arg1: expr1
- Arg2: expr2
- Name: *
- Description: Extend expression
- Category: Simple expression
- Address: 0x1238EA0
- Arg1: expr
- Arg2: val
- Name: *
- Description: Extend expression
- Category: Simple expression
- Address: 0x123AF20
- Arg1: val
- Arg2: expr
- Name: /
- Description: Extend expression
- Category: Simple expression
- Address: 0x1238880
- Arg1: expr
- Arg2: val
- Name: /
- Description: Extend expression
- Category: Simple expression
- Address: 0x123AD60
- Arg1: val
- Arg2: expr
- Name: /
- Description: Extend expression
- Category: Simple expression
- Address: 0x123AD60
- Arg1: val
- Arg2: expr
- Name: /
- Description: Extend expression
- Category: Simple expression
- Address: 0x1238880
- Arg1: expr
- Arg2: val
- Name: /
- Description: Extend expression
- Category: Simple expression
- Address: 0x1238850
- Arg1: expr1
- Arg2: expr2
- Name: /
- Description: Extend expression
- Category: Simple expression
- Address: 0x1238850
- Arg1: expr1
- Arg2: expr2
- Name: +
- Description: Extend expression
- Category: Simple expression
- Address: 0x12387F0
- Arg1: expr1
- Arg2: expr2
- Name: +
- Description: Extend expression
- Category: Simple expression
- Address: 0x1238820
- Arg1: expr
- Arg2: val
- Name: +
- Description: Extend expression
- Category: Simple expression
- Address: 0x12387F0
- Arg1: expr1
- Arg2: expr2
- Name: +
- Description: Extend expression
- Category: Simple expression
- Address: 0x1238820
- Arg1: expr
- Arg2: val
- Name: +
- Description: Extend expression
- Category: Simple expression
- Address: 0x123AD30
- Arg1: val
- Arg2: expr
- Name: +
- Description: Extend expression
- Category: Simple expression
- Address: 0x1238FD0
- Example: +daylight
- Arg1: expr
- Name: +
- Description: Extend expression
- Category: Simple expression
- Address: 0x123AD30
- Arg1: val
- Arg2: expr
- Name: accTime
- Description: Returns the current time acceleration factor.
- Category: General
- Address: 0xC9FAD0
- Name: actionKeys
- Description: Returns a list of dikCodes of buttons assigned to the given user action.
- Category: General
- Address: 0xC9FB80
- Example: array = actionKeys "ReloadMagazine"
- Arg1: action
- Name: actionKeysImages
- Description: Returns a list of button images or names assigned to the given user action. A maximum of maxKeys keys is listed. You can find the action names in config class ControllerSchemes.
- Category: General
- Address: 0xC9FD10
- Example: text = actionKeysImages "ReloadMagazine"
- Arg1: action or [action, maxKeys]
- Name: actionKeysNames
- Description: 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.
- Category: General
- Address: 0xCA0020
- Example: list = actionKeysNames "ReloadMagazine"
- Arg1: action or [action, maxKeys] or [action, maxKeys, inputDevicePriority]
- Name: actionKeysNamesArray
- Description: 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.
- Category: General
- Address: 0xCA0370
- Example: list = actionKeysNames "ReloadMagazine"
- Arg1: action or [action, maxKeys] or [action, maxKeys, inputDevicePriority]
- Name: actionName
- Description: Returns localized name of action.
- Category: General
- Address: 0xCA0990
- Example: name = actionName "ReloadMagazine"
- Arg1: action
- Name: activateAddons
- Description: Activates the listed addons. The list of active addons is reinitialized during this function.
- Category: General
- Address: 0xC8F710
- Example: activateAddons ["BISOFP"]
- Arg1: [addon1, ...]
- Name: activatedAddons
- Category: General
- Address: 0xC8D7F0
- Name: activateKey
- Description: Activates the given key for the current user profile. The keys are used to unlock missions or campaigns. See keys, keysLimit and doneKeys in the description.ext file of the missions.
- Category: General
- Address: 0xD1EC30
- Example: activateKey "M04"
- Arg1: keyName
- Name: addCamShake
- Description: Adds camera shake source.
- Category: General
- Address: 0xC8DD80
- Arg1: [power, duration, frquency]
- Name: addForceGeneratorRTD
- Description: Add force generator to world. Returns force index.
- Category: General
- Address: 0xC8E980
- Arg1: [bool enabled, int type, vec3 strengh, vec3 position, vec3 radius, vec3 orientation, object AttachTo]
- Name: addItemPool
- Description: Adds count items of type name into the weapon pool (used in the campaign to transfer weapons to the next mission).
- Category: General
- Address: 0xF92D70
- Name: addMagazinePool
- Description: Adds count magazines of type name into the weapon pool (used in the campaign to transfer weapons to the next mission).
- Category: General
- Address: 0xF92EB0
- Name: addMissionEventHandler
- Description: 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.
- Category: General
- Address: 0xD28460
- Example: _id = addMissionEventHandler ["ended",{_this exec "missionEnded.sqs"}]
- Arg1: [type, command]
- Name: addMusicEventHandler
- Description: Add an music track event handler. Returns id of the handler or -1 when failed.
- Category: General
- Address: 0xD29600
- Example: _id = addMusicEventHandler ["MusicStart", "hint format['Sample %1 start', _this select 0]"]
- Arg1: [type, function]
- Name: addSwitchableUnit
- Description: Add a unit into the list of units available for team switch.
- Category: General
- Address: 0xC8F350
- Arg1: person
- Name: addToRemainsCollector
- Description: Flags given objects to me managed by unitRemove manager
- Category: General
- Address: 0xC8F470
- Example: addToRemainsCollector [unit1, unit2]
- Arg1: array
- Name: addWeaponPool
- Description: Adds count weapons of type name into the weapon pool (used in campaigns to transfer weapons to the next mission).
- Category: General
- Address: 0xF92FF0
- Arg1: [name, count]
- Name: agent
- Description: Return a person for given agent.
- Category: Agents
- Address: 0xD5E010
- Example: _person = agent _agent
- Arg1: agent
- Name: agents
- Description: Return a list of agents in the current mission.
- Category: Agents
- Address: 0xD5E0B0
- Example: _agents = agents
- Name: aimPos
- Description: Returns the position of the object other units can aim to in format <ar>PositionASL</ar>.
- Category: General
- Address: 0xD35760
- Example: aimPos player
- Arg1: obj
- Name: airDensityCurveRTD
- Description: Returns air density curve graph.
- Category: General
- Address: 0xCA0A80
- Name: airDensityRTD
- Description: Returns air density in given altitude.
- Category: General
- Address: 0xCA0DE0
- Arg1: altitude
- Name: airportSide
- Description: Checks a side of the airport.
- Category: General
- Address: 0xC8FF60
- Example: airportSide 0
- Ex. Returns: west
- Arg1: airportId
- Name: AISFinishHeal
- Description: AIS end state.
- Category: General
- Address: 0xC8CF80
- Example: AISFinishHeal [wounded,medic,true]
- Arg1: [unit,unit,bool]
- Name: alive
- Description: Checks whether the given person, vehicle or building is't dead / destroyed.
- Category: General
- Address: 0xD2C890
- Example: alive player
- Arg1: obj
- Name: allCurators
- Description: Returns list of all curators.
- Category: General
- Address: 0xCA1950
- Name: allDead
- Description: Return a list of dead units and destroyed vehicles. Dead unit might be inside vehicle.,
- Category: General
- Address: 0xCA1AF0
- Name: allDeadMen
- Description: Return a list of dead units. Dead unit might be inside vehicle.,
- Category: General
- Address: 0xCA1C00
- Name: allGroups
- Description: Return a list of all groups.
- Category: General
- Address: 0xCA1D10
- Name: allMapMarkers
- Description: Return all markers in map.
- Category: General
- Address: 0xD69C50
- Name: allMines
- Description: Returns an array of all mines in game.
- Category: General
- Address: 0xCA1EF0
- Example: allMines
- Ex. Returns: [listOfAllMines]
- Name: allMissionObjects
- Description: Returns all mission objects with given type.
- Category: General
- Address: 0xCA1F40
- Example: allMissionObjects "Air"
- Arg1: type
- Name: allSites
- Description: Return a list of all sites.
- Category: General
- Address: 0xCA22E0
- Name: allTurrets
- Description: Returns array with turrets in given vehicle
- Category: General
- Address: 0xCA23E0
- Example: allTurrets vehicle player
- Arg1: vehicle
- Name: allTurrets
- Description: Returns array with turrets in given vehicle. TRUE FALSE stands for return person turrets
- Category: General
- Address: 0xCA2490
- Example: allTurrets [vehicle player, true]
- Arg1: [vehicle, includePersonTurrets]
- Name: allUnits
- Description: Return a list of all units (all persons except agents).
- Category: General
- Address: 0xCA26A0
- Name: allUnitsUAV
- Description: Return a list of all UAV units.
- Category: General
- Address: 0xCA28E0
- Name: animationState
- Description: Return the name of the current primary animation.
- Category: General
- Address: 0xD6FE20
- Arg1: man
- Name: armoryPoints
- Description: Return the stored value of armory points.
- Category: General
- Address: 0xCA2940
- Name: ASLToATL
- Description: Converts a position from <ar>PositionASL</ar> to <ar>Position</ar> format.
- Category: General
- Address: 0xD3C3B0
- Example: ASLToATL getPosASL player
- Arg1: pos
- Name: assignedCargo
- Description: Returns the list of soldiers assigned to the given vehicle as a cargo.
- Category: General
- Address: 0xD325E0
- Arg1: vehicle
- Name: assignedCommander
- Description: Returns the soldier assigned to the given vehicle as a commander.
- Category: General
- Address: 0xD329B0
- Arg1: vehicle
- Name: assignedDriver
- Description: Returns the soldier assigned to the given vehicle as a driver.
- Category: General
- Address: 0xD32D00
- Arg1: vehicle
- Name: assignedGunner
- Description: Returns the soldier assigned to the given vehicle as a gunner.
- Category: General
- Address: 0xD33900
- Arg1: vehicle
- Name: assignedItems
- Description: Get array with all assigned items.
- Category: General
- Address: 0xD2C8E0
- Arg1: unit
- Name: assignedTarget
- Description: Return the target assigned to the vehicle.
- Category: General
- Address: 0xD6FE80
- Arg1: vehicle
- Name: assignedTeam
- Description: Checks which team does the vehicle (its commander unit) belong to.
- Category: General
- Address: 0xC908D0
- Example: assignedTeam soldier2
- Ex. Returns: MAIN
- Arg1: vehicle
- Name: assignedVehicle
- Description: Return the vehicle person is assigned to.
- Category: General
- Address: 0xD31120
- Arg1: person
- Name: assignedVehicleRole
- Description: Return the position in vehicle person is assigned to.
- Category: General
- Address: 0xD311A0
- Arg1: person
- Name: ATLToASL
- Description: Converts a position from <ar>Position</ar> to <ar>PositionASL</ar> format.
- Category: General
- Address: 0xD3C4B0
- Example: ATLToASL getPosATL player
- Arg1: pos
- Name: attachedObjects
- Description: Returns list of attached objects.
- Category: General
- Address: 0xC90AC0
- Example: attachedObjects player
- Arg1: Unit
- Name: attachedTo
- Description: Returns the object it is attach to.
- Category: General
- Address: 0xC90CA0
- Example: attachedTo player
- Arg1: Unit
- Name: attackEnabled
- Description: Return whether leader can issue attack commands.
- Category: General
- Address: 0xCB36B0
- Arg1: group
- Name: backpack
- Description: Returns a class of a backpack.
- Category: General
- Address: 0xD2E330
- Arg1: unit
- Name: backpackCargo
- Description: Get array with backpacks from ammo box (or any general weapon holder container).
- Category: General
- Address: 0xD2E090
- Arg1: box
- Name: backpackContainer
- Description: Returns container of a backpack.
- Category: General
- Address: 0xD2E0B0
- Arg1: unit
- Name: backpackItems
- Description: Get array with all items from backpack.
- Category: General
- Address: 0xD2E0D0
- Arg1: unit
- Name: backpackMagazines
- Description: Get array with all magazines from vest.
- Category: General
- Address: 0xD2E310
- Arg1: unit
- Name: behaviour
- Description: Returns the behaviour mode of the given unit ("CARELESS","SAFE","AWARE","COMBAT" or "STEALTH").
- Category: General
- Address: 0xD2E360
- Example: behaviour player
- Arg1: unit
- Name: benchmark
- Description: Returns the value of "3D performance" as it is in OFP preferences. This can be used to estimate computer performance. The function can be used to create missions that are able to adapt to computer peformance.
- Category: General
- Address: 0xC90D20
- Example: ? benchmark>2000 : setviewdistance 2000
- Name: binocular
- Description: Returns name of currently used binocular.
- Category: General
- Address: 0xD31890
- Arg1: unit
- Name: blufor
- Description: Pre-defined variable for the blufor side.
- Category: General
- Address: 0xD57560
- Name: boundingBox
- Description: 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]].
- Category: General
- Address: 0xD319B0
- Arg1: object
- Name: boundingBoxReal
- Description: Returns a bounding box of given object in model coordinates space. The result is in format [[minX, minZ, minY], [maxX, maxZ, maxY]].
- Category: General
- Address: 0xD31CF0
- Example: boundingBoxReal cursorTarget
- Arg1: obj
- Name: boundingCenter
- Description: Returns the position of original (loaded) center of object in model coordinates. The result is in format [x, z, y]
- Category: General
- Address: 0xD32030
- Arg1: object
- Name: briefingName
- Description: Returns the name of the current briefing.
- Category: General
- Address: 0xC90D40
- Name: buldozer_EnableRoadDiag
- Category: General
- Address: 0xC90F60
- Arg1: enable
- Name: buldozer_IsEnabledRoadDiag
- Description: Is enabled road diag in buldozer?
- Category: General
- Address: 0xCB88A0
- Example: true/false
- Name: buldozer_LoadNewRoads
- Category: General
- Address: 0xC90FF0
- Arg1: path
- Name: buldozer_reloadOperMap
- Description: Reload oper map visible in costMap diag tool.
- Category: General
- Address: 0xC91100
- Name: buttonAction
- Description: Returns the action assigned to the given button or active text. The action is any expression in this scripting language.
- Category: General
- Address: 0xD61890
- Example: _action = buttonAction _button
- Arg1: control
- Name: buttonAction
- Description: Returns the action assigned to the control with id idc of the topmost user dialog. The action is any expression in this scripting language. The function can be used for buttons and active texts.
- Category: General
- Address: 0xC91120
- Example: _action = buttonAction 100
- Arg1: idc
- Name: buttonSetAction
- Description: Assigns an action to the control with id idc of the topmost user dialog. Action is any expression in this scripting language. The function can be used for buttons and active texts.
- Category: General
- Address: 0xC913D0
- Example: buttonSetAction [100, "player exec ""reply.sqs"""]
- Arg1: [idc, action]
- Name: cadetMode
- Description: Returns true if the mission is played in cadet mode and false in veteran mode.
- Category: General
- Address: 0xC91560
- Name: camCommitted
- Description: Checks whether the camera has finished committing.
- Category: General
- Address: 0xC91940
- Example: camCommitted _camera
- Arg1: camera
- Name: camDestroy
- Description: Destroys the camera.
- Category: General
- Address: 0xC91E80
- Arg1: camera
- Name: cameraEffectEnableHUD
- Description: Enable / disable showing of in-game UI during currently active camera effect.
- Category: General
- Address: 0xC92B10
- Arg1: enable
- Name: cameraInterest
- Description: Return camera interest for given entity.
- Category: General
- Address: 0xD6FF70
- Arg1: entity
- Name: cameraOn
- Description: Returns the vehicle to which the camera is attached.
- Category: General
- Address: 0xC92B60
- Name: cameraView
- Description: Return type of camera.
- Category: General
- Address: 0xD32510
- Name: campaignConfigFile
- Description: Return root of campaign description.ext entries hierarchy.
- Category: General
- Address: 0xC938A0
- Name: camPreloaded
- Description: Checks whether the camera has finished preloading.
- Category: General
- Address: 0xC92150
- Example: camPreloaded _camera
- Arg1: camera
- Name: camTarget
- Description: Returns camera's target.
- Category: General
- Address: 0xC91EC0
- Example: camTarget _camera
- Arg1: camera
- Name: camUseNVG
- Description: Set / clear using of night vision during cutscenes.
- Category: General
- Address: 0xD4FAA0
- Arg1: set
- Name: canFire
- Description: Checks whether the given vehicle is able to fire. It does not check for ammo, only for damage.
- Category: General
- Address: 0xD2E840
- Example: canFire vehicle player
- Arg1: vehicle
- Name: canMove
- Description: Checks whether the given vehicle is able to move. It does not test for fuel, only the damage status is checked.
- Category: General
- Address: 0xD2E8E0
- Example: canMove vehicle player
- Arg1: vehicle
- Name: canStand
- Description: Checks whether the given soldier is able to stand up.
- Category: General
- Address: 0xD2E950
- Example: canStand player
- Arg1: soldier
- Name: canUnloadInCombat
- Description: Check if cargo of this vehicle want to get out when in combat.
- Category: General
- Address: 0xD2E9B0
- Arg1: vehicle
- Name: captive
- Description: Checks whether the unit is a captive. If the unit is a vehicle, its commander is checked instead.
- Category: General
- Address: 0xD2EA10
- Example: captive player
- Arg1: unit
- Name: captiveNum
- Description: Checks whether the unit is a captive. If the unit is a vehicle, its commander is checked instead.
- Category: General
- Address: 0xD2EA80
- Example: captive player
- Arg1: unit
- Name: cbChecked
- Description: Returns the current state of CheckBox.
- Category: General
- Address: 0xD61FA0
- Example: _checked = cbChecked _myCheckBox
- Arg1: control
- Name: cheatsEnabled
- Description: Checks whether cheats are enabled (whether the designers' version is running).
- Category: General
- Address: 0x11D62F0
- Name: checkAIFeature
- Description: Check if given AI feature is currently enabled.
- Category: General
- Address: 0xC92F30
- Arg1: feature
- Name: civilian
- Description: The Civilian side.
- Category: General
- Address: 0xD575A0
- Name: clearAllItemsFromBackpack
- Description: Removes all items from the backpack.
- Category: General
- Address: 0xD2EAF0
- Arg1: unit
- Name: clearBackpackCargo
- Description: Removes all backpacks from ammo box (or any general weapon holder container).
- Category: General
- Address: 0xD2EB50
- Example: clearBackpackCargo jeepOne
- Arg1: box
- Name: clearBackpackCargoGlobal
- Description: Removes all magazines from the vehicle cargo space. MP synchronized.
- Category: General
- Address: 0xD2EBB0
- Example: clearMagazineCargoGlobal jeepOne
- Arg1: unit
- Name: clearForcesRTD
- Description: Remove all force generators from wolrd.
- Category: General
- Address: 0xC93200
- Name: clearGroupIcons
- Description: Removes all icon from group.
- Category: General
- Address: 0xC93250
- Example: clearGroupIcons group
- Arg1: group
- Name: clearItemCargo
- Description: Removes all items from ammo box (or any general weapon holder container).
- Category: General
- Address: 0xD2EC00
- Example: clearItemCargo jeepOne
- Arg1: box
- Name: clearItemCargoGlobal
- Description: Removes all items from ammo box (or any general weapon holder container).
- Category: General
- Address: 0xD2EC60
- Example: clearItemCargoGlobal jeepOne
- Arg1: box
- Name: clearItemPool
- Description: Removes all magazines from the weapon pool (this is used in campaigns to transfer weapons to the next mission).
- Category: General
- Address: 0xF93130
- Name: clearMagazineCargo
- Description: Removes all magazines from the vehicle cargo space.
- Category: General
- Address: 0xD2ECB0
- Example: clearMagazineCargo jeepOne
- Arg1: unit
- Name: clearMagazineCargoGlobal
- Description: Removes all magazines from the vehicle cargo space. MP synchronized.
- Category: General
- Address: 0xD2ED10
- Example: clearMagazineCargoGlobal jeepOne
- Arg1: unit
- Name: clearMagazinePool
- Description: Removes all magazines from the weapon pool (this is used in campaigns to transfer weapons to the next mission).
- Category: General
- Address: 0xF93170
- Name: clearRadio
- Description: Clean up the content of radio protocol history.
- Category: General
- Address: 0xD49360
- Name: clearWeaponCargo
- Description: Removes all weapons from the vehicle cargo space.
- Category: General
- Address: 0xD2ED60
- Example: clearWeaponCargo jeepOne
- Arg1: unit
- Name: clearWeaponCargoGlobal
- Description: Removes all weapons from the vehicle cargo space. MP synchronized.
- Category: General
- Address: 0xD2EDC0
- Example: clearWeaponCargoGlobal jeepOne
- Arg1: unit
- Name: clearWeaponPool
- Description: Removes all weapons from the weapon pool (this is used in campaigns to transfer weapons to the next mission).
- Category: General
- Address: 0xF931B0
- Name: closeDialog
- Description: Closes the topmost user dialog as if a button with id idc was pressed.
- Category: General
- Address: 0xC9AC80
- Example: closeDialog 1
- Arg1: idc
- Name: collectiveRTD
- Description: Returns collective.
- Category: General
- Address: 0xCA37A0
- Arg1: RTD_helicopter
- Name: combatMode
- Description: Returns the combat mode of the given unit ("BLUE","GREEN","YELLOW" or "RED").
- Category: General
- Address: 0xCB2EF0
- Example: combatMode group player
- Arg1: grp
- Name: commander
- Description: Returns the commander of the vehicle. If the vehicle is not a vehicle, but a person, the person is returned instead.
- Category: General
- Address: 0xD2F2D0
- Example: commander vehicle player
- Arg1: vehicle
- Name: commandGetOut
- Description: Orders the unit to get out from the vehicle (via the radio).
- Category: General
- Address: 0xD6E8C0
- Example: commandGetOut unitOne
- Arg1: unit
- Name: commandingMenu
- Description: Return the name of the topmost commanding menu.
- Category: General
- Address: 0xCA3A40
- Name: commandStop
- Description: Orders the unit to stop (via the radio).
- Note: the stop command is never finished; the unit will never be ready.
- Category: General
- Address: 0xD6E900
- Example: commandStop unitOne
- Arg1: unit
- Name: completedFSM
- Description: Check whether the given FSM completes. The FSM handle is the number returned by the execFSM command.
- Category: General
- Address: 0xC9C9B0
- Arg1: FSM handle
- Name: composeText
- Description: Creates a structured text by joining the given structured or plain texts.
- Category: General
- Address: 0xD609B0
- Example: txt = composeText ["First line", image "data\isniper.paa", lineBreak, "Second line"]
- Arg1: [text1, text2, ...]
- Name: configFile
- Description: Return root of config entries hierarchy.
- Category: General
- Address: 0xC942A0
- Name: configName
- Description: Returns name of config entry.
- Category: General
- Address: 0xC94180
- Example: _name = configName (configFile >> "CfgVehicles")
- Ex. Returns: "CfgVehicles"
- Arg1: config
- Name: configProperties
- Description: 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.
- Category: General
- Address: 0xCA4090
- Arg1: [config, condition, includeInherited]
- Name: controlNull
- Description: A non-existing control. This value is not equal to anything, including itself.
- Category: General
- Address: 0xD62F90
- Name: copyFromClipboard
- Description: Return the content of the (text) clipboard.
- Category: General
- Address: 0xC94E60
- Name: copyToClipboard
- Description: Copy the text to the clipboard.
- Category: General
- Address: 0xC94F20
- Arg1: text
- Name: count
- Description: Returns count of subentries.
- Category: General
- Address: 0xC93B00
- Example: _count = count (configFile >> "CfgVehicles")
- Arg1: config
- Name: createAgent
- Description: Creates an (independent) agent (person) of the given type (type is a name of a subclass of CfgVehicles). If the markers array contains several marker names, the position of a random one is used. Otherwise, the given position is used. The unit is placed inside a circle with this position as its center and placement as its radius. Special properties can be: "NONE" and "FORM".
- Category: General
- Address: 0xC8F8E0
- Example: agent = createAgent ["SoldierWB", position player, [], 0, "FORM"]
- Arg1: [type, position, markers, placement, special]
- Name: createCenter
- Description: Creates a new AI center for the given side.
- Category: General
- Address: 0xC92CA0
- Example: center = createCenter East
- Arg1: side
- Name: createDialog
- Description: Creates a user dialog from the resource template name. If a user dialog already exists, it creates a child dialog of the topmost user dialog. The class name is searched in the description.ext file of the mission, the description.ext file of the campaign and the globlal resource.cpp file. The function returns its success.
- Category: General
- Address: 0xC9ACF0
- Example: _ok = createDialog "RscDisplayGame"
- Arg1: name
- Name: createGearDialog
- Description: Opens gear dialog for given unit.
- Category: General
- Address: 0xC95C90
- Example: CreateGearDialog [palyer,"RscDisplayGear"]
- Arg1: [unit,resource]
- Name: createGroup
- Description: Creates a new AI group for the given center (side).
- Category: General
- Address: 0xCB2770
- Example: group = createGroup East
- Arg1: side
- Name: createGuardedPoint
- Description: Adds a point guarded by the given side. If idStatic is not negative, the position of a static object with the given id is guarded. If the given vehicle is valid, the starting position of the vehicle is guarded, otherwise the given position is guarded.
- Category: General
- Address: 0xCB4BD0
- Example: point = createGuardedPoint [East, [0, 0], -1, vehicle player]
- Arg1: [side, position, idStatic, vehicle]
- Name: createMarker
- Description: Creates a new marker on the given position. The marker name has to be unique. The marker is created on all computers in a network session.
- Category: General
- Address: 0xD25AF0
- Example: marker = createMarker [Marker1, position player]
- Arg1: [name, position]
- Name: createMarkerLocal
- Description: Creates a new marker on the given position. The marker name has to be unique. The marker is only created on the computer where the command is called.
- Category: General
- Address: 0xD258F0
- Example: marker = createMarkerLocal [Marker1, position player]
- Arg1: [name, position]
- Name: createMine
- Description: Creates a mine of the given type (type is the name of the subclass of CfgVehicles). If the markers array contains several marker names, the position of a random one is used. Otherwise, the given position is used. The mine is placed inside a circle with this position as its center and placement as its radius.
- Category: General
- Address: 0xD28100
- Example: mine = createMine ["MineMine", position player, [], 0]
- Arg1: [type, position, markers, placement]
- Name: createSoundSource
- Description: Creates a sound source of the given type (type is the name of the subclass of CfgVehicles). If the markers array contains several marker names, the position of a random one is used. Otherwise, the given position is used. The sound source is placed inside a circle with this position as its center and placement as its radius.
- Category: General
- Address: 0xD58DF0
- Example: soundSource = createSoundSource ["LittleDog", position player, [], 0]
- Arg1: [type, position, markers, placement]
- Name: createTeam
- Description: Create a team and name it.
- Category: Agents
- Address: 0xD5D0D0
- Example: _team = createTeam ["USMC_Team", "Fire Team Red"]
- Arg1: [type, name]
- Name: createTrigger
- Description: Creates a new trigger on the given position. An object of the given type is created; this type must be a class name in CfgNonAIVehicles or CfgVehicles with simulation=detector.
- Category: General
- Address: 0xD5F630
- Example: trigger = createTrigger["EmptyDetector", position player]
- Arg1: [type, position]
- Name: createVehicle
- Description: Creates a vehicle of the given type (type is the name of the subclass in CfgVehicles). If the markers array contains several marker names, the position of a random one is used. Otherwise, the given position is used. The vehicle is placed inside a circle with this position as center and placement as its radius. Special properties can be: "NONE", "FLY" and "FORM".
- Category: General
- Address: 0xD6EAC0
- Example: veh = createVehicle ["Cobra", position player, [], 0, "FLY"]
- Arg1: [type, position, markers, placement, special]
- Name: createVehicleCrew
- Description: Creates crew to given vehicle.
- Category: General
- Address: 0xC973B0
- Example: createVehicleCrew vehicle0
- Arg1: Vehicle
- Name: crew
- Description: Returns all units mounted in the given vehicle. If the vehicle is not a vehicle, but person, a list containing only persons is returned.
- Category: General
- Address: 0xD396F0
- Example: crew vehicle player
- Arg1: vehicle
- Name: ctrlActivate
- Description: Launch actions attached to given (button based) control.
- Category: General
- Address: 0xD61E40
- Example: ctrlActivate _control
- Arg1: control
- Name: ctrlAutoScrollDelay
- Description: Returns number of seconds until auto-scroll starts. -2 if scrollbar not present.
- Category: General
- Address: 0xD62520
- Example: _delay = ctrlAutoScrollDelay _control
- Arg1: control
- Name: ctrlAutoScrollRewind
- Description: True if auto-scroll should move back to start after it reach end.
- Category: General
- Address: 0xD62630
- Example: _rewind = ctrlAutoScrollRewind _control
- Arg1: control
- Name: ctrlAutoScrollSpeed
- Description: Returns number of seconds to auto-scroll one line. -1 if auto-scroll is disabled. -2 if scrollbar not present.
- Category: General
- Address: 0xD62720
- Example: _speed = ctrlAutoScrollSpeed _control
- Arg1: control
- Name: ctrlChecked
- Description: Returns the current state of textual checkbox.
- Category: General
- Address: 0xD62830
- Example: _checked = ctrlChecked _control
- Arg1: control
- Name: ctrlClassName
- Description: Returns class name of given control.
- Category: General
- Address: 0xCA4830
- Example: ctrlClassName ((FindDisplay 20000) displayCtrl 20001)
- Arg1: control
- Name: ctrlCommitted
- Description: Check if the control animation is finished.
- Category: General
- Address: 0xD62360
- Example: _done = ctrlCommitted _control
- Arg1: control
- Name: ctrlDelete
- Description: Deletes given control.
- Category: General
- Address: 0xC99B90
- Example: ctrlDelete ((FindDisplay 20000) displayCtrl 20001)
- Arg1: control
- Name: ctrlEnable
- Description: Enables / disables the control with id idc of the topmost user dialog.
- Category: General
- Address: 0xC97A40
- Example: ctrlEnable [100, false]
- Arg1: [idc, enable]
- Name: ctrlEnabled
- Description: Returns whether the control with id idc of the topmost user dialog is enabled.
- Category: General
- Address: 0xC97AF0
- Example: _enabled = ctrlEnabled 100
- Arg1: idc
- Name: ctrlEnabled
- Description: Returns whether given control is enabled.
- Category: General
- Address: 0xD62DF0
- Example: _ok = ctrlEnabled _control
- Arg1: control
- Name: ctrlFade
- Description: Returns the current fade factor of control.
- Category: General
- Address: 0xD628C0
- Example: _scale = ctrlFade _control
- Arg1: control
- Name: ctrlHTMLLoaded
- Description: Returns true when HTML content was successfully loaded.
- Category: General
- Address: 0xD66A20
- Example: _htmlLoaded ctrlHTMLLoaded _control
- Arg1: control
- Name: ctrlIDC
- Description: Returns control IDC.
- Category: General
- Address: 0xD62D70
- Example: IDC = ctrlIDC _control
- Arg1: control
- Name: ctrlIDD
- Description: Returns display IDD.
- Category: General
- Address: 0xD65C90
- Example: IDD = ctrlIDD _display
- Arg1: display
- Name: ctrlMapAnimClear
- Description: Clears the map animation.
- Category: General
- Address: 0xD69F10
- Arg1: control
- Name: ctrlMapAnimCommit
- Description: Plays the map animation.
- Category: General
- Address: 0xD69FA0
- Arg1: control
- Name: ctrlMapAnimDone
- Description: Checks whether the map animation has finished.
- Category: General
- Address: 0xD6A030
- Arg1: control
- Name: ctrlMapMouseOver
- Description: Returns description of map sign mouse cursor is over.
- Category: General
- Address: 0xD6A170
- Arg1: control
- Name: ctrlMapScale
- Description: Return the current scale of the map control.
- Category: General
- Address: 0xD6A0D0
- Arg1: control
- Name: ctrlModel
- Description: Returns model setted in given control.
- Category: General
- Address: 0xCA4BA0
- Example: ctrlModel ((FindDisplay 20000) displayCtrl 20001)
- Arg1: control
- Name: ctrlModelDirAndUp
- Description: Returns orientation setted in given control.
- Category: General
- Address: 0xCA4CA0
- Example: ctrlModelOrientation ((FindDisplay 20000) displayCtrl 20001)
- Arg1: control
- Name: ctrlModelScale
- Description: Returns scale setted in given control object
- Category: General
- Address: 0xCA4DE0
- Example: ctrlModelScale ((FindDisplay 20000) displayCtrl 20001)
- Arg1: control
- Name: ctrlParent
- Description: Returns container of given control.
- Category: General
- Address: 0xD62FD0
- Example: _display = ctrlParent _control
- Arg1: control
- Name: ctrlPosition
- Description: Returns the current position and size of control as [x, y, w, h] array.
- Category: General
- Address: 0xD62970
- Example: _pos = ctrlPosition _control
- Arg1: control
- Name: ctrlScale
- Description: Returns the current scale of control.
- Category: General
- Address: 0xD62C30
- Example: _scale = ctrlScale _control
- Arg1: control
- Name: ctrlSetFocus
- Description: Set the input focus on given control.
- Category: General
- Address: 0xD624A0
- Example: ctrlSetFocus _control
- Arg1: control
- Name: ctrlSetText
- Description: Sets the text that will be shown in the control with id idc of the topmost user dialog. This can be used for static texts, buttons, edit lines and active texts.
- Category: General
- Address: 0xC98170
- Example: ctrlSetText [100, "Hello, world"]
- Arg1: [idc, text]
- Name: ctrlShow
- Description: Shows / hides the control with id idc of the topmost user dialog.
- Category: General
- Address: 0xC982A0
- Example: ctrlShow [100, true]
- Arg1: [idc, show]
- Name: ctrlShown
- Description: Returns whether given control is shown.
- Category: General
- Address: 0xD62F10
- Example: _ok = ctrlShown _control
- Arg1: control
- Name: ctrlText
- Description: Returns the text shown in given control.
- Category: General
- Address: 0xD62CE0
- Example: _text = ctrlText _control
- Arg1: control
- Name: ctrlText
- Description: Returns the text shown in the control with id idc of the topmost user dialog. This can be used for static texts, buttons, edit lines and active texts.
- Category: General
- Address: 0xC97B80
- Example: _message = ctrlText 100
- Arg1: idc
- Name: ctrlTextHeight
- Description: Returns the text height.
- Category: General
- Address: 0xD66600
- Example: h = ctrlTextHeight _control
- Arg1: structuredText control
- Name: ctrlType
- Description: Returns value representing type of control.
- Category: General
- Address: 0xD65690
- Example: _type = ctrlType _control
- Arg1: control
- Name: ctrlVisible
- Description: Returns whether the control with id idc of the topmost user dialog is visible.
- Category: General
- Address: 0xC98350
- Example: _visible = ctrlVisible 100
- Arg1: idc
- Name: curatorAddons
- Description: Return list of addons allowed to given curator.
- Category: General
- Address: 0xCA4EF0
- Arg1: curatorObj
- Name: curatorCamera
- Description: Returns curator camera object.
- Category: General
- Address: 0xCA50A0
- Name: curatorCameraArea
- Description: Return all curator camera areas.
- Category: General
- Address: 0xC98440
- Arg1: curatorObj
- Name: curatorCameraAreaCeiling
- Description: Return ceiling height for curator camera.
- Category: General
- Address: 0xC983D0
- Arg1: curatorObj
- Name: curatorEditableObjects
- Description: Return all editable objects which belongs to a curator.
- Category: General
- Address: 0xCA5270
- Arg1: curatorObj
- Name: curatorEditingArea
- Description: Returns all curator editing areas
- Category: General
- Address: 0xC98680
- Arg1: curatorObj
- Name: curatorEditingAreaType
- Description: Returns type of edit areas assigned to curator (blacklist/whitelist).
- Category: General
- Address: 0xCA51F0
- Arg1: obj
- Name: curatorMouseOver
- Description: Returns curator mouse over object.
- Category: General
- Address: 0xCA5420
- Name: curatorPoints
- Description: Return number of points that curator have.
- Category: General
- Address: 0xCA56B0
- Arg1: curatorObj
- Name: curatorRegisteredObjects
- Description: Returns array with all objects that has curator registered and their settings.
- Category: General
- Address: 0xCA5720
- Arg1: curatorObj
- Name: curatorSelected
- Description: Returns list of all curator selected items.
- Category: General
- Address: 0xCA5C50
- Name: curatorWaypointCost
- Description: Return current price for placing waypoints (curator specific).
- Category: General
- Address: 0xCA6460
- Arg1: curatorObj
- Name: currentCommand
- Description: Return the current command type (empty string when no command).
- Category: General
- Address: 0xD6FFD0
- Arg1: vehicle
- Name: currentMagazine
- Description: Return the name of the type of the currently using magazine (on the primary turret for vehicles).
- Category: General
- Address: 0xD70060
- Arg1: vehicle
- Name: currentMagazineDetail
- Description: Return the name of the type of the currently using magazine (on the primary turret for vehicles).
- Category: General
- Address: 0xD70110
- Arg1: vehicle
- Name: currentMuzzle
- Description: Returns current muzzle of unit's weapon.
- Category: General
- Address: 0xC988C0
- Arg1: gunner
- Name: currentVisionMode
- Description: Returns vision mode of unit's weapon. 0-dayTime, 1-night vision, 2-FLIR
- Category: General
- Address: 0xC989B0
- Arg1: gunner
- Name: currentWaypoint
- Description: Return the index of the current waypoint.
- Category: General
- Address: 0xD74DB0
- Arg1: group
- Name: currentWeapon
- Description: Return the name of the currently selected weapon (on the primary turret for vehicles).
- Category: General
- Address: 0xD703D0
- Arg1: vehicle
- Name: currentWeaponMode
- Description: Returns current weapon mode of unit's weapon.
- Category: General
- Address: 0xC98A60
- Arg1: gunner
- Name: currentZeroing
- Description: Returns zeroing of unit's weapon.
- Category: General
- Address: 0xC98B80
- Arg1: gunner
- Name: cursorTarget
- Description: This is the entity pointed to by a players cursor.
- Category: General
- Address: 0xC98DB0
- Example: alive cursorTarget
- Name: cutObj
- Description: Object background - the argument uses format ["name","type",speed, showInMap] or ["name","type"]. If speed is not given, it's assumed to be one.
- The object can be defined in the description.ext file.
- Category: General
- Address: 0xC99080
- Example: cutObj ["TVSet", "plain"]
- Arg1: effect
- Name: cutRsc
- Description: Resource background - the argument uses format ["name","type",speed, showInMap] or ["name","type"]. If speed is not given, it's assumed to be one.
- The resource can be defined in the description.ext file.
- Category: General
- Address: 0xC993C0
- Example: cutRsc ["binocular", "PLAIN"]
- Arg1: effect
- Name: cutText
- Description: 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".
- Category: General
- Address: 0xC99540
- Example: cutText ["", "BLACK OUT"]
- Arg1: effect
- Name: damage
- Description: Returns the object damage in a range of 0 to 1. Note: this function is identical to <f>getDammage</f>.
- Category: General
- Address: 0xD32A30
- Example: damage player
- Arg1: object
- Name: date
- Description: Return the actual mission date and time as an array [year, month, day, hour, minute].
- Category: General
- Address: 0xCA6710
- Name: dateToNumber
- Description: Convert date to float number.
- Category: General
- Address: 0xC99840
- Example: time = DateToNumber [year,month,day,hour,minute]
- Arg1: date
- Name: dayTime
- Description: Returns the time in the world, in hours.
- Category: General
- Address: 0xC99A30
- Name: deActivateKey
- Description: 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.
- Category: General
- Address: 0xD1F020
- Example: deActivateKey "M04"
- Arg1: keyName
- Name: debriefingText
- Description: Return debriefing text.
- Category: General
- Address: 0xCA6860
- Arg1: end
- Name: debugLog
- Description: Dumps the argument's type and value to the debugging output.
- Category: General
- Address: 0xD55590
- Example: debugLog player
- Arg1: anything
- Name: deleteCenter
- Description: Destroys the AI center of the given side.
- Category: General
- Address: 0xC92D10
- Example: deleteCenter East
- Arg1: side
- Name: deleteCollection
- Description: same as hideObject.
- Category: General
- Address: 0xCB5C10
- Arg1: object
- Name: deleteGroup
- Description: Destroys the given AI group.
- Category: General
- Address: 0xCB2930
- Example: deleteGroup group
- Arg1: group
- Name: deleteIdentity
- Description: Deletes an identity created by saveIdentity from the campaign progress file.
- Category: General
- Address: 0xC99DC0
- Example: deleteIdentity "playerIdentity"
- Arg1: identityName
- Name: deleteMarker
- Description: Destroys the given marker. The marker is destroyed on all computers in a network session.
- Category: General
- Address: 0xD25C30
- Example: deleteMarker "Marker1"
- Arg1: name
- Name: deleteMarkerLocal
- Description: Destroys the given marker. The marker is only destroyed on the computer where the command is called.
- Category: General
- Address: 0xD25D60
- Example: deleteMarkerLocal "Marker1"
- Arg1: name
- Name: deleteSite
- Description: Removes the site.
- Category: General
- Address: 0xD584B0
- Example: deleteSite tank
- Arg1: site
- Name: deleteStatus
- Description: Deletes a status created by saveStatus from the campaign progress file.
- Category: General
- Address: 0xC9A180
- Example: deleteStatus "playerState"
- Arg1: statusName
- Name: deleteTeam
- Description: Destroy given team.
- Category: Agents
- Address: 0xD5D2D0
- Example: deleteTeam _team
- Arg1: team
- Name: deleteVehicle
- Description: Deletes any unit or vehicle. Only vehicles inserted in the editor or created during a mission can be deleted. The player unit cannot be deleted.
- Category: General
- Address: 0xD6F0B0
- Example: deleteVehicle tank
- Arg1: object
- Name: deleteWaypoint
- Description: Removes the waypoint.
- Category: General
- Address: 0xD74950
- Example: deleteWaypoint [grp, 2]
- Arg1: waypoint
- Name: detach
- Description: Detaches an object.
- Category: General
- Address: 0xD2F6D0
- Example: detach player
- Arg1: obj
- Name: detectedMines
- Description: Returns list af all mines detected by given side.
- Category: General
- Address: 0xCA69B0
- Example: detectedMines (side player)
- Arg1: side
- Name: diag_fps
- Description: Returns average framerate over last 16 frames.
- Category: General
- Address: 0xC9AB40
- Name: diag_fpsmin
- Description: Returns minimal framerate. Calculated from the longest frame over last 16 frames.
- Category: General
- Address: 0xC9AB70
- Name: diag_frameno
- Description: Returns number of frame currently displayed .
- Category: General
- Address: 0xC9ABC0
- Name: diag_log
- Description: Dumps the argument's type and value to the report file.
- Category: General
- Address: 0xC9ABE0
- Example: diag_log player
- Arg1: anything
- Name: diag_tickTime
- Description: Real time spent from the start of the game.
- Category: General
- Address: 0xC9AC40
- Name: dialog
- Description: Returns whether a user dialog is present.
- Category: General
- Address: 0xCB6AC0
- Name: difficulty
- Description: Return difficulty.
- Category: General
- Address: 0xCA6AA0
- Example: difficulty
- Name: difficultyEnabled
- Description: Check if given difficulty setting is currently enabled. For possible values of flag, see config class Flags in CfgDificulties.
- Category: General
- Address: 0xCB6AE0
- Arg1: flag
- Name: difficultyEnabledRTD
- Description: Returns true if rotorlib simulation is enabled. Forcing by mission is included.
- Category: General
- Address: 0xCB8800
- Name: direction
- Description: Returns the object heading in the range of 0 to 360.
- Category: General
- Address: 0xD32C70
- Example: direction player
- Arg1: object
- Name: disableDebriefingStats
- Description: Disable debriefing score table.
- Category: General
- Address: 0xC9AE90
- Example: disableDebriefingStats
- Name: disableUserInput
- Description: Disables all user input. This is normally used only in cutscenes to disable the player's controls.
- Category: General
- Address: 0xC9AF80
- Arg1: disable
- Name: displayNull
- Description: A non-existing display. This value is not equal to anything, including itself.
- Category: General
- Address: 0xD66050
- Name: dissolveTeam
- Description: Dissolves the given team. All members become members of the main team. Possible team values are: "RED", "GREEN", "BLUE" or "YELLOW".
- Category: General
- Address: 0xD5D340
- Example: dissolveTeam "RED"
- Arg1: team
- Name: distributionRegion
- Description: Return the region where the game was sold (based on distribution id).
- Category: General
- Address: 0xCA6B00
- Name: doGetOut
- Description: Orders a unit to get out from the vehicle (silently).
- Category: General
- Address: 0xD6F220
- Example: doGetOut unitOne
- Arg1: unit
- Name: doStop
- Description: Orders the unit to stop (silently).
- Note: the stop command is never finished; the unit will never be ready.
- Category: General
- Address: 0xD6F260
- Example: doStop unitOne
- Arg1: unit
- Name: drawIcon3D
- Description: Draws an ingame icon at a given position.
- Category: General
- Address: 0xD76D80
- Example: 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"]
- Arg1: [texture, color, position, width, height, angle, text, shadow, textSize, font]
- Name: drawLine3D
- Description: Draws a line of a given COLOR from START to END.
- Category: General
- Address: 0xD76E30
- Example: drawLine3D [position soldier, position cursorTarget, [1,1,1,1]]
- Arg1: [start, end, color]
- Name: driver
- Description: Returns the driver of the vehicle. If the vehicle is not a vehicle, but a person, the person is returned instead.
- Category: General
- Address: 0xD2FBC0
- Example: driver vehicle player
- Arg1: vehicle
- Name: drop
- Description: Drops a particle into the scene. Array is in format <ar>ParticleArray</ar>.
- Category: General
- Address: 0x99CCF0
- Arg1: array
- Name: east
- Description: The East side.
- Category: General
- Address: 0xD578B0
- Name: effectiveCommander
- Description: Returns the effective commander (who really commands) of the vehicle.
- Category: General
- Address: 0xD2FC40
- Arg1: vehicle
- Name: enableCamShake
- Description: Enables/disables camera shakes.
- Category: General
- Address: 0xC9B900
- Arg1: true/false
- Name: enableCaustics
- Description: Enable/disable caustics drawing.
- Category: General
- Address: 0xC9B960
- Arg1: enable
- Name: enableDebriefingStats
- Description: Enable debriefing score table. The table will be displayed at specified coordinates.
- Category: General
- Address: 0xC9BA40
- Example: enableDebriefingStats [0.1, 0.1, 0.8, 0.8]
- Arg1: [left, top, width, height]
- Name: enableDiagLegend
- Description: Enable or disable legend for diagnostic
- Category: General
- Address: 0xC9BB30
- Example: enableDiagLegend false
- Arg1: true/false
- Name: enableEndDialog
- Description: Enables the dialog buttons to be shown during the OnPlayerKilled script.
- Category: General
- Address: 0xC9BBA0
- Name: enableEngineArtillery
- Description: Enables/disables engine's artillery.
- Category: General
- Address: 0xC9B840
- Arg1: true/false
- Name: enableEnvironment
- Description: Enable/disable environmental effects (ambient life + sound).
- Category: General
- Address: 0xC9BBC0
- Example: enableEnvironment false
- Arg1: enabled
- Name: enableRadio
- Description: Enables radio transmissions to be heard and seen on screen.
- Category: General
- Address: 0xC9BBF0
- Arg1: enable
- Name: enableSatNormalOnDetail
- Description: Enables/disables satellite normal map od detail maps.
- Category: General
- Address: 0xC9BD20
- Arg1: true/false
- Name: enableSaving
- Description: Enable / disable saving of the game. When disabled, the autosave is created (if not forbidden by save == false).
- Category: General
- Address: 0xC9BD90
- Arg1: enable or [enable, save]
- Name: enableSentences
- Description: Enables radio transmissions to be heard and seen on screen. It does not affect KBTell conversations.
- Category: General
- Address: 0xC9BEB0
- Arg1: enable
- Name: enableStressDamage
- Description: Enable stress damage.
- Category: General
- Address: 0xC9BEF0
- Arg1: enable
- Name: enableTeamSwitch
- Description: Enable / disable team switch.
- Category: General
- Address: 0xD5EF20
- Arg1: enable
- Name: enableTraffic
- Description: Enable ambient traffic.
- Category: General
- Address: 0xD55590
- Arg1: enable
- Name: endLoadingScreen
- Description: Finish loading screen displaying (started by startLoadingScreen).
- Category: General
- Address: 0xD24170
- Name: endMission
- Description: Finish the mission. The end type can be "CONTINUE", "KILLED", "LOSER", "END1", "END2", "END3", "END4", "END5", or "END6".
- Category: General
- Address: 0xD28590
- Arg1: end type
- Name: enginesIsOnRTD
- Description: Returns which engines are producing some work.
- Category: General
- Address: 0xCA75B0
- Arg1: RTD_helicopter
- Name: enginesPowerRTD
- Description: Power produced by engines in Watts.
- Category: General
- Address: 0xCA7790
- Arg1: RTD_Helicopter
- Name: enginesRpmRTD
- Description: Returns all engines RPM.
- Category: General
- Address: 0xCA7960
- Arg1: RTD_helicopter
- Name: enginesTorqueRTD
- Description: Torque produced by engines in Newton*meter.
- Category: General
- Address: 0xCA7B40
- Arg1: RTD_Helicopter
- Name: entities
- Description: Returns a list of entities with given type.
- Category: General
- Address: 0xCA7D10
- Example: entities "Car"
- Arg1: type
- Name: estimatedEndServerTime
- Description: Estimated end of MP game converted to serverTime.
- Category: General
- Address: 0xCA7E60
- Name: estimatedTimeLeft
- Description: Returns the estimated time left in the game. Using this function the designer can provide a "time left" estimate that is shown in the "Game in progress" screen or in the master browser. For missions with a hard set limit adjusted via Param1, the following example can be used in the init.sqs file.
- Category: General
- Address: 0xC9C1B0
- Example: estimatedTimeLeft Param1
- Arg1: timeLeft
- Name: everyBackpack
- Description: Returns array of backpacks stored in given crate .e.g. used for accessing backpack content of a backpack on ground.
- Category: General
- Address: 0xD32D90
- Example: everyBackpack cursorTarget
- Arg1: box
- Name: everyContainer
- Description: 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.
- Category: General
- Address: 0xD32F30
- Example: everyContainer cursorTarget
- Arg1: box
- Name: execFSM
- Description: Execute the scripted FSM. The FSM file is first searched in the mission folder, then in the campaign scripts folder and finally in the global scripts folder. Return the FSM handler or 0 when failed.
- Category: General
- Address: 0xC9C720
- Example: execFSM "test.fsm"
- Arg1: filename
- Name: execVM
- Description: Compile and execute function (sqf). The function is first searched in the mission folder, then in the campaign scripts folder and finally in the global scripts folder.
- Category: General
- Address: 0xD6D9D0
- Example: execVM "test.sqf"
- Arg1: filename
- Name: exit
- Description: Exits the script.
- Category: General
- Address: 0xB9CC10
- Name: expectedDestination
- Description: Return expected destination of unit as a [position, planningMode, forceReplan].
- Category: General
- Address: 0xD70580
- Arg1: person
- Name: eyeDirection
- Description: Returns the direction object is watching (eyes, or a vehicle primary observer).
- Category: General
- Address: 0xD32B30
- Example: eyeDirection player
- Arg1: unit
- Name: eyePos
- Description: Returns the position of the object eye in format <ar>PositionASL</ar>.
- Category: General
- Address: 0xD35850
- Example: eyePos player
- Arg1: obj
- Name: face
- Description: Returns the face from identity of given object.
- Category: General
- Address: 0xD30250
- Example: face player
- Arg1: object
- Name: faction
- Description: Gets unit faction. If faction is not defined, returns empty string.
- Category: General
- Address: 0xCA7F40
- Arg1: unit
- Name: factor
- Description: Extend expression
- Category: Simple expression
- Address: 0x12388B0
- Arg1: expr
- Arg2: val
- Name: factor
- Description: Extend expression
- Category: Simple expression
- Address: 0x12388B0
- Arg1: expr
- Arg2: val
- Name: failMission
- Description: Finish the mission. The end type can be "CONTINUE", "KILLED", "LOSER", "END1", "END2", "END3", "END4", "END5", or "END6". Mission saves will not be deleted.
- Category: General
- Address: 0xC9CB70
- Arg1: end type
- Name: fillWeaponsFromPool
- Description: Adds magazines from the campaign pool to the person (depending on the weapons the person has).
- Category: General
- Address: 0xD44840
- Example: fillWeaponsFromPool victor
- Arg1: person
- Name: findDisplay
- Description: Find display by its IDD.
- Category: General
- Address: 0xD664F0
- Example: _display = findDisplay 1
- Arg1: idd
- Name: finishMissionInit
- Description: Finish world initialization before mission is launched.
- Category: General
- Address: 0xD28670
- Name: firstBackpack
- Description: Returns object of the first stored backpack in another weaponholder.e.g. used for accessing backpack content of a backpack on ground.
- Category: General
- Address: 0xD33570
- Example: firstBackpack cursorTarget
- Arg1: box
- Name: flag
- Description: If the unit has a flag, this flag is returned.
- If not, objNull is returned.
- Category: General
- Address: 0xD33640
- Example: flag player
- Arg1: unit
- Name: flagOwner
- Description: When used on a flag, the returned value is the person that has this flag.
- When used on anything else, objNull is returned.
- Category: General
- Address: 0xD336C0
- Example: flagowner flagOne
- Arg1: flag
- Name: fleeing
- Description: Checks whether the unit is fleeing. A dead or empty unit returns false.
- Category: General
- Address: 0xD305B0
- Example: fleeing player
- Arg1: unit
- Name: fog
- Description: Return the current fog.
- Category: General
- Address: 0xCA81B0
- Name: fogForecast
- Description: Return the fog forecast.
- Category: General
- Address: 0xCA81E0
- Name: fogParams
- Description: Returns actual params for fog.
- Category: General
- Address: 0xCA8210
- Name: forceAtPositionRTD
- Description: Add force generator to world. Returns force index.
- Category: General
- Address: 0xC9E640
- Arg1: position
- Name: forceEnd
- Description: Forces the mission to terminate.
- Category: General
- Address: 0xC9EA50
- Name: forceGeneratorRTD
- Description: Add force generator to world. Returns force index.
- Category: General
- Address: 0xCA83C0
- Arg1: index
- Name: forceMap
- Description: Forces the map to display.
- Category: General
- Address: 0xD25170
- Example: forceMap true
- Arg1: show
- Name: forceRespawn
- Description: Force respawns given unit (stays old "killed" body). Will not count score
- Category: General
- Address: 0xC9EA70
- Arg1: targetUnit
- Name: forceWeatherChange
- Description: Forces saved wanted settings for weather to be actual. (BEWARE: Will cause lag)
- Category: General
- Address: 0xC9EFF0
- Name: format
- Description: The first argument of the array is in format string. This string may contain references to the following arguments using format %1, %2, etc. Each %x is replaced by the corresponding argument. %x may appear in the string in any order.
- Category: General
- Address: 0xD59200
- Example: format ["%1 - %2 - %1", 1, "text"]
- Ex. Returns: "1 - text - 1"
- Arg1: format
- Name: formation
- Description: Return a formation of given team.
- Category: Agents
- Address: 0xD5D900
- Example: _formation = formation _team
- Arg1: team
- Name: formation
- Description: Returns the formation of the group ("COLUMN", "STAG COLUMN", "WEDGE", "ECH LEFT", "ECH RIGHT", "VEE" or "LINE").
- Category: General
- Address: 0xCB30F0
- Example: formation group player
- Arg1: grp
- Name: formationDirection
- Description: Return the direction unit watching in formation.
- Category: General
- Address: 0xD33740
- Arg1: person
- Name: formationLeader
- Description: Return leader of the formation.
- Category: General
- Address: 0xD70830
- Arg1: person
- Name: formationMembers
- Description: Return list of units (drivers) in the formation.
- Category: General
- Address: 0xD70900
- Arg1: person
- Name: formationPosition
- Description: Return position of unit in the formation.
- Category: General
- Address: 0xD70AA0
- Arg1: person
- Name: formationTask
- Description: Return the current task of the unit in the formation.
- Category: General
- Address: 0xD70BF0
- Arg1: person
- Name: formatText
- Description: Creates a structured text by replacing %1, %2, etc. in format by plain or structured texts given as arguments.
- Category: General
- Address: 0xD60C90
- Example: txt = formatText ["Image: %1", image "data\isniper.paa"]
- Arg1: [format, arg1, arg2, ...]
- Name: formLeader
- Description: Returns the formation leader for the given unit. For dead units objNull is returned. The result is often the same as groupLeader, but not always.
- Category: General
- Address: 0xD39120
- Example: formLeader player != leader player
- Arg1: unit
- Name: freeLook
- Description: Returns true if freelook is active.
- Category: General
- Address: 0xCA8980
- Name: fromEditor
- Description: Return if given team was inserted directly from mission editor.
- Category: Agents
- Address: 0xD5E120
- Example: _fromEditor = fromEditor _member
- Arg1: teamMember
- Name: fuel
- Description: Checks how much fuel is left in the gas tank, in the range from 0 to 1.
- Category: General
- Address: 0xD30650
- Example: fuel vehicle player
- Arg1: vehicle
- Name: fullCrew
- Description: Returns array with all crew inside given vehicle
- Category: General
- Address: 0xCA0E50
- Example: fullCrew vehicle player
- Arg1: vehicle
- Name: fullCrew
- Description: Returns array with all crew of given type inside given vehicle
- Category: General
- Address: 0xCA0F10
- Example: fullCrew [vehicle player, "turret"]
- Arg1: [vehicle, type]
- Name: gearIDCAmmoCount
- Description: Returns ammo count of assigned magazine.
- Category: General
- Address: 0xCB5ED0
- Example: ammo = gearSlotAmmoCount IDC
- Arg1: control IDC
- Name: gearSlotAmmoCount
- Description: Returns ammo count of assigned magazine.
- Category: General
- Address: 0xD61CF0
- Example: ammo = gearSlotAmmoCount _control
- Arg1: control
- Name: gearSlotData
- Description: Returns gear slot item name.
- Category: General
- Address: 0xD61DA0
- Example: weapon = gearSlotData _control
- Arg1: control
- Name: getAmmoCargo
- Description: Returns the amount of ammo resources in the cargo space of a repair vehicle.
- Category: General
- Address: 0xD31030
- Example: getAmmoCargo vehicle
- Arg1: vehicle
- Name: getArray
- Description: Extract array from config entry.
- Category: General
- Address: 0xC93B90
- Example: _array = getArray (configFile >> "CfgVehicles" >> "Thing" >> "threat")
- Arg1: config
- Name: getArtilleryAmmo
- Description: Get list of all available magazines of artillery units in the list.
- Category: General
- Address: 0xCA2A80
- Arg1: [unitlist]
- Name: getArtilleryComputerSettings
- Description: Returns settings from artillery computer currently opened by player.
- Category: General
- Address: 0xCA2E30
- Name: getAssignedCuratorLogic
- Description: Returns curator logic to which has given player access.
- Category: General
- Address: 0xCA3360
- Arg1: player
- Name: getAssignedCuratorUnit
- Description: Returns unit assigned to curator logic.
- Category: General
- Address: 0xCA32F0
- Arg1: curatorObj
- Name: getBackpackCargo
- Description: Returns all backpacks names and count from ammo box (or any general weapon holder container).
- Category: General
- Address: 0xD31500
- Example: getBackpackCargo jeepOne
- Arg1: box
- Name: getBleedingRemaining
- Description: Return reamining time of bleeding.
- Category: General
- Address: 0xD31950
- Arg1: unit
- Name: getBurningValue
- Description: Return amount of damage from fire.
- Category: General
- Address: 0xD324A0
- Arg1: unit
- Name: getCenterOfMass
- Description: Returns center of mass of an object
- Category: General
- Address: 0xD328A0
- Example: com = getCenterOfMass myEntity
- Arg1: object
- Name: getClientState
- Description: Return client state in network game
- Category: General
- Address: 0xCA3760
- Name: getConnectedUAV
- Description: Returns UAV if unit has connection to some UAV.
- Category: General
- Address: 0xCA4750
- Example: getConnectedUAV player
- Arg1: Unit
- Name: getDammage
- Description: Returns the object damage in the range from 0 to 1.
- Category: General
- Address: 0xD32A50
- Example: getDammage player
- Arg1: obj
- Name: getDescription
- Description: Returns the string representation of unit as an four slots array ([unit,uniform,vest,backpack])
- Category: General
- Address: 0xD77700
- Example: getDescription player
- Arg1: unit
- Name: getDir
- Description: Returns the object heading in the range from 0 to 360.
- Category: General
- Address: 0xD32C70
- Example: getDir player
- Arg1: obj
- Name: getDirVisual
- Description: Returns the object heading in the range from 0 to 360.
- Category: General
- Address: 0xD32CE0
- Example: getDir player
- Arg1: obj
- Name: getDLCAssetsUsage
- Description: Returns an array of the DLC usage times. Returned array contain DLC item in this format: [[name, dlcAppId, sessionTime, totalTime], [name, dlcAppId, sessionTime, totalTime], ...]
- Category: General
- Address: 0xCA6C40
- Name: getDLCAssetsUsageByName
- Description: Returns an array with the session and global time the asset has been used.
- Category: General
- Address: 0xCA6CD0
- Arg1: assetName
- Name: getDLCs
- Description: Returns list of appIds of game DLCs. Use filter param to get only certain DLCs: 0:all, 1:owned, 2:not owned
- Category: General
- Address: 0xCA6F90
- Arg1: filter
- Name: getDLCUsageTime
- Description: Returns total time the assets of the given DLC has been used.
- Category: General
- Address: 0xCA6EF0
- Arg1: appId
- Name: getElevationOffset
- Description: Returns the map elevation offset from [map]/config.cpp
- Category: General
- Address: 0xCA73A0
- Name: getEngineTargetRPMRTD
- Description: Returns target rpm of all engines.
- Category: General
- Address: 0xCA73E0
- Arg1: RTD_helicopter
- Name: getFatigue
- Description: Returns fatigue of given unit.
- Category: General
- Address: 0xD333D0
- Arg1: unit
- Name: getFieldManualStartPage
- Description: Returns array of the starting topic and hint the given field manual should display
- Category: General
- Address: 0xD66270
- Arg1: display
- Name: getFuelCargo
- Description: Returns the fuel amount in the cargo space of a refuelling vehicle.
- Category: General
- Address: 0xD33810
- Example: getFuelCargo vehicle
- Arg1: vehicle
- Name: getGroupIconParams
- Description: Returns group icons params. [color, text,scale, visible]
- Category: General
- Address: 0xCA8E00
- Example: getGroupIconParams group
- Arg1: group
- Name: getGroupIcons
- Description: Returns all group icons.[[id,icon,[offsetx,offsety],[..],..]
- Category: General
- Address: 0xCA9030
- Example: getGroupIcons group
- Arg1: group
- Name: getItemCargo
- Description: Returns all items names and count from ammo box (or any general weapon holder container).
- Category: General
- Address: 0xD33DB0
- Example: getItemCargo jeepOne
- Arg1: box
- Name: getMagazineCargo
- Description: Returns all magazines names and count from ammo box (or any general weapon holder container).
- Category: General
- Address: 0xD34340
- Example: getMagazineCargo jeepOne
- Arg1: box
- Name: getMarkerColor
- Description: Gets the marker color. See <f>setMarkerColor</f>.
- Category: General
- Address: 0xD26050
- Example: getMarkerColor "MarkerOne"
- Arg1: marker
- Name: getMarkerPos
- Description: Returns the marker positon in format [x,z,y].
- Category: General
- Address: 0xD26230
- Example: getMarkerPos "markerOne"
- Arg1: markerName
- Name: getMarkerSize
- Description: Gets the marker size. See <f>setMarkerSize</f>.
- Category: General
- Address: 0xD264A0
- Example: getMarkerSize "MarkerOne"
- Arg1: marker
- Name: getMarkerType
- Description: Gets the type of the marker. See <f>setMarkerType</f>.
- Category: General
- Address: 0xD266E0
- Example: getMarkerType "MarkerOne"
- Arg1: marker
- Name: getMass
- Description: Returns mass of an object
- Category: General
- Address: 0xD346D0
- Example: mass = getMass myEntity
- Arg1: object
- Name: getMissionDlcs
- Description: 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!
- Category: General
- Address: 0xCAAA50
- Example: list of DLCs detected for the mission
- Name: getNumber
- Description: Extract number from config entry.
- Category: General
- Address: 0xC94200
- Example: _array = getNumber (configFile >> "CfgVehicles" >> "Thing" >> "maxSpeed")
- Arg1: config
- Name: getObjectDLC
- Description: Returns an appId the object belongs to. The information is taken from it's model.
- Category: General
- Address: 0xCAD230
- Example: getObjectDLC cursorTarget
- Arg1: Object
- Name: getOxygenRemaining
- Description: Return amount of remaining oxygen.
- Category: General
- Address: 0xD35300
- Arg1: unit
- Name: getPersonUsedDLCs
- Description: Returns list of all DLCs (appIds, both owned or not) the person is currently using.
- Category: General
- Address: 0xCAD350
- Example: getPersonUsedDLCs player
- Arg1: Person
- Name: getPlayerUID
- Description: Get unique player id.
- Category: General
- Address: 0xCAD7A0
- Arg1: unit
- Name: getPos
- Description: Returns the object position in format <ar>Position</ar>.
- Category: General
- Address: 0xD35380
- Example: getPos player
- Arg1: obj
- Name: getPosASL
- Description: Returns the object position in format <ar>PositionASL</ar>.
- Category: General
- Address: 0xD35470
- Example: getPosASL player
- Arg1: obj
- Name: getPosASLVisual
- Description: Returns the object rendered position in format <ar>PositionASL</ar>.
- Category: General
- Address: 0xD36D90
- Example: visiblePositionASL player
- Arg1: object
- Name: getPosASLW
- Description: Returns the object position in format <ar>PositionASLW</ar>.
- Category: General
- Address: 0xD355C0
- Example: getPosASLW player
- Arg1: obj
- Name: getPosATL
- Description: Returns the object position in format <ar>PositionATL</ar>.
- Category: General
- Address: 0xD35720
- Example: getPosATL player
- Arg1: obj
- Name: getPosATLVisual
- Description: Returns the object position in format <ar>PositionATL</ar>.
- Category: General
- Address: 0xD35740
- Example: getPosATL player
- Arg1: obj
- Name: getPosVisual
- Description: Returns the object rendered position in format <ar>Position</ar>.
- Category: General
- Address: 0xD36C70
- Example: visiblePosition player
- Arg1: object
- Name: getPosWorld
- Description: Returns the object position in format <ar>PositionWorld</ar>.
- Category: General
- Address: 0xD35AC0
- Example: getPosWorld player
- Arg1: obj
- Name: getRepairCargo
- Description: Returns the amount or repair resources in the cargo space of a repair vehicle.
- Category: General
- Address: 0xD35CC0
- Example: getRepairCargo vehicle
- Arg1: vehicle
- Name: getResolution
- Description: returns [width, height, 2D viewport Width, 2D viewport Height, aspect ration, UI scale]
- Category: General
- Address: 0xCADDD0
- Name: getRotorBrakeRTD
- Description: Returns if rotorbrake is on.
- Category: General
- Address: 0xCAE050
- Arg1: RTD_helicopter
- Name: getShadowDistance
- Description: Get the shadows rendering distance.
- Category: General
- Address: 0xCAA910
- Example: _dist = getShadowDistance
- Name: getSlingLoad
- Description: Return object which is sling loaded by vehicle
- Category: General
- Address: 0xCAE820
- Example: getSlingLoad veh
- Arg1: vehicle
- Name: getStatValue
- Description: Returns value of the given stat.
- Category: General
- Address: 0xCAEFF0
- Arg1: statName
- Name: getTerrainHeightASL
- Description: Returns terrain height above sea level.
- Category: General
- Address: 0xCAF6A0
- Example: z = getTerrainHeightASL [x,y]
- Arg1: [x,y]
- Name: getText
- Description: Extract text from config entry.
- Category: General
- Address: 0xC94470
- Example: _array = getText (configFile >> "CfgVehicles" >> "Thing" >> "icon")
- Arg1: config
- Name: getTotalDLCUsageTime
- Description: Returns total DLC usage time in this game session
- Category: General
- Address: 0xCAFFB0
- Name: getTrimOffsetRTD
- Description: Returns controls trim offset.
- Category: General
- Address: 0xCB0010
- Arg1: RTD_helicopter
- Name: getWeaponCargo
- Description: Returns all weapons names and count from ammo box (or any general weapon holder container).
- Category: General
- Address: 0xD371B0
- Example: getWeaponCargo jeepOne
- Arg1: box
- Name: getWingsOrientationRTD
- Description: Returns orientation of horizontaol stabilizers.
- Category: General
- Address: 0xCB1E10
- Arg1: RTD_helicopter
- Name: getWingsPositionRTD
- Description: Returns position of stabilizers.
- Category: General
- Address: 0xCB21E0
- Arg1: RTD_helicopter
- Name: getWPPos
- Description: Gets the waypoint position. The format of waypoint is <ar>Waypoint</ar>.
- Category: General
- Address: 0xD771E0
- Example: getWPPos [groupOne, 1]
- Arg1: waypoint
- Name: goggles
- Description: Returns name of currently used goggles.
- Category: General
- Address: 0xD37F20
- Arg1: unit
- Name: goto
- Description: Only in scripts: go to given label. Note: the string argument is used here. Be sure to use double quotes around the label name in goto.
- Category: General
- Address: 0xB9CC30
- Example: goto "Loop"
- Arg1: label
- Name: group
- Description: Returns the group to which the given unit is assigned. For dead units, grpNull is returned.
- Category: General
- Address: 0xD37F50
- Example: group player == group leader player
- Arg1: obj
- Name: groupFromNetId
- Description: Get group with given unique ID.
- Category: General
- Address: 0xCA9290
- Example: groupFromNetId (netId group player)
- Ex. Returns: group player
- Arg1: id
- Name: groupIconSelectable
- Description: Return if groups icon raises onClick and onOver events.
- Category: General
- Address: 0xCB8020
- Name: groupIconsVisible
- Description: Return group icons are visible.
- Category: General
- Address: 0xCB8040
- Name: groupID
- Description: Returns group name.
- Category: General
- Address: 0xCB3190
- Example: name = groupID (group player)
- Arg1: group
- Name: groupSelectedUnits
- Description: Returns selected groups in sgroup.
- Category: General
- Address: 0xCB2BE0
- Example: array = groupSelectedUnits unit
- Arg1: unit
- Name: grpNull
- Description: A non-existing group. This value is not equal to anything, including itself.
- Category: General
- Address: 0xCB3A10
- Example: group player == objNull
- Ex. Returns: false
- Name: gunner
- Description: Returns the gunner of the vehicle. If the vehicle is not a vehicle, but a person, the person is returned.
- Category: General
- Address: 0xD38180
- Example: gunner vehicle player
- Arg1: vehicle
- Name: gusts
- Description: Return the current gusts value.
- Category: General
- Address: 0xCA9350
- Name: handgunItems
- Description: Get array with all items assigned to a weapon.
- Category: General
- Address: 0xD38230
- Arg1: unit
- Name: handgunMagazine
- Description: Return the names of the types of currently loaded magazines in given weapon.
- Category: General
- Address: 0xD70C60
- Arg1: vehicle
- Name: handgunWeapon
- Description: Returns the name of a units's handgun (an empty string if there is none).
- Category: General
- Address: 0xD33980
- Example: handgunWeapon player
- Arg1: unit
- Name: handsHit
- Description: Checks whether the soldier's hands are hit (causing inaccurate aiming).
- Category: General
- Address: 0xD38250
- Example: handsHit leader player
- Arg1: soldier
- Name: hasInterface
- Description: Returns true if the computer has an inteface (a real player). False for a dedicated server or for a headless client.
- Category: General
- Address: 0xCB5BD0
- Name: hcAllGroups
- Description: Returns selected groups in high command.
- Category: General
- Address: 0xCB50F0
- Example: array = hcAllGroups unit
- Arg1: unit
- Name: hcLeader
- Description: Returns group's HC commander.
- Category: General
- Address: 0xCB5530
- Example: hcLeader group
- Arg1: group
- Name: hcRemoveAllGroups
- Description: Remove all groups from unit's high command bar.
- Category: General
- Address: 0xCB5320
- Example: hcRemoveAllGroups unit
- Arg1: unit
- Name: hcSelected
- Description: Returns selected groups in high command.
- Category: General
- Address: 0xCB58D0
- Example: array = hcSelected unit
- Arg1: unit
- Name: hcShowBar
- Description: Shows or hides HC bar. There must be some groups under hc command to show hc bar.
- Category: General
- Address: 0xCB5B30
- Example: hcShowBar true
- Arg1: bool
- Name: hcShownBar
- Description: Return true if the HC bar is shown/active.
- Category: General
- Address: 0xCB80B0
- Name: headgear
- Description: Returns name of currently used headgear.
- Category: General
- Address: 0xD38420
- Arg1: unit
- Name: hideBody
- Description: Hides the body of the given person.
- Category: General
- Address: 0xD38450
- Example: hideBody player
- Arg1: person
- Name: hideObject
- Description: Hide object (cannot hide static objects).
- Category: General
- Address: 0xCB5C10
- Arg1: object
- Name: hideObjectGlobal
- Description: Hide object globally (cannot hide static objects). Only from server
- Category: General
- Address: 0xCB5CB0
- Arg1: object
- Name: hint
- Description: Shows a text hint. The text can contain several lines. \n is used to indicate the end of a line.
- Category: General
- Address: 0xD56860
- Example: hint "Press W to move forward"
- Arg1: text
- Name: hintC
- Description: Shows a text hint. The text can contain several lines. \n is used to indicate the end of a line. This hint has to be confirmed.
- Category: General
- Address: 0xD56C30
- Example: hintC "Press W to move forward"
- Arg1: text
- Name: hintCadet
- Description: Shows a text hint only when using cadet mode. The text can contain several lines. \n is used to indicate the end of a line.
- Category: General
- Address: 0xD56C70
- Example: hintCadet "Press W to move forward"
- Arg1: text
- Name: hintSilent
- Description: Same as <f>hint</f>, but without a sound.
- Category: General
- Address: 0xD56DA0
- Arg1: text
- Name: hmd
- Description: Returns name of currently used HMD.
- Category: General
- Address: 0xD38200
- Arg1: unit
- Name: hostMission
- Description: Host the MP mission described by config class. Should be called as a reaction to some UI action in some dialog.
- Category: General
- Address: 0xCB5DF0
- Arg1: [Config,Display]
- Name: HUDMovementLevels
- Description: Returns movement borders for HUD [min speed, max speed, min alt, max alt, min dir, max dir, position[x,y,z] or target]
- Category: General
- Address: 0xCA9390
- Name: humidity
- Description: Return the current humidity value.
- Category: General
- Address: 0xCA9990
- Name: image
- Description: Creates a structured text containing the given image.
- Category: General
- Address: 0xD60F80
- Example: txt1 = image "data\isniper.paa"
- Arg1: filename
- Name: incapacitatedState
- Description: Returns the incapacitated state of the given unit.
- Category: General
- Address: 0xD33D00
- Arg1: unit
- Name: independent
- Description: Pre-defined variable for the independent side.
- Category: General
- Address: 0xD57790
- Name: inflamed
- Description: Check if fireplace is inflamed (buring).
- Category: General
- Address: 0xD385F0
- Example: inflamed fireplaceOne
- Arg1: fireplace
- Name: inGameUISetEventHandler
- Description: Sets given event handler of in-game UI.
- Category: General
- Address: 0xCB5FB0
- Arg1: [handler name, function]
- Name: inheritsFrom
- Description: Returns base entry of config entry.
- Category: General
- Address: 0xC93C40
- Example: _base = inheritsFrom (configFile >> "CfgVehicles" >> "Car")
- Arg1: config
- Name: initAmbientLife
- Description: Initialize the ambient life.
- Category: General
- Address: 0xC90590
- Name: inputAction
- Description: Return the state of input devices mapped to given input action (see CfgDefaultKeysMapping for action names).
- Category: General
- Address: 0xCA9EB0
- Arg1: name
- Name: interpolate
- Description: Extend expression
- Category: Simple expression
- Address: 0x1238D80
- Arg1: expr
- Arg2: val
- Name: interpolate
- Description: Extend expression
- Category: Simple expression
- Address: 0x1238D80
- Arg1: expr
- Arg2: val
- Name: isAbleToBreathe
- Description: Return whether the unit is diving.
- Category: General
- Address: 0xD38640
- Arg1: unit
- Name: isAgent
- Description: Check if team member is an agent.
- Category: Agents
- Address: 0xD5E9B0
- Arg1: teamMember
- Name: isArray
- Description: Check if config entry represents array.
- Category: General
- Address: 0xC94510
- Example: _ok = isArray (configFile >> "CfgVehicles")
- Ex. Returns: false
- Arg1: config
- Name: isAutoHoverOn
- Description: Returns true if vehicle has enabled auto hover
- Category: General
- Address: 0xCB67A0
- Arg1: vehicle
- Name: isAutonomous
- Description: Return true if UAV is in autonomous mode.
- Category: General
- Address: 0xCB68A0
- Example: uavAuto = isAutonomous uav
- Arg1: Uav
- Name: isAutoStartUpEnabledRTD
- Description: Returns true if automatic start up action is enabled.
- Category: General
- Address: 0xCB6800
- Arg1: RTD_helicopter
- Name: isAutotest
- Description: Returns true if game was started with autotest parameter
- Category: General
- Address: 0xCB6900
- Example: isAutotest
- Name: isAutoTrimOnRTD
- Description: Returns true if autotrim is enabled.
- Category: General
- Address: 0xCB6850
- Arg1: RTD_helicopter
- Name: isBleeding
- Description: Return whether the unit is bleeding.
- Category: General
- Address: 0xD386A0
- Arg1: unit
- Name: isBurning
- Description: Return whether the unit is burning.
- Category: General
- Address: 0xD386F0
- Arg1: unit
- Name: isClass
- Description: Check if config entry represents config class.
- Category: General
- Address: 0xC94580
- Example: _ok = isClass (configFile >> "CfgVehicles")
- Ex. Returns: true
- Arg1: config
- Name: isCollisionLightOn
- Description: Checks whether the collision light is on.(non-vehicle param returns false)
- Category: General
- Address: 0xD71520
- Example: on = isLightOn vehicle player
- Arg1: vehicle
- Name: isCopilotEnabled
- Description: Returns true if copilots actions are enabled.
- Category: General
- Address: 0xCB6A00
- Example: enabled = isCopilotEnabled (vehicle player)
- Arg1: vehicle
- Name: isDedicated
- Description: Return true for dedicated server.
- Category: General
- Address: 0xCB6AA0
- Name: isDLCAvailable
- Description: Returns true if the DLC is marked as available.
- Category: General
- Address: 0xCB6B90
- Ex. Returns: 123896
- Arg1: appId
- Name: isEngineOn
- Description: Checks whether the engine is on.
- Category: General
- Address: 0xD715E0
- Example: on = isEngineOn vehicle player
- Arg1: vehicle
- Name: isForcedWalk
- Description: Returns true if player is forced to walk
- Category: General
- Address: 0xCB7F20
- Arg1: player
- Name: isFormationLeader
- Description: Returns true if the specified person is subgroup leader.
- Category: General
- Address: 0xD71640
- Arg1: person
- Name: isHidden
- Description: Return whether the person is hidden (reached the hiding position).
- Category: General
- Address: 0xD38790
- Arg1: person
- Name: isInRemainsCollector
- Description: Returns true if object will be managed by the unitRemove manager
- Category: General
- Address: 0xCB80E0
- Example: isInRemainsCollector player
- Arg1: object
- Name: isInstructorFigureEnabled
- Description: True if instructor figure is enabled in Game Options.
- Category: General
- Address: 0xCB8180
- Example: isInstructorFigureEnabled
- Ex. Returns: true or false
- Name: isKeyActive
- Description: Checks whether the given key is active in the current user profile.
- Category: General
- Address: 0xCB81A0
- Example: ok = isKeyActive "M04"
- Arg1: keyName
- Name: isLightOn
- Description: Checks whether the light is on.(non-vehicle param returns false)
- Category: General
- Address: 0xD716D0
- Example: on = isLightOn vehicle player
- Arg1: vehicle
- Name: isLocalized
- Description: Checks whether given string name is localized.
- Category: General
- Address: 0xD59530
- Example: isLocalized "STR_DN_SNAKE"
- Arg1: stringName
- Name: isManualFire
- Description: Returns true if manul fire is on.
- Category: General
- Address: 0xCB84A0
- Arg1: vehicle
- Name: isMarkedForCollection
- Description: Checks whether the object is marked for weapons collection.
- Category: General
- Address: 0xD389C0
- Example: marked = isMarkedForCollection truck
- Arg1: object
- Name: isMultiplayer
- Description: Return true if multiPlayer.
- Category: General
- Address: 0xCB86B0
- Name: isNull
- Description: Checks whether the value is equal to grpNull.
- Note: a==GrpNull does not work, because grpNull is not equal to anything, even to itself.
- Category: General
- Address: 0xCB3730
- Example: isNull group player
- Ex. Returns: false
- Arg1: grp
- Name: isNull
- Description: Checks whether the value is equal to scriptNull.
- Note: script == scriptNull does not work, because scriptNull is not equal to anything, even to itself.
- Category: General
- Address: 0xD4D150
- Example: isNull scriptNull
- Ex. Returns: true
- Arg1: script
- Name: isNull
- Description: Checks whether the value is equal to displayNull.
- Note: a==displayNull does not work, because displayNull is not equal to anything, even to itself.
- Category: General
- Address: 0xD65D10
- Example: isNull displayNull
- Ex. Returns: true
- Arg1: display
- Name: isNull
- Description: Checks whether the value is equal to objNetNull.
- Note: a==ObjNetNull does not work, because objNetNull is not equal to anything, even to itself.
- Category: General
- Address: 0xD29950
- Example: isNull objNetNull
- Ex. Returns: true
- Arg1: NetObject
- Name: isNull
- Description: Checks whether the value is equal to controlNull.
- Note: a==controlNull does not work, because controlNull is not equal to anything, even to itself.
- Category: General
- Address: 0xD62E70
- Example: isNull controlNull
- Ex. Returns: true
- Arg1: control
- Name: isNull
- Description: Checks whether the value is equal to objNull.
- Note: a==ObjNull does not work, because objNull is not equal to anything, even to itself.
- Category: General
- Address: 0xD38A20
- Example: isNull objNull
- Ex. Returns: true
- Arg1: obj
- Name: isNumber
- Description: Check if config entry represents number.
- Category: General
- Address: 0xC945F0
- Example: _ok = isNumber (configFile >> "CfgVehicles")
- Ex. Returns: false
- Arg1: config
- Name: isObjectRTD
- Description: Returns true if RTD model is loaded.
- Category: General
- Address: 0xCB8770
- Arg1: helicopter
- Name: isOnRoad
- Description: Check whether given position is on road.
- Category: General
- Address: 0xD472D0
- Arg1: position or object
- Name: isPipEnabled
- Description: Returns true if PiP is enabled.
- Category: General
- Address: 0xCB87D0
- Name: isPlayer
- Description: Check if given person is the player.
- Category: General
- Address: 0xD38AC0
- Arg1: person
- Name: isServer
- Description: Returns true if the computer is the server.
- Category: General
- Address: 0xCB8930
- Name: isSteamMission
- Description: Returns true if mission is started from the steam.
- Category: General
- Address: 0xCB8980
- Name: isStreamFriendlyUIEnabled
- Description: True if stream friendly UI is enabled in Game Options.
- Category: General
- Address: 0xCB89E0
- Example: isStreamFriendlyUIEnabled
- Ex. Returns: true or false
- Name: isStressDamageEnabled
- Description: Returns true if stress damage is enabled.
- Category: General
- Address: 0xCB8A00
- Name: isText
- Description: Check if config entry represents text.
- Category: General
- Address: 0xC94670
- Example: _ok = isText (configFile >> "CfgVehicles")
- Ex. Returns: false
- Arg1: config
- Name: isTouchingGround
- Description: Returns true if object is touching the ground.
- Category: General
- Address: 0xD38B20
- Example: isTouchingGround vehicle
- Arg1: object
- Name: isTutHintsEnabled
- Description: True if tutorial hints are enabled in Game Options.
- Category: General
- Address: 0xCB8A50
- Example: isTutHintsEnabled
- Ex. Returns: true or false
- Name: isUAVConnected
- Description: Returns true if UAV is connected to some terminal.
- Category: General
- Address: 0xCB8BA0
- Example: isUAVConnected cursorTarget
- Arg1: Uav
- Name: isWalking
- Description: Returns true walk is toggled.
- Category: General
- Address: 0xCB8C70
- Arg1: soldier
- Name: itemCargo
- Description: Get array with items from ammo box (or any general weapon holder container).
- Category: General
- Address: 0xD38FA0
- Arg1: box
- Name: items
- Description: Returns only items that are not magazines/explosives/grenades. Includes also items that are linked on unit (i.e. includes assignedItems array)
- Category: General
- Address: 0xD2CD20
- Arg1: unit
- Name: itemsWithMagazines
- Description: Get array with all inventory items.
- Category: General
- Address: 0xD2CCC0
- Arg1: unit
- Name: keyImage
- Description: Returns a structured text, containing an image or name (if no image is found) of the button (on the keyboard, mouse or joystick) with the given code.
- Category: General
- Address: 0xCA9FA0
- Example: name = keyImage 28
- Ex. Returns: "Enter"
- Arg1: dikCode
- Name: keyName
- Description: Returns the name of a button (on the keyboard, mouse or joystick) with the given code.
- Category: General
- Address: 0xCAA040
- Example: name = keyName 28
- Ex. Returns: "Enter"
- Arg1: dikCode
- Name: landResult
- Description: Return the result of helicopter landing position searching (performed after land command). The value can be "Found" (position found), "NotFound" (position not found), "NotReady" (position searching is still in progress) or empty string when wrong argument given.
- Category: General
- Address: 0xD341D0
- Arg1: helicopter
- Name: language
- Description: Returns current game language.
- Category: General
- Address: 0xCAA350
- Name: laserTarget
- Description: Returns target created by gunner in given vehicle.
- Category: General
- Address: 0xCAA380
- Arg1: vehicle
- Name: lbAdd
- Description: Adds an item with the given text to the listbox or combobox with id idc of the topmost user dialog. It returns the index of the newly added item.
- Category: General
- Address: 0xD1F2D0
- Example: _index = lbAdd [101, "First item"]
- Arg1: [idc, text]
- Name: lbClear
- Description: Clears all items in the listbox or combobox with id idc of the topmost user dialog.
- Category: General
- Address: 0xD20A10
- Example: lbClear 101
- Arg1: idc
- Name: lbClear
- Description: Clears all items in the given listbox or combobox.
- Category: General
- Address: 0xD66B80
- Example: lbClear _control
- Arg1: control
- Name: lbColor
- Description: Returns the text color of the item with the given index of the listbox or combobox with id idc of the topmost user dialog. The color is returned in format <ar>Color</ar>.
- Category: General
- Address: 0xD1F4A0
- Example: _color = lbColor [101, 0]
- Arg1: [idc, index]
- Name: lbCurSel
- Description: Returns the index of the selected item of the listbox or combobox with id idc of the topmost user dialog.
- Category: General
- Address: 0xD1F5F0
- Example: _index = lbCurSel 101
- Arg1: idc
- Name: lbCurSel
- Description: Returns the index of the selected item of the given listbox or combobox.
- Category: General
- Address: 0xD66DD0
- Example: _index = lbCurSel _control
- Arg1: control
- Name: lbData
- Description: Returns the additional text (invisible) in an item with the given index of the listbox or combobox with id idc of the topmost user dialog.
- Category: General
- Address: 0xD1F640
- Example: _data = lbData [101, 0]
- Arg1: [idc, index]
- Name: lbDelete
- Description: Removes the item with the given index from the listbox or combobox with id idc of the topmost user dialog.
- Category: General
- Address: 0xD1F3D0
- Example: lbDelete [101, 0]
- Arg1: [idc, index]
- Name: lbPicture
- Description: Returns the picture name of the item with the given index of the listbox or combobox with id idc of the topmost user dialog.
- Category: General
- Address: 0xD1F720
- Example: _picture = lbPicture [101, 0]
- Arg1: [idc, index]
- Name: lbSelection
- Description: Returns the array of selected rows indices in the given listbox.
- Category: General
- Address: 0xD670A0
- Example: _indices = lbSelection _control
- Arg1: control
- Name: lbSetColor
- Description: Sets the color of the item with the given index of the listbox or combobox with id idc of the topmost user dialog to the given color. Color is in format <ar>Color</ar>.
- Category: General
- Address: 0xD1FAB0
- Example: lbSetColor [101, 0, [0, 1, 0, 0.5]]
- Arg1: [idc, index, color]
- Name: lbSetCurSel
- Description: Selects the item with the given index of the listbox or combobox with id idc of the topmost user dialog.
- Category: General
- Address: 0xD1FBE0
- Example: lbSetCurSel [101, 0]
- Arg1: [idc, index]
- Name: lbSetData
- Description: Sets the additional text (invisible) in the item with the given index of the listbox or combobox with id idc of the topmost user dialog to the given data.
- Category: General
- Address: 0xD1FD80
- Example: lbSetData [101, 1, "#1"]
- Arg1: [idc, index, data]
- Name: lbSetPicture
- Description: Sets the picture in the item with the given index of the listbox or combobox with id idc of the topmost user dialog. Name is the picture name. The picture is searched in the mission directory, the dtaExt subdirectory of the campaign directory and the dtaExt directory and the data bank (or directory).
- Category: General
- Address: 0xD1FDA0
- Example: lbSetPicture [101, 0, "iskoda"]
- Arg1: [idc, index, name]
- Name: lbSetPictureColor
- Description: 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)
- Category: General
- Address: 0xD1FF20
- Example: lbSetPictureColor [101, 0, [0, 1, 0, 0.5]]
- Arg1: [idc, index, color]
- Name: lbSetPictureColorDisabled
- Description: 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)
- Category: General
- Address: 0xD20110
- Example: lbSetPictureColorDisabled [101, 0, [0, 1, 0, 0.5]]
- Arg1: [idc, index, color]
- Name: lbSetPictureColorSelected
- Description: 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)
- Category: General
- Address: 0xD20280
- Example: lbSetPictureColorSelected [101, 0, [0, 1, 0, 0.5]]
- Arg1: [idc, index, color]
- Name: lbSetTooltip
- Description: 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.
- Category: General
- Address: 0xD202A0
- Example: lbSetTooltip [101, 1, "tooltip"]
- Arg1: [idc, index, tooltip]
- Name: lbSetValue
- Description: Sets the additional integer value in the item with the given index of the listbox or combobox with id idc of the topmost user dialog to the given value.
- Category: General
- Address: 0xD202C0
- Example: lbSetValue [101, 0, 1]
- Arg1: [idc, index, value]
- Name: lbSize
- Description: Returns the number of items in the given listbox or combobox.
- Category: General
- Address: 0xD672B0
- Example: _n = lbSize _control
- Arg1: control
- Name: lbSize
- Description: Returns the number of items in the listbox or combobox with id idc of the topmost user dialog.
- Category: General
- Address: 0xD1F880
- Example: _n = lbSize 101
- Arg1: idc
- Name: lbSort
- Description: Sorts the given listbox or combobox by item text, order can be "asc" for ascending or "desc" for descending.
- Category: General
- Address: 0xD68000
- Example: lbSort [_control, "desc"]
- Arg1: [control, order]
- Name: lbSort
- Description: Sorts the given listbox or combobox by item text.
- Category: General
- Address: 0xD67F00
- Example: lbSort _control
- Arg1: control
- Name: lbSortByValue
- Description: Sorts the given listbox or combobox by item value.
- Category: General
- Address: 0xD67F80
- Example: lbSortByValue _control
- Arg1: control
- Name: lbText
- Description: Returns the shown text in the item with the given index of the listbox or combobox with id idc of the topmost user dialog.
- Category: General
- Address: 0xD1F8D0
- Example: _text = lbText [101, 0]
- Arg1: [idc, index]
- Name: lbValue
- Description: Returns the additional integer value in the item with the given index of the listbox or combobox with id idc of the topmost user dialog.
- Category: General
- Address: 0xD1F9B0
- Example: _value = lbValue [101, 0]
- Arg1: [idc, index]
- Name: leader
- Description: Returns the group leader for the given group. For a dead unit, grpNull is returned.
- Category: General
- Address: 0xCB3850
- Example: leader group player == leader player
- Arg1: grp
- Name: leader
- Description: Return the leader of given team.
- Category: Agents
- Address: 0xD5E190
- Arg1: team
- Name: leader
- Description: Returns the group leader for the given unit. For dead units, objNull is returned.
- Category: General
- Address: 0xD38070
- Example: leader player
- Arg1: unit
- Name: libraryCredits
- Description: Copyright information needed by libraries used.
- Category: General
- Address: 0xD222D0
- Example: libraryCredits
- Ex. Returns: [['Real Virtuality','(C) 2012 Bohemia Interactive','All rights reserved']]
- Name: libraryDisclaimers
- Description: Disclaimer information needed by libraries used (duplicate disclaimers are removed).
- Category: General
- Address: 0xD225D0
- Example: libraryDisclaimers
- Ex. Returns: ['All rights reserved']
- Name: lifeState
- Description: Returns the life state of the given unit.
- Category: General
- Address: 0xD34240
- Arg1: unit
- Name: lightDetachObject
- Description: Detach light from object.
- Category: General
- Address: 0xD22940
- Arg1: light
- Name: lightIsOn
- Description: Checks whether the lampost is turned on. Possible values are "ON", "OFF" and "AUTO" (auto means the lamp will be shining during the night automatically).
- Category: General
- Address: 0xD391B0
- Example: lightIsOn nearestObject [player, "StreetLamp"] != "OFF"
- Arg1: lamppost
- Name: lightnings
- Description: Return lightnings value.
- Category: General
- Address: 0xCAA430
- Name: linearConversion
- Description: Converts value in interval [min, max] to newMin + a*(max-min)/(newMax - newMin), potentially clamps the final value.
- Category: General
- Address: 0xCB6530
- Example: linearConversion [4, 8, 5, 0, 1, false]
- Arg1: [min, max, value, newMin, newMax, clamp]
- Name: lineBreak
- Description: Creates a structured text containing a line break.
- Category: General
- Address: 0xD60920
- Example: txt3 = lineBreak
- Name: lineIntersects
- Description: Returns true, if line intersect with any object.
- Category: General
- Address: 0xD23190
- Example: lineIntersects [begPos, endPos, withObj, ignoreObj]
- Arg1: array
- Name: lineIntersectsObjs
- Description: 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)
- Category: General
- Address: 0xD231B0
- Example: lineIntersectsObjs [begPos, endPos, withObj, ignoreObj, sortByDist, flags]
- Arg1: array
- Name: lineIntersectsWith
- Description: Returns list of objects intersected by given line.
- Category: General
- Address: 0xD231B0
- Example: lineIntersectsWith [begPos, endPos, withObj, ignoreObj, sortByDist]
- Arg1: array
- Name: list
- Description: Returns a list of units that would activate the given trigger. For a trigger of type "Not present" the list is the same as the list that would be returned for type "Present".
- Category: General
- Address: 0xD39660
- Example: list triggerOne
- Arg1: trigger
- Name: lnbAddArray
- Description: Adds list of rows of strings.
- Category: General
- Address: 0xD203E0
- Example: _index = lnbAddArray [idc,[[[text,text,text], [value], [data]], [[text,text,text], [value, value], [data]]]] . Returns row index.
- Arg1: [IDC,[[[text,text], [value,..], [data,..]], [[text,text], [value,..], [data,..]],]]
- Name: lnbAddColumn
- Description: Adds an column at given position. It returns the index of the newly added column.
- Category: General
- Address: 0xD207A0
- Example: _index = lnbAddColumn [105, 0.8]
- Arg1: [idc, position]
- Name: lnbAddRow
- Description: Adds an row of strings.
- Category: General
- Address: 0xD20880
- Example: _index = lnbAddRow [105, ["First column", "second column", ...]]. Returns row index.
- Arg1: [idc, [text, text,...]]
- Name: lnbClear
- Description: Clears all items in the given listbox or combobox.
- Category: General
- Address: 0xD66B60
- Example: lbClear _control
- Arg1: control
- Name: lnbClear
- Description: Clears all items in the 2D listbox.
- Category: General
- Address: 0xD20A10
- Example: lnbClear 101
- Arg1: idc
- Name: lnbColor
- Description: Returns the text color of the item with the given position of the 2D listbox. The color is returned in format <ar>Color</ar>.
- Category: General
- Address: 0xD20C00
- Example: _color = lnbColor [101, [0,1]]
- Arg1: [idc, [row, column]
- Name: lnbCurSelRow
- Description: Returns the index of the selected row id 2D listbox.
- Category: General
- Address: 0xD1F5F0
- Example: _row = lnbCurSel 105
- Arg1: idc
- Name: lnbCurSelRow
- Description: Returns the index of the selected item of the given listbox or combobox.
- Category: General
- Address: 0xD68850
- Example: _index = lbCurSel _control
- Arg1: control
- Name: lnbData
- Description: Returns the additional text (invisible) in an item with the given position of the 2D listbox.
- Category: General
- Address: 0xD20F10
- Example: _data = lnbData [101, [0,1]]
- Arg1: [idc, [row, column]
- Name: lnbDeleteColumn
- Description: Removes column with given index.
- Category: General
- Address: 0xD20A40
- Example: lnbDeleteColumn [101, 0]
- Arg1: [idc, index]
- Name: lnbDeleteRow
- Description: Removes row with given index from the 2D listbox.
- Category: General
- Address: 0xD20B20
- Example: lnbDeleteRow [105, 0]
- Arg1: [idc, index]
- Name: lnbGetColumnsPosition
- Description: Returns the columns position in 2D listbox.
- Category: General
- Address: 0xD20E00
- Example: _n = lnbGetColumnsSize 105
- Arg1: idc
- Name: lnbGetColumnsPosition
- Description: Returns the index of the selected item of the given listbox or combobox.
- Category: General
- Address: 0xD68740
- Example: _index = lbCurSel _control
- Arg1: control
- Name: lnbPicture
- Description: Returns the picture name of the item with the given position of the 2D listbox.
- Category: General
- Address: 0xD21090
- Example: _picture = lnbPicture [101, [0,1]]
- Arg1: [idc, [row, column]
- Name: lnbSetColor
- Description: Sets the color of the item with the given position of the 2D listbox. Color is in format <ar>Color</ar>.
- Category: General
- Address: 0xD216A0
- Example: lnbSetColor [101, [0,1], [0, 1, 0, 0.5]]
- Arg1: [idc, [row, column], color]
- Name: lnbsetColumnsPos
- Description: Sets the additional text (invisible) in the item with the given position of the 2D listbox.
- Category: General
- Address: 0xD21890
- Example: lnbSetData [101, [0,1], "#1"]
- Arg1: [idc, [row, column], data]
- Name: lnbSetCurSelRow
- Description: Selects the row with the given index of the 2D listbox.
- Category: General
- Address: 0xD21A00
- Example: lnbSetCurSel [105, 0]
- Arg1: [idc, index]
- Name: lnbSetData
- Description: Sets the additional text (invisible) in the item with the given position of the 2D listbox.
- Category: General
- Address: 0xD21AE0
- Example: lnbSetData [101, [0,1], "#1"]
- Arg1: [idc, [row, column], data]
- Name: lnbSetPicture
- Description: Sets the picture in the item with the given position of the 2D listbox. Name is the picture name. The picture is searched in the mission directory, the dtaExt subdirectory of the campaign directory and the dtaExt directory and the data bank (or directory).
- Category: General
- Address: 0xD21CD0
- Example: lnbSetPicture [101, [0,1], "iskoda"]
- Arg1: [idc, [row, column], name]
- Name: lnbSetText
- Description: Sets the additional text (invisible) in the item with the given position of the 2D listbox.
- Category: General
- Address: 0xD21EF0
- Example: lnbSetData [101, [0,1], "#1"]
- Arg1: [idc, [row, column], data]
- Name: lnbSetValue
- Description: Sets the additional integer value in the item with the position index of the 2D listbox.
- Category: General
- Address: 0xD220E0
- Example: lnbSetValue [101, [0,1], 1]
- Arg1: [idc, [row, column], value]
- Name: lnbSize
- Description: Returns the number of items in the given listbox or combobox.
- Category: General
- Address: 0xD68C70
- Example: _n = lbSize _control
- Arg1: control
- Name: lnbSize
- Description: Returns [X,Y] size of 2D listbox.
- Category: General
- Address: 0xD21270
- Example: _n = lnbSize 105
- Arg1: idc
- Name: lnbText
- Description: Returns the shown text in the item with the given position of the 2D listbox.
- Category: General
- Address: 0xD21380
- Example: _text = lnbText [101, [0,1]]
- Arg1: [idc, [row, column]]
- Name: lnbValue
- Description: Returns the additional integer value in the item with the given position of the 2D listbox.
- Category: General
- Address: 0xD21500
- Example: _value = lnbValue [101, [0,1]]
- Arg1: [idc, [row, column]
- Name: load
- Description: Returns current sum of mass from items stored in all unit's containers.
- Category: General
- Address: 0xD30780
- Example: load player
- Arg1: unit
- Name: loadAbs
- Description: Returns current sum of mass from items stored in a all unit's containers, linked items and weapons.
- Category: General
- Address: 0xD30860
- Example: loadAbs player
- Arg1: unit
- Name: loadBackpack
- Description: Returns current sum of mass from items stored in a backpack.
- Category: General
- Address: 0xD34730
- Example: loadBackpack player
- Arg1: unit
- Name: loadFile
- Description: 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
- Category: General
- Address: 0xD597C0
- Example: loadFile "myFunction.sqf"
- Ex. Returns: "if a>b then {a} else {b}"
- Arg1: filename
- Name: loadGame
- Description: Load a game from the autosave, if failed, restart the mission.
- Category: General
- Address: 0xD23B90
- Name: loadUniform
- Description: Returns current sum of mass from items stored in a uniform.
- Category: General
- Address: 0xD347E0
- Example: loadUniform player
- Arg1: unit
- Name: loadVest
- Description: Returns current sum of mass from items stored in a vest.
- Category: General
- Address: 0xD34890
- Example: loadVest player
- Arg1: unit
- Name: local
- Description: MP: checks whether the given unit is local on the computer. This can be used when one or more activation fields or scripts need to be performed only on one computer.
- In SP all objects are local. Note: all static objects are local on all computers.
- Category: General
- Address: 0xD38980
- Example: local unitName
- Arg1: obj
- Name: local
- Description: MP: checks whether the given group is local on the computer.
- Category: General
- Address: 0xCB36F0
- Example: local group1
- Arg1: grp
- Name: localize
- Description: Replaces the string with the given name with the corresponding localized text from the stringtable.csv file.
- Category: General
- Address: 0xD59670
- Example: localize "STR_DN_FROG"
- Arg1: stringName
- Name: locked
- Description: 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
- Category: General
- Address: 0xD3A480
- Example: locked jeepOne
- Arg1: unit
- Name: lockedDriver
- Description: Check whether driver position of the vehicle turret is locked.
- Category: General
- Address: 0xD71590
- Arg1: vehicle
- Name: logEntities
- Description: Creates a log file containing a list of all game entites in scene.,
- Category: General
- Address: 0xD24380
- Name: magazineCargo
- Description: Get array with magazines from ammo box (or any general weapon holder container).
- Category: General
- Address: 0xD3A4E0
- Arg1: box
- Name: magazines
- Description: Returns an array with the type names of all the vehicle's magazines.
- Category: General
- Address: 0xD308D0
- Example: magazines player
- Arg1: vehicle
- Name: magazinesAmmo
- Description: Returns an array of subarrays with the type names and ammo left of all the vehicle's magazines.
- Category: General
- Address: 0xD309C0
- Example: magazinesAmmo player
- Arg1: vehicle
- Name: magazinesAmmoCargo
- Description: Returns an array of subarrays with the type names and ammo left of all the vehicle's cargo magazines.
- Category: General
- Address: 0xD30B40
- Example: magazinesAmmoCargo vehicle player
- Arg1: vehicle
- Name: magazinesAmmoFull
- Description: Returns an array of subarrays with the type names and ammo left of all the vehicle's magazines.
- Category: General
- Address: 0xD30C70
- Example: magazinesAmmoFull player
- Arg1: vehicle
- Name: magazinesDetail
- Description: Returns an array with the type names of all the unit's magazines.
- Category: General
- Address: 0xD30900
- Example: magazines player
- Arg1: unit
- Name: magazinesDetailBackpack
- Description: Returns an array with the type names of all the unit's backpack magazines.
- Category: General
- Address: 0xD30930
- Example: magazinesBackpack player
- Arg1: unit
- Name: magazinesDetailUniform
- Description: Returns an array with the type names of all the unit's uniform magazines.
- Category: General
- Address: 0xD30960
- Example: magazinesUniform player
- Arg1: unit
- Name: magazinesDetailVest
- Description: Returns an array with the type names of all the unit's vest magazines.
- Category: General
- Address: 0xD30990
- Example: magazinesVest player
- Arg1: unit
- Name: mapAnimAdd
- Description: Adds the next frame to the map animation. The format of frame is [time, zoom, position], the format of position is <ar>Position2D</ar>.
- Category: General
- Address: 0xD243A0
- Example: mapAnimAdd [1, 0.1, getMarkerPos "anim1"]
- Arg1: frame
- Name: mapAnimClear
- Description: Clears the map animation.
- Category: General
- Address: 0xD24530
- Name: mapAnimCommit
- Description: Plays the map animation.
- Category: General
- Address: 0xD24590
- Name: mapAnimDone
- Description: Checks whether the map animation has finished.
- Category: General
- Address: 0xD245F0
- Name: mapGridPosition
- Description: Returns the position as map coords.
- Category: General
- Address: 0xD251B0
- Example: mapGridPosition player
- Arg1: object
- Name: markAsFinishedOnSteam
- Description: Marks current mission and finished on steam. Returns true is Steam query is successfully started or false otherwise.
- Category: General
- Address: 0xD25880
- Name: markerAlpha
- Description: Gets the marker alpha. See <f>setMarkerAlpha</f>.
- Category: General
- Address: 0xD25E70
- Example: markerAlpha "MarkerOne"
- Arg1: markerName
- Name: markerBrush
- Description: Gets the marker brush. See <f>setMarkerBrush</f>.
- Category: General
- Address: 0xD25F50
- Example: markerBrush "MarkerOne"
- Arg1: name
- Name: markerColor
- Description: Gets the marker color. See <f>setMarkerColor</f>.
- Note: this function is identical to <f>getMarkerColor</f>.
- Category: General
- Address: 0xD26030
- Example: markerColor "MarkerOne"
- Arg1: markerName
- Name: markerDir
- Description: Gets the marker direction. See <f>setMarkerDir</f>.
- Category: General
- Address: 0xD26130
- Example: markerDir "MarkerOne"
- Arg1: markerName
- Name: markerPos
- Description: Returns the marker positon in format [x,z,y].
- Note: this function is identical to <f>getMarkerPos</f>.
- Category: General
- Address: 0xD26210
- Example: markerPos "markerOne"
- Arg1: markerName
- Name: markerShape
- Description: Gets the marker shape. See <f>setMarkerShape</f>.
- Category: General
- Address: 0xD26390
- Example: markerShape "MarkerOne"
- Arg1: name
- Name: markerSize
- Description: Gets the marker size. See <f>setMarkerSize</f>.
- Note: this function is identical to <f>getMarkerSize</f>.
- Category: General
- Address: 0xD26480
- Example: markerSize "MarkerOne"
- Arg1: markerName
- Name: markerText
- Description: Gets the marker text. See <f>setMarkerText</f>.
- Category: General
- Address: 0xD265E0
- Example: markerText "MarkerOne"
- Arg1: markerName
- Name: markerType
- Description: Gets the type of the marker. See <f>setMarkerType</f>.
- Note: this function is identical to <f>getMarkerType</f>.
- Category: General
- Address: 0xD266C0
- Example: markerType "MarkerOne"
- Arg1: markerName
- Name: max
- Description: Extend expression
- Category: Simple expression
- Address: 0x1238DE0
- Arg1: expr
- Arg2: val
- Name: max
- Description: Extend expression
- Category: Simple expression
- Address: 0x123AEC0
- Arg1: val
- Arg2: expr
- Name: max
- Description: Extend expression
- Category: Simple expression
- Address: 0x1238DB0
- Arg1: expr1
- Arg2: expr2
- Name: max
- Description: Extend expression
- Category: Simple expression
- Address: 0x1238DB0
- Arg1: expr1
- Arg2: expr2
- Name: max
- Description: Extend expression
- Category: Simple expression
- Address: 0x1238DE0
- Arg1: expr
- Arg2: val
- Name: max
- Description: Extend expression
- Category: Simple expression
- Address: 0x123AEC0
- Arg1: val
- Arg2: expr
- Name: members
- Description: Return a list of members in given team.
- Category: Agents
- Address: 0xD5E230
- Example: _members = members _team
- Arg1: team
- Name: min
- Description: Extend expression
- Category: Simple expression
- Address: 0x1238E10
- Arg1: expr1
- Arg2: expr2
- Name: min
- Description: Extend expression
- Category: Simple expression
- Address: 0x1238E10
- Arg1: expr1
- Arg2: expr2
- Name: min
- Description: Extend expression
- Category: Simple expression
- Address: 0x123AEF0
- Arg1: val
- Arg2: expr
- Name: min
- Description: Extend expression
- Category: Simple expression
- Address: 0x1238E40
- Arg1: expr
- Arg2: val
- Name: min
- Description: Extend expression
- Category: Simple expression
- Address: 0x123AEF0
- Arg1: val
- Arg2: expr
- Name: min
- Description: Extend expression
- Category: Simple expression
- Address: 0x1238E40
- Arg1: expr
- Arg2: val
- Name: mineActive
- Description: Checks whether the given mine is active
- Category: General
- Address: 0xD28090
- Example: active mine
- Arg1: obj
- Name: missionConfigFile
- Description: Return root of mission description.ext entries hierarchy.
- Category: General
- Address: 0xC946E0
- Name: missionDifficulty
- Description: 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.
- Category: General
- Address: 0xCAA9D0
- Example: difficulty
- Name: missionName
- Description: Returns the name of the current mission.
- Category: General
- Address: 0xD28A20
- Name: missionNamespace
- Description: Return the global namespace attached to mission.
- Category: General
- Address: 0xD29810
- Name: missionStart
- Description: Returns the time of the mission start in format [year, month, day, hour, minute, second].
- Category: General
- Address: 0xD28E80
- Name: moonIntensity
- Description: Returns moon light intensity.
- Category: General
- Address: 0xCAABD0
- Name: morale
- Description: Checks a current morale level of the unit (-1..+1).
- Category: General
- Address: 0xD3AD90
- Example: morale leader player
- Ex. Returns: 0.5
- Arg1: unit
- Name: moveOut
- Description: Moves the soldier out of vehicle. (Immediately, without animation).
- Category: General
- Address: 0xD3BAF0
- Arg1: soldier
- Name: moveTime
- Description: Returns the current time of the most important RTM animation currently being played on the soldier.
- Category: General
- Address: 0xD34940
- Example: moveTime player
- Arg1: soldier
- Name: moveToCompleted
- Description: Check if latest low level moveTo command is finished.
- Category: General
- Address: 0xC8FBA0
- Arg1: person
- Name: moveToFailed
- Description: Check if latest low level moveTo command failed.
- Category: General
- Address: 0x11D62F0
- Arg1: person
- Name: musicVolume
- Description: Checks the current music volume (set by <f>fadeMusic</f>).
- Category: General
- Address: 0xCAAC20
- Name: name
- Description: Returns the name of the variable assigned to the object in the mission editor. When used on a vehicle, the name of the first crew member is returned (in order: commander, driver, gunner).
- Category: General
- Address: 0xD3BB50
- Example: name vehicle player
- Arg1: object
- Name: nameSound
- Description: Returns the nameSound of the variable assigned to the object in the mission editor.
- Category: General
- Address: 0xD3BDD0
- Example: nameSound player
- Arg1: object
- Name: nearestBuilding
- Description: Returns the nearest building to the given object.
- Category: General
- Address: 0xD349A0
- Example: neareastBuilding player
- Arg1: obj
- Name: nearestBuilding
- Description: Returns the nearest building to the given position.
- Category: General
- Address: 0xD34A30
- Example: neareastBuilding position player
- Arg1: pos
- Name: nearestObject
- Description: Returns the nearest object of the given type to the given position or object.
- Pos may be using format [x,y,z, "type"] or [object, "type"].
- Category: General
- Address: 0xCAC1C0
- Example: nearestObject [player, "StreetLamp"]
- Arg1: pos
- Name: nearestObjects
- Description: Returns a list of nearest objects of the given types to the given position or object, within the specified distance.
- Pos may be using format [x,y,z, ["type",...], limit] or [object, ["type",...], limit].
- Category: General
- Address: 0xCAC6B0
- Example: nearestObjects [player, ["Car","Tank"], 200]
- Arg1: pos
- Name: needReload
- Description: Return how much vehicle wants to reload its weapons.
- Category: General
- Address: 0xD71190
- Arg1: vehicle
- Name: netId
- Description: Unique ID of an object.
- Category: General
- Address: 0xCACEA0
- Example: netId player
- Ex. Returns: 1:8965
- Arg1: object
- Name: netId
- Description: Unique ID of a group.
- Category: General
- Address: 0xCACE60
- Example: netId (group player)
- Ex. Returns: 1:5623
- Arg1: group
- Name: netObjNull
- Description: A non-existing object. This value is not equal to anything, including itself.
- Category: General
- Address: 0xD299F0
- Example: myNetObject == objNetNull
- Ex. Returns: false
- Name: nextWeatherChange
- Description: Return the time (in seconds) when the next weather change will occur.
- Category: General
- Address: 0xCACFD0
- Name: numberOfEnginesRTD
- Description: Returns number of engines helicopter has.
- Category: General
- Address: 0xCAD020
- Arg1: RTD_helicopter
- Name: numberToDate
- Description: Convert float number to date.
- Category: General
- Address: 0xD29B20
- Example: date = NumberToDate [2008,0.5324]
- Arg1: [year,time]
- Name: objectCurators
- Description: Returns array with all curators which can edit given object.
- Category: General
- Address: 0xCA64D0
- Arg1: obj
- Name: objectFromNetId
- Description: Get object with given unique ID.
- Category: General
- Address: 0xCAD080
- Example: objectFromNetId netId player
- Ex. Returns: player
- Arg1: id
- Name: objNull
- Description: A non-existing object. This value is not equal to anything, including itself.
- Category: General
- Address: 0xD3BF40
- Example: player == objNull
- Ex. Returns: false
- Name: onBriefingGroup
- Description: Defines a sound (voice) that is played the first time when the Group section in the briefing is selected.
- Category: General
- Address: 0xC90D60
- Example: onBriefingGroup "GroupVoiceOver"
- Arg1: sound
- Name: onBriefingNotes
- Description: Defines a sound (voice) that is played the first time when the Notes section in the briefing is selected.
- Category: General
- Address: 0xC90DE0
- Example: onBriefingNotes "NotesVoiceOver"
- Arg1: sound
- Name: onBriefingPlan
- Description: Defines a sound (voice) that is played the first time when the Plan section in the briefing is selected.
- Category: General
- Address: 0xC90E60
- Example: onBriefingPlan "PlanVoiceOver"
- Arg1: sound
- Name: onBriefingTeamSwitch
- Description: Defines a sound (voice) that is played the first time when the Team switch section in the briefing is selected.
- Category: General
- Address: 0xC90EE0
- Example: onBriefingTeamSwitch "TeamSwitchVoiceOver"
- Arg1: sound
- Name: onCommandModeChanged
- Description: Defines an action performed when command mode change. Command receives <br/>
- _isHighCommand <t>bool</t>
- Category: General
- Address: 0xC93880
- Arg1: command
- Name: onEachFrame
- Description: Defines an action performed on each frame (even when game is paused). Code is performed synchronously, cannot contain any sleep or wait.
- Category: General
- Address: 0xD51490
- Example: onEachFrame {}
- Arg1: command
- Name: onGroupIconClick
- Description: Defines an action performed when player clicked on group marker (3D or in a map)
- Category: General
- Address: 0xCB29A0
- Arg1: command
- Name: onGroupIconOverEnter
- Description: Defines an action performed when player clicked on group marker (3D or in a map)
- Category: General
- Address: 0xCB29C0
- Arg1: command
- Name: onGroupIconOverLeave
- Description: Defines an action performed when player clicked on group marker (3D or in a map)
- Category: General
- Address: 0xCB29E0
- Arg1: command
- Name: onHCGroupSelectionChanged
- Description: Defines an action performed when HC group has been selected. Command receives <br/>
- _group <t>group</t> selected group <br/>
- _isSelected <t>bool</t> new selection state
- Category: General
- Address: 0xCB53A0
- Arg1: command
- Name: onMapSingleClick
- Description: Defines an action performed when the user clicks on the map. Command receives:<br/>
- <br/>
- _pos <t>array</t> position<br/>
- _units <t>array</t> selected units<br/>
- _shift,_alt <t>bool</t> key state<br/>
- <br/>If the click is processed, command should return true.
- Category: General
- Address: 0xD25350
- Example: onMapSingleClick """SoldierEG"" createUnit [_pos, group player]"
- Arg1: command
- Name: onPlayerConnected
- Description: 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.
- Category: General
- Address: 0xD29AA0
- Arg1: statement
- Name: onPlayerDisconnected
- Description: This statement is launched whenever a player is disconnected from a MP session. Variables _id, _name and _uid are set.
- Category: General
- Address: 0xD29AC0
- Arg1: statement
- Name: onPreloadFinished
- Description: Defines an action performed after the preload screen finished.
- Category: General
- Address: 0xD45D40
- Arg1: command
- Name: onPreloadStarted
- Description: Defines an action performed just before the preload screen started.
- Category: General
- Address: 0xD45D60
- Arg1: command
- Name: onTeamSwitch
- Description: Defines an action performed when the team switch is finished. Command receives:<br/>
- <br/>
- _from <t>object</t> previous unit<br/>
- _to <t>object</t> current units<br/>
- <br/>
- Category: General
- Address: 0xD45D80
- Arg1: command
- Name: openCuratorInterface
- Description: Force opens curator interface.
- Category: General
- Address: 0xD45DC0
- Name: openDlcPage
- Description: Opens a Steam page of the app with given appId. Only works for known appId (game + linked DLCs)
- Category: General
- Address: 0xD45E80
- Example: openDlcPage 288520
- Arg1: appId
- Name: openMap
- Description: Show player's map. If forced, cannot be closed.
- Category: General
- Address: 0xD45F50
- Example: openMap true
- Arg1: show
- Name: openMap
- Description: Show player's map. If forced, cannot be closed.
- Category: General
- Address: 0xD45F50
- Example: openMap [true,true]
- Arg1: [show, forced]
- Name: openYoutubeVideo
- Description: 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'
- Category: General
- Address: 0xD46110
- Arg1: youTubeUrl
- Name: opfor
- Description: Pre-defined variable for the opfor side.
- Category: General
- Address: 0xD578B0
- Name: overcast
- Description: Return the current overcast.
- Category: General
- Address: 0xCAD2B0
- Name: overcastForecast
- Description: Return the overcast forecast.
- Category: General
- Address: 0xCAD2E0
- Name: owner
- Description: On server machine, return the ID of the client where the object is local. Otherwise return 0.
- Category: General
- Address: 0xD35280
- Arg1: object
- Name: parseText
- Description: Creates a structured text by parsing the given XML description.
- Category: General
- Address: 0xD61060
- Example: txt = parseText "First line<img image=data\isniper.paa/><br/>Second line"
- Arg1: text
- Name: parsingNamespace
- Description: Return the global namespace attached to config parser.
- Category: General
- Address: 0xD29830
- Name: particlesQuality
- Description: Return current settings for particles quality.
- Category: General
- Address: 0xCAD310
- Name: pickWeaponPool
- Description: Transfers weapons and magazines from the cargo space of object obj to the weapon pool (used in campaigns to transfer weapons to the next mission).
- Category: General
- Address: 0xF934D0
- Arg1: obj
- Name: pitch
- Description: Returns the pitch of the variable assigned to the object in the mission editor.
- Category: General
- Address: 0xD3BF80
- Example: pitch player
- Arg1: object
- Name: playableSlotsNumber
- Description: 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.
- Category: General
- Address: 0xD46E20
- Arg1: side
- Name: playableUnits
- Description: Return a list of playable units (occupied by both AI or players).
- Category: General
- Address: 0xCAD4E0
- Name: player
- Description: This is the person controlled by the player. In MP this value is different on each computer.
- Category: General
- Address: 0xD46E90
- Example: alive player
- Name: playerRespawnTime
- Description: Return the player remaining time to respawn.
- Category: General
- Address: 0xCAD740
- Name: playerSide
- Description: Returns the player's side. This is valid even when the player controlled person is dead (a difference from player side).
- Category: General
- Address: 0xD46EE0
- Name: playersNumber
- Description: Returns the number of players playing on the given side.
- Category: General
- Address: 0xD46F30
- Arg1: side
- Name: playMission
- Description: The mission is launched (from the main menu). Both campaign and mission are given as their directory name. If the campaign is empty, a single mission is launched. If skipBriefing is true, the intro and briefing are skipped.
- Category: General
- Address: 0xD28A50
- Example: playMission["XOutrage","x05Negotiator.Noe"]
- Arg1: [campaign, mission] or [campaign, mission, skipBriefing]
- Name: playMusic
- Description: Plays music defined in the description.ext file.
- Category: General
- Address: 0xD46470
- Example: playMusic "musicname"
- Arg1: name
- Name: playMusic
- Description: Plays music defined in the description.ext file. The format of nameAndPos is [name,position]. Position is in seconds.
- Category: General
- Address: 0xD46470
- Example: playMusic ["Track13", 30]
- Arg1: nameAndPos
- Name: playScriptedMission
- Description: Load the given world, launch an empty mission and execute the given expression. Config (optional) can reference to the config entry replacing description.ext for this mission.
- Category: General
- Address: 0xD4D320
- Arg1: [world, expression, config, (ignoreChildWindow)]
- Name: playSound
- Description: Plays a sound defined in the description.ext file.
- Category: General
- Address: 0xD46B90
- Example: playSound "soundname"
- Arg1: name
- Name: playSound
- Description: Plays a sound defined in the description.ext file. Accomodation set to false disable sound volume changes.
- Category: General
- Address: 0xD46B90
- Example: playSound ["soundname", false]
- Arg1: name, enable / disable sound volume accomodation
- Name: playSound3D
- Description: 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.
- Category: General
- Address: 0xD467C0
- Example: playSound3D ["A3\Sounds_F\sfx\blip1.wav", player] or playSound3D ["A3\Sounds_F\sfx\blip1.wav", player, false, getPos player, 1, 1, 0]
- Arg1: ["filename", source, isInside, position, volume, frequency, distance]
- Name: position
- Description: Returns the object position in format <ar>Position</ar>.
- Category: General
- Address: 0xD35360
- Example: position player
- Arg1: object
- Name: positionCameraToWorld
- Description: Transform position from camera coordinate space to world coordinate space.
- Category: General
- Address: 0xD46F90
- Example: _worldPos = positionCameraToWorld _cameraPos
- Arg1: position
- Name: precision
- Description: Return the precision of the given entity.
- Category: General
- Address: 0xD35BA0
- Arg1: entity
- Name: preloadCamera
- Description: Preload all textures and models around given position
- Category: General
- Address: 0xC91FB0
- Arg1: position
- Name: preloadSound
- Description: Make sure sound can start playing without any delay once we need it.
- Category: General
- Address: 0xD58BD0
- Arg1: sound
- Name: preloadTitleObj
- Description: Object title - argument uses format ["text","type",speed, showInMap] or ["name","type"]. Speed is ignored.
- Preload data
- The object can be defined in the description.ext file.
- Category: General
- Address: 0xC9F240
- Example: titleObj ["BISLogo","plain"]
- Arg1: effect
- Name: preloadTitleRsc
- Description: Resource title - argument uses format ["name","type",speed, showInMap] or ["name","type"]. Speed is ignored.
- Preload data
- The resource can be defined in the description.ext file.
- Category: General
- Address: 0xC9F430
- Example: titleRsc ["BIS", "PLAIN"]
- Arg1: effect
- Name: preprocessFile
- Description: Returns the preprocessed content of the given file. The preprocessor is C-like, it supports comments using // or /* and */ and macros defined with #define. 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
- Category: General
- Address: 0xD59AE0
- Example: preprocessFile "myFunction.sqf"
- Ex. Returns: "if a>b then {a} else {b}"
- Arg1: filename
- Name: preprocessFileLineNumbers
- Description: 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.
- Category: General
- Address: 0xD59E60
- Example: preprocessFileLineNumbers "myFunction.sqf"
- Ex. Returns: "if a>b then {a} else {b}"
- Arg1: filename
- Name: primaryWeapon
- Description: Returns the name of the vehicle's primary weapon (an empty string if there is none).
- Category: General
- Address: 0xD35C00
- Example: primaryWeapon player
- Arg1: vehicle
- Name: primaryWeaponItems
- Description: Get array with all items assigned to a weapon.
- Category: General
- Address: 0xD3C5B0
- Arg1: unit
- Name: primaryWeaponMagazine
- Description: Return the names of the types of currently loaded magazines in given weapon.
- Category: General
- Address: 0xD71170
- Arg1: vehicle
- Name: productVersion
- Description: Return the product name and version, in form ["product name","product short name",version*100,build]
- Category: General
- Address: 0xCAD9D0
- Example: productVersion
- Ex. Returns: ["ArmA 2 OA","ArmA2OA",160,87840]
- Name: profileName
- Description: Return profile name.
- Category: General
- Address: 0xCADB80
- Name: profileNamespace
- Description: Return the global namespace attached to user profile.
- Category: General
- Address: 0xD29850
- Name: progressLoadingScreen
- Description: If loading screen is show, set progress bar to the given value (from interval [0, 1])
- Category: General
- Address: 0xD24330
- Arg1: progress
- Name: progressPosition
- Description: Returns the current position in the progress bar.
- Category: General
- Address: 0xD6AB90
- Example: _pos = progressPosition _control
- Arg1: control
- Name: publicVariable
- Description: Broadcasts the variable value to all computers.
- Only type <t>Number</t> is supported in versions 1.33 and before.
- The following types are supported since 1.34:
- <t>Number</t>, <t>Boolean</t>, <t>Object</t> and <t>Group</t>.
- Category: General
- Address: 0xD48E00
- Example: publicVariable "CTFscoreOne"
- Arg1: varName
- Name: publicVariableServer
- Description: Send the variable value to the server computer.
- Only type <t>Number</t> is supported in versions 1.33 and before.
- The following types are supported since 1.34:
- <t>Number</t>, <t>Boolean</t>, <t>Object</t> and <t>Group</t>.
- Category: General
- Address: 0xD48ED0
- Example: publicVariableServer "CTFscoreOne"
- Arg1: varName
- Name: putWeaponPool
- Description: Transfers weapons and magazines from the weapon pool (used in campaigns to transfer weapons to the next mission) into the cargo space of object obj.
- Category: General
- Address: 0xF931F0
- Arg1: obj
- Name: queryItemsPool
- Description: Returns the number of items of type name in the weapon pool (used in campaigns to transfer weapons to the next mission).
- Category: General
- Address: 0xF93260
- Arg1: name
- Name: queryMagazinePool
- Description: Returns the number of magazines of type name in the weapon pool (used in campaigns to transfer weapons to the next mission).
- Category: General
- Address: 0xF93330
- Arg1: name
- Name: queryWeaponPool
- Description: Returns the number of weapons of type name in the weapon pool (used in campaigns to transfer weapons to the next mission).
- Category: General
- Address: 0xF93400
- Arg1: name
- Name: radioChannelCreate
- Description: 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.
- Category: General
- Address: 0xC96100
- Arg1: [[r,g,b,a], label, callSign, [unit1,unit2,...], sentenceColorType]
- Name: radioVolume
- Description: Checks the current radio volume (set by <f>setRadioVolume</f>).
- Category: General
- Address: 0xCADBB0
- Name: rain
- Description: Return the current rain.
- Category: General
- Address: 0xCADBD0
- Name: rainbow
- Description: Return the current rainbow intensity.
- Category: General
- Address: 0xCADBF0
- Name: randomGen
- Description: Create expression which will generate random number from interval <0, multiplier)
- Category: Simple expression
- Address: 0x1238FF0
- Example: randomGen daylight
- Arg1: multiplier
- Name: randomGen
- Description: Create expression which will generate random number from interval <0, multiplier)
- Category: Simple expression
- Address: 0x123AF50
- Example: randomGen 5
- Arg1: multiplier
- Name: rank
- Description: Return the rank of the given unit.
- Category: General
- Address: 0xD6D160
- Arg1: unit
- Name: rankId
- Description: Return the rank of the given unit for comparison.
- Category: General
- Address: 0xD6D1E0
- Arg1: unit
- Name: rating
- Description: Checks the unit rating. This rating is increased for killing enemies, decreased for killing friendlies and can be changed by a mission designer.
- Category: General
- Address: 0xD301D0
- Example: rating player
- Arg1: unit
- Name: reload
- Description: Reload all weapons.
- Category: General
- Address: 0xD72350
- Arg1: vehicle
- Name: reloadEnabled
- Description: Check whether magazine is reloaded whenever emptied.
- Category: General
- Address: 0xD71730
- Arg1: vehicle
- Name: removeAllActions
- Description: Removes the action with the given id.
- Category: General
- Address: 0xD3CA00
- Example: removeAllActions player
- Arg1: unit
- Name: removeAllAssignedItems
- Description: Removes all linked items from gear (map, compass, headgear, goggles etc.).
- Category: General
- Address: 0xD49C10
- Arg1: unit
- Name: removeAllContainers
- Description: Removes all containers from the unit.
- Category: General
- Address: 0xD3C6F0
- Example: removeAllContainers player
- Arg1: unit
- Name: removeAllCuratorAddons
- Description: Restrict access to all addons for given curator.
- Category: General
- Address: 0xD49CE0
- Arg1: curatorObj
- Name: removeAllCuratorCameraAreas
- Description: Delete all curator camera areas.
- Category: General
- Address: 0xD49E00
- Arg1: curatorObj
- Name: removeAllCuratorEditingAreas
- Description: Delete all curator edit areas.
- Category: General
- Address: 0xD49EB0
- Arg1: curatorObj
- Name: removeAllHandgunItems
- Description: Removes all items from weapon except magazine.
- Category: General
- Address: 0xD3C7A0
- Arg1: unit
- Name: removeAllItems
- Description: Removes all items from the uniform, vest and backpack.
- Category: General
- Address: 0xD3C8A0
- Arg1: unit
- Name: removeAllItemsWithMagazines
- Description: Removes all items from the uniform, vest and backpack.
- Category: General
- Address: 0xD3C7C0
- Arg1: unit
- Name: removeAllMissionEventHandlers
- Description: Removes all event handlers of the given type which were added by <f>addMissionEventHandler</f>.
- Category: General
- Address: 0xD28D60
- Example: removeAllMissionEventHandlers "ended"
- Arg1: type
- Name: removeAllMusicEventHandlers
- Description: Remove all music track event handlers.
- Category: General
- Address: 0xD296A0
- Example: removeAllMusicEventHandlers "MusicStart"
- Arg1: type
- Name: removeAllPrimaryWeaponItems
- Description: Removes all items from weapon except magazine.
- Category: General
- Address: 0xD3C9E0
- Arg1: unit
- Name: removeAllWeapons
- Description: Removes all weapons from the unit.
- Category: General
- Address: 0xD3CA40
- Example: removeAllWeapons player
- Arg1: unit
- Name: removeBackpack
- Description: Remove backpack from unit.
- Category: General
- Address: 0xD49FD0
- Example: removeBackpack player
- Arg1: unit
- Name: removeBackpackGlobal
- Description: Remove backpack from unit(even non-local).
- Category: General
- Address: 0xD4A040
- Example: removeBackpackGlobal player
- Arg1: unit
- Name: removeFromRemainsCollector
- Description: Removes flag from given objects to be managed by unitRemove manager
- Category: General
- Address: 0xD4A780
- Example: removeFromRemainsCollector [unit1, unit2]
- Arg1: array
- Name: removeGoggles
- Description: Remove goggles from unit.
- Category: General
- Address: 0xD4A830
- Example: removeBackpack player
- Arg1: unit
- Name: removeHeadgear
- Description: Remove headgear from unit.
- Category: General
- Address: 0xD4A8F0
- Example: removeBackpack player
- Arg1: unit
- Name: removeMissionEventHandler
- Description: 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.
- Category: General
- Address: 0xD28DA0
- Example: removeMissionEventHandler ["ended",0]
- Arg1: [type, id]
- Name: removeMusicEventHandler
- Description: Remove specified music track event handler.
- Category: General
- Address: 0xD296E0
- Example: removeMusicEventHandler ["MusicTerminate", "1"]
- Arg1: [type, id]
- Name: removeSwitchableUnit
- Description: Remove a unit from the list of units available for team switch.
- Category: General
- Address: 0xD4AA80
- Arg1: person
- Name: removeUniform
- Description: Remove uniform from unit.
- Category: General
- Address: 0xD4AB80
- Example: removeBackpack player
- Arg1: unit
- Name: removeVest
- Description: Remove vest from unit.
- Category: General
- Address: 0xD4ACB0
- Example: removeBackpack player
- Arg1: unit
- Name: requiredVersion
- Description: Checks whether the appropriate version of the application is available. If it's not, a warning message is shown and false is returned. The version format is "Major.Minor", e.g. "1.30".
- Category: General
- Address: 0xD4ACD0
- Example: requiredVersion "1.30"
- Arg1: version
- Name: resetCamShake
- Description: Resets all camera shakes.
- Category: General
- Address: 0xD4AE00
- Name: resetSubgroupDirection
- Description: Reset direction of subgroup.
- Category: General
- Address: 0xD4AE60
- Example: resetSubgroupDirection unit
- Arg1: subgroup member
- Name: resistance
- Description: The Resistance side.
- Category: General
- Address: 0xD57790
- Name: resources
- Description: Return a list of the resources belonging to a team.
- Category: Agents
- Address: 0xD5E430
- Arg1: teamMember
- Name: reversedMouseY
- Description: Return if mouse vertical axe is inverted.
- Category: General
- Address: 0xD4B390
- Name: roadsConnectedTo
- Description: Find the road segments connected to the given road segment.
- Category: General
- Address: 0xCA43C0
- Arg1: road segment
- Name: ropeAttachedObjects
- Description: Returns list of attached objects on ropes
- Category: General
- Address: 0xD4B690
- Example: ropeAttachedObjects obj
- Arg1: vehicle
- Name: ropeAttachedTo
- Description: Returns the object it is attached to by rope
- Category: General
- Address: 0xD4B890
- Example: ropeAttachedTo obj
- Arg1: vehicle
- Name: ropeAttachEnabled
- Description: Check if the vehicle can be attached to ropes
- Category: General
- Address: 0xD4B3B0
- Arg1: vehicle
- Name: ropeCreate
- Description: Create instance of rope object attached on vehicle
- Category: General
- Address: 0xD4B970
- Example: 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]]]
- Arg1: [fromObject, fromPoint, toObject, toPoint, (length), ([ropeStart, downDir]), ([ropeEnd, downDir])]
- Name: ropeCut
- Description: Cut rope and detach rope from vehicle
- Category: General
- Address: 0xD4C3B0
- Example: ropeCut [rope, 5]
- Arg1: [rope, distance]
- Name: ropeDestroy
- Description: Destroy rope and detach rope from vehicle
- Category: General
- Address: 0xD4C470
- Example: ropeDestroy rope
- Arg1: rope
- Name: ropeEndPosition
- Description: Return rope end positions
- Category: General
- Address: 0xD4C560
- Example: [start position, end position] ropeEndPosition ropeObj
- Arg1: rope
- Name: ropeLength
- Description: Return rope length (set by ropeCreate, ropeCut, ropeUnwind)
- Category: General
- Address: 0xCADFC0
- Example: ropeLength rope
- Arg1: rope
- Name: ropes
- Description: Return vehicle ropes
- Category: General
- Address: 0xD4C8E0
- Example: ropes vehicle player
- Arg1: vehicle
- Name: ropeUnwind
- Description: Unwind rope to target length. Use relative parameter for change rope length +/- from current length
- Category: General
- Address: 0xD4C7A0
- Example: ropeUnwind [rope, 3, 10]
- Arg1: [rope, speed, targetLength, (relative)]
- Name: ropeUnwound
- Description: False if unwiding in progress, otherwise true
- Category: General
- Address: 0xD4C730
- Example: ropeUnwound rope
- Arg1: rope
- Name: rotorsForcesRTD
- Description: Returns force produced by rotors.
- Category: General
- Address: 0xCAE0D0
- Arg1: RTD_helicopter
- Name: rotorsRpmRTD
- Description: Returns rotors RPM.
- Category: General
- Address: 0xCAE490
- Arg1: RTD_helicopter
- Name: runInitScript
- Description: Launch init.sqs script.
- Category: General
- Address: 0xD28E60
- Name: safeZoneH
- Category: General
- Address: 0xD4CA80
- Name: safeZoneW
- Category: General
- Address: 0xD4CAC0
- Name: safeZoneWAbs
- Category: General
- Address: 0xD4CB00
- Name: safeZoneX
- Category: General
- Address: 0xD4CB40
- Name: safeZoneXAbs
- Category: General
- Address: 0xD4CB80
- Name: safeZoneY
- Category: General
- Address: 0xD4CBC0
- Name: saveGame
- Description: Creates an autosave game (used for Retry).
- Category: General
- Address: 0xD4CC00
- Name: saveJoysticks
- Description: Saves joysticks key mappings into the joysticks.cfg file. Engine add these joysticks to the Joystick Scheme mapping dialog in options controls section.
- Category: General
- Address: 0xD4CC40
- Name: saveProfileNamespace
- Description: Saves the variables stored in profileNamespace to user profile.
- Category: General
- Address: 0xD4CCA0
- Name: saveVar
- Description: Saves the variable value into the global campaign space. The variable is then available to all following missions in the campaign.
- Category: General
- Address: 0xD4CD40
- Example: saveVar "varOne"
- Arg1: varName
- Name: savingEnabled
- Description: Check if saving the game is enabled.
- Category: General
- Address: 0xCB8900
- Name: score
- Description: MP: returns the unit's score.
- Category: General
- Address: 0xD35DB0
- Example: score unitOne
- Arg1: unit
- Name: scoreSide
- Description: MP: returns side score.
- Category: General
- Address: 0xD57740
- Example: score west
- Arg1: side
- Name: screenToWorld
- Description: Returns the position on landscape (in world coordinates) corresponding to the given point on screen (in UI coordinates).
- Category: General
- Address: 0xD4CE00
- Arg1: position
- Name: scriptDone
- Description: Check if script is already finished
- Category: General
- Address: 0xD4D030
- Arg1: script
- Name: scriptNull
- Description: A non-existing script. This value is not equal to anything, including itself.
- Category: General
- Address: 0xD4D170
- Example: script == scriptNull
- Ex. Returns: false
- Name: scudState
- Description: 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.
- Category: General
- Address: 0xD35F50
- Example: scudState scudOne>=4
- Arg1: scud
- Name: secondaryWeapon
- Description: Returns the name of a vehicle's secondary weapon (an empty string if there is none).
- Category: General
- Address: 0xD35FB0
- Example: secondaryWeapon player
- Arg1: vehicle
- Name: secondaryWeaponItems
- Description: Get array with all items assigned to a weapon.
- Category: General
- Address: 0xD3F0C0
- Arg1: unit
- Name: secondaryWeaponMagazine
- Description: Return the names of the types of currently loaded magazines in given weapon.
- Category: General
- Address: 0xD711F0
- Arg1: vehicle
- Name: selectBestPlaces
- Description: Find the places with the max. value of _expression in the given area.
- Category: General
- Address: 0xC901D0
- Arg1: [_position, _radius, _expression, _precision, _sourcesCount]
- Name: selectNoPlayer
- Description: Switch player to no unit.
- Category: General
- Address: 0xD4D450
- Name: selectPlayer
- Description: Switch player to given unit.
- Category: General
- Address: 0xD4D4A0
- Example: selectPlayer aP
- Arg1: unit
- Name: sendAUMessage
- Description: Send the command to the list of clients or some count of clients.
- Category: General
- Address: 0xD4D740
- Example: SendAUMessage [[dpnid1, dpnid2], "ConnectTo: 192.168.1.66"]
- Arg1: [count|[clientList], "command"]
- Name: sendUDPMessage
- Description: Send message to given adress using UDP protocol.
- Category: General
- Address: 0x11D62F0
- Arg1: [ip,port,"message"]
- Name: serverCommand
- Description: Process the specified server command.
- The Server command string is identical to that used in chat line in MP.
- This command needs to be executed from UI handler to succeed.
- Category: General
- Address: 0xD4EAB0
- Example: serverCommand "#kick friendlykiller"
- Arg1: server command
- Name: serverCommandAvailable
- Description: Checks whether current user is able to process the specified server command. See also <f>serverCommand</f>
- Category: General
- Address: 0xD4EB90
- Example: serverCommandAvailable "#kick"
- Arg1: server command
- Name: serverCommandExecutable
- Description: Checks whether current user is able to execute the specified server command.
- This command needs to be executed from UI handler to succeed and mirrors serverCommand behavior. See also <f>serverCommand</f>
- Category: General
- Address: 0xD4EC20
- Example: serverCommandExecutable "#kick"
- Arg1: server command
- Name: serverTime
- Description: Server time synchronized to clients.
- Category: General
- Address: 0xCAE760
- Name: setAccTime
- Description: Sets the time acceleration coeficient. It can also be used to slow down time in cutscenes.
- Category: General
- Address: 0xD4ED90
- Example: setAccTime 0.1
- Arg1: accFactor
- Name: setAperture
- Description: Sets custom camera apreture (-1 to do it automatically).
- Category: General
- Address: 0xD4F000
- Arg1: set
- Name: setApertureNew
- Description: Sets custom camera apreture (-1 to do it automatically).
- Category: General
- Address: 0xD4F0D0
- Arg1: [min, std, max, std lum]
- Name: setArmoryPoints
- Description: Store the given amount of armory points.
- Category: General
- Address: 0xD4F2B0
- Arg1: points
- Name: setCamShakeDefParams
- Description: Sets camera shake default params.
- Category: General
- Address: 0xD4F6C0
- Arg1: [power, duration, maxDistance, frequency, minSpeed, minMass, caliberCoefHit, caliberCoefFire, vehicleCoef]
- Name: setCamShakeParams
- Description: Sets camera shake params.
- Category: General
- Address: 0xD4F910
- Arg1: [posCoef, rotXCoef, rotYCoef, rotZCoef, interp]
- Name: setCompassOscillation
- Description: Set Compass Oscilation.
- Category: General
- Address: 0xD4FC00
- Arg1: [angle, frequencyMin, frequencyMax]
- Name: setDate
- Description: Sets the actual mission date and time.
- Category: General
- Address: 0xD50450
- Arg1: [year, month, day, hour, minute]
- Name: setDefaultCamera
- Description: Sets the position and direction for camera used after camera is set on no object (e.g. leaving a multiplayer game).
- Category: General
- Address: 0xD507E0
- Example: setDefaultCamera [ [ 5000,5000,200], [1,1,-1] ]
- Arg1: [ position, direction = [0,0,-1]]
- Name: setDetailMapBlendPars
- Description: Sets the detail texture map blend pars.
- Category: General
- Address: 0xD50920
- Example: setDetailMapBlendPars [20, 50]
- Arg1: [fullDetail, noDetail]
- Name: setGroupIconsSelectable
- Description: Sets if group icons raises onclick and onover events.
- Category: General
- Address: 0xD4D6D0
- Example: selectableGroupIcons true
- Arg1: bool
- Name: setGroupIconsVisible
- Description: Sets if group icons are visible.
- Category: General
- Address: 0xD56730
- Example: showGroupIcons [true,true]
- Arg1: array
- Name: setHorizonParallaxCoef
- Description: Sets coef used to shift horizon position based on camera height (use 0 to disable shifting).
- Category: General
- Address: 0xD52400
- Arg1: coef
- Name: setHUDMovementLevels
- Description: 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
- Category: General
- Address: 0xD51F10
- Example: SetHUDMovementLevels [20,30,-1,-1,0.23,2.1]
- Arg1: [min speed, max speed, min alt, max alt, min dir, max dir, position[x,y,z] or target]
- Name: setLocalWindParams
- Description: Sets parameters for local wind emiters (like helicopters). Default [1.0, 1.0]
- Category: General
- Address: 0xD525F0
- Arg1: [strength, diameter]
- Name: setMousePosition
- Description: Move (UI) mouse pointer to specified position of the screen.
- Category: General
- Address: 0xD527D0
- Example: setMousePosition [0.5, 0.5]
- Arg1: [x, y]
- Name: setMusicEventHandler
- Description: Sets given music track event handler.
- Category: General
- Address: 0xD29790
- Example: setMusicEventHandler ["MusicTerminate", ""]
- Arg1: [type, function]
- Name: setObjectViewDistance
- Description: Sets the rendering distance of objects.
- Category: General
- Address: 0xD53510
- Example: setobjectviewdistance 2000
- Arg1: distance
- Name: setObjectViewDistance
- Description: Sets the rendering distance of objects.
- Category: General
- Address: 0xD53510
- Example: setobjectviewdistance [2000,50]
- Arg1: [vehiclesZ, shadowsZ]
- Name: setPlayable
- Description: Create MP role for the unit.
- Category: General
- Address: 0xD54840
- Example: setPlayable aP
- Arg1: unit
- Name: setPlayerRespawnTime
- Description: Set the time interval to wait on player respawn. It is set to mission default on mission start again.
- Category: General
- Address: 0xD54890
- Arg1: time interval
- Name: setShadowDistance
- Description: Sets the shadows rendering distance.
- Category: General
- Address: 0xD52760
- Example: setShadowDistance 1000
- Arg1: newDistance
- Name: setSimulWeatherLayers
- Description: Sets simul weather layers
- Category: General
- Address: 0xD54D30
- Arg1: layers
- Name: setStatValue
- Description: Sets a value to given stat.
- Category: General
- Address: 0xD55000
- Arg1: [statName, value]
- Name: setSystemOfUnits
- Description: Set system of units. 0 for metric, 1 for mixed, 2 for imperial.
- Category: General
- Address: 0xD55240
- Arg1: value
- Name: setTerrainGrid
- Description: 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.
- Category: General
- Address: 0xD55290
- Example: setTerrainGrid 12.5
- Arg1: grid
- Name: setTimeMultiplier
- Description: Time multiplier for in game time.
- Category: General
- Address: 0xD55490
- Example: setTimeMultiplier 60
- Arg1: multiplier
- Name: setTrafficDensity
- Description: Set the density of ambient cars in a rectangle (in cars per kilometer).
- Category: General
- Address: 0xD55590
- Arg1: [density, xMin, xMax, zMin, zMax]
- Name: setTrafficDistance
- Description: Set maximum ambient traffic draw distance (in 2D).
- Category: General
- Address: 0xD55590
- Arg1: distance
- Name: setTrafficGap
- Description: Set the average gap between ambient cars in a rectangle (in meters).
- Category: General
- Address: 0xD55590
- Arg1: [gap, xMin, xMax, zMin, zMax]
- Name: setTrafficSpeed
- Description: Set ambient traffic speed in a rectangle (in kilometers per hour).
- Category: General
- Address: 0xD55590
- Arg1: [speed, xMin, xMax, zMin, zMax]
- Name: setViewDistance
- Description: Sets the rendering distance. Default is 900 meters. The accepted range is from 500 to 5000 meters.
- Category: General
- Address: 0xD55AE0
- Example: setviewdistance 2000
- Arg1: distance
- Name: setWind
- Description: Set current (forced == false) or permanent (forced == true) wind direction and force.
- Category: General
- Address: 0xD56030
- Arg1: [x, z, forced]
- Name: setWindDir
- Description: Set current wind direction and force.
- Category: General
- Address: 0xD561E0
- Arg1: [x, z]
- Name: showChat
- Description: Shows/hides the whole chat window.
- Category: General
- Address: 0xD56560
- Example: showChat false
- Arg1: true/false
- Name: showCinemaBorder
- Description: Forces drawing of the cinema borders. This is normally used in cutscenes to indicate the player has no control.
- Category: General
- Address: 0xC10A20
- Arg1: show
- Name: showCommandingMenu
- Description: Create the commanding menu described by the given config class. When class name is empty, current commanding menu is hidden.
- Category: General
- Address: 0xD4FBC0
- Arg1: class name
- Name: showCompass
- Description: Enables the compass (the default is true).
- Category: General
- Address: 0xD565A0
- Arg1: show
- Name: showCuratorCompass
- Description: Hides or shows compass in curator interface.
- Category: General
- Address: 0xD56620
- Arg1: show?
- Name: showGps
- Description: Enables the GPS receiver (the default is false).
- Category: General
- Address: 0xD566B0
- Arg1: show
- Name: showHUD
- Description: Enable / disable showing of HUD.
- Category: General
- Address: 0xD56810
- Arg1: enable
- Name: showMap
- Description: Enables the map (the default is true).
- Category: General
- Address: 0xD56EB0
- Example: showMap true
- Arg1: show
- Name: shownArtilleryComputer
- Description: Checks whether the player has the artillery computer currently enabled.
- Category: General
- Address: 0xCB6760
- Name: shownChat
- Description: Checks whether the player chat is visible.
- Category: General
- Address: 0xCB6940
- Name: shownCompass
- Description: Checks whether the player has the compass enabled.
- Category: General
- Address: 0xCB6960
- Name: shownCuratorCompass
- Description: Returns true if compass is shown.
- Category: General
- Address: 0xCB6A50
- Name: shownGps
- Description: Checks whether the player has the GPS receiver enabled.
- Category: General
- Address: 0xCB7F70
- Name: shownMap
- Description: Checks whether the player has the map enabled.
- Category: General
- Address: 0xCB84F0
- Name: shownPad
- Description: Checks whether the player has the notebook enabled.
- Category: General
- Address: 0xCB86E0
- Name: shownRadio
- Description: Checks whether the player has the radio transmitter enabled.
- Category: General
- Address: 0xCB8C00
- Name: shownUAVFeed
- Description: True if UAV view is visible.
- Category: General
- Address: 0xD57530
- Name: shownWarrant
- Description: Checks whether the player has the ID card enabled.
- (Obsolete).
- Category: General
- Address: 0xCB8CC0
- Name: shownWatch
- Description: Checks whether the player has the watch enabled.
- Category: General
- Address: 0xCB8D30
- Name: showPad
- Description: Enables the notepad (the default is true).
- Category: General
- Address: 0xD56F30
- Arg1: show
- Name: showRadio
- Description: Enables the radio (the default is false).
- Category: General
- Address: 0xD573D0
- Arg1: show
- Name: showSubtitles
- Description: Enable / disable showing of subtitles. Return the previous state.
- Category: General
- Address: 0xD56FF0
- Arg1: enable
- Name: showUAVFeed
- Description: Show UAV view.
- Category: General
- Address: 0xD57350
- Example: showUAVFeed true
- Arg1: show
- Name: showWarrant
- Description: Obsolete.
- Enables the ID card (the default is false).
- Category: General
- Address: 0xD57440
- Arg1: show
- Name: showWatch
- Description: Enables the watch (the default is true).
- Category: General
- Address: 0xD574B0
- Arg1: show
- Name: side
- Description: Returns the side of the unit.
- Category: General
- Address: 0xD43110
- Example: side player == west
- Arg1: unit
- Name: side
- Description: Returns the side of the group.
- Category: General
- Address: 0xCB4960
- Example: side group player == west
- Arg1: group
- Name: sideEnemy
- Description: The Enemy side (used for renegades).
- Category: General
- Address: 0xD576C0
- Name: sideFriendly
- Description: The Friendly side (used for captives).
- Category: General
- Address: 0xD57700
- Name: sideLogic
- Description: The Logic side.
- Category: General
- Address: 0xD57870
- Name: sideUnknown
- Description: The unknown side.
- Category: General
- Address: 0xD578F0
- Name: simulationEnabled
- Description: Check if the entity has enabled simulation.
- Category: General
- Address: 0xD71780
- Arg1: entity
- Name: simulCloudDensity
- Description: Returns density of clouds at given position.
- Category: General
- Address: 0xD57C30
- Arg1: position
- Name: simulCloudOcclusion
- Description: Returns clouds occlusion between two given points (0 = no clouds, 1 = full clouds).
- Category: General
- Address: 0xD57E40
- Arg1: [position1, position2]
- Name: simulInClouds
- Description: Returns if given position is in clouds.
- Category: General
- Address: 0xD581D0
- Arg1: position
- Name: simulWeatherSync
- Description: Synchronizes SW with arma weather, generates all keyframes.
- Category: General
- Address: 0xD58400
- Name: sizeOf
- Description: Return the size of the entity of given type.
- Category: General
- Address: 0xD61780
- Arg1: typeName
- Name: skill
- Description: Returns the current level of ability of the person.
- Category: General
- Address: 0xD30700
- Example: skill player
- Arg1: person
- Name: skipTime
- Description: Skips the specified time. Daytime is adjusted, a weather change is estimated and no changes to any units are done. Duration is in hours.
- Category: General
- Address: 0xD58550
- Example: skipTime 2.5
- Arg1: duration
- Name: sleep
- Description: Suspend execution of script for given time.
- Category: General
- Address: 0xD6DB30
- Example: sleep 0.5
- Arg1: delay
- Name: sliderPosition
- Description: Returns the current thumb position of the given slider.
- Category: General
- Address: 0xD6ADD0
- Example: _pos = sliderPosition _control
- Arg1: control
- Name: sliderPosition
- Description: Returns the current thumb position of the slider with id idc of the topmost user dialog.
- Category: General
- Address: 0xD585B0
- Example: _pos = sliderPosition 101
- Arg1: idc
- Name: sliderRange
- Description: Returns the limits (as an array [min, max]) of the slider with id idc of the topmost user dialog.
- Category: General
- Address: 0xD585F0
- Example: _limits = sliderRange 100
- Arg1: idc
- Name: sliderRange
- Description: Returns the limits (as an array [min, max]) of the given slider.
- Category: General
- Address: 0xD6AE60
- Example: _limits = sliderRange _control
- Arg1: control
- Name: sliderSetPosition
- Description: Sets the current thumb position of the slider with id idc of the topmost user dialog.
- Category: General
- Address: 0xD588E0
- Example: sliderSetPosition [100, 0]
- Arg1: [idc, pos]
- Name: sliderSetRange
- Description: Sets the limits of the slider with id idc of the topmost user dialog.
- Category: General
- Address: 0xD589A0
- Example: sliderSetRange [100, 0, 10]
- Arg1: [idc, min, max]
- Name: sliderSetSpeed
- Description: 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.
- Category: General
- Address: 0xD58A90
- Example: sliderSetSpeed [100, 0.5, 2.0]
- Arg1: [idc, line, page]
- Name: sliderSpeed
- Description: Returns the speed (as an array [line, page]) of the given slider.
- Category: General
- Address: 0xD6B020
- Example: _speed = sliderSpeed _control
- Arg1: control
- Name: sliderSpeed
- Description: Returns the speed (as an array [line, page]) of the slider with id idc of the topmost user dialog.
- Category: General
- Address: 0xD58760
- Example: _speed = sliderSpeed
- Arg1: idc
- Name: slingLoadAssistantShown
- Description: Return true if Sling Load Assistant is shown.
- Category: General
- Address: 0xD77C30
- Example: slingLoadAssistantShown
- Name: SoldierMagazines
- Description: Get array with all magazines from vest.
- Category: General
- Address: 0xD2D350
- Arg1: unit
- Name: someAmmo
- Description: Checks whether the unit has some ammo remaining.
- Category: General
- Address: 0xD435A0
- Example: someAmmo vehicle player
- Arg1: unit
- Name: soundVolume
- Description: Checks the current sound volume (set by <f>setSoundVolume</f>).
- Category: General
- Address: 0xCAEB50
- Name: speaker
- Description: Returns the speaker of the variable assigned to the object in the mission editor.
- Category: General
- Address: 0xD436D0
- Example: speaker player
- Arg1: object
- Name: speed
- Description: Returns the object speed (in km/h).
- Category: General
- Address: 0xD36390
- Example: speed player
- Arg1: obj
- Name: speedMode
- Description: Returns the speed mode of the group ("LIMITED", "NORMAL" or "FULL").
- Category: General
- Address: 0xCB49D0
- Example: speedMode group player
- Arg1: grp
- Name: squadParams
- Description: Returns data about squad of given unit loaded from squad.xml
- Category: General
- Address: 0xCAEB70
- Arg1: unit
- Name: stance
- Description: Returns the stance of the given unit.
- Category: General
- Address: 0xD36400
- Arg1: unit
- Name: startLoadingScreen
- Description: 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.
- Category: General
- Address: 0xD241A0
- Arg1: [text] or [text, resource]
- Name: stopEngineRTD
- Description: Instant engines stop.
- Category: General
- Address: 0xD4AE20
- Arg1: RTD_helicopter
- Name: stopped
- Description: Checks whether the unit is stopped using the "stop" command.
- Category: General
- Address: 0xD437C0
- Example: stopped jeepOne
- Arg1: unit
- Name: sunOrMoon
- Description: Returns sun to moon transition state.
- Category: General
- Address: 0xCAF3E0
- Name: surfaceIsWater
- Description: Returns whether water is on given position.
- Category: General
- Address: 0xD5A5F0
- Arg1: [x, y]
- Name: surfaceNormal
- Description: Returns surface normal on given position.
- Category: General
- Address: 0xD5A2D0
- Arg1: [x, y]
- Name: surfaceType
- Description: Returns what surface is on given position.
- Category: General
- Address: 0xD5A490
- Arg1: [x, y]
- Name: switchableUnits
- Description: Return a list of units accessible through team switch.
- Category: General
- Address: 0xCAF430
- Name: synchronizedObjects
- Description: Return the list of objects synchronized with the given unit/trigger.
- Category: General
- Address: 0xD36490
- Arg1: unit/trigger
- Name: synchronizedTriggers
- Description: Return the list of triggers synchronized with a given waypoint.
- Category: General
- Address: 0xD5A790
- Example: synchronizedTriggers [group player, 1]
- Arg1: waypoint
- Name: synchronizedWaypoints
- Description: Return the list of waypoints synchronized with a given waypoint.
- Category: General
- Address: 0xD5A960
- Example: synchronizedWaypoints [group player, 1]
- Arg1: waypoint
- Name: synchronizedWaypoints
- Description: Return the list of waypoints synchronized with a given trigger.
- Category: General
- Address: 0xD5A960
- Example: synchronizedWaypoints trigger1
- Arg1: trigger
- Name: systemChat
- Description: Types text to the system radio channel.
- Note: this function only types text to the list, it does not broadcast the message. If you want the message to show on all computers, you have to execute it on all of them.
- Category: General
- Address: 0xD5AAF0
- Example: systemChat "Dam of Peace"
- Arg1: chatText
- Name: systemOfUnits
- Description: Returns 0 for metric, 1 for mixed (ground units uses metric, air units uses imperial) and 2 for imperial.
- Category: General
- Address: 0xCAF630
- Name: taskHint
- Description: Shows info about new,changed or failed task. The text can contain several lines. \n is used to indicate the end of a line.
- Category: General
- Address: 0xD57030
- Example: taskHint "Capture town."
- Arg1: text
- Name: teamMember
- Description: Return an agent for given person.
- Category: Agents
- Address: 0xD36600
- Example: _agent = teamMember player
- Arg1: person
- Name: teamMemberNull
- Description: A non-existing team member. This value is not equal to anything, including itself.
- Category: Agents
- Address: 0xD5EA20
- Example: _teamMember == teamMemberNull
- Ex. Returns: false
- Name: teamName
- Description: Return a name of given team.
- Category: Agents
- Address: 0xD5D990
- Example: _name = teamName _team
- Arg1: team
- Name: teams
- Description: Return a list of teams in the current mission.
- Category: Agents
- Address: 0xD5E5B0
- Example: _teams = teams
- Name: teamSwitch
- Description: Invoke the team switch dialog (force it even when conditions are not met).
- Category: General
- Address: 0xD48D90
- Name: teamSwitchEnabled
- Description: Check if tam switch is currently enabled.
- Category: General
- Address: 0xCB8A20
- Name: teamType
- Description: Return a type of given team.
- Category: Agents
- Address: 0xD5DA20
- Example: _type = teamType _team
- Arg1: team
- Name: terminate
- Description: Terminate (abort) the script
- Category: General
- Address: 0xD4D2B0
- Arg1: script
- Name: terrainIntersect
- Description: Checks for intersection of terrain between two positions. Returns true if intersects with terrain
- Category: General
- Address: 0xD5F020
- Example: _doesIntersect = terrainIntersect [ position player, position enemy1 ];
- Arg1: [ position begin, position end ]
- Name: terrainIntersectASL
- Description: Checks for intersection of terrain between two positions. Returns true if intersects with terrain
- Category: General
- Address: 0xD5F1A0
- Example: _doesIntersect = terrainIntersectASL [ getposAsl player, getposAsl enemy1 ];
- Arg1: [ positionASL begin, positionASL end ]
- Name: text
- Description: Creates a structured text containing the given plain text.
- Category: General
- Address: 0xD613B0
- Example: txt2 = text "Hello world."
- Arg1: text
- Name: textLog
- Description: Dumps the argument value into the debugging output.
- Category: General
- Address: 0xD55590
- Example: textLog player
- Arg1: anything
- Name: textLogFormat
- Description: Shortcut to textLog format [format, arg1, arg2, ...] (for better performance in retail version).
- Category: General
- Address: 0xD55590
- Arg1: [format, arg1, arg2, ...]
- Name: time
- Description: Returns the time that elapsed since the mission started (in seconds).
- Category: General
- Address: 0xC9F620
- Name: timeMultiplier
- Description: Returns game time multiplier setted to speed up game time
- Category: General
- Address: 0xCA8A30
- Example: multiplier
- Name: titleCut
- Description: Obsolete.
- Category: General
- Address: 0xC996F0
- Arg1: effect
- Name: titleFadeOut
- Description: Terminate the title effect and set duration of the fade out phase to the given time.
- Category: General
- Address: 0xC9F650
- Example: titleFadeIn 1.0
- Arg1: duration
- Name: titleObj
- Description: Object title - the argument uses format ["text","type",speed, showInMap] or ["name","type"]. If speed is not given, it's assumed to be one.
- The object can be defined in the description.ext file.
- Category: General
- Address: 0xC9F690
- Example: titleObj ["BISLogo","plain"]
- Arg1: effect
- Name: titleRsc
- Description: Resource title - the argument uses format ["name","type",speed, showInMap] or ["name","type"]. If speed is not given, it's assumed to be one.
- Resource can be defined in the description.ext file.
- Category: General
- Address: 0xC9F800
- Example: titleRsc ["BIS", "PLAIN"]
- Arg1: effect
- Name: titleText
- Description: Text title - the argument uses format ["text","type",speed, showInMap] or ["text","type"]. If speed is not given, it's assumed to be one.
- Category: General
- Address: 0xC9F980
- Example: titleText ["Show this text", "PLAIN"]
- Arg1: effect
- Name: triggerActivated
- Description: Returns true if the trigger has been activated.
- Category: General
- Address: 0xD5F490
- Arg1: trigger
- Name: triggerActivation
- Description: Returns trigger activation in the form [by, type, repeating]
- Category: General
- Address: 0xD5F9E0
- Arg1: trigger
- Name: triggerArea
- Description: Returns trigger area in the form [a, b, angle, rectangle]
- Category: General
- Address: 0xD5FB20
- Arg1: trigger
- Name: triggerAttachedVehicle
- Description: Returns vehicle attached to the trigger (for example using <f>triggerAttachVehicle</f>)
- Category: General
- Address: 0xD5FC30
- Arg1: trigger
- Name: triggerStatements
- Description: Returns trigger statements in the form [cond, activ, desactiv]
- Category: General
- Address: 0xD5FCA0
- Arg1: trigger
- Name: triggerText
- Description: Returns trigger text.
- Category: General
- Address: 0xD5FDF0
- Arg1: trigger
- Name: triggerTimeout
- Description: Returns trigger timeout in the form [min, mid, max, interruptable]
- Category: General
- Address: 0xD5FE60
- Arg1: trigger
- Name: triggerTimeoutCurrent
- Description: Returns trigger timeout or -1 if countdown is not in progress.
- Category: General
- Address: 0xD5FF30
- Example: triggerTimeoutCurrent triggerOne
- Arg1: trigger
- Name: triggerType
- Description: Returns trigger type.
- Category: General
- Address: 0xD5FF90
- Arg1: trigger
- Name: tvAdd
- Description: Adds an item with given text to Tree View with given idc under specified path (zero based).
- Category: General
- Address: 0xD5AB20
- Example: tvAdd [101, [0], "First item"]
- Arg1: [idc, [path], text]
- Name: tvClear
- Description: Removes all items from Tree View with given idc.
- Category: General
- Address: 0xD5ADA0
- Example: tvClear 101
- Arg1: idc
- Name: tvClear
- Description: Removes all items from Tree View with given idc.
- Category: General
- Address: 0xD6B610
- Example: tvClear 101
- Arg1: idc
- Name: tvCollapse
- Description: Collapses tree item pointed to by path. IDC means id of parent Tree View.
- Category: General
- Address: 0xD5ADF0
- Example: tvCollapse [101,[0]]
- Arg1: [idc, [path]]
- Name: tvCount
- Description: Returns childrens count of item on given path. IDC means id of parent Tree View.
- Category: General
- Address: 0xD5AF50
- Example: tvCount [101,[0]]
- Arg1: [idc, [path]]
- Name: tvCurSel
- Description: Returns path to currently selected item. IDC means id of parent Tree View.
- Category: General
- Address: 0xD6B7B0
- Example: tvCurSel 101
- Arg1: idc
- Name: tvCurSel
- Description: Returns path to currently selected item. IDC means id of parent Tree View.
- Category: General
- Address: 0xD5B5A0
- Example: tvCurSel 101
- Arg1: idc
- Name: tvData
- Description: Returns string data from item on given path. IDC means id of parent Tree View.
- Category: General
- Address: 0xD5B0C0
- Example: tvData [101,[0]]
- Arg1: [idc, [path]]
- Name: tvDelete
- Description: Removes an item on given path from Tree View with given idc.
- Category: General
- Address: 0xD5B240
- Example: tvDelete [101, [0,0]]
- Arg1: [idc, [path]]
- Name: tvExpand
- Description: Expands tree item pointed to by path. IDC means id of parent Tree View.
- Category: General
- Address: 0xD5B440
- Example: tvExpand [101,[0]]
- Arg1: [idc, [path]]
- Name: tvPicture
- Description: Returns name of picture from item pointed to by path. IDC means id of parent Tree View.
- Category: General
- Address: 0xD5BA80
- Example: tvPicture [101,[0]]
- Arg1: [idc, [path]]
- Name: tvSetCurSel
- Description: Sets cursor to given item on given path. IDC means id of parent Tree View.
- Category: General
- Address: 0xD5C1B0
- Example: tvSetCurSel [101,[0]]
- Arg1: [idc, [path]]
- Name: tvSetData
- Description: Sets string data to item on given path. IDC means id of parent Tree View.
- Category: General
- Address: 0xD5BC90
- Example: tvSetData [101,[0],"Test data"]
- Arg1: [idc, [path], "data"]
- Name: tvSetPicture
- Description: 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
- Category: General
- Address: 0xD5BED0
- Example: tvSetPicture [101,[0],"picture"]
- Arg1: [idc, [path],name]
- Name: tvSetTooltip
- Description: Sets tooltip for item with the given index of the tree view with id idc of the topmost user dialog to the given data.
- Category: General
- Address: 0xD5C310
- Example: tvSetTooltip [101, 1, "tooltip"]
- Arg1: [idc, index, tooltip]
- Name: tvSetValue
- Description: Sets scalar data to item on given path. IDC means id of parent Tree View.
- Category: General
- Address: 0xD5C460
- Example: tvSetValue [101,[0], 555]
- Arg1: [idc, [path], val]
- Name: tvSort
- Description: Sorts childrens of given item by data. Param reversed is optional. IDC means id of parent Tree View.
- Category: General
- Address: 0xD5C600
- Example: tvSort [101,[0],false]
- Arg1: [idc,[path],reversed]
- Name: tvSortByValue
- Description: Sorts childrens of given item by value. Param reversed is optional. IDC means id of parent Tree View.
- Category: General
- Address: 0xD5C760
- Example: tvSort [101,[0],false]
- Arg1: [idc,[path],reversed]
- Name: tvText
- Description: Returns shown text in the item on given path. IDC means id of parent Tree View.
- Category: General
- Address: 0xD5CAA0
- Example: tvText [101,[0]]
- Arg1: [idc, [path]]
- Name: tvTooltip
- Description: Returns the tooltip of the item in the given path of the treeview with id idc of the topmost user dialog.
- Category: General
- Address: 0xD5B870
- Example: _text = lbText [101, 0]
- Arg1: [idc, path]
- Name: tvValue
- Description: Returns scalar data from item on given path. IDC means id of parent Tree View.
- Category: General
- Address: 0xD5CC20
- Example: tvValue [101,[0]]
- Arg1: [idc, [path]]
- Name: typeOf
- Description: Returns the name of the type of the given object.
- Category: General
- Address: 0xD36690
- Example: typeOf player
- Ex. Returns: "SoldierWB"
- Arg1: object
- Name: UAVControl
- Description: Get list with unit connected to vehicle and position in that vehicle.
- Category: General
- Address: 0xD6C490
- Example: UAVControl cameraOn
- Arg1: Uav
- Name: uiNamespace
- Description: Return the global namespace attached to user interface.
- Category: General
- Address: 0xD29890
- Name: uisleep
- Description: Suspend execution of script for given uitime.
- Category: General
- Address: 0xD6AD10
- Example: uisleep 0.5
- Arg1: delay
- Name: unassignCurator
- Description: Unassign curator (will destroy both sides of connection).
- Category: General
- Address: 0xD6C7C0
- Arg1: curatorObj
- Name: unassignTeam
- Description: Unassigns the vehicle (its commander unit) from his team. This is equal to vehicle assignTeam "MAIN".
- Category: General
- Address: 0xD5EF70
- Example: unassignTeam soldier2
- Arg1: vehicle
- Name: unassignVehicle
- Description: The person is unassigned from the vehicle. If he is currently inside, the group leader will issue an order to disembark.
- Category: General
- Address: 0xD43C40
- Example: unassignVehicle player
- Arg1: unit
- Name: underwater
- Description: Return whether object is fully underwater.
- Category: General
- Address: 0xD38D90
- Arg1: object
- Name: uniform
- Description: Returns name of currently used uniform.
- Category: General
- Address: 0xD43F20
- Arg1: unit
- Name: uniformContainer
- Description: Returns container of currently used uniform.
- Category: General
- Address: 0xD43C90
- Arg1: unit
- Name: uniformItems
- Description: Get array with all items from uniform.
- Category: General
- Address: 0xD43CB0
- Arg1: unit
- Name: uniformMagazines
- Description: Get array with all magazines from vest.
- Category: General
- Address: 0xD43F00
- Arg1: unit
- Name: unitAddons
- Description: Get list with addons which unitClass belongs to.
- Category: General
- Address: 0xCB0630
- Example: unitAddons unitClass
- Arg1: unitClass
- Name: unitBackpack
- Description: Returns unit's backpack.
- Category: General
- Address: 0xCB09C0
- Arg1: unit
- Name: unitPos
- Description: Return the unit position rules.
- Category: General
- Address: 0xD36750
- Arg1: person
- Name: unitReady
- Description: Checks whether the unit is ready. A unit is busy when it's given an order like "move", until the command is finished.
- Category: General
- Address: 0xD6F2C0
- Example: unitReady player
- Arg1: unit
- Name: unitRecoilCoefficient
- Description: Returns unit's custom recoil coefficient.
- Category: General
- Address: 0xCB0A40
- Example: coef = unitRecoilCoefficient player
- Arg1: soldier
- Name: units
- Description: Returns an array with all the units in the group of the given object. For a destroyed object an empty array is returned.
- Category: General
- Address: 0xCB4A70
- Example: player in units player
- Arg1: unit
- Name: units
- Description: Returns an array with all the units in the group.
- Category: General
- Address: 0xCB4A90
- Example: player in units group player
- Arg1: grp
- Name: unlockAchievement
- Description: Unlock the given achievement.
- Category: General
- Address: 0xC8D180
- Arg1: name
- Name: vectorDir
- Description: Return object's direction vector in world coordinates as [x, z, y].
- Category: General
- Address: 0xD36A30
- Arg1: obj
- Name: vectorDirVisual
- Description: Return object's direction vector in world coordinates as [x, z, y].
- Category: General
- Address: 0xD36A50
- Arg1: obj
- Name: vectorMagnitude
- Description: Magnitude of a vector
- Category: General
- Address: 0x5CF640
- Example: vectorMagnitude [0,8,7]
- Arg1: array
- Name: vectorMagnitudeSqr
- Description: Squared magnitude of a vector
- Category: General
- Address: 0x5CF570
- Example: vectorMagnitudeSqr [4,1,3]
- Arg1: array
- Name: vectorNormalized
- Description: Normalized vector (unit vector), if original vector is zero, result is a zero vector as well
- Category: General
- Address: 0x5CF890
- Example: vectorNormalized [4,1,3]
- Arg1: array
- Name: vectorUp
- Description: Return object's up vector in world coordinates as [x, z, y].
- Category: General
- Address: 0xD36A70
- Arg1: obj
- Name: vectorUpVisual
- Description: Return object's up vector in world coordinates as [x, z, y].
- Category: General
- Address: 0xD36A90
- Arg1: obj
- Name: vehicle
- Description: Returns the vehicle in which the given unit is mounted. If there is none, the unit is returned.
- Category: General
- Address: 0xD43FF0
- Example: vehicle player != player
- Arg1: unit
- Name: vehicles
- Description: Return a list of vehicles in the current mission.
- Category: General
- Address: 0xCB1130
- Example: _vehicles = vehicles
- Name: vehicleVarName
- Description: Returns the name of the variable which contains a reference to this object.
- Category: General
- Address: 0xD71400
- Arg1: object
- Name: velocity
- Description: Returns the velocity (speed vector) of the vehicle as an array with format [x, z, y].
- Category: General
- Address: 0xD36AB0
- Arg1: vehicle
- Name: velocityModelSpace
- Description: Returns the velocity (speed vector) of the vehicle as an array with format [x, z, y]. Vector is in model space
- Category: General
- Address: 0xD36B90
- Arg1: vehicle
- Name: verifySignature
- Description: 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.
- Category: General
- Address: 0xD57930
- Arg1: filename
- Name: vest
- Description: Returns name of currently used vest.
- Category: General
- Address: 0xD444D0
- Arg1: unit
- Name: vestContainer
- Description: Returns container of currently used vest.
- Category: General
- Address: 0xD441A0
- Arg1: unit
- Name: vestItems
- Description: Get array with all items from vest.
- Category: General
- Address: 0xD441C0
- Arg1: unit
- Name: vestMagazines
- Description: Get array with all magazines from vest.
- Category: General
- Address: 0xD444B0
- Arg1: unit
- Name: viewDistance
- Description: Returns the rendering distance.
- Category: General
- Address: 0xCB1190
- Name: visibleCompass
- Description: Checks whether the player has the compass opened and visible.
- Category: General
- Address: 0xCB69C0
- Name: visibleGps
- Description: Checks whether the player has the GPS receiver opened and visible.
- Category: General
- Address: 0xCB7FD0
- Name: visibleMap
- Description: Return true if the main map is shown (active).
- Category: General
- Address: 0xCB8550
- Name: visiblePosition
- Description: Returns the object rendered position in format <ar>Position</ar>.
- Category: General
- Address: 0xD36C90
- Example: visiblePosition player
- Arg1: object
- Name: visiblePositionASL
- Description: Returns the object rendered position in format <ar>PositionASL</ar>.
- Category: General
- Address: 0xD36D90
- Example: visiblePositionASL player
- Arg1: object
- Name: visibleWatch
- Description: Checks whether the player has the watch opened and visible.
- Category: General
- Address: 0xCB8D90
- Name: waves
- Description: Return waves value.
- Category: General
- Address: 0xCB11E0
- Name: waypointAttachedObject
- Description: Gets the object attached to the waypoint.
- Category: General
- Address: 0xD74B10
- Example: waypointAttachedObject [groupOne, 1]
- Arg1: waypoint
- Name: waypointAttachedVehicle
- Description: Gets the vehicle attached to the waypoint.
- Category: General
- Address: 0xD74C00
- Example: waypointAttachedVehicle [groupOne, 1]
- Arg1: waypoint
- Name: waypointBehaviour
- Description: Gets the waypoint behavior.
- Category: General
- Address: 0xD74C80
- Example: waypointBehaviour [groupOne, 1]
- Arg1: waypoint
- Name: waypointCombatMode
- Description: Gets the waypoint combat mode.
- Category: General
- Address: 0xD74CF0
- Example: waypointCombatMode [groupOne, 1]
- Arg1: waypoint
- Name: waypointCompletionRadius
- Description: Gets the radius around the waypoint where is the waypoint completed.
- Category: General
- Address: 0xD74D60
- Example: _radius = waypointCompletionRadius [groupOne, 1]
- Arg1: waypoint
- Name: waypointDescription
- Description: Gets the waypoint description.
- Category: General
- Address: 0xD74E00
- Example: waypointDescription [groupOne, 1]
- Arg1: waypoint
- Name: waypointFormation
- Description: Gets the waypoint formation.
- Category: General
- Address: 0xD74E70
- Example: waypointFormation [groupOne, 1]
- Arg1: waypoint
- Name: waypointHousePosition
- Description: Gets the house position assigned to the waypoint.
- Category: General
- Address: 0xD74EE0
- Example: waypointHousePosition [groupOne, 1]
- Arg1: waypoint
- Name: waypointLoiterRadius
- Description: Gets the waypoint loiter radius. Waypoint uses format <ar>Waypoint</ar>.
- Category: General
- Address: 0xD74F40
- Example: waypointLoiterRadius [groupOne, 1]
- Arg1: waypoint
- Name: waypointLoiterType
- Description: Gets the waypoint loiter type. Waypoint uses format <ar>Waypoint</ar>.
- Category: General
- Address: 0xD75050
- Example: waypointLoiterRadius [groupOne, 1]
- Arg1: waypoint
- Name: waypointName
- Description: Gets the waypoint name.
- Category: General
- Address: 0xD751F0
- Example: waypointName [groupOne, 1]
- Arg1: waypoint
- Name: waypointPosition
- Description: Gets the waypoint position. Waypoint uses format <ar>Waypoint</ar>.
- Note: this function is identical to <f>getWaypointPosition</f>.
- Category: General
- Address: 0xD771C0
- Example: waypointPosition [groupOne, 1]
- Arg1: waypoint
- Name: waypoints
- Description: Return the list of waypoints for given group.
- Category: General
- Address: 0xCB3440
- Arg1: group
- Name: waypointScript
- Description: Gets the waypoint script.
- Category: General
- Address: 0xD75260
- Example: waypointScript [groupOne, 1]
- Arg1: waypoint
- Name: waypointShow
- Description: Gets the waypoint show/hide status.
- Category: General
- Address: 0xD752D0
- Example: waypointShow [groupOne, 1]
- Arg1: waypoint
- Name: waypointSpeed
- Description: Gets the waypoint speed.
- Category: General
- Address: 0xD75340
- Example: waypointSpeed [groupOne, 1]
- Arg1: waypoint
- Name: waypointStatements
- Description: Gets the waypoint statements.
- Category: General
- Address: 0xD753B0
- Example: waypointStatements [groupOne, 1]
- Arg1: waypoint
- Name: waypointTimeout
- Description: Gets the waypoint timeout values.
- Category: General
- Address: 0xD75470
- Example: waypointTimeout [groupOne, 1]
- Arg1: waypoint
- Name: waypointTimeoutCurrent
- Description: Gets the current waypoint timeout or -1 if countdown is not in progress.
- Category: General
- Address: 0xD75540
- Example: waypointTimeoutCurrent groupOne
- Arg1: waypoint
- Name: waypointType
- Description: Gets the waypoint type.
- Category: General
- Address: 0xD755E0
- Example: waypointType [groupOne, 1]
- Arg1: waypoint
- Name: waypointVisible
- Description: Gets waypoint visibility.
- Category: General
- Address: 0xD75650
- Example: visible = waypointVisible [groupOne, 1]
- Arg1: waypoint
- Name: weaponCargo
- Description: Get array with weapons from ammo box (or any general weapon holder container).
- Category: General
- Address: 0xD44500
- Arg1: box
- Name: weaponInertia
- Description: Returns current rate of how much the weapon view is distorted because of quick aiming
- Category: General
- Address: 0x5CEE90
- Example: weaponInertia player
- Arg1: soldier
- Name: weaponLowered
- Description: True if given soldier's weapon is lowered.
- Category: General
- Address: 0xD38F40
- Example: weaponLowered player
- Arg1: soldier
- Name: weapons
- Description: Returns an array of names of all the vehicle's weapons.
- Category: General
- Address: 0xD30CE0
- Example: weapons player
- Arg1: vehicle
- Name: weaponsItems
- Description: 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]]]
- Category: General
- Address: 0xD30D00
- Example: weaponsItems player
- Arg1: vehicle
- Name: weaponsItemsCargo
- Description: 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]]]
- Category: General
- Address: 0xD30EB0
- Example: weaponsItemsCargo vehicle player
- Arg1: vehicle
- Name: weaponState
- Description: Returns the current weapon state as an array of strings in the follow format [WeaponName, MuzzleName, ModeName, MagazineName].
- Category: General
- Address: 0xD37890
- Example: weaponState player or weaponState [vehicle player,[0]]
- Arg1: Gunner or [veh,turret path]
- Name: weightRTD
- Description: Returns weight of helicopter.
- Category: General
- Address: 0xCB1600
- Example: [fuselage weight, crew weight, fuel weight, custom weight, weapons weight]
- Arg1: helicopter
- Name: west
- Description: The West side.
- Category: General
- Address: 0xD57560
- Name: WFSideText
- Description: Returns the unlocalized text value of a object's side as: East, West, Resistance, Civilian, or Unknown.
- Category: General
- Address: 0xD74160
- Example: WFSideText player
- Arg1: object
- Name: WFSideText
- Description: Returns the unlocalized text value of a group's side as: East, West, Resistance, Civilian, or Unknown.
- Category: General
- Address: 0xD74070
- Example: WFSideText group player
- Arg1: group
- Name: wind
- Description: Return the current wind vector.
- Category: General
- Address: 0xCB17D0
- Name: windDir
- Description: Return the current wind azimut.
- Category: General
- Address: 0xCB1860
- Name: windRTD
- Description: Returns wind strength and direction.
- Category: General
- Address: 0xCB18C0
- Name: windStr
- Description: Return the current wind strength.
- Category: General
- Address: 0xCB1A10
- Name: wingsForcesRTD
- Description: Returns force produced by wings.
- Category: General
- Address: 0xCB1A50
- Arg1: RTD_helicopter
- Name: worldName
- Description: Return the name of the currently loaded world.
- Category: General
- Address: 0xCB25B0
- Name: worldToScreen
- Description: Converts position in world space into screen (UI) space.
- Category: General
- Address: 0xD76F00
- Arg1: position
Add Comment
Please, Sign In to add comment