{"updated":"2026-11-04T00:04:10Z","source":"https://community.bistudio.com/wiki/Category:Arma_3:_Functions","count":2062,"items":[{"name":"BIN_fnc_addButtonEvents","title":"BIN fnc addButtonEvents","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_addButtonEvents","revid":309515,"updated":"2022-05-05T12:06:39Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_addDangerZone","title":"BIN fnc addDangerZone","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_addDangerZone","revid":309547,"updated":"2022-05-05T12:07:00Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_addEntitiesToArea","title":"BIN fnc addEntitiesToArea","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_addEntitiesToArea","revid":309682,"updated":"2022-05-05T12:08:43Z","groups":["Collisions"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_addFaradayCage","title":"BIN fnc addFaradayCage","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_addFaradayCage","revid":309476,"updated":"2022-05-05T12:06:13Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_addIDWMapMeasurementPoint","title":"BIN fnc addIDWMapMeasurementPoint","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_addIDWMapMeasurementPoint","revid":309540,"updated":"2022-05-05T12:06:56Z","groups":["IDWMap"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Adds measurement point to IDWMap\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"arg call BIN_fnc_addIDWMapMeasurementPoint","params":[{"name":"arg","type":"Array","type_expr":"Array","optional":true,"default":"position player","description":"position in format [x,y] or [x,y,z] in which case z is ignored. Default: position player","text":"ARRAY (Optional) - position in format [x,y] or [x,y,z] in which case z is ignored. Default: position player","source":"docblock"}],"returns":{"type":"Number","type_expr":"Number","text":"NUMBER\n    0 ... 1 - strength at given coordinates\n    -1 - point is out of bounds\n    -999 - error","source":"docblock"},"inferred":true}],"examples":[{"code":["call BIN_fnc_addIDWMapMeasurementPoint\n[x,y] call BIN_fnc_addIDWMapMeasurementPoint\n[x,y,z] call BIN_fnc_addIDWMapMeasurementPoint"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Adds measurement point to IDWMap\n\nParameter(s):\n    ARRAY (Optional) - position in format [x,y] or [x,y,z] in which case z is ignored. Default: position player\n\nReturns:\n    NUMBER\n        0 ... 1 - strength at given coordinates\n        -1 - point is out of bounds\n        -999 - error\n\nExample:\n    call BIN_fnc_addIDWMapMeasurementPoint\n    [x,y] call BIN_fnc_addIDWMapMeasurementPoint\n    [x,y,z] call BIN_fnc_addIDWMapMeasurementPoint","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_addObjectsToArea","title":"BIN fnc addObjectsToArea","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_addObjectsToArea","revid":309616,"updated":"2022-05-05T12:07:44Z","groups":["Collisions"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Adds given array of objects to area, ovewriting previous objects data stored for the area in extension\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0, param1] call BIN_fnc_addObjectsToArea","params":[{"name":"param0","type":"String","type_expr":"String","description":"area name","text":"0: STRING - area name","source":"docblock"},{"name":"param1","type":"Array","type_expr":"Array","description":"array of objects to add","text":"1: ARRAY - array of objects to add","source":"docblock"}],"returns":{"type":"Number","type_expr":"Number","description":"number of objects added","text":"NUMBER - number of objects added","source":"docblock"},"inferred":true}],"examples":[{"code":["[\"myArea\", [obj1,ob2,...]]  call BIN_fnc_addObjectsToArea"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Adds given array of objects to area, ovewriting previous objects data stored for the area in extension\n\nParameter(s):\n    0: STRING - area name\n    1: ARRAY - array of objects to add\n\nReturns:\n    NUMBER - number of objects added\n\nExample:\n    [\"myArea\", [obj1,ob2,...]]  call BIN_fnc_addObjectsToArea","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_addRecordedSignal","title":"BIN fnc addRecordedSignal","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_addRecordedSignal","revid":309495,"updated":"2022-05-05T12:06:23Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_addRotation","title":"BIN fnc addRotation","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_addRotation","revid":309527,"updated":"2022-05-05T12:06:48Z","groups":["Movement"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_addSignal","title":"BIN fnc addSignal","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_addSignal","revid":309538,"updated":"2022-05-05T12:06:55Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_addSiteEntities","title":"BIN fnc addSiteEntities","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_addSiteEntities","revid":363741,"updated":"2024-04-17T15:24:34Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Register entities to a site, so they can be despawned with the rest when player leaves the area.\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0, param1] call BIN_fnc_addSiteEntities","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"site logic. The site must be spawned for the function to work.","text":"0: OBJECT - site logic. The site must be spawned for the function to work.","source":"docblock"},{"name":"param1","type":"Array","type_expr":"Array","description":"entities to be added. Types can be mixed, the system will sort them out itself.","text":"1: ARRAY - entities to be added. Types can be mixed, the system will sort them out itself.","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if added","text":"BOOL - true if added","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\n    Register entities to a site, so they can be despawned with the rest when player leaves the area.\n\nParameter(s):\n    0: OBJECT - site logic. The site must be spawned for the function to work.\n    1: ARRAY - entities to be added. Types can be mixed, the system will sort them out itself.\n\nReturns:\n    BOOL - true if added"},"filled_from_docblock":["params","syntax","returns","description"]},{"name":"BIN_fnc_addTranslation","title":"BIN fnc addTranslation","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_addTranslation","revid":309689,"updated":"2022-05-05T12:08:49Z","groups":["Movement"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_addTravelPoint","title":"BIN fnc addTravelPoint","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_addTravelPoint","revid":309592,"updated":"2022-05-05T12:07:27Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_allIDWMapMeasurementPoints","title":"BIN fnc allIDWMapMeasurementPoints","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_allIDWMapMeasurementPoints","revid":309485,"updated":"2022-05-05T12:06:18Z","groups":["IDWMap"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Retrieves user measurements data with strengths\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Array","type_expr":"Array","description":"user measurements in format [x,y,strength] or empty array [] on error","text":"ARRAY - user measurements in format [x,y,strength] or empty array [] on error","source":"docblock"}}],"examples":[{"code":["call BIN_fnc_getAllMeasurementPoints"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Retrieves user measurements data with strengths\n\nParameter(s):\n    NONE\n\nReturns:\n    ARRAY - user measurements in format [x,y,strength] or empty array [] on error\n\nExample:\n    call BIN_fnc_getAllMeasurementPoints","author":"Killzone_Kid"},"filled_from_docblock":["returns","examples","description"]},{"name":"BIN_fnc_allowAntennaReveal","title":"BIN fnc allowAntennaReveal","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_allowAntennaReveal","revid":309498,"updated":"2022-05-05T12:06:24Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_allowedAntennaReveal","title":"BIN fnc allowedAntennaReveal","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_allowedAntennaReveal","revid":309683,"updated":"2022-05-05T12:08:45Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_animateSmooth","title":"BIN fnc animateSmooth","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_animateSmooth","revid":309626,"updated":"2022-05-05T12:07:47Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_assignAntenna","title":"BIN fnc assignAntenna","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_assignAntenna","revid":309623,"updated":"2022-05-05T12:07:46Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_assignedAntenna","title":"BIN fnc assignedAntenna","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_assignedAntenna","revid":309545,"updated":"2022-05-05T12:06:59Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_attachChemlight","title":"BIN fnc attachChemlight","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_attachChemlight","revid":363740,"updated":"2024-04-17T15:23:36Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"```\n#define VAR_LIGHT    \"BIN_fnc_attachChemlight_light\"\n#define VAR_KILLED    \"BIN_fnc_attachChemlight_killed\"\n```\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_bakeAntenna","title":"BIN fnc bakeAntenna","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_bakeAntenna","revid":309523,"updated":"2022-05-05T12:06:44Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_behaviorInit","title":"BIN fnc behaviorInit","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_behaviorInit","revid":363746,"updated":"2024-04-17T15:24:35Z","groups":["Behavior"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"```\n#define HISTORY_CAPACITY    5\n#define HIT_DELAY        5\n#define SIZE_COEF        3\n```\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_bezier","title":"BIN fnc bezier","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_bezier","revid":363588,"updated":"2024-04-07T18:16:46Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Calculate bezier curve\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0, param1] call BIN_fnc_bezier","params":[{"name":"param0","type":"Array","type_expr":"Array","description":"list of control points in format [x,y,z], can be any number of them","text":"0: ARRAY - list of control points in format [x,y,z], can be any number of them","source":"docblock"},{"name":"param1","type":"Number","type_expr":"Number","description":"progress in range 0 to 1","text":"1: NUMBER - progress in range 0 to 1","source":"docblock"}],"returns":{"type":"Array","type_expr":"Array","description":"position curve in format [x,y,z]","text":"ARRAY - position curve in format [x,y,z]","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nCalculate bezier curve\n\nParameter(s):\n    0: ARRAY - list of control points in format [x,y,z], can be any number of them\n    1: NUMBER - progress in range 0 to 1\n\nReturns:\nARRAY - position curve in format [x,y,z]"},"filled_from_docblock":["params","syntax","returns","description"]},{"name":"BIN_fnc_bezierAverage","title":"BIN fnc bezierAverage","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_bezierAverage","revid":363744,"updated":"2024-04-17T15:24:34Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"```\n#define STEPS    101\n```\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_bezierBoundingBox","title":"BIN fnc bezierBoundingBox","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_bezierBoundingBox","revid":309505,"updated":"2022-05-05T12:06:32Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_bezierEditor","title":"BIN fnc bezierEditor","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_bezierEditor","revid":363747,"updated":"2024-04-17T15:24:36Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"```\n#define POINT_W            (0.03)\n#define POINT_H            (POINT_W / 0.75)\n#define RESOLUTION        50\n#define MAX_POINTS        16\n#define GRIDS            10\n#define REFRESH            ([_ctrlParent] call (_ctrlArea getvariable \"fnc_draw\"))\n#define POINTS            (_ctrlArea getvariable \"points\")\n#define LINES            (_ctrlArea getvariable \"lines\")\n#define CURVE            (_ctrlArea getvariable \"curve\")\n#define BUTTONS            (_ctrlArea getvariable \"buttons\")\n#define HOVER            (_ctrlArea getvariable \"hover\")\n#define SELECTED        (_ctrlArea getvariable \"selected\")\n#define SET_HOVER(CTRL)        _ctrlArea setvariable [\"hover\",CTRL]; CTRL ctrlsettextcolor COLOR_SELECTED\n#define SET_SELECTED(CTRL)    _ctrlArea setvariable [\"selected\",CTRL]\n#define COLOR_BACKGROUND    [0.4,0.4,0.4,1]\n#define COLOR            [0,0,0,1]\n#define COLOR_SELECTED        [1,1,1,1]\n#define COLOR_CURVE        [1,0,0,1]\n#define COLOR_LINE        [0,0,0,0.2]\n#define COLOR_TIMELINE        [1,1,1,1]\n#define COLOR_GRID        [1,1,1,0.3]\n#define POINT_POS        [\\\n                    (_posX - POINT_W / 2) max 0 min ((ctrlposition _ctrlArea select 2) - POINT_W),\\\n                    (_posY - POINT_H / 2) max 0 min ((ctrlposition _ctrlArea select 3) - POINT_H),\\\n                    POINT_W,\\\n                    POINT_H\\\n                ]\n```\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_bezierNormalize","title":"BIN fnc bezierNormalize","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_bezierNormalize","revid":309587,"updated":"2022-05-05T12:07:25Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_bezierVelocity","title":"BIN fnc bezierVelocity","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_bezierVelocity","revid":309567,"updated":"2022-05-05T12:07:12Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Calculate bezier curve velocity\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0, param1] call BIN_fnc_bezierVelocity","params":[{"name":"param0","type":"Array","type_expr":"Array","description":"list of control points in format [x,y,z], can be any number of them","text":"0: ARRAY - list of control points in format [x,y,z], can be any number of them","source":"docblock"},{"name":"param1","type":"Number","type_expr":"Number","description":"progress in range 0 to 1","text":"1: NUMBER - progress in range 0 to 1","source":"docblock"}],"returns":{"type":"Array","type_expr":"Array","description":"velocity vector in format [x,y,z]","text":"ARRAY - velocity vector in format [x,y,z]","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nCalculate bezier curve velocity\n\nParameter(s):\n    0: ARRAY - list of control points in format [x,y,z], can be any number of them\n    1: NUMBER - progress in range 0 to 1\n\nReturns:\nARRAY - velocity vector in format [x,y,z]"},"filled_from_docblock":["params","syntax","returns","description"]},{"name":"BIN_fnc_breatheInit","title":"BIN fnc breatheInit","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_breatheInit","revid":309522,"updated":"2022-05-05T12:06:44Z","groups":["Behavior"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_calculateLinkBudget","title":"BIN fnc calculateLinkBudget","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_calculateLinkBudget","revid":309464,"updated":"2022-05-05T12:06:10Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_calculateSpectrumAnalyzerValues","title":"BIN fnc calculateSpectrumAnalyzerValues","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_calculateSpectrumAnalyzerValues","revid":309512,"updated":"2022-05-05T12:06:36Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_callButtonEvent","title":"BIN fnc callButtonEvent","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_callButtonEvent","revid":309661,"updated":"2022-05-05T12:08:16Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_cargoPlatform_01_adjust","title":"BIN fnc cargoPlatform 01 adjust","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_cargoPlatform_01_adjust","revid":348307,"updated":"2023-11-08T12:59:37Z","groups":["Cargo Platform"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Adjust Military Cargo Platform legs length in Eden Editor.","syntaxes":[{"syntax":"[object] call BIN_fnc_cargoPlatform_01_adjust","params":[{"name":"object","type":"Object","description":"cargo platform","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["platform call BIN_fnc_cargoPlatform_01_adjust;"]}],"see_also":["BIN_fnc_cargoPlatform_01_destruction","BIN_fnc_cargoPlatform_01_update"]},{"name":"BIN_fnc_cargoPlatform_01_destruction","title":"BIN fnc cargoPlatform 01 destruction","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_cargoPlatform_01_destruction","revid":286048,"updated":"2021-06-20T17:24:47Z","groups":["Cargo Platform"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"BIN_fnc_CargoPlatform_01_destruction\n\nApply texture & materials of parent object to ruins. Function is attached to killed event handler.\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_CargoPlatform_01_destruction\n\nApply texture & materials of parent object to ruins. Function is attached to killed event handler."},"filled_from_docblock":["description"]},{"name":"BIN_fnc_cargoPlatform_01_update","title":"BIN fnc cargoPlatform 01 update","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_cargoPlatform_01_update","revid":286082,"updated":"2021-06-20T17:25:29Z","groups":["Cargo Platform"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"BIN_fnc_cargoPlatform_01_update\n\nUpdate cargo platform position\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_cargoPlatform_01_update\n\nUpdate cargo platform position"},"filled_from_docblock":["description"]},{"name":"BIN_fnc_CBRNCharacterAdd","title":"BIN fnc CBRNCharacterAdd","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_CBRNCharacterAdd","revid":309525,"updated":"2022-05-05T12:06:45Z","groups":["Modules - CBRN","Broken Functions"],"status":"broken","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Enables CBRN systems on a specific character entity.\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0] call BIN_fnc_CBRNCharacterAdd","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"character entity to enable CBRN systems on","text":"0: OBJECT - character entity to enable CBRN systems on","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","text":"BOOL","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nEnables CBRN systems on a specific character entity.\nNOTE: Module / function set not robust nor completed - not recommended for usage at this stage!\n\nParameter(s):\n    0: OBJECT - character entity to enable CBRN systems on\n\nReturns:\nBOOL"},"filled_from_docblock":["params","syntax","returns","description"]},{"name":"BIN_fnc_CBRNContaminantAdd","title":"BIN fnc CBRNContaminantAdd","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_CBRNContaminantAdd","revid":309631,"updated":"2022-05-05T12:07:49Z","groups":["Modules - CBRN","Broken Functions"],"status":"broken","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Registers a CBRN contaminant.\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0] call BIN_fnc_CBRNContaminantAdd","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"OBJECT - trigger representing a CBRN contaminated area\nOBJECT - entity representing an active CBRN contaminant","text":"0: OBJECT - trigger representing a CBRN contaminated area\nOBJECT - entity representing an active CBRN contaminant","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","text":"BOOL","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nRegisters a CBRN contaminant.\nNOTE: Module / function set not robust nor completed - not recommended for usage at this stage!\n\nParameter(s):\n    0:\n        OBJECT - trigger representing a CBRN contaminated area\n        OBJECT - entity representing an active CBRN contaminant\n\nReturns:\nBOOL"},"filled_from_docblock":["params","syntax","returns","description"]},{"name":"BIN_fnc_CBRNContaminantRemove","title":"BIN fnc CBRNContaminantRemove","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_CBRNContaminantRemove","revid":309690,"updated":"2022-05-05T12:08:49Z","groups":["Modules - CBRN","Broken Functions"],"status":"broken","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Unregisters a CBRN contaminant.\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0] call BIN_fnc_CBRNContaminantRemove","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"trigger representing a CBRN contaminated area","text":"0: OBJECT - trigger representing a CBRN contaminated area","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","text":"BOOL","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nUnregisters a CBRN contaminant.\nNOTE: Module / function set not robust nor completed - not recommended for usage at this stage!\n\nParameter(s):\n    0: OBJECT - trigger representing a CBRN contaminated area\n\nReturns:\nBOOL"},"filled_from_docblock":["params","syntax","returns","description"]},{"name":"BIN_fnc_CBRNGearActivate","title":"BIN fnc CBRNGearActivate","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_CBRNGearActivate","revid":309653,"updated":"2022-05-05T12:07:59Z","groups":["Modules - CBRN","Broken Functions"],"status":"broken","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Activates a specific piece of CBRN gear for a character entity.\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0, param1] call BIN_fnc_CBRNGearActivate","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"character entity to activate CBRN gear for","text":"0: OBJECT - character entity to activate CBRN gear for","source":"docblock"},{"name":"param1","type":"String","type_expr":"String","description":"CBRN gear class name to activate","text":"1: STRING - CBRN gear class name to activate","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","text":"BOOL","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nActivates a specific piece of CBRN gear for a character entity.\nNOTE: Module / function set not robust nor completed - not recommended for usage at this stage!\n\nParameter(s):\n    0: OBJECT - character entity to activate CBRN gear for\n    1: STRING - CBRN gear class name to activate\n\nReturns:\nBOOL"},"filled_from_docblock":["params","syntax","returns","description"]},{"name":"BIN_fnc_CBRNGearDeactivate","title":"BIN fnc CBRNGearDeactivate","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_CBRNGearDeactivate","revid":309544,"updated":"2022-05-05T12:06:59Z","groups":["Modules - CBRN","Broken Functions"],"status":"broken","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Deactivates a specific piece of CBRN gear for a character entity.\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0, param1] call BIN_fnc_CBRNGearDeactivate","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"character entity to deactivate CBRN gear for","text":"0: OBJECT - character entity to deactivate CBRN gear for","source":"docblock"},{"name":"param1","type":"String","type_expr":"String","description":"CBRN gear class name to deactivate","text":"1: STRING - CBRN gear class name to deactivate","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","text":"BOOL","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nDeactivates a specific piece of CBRN gear for a character entity.\nNOTE: Module / function set not robust nor completed - not recommended for usage at this stage!\n\nParameter(s):\n    0: OBJECT - character entity to deactivate CBRN gear for\n    1: STRING - CBRN gear class name to deactivate\n\nReturns:\nBOOL"},"filled_from_docblock":["params","syntax","returns","description"]},{"name":"BIN_fnc_CBRNGearUpdate","title":"BIN fnc CBRNGearUpdate","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_CBRNGearUpdate","revid":309660,"updated":"2022-05-05T12:08:16Z","groups":["Modules - CBRN","Broken Functions"],"status":"broken","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Processes CBRN gear updates on a specific character entity.\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0, param1] call BIN_fnc_CBRNGearUpdate","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"character entity to process CBRN gear for","text":"0: OBJECT - character entity to process CBRN gear for","source":"docblock"},{"name":"param1","type":"String","type_expr":"String","description":"CBRN gear class name to process","text":"1: STRING - CBRN gear class name to process","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","text":"BOOL","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nProcesses CBRN gear updates on a specific character entity.\nNOTE: Module / function set not robust nor completed - not recommended for usage at this stage!\n\nParameter(s):\n    0: OBJECT - character entity to process CBRN gear for\n    1: STRING - CBRN gear class name to process\n\nReturns:\nBOOL"},"filled_from_docblock":["params","syntax","returns","description"]},{"name":"BIN_fnc_CBRNHoseInit","title":"BIN fnc CBRNHoseInit","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_CBRNHoseInit","revid":363924,"updated":"2024-04-26T21:29:40Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","locality":{"argument":"local","effect":"local"},"description":"Initialises CBRN Hose for given unit.","syntaxes":[{"syntax":"[unit] call BIN_fnc_CBRNHoseInit","params":[{"name":"unit","type":"Object","description":"unit","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["player call BIN_fnc_CBRNHoseInit;"]}],"see_also":["Arma 3: CBRN"]},{"name":"BIN_fnc_CBRNInContaminant","title":"BIN fnc CBRNInContaminant","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_CBRNInContaminant","revid":309463,"updated":"2022-05-05T12:06:09Z","groups":["Modules - CBRN","Broken Functions"],"status":"broken","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Returns whether or not a character entity is within a CBRN contaminated area.\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0] call BIN_fnc_CBRNInContaminant","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"character entity to test for","text":"0: OBJECT - character entity to test for","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","text":"BOOL","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nReturns whether or not a character entity is within a CBRN contaminated area.\nNOTE: Module / function set not robust nor completed - not recommended for usage at this stage!\n\nParameter(s):\n    0: OBJECT - character entity to test for\n\nReturns:\nBOOL"},"filled_from_docblock":["params","syntax","returns","description"]},{"name":"BIN_fnc_circleSmokeMissile","title":"BIN fnc circleSmokeMissile","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_circleSmokeMissile","revid":309557,"updated":"2022-05-05T12:07:06Z","groups":["Effects"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_circleSmokeMissile"}},{"name":"BIN_fnc_clearIDWMap","title":"BIN fnc clearIDWMap","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_clearIDWMap","revid":309571,"updated":"2022-05-05T12:07:12Z","groups":["IDWMap"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Clears IDWMap on the main map\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if EH existed and was removed","text":"BOOL - true if EH existed and was removed","source":"docblock"}}],"examples":[{"code":["call BIN_fnc_clearIDWMap"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Clears IDWMap on the main map\n\nParameter(s):\n    NONE\n\nReturns:\n    BOOL - true if EH existed and was removed\n\nExample:\n    call BIN_fnc_clearIDWMap","author":"Killzone_Kid"},"filled_from_docblock":["returns","examples","description"]},{"name":"BIN_fnc_clearTXScan","title":"BIN fnc clearTXScan","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_clearTXScan","revid":309584,"updated":"2022-05-05T12:07:20Z","groups":["TXScan"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Clears TXScan drawing\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0] call BIN_fnc_clearTXScan","params":[{"name":"param0","type":"String","type_expr":"String","description":"scan name, \"\" - all scans","text":"0: STRING - scan name, \"\" - all scans","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"false if error occured","text":"BOOL - false if error occured","source":"docblock"},"inferred":true}],"examples":[{"code":["\"MyScan\" call BIN_fnc_clearTXScan\n\"\" call BIN_fnc_clearTXScan - all scans"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Clears TXScan drawing\n\nParameter(s):\n    0: STRING - scan name, \"\" - all scans\n\nReturns:\n    BOOL - false if error occured\n\nExample:\n    \"MyScan\" call BIN_fnc_clearTXScan\n    \"\" call BIN_fnc_clearTXScan - all scans","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_colorHSLtoRGB","title":"BIN fnc colorHSLtoRGB","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_colorHSLtoRGB","revid":338046,"updated":"2023-02-23T21:14:59Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Converts [HSL colour format](https://en.wikipedia.org/wiki/HSL_and_HSV) to RGB.\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[hue, saturation, lightness] call BIN_fnc_colorHSLtoRGB","params":[{"name":"hue","type":"Number","optional":true,"default":"0","type_expr":"Number","text":"hue: Number - (Optional, default 0)"},{"name":"saturation","type":"Number","optional":true,"default":"0","type_expr":"Number","text":"saturation: Number - (Optional, default 0)"},{"name":"lightness","type":"Number","optional":true,"default":"0","type_expr":"Number","text":"lightness: Number - (Optional, default 0)"}],"returns":{"type":"Array of Numbers","type_expr":"Array<Number>","description":"to format [R, G, B]"}}],"examples":[{"code":["private _rgb = [0, 100, 50] call BIN_fnc_colorHSLtoRGB;"]}],"see_also":["BIS_fnc_colorRGBtoHTML"]},{"name":"BIN_fnc_crearAllData","title":"BIN fnc crearAllData","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_crearAllData","revid":309657,"updated":"2022-05-05T12:08:09Z","groups":["Collisions"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"This function contains no code.\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[] call BIN_fnc_crearAllData","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"code":["[] call BIN_fnc_crearAllData;"]}]},{"name":"BIN_fnc_createScriptedSoundSource","title":"BIN fnc createScriptedSoundSource","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_createScriptedSoundSource","revid":378183,"updated":"2026-03-09T19:47:13Z","groups":["Sound","Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_createScriptedSoundSourceVehicle","title":"BIN fnc createScriptedSoundSourceVehicle","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_createScriptedSoundSourceVehicle","revid":309672,"updated":"2022-05-05T12:08:29Z","groups":["Sound","Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_createTXScan","title":"BIN fnc createTXScan","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_createTXScan","revid":309609,"updated":"2022-05-05T12:07:40Z","groups":["TXScan"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Creates a scan with the name defined as class in CfgTXScans or from given params. If name doesn't exists in config and params are not provided, default scan is created which could be tweaked later\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0, param0, param1, param2, param3, param4] call BIN_fnc_createTXScan","params":[{"name":"param0","type":"String","type_expr":"String","description":"\"\" create every scan from config\nor","text":"0: STRING - \"\" create every scan from config\nor","source":"docblock"},{"name":"param0","type":"String","type_expr":"String","description":"scan name","text":"0: STRING - scan name","source":"docblock"},{"name":"param1","type":"Array","type_expr":"Array","optional":true,"description":"TX position","text":"1: ARRAY (Optional) - TX position","source":"docblock"},{"name":"param2","type":"Number","type_expr":"Number","optional":true,"description":"scan angle","text":"2: NUMBER (Optional) - scan angle","source":"docblock"},{"name":"param3","type":"Number","type_expr":"Number","optional":true,"description":"scan precision","text":"3: NUMBER (Optional) - scan precision","source":"docblock"},{"name":"param4","type":"Array","type_expr":"Array","optional":true,"description":"scan polygon","text":"4: ARRAY (Optional) - scan polygon","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"false on error","text":"BOOL - false on error","source":"docblock"},"inferred":true}],"examples":[{"code":["\"MyScan\" call BIN_fnc_createTXScan\n\"\" call BIN_fnc_createTXScan - creates every scan from config\n[\"MyScan\", [1,2,3], 20, 0.1] call BIN_fnc_createTXScan - creates every scan from config"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Creates a scan with the name defined as class in CfgTXScans or from given params.\n    If name doesn't exists in config and params are not provided, default scan is created which could be tweaked later\n\nParameter(s):\n    0: STRING - \"\" create every scan from config\n    or\n    0: STRING - scan name\n    1: ARRAY (Optional) - TX position\n    2: NUMBER (Optional) - scan angle\n    3: NUMBER (Optional) - scan precision\n    4: ARRAY (Optional) - scan polygon\n\nReturns:\n    BOOL - false on error\n\nExamples:\n    \"MyScan\" call BIN_fnc_createTXScan\n    \"\" call BIN_fnc_createTXScan - creates every scan from config\n    [\"MyScan\", [1,2,3], 20, 0.1] call BIN_fnc_createTXScan - creates every scan from config","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_cropTXScan","title":"BIN fnc cropTXScan","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_cropTXScan","revid":309491,"updated":"2022-05-05T12:06:22Z","groups":["TXScan"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Crops given scan\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0, param1, param2, param3, param4] call BIN_fnc_cropTXScan","params":[{"name":"param0","type":"String","type_expr":"String","description":"scan name","text":"0: STRING - scan name","source":"docblock"},{"name":"param1","type":"Number","type_expr":"Number","description":"crop rectangle center X","text":"1: NUMBER - crop rectangle center X","source":"docblock"},{"name":"param2","type":"Number","type_expr":"Number","description":"crop rectangle center Y","text":"2: NUMBER - crop rectangle center Y","source":"docblock"},{"name":"param3","type":"Number","type_expr":"Number","description":"crop rectangle center W","text":"3: NUMBER - crop rectangle center W","source":"docblock"},{"name":"param4","type":"Number","type_expr":"Number","description":"crop rectangle center H","text":"4: NUMBER - crop rectangle center H","source":"docblock"}],"returns":{"type":"Array","type_expr":"Array","description":"crop rectangle corners","text":"ARRAY - crop rectangle corners","source":"docblock"},"inferred":true}],"examples":[{"code":["[\"MyScan\", 100, 100, 1000, 500] call BIN_fnc_cropTXScan"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Crops given scan\n\nParameter(s):\n    0: STRING - scan name\n    1: NUMBER - crop rectangle center X\n    2: NUMBER - crop rectangle center Y\n    3: NUMBER - crop rectangle center W\n    4: NUMBER - crop rectangle center H\n\nReturns:\n    ARRAY - crop rectangle corners\n\nExample:\n    [\"MyScan\", 100, 100, 1000, 500] call BIN_fnc_cropTXScan","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_curatorInit","title":"BIN fnc curatorInit","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_curatorInit","revid":309467,"updated":"2022-05-05T12:06:11Z","groups":["Movement"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_debugDraw","title":"BIN fnc debugDraw","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_debugDraw","revid":309598,"updated":"2022-05-05T12:07:29Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_debugDrawMapInit","title":"BIN fnc debugDrawMapInit","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_debugDrawMapInit","revid":309474,"updated":"2022-05-05T12:06:13Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_debugQuests","title":"BIN fnc debugQuests","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_debugQuests","revid":309649,"updated":"2022-05-05T12:07:59Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_debugText","title":"BIN fnc debugText","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_debugText","revid":309556,"updated":"2022-05-05T12:07:05Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_deconShowerAnim","title":"BIN fnc deconShowerAnim","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_deconShowerAnim","revid":309530,"updated":"2022-05-05T12:06:49Z","groups":["Decon Shower"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_deconShowerAnim"}},{"name":"BIN_fnc_deconShowerAnimLarge","title":"BIN fnc deconShowerAnimLarge","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_deconShowerAnimLarge","revid":309586,"updated":"2022-05-05T12:07:25Z","groups":["Decon Shower"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_deconShowerAnimLarge"}},{"name":"BIN_fnc_deconShowerAnimStop","title":"BIN fnc deconShowerAnimStop","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_deconShowerAnimStop","revid":309591,"updated":"2022-05-05T12:07:27Z","groups":["Decon Shower"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"BIN_fnc_deconShowerAnimStop Delete all sound sources attachted to decon shower in case it is destroyed or deleted","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_deconShowerAnimStop\nDelete all sound sources attachted to decon shower in case it is destroyed or deleted"},"filled_from_docblock":["description"]},{"name":"BIN_fnc_deconShowerCollision","title":"BIN fnc deconShowerCollision","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_deconShowerCollision","revid":309507,"updated":"2022-05-05T12:06:33Z","groups":["Decon Shower"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_deconShowerCollision"}},{"name":"BIN_fnc_deconShowerDelete","title":"BIN fnc deconShowerDelete","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_deconShowerDelete","revid":309590,"updated":"2022-05-05T12:07:27Z","groups":["Decon Shower"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"BIN_fnc_deconShowerDelete Delete all sound sources attachted to decon shower in case it is destroyed or deleted","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_deconShowerDelete\nDelete all sound sources attachted to decon shower in case it is destroyed or deleted"},"filled_from_docblock":["description"]},{"name":"BIN_fnc_deconShowerMove","title":"BIN fnc deconShowerMove","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_deconShowerMove","revid":309614,"updated":"2022-05-05T12:07:43Z","groups":["Decon Shower"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_deconShowerMove"}},{"name":"BIN_fnc_deleteAntenna","title":"BIN fnc deleteAntenna","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_deleteAntenna","revid":309554,"updated":"2022-05-05T12:07:05Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_deleteDangerZone","title":"BIN fnc deleteDangerZone","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_deleteDangerZone","revid":309694,"updated":"2022-05-05T12:08:50Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_deleteDiaryRecord","title":"BIN fnc deleteDiaryRecord","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_deleteDiaryRecord","revid":309663,"updated":"2022-05-05T12:08:21Z","groups":["Diary"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_deleteFaradayCage","title":"BIN fnc deleteFaradayCage","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_deleteFaradayCage","revid":309475,"updated":"2022-05-05T12:06:13Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_deleteLoopedRadioSignal","title":"BIN fnc deleteLoopedRadioSignal","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_deleteLoopedRadioSignal","revid":309670,"updated":"2022-05-05T12:08:26Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_deleteSignal","title":"BIN fnc deleteSignal","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_deleteSignal","revid":309500,"updated":"2022-05-05T12:06:26Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_deleteSpectrumAnalyzer","title":"BIN fnc deleteSpectrumAnalyzer","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_deleteSpectrumAnalyzer","revid":309470,"updated":"2022-05-05T12:06:11Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_deleteTravelPoint","title":"BIN fnc deleteTravelPoint","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_deleteTravelPoint","revid":309509,"updated":"2022-05-05T12:06:35Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_deleteTXScan","title":"BIN fnc deleteTXScan","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_deleteTXScan","revid":309647,"updated":"2022-05-05T12:07:58Z","groups":["TXScan"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Deletes scan with given name from extension and the map\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0] call BIN_fnc_deleteTXScan","params":[{"name":"param0","type":"String","type_expr":"String","description":"TXScan name","text":"0: STRING - TXScan name","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"false on error","text":"BOOL - false on error","source":"docblock"},"inferred":true}],"examples":[{"code":["\"MyScan\" call BIN_fnc_deleteTXScan"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Deletes scan with given name from extension and the map\n\nParameter(s):\n    0: STRING - TXScan name\n\nReturns:\n    BOOL - false on error\n\nExample:\n    \"MyScan\" call BIN_fnc_deleteTXScan","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_diag_addAllSpectrumAnalyzers","title":"BIN fnc diag addAllSpectrumAnalyzers","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_diag_addAllSpectrumAnalyzers","revid":309473,"updated":"2022-05-05T12:06:12Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_diag_drawAllAreaObjectsBounds","title":"BIN fnc diag drawAllAreaObjectsBounds","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_diag_drawAllAreaObjectsBounds","revid":309564,"updated":"2022-05-05T12:07:10Z","groups":["Collisions"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Draws all area objects bounds\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0] call BIN_fnc_diag_drawAllAreaObjectsBounds","params":[{"name":"param0","type":"String","type_expr":"String","description":"area name","text":"0: STRING - area name","source":"docblock"}],"returns":{"type":"Number","type_expr":"Number","description":"event handler id","text":"NUMBER - event handler id","source":"docblock"},"inferred":true}],"examples":[{"code":["\"MyArea\" call BIN_fnc_diag_drawAllAreaObjectsBounds"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Draws all area objects bounds\n\nParameter(s):\n    0: STRING - area name\n\nReturns:\n    NUMBER - event handler id\n\nExample:\n    \"MyArea\" call BIN_fnc_diag_drawAllAreaObjectsBounds","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_diag_getAllAreaEntities","title":"BIN fnc diag getAllAreaEntities","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_diag_getAllAreaEntities","revid":309490,"updated":"2022-05-05T12:06:21Z","groups":["Collisions"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_diag_getAllAreaObjects","title":"BIN fnc diag getAllAreaObjects","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_diag_getAllAreaObjects","revid":309659,"updated":"2022-05-05T12:08:15Z","groups":["Collisions"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Returns stored area objects for diagnostics\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0, param1] call BIN_fnc_diag_getAllAreaObjects","params":[{"name":"param0","type":"String","type_expr":"String","description":"area name","text":"0: STRING - area name","source":"docblock"},{"name":"param1","type":"Number","type_expr":"Number","description":"multipart number","text":"1: NUMBER - multipart number","source":"docblock"}],"returns":{"type":"Array","type_expr":"Array","text":"ARRAY of arays in format [[posX,posY,posMinZ,posMaxZ,radius],...]","source":"docblock"},"inferred":true}],"examples":[{"code":["\"MyArea\" call BIN_fnc_diag_getAllAreaObjects"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Returns stored area objects for diagnostics\n\nParameter(s):\n    0: STRING - area name\n    1: NUMBER - multipart number\n\nReturns:\n    ARRAY of arays in format [[posX,posY,posMinZ,posMaxZ,radius],...]\n\nExample:\n    \"MyArea\" call BIN_fnc_diag_getAllAreaObjects","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_diag_IDWMap","title":"BIN fnc diag IDWMap","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_diag_IDWMap","revid":309494,"updated":"2022-05-05T12:06:23Z","groups":["IDWMap"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Adds user action menu to the player with different IDWMap diag options\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0, param1] call BIN_fnc_diag_IDWMap","params":[{"name":"param0","type":"String","type_expr":"String","description":"command","text":"0: STRING - command","source":"docblock"},{"name":"param1","type":"Boolean","type_expr":"Boolean","optional":true,"description":"extended option","text":"1: BOOL (Optional) - extended option","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","text":"NOTHING","source":"docblock"},"inferred":true}],"examples":[{"code":["call BIN_fnc_diag_IDWMap"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Adds user action menu to the player with different IDWMap diag options\n\nParameter(s):\n    0: STRING - command\n    1: BOOL (Optional) - extended option\n\nReturns:\n    NOTHING\n\nExample:\n    call BIN_fnc_diag_IDWMap","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_diag_logAntenna","title":"BIN fnc diag logAntenna","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_diag_logAntenna","revid":309483,"updated":"2022-05-05T12:06:17Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_diag_revealAllAntennas","title":"BIN fnc diag revealAllAntennas","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_diag_revealAllAntennas","revid":309680,"updated":"2022-05-05T12:08:41Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_diag_showLinkBudgetMap","title":"BIN fnc diag showLinkBudgetMap","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_diag_showLinkBudgetMap","revid":309627,"updated":"2022-05-05T12:07:47Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_diag_TXScan","title":"BIN fnc diag TXScan","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_diag_TXScan","revid":309572,"updated":"2022-05-05T12:07:12Z","groups":["TXScan"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Adds user action menu to the player with different TXScan diag options\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0] call BIN_fnc_diag_TXScan","params":[{"name":"param0","type":"String","type_expr":"String","description":"command","text":"0: STRING - command","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","text":"NOTHING","source":"docblock"},"inferred":true}],"examples":[{"code":["call BIN_fnc_diag_TXScan"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Adds user action menu to the player with different TXScan diag options\n\nParameter(s):\n    0: STRING - command\n\nReturns:\n    NOTHING\n\nExample:\n    call BIN_fnc_diag_TXScan","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_distanceToAreaBorder","title":"BIN fnc distanceToAreaBorder","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_distanceToAreaBorder","revid":309550,"updated":"2022-05-05T12:07:01Z","groups":["Geometry"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_dockModule","title":"BIN fnc dockModule","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_dockModule","revid":309645,"updated":"2022-05-05T12:07:55Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_drawAntennas","title":"BIN fnc drawAntennas","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_drawAntennas","revid":309596,"updated":"2022-05-05T12:07:28Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_drawIconFixed","title":"BIN fnc drawIconFixed","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_drawIconFixed","revid":309619,"updated":"2022-05-05T12:07:45Z","groups":["Diary"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Set fixed size marker to be drawn in main map\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0, param1] call BIN_fnc_drawIconFixed","params":[{"name":"param0","type":"String","type_expr":"String","description":"unique marker ID","text":"0: STRING - unique marker ID","source":"docblock"},{"name":"param1","type":"Array, Boolean","type_expr":"Array | Boolean","description":"ARRAY - marker parameters in format used by drawIcon command\nBOOL - delete the marker","text":"1: ARRAY - marker parameters in format used by drawIcon command\nBOOL - delete the marker","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if successful","text":"BOOL - true if successful","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\n    Set fixed size marker to be drawn in main map\n\nParameter(s):\n    0: STRING - unique marker ID\n    1:\n        ARRAY - marker parameters in format used by drawIcon command\n        BOOL - delete the marker\n\nReturns:\n    BOOL - true if successful"},"filled_from_docblock":["params","syntax","returns","description"]},{"name":"BIN_fnc_drawIDWMap","title":"BIN fnc drawIDWMap","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_drawIDWMap","revid":309643,"updated":"2022-05-05T12:07:55Z","groups":["IDWMap"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Draws IDWMap on the main map\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true on success","text":"BOOL - true on success","source":"docblock"}}],"examples":[{"code":["call BIN_fnc_drawIDWMap"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Draws IDWMap on the main map\n\nParameter(s):\n    NONE\n\nReturns:\n    BOOL - true on success\n\nExample:\n    call BIN_fnc_drawIDWMap","author":"Killzone_Kid"},"filled_from_docblock":["returns","examples","description"]},{"name":"BIN_fnc_drawMap","title":"BIN fnc drawMap","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_drawMap","revid":309472,"updated":"2022-05-05T12:06:12Z","groups":["Diary"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_drawProbeMap","title":"BIN fnc drawProbeMap","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_drawProbeMap","revid":309666,"updated":"2022-05-05T12:08:24Z","groups":["Diary"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_drawSpectrum","title":"BIN fnc drawSpectrum","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_drawSpectrum","revid":309687,"updated":"2022-05-05T12:08:49Z","groups":["Diary"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_drawTooltip","title":"BIN fnc drawTooltip","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_drawTooltip","revid":309462,"updated":"2022-05-05T12:06:09Z","groups":["Diary"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_drawTXScan","title":"BIN fnc drawTXScan","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_drawTXScan","revid":309589,"updated":"2022-05-05T12:07:26Z","groups":["TXScan"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Draws TXScan with given name\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"arg call BIN_fnc_drawTXScan","params":[{"name":"arg","type":"String","type_expr":"String","description":"scan name or \"\" to draw all scans","text":"STRING - scan name or \"\" to draw all scans","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true on success","text":"BOOL - true on success","source":"docblock"},"inferred":true}],"examples":[{"code":["\"MyScan\" call BIN_fnc_drawTXScan\n\"\" call BIN_fnc_drawTXScan - draw all scans"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Draws TXScan with given name\n\nParameter(s):\n    STRING - scan name or \"\" to draw all scans\n\nReturns:\n    BOOL - true on success\n\nExample:\n    \"MyScan\" call BIN_fnc_drawTXScan\n    \"\" call BIN_fnc_drawTXScan - draw all scans","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_droneDestructionFX","title":"BIN fnc droneDestructionFX","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_droneDestructionFX","revid":309692,"updated":"2022-05-05T12:08:50Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_droneDestructionFX"}},{"name":"BIN_fnc_droneModuleDestruction","title":"BIN fnc droneModuleDestruction","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_droneModuleDestruction","revid":309478,"updated":"2022-05-05T12:06:14Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"BIN_fnc_droneModuleDestruction Alien Module destruction\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_droneModuleDestruction\nAlien Module destruction"},"filled_from_docblock":["description"]},{"name":"BIN_fnc_editMoveProperties","title":"BIN fnc editMoveProperties","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_editMoveProperties","revid":309622,"updated":"2022-05-05T12:07:46Z","groups":["Movement"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_empVehicle","title":"BIN fnc empVehicle","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_empVehicle","revid":350046,"updated":"2023-11-20T22:17:29Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Sets EMP parameters to a vehicle. Destroys lights and optionally prevents vehicle from starting\n\n> [!NOTE]\n> The player has to be defined as `BIN_player` for the voice lines to be spoken.\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[obj, destroyEngine, aiExit] call BIN_fnc_empVehicle","params":[{"name":"obj","type":"Object","description":"the vehicle","type_expr":"Object"},{"name":"destroyEngine","type":"Boolean","optional":true,"default":"true","description":"true to destroys the engine, false to have it working","type_expr":"Boolean","text":"destroyEngine: Boolean - (Optional, default true) true to destroys the engine, false to have it working"},{"name":"aiExit","type":"Boolean","optional":true,"default":"true","description":"AI behaviour in vehicle; true to make them exit the vehicle, false to remain in it","type_expr":"Boolean","text":"aiExit: Boolean - (Optional, default true) AI behaviour in vehicle; true to make them exit the vehicle, false to remain in it"}],"returns":null}],"examples":[{"code":["[_enemyVehicle, true, true] call BIN_fnc_empVehicle;"]}],"see_also":["setDamage","setHitPointDamage"]},{"name":"BIN_fnc_enableSaving","title":"BIN fnc enableSaving","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_enableSaving","revid":340303,"updated":"2023-04-28T23:03:28Z","groups":["Missions"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Sets a variable used in Arma 3 Contact which handles saving.\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[enableSaving, saveGame] call BIN_fnc_enableSaving","params":[{"name":"enableSaving","type":"Boolean","optional":true,"default":"true","description":"true to enable, false to disable","type_expr":"Boolean","text":"enableSaving: Boolean - (Optional, default true) true to enable, false to disable"},{"name":"saveGame","type":"Boolean","optional":true,"default":"false","description":"true to save, false to not disable","type_expr":"Boolean","text":"saveGame: Boolean - (Optional, default false) true to save, false to not disable"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[true, true] call BIN_fnc_enableSaving;"]}],"see_also":["BIN_fnc_savingEnabled","saveGame","loadGame"]},{"name":"BIN_fnc_eulerToVector","title":"BIN fnc eulerToVector","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_eulerToVector","revid":309548,"updated":"2022-05-05T12:07:00Z","groups":["Vectors","Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_exit","title":"BIN fnc exit","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_exit","revid":309460,"updated":"2022-05-05T12:06:08Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_exitAntennas","title":"BIN fnc exitAntennas","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_exitAntennas","revid":309541,"updated":"2022-05-05T12:06:57Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_exitDiary","title":"BIN fnc exitDiary","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_exitDiary","revid":309610,"updated":"2022-05-05T12:07:41Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_exitGroup","title":"BIN fnc exitGroup","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_exitGroup","revid":309654,"updated":"2022-05-05T12:08:02Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_exitPersistentObjects","title":"BIN fnc exitPersistentObjects","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_exitPersistentObjects","revid":309624,"updated":"2022-05-05T12:07:47Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_exitQuests","title":"BIN fnc exitQuests","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_exitQuests","revid":309477,"updated":"2022-05-05T12:06:13Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_exitSites","title":"BIN fnc exitSites","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_exitSites","revid":309546,"updated":"2022-05-05T12:07:00Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_exitTasks","title":"BIN fnc exitTasks","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_exitTasks","revid":309650,"updated":"2022-05-05T12:07:59Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_findNearestGrid","title":"BIN fnc findNearestGrid","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_findNearestGrid","revid":309688,"updated":"2022-05-05T12:08:49Z","groups":["Movement"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_findPath","title":"BIN fnc findPath","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_findPath","revid":309455,"updated":"2022-05-05T12:06:03Z","groups":["Movement"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"A* search algorithm. Uses hard-coded Manhattan distance to measure distance.\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0, param1, param2] call BIN_fnc_findPath","params":[{"name":"param0","type":"Array","type_expr":"Array<Array>","description":"0: NUMBER - node cost\n1: ARRAY - array of neighbor indexes\n2: ARRAY - XYZ position of the node, used to measure distance from end pos","text":"0: ARRAY of ARRAYs in format:\n0: NUMBER - node cost\n1: ARRAY - array of neighbor indexes\n2: ARRAY - XYZ position of the node, used to measure distance from end pos","source":"docblock"},{"name":"param1","type":"Number","type_expr":"Number","description":"index of starting point","text":"1: NUMBER - index of starting point","source":"docblock"},{"name":"param2","type":"Number","type_expr":"Number","description":"index of ending point","text":"2: NUMBER - index of ending point","source":"docblock"}],"returns":{"type":"Array, Number","type_expr":"Array<Number>","description":"indexes of nodes which are traversed on the way to the ending point","text":"ARRAY of NUMBERs - indexes of nodes which are traversed on the way to the ending point","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nA* search algorithm.\nUses hard-coded Manhattan distance to measure distance.\n\nParameter(s):\n    0: ARRAY of ARRAYs in format:\n        0: NUMBER - node cost\n        1: ARRAY - array of neighbor indexes\n        2: ARRAY - XYZ position of the node, used to measure distance from end pos\n    1: NUMBER - index of starting point\n    2: NUMBER - index of ending point\n\nReturns:\nARRAY of NUMBERs - indexes of nodes which are traversed on the way to the ending point"},"filled_from_docblock":["params","syntax","returns","description"]},{"name":"BIN_fnc_findSafePositions","title":"BIN fnc findSafePositions","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_findSafePositions","revid":309553,"updated":"2022-05-05T12:07:03Z","groups":["Behavior"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_findSafePositions"}},{"name":"BIN_fnc_findTargetWeight","title":"BIN fnc findTargetWeight","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_findTargetWeight","revid":309558,"updated":"2022-05-05T12:07:06Z","groups":["Behavior"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_findTargetWeight"}},{"name":"BIN_fnc_frequencyToString","title":"BIN fnc frequencyToString","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_frequencyToString","revid":363749,"updated":"2024-04-17T19:52:50Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Returns frequency as a string","syntaxes":[{"syntax":"[param0, param1, param2] call BIN_fnc_frequencyToString","params":[{"name":"param0","type":"Number, Array","type_expr":"Number | Array","description":"NUMBER - frequency in MHz, returned value is in format \"<value> <unit>\"\nARRAY in format [NUMBER,NUMBER] - frequency range in MHz, returned value is in format \"<value1> <unit1> - <value2> <unit2>\"","text":"0: NUMBER - frequency in MHz, returned value is in format \"<value> <unit>\"\nARRAY in format [NUMBER,NUMBER] - frequency range in MHz, returned value is in format \"<value1> <unit1> - <value2> <unit2>\"","source":"docblock"},{"name":"param1","type":"Number","type_expr":"Number","description":"order offset. When 0, frequency 1000 will return \"1 GHz\". When -1, returned value will be \"1000 MHz\"","text":"1: NUMBER - order offset. When 0, frequency 1000 will return \"1 GHz\". When -1, returned value will be \"1000 MHz\"","source":"docblock"},{"name":"param2","type":"Boolean","type_expr":"Boolean","description":"true if input values are in Hz, false if in MHz (standard across the game)","text":"2: BOOL - true if input values are in Hz, false if in MHz (standard across the game)","source":"docblock"}],"returns":{"type":"String","type_expr":"String","text":"STRING","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\n    Returns frequency as a string\n\nParameter(s):\n    0:\n        NUMBER - frequency in MHz, returned value is in format \"<value> <unit>\"\n        ARRAY in format [NUMBER,NUMBER] - frequency range in MHz, returned value is in format \"<value1> <unit1> - <value2> <unit2>\"\n    1: NUMBER - order offset. When 0, frequency 1000 will return \"1 GHz\". When -1, returned value will be \"1000 MHz\"\n    2: BOOL - true if input values are in Hz, false if in MHz (standard across the game)\n\nReturns:\n    STRING"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIN_fnc_getAISquadID","title":"BIN fnc getAISquadID","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getAISquadID","revid":309641,"updated":"2022-05-05T12:07:52Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getAISquadPosition","title":"BIN fnc getAISquadPosition","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getAISquadPosition","revid":309676,"updated":"2022-05-05T12:08:40Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getAllAISquads","title":"BIN fnc getAllAISquads","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getAllAISquads","revid":309607,"updated":"2022-05-05T12:07:40Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getAllAreas","title":"BIN fnc getAllAreas","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getAllAreas","revid":309560,"updated":"2022-05-05T12:07:06Z","groups":["Collisions"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getAllTXScans","title":"BIN fnc getAllTXScans","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getAllTXScans","revid":309634,"updated":"2022-05-05T12:07:51Z","groups":["TXScan"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Returns array of names of all TXScans stored in extension\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Array","type_expr":"Array","description":"scan names","text":"ARRAY - scan names","source":"docblock"}}],"examples":[{"code":["call BIN_fnc_getAllTXScans"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Returns array of names of all TXScans stored in extension\n\nParameter(s):\n    NONE\n\nReturns:\n    ARRAY - scan names\n\nExample:\n    call BIN_fnc_getAllTXScans","author":"Killzone_Kid"},"filled_from_docblock":["returns","examples","description"]},{"name":"BIN_fnc_getAntennaAngle","title":"BIN fnc getAntennaAngle","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getAntennaAngle","revid":309493,"updated":"2022-05-05T12:06:22Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getAntennaCanReveal","title":"BIN fnc getAntennaCanReveal","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getAntennaCanReveal","revid":309695,"updated":"2022-05-05T12:08:50Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getAntennaFrequency","title":"BIN fnc getAntennaFrequency","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getAntennaFrequency","revid":309454,"updated":"2022-05-05T12:06:03Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getAntennaFrequencyClass","title":"BIN fnc getAntennaFrequencyClass","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getAntennaFrequencyClass","revid":309528,"updated":"2022-05-05T12:06:48Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getAntennaGain","title":"BIN fnc getAntennaGain","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getAntennaGain","revid":309574,"updated":"2022-05-05T12:07:14Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getAntennaName","title":"BIN fnc getAntennaName","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getAntennaName","revid":309642,"updated":"2022-05-05T12:07:53Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getAntennaObject","title":"BIN fnc getAntennaObject","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getAntennaObject","revid":309601,"updated":"2022-05-05T12:07:29Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getAntennaPower","title":"BIN fnc getAntennaPower","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getAntennaPower","revid":309504,"updated":"2022-05-05T12:06:32Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getAntennaRevealValue","title":"BIN fnc getAntennaRevealValue","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getAntennaRevealValue","revid":309503,"updated":"2022-05-05T12:06:32Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getAntennas","title":"BIN fnc getAntennas","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getAntennas","revid":309469,"updated":"2022-05-05T12:06:11Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Get all antennas, transmitters and receivers alike\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0] call BIN_fnc_getAntennas","params":[{"name":"param0","type":"Boolean","type_expr":"Boolean","default":"false","description":"true to ignore player's antennas (default: false)","text":"0: BOOL - true to ignore player's antennas (default: false)","source":"docblock"}],"returns":{"type":"Array, String","type_expr":"Array<String>","description":"antenna IDs","text":"ARRAY of STRINGs - antenna IDs","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\n    Get all antennas, transmitters and receivers alike\n\nParameter(s):\n    0: BOOL - true to ignore player's antennas (default: false)\n\nReturns:\n    ARRAY of STRINGs - antenna IDs"},"filled_from_docblock":["params","syntax","returns","description"]},{"name":"BIN_fnc_getAntennaScanPolygon","title":"BIN fnc getAntennaScanPolygon","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getAntennaScanPolygon","revid":309674,"updated":"2022-05-05T12:08:33Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getAntennaScans","title":"BIN fnc getAntennaScans","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getAntennaScans","revid":309697,"updated":"2022-05-05T12:08:50Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getAntennaScanSignals","title":"BIN fnc getAntennaScanSignals","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getAntennaScanSignals","revid":309603,"updated":"2022-05-05T12:07:33Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getAntennaSensitivity","title":"BIN fnc getAntennaSensitivity","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getAntennaSensitivity","revid":309701,"updated":"2022-05-05T12:08:50Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getAntennaSignal","title":"BIN fnc getAntennaSignal","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getAntennaSignal","revid":309652,"updated":"2022-05-05T12:07:59Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getAntennaSignalHistory","title":"BIN fnc getAntennaSignalHistory","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getAntennaSignalHistory","revid":309658,"updated":"2022-05-05T12:08:11Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getAntennaType","title":"BIN fnc getAntennaType","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getAntennaType","revid":309577,"updated":"2022-05-05T12:07:17Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getBehaviorCoef","title":"BIN fnc getBehaviorCoef","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getBehaviorCoef","revid":309581,"updated":"2022-05-05T12:07:18Z","groups":["Behavior"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"BIN_fnc_getBehaviorCoef Get behavior coefficients\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}],"examples":[{"code":["[bin_drone,\"gravityCannon\"] call BIN_fnc_getBehaviorCoef - returns coefficients for gravity cannon behavior"]}],"docblock":{"text":"BIN_fnc_getBehaviorCoef\nGet behavior coefficients\n\nExamples:\n\n    [bin_drone,\"gravityCannon\"] call BIN_fnc_getBehaviorCoef - returns coefficients for gravity cannon behavior"},"filled_from_docblock":["examples","description"]},{"name":"BIN_fnc_getCharacterSounds","title":"BIN fnc getCharacterSounds","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getCharacterSounds","revid":309565,"updated":"2022-05-05T12:07:11Z","groups":["Sound","Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getCurrentSignal","title":"BIN fnc getCurrentSignal","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getCurrentSignal","revid":309580,"updated":"2022-05-05T12:07:18Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getEntityBoundingBarrel","title":"BIN fnc getEntityBoundingBarrel","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getEntityBoundingBarrel","revid":309679,"updated":"2022-05-05T12:08:40Z","groups":["Collisions"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getFollowingSignals","title":"BIN fnc getFollowingSignals","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getFollowingSignals","revid":309585,"updated":"2022-05-05T12:07:22Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Get signals which follow after given one.\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0] call BIN_fnc_getFollowingSignals","params":[{"name":"param0","type":"String","type_expr":"String","description":"signal class","text":"0: STRING - signal class","source":"docblock"}],"returns":{"type":"Array, String","type_expr":"Array<String>","text":"ARRAY of STRINGs (including input signal when it is not a link)","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\n    Get signals which follow after given one.\n\nParameter(s):\n    0: STRING - signal class\n\nReturns:\n    ARRAY of STRINGs (including input signal when it is not a link)"},"filled_from_docblock":["params","syntax","returns","description"]},{"name":"BIN_fnc_getFormattedControl","title":"BIN fnc getFormattedControl","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getFormattedControl","revid":309599,"updated":"2022-05-05T12:07:29Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Return a formatted string of a mapped control (same style as the Field Manual and Hints)\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0] call BIN_fnc_getFormattedControl","params":[{"name":"param0","type":"String","type_expr":"String","optional":true,"description":"name of the control action\n1 (Optional): SCALAR - 0-based index of the mapped control","text":"0: STRING - name of the control action\n1 (Optional): SCALAR - 0-based index of the mapped control","source":"docblock"}],"returns":{"type":"String","type_expr":"String","description":"formatted control","text":"STRING - formatted control","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nReturn a formatted string of a mapped control (same style as the Field Manual and Hints)\n\nParameter(s):\n    0: STRING - name of the control action\n    1 (Optional): SCALAR - 0-based index of the mapped control\n\nReturns:\nSTRING - formatted control"},"filled_from_docblock":["params","syntax","returns","description"]},{"name":"BIN_fnc_getGridCollisions","title":"BIN fnc getGridCollisions","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getGridCollisions","revid":363745,"updated":"2024-04-17T15:24:34Z","groups":["Movement"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"```\n#define BUSH_WIDTH        2\n#define BUSH_HEIGHT        2\n#define TREE_TRUNK_WIDTH    0.5\n#define TREE_TRUNK_HEIGHT    4\n\n#define GET_POS\\\n    private _pos = _x modelToWorld (boundingcenter _x vectormultiply -1);\n\n#define GET_BBOX\\\n    private _bbox = boundingboxreal _x;\\\n    private _bboxX = abs ((_bbox select 0 select 0) - (_bbox select 1 select 0)) / 2 + _cellSizeXHalf*0;\\\n    private _bboxY = abs ((_bbox select 0 select 1) - (_bbox select 1 select 1)) / 2 + _cellSizeYHalf*0;\\\n    private _bboxZ = abs ((_bbox select 0 select 2) - (_bbox select 1 select 2)) / 2 + _cellSizeZHalf*0;\n\n    //_bboxZ = (abs (_bbox select 0 select 2) + abs (_bbox select 1 select 2)) + _cellSizeZHalf*0;\n\n#define GET_BBOX_FIXED(SIZE)\\\n    private _bboxX = SIZE + _cellSizeXHalf;\\\n    private _bboxY = SIZE + _cellSizeYHalf;\\\n    private _bboxZ = SIZE + _cellSizeZHalf;\n```\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getGridMap","title":"BIN fnc getGridMap","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getGridMap","revid":309602,"updated":"2022-05-05T12:07:32Z","groups":["Movement"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getGridPath","title":"BIN fnc getGridPath","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getGridPath","revid":309551,"updated":"2022-05-05T12:07:02Z","groups":["Movement"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getGroupSeed","title":"BIN fnc getGroupSeed","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getGroupSeed","revid":309569,"updated":"2022-05-05T12:07:12Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getIDWMapDrawColorSet","title":"BIN fnc getIDWMapDrawColorSet","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getIDWMapDrawColorSet","revid":309685,"updated":"2022-05-05T12:08:49Z","groups":["IDWMap"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Gets stored draw colors\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Array","type_expr":"Array","description":"draw colors\nor\n[] on error","text":"ARRAY - draw colors\nor\n[] on error","source":"docblock"}}],"examples":[{"code":["call BIN_fnc_getIDWMapDrawColorSet"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Gets stored draw colors\n\nParameter(s):\n    NONE\n\nReturns:\n    ARRAY - draw colors\n    or\n    [] on error\n\nExample:\n    call BIN_fnc_getIDWMapDrawColorSet","author":"Killzone_Kid"},"filled_from_docblock":["returns","examples","description"]},{"name":"BIN_fnc_getIDWMapDrawPatternIndex","title":"BIN fnc getIDWMapDrawPatternIndex","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getIDWMapDrawPatternIndex","revid":309514,"updated":"2022-05-05T12:06:36Z","groups":["IDWMap"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Gets stored draw pattern index\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Number","type_expr":"Number","description":"draw pattern index (0..3)\nor\n-1 on error","text":"NUMBER - draw pattern index (0..3)\nor\n-1 on error","source":"docblock"}}],"examples":[{"code":["call BIN_fnc_getIDWMapDrawPatternIndex"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Gets stored draw pattern index\n\nParameter(s):\n    NONE\n\nReturns:\n    NUMBER - draw pattern index (0..3)\n    or\n    -1 on error\n\nExample:\n    call BIN_fnc_getIDWMapDrawPatternIndex","author":"Killzone_Kid"},"filled_from_docblock":["returns","examples","description"]},{"name":"BIN_fnc_getIDWMapParams","title":"BIN fnc getIDWMapParams","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getIDWMapParams","revid":309496,"updated":"2022-05-05T12:06:23Z","groups":["IDWMap"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Returns currently set IDWMap params\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Array","type_expr":"Array","text":"ARRAY in format: [[mapMinX, mapMinY, mapMaxX, mapMaxY], idwCellSize, idwSpreadRadius, idwSpreadPower, curvePointsInterval, curvePointSpreadRadius]\nor\n[] on error","source":"docblock"}}],"examples":[{"code":["call BIN_fnc_getIDWMapParams"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Returns currently set IDWMap params\n\nParameter(s):\n    NONE\n\nReturns:\n    ARRAY in format: [[mapMinX, mapMinY, mapMaxX, mapMaxY], idwCellSize, idwSpreadRadius, idwSpreadPower, curvePointsInterval, curvePointSpreadRadius]\n    or\n    [] on error\n\nExample:\n    call BIN_fnc_getIDWMapParams","author":"Killzone_Kid"},"filled_from_docblock":["returns","examples","description"]},{"name":"BIN_fnc_getIDWMapSaveData","title":"BIN fnc getIDWMapSaveData","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getIDWMapSaveData","revid":309516,"updated":"2022-05-05T12:06:41Z","groups":["IDWMap"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"```\n/*\n        Killzone_Kid\n\n    Description:\n        Returns array with IDWMap data which is used for saving/loading\n\n    Parameter(s):\n        NONE\n\n    Returns:\n        ARRAY - save data\n\n    Example:\n        call BIN_fnc_getIDWMapSaveData\n*/\n\n#define MAPDRAWPATTERNINDEX_DEFAULT 0\n#define MAPDRAWCOLORSET_DEFAULT [[0,0,0.514,0.7],[0,0,0.875,0.7],[0,0.247,1,0.7],[0,0.659,1,0.7],[0.035,1,0.961,0.7],[0.443,1,0.553,0.7],[0.843,1,0.153,0.7],[1,0.749,0,0.7],[1,0.357,0,0.7],[0.941,0,0,0.7],[0.522,0,0,0.7]]\n#define MAPDRAWIDC_DEFAULT 51\n\n// if the data was not yet set\n```\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getIDWMapStaticDataLayers","title":"BIN fnc getIDWMapStaticDataLayers","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getIDWMapStaticDataLayers","revid":309489,"updated":"2022-05-05T12:06:20Z","groups":["IDWMap"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Gets static data from extension\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Array","type_expr":"Array","text":"ARRAY in format:\n[\n    [[x,y,strengh],[x,y,strengh],...], // data layer 0\n    [[x,y,strengh],[x,y,strengh],...], // data layer 1\n    ...\n    [[x,y,strengh],[x,y,strengh],...] // data layer N\n]\nor\n[] - on error","source":"docblock"}}],"examples":[{"code":["call BIN_fnc_getIDWMapStaticDataLayers"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Gets static data from extension\n\nParameter(s):\n    NONE\n\nReturns:\n    ARRAY in format:\n    [\n        [[x,y,strengh],[x,y,strengh],...], // data layer 0\n        [[x,y,strengh],[x,y,strengh],...], // data layer 1\n        ...\n        [[x,y,strengh],[x,y,strengh],...] // data layer N\n    ]\n    or\n    [] - on error\n\n\nExample:\n    call BIN_fnc_getIDWMapStaticDataLayers","author":"Killzone_Kid"},"filled_from_docblock":["returns","examples","description"]},{"name":"BIN_fnc_getLinkBudget","title":"BIN fnc getLinkBudget","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getLinkBudget","revid":309578,"updated":"2022-05-05T12:07:17Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getLinkDir","title":"BIN fnc getLinkDir","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getLinkDir","revid":309600,"updated":"2022-05-05T12:07:29Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getLinkedAntennas","title":"BIN fnc getLinkedAntennas","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getLinkedAntennas","revid":275216,"updated":"2021-06-13T02:06:02Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getLinkStrength","title":"BIN fnc getLinkStrength","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getLinkStrength","revid":309699,"updated":"2022-05-05T12:08:50Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getObjectAntennas","title":"BIN fnc getObjectAntennas","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getObjectAntennas","revid":309646,"updated":"2022-05-05T12:07:56Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getObjectBoundingBarrel","title":"BIN fnc getObjectBoundingBarrel","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getObjectBoundingBarrel","revid":309563,"updated":"2022-05-05T12:07:08Z","groups":["Collisions"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Returns bounding barrel of the given object\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0] call BIN_fnc_getObjectBoundingBarrel","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"object to measure","text":"0: OBJECT - object to measure","source":"docblock"}],"returns":{"type":"Array, Object, Position","types":["Array","Object","Position"],"type_expr":"Array","text":"ARRAY in format [radius, height, offset]. Offset is negative if object Z position is higher than the lower bound","source":"docblock"},"inferred":true}],"examples":[{"code":["myObj call BIN_fnc_getObjectBoundingBarrel"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Returns bounding barrel of the given object\n\nParameter(s):\n    0: OBJECT - object to measure\n\nReturns:\n    ARRAY in format [radius, height, offset]. Offset is negative if object Z position is higher than the lower bound\n\nExample:\n    myObj call BIN_fnc_getObjectBoundingBarrel","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_getPatrolRoutes","title":"BIN fnc getPatrolRoutes","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getPatrolRoutes","revid":309698,"updated":"2022-05-05T12:08:50Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getRadioConversation","title":"BIN fnc getRadioConversation","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getRadioConversation","revid":309555,"updated":"2022-05-05T12:07:05Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getRecordedSignals","title":"BIN fnc getRecordedSignals","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getRecordedSignals","revid":309615,"updated":"2022-05-05T12:07:43Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getRoleIcon","title":"BIN fnc getRoleIcon","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getRoleIcon","revid":309620,"updated":"2022-05-05T12:07:45Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Get soldier's role icon (e.g., sniper, machine-gunner, etc.)\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0] call BIN_fnc_getRoleIcon","params":[{"name":"param0","type":"Object","type_expr":"Object","text":"0: OBJECT","source":"docblock"}],"returns":{"type":"String","type_expr":"String","description":"image path","text":"STRING - image path","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\n    Get soldier's role icon (e.g., sniper, machine-gunner, etc.)\n\nParameter(s):\n    0: OBJECT\n\nReturns:\n    STRING - image path"},"filled_from_docblock":["params","syntax","returns","description"]},{"name":"BIN_fnc_getRotation","title":"BIN fnc getRotation","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getRotation","revid":309524,"updated":"2022-05-05T12:06:44Z","groups":["Movement"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getSignalAge","title":"BIN fnc getSignalAge","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getSignalAge","revid":309575,"updated":"2022-05-05T12:07:15Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getSignalTypeClass","title":"BIN fnc getSignalTypeClass","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getSignalTypeClass","revid":309510,"updated":"2022-05-05T12:06:35Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getSignalTypes","title":"BIN fnc getSignalTypes","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getSignalTypes","revid":309579,"updated":"2022-05-05T12:07:17Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getSiteLayerEntities","title":"BIN fnc getSiteLayerEntities","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getSiteLayerEntities","revid":309456,"updated":"2022-05-05T12:06:06Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_getTerrainObjects","title":"BIN fnc getTerrainObjects","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getTerrainObjects","revid":309520,"updated":"2022-05-05T12:06:43Z","groups":["Collisions"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Returns terrain objects of the given type for the given area dimensions\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0, param1] call BIN_fnc_getTerrainObjects","params":[{"name":"param0","type":"Array","type_expr":"Array","description":"area details in Area format (see BIS_fnc_getArea)","text":"0: ARRAY - area details in Area format (see BIS_fnc_getArea)","source":"docblock"},{"name":"param1","type":"Array","type_expr":"Array","description":"types of terrain objects, for example [\"HOUSE\", \"TREE\"]","text":"1: ARRAY - types of terrain objects, for example [\"HOUSE\", \"TREE\"]","source":"docblock"}],"returns":{"type":"Array, Object","type_expr":"Array<Object>","text":"ARRAY of objects","source":"docblock"},"inferred":true}],"examples":[{"code":["[\"myArea\", [player, 100], [\"HOUSE\", \"TREE\"]] call BIN_fnc_getTerrainObjects"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Returns terrain objects of the given type for the given area dimensions\n\nParameter(s):\n    0: ARRAY - area details in Area format (see BIS_fnc_getArea)\n    1: ARRAY - types of terrain objects, for example [\"HOUSE\", \"TREE\"]\n\nReturns:\n    ARRAY of objects\n\nExample:\n    [\"myArea\", [player, 100], [\"HOUSE\", \"TREE\"]] call BIN_fnc_getTerrainObjects","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_getTXScanAngle","title":"BIN fnc getTXScanAngle","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getTXScanAngle","revid":309700,"updated":"2022-05-05T12:08:50Z","groups":["TXScan"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Returns TXScan angle\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0] call BIN_fnc_getTXScanAngle","params":[{"name":"param0","type":"String","type_expr":"String","description":"scan name","text":"0: STRING - scan name","source":"docblock"}],"returns":{"type":"Number","type_expr":"Number","description":"set cone angle or -1 on error","text":"NUMBER - set cone angle or -1 on error","source":"docblock"},"inferred":true}],"examples":[{"code":["\"MyScan\" call BIN_fnc_getTXScanAngle"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Returns TXScan angle\n\nParameter(s):\n    0: STRING - scan name\n\nReturns:\n    NUMBER - set cone angle or -1 on error\n\nExample:\n    \"MyScan\" call BIN_fnc_getTXScanAngle","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_getTXScanDrawData","title":"BIN fnc getTXScanDrawData","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getTXScanDrawData","revid":309486,"updated":"2022-05-05T12:06:18Z","groups":["TXScan"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Returns draw data for given TXScan\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0] call BIN_fnc_getTXScanDrawData","params":[{"name":"param0","type":"String","type_expr":"String","description":"scan name","text":"0: STRING - scan name","source":"docblock"}],"returns":{"type":"Array","type_expr":"Array","text":"ARRAY in format [iconData, polygonData, triangleData, rectangleData, isDefaultPolygon] where:\n    iconData: ARRAY - position in format [x,y,0]\n    polygonData: ARRAY - array of polygon vertices, where each vertex is in format [x,y,0]\n    triangleData: ARRAY - array of triangle vrtices, where each vertex is in format [x,y,0]\n    rectangleData: ARRAY - bounding rectangle in format [center, a, b, angle]\n    isDefaultPolygon: BOOL - if a scan polygon has not yet been calculated, this will be true","source":"docblock"},"inferred":true}],"examples":[{"code":["\"myScan\" call BIN_fnc_getTXScanDrawData"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Returns draw data for given TXScan\n\nParameter(s):\n    0: STRING - scan name\n\nReturns:\n    ARRAY in format [iconData, polygonData, triangleData, rectangleData, isDefaultPolygon] where:\n        iconData: ARRAY - position in format [x,y,0]\n        polygonData: ARRAY - array of polygon vertices, where each vertex is in format [x,y,0]\n        triangleData: ARRAY - array of triangle vrtices, where each vertex is in format [x,y,0]\n        rectangleData: ARRAY - bounding rectangle in format [center, a, b, angle]\n        isDefaultPolygon: BOOL - if a scan polygon has not yet been calculated, this will be true\n\nExample:\n    \"myScan\" call BIN_fnc_getTXScanDrawData","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_getTXScanPolygon","title":"BIN fnc getTXScanPolygon","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getTXScanPolygon","revid":309526,"updated":"2022-05-05T12:06:46Z","groups":["TXScan"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Returns current intersection polygon for given scan\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0] call BIN_fnc_getTXScanPolygon","params":[{"name":"param0","type":"String","type_expr":"String","description":"TXScan name","text":"0: STRING - TXScan name","source":"docblock"}],"returns":{"type":"Array","type_expr":"Array","description":"polygon points or [] on error","text":"ARRAY - polygon points or [] on error","source":"docblock"},"inferred":true}],"examples":[{"code":["\"MyScan\" call BIN_fnc_getTXScanPolygon"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Returns current intersection polygon for given scan\n\nParameter(s):\n    0: STRING - TXScan name\n\nReturns:\n    ARRAY - polygon points or [] on error\n\nExample:\n    \"MyScan\" call BIN_fnc_getTXScanPolygon","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_getTXScanPolygonDetails","title":"BIN fnc getTXScanPolygonDetails","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getTXScanPolygonDetails","revid":309576,"updated":"2022-05-05T12:07:16Z","groups":["TXScan"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Returns estimated area and perimeter of the given scan polygon\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0] call BIN_fnc_getTXScanPolygonDetails","params":[{"name":"param0","type":"String","type_expr":"String","description":"TXScan name","text":"0: STRING - TXScan name","source":"docblock"}],"returns":{"type":"Array","type_expr":"Array","text":"ARRAY in format [area, perimeter]","source":"docblock"},"inferred":true}],"examples":[{"code":["\"MyScan\" call BIN_fnc_getTXScanPolygonDetails"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Returns estimated area and perimeter of the given scan polygon\n\nParameter(s):\n    0: STRING - TXScan name\n\nReturns:\n    ARRAY in format [area, perimeter]\n\nExample:\n    \"MyScan\" call BIN_fnc_getTXScanPolygonDetails","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_getTXScanPosition","title":"BIN fnc getTXScanPosition","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getTXScanPosition","revid":309648,"updated":"2022-05-05T12:07:58Z","groups":["TXScan"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Gets stored TXScan transmitter position\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0] call BIN_fnc_getTXScanPosition","params":[{"name":"param0","type":"String","type_expr":"String","description":"scan name","text":"0: STRING - scan name","source":"docblock"}],"returns":{"type":"Array","type_expr":"Array","description":"set transmitter position or [] on error","text":"ARRAY - set transmitter position or [] on error","source":"docblock"},"inferred":true}],"examples":[{"code":["\"MyScan\" call BIN_fnc_setTXScanPosition"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Gets stored TXScan transmitter position\n\nParameter(s):\n    0: STRING - scan name\n\nReturns:\n    ARRAY - set transmitter position or [] on error\n\nExample:\n    \"MyScan\" call BIN_fnc_setTXScanPosition","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_getTXScanPrecision","title":"BIN fnc getTXScanPrecision","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getTXScanPrecision","revid":309656,"updated":"2022-05-05T12:08:04Z","groups":["TXScan"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Returns stored TXScan precision\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0] call BIN_fnc_getTXScanPrecision","params":[{"name":"param0","type":"String","type_expr":"String","description":"scan name","text":"0: STRING - scan name","source":"docblock"}],"returns":{"type":"Number","type_expr":"Number","description":"set cone precision or -1 on error","text":"NUMBER - set cone precision or -1 on error","source":"docblock"},"inferred":true}],"examples":[{"code":["\"MyScan\" call BIN_fnc_getTXScanPrecision"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Returns stored TXScan precision\n\nParameter(s):\n    0: STRING - scan name\n\nReturns:\n    NUMBER - set cone precision or -1 on error\n\nExample:\n    \"MyScan\" call BIN_fnc_getTXScanPrecision","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_getTXScanSaveData","title":"BIN fnc getTXScanSaveData","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getTXScanSaveData","revid":363748,"updated":"2024-04-17T15:24:36Z","groups":["TXScan"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Returns array with given TXScan data which is used for saving/loading\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0] call BIN_fnc_getTXScanSaveData","params":[{"name":"param0","type":"String","type_expr":"String","description":"TXScan name or \"\" to return all saved scan names","text":"0: STRING - TXScan name or \"\" to return all saved scan names","source":"docblock"}],"returns":{"type":"Array","type_expr":"Array","description":"save data for given scan name\nor if argument was \"\"\nARRAY in format [allscannames, activeareaboundaries]","text":"ARRAY - save data for given scan name\nor if argument was \"\"\nARRAY in format [allscannames, activeareaboundaries]","source":"docblock"},"inferred":true}],"examples":[{"code":["\"MyScan\" call BIN_fnc_getTXScanSaveData\n\"\" call BIN_fnc_getTXScanSaveData"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Returns array with given TXScan data which is used for saving/loading\n\nParameter(s):\n    0: STRING - TXScan name or \"\" to return all saved scan names\n\nReturns:\n    ARRAY - save data for given scan name\n    or if argument was \"\"\n    ARRAY in format [allscannames, activeareaboundaries]\n\nExample:\n    \"MyScan\" call BIN_fnc_getTXScanSaveData\n    \"\" call BIN_fnc_getTXScanSaveData","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_getTXScanWorldBounds","title":"BIN fnc getTXScanWorldBounds","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_getTXScanWorldBounds","revid":309635,"updated":"2022-05-05T12:07:51Z","groups":["TXScan"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Returns currently set boundaries of active area\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Array","type_expr":"Array","text":"ARRAY in format: [minX, minY, maxX, maxY]\nor\n[] on error","source":"docblock"}}],"examples":[{"code":["call BIN_fnc_getTXScanWorldBounds"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Returns currently set boundaries of active area\n\nParameter(s):\n    NONE\n\nReturns:\n    ARRAY in format: [minX, minY, maxX, maxY]\n    or\n    [] on error\n\nExample:\n    call BIN_fnc_getTXScanWorldBounds","author":"Killzone_Kid"},"filled_from_docblock":["returns","examples","description"]},{"name":"BIN_fnc_gravityBurst","title":"BIN fnc gravityBurst","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_gravityBurst","revid":309639,"updated":"2022-05-05T12:07:51Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_gravityCannon_01_ai","title":"BIN fnc gravityCannon 01 ai","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_gravityCannon_01_ai","revid":286102,"updated":"2021-06-20T17:25:48Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_gravityCannon_01_AI"}},{"name":"BIN_fnc_grenadeThrowback","title":"BIN fnc grenadeThrowback","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_grenadeThrowback","revid":309535,"updated":"2022-05-05T12:06:51Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_grenadeThrowback"}},{"name":"BIN_fnc_hackAIDrone","title":"BIN fnc hackAIDrone","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_hackAIDrone","revid":309484,"updated":"2022-05-05T12:06:18Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_handDrawBezier","title":"BIN fnc handDrawBezier","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_handDrawBezier","revid":309531,"updated":"2022-05-05T12:06:51Z","groups":["Diary"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Show hand-drawn bezier curve in the map\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0, param1, param2, param3, param4, param5, param6] call BIN_fnc_handDrawBezier","params":[{"name":"param0","type":"String","type_expr":"String","description":"Unique ID of the ellipse. When such ellipse already exists, it will override it.","text":"0: STRING - Unique ID of the ellipse. When such ellipse already exists, it will override it.","source":"docblock"},{"name":"param1","type":"Array","type_expr":"Array","description":"control points of bezier curve","text":"1: ARRAY - control points of bezier curve","source":"docblock"},{"name":"param2","type":"Array","type_expr":"Array","description":"color in [r,g,b,a] format","text":"2: ARRAY - color in [r,g,b,a] format","source":"docblock"},{"name":"param3","type":"String","type_expr":"String","optional":true,"default":"pen-blue color, false for the same, but faded","description":"fill texture\n   BOOL - true for default pen-blue color, false for the same, but faded\n\nOptional:","text":"3: STRING - fill texture\n   BOOL - true for default pen-blue color, false for the same, but faded\n\nOptional:","source":"docblock"},{"name":"param4","type":"Number, Array","type_expr":"Number | Array","text":"4: NUMBER or ARRAY: thickness","source":"docblock"},{"name":"param5","type":"Array","type_expr":"Array","description":"random thickness offset in format [min,mid,max]","text":"5: ARRAY - random thickness offset in format [min,mid,max]","source":"docblock"},{"name":"param6","type":"Number","type_expr":"Number","description":"number od drawing steps","text":"6: NUMBER - number od drawing steps","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","text":"NOTHING","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\n    Show hand-drawn bezier curve in the map\n\nParameter(s):\n    0: STRING - Unique ID of the ellipse. When such ellipse already exists, it will override it.\n    1: ARRAY - control points of bezier curve\n    2: ARRAY - color in [r,g,b,a] format\n    3: STRING - fill texture\n       BOOL - true for default pen-blue color, false for the same, but faded\n\n    Optional:\n    4: NUMBER or ARRAY: thickness\n    5: ARRAY - random thickness offset in format [min,mid,max]\n    6: NUMBER - number od drawing steps\n\nReturns:\n    NOTHING"},"filled_from_docblock":["params","syntax","returns","description"]},{"name":"BIN_fnc_handDrawEllipse","title":"BIN fnc handDrawEllipse","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_handDrawEllipse","revid":309651,"updated":"2022-05-05T12:07:59Z","groups":["Diary"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Show hand-drawn ellipse in the map\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0, param1, param2, param3, param4, param5, param6, param7, param8, param9, param10, param11, param12, param13, param14] call BIN_fnc_handDrawEllipse","params":[{"name":"param0","type":"String","type_expr":"String","description":"Unique ID of the ellipse. When such ellipse already exists, it will override it.","text":"0: STRING - Unique ID of the ellipse. When such ellipse already exists, it will override it.","source":"docblock"},{"name":"param1","type":"Array","type_expr":"Array","description":"center position","text":"1: ARRAY - center position","source":"docblock"},{"name":"param2","type":"Number","type_expr":"Number","description":"semi-major axis","text":"2: NUMBER - semi-major axis","source":"docblock"},{"name":"param3","type":"Number","type_expr":"Number","description":"semi-minor axis","text":"3: NUMBER - semi-minor axis","source":"docblock"},{"name":"param4","type":"Number","type_expr":"Number","description":"angle","text":"4: NUMBER - angle","source":"docblock"},{"name":"param5","type":"Array","type_expr":"Array","description":"color in [r,g,b,a] format","text":"5: ARRAY - color in [r,g,b,a] format","source":"docblock"},{"name":"param6","type":"String","type_expr":"String","optional":true,"default":"pen-blue color, false for the same, but faded","description":"fill texture\n   BOOL - true for default pen-blue color, false for the same, but faded\n\nOptional:","text":"6: STRING - fill texture\n   BOOL - true for default pen-blue color, false for the same, but faded\n\nOptional:","source":"docblock"},{"name":"param7","type":"Number","type_expr":"Number","description":"radius coef","text":"7: NUMBER - radius coef","source":"docblock"},{"name":"param8","type":"Number","type_expr":"Number","description":"length coef","text":"8: NUMBER - length coef","source":"docblock"},{"name":"param9","type":"Number, Array","type_expr":"Number | Array","text":"9: NUMBER or ARRAY: thickness","source":"docblock"},{"name":"param10","type":"Array","type_expr":"Array","description":"radius curve","text":"10: ARRAY - radius curve","source":"docblock"},{"name":"param11","type":"Boolean","type_expr":"Boolean","description":"true if clockwise","text":"11: BOOL - true if clockwise","source":"docblock"},{"name":"param12","type":"Number","type_expr":"Number","description":"starting angle","text":"12: NUMBER - starting angle","source":"docblock"},{"name":"param13","type":"Array","type_expr":"Array","description":"random thickness offset in format [min,mid,max]","text":"13: ARRAY - random thickness offset in format [min,mid,max]","source":"docblock"},{"name":"param14","type":"Number","type_expr":"Number","description":"number od drawing steps","text":"14: NUMBER - number od drawing steps","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","text":"NOTHING","source":"docblock"},"inferred":true}],"examples":[{"code":["//--- Show an ellipse on player's position\n[\"test1\",position player,300,400,15] call BIN_fnc_handDrawEllipse;"]},{"code":["//--- Show the same ellipse, but faded\n[\"test1\",position player,300,400,15,nil,false] call BIN_fnc_handDrawEllipse;"]}],"docblock":{"text":"Description:\n    Show hand-drawn ellipse in the map\n\nParameter(s):\n    0: STRING - Unique ID of the ellipse. When such ellipse already exists, it will override it.\n    1: ARRAY - center position\n    2: NUMBER - semi-major axis\n    3: NUMBER - semi-minor axis\n    4: NUMBER - angle\n    5: ARRAY - color in [r,g,b,a] format\n    6: STRING - fill texture\n       BOOL - true for default pen-blue color, false for the same, but faded\n\n    Optional:\n    7: NUMBER - radius coef\n    8: NUMBER - length coef\n    9: NUMBER or ARRAY: thickness\n    10: ARRAY - radius curve\n    11: BOOL - true if clockwise\n    12: NUMBER - starting angle\n    13: ARRAY - random thickness offset in format [min,mid,max]\n    14: NUMBER - number od drawing steps\n\nReturns:\n    NOTHING\n\nExamples:\n    //--- Show an ellipse on player's position\n    [\"test1\",position player,300,400,15] call BIN_fnc_handDrawEllipse;\n\n    //--- Show the same ellipse, but faded\n    [\"test1\",position player,300,400,15,nil,false] call BIN_fnc_handDrawEllipse;"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_hasAntennaSignal","title":"BIN fnc hasAntennaSignal","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_hasAntennaSignal","revid":309568,"updated":"2022-05-05T12:07:12Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_inDangerZone","title":"BIN fnc inDangerZone","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_inDangerZone","revid":309638,"updated":"2022-05-05T12:07:51Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_initAcctime","title":"BIN fnc initAcctime","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_initAcctime","revid":309625,"updated":"2022-05-05T12:07:47Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_initActors","title":"BIN fnc initActors","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_initActors","revid":309559,"updated":"2022-05-05T12:07:06Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_initAI","title":"BIN fnc initAI","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_initAI","revid":309479,"updated":"2022-05-05T12:06:15Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_initAIBase","title":"BIN fnc initAIBase","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_initAIBase","revid":309696,"updated":"2022-05-05T12:08:50Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_initAIDrone","title":"BIN fnc initAIDrone","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_initAIDrone","revid":309691,"updated":"2022-05-05T12:08:49Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_initAISquad","title":"BIN fnc initAISquad","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_initAISquad","revid":309539,"updated":"2022-05-05T12:06:56Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_initAntennas","title":"BIN fnc initAntennas","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_initAntennas","revid":309501,"updated":"2022-05-05T12:06:29Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_initConstants","title":"BIN fnc initConstants","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_initConstants","revid":309582,"updated":"2022-05-05T12:07:20Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_initCutLayers","title":"BIN fnc initCutLayers","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_initCutLayers","revid":309629,"updated":"2022-05-05T12:07:47Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"```\n//--- Register RSC layers in the correct order (they are not serialized)\n```\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_initDiary","title":"BIN fnc initDiary","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_initDiary","revid":309497,"updated":"2022-05-05T12:06:24Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_initDroneModule","title":"BIN fnc initDroneModule","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_initDroneModule","revid":309681,"updated":"2022-05-05T12:08:42Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_initDroneModule"}},{"name":"BIN_fnc_initGroup","title":"BIN fnc initGroup","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_initGroup","revid":309561,"updated":"2022-05-05T12:07:06Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"```\n#define DEBUG\n#define GROUP    (units player - [player])\n#define DAMAGE_COEF    0.25\n#define DIS_LIMIT_SOFT    400\n#define DIS_LIMIT_HARD    600\n```\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_initHub","title":"BIN fnc initHub","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_initHub","revid":309628,"updated":"2022-05-05T12:07:47Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_initInspectableDiaryRecord","title":"BIN fnc initInspectableDiaryRecord","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_initInspectableDiaryRecord","revid":309612,"updated":"2022-05-05T12:07:42Z","groups":["Diary"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_initInventory","title":"BIN fnc initInventory","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_initInventory","revid":309608,"updated":"2022-05-05T12:07:40Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"```\n//--- Ignored in missions without special description.ext property\n```\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_initLocations","title":"BIN fnc initLocations","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_initLocations","revid":309693,"updated":"2022-05-05T12:08:50Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_initMiniUGV","title":"BIN fnc initMiniUGV","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_initMiniUGV","revid":309511,"updated":"2022-05-05T12:06:35Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_initMothershipLights","title":"BIN fnc initMothershipLights","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_initMothershipLights","revid":309678,"updated":"2022-05-05T12:08:40Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Enable scripted ET Mothership lights on baked memory points Created lights can be retrieved via getVariable \"BIN_lights\" on the Mothership\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0] call BIN_fnc_initMothershipLights","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"Mothership","text":"0: OBJECT - Mothership","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","text":"NOTHING","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\n    Enable scripted ET Mothership lights on baked memory points\n    Created lights can be retrieved via getVariable \"BIN_lights\" on the Mothership\n\nParameter(s):\n    0: OBJECT - Mothership\n\nReturns:\n    NOTHING"},"filled_from_docblock":["params","syntax","returns","description"]},{"name":"BIN_fnc_initPersistentObjects","title":"BIN fnc initPersistentObjects","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_initPersistentObjects","revid":309640,"updated":"2022-05-05T12:07:51Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_initProbeMap","title":"BIN fnc initProbeMap","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_initProbeMap","revid":309517,"updated":"2022-05-05T12:06:41Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"```\n//--- Debug\n```\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_initPuzzle","title":"BIN fnc initPuzzle","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_initPuzzle","revid":309466,"updated":"2022-05-05T12:06:10Z","groups":["Puzzles"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_initQuests","title":"BIN fnc initQuests","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_initQuests","revid":309519,"updated":"2022-05-05T12:06:42Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_initRevive","title":"BIN fnc initRevive","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_initRevive","revid":363742,"updated":"2024-04-17T15:24:34Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"```\n#define BLEED_TIME        160\n#define BLINK_DELAY_MAX        20\n#define BLINK_TIME        0.75\n```\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_initSideColors","title":"BIN fnc initSideColors","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_initSideColors","revid":309502,"updated":"2022-05-05T12:06:32Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"```\n#define FORMAT \"Map_%1_%2\"\n```\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_initSites","title":"BIN fnc initSites","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_initSites","revid":376112,"updated":"2025-08-26T21:33:15Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"```sqf\n#define DEBUG\n#define AREA_BUFFER        +200\n#define DEF_RADIUS        500\n#define DEF_RADIUS_OUT    550\n#define AREA_DEF        [position _logic, DEF_RADIUS_OUT, DEF_RADIUS_OUT, 0, false]\n```\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_initTasks","title":"BIN fnc initTasks","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_initTasks","revid":364939,"updated":"2024-07-02T16:08:08Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"```\n//--- Obsolete, replace dby BIN_fnc_initQuests\n```\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_initTurret","title":"BIN fnc initTurret","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_initTurret","revid":309461,"updated":"2022-05-05T12:06:09Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_initUAV","title":"BIN fnc initUAV","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_initUAV","revid":309668,"updated":"2022-05-05T12:08:26Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_initUGV","title":"BIN fnc initUGV","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_initUGV","revid":309665,"updated":"2022-05-05T12:08:23Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_inList","title":"BIN fnc inList","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_inList","revid":309673,"updated":"2022-05-05T12:08:29Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_inRadioConversation","title":"BIN fnc inRadioConversation","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_inRadioConversation","revid":309604,"updated":"2022-05-05T12:07:33Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_inRadioConversationWith","title":"BIN fnc inRadioConversationWith","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_inRadioConversationWith","revid":309482,"updated":"2022-05-05T12:06:17Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_isAIBase","title":"BIN fnc isAIBase","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_isAIBase","revid":309537,"updated":"2022-05-05T12:06:53Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_isAntenna","title":"BIN fnc isAntenna","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_isAntenna","revid":309677,"updated":"2022-05-05T12:08:40Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_isAntennaBaked","title":"BIN fnc isAntennaBaked","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_isAntennaBaked","revid":309492,"updated":"2022-05-05T12:06:22Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_isAntennaBroadcasting","title":"BIN fnc isAntennaBroadcasting","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_isAntennaBroadcasting","revid":309562,"updated":"2022-05-05T12:07:08Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_isAntennaJammed","title":"BIN fnc isAntennaJammed","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_isAntennaJammed","revid":309588,"updated":"2022-05-05T12:07:26Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_isAntennaRevealed","title":"BIN fnc isAntennaRevealed","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_isAntennaRevealed","revid":309508,"updated":"2022-05-05T12:06:34Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_isAntennaSelected","title":"BIN fnc isAntennaSelected","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_isAntennaSelected","revid":309459,"updated":"2022-05-05T12:06:08Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_isExtensionError","title":"BIN fnc isExtensionError","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_isExtensionError","revid":379541,"updated":"2026-10-31T13:36:56Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Checks the output of the array syntax of callExtension for an error. If an error is found, it is reported with BIS_fnc_error and the function returns true.\n\n- If the error code (third element) is above 0, the engine reported an error; the reported message depends on the code:\n  - 101 - \"SYNTAX_ERROR_WRONG_PARAMS_SIZE\"\n  - 102 - \"SYNTAX_ERROR_WRONG_PARAMS_TYPE\"\n  - 201 - \"PARAMS_ERROR_TOO_MANY_ARGS\"\n  - 301 - \"EXECUTION_WARNING_TAKES_TOO_LONG\"\n  - any other code - \"UNKNOWN_ERROR\"\n- Otherwise, if the return code (second element) is negative, the extension itself reported an error and its output string is used as the error message (\"Generic Error\" if the string is empty).\n\nIf the input is not an array of format [String, Number, Number], the function returns false without reporting anything.\n\nContact functions use it after every call to their extensions, e.g. BIN_fnc_addObjectsToArea and BIN_fnc_getObjectBoundingBarrel (extension \"biext_collisions\") or BIN_fnc_preInitEM and BIN_fnc_deleteAntenna (extension \"biext_txscan\"). It works with the output of any extension and can be used in scripts as well.\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"extensionOutput call BIN_fnc_isExtensionError","params":[{"name":"extensionOutput","type":"Array","description":"output of `extensionName callExtension [function, arguments]`, format [result, returnCode, errorCode]:\n\n- result: String - output of the extension; on error it should contain the error description\n- returnCode: Number - return code set by the extension; a negative value means an error\n- errorCode: Number - error code set by the engine; a value above 0 means an error","type_expr":"Array"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if an error was detected (and reported), otherwise false"}}],"examples":[{"code":["private _result = \"biext_collisions\" callExtension [\"addObjectsToArea\", _args];\nif (_result call BIN_fnc_isExtensionError) exitWith { [0] }; // the error has already been reported\nparseSimpleArray (_result select 0);"]}],"see_also":["callExtension","BIS_fnc_error"]},{"name":"BIN_fnc_isNull","title":"BIN fnc isNull","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_isNull","revid":309636,"updated":"2022-05-05T12:07:51Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_isPaused","title":"BIN fnc isPaused","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_isPaused","revid":309488,"updated":"2022-05-05T12:06:20Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_isPausedInit","title":"BIN fnc isPausedInit","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_isPausedInit","revid":309613,"updated":"2022-05-05T12:07:42Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_isPuzzleReset","title":"BIN fnc isPuzzleReset","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_isPuzzleReset","revid":309458,"updated":"2022-05-05T12:06:06Z","groups":["Puzzles"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_isPuzzleTerminated","title":"BIN fnc isPuzzleTerminated","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_isPuzzleTerminated","revid":309573,"updated":"2022-05-05T12:07:14Z","groups":["Puzzles"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_isRadioHandshake","title":"BIN fnc isRadioHandshake","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_isRadioHandshake","revid":309655,"updated":"2022-05-05T12:08:04Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_isRadioSilence","title":"BIN fnc isRadioSilence","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_isRadioSilence","revid":309618,"updated":"2022-05-05T12:07:44Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_joinAISquad","title":"BIN fnc joinAISquad","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_joinAISquad","revid":309632,"updated":"2022-05-05T12:07:49Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_lightBurst","title":"BIN fnc lightBurst","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_lightBurst","revid":309552,"updated":"2022-05-05T12:07:02Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_list","title":"BIN fnc list","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_list","revid":309686,"updated":"2022-05-05T12:08:49Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_loadIDWMap","title":"BIN fnc loadIDWMap","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_loadIDWMap","revid":309593,"updated":"2022-05-05T12:07:27Z","groups":["IDWMap"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Loads IDWMap data from global variable 'BIN_fnc_IDWMap_saveData' into extension\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true on success","text":"BOOL - true on success","source":"docblock"}}],"examples":[{"code":["call BIN_fnc_loadIDWMap"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Loads IDWMap data from global variable 'BIN_fnc_IDWMap_saveData' into extension\n\nParameter(s):\n    NONE\n\nReturns:\n    BOOL - true on success\n\nExample:\n    call BIN_fnc_loadIDWMap","author":"Killzone_Kid"},"filled_from_docblock":["returns","examples","description"]},{"name":"BIN_fnc_loadTXScanState","title":"BIN fnc loadTXScanState","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_loadTXScanState","revid":309617,"updated":"2022-05-05T12:07:44Z","groups":["TXScan"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Loads TXScan data from global saved variables into extension\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true on success","text":"BOOL - true on success","source":"docblock"}}],"examples":[{"code":["call BIN_fnc_loadTXScanState"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Loads TXScan data from global saved variables into extension\n\nParameter(s):\n    NONE\n\nReturns:\n    BOOL - true on success\n\nExample:\n    call BIN_fnc_loadTXScanState","author":"Killzone_Kid"},"filled_from_docblock":["returns","examples","description"]},{"name":"BIN_fnc_markDangerZone","title":"BIN fnc markDangerZone","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_markDangerZone","revid":309621,"updated":"2022-05-05T12:07:45Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_markFreeAreaPositions","title":"BIN fnc markFreeAreaPositions","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_markFreeAreaPositions","revid":309566,"updated":"2022-05-05T12:07:12Z","groups":["Collisions"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Returns array of booleans in place of passed positions, where true is free and false is possible collision\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0, param1, param2] call BIN_fnc_markFreeAreaPositions","params":[{"name":"param0","type":"String","type_expr":"String","description":"area name","text":"0: STRING - area name","source":"docblock"},{"name":"param1","type":"Array","type_expr":"Array","description":"bounding barrel in format [radius, height, offset]","text":"1: ARRAY - bounding barrel in format [radius, height, offset]","source":"docblock"},{"name":"param2","type":"Array","type_expr":"Array","description":"arrays of positions","text":"2: ARRAY - arrays of positions","source":"docblock"}],"returns":{"type":"Array, Boolean","type_expr":"Array<Boolean>","text":"ARRAY of booleans","source":"docblock"},"inferred":true}],"examples":[{"code":["[\"myArea\", [10,5,0], [[123,123,123],[456,456,456],...]] call BIN_fnc_markFreeAreaPositions"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Returns array of booleans in place of passed positions, where true is free and false is possible collision\n\nParameter(s):\n    0: STRING - area name\n    1: ARRAY - bounding barrel in format [radius, height, offset]\n    2: ARRAY - arrays of positions\n\nReturns:\n    ARRAY of booleans\n\nExample:\n    [\"myArea\", [10,5,0], [[123,123,123],[456,456,456],...]] call BIN_fnc_markFreeAreaPositions","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_matrixMultiply","title":"BIN fnc matrixMultiply","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_matrixMultiply","revid":309664,"updated":"2022-05-05T12:08:23Z","groups":["Vectors","Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_matrixTranspose","title":"BIN fnc matrixTranspose","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_matrixTranspose","revid":309487,"updated":"2022-05-05T12:06:20Z","groups":["Vectors","Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_matterballDestruction","title":"BIN fnc matterballDestruction","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_matterballDestruction","revid":286089,"updated":"2021-06-20T17:25:32Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"BIN_fnc_matterBallDestruction Alien Module destruction\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_matterBallDestruction\nAlien Module destruction"},"filled_from_docblock":["description"]},{"name":"BIN_fnc_matterballEffects","title":"BIN fnc matterballEffects","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_matterballEffects","revid":286079,"updated":"2021-06-20T17:25:25Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"BIN_fnc_matterBallEffects\n\nAlien Matter Ball decaying effects\n\na: reyhard\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_matterBallEffects\n\nAlien Matter Ball decaying effects\n\na: reyhard"},"filled_from_docblock":["description"]},{"name":"BIN_fnc_matterCollectionFX","title":"BIN fnc matterCollectionFX","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_matterCollectionFX","revid":286081,"updated":"2021-06-20T17:25:26Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_matterCollectionFX"}},{"name":"BIN_fnc_missileDeflection","title":"BIN fnc missileDeflection","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_missileDeflection","revid":280978,"updated":"2021-06-14T08:58:51Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_missileSwarm","title":"BIN fnc missileSwarm","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_missileSwarm","revid":286064,"updated":"2021-06-20T17:25:05Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_missileSwarm"}},{"name":"BIN_fnc_moduleAntenna","title":"BIN fnc moduleAntenna","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_moduleAntenna","revid":280896,"updated":"2021-06-14T08:55:29Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_moduleCBRN","title":"BIN fnc moduleCBRN","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_moduleCBRN","revid":281109,"updated":"2021-06-14T09:00:57Z","groups":["Modules - CBRN"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Enables CBRN systems in a scenario (not MP-compatible!).\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Boolean","type_expr":"Boolean","text":"BOOL","source":"docblock"}}],"docblock":{"text":"Description:\nEnables CBRN systems in a scenario (not MP-compatible!).\nNOTE: Module / function set not robust nor completed - not recommended for usage at this stage!\n\nParameter(s):\n\nReturns:\nBOOL"},"filled_from_docblock":["returns","description"]},{"name":"BIN_fnc_moduleChargeSequence","title":"BIN fnc moduleChargeSequence","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_moduleChargeSequence","revid":281032,"updated":"2021-06-14T08:59:46Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_moduleDangerZone","title":"BIN fnc moduleDangerZone","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_moduleDangerZone","revid":364337,"updated":"2024-05-06T10:27:32Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"```\n#define AREA_BUFFER    +50\n```\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_moduleFaradayCage","title":"BIN fnc moduleFaradayCage","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_moduleFaradayCage","revid":280974,"updated":"2021-06-14T08:58:47Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_moduleGravityAnomaly","title":"BIN fnc moduleGravityAnomaly","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_moduleGravityAnomaly","revid":280908,"updated":"2021-06-14T08:56:05Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_moduleMovementGrid","title":"BIN fnc moduleMovementGrid","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_moduleMovementGrid","revid":272875,"updated":"2021-06-13T00:34:02Z","groups":["Movement"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_modulePointOfInterest","title":"BIN fnc modulePointOfInterest","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_modulePointOfInterest","revid":280940,"updated":"2021-06-14T08:57:59Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_moduleSimpleObject","title":"BIN fnc moduleSimpleObject","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_moduleSimpleObject","revid":281095,"updated":"2021-06-14T09:00:46Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_moduleTravel","title":"BIN fnc moduleTravel","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_moduleTravel","revid":281085,"updated":"2021-06-14T09:00:40Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_moveAI","title":"BIN fnc moveAI","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_moveAI","revid":281042,"updated":"2021-06-14T08:59:51Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_moveAIReinforcements","title":"BIN fnc moveAIReinforcements","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_moveAIReinforcements","revid":281102,"updated":"2021-06-14T09:00:51Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_moveInit","title":"BIN fnc moveInit","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_moveInit","revid":280973,"updated":"2021-06-14T08:58:47Z","groups":["Movement"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_moveModule","title":"BIN fnc moveModule","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_moveModule","revid":280953,"updated":"2021-06-14T08:58:16Z","groups":["Movement"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_moveObject","title":"BIN fnc moveObject","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_moveObject","revid":280993,"updated":"2021-06-14T08:59:09Z","groups":["Movement"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_moveTo","title":"BIN fnc moveTo","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_moveTo","revid":281020,"updated":"2021-06-14T08:59:30Z","groups":["Movement"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_moveToModelSpace","title":"BIN fnc moveToModelSpace","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_moveToModelSpace","revid":281078,"updated":"2021-06-14T09:00:29Z","groups":["Movement"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_moveToOnArc","title":"BIN fnc moveToOnArc","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_moveToOnArc","revid":286104,"updated":"2021-06-20T17:25:50Z","groups":["Movement"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_moveToOnArc"}},{"name":"BIN_fnc_onPuzzleCompleted","title":"BIN fnc onPuzzleCompleted","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_onPuzzleCompleted","revid":281200,"updated":"2021-06-14T09:05:59Z","groups":["Puzzles"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_onPuzzleProgress","title":"BIN fnc onPuzzleProgress","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_onPuzzleProgress","revid":281224,"updated":"2021-06-14T09:06:17Z","groups":["Puzzles"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_onPuzzleReset","title":"BIN fnc onPuzzleReset","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_onPuzzleReset","revid":281232,"updated":"2021-06-14T09:06:23Z","groups":["Puzzles"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_onPuzzleStepCompleted","title":"BIN fnc onPuzzleStepCompleted","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_onPuzzleStepCompleted","revid":281272,"updated":"2021-06-14T09:07:08Z","groups":["Puzzles"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_onPuzzleTerminated","title":"BIN fnc onPuzzleTerminated","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_onPuzzleTerminated","revid":281168,"updated":"2021-06-14T09:05:25Z","groups":["Puzzles"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_persistentVariables","title":"BIN fnc persistentVariables","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_persistentVariables","revid":364338,"updated":"2024-05-06T10:31:00Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_playAlternatingSound","title":"BIN fnc playAlternatingSound","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_playAlternatingSound","revid":281306,"updated":"2021-06-14T09:08:04Z","groups":["Sound","Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_playMission","title":"BIN fnc playMission","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_playMission","revid":364339,"updated":"2024-05-06T10:31:12Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"```\n//--- Disabled, campaign is now configured as traditional campaign\n```\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_playPatrolAnim","title":"BIN fnc playPatrolAnim","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_playPatrolAnim","revid":281150,"updated":"2021-06-14T09:05:02Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_playPatrolAnimDone","title":"BIN fnc playPatrolAnimDone","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_playPatrolAnimDone","revid":281222,"updated":"2021-06-14T09:06:17Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_postInit","title":"BIN fnc postInit","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_postInit","revid":281176,"updated":"2021-06-14T09:05:31Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_preInit","title":"BIN fnc preInit","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_preInit","revid":281193,"updated":"2021-06-14T09:05:49Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_preInitEM","title":"BIN fnc preInitEM","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_preInitEM","revid":281276,"updated":"2021-06-14T09:07:23Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_preInitIDWMap","title":"BIN fnc preInitIDWMap","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_preInitIDWMap","revid":281226,"updated":"2021-06-14T09:06:19Z","groups":["IDWMap"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Should be called from preInit, contains saving/loading functions as well as default initisalization\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0] call BIN_fnc_preInitIDWMap","params":[{"name":"param0","type":"String","type_expr":"String","description":"preInit pass through","text":"0: STRING - preInit pass through","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","text":"NOTHING","source":"docblock"},"inferred":true}],"examples":[{"code":["// from preinit script\ncall BIN_fnc_preInitIDWMap"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Should be called from preInit, contains saving/loading functions as well as default initisalization\n\nParameter(s):\n    0: STRING - preInit pass through\n\nReturns:\n    NOTHING\n\nExample:\n    // from preinit script\n    call BIN_fnc_preInitIDWMap","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_preInitTXScan","title":"BIN fnc preInitTXScan","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_preInitTXScan","revid":281151,"updated":"2021-06-14T09:05:04Z","groups":["TXScan"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Should be called from preInit, contains saving/loading functions as well as default initisalization\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0] call BIN_fnc_preInitTXScan","params":[{"name":"param0","type":"String","type_expr":"String","description":"\"preInit\"","text":"0: STRING - \"preInit\"","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","text":"NOTHING","source":"docblock"},"inferred":true}],"examples":[{"code":["// from preinit script\ncall BIN_fnc_preInitTXScan"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Should be called from preInit, contains saving/loading functions as well as default initisalization\n\nParameter(s):\n    0: STRING - \"preInit\"\n\nReturns:\n    NOTHING\n\nExample:\n    // from preinit script\n    call BIN_fnc_preInitTXScan","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_probeAnim","title":"BIN fnc probeAnim","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_probeAnim","revid":286095,"updated":"2021-06-20T17:25:40Z","groups":["Probe"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"BIN_fnc_probeAnim\n\nExample usage:\n    [probe,1] call BIN_fnc_probeAnim - expand probe core\n    [probe,0] call BIN_fnc_probeAnim - retract probe core\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_probeAnim\n\nExample usage:\n    [probe,1] call BIN_fnc_probeAnim - expand probe core\n    [probe,0] call BIN_fnc_probeAnim - retract probe core"},"filled_from_docblock":["description"]},{"name":"BIN_fnc_probeCoreDelete","title":"BIN fnc probeCoreDelete","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_probeCoreDelete","revid":281195,"updated":"2021-06-14T09:05:50Z","groups":["Probe"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_probeCoreEffects","title":"BIN fnc probeCoreEffects","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_probeCoreEffects","revid":286069,"updated":"2021-06-20T17:25:11Z","groups":["Probe"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"BIN_fnc_probeCoreEffects [probeCore] call BIN_fnc_probeCoreEffects\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_probeCoreEffects\n[probeCore] call BIN_fnc_probeCoreEffects"},"filled_from_docblock":["description"]},{"name":"BIN_fnc_probeCoreInit","title":"BIN fnc probeCoreInit","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_probeCoreInit","revid":281297,"updated":"2021-06-14T09:07:43Z","groups":["Probe"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_probeCoreLegsDestroyed","title":"BIN fnc probeCoreLegsDestroyed","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_probeCoreLegsDestroyed","revid":286037,"updated":"2021-06-20T17:24:40Z","groups":["Probe"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_probeCoreLegsDestroyed"}},{"name":"BIN_fnc_probeCoreUpdate","title":"BIN fnc probeCoreUpdate","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_probeCoreUpdate","revid":281268,"updated":"2021-06-14T09:07:01Z","groups":["Probe"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_probeDelete","title":"BIN fnc probeDelete","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_probeDelete","revid":286068,"updated":"2021-06-20T17:25:08Z","groups":["Probe"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_probeDelete"}},{"name":"BIN_fnc_probeHitpoint","title":"BIN fnc probeHitpoint","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_probeHitpoint","revid":286056,"updated":"2021-06-20T17:24:56Z","groups":["Probe"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"BIN_fnc_probeHitpoint\n\nSpawns particle effects & sound\n\nFunction is connected to probe hitpoint and can be also manually triggered via calling following code:\n     [cursorObject,1,true] call BIN_fnc_probeHitpoint - destroy hitpoint with index 1\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_probeHitpoint\n\nSpawns particle effects & sound\n\nFunction is connected to probe hitpoint and can be also manually triggered via calling following code:\n     [cursorObject,1,true] call BIN_fnc_probeHitpoint - destroy hitpoint with index 1"},"filled_from_docblock":["description"]},{"name":"BIN_fnc_probeVeinHitpoint","title":"BIN fnc probeVeinHitpoint","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_probeVeinHitpoint","revid":379542,"updated":"2026-10-31T13:38:06Z","groups":["Probe"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","exec":"spawn","description":"Reacts to a hit on a vein of the alien probe: the vein is retracted with BIN_fnc_probeAnim (retract sound, the looping sound fades out and is deleted), and after a delay it is expanded again (expand sound, a new looping sound is created).\nThe delay is 4 seconds by default and can be changed by setting the variable \"bin_probe_retractTime\" on the probe itself.\nThe function does nothing if the hit part index is -1.\n\nIts parameters match the Dammaged event handler, from which it is meant to be executed; no other Contact function calls it. As it uses sleep, it must run in a scheduled environment.\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[probe, selection, damage, hitIndex, hitPoint] spawn BIN_fnc_probeVeinHitpoint","params":[{"name":"probe","type":"Object","description":"the alien probe","type_expr":"Object"},{"name":"selection","type":"String","optional":true,"default":"\"\"","description":"name of the damaged selection; not used","type_expr":"String","text":"selection: String - (Optional, default \"\") name of the damaged selection; not used"},{"name":"damage","type":"Number","optional":true,"default":"0","description":"resulting damage; not used","type_expr":"Number","text":"damage: Number - (Optional, default 0) resulting damage; not used"},{"name":"hitIndex","type":"Number","optional":true,"default":"-1","description":"hit part index of the damaged hitpoint; the function exits if it is -1","type_expr":"Number","text":"hitIndex: Number - (Optional, default -1) hit part index of the damaged hitpoint; the function exits if it is -1"},{"name":"hitPoint","type":"String","optional":true,"default":"\"\"","description":"hitpoint name; not used","type_expr":"String","text":"hitPoint: String - (Optional, default \"\") hitpoint name; not used"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["myProbe setVariable [\"bin_probe_retractTime\", 10]; // keep the vein retracted for 10 seconds\nmyProbe addEventHandler [\"Dammaged\", { _this spawn BIN_fnc_probeVeinHitpoint }];"]}],"see_also":["BIN_fnc_probeAnim","BIN_fnc_probeHitpoint"]},{"name":"BIN_fnc_ProbingArm_fired","title":"BIN fnc ProbingArm fired","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_ProbingArm_fired","revid":309499,"updated":"2022-05-05T12:06:24Z","groups":["Probing"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_probingArm_fired"}},{"name":"BIN_fnc_ProbingBeam_fired","title":"BIN fnc ProbingBeam fired","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_ProbingBeam_fired","revid":309684,"updated":"2022-05-05T12:08:45Z","groups":["Probing"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_probingBeam_fired"}},{"name":"BIN_fnc_ProbingBeam_sendData","title":"BIN fnc ProbingBeam sendData","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_ProbingBeam_sendData","revid":309667,"updated":"2022-05-05T12:08:24Z","groups":["Probing"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIS_fnc_ProbingBeam_sendData"}},{"name":"BIN_fnc_prototypeCannon_01_ai","title":"BIN fnc prototypeCannon 01 ai","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_prototypeCannon_01_ai","revid":281335,"updated":"2021-06-14T09:08:33Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_prototypeCannon_01_player","title":"BIN fnc prototypeCannon 01 player","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_prototypeCannon_01_player","revid":364340,"updated":"2024-05-06T10:31:30Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_prototypeCannon_01_slaved","title":"BIN fnc prototypeCannon 01 slaved","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_prototypeCannon_01_slaved","revid":281235,"updated":"2021-06-14T09:06:26Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_puzzle_mole","title":"BIN fnc puzzle mole","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_puzzle_mole","revid":281234,"updated":"2021-06-14T09:06:25Z","groups":["Puzzles"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_puzzle_outlier","title":"BIN fnc puzzle outlier","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_puzzle_outlier","revid":281319,"updated":"2021-06-14T09:08:15Z","groups":["Puzzles"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_reactRadio","title":"BIN fnc reactRadio","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_reactRadio","revid":281365,"updated":"2021-06-14T09:09:18Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_reactRadio_Base","title":"BIN fnc reactRadio Base","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_reactRadio_Base","revid":281156,"updated":"2021-06-14T09:05:14Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_reactRadio_Player","title":"BIN fnc reactRadio Player","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_reactRadio_Player","revid":281328,"updated":"2021-06-14T09:08:23Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_reactRadio_Squad","title":"BIN fnc reactRadio Squad","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_reactRadio_Squad","revid":281275,"updated":"2021-06-14T09:07:22Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_recordSignal","title":"BIN fnc recordSignal","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_recordSignal","revid":281338,"updated":"2021-06-14T09:08:37Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Add signal to the library.\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0] call BIN_fnc_recordSignal","params":[{"name":"param0","type":"String","type_expr":"String","description":"antenna ID (its currently transmitted signal will be used) or signal class from CfgContact >> Signals","text":"0: STRING - antenna ID (its currently transmitted signal will be used) or signal class from CfgContact >> Signals","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if added","text":"BOOL - true if added","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\n    Add signal to the library.\n\nParameter(s):\n    0: STRING - antenna ID (its currently transmitted signal will be used) or signal class from CfgContact >> Signals\n\nReturns:\n    BOOL - true if added"},"filled_from_docblock":["params","syntax","returns","description"]},{"name":"BIN_fnc_resetPuzzle","title":"BIN fnc resetPuzzle","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_resetPuzzle","revid":281210,"updated":"2021-06-14T09:06:08Z","groups":["Puzzles"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_revealAntenna","title":"BIN fnc revealAntenna","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_revealAntenna","revid":281143,"updated":"2021-06-14T09:04:55Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_revealFrequency","title":"BIN fnc revealFrequency","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_revealFrequency","revid":281279,"updated":"2021-06-14T09:07:27Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_saveIDWMap","title":"BIN fnc saveIDWMap","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_saveIDWMap","revid":281213,"updated":"2021-06-14T09:06:09Z","groups":["IDWMap"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Saves IDWMap data into global variable 'BIN_fnc_IDWMap_saveData' so that it can be serialised and then loaded from game save when needed\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true on success","text":"BOOL - true on success","source":"docblock"}}],"examples":[{"code":["call BIN_fnc_saveIDWMap"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Saves IDWMap data into global variable 'BIN_fnc_IDWMap_saveData' so that it can be serialised and then loaded from game save when needed\n\nParameter(s):\n    NONE\n\nReturns:\n    BOOL - true on success\n\nExample:\n    call BIN_fnc_saveIDWMap","author":"Killzone_Kid"},"filled_from_docblock":["returns","examples","description"]},{"name":"BIN_fnc_saveTXScanState","title":"BIN fnc saveTXScanState","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_saveTXScanState","revid":281280,"updated":"2021-06-14T09:07:27Z","groups":["TXScan"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Saves TXScan data into global variables so that it can be serialised and then loaded from game save when needed\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true on success","text":"BOOL - true on success","source":"docblock"}}],"examples":[{"code":["call BIN_fnc_saveTXScanState"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Saves TXScan data into global variables so that it can be serialised and then loaded from game save when needed\n\nParameter(s):\n    NONE\n\nReturns:\n    BOOL - true on success\n\nExample:\n    call BIN_fnc_saveTXScanState","author":"Killzone_Kid"},"filled_from_docblock":["returns","examples","description"]},{"name":"BIN_fnc_savingEnabled","title":"BIN fnc savingEnabled","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_savingEnabled","revid":327697,"updated":"2022-07-13T10:12:50Z","groups":["Missions"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Returns the value of `missionNamespace getVariable [\"BIN_enableSaving\", true]`.\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"call BIN_fnc_savingEnabled","params":[],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["call BIN_fnc_savingEnabled == (missionNamespace getVariable [\"BIN_enableSaving\", true]); // true"]}],"see_also":["BIS_fnc_enableSaving","BIS_fnc_disableSaving","saveGame","loadGame"]},{"name":"BIN_fnc_scan","title":"BIN fnc scan","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_scan","revid":281381,"updated":"2021-06-14T09:09:35Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_scanObject","title":"BIN fnc scanObject","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_scanObject","revid":364341,"updated":"2024-05-06T10:33:49Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_scanTX","title":"BIN fnc scanTX","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_scanTX","revid":281199,"updated":"2021-06-14T09:05:55Z","groups":["TXScan"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Intersects current scan polygon (or map square if no scan exists) with triangle originated from RX position and returns the triangle\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0, param1] call BIN_fnc_scanTX","params":[{"name":"param0","type":"String","type_expr":"String","description":"scan name","text":"0: STRING - scan name","source":"docblock"},{"name":"param1","type":"Array","type_expr":"Array","optional":true,"default":"position player","description":"RX position. Default: position player","text":"1: ARRAY (Optional) - RX position. Default: position player","source":"docblock"}],"returns":{"type":"Array","type_expr":"Array","description":"triangle used for intersection","text":"ARRAY - triangle used for intersection","source":"docblock"},"inferred":true}],"examples":[{"code":["[\"MyScan\", position player] call BIN_fnc_scanTX"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Intersects current scan polygon (or map square if no scan exists) with triangle originated from RX position\n    and returns the triangle\n\nParameter(s):\n    0: STRING - scan name\n    1: ARRAY (Optional) - RX position. Default: position player\n\nReturns:\n    ARRAY - triangle used for intersection\n\nExample:\n    [\"MyScan\", position player] call BIN_fnc_scanTX","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_selectDiaryCategory","title":"BIN fnc selectDiaryCategory","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_selectDiaryCategory","revid":281182,"updated":"2021-06-14T09:05:40Z","groups":["Diary"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_selectDiaryRecord","title":"BIN fnc selectDiaryRecord","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_selectDiaryRecord","revid":281377,"updated":"2021-06-14T09:09:32Z","groups":["Diary"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_selectDiaryTask","title":"BIN fnc selectDiaryTask","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_selectDiaryTask","revid":281359,"updated":"2021-06-14T09:09:12Z","groups":["Diary"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_sendPing","title":"BIN fnc sendPing","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_sendPing","revid":281291,"updated":"2021-06-14T09:07:37Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_sendRadioSignal","title":"BIN fnc sendRadioSignal","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_sendRadioSignal","revid":281134,"updated":"2021-06-14T09:04:49Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_setAISquadID","title":"BIN fnc setAISquadID","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setAISquadID","revid":281160,"updated":"2021-06-14T09:05:16Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_setAntenna","title":"BIN fnc setAntenna","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setAntenna","revid":281180,"updated":"2021-06-14T09:05:36Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_setAntennaAngle","title":"BIN fnc setAntennaAngle","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setAntennaAngle","revid":281149,"updated":"2021-06-14T09:05:01Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_setAntennaCanReveal","title":"BIN fnc setAntennaCanReveal","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setAntennaCanReveal","revid":281337,"updated":"2021-06-14T09:08:35Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_setAntennaClass","title":"BIN fnc setAntennaClass","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setAntennaClass","revid":281285,"updated":"2021-06-14T09:07:34Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_setAntennaFrequency","title":"BIN fnc setAntennaFrequency","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setAntennaFrequency","revid":281312,"updated":"2021-06-14T09:08:08Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_setAntennaFrequencyFromList","title":"BIN fnc setAntennaFrequencyFromList","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setAntennaFrequencyFromList","revid":281299,"updated":"2021-06-14T09:07:46Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_setAntennaGain","title":"BIN fnc setAntennaGain","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setAntennaGain","revid":281187,"updated":"2021-06-14T09:05:43Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_setAntennaName","title":"BIN fnc setAntennaName","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setAntennaName","revid":281329,"updated":"2021-06-14T09:08:25Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_setAntennaObject","title":"BIN fnc setAntennaObject","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setAntennaObject","revid":281254,"updated":"2021-06-14T09:06:46Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_setAntennaPower","title":"BIN fnc setAntennaPower","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setAntennaPower","revid":281257,"updated":"2021-06-14T09:06:47Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_setAntennaRevealValue","title":"BIN fnc setAntennaRevealValue","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setAntennaRevealValue","revid":281350,"updated":"2021-06-14T09:09:02Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_setAntennaScans","title":"BIN fnc setAntennaScans","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setAntennaScans","revid":281233,"updated":"2021-06-14T09:06:24Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_setAntennaSensitivity","title":"BIN fnc setAntennaSensitivity","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setAntennaSensitivity","revid":281240,"updated":"2021-06-14T09:06:32Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_setAntennaType","title":"BIN fnc setAntennaType","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setAntennaType","revid":281364,"updated":"2021-06-14T09:09:18Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_setBehavior","title":"BIN fnc setBehavior","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setBehavior","revid":353787,"updated":"2024-03-23T16:21:26Z","groups":["Behavior"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"```\n#define DEBUG\n#define HISTORY_CAPACITY    5\n#define TERMINATE_DEFAULT    1\n#define TERMINATE_INTERRUPT    2\n#define BEHAVIOR_PATH \"a3\\Functions_F_Contact\\Behavior\\Drone\\\"\n```\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_setBehaviorCoef","title":"BIN fnc setBehaviorCoef","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setBehaviorCoef","revid":286105,"updated":"2021-06-20T17:25:54Z","groups":["Behavior"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"BIN_fnc_setBehaviorCoef Set behavior coefficients\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}],"examples":[{"code":["[bin_drone,\"gravityCannon\",0] call BIN_fnc_setBehaviorCoef"]}],"docblock":{"text":"BIN_fnc_setBehaviorCoef\nSet behavior coefficients\n\nExamples:\n\n    [bin_drone,\"gravityCannon\",0] call BIN_fnc_setBehaviorCoef"},"filled_from_docblock":["examples","description"]},{"name":"BIN_fnc_setBreathe","title":"BIN fnc setBreathe","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setBreathe","revid":281157,"updated":"2021-06-14T09:05:14Z","groups":["Behavior"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_setCurrentSignal","title":"BIN fnc setCurrentSignal","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setCurrentSignal","revid":281237,"updated":"2021-06-14T09:06:30Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_setCustomSoundController","title":"BIN fnc setCustomSoundController","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setCustomSoundController","revid":281173,"updated":"2021-06-14T09:05:29Z","groups":["Sound","Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_setCustomSoundController\n\na: reyhard"}},{"name":"BIN_fnc_setDiaryRecord","title":"BIN fnc setDiaryRecord","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setDiaryRecord","revid":364342,"updated":"2024-05-06T10:33:57Z","groups":["Diary"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_setDroneModuleParams","title":"BIN fnc setDroneModuleParams","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setDroneModuleParams","revid":286107,"updated":"2021-06-20T17:25:57Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_setDroneModuleParams"}},{"name":"BIN_fnc_setDroneModuleTarget","title":"BIN fnc setDroneModuleTarget","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setDroneModuleTarget","revid":286088,"updated":"2021-06-20T17:25:32Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"BIN_fnc_setDroneModuleTarget"}},{"name":"BIN_fnc_setGravityPulse","title":"BIN fnc setGravityPulse","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setGravityPulse","revid":281370,"updated":"2021-06-14T09:09:22Z","groups":["Puzzles"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_setIDWMapDrawColorSet","title":"BIN fnc setIDWMapDrawColorSet","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setIDWMapDrawColorSet","revid":364343,"updated":"2024-05-06T10:34:27Z","groups":["IDWMap"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Sets map draw color set\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"arg call BIN_fnc_setIDWMapDrawColorSet","params":[{"name":"arg","type":"Array","type_expr":"Array","description":"array of colors from 1 to 11","text":"ARRAY - array of colors from 1 to 11","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true on success","text":"BOOL - true on success","source":"docblock"},"inferred":true}],"examples":[{"code":["// set 3 color drawing on the fly\n[[0,0,0.514,0.7],[0.843,1,0.153,0.7],[0.522,0,0,0.7]] call BIN_fnc_setIDWMapDrawColorSet;\n// set from config\n[] call BIN_fnc_setIDWMapDrawColorSet;"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Sets map draw color set\n\nParameter(s):\n    ARRAY - array of colors from 1 to 11\n\nReturns:\n    BOOL - true on success\n\nExample:\n    // set 3 color drawing on the fly\n    [[0,0,0.514,0.7],[0.843,1,0.153,0.7],[0.522,0,0,0.7]] call BIN_fnc_setIDWMapDrawColorSet;\n    // set from config\n    [] call BIN_fnc_setIDWMapDrawColorSet;","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_setIDWMapDrawPatternIndex","title":"BIN fnc setIDWMapDrawPatternIndex","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setIDWMapDrawPatternIndex","revid":364344,"updated":"2024-05-06T10:34:40Z","groups":["IDWMap"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Sets map draw pattern\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"arg call BIN_fnc_setIDWMapDrawPatternIndex","params":[{"name":"arg","type":"Number","type_expr":"Number","description":"pattern: 0 - triangles, 1 - diamonds, 2 - squares, 3 - diamonds overlapped","text":"NUMBER - pattern: 0 - triangles, 1 - diamonds, 2 - squares, 3 - diamonds overlapped","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true on success","text":"BOOL - true on success","source":"docblock"},"inferred":true}],"examples":[{"code":["// set on the fly\n3 call BIN_fnc_setIDWMapDrawPatternIndex; OR [3] call BIN_fnc_setIDWMapDrawPatternIndex;\n// set from config\ncall BIN_fnc_setIDWMapDrawPatternIndex; OR [] call BIN_fnc_setIDWMapDrawPatternIndex;"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Sets map draw pattern\n\nParameter(s):\n    NUMBER - pattern: 0 - triangles, 1 - diamonds, 2 - squares, 3 - diamonds overlapped\n\nReturns:\n    BOOL - true on success\n\nExample:\n    // set on the fly\n    3 call BIN_fnc_setIDWMapDrawPatternIndex; OR [3] call BIN_fnc_setIDWMapDrawPatternIndex;\n    // set from config\n    call BIN_fnc_setIDWMapDrawPatternIndex; OR [] call BIN_fnc_setIDWMapDrawPatternIndex;","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_setIDWMapParams","title":"BIN fnc setIDWMapParams","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setIDWMapParams","revid":281196,"updated":"2021-06-14T09:05:51Z","groups":["IDWMap"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Resets extension data, sets IDWMap params from argument, from config or default\n*** This function must be called before any data is added to the IDWMap ***\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0, param1, param2, param3, param4, param5] call BIN_fnc_setIDWMapParams","params":[{"name":"param0","type":"Array","type_expr":"Array","optional":true,"default":"[0, 0, worldSize, worldSize]","description":"areaParams in format:\n0: NUMBER - minMapX\n1: NUMBER - minMapY\n2: NUMBER - maxMapX\n3: NUMBER - maxMapY\nDefault: [0, 0, worldSize, worldSize]","text":"0: ARRAY - (Optional) areaParams in format:\n0: NUMBER - minMapX\n1: NUMBER - minMapY\n2: NUMBER - maxMapX\n3: NUMBER - maxMapY\nDefault: [0, 0, worldSize, worldSize]","source":"docblock"},{"name":"param1","type":"Number","type_expr":"Number","optional":true,"default":"20","description":"idwCellSize. Default: 20","text":"1: NUMBER (Optional) - idwCellSize. Default: 20","source":"docblock"},{"name":"param2","type":"Number","type_expr":"Number","optional":true,"default":"200","description":"idwSpreadRadius. Default: 200","text":"2: NUMBER (Optional) - idwSpreadRadius. Default: 200","source":"docblock"},{"name":"param3","type":"Number","type_expr":"Number","optional":true,"default":"2.0","description":"idwSpreadPower. Default: 2.0","text":"3: NUMBER (Optional) - idwSpreadPower. Default: 2.0","source":"docblock"},{"name":"param4","type":"Number","type_expr":"Number","optional":true,"default":"20","description":"curvePointsInterval. Default: 20","text":"4: NUMBER (Optional) - curvePointsInterval. Default: 20","source":"docblock"},{"name":"param5","type":"Number","type_expr":"Number","optional":true,"default":"idwSpreadRadius","description":"curvePointSpreadRadius. Default: idwSpreadRadius","text":"5: NUMBER (Optional) - curvePointSpreadRadius. Default: idwSpreadRadius","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true on success","text":"BOOL - true on success","source":"docblock"},"inferred":true}],"examples":[{"code":["call BIN_fnc_setIDWMapParams"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Resets extension data, sets IDWMap params from argument, from config or default\n    *** This function must be called before any data is added to the IDWMap ***\n\nParameter(s):\n    0: ARRAY - (Optional) areaParams in format:\n        0: NUMBER - minMapX\n        1: NUMBER - minMapY\n        2: NUMBER - maxMapX\n        3: NUMBER - maxMapY\n        Default: [0, 0, worldSize, worldSize]\n    1: NUMBER (Optional) - idwCellSize. Default: 20\n    2: NUMBER (Optional) - idwSpreadRadius. Default: 200\n    3: NUMBER (Optional) - idwSpreadPower. Default: 2.0\n    4: NUMBER (Optional) - curvePointsInterval. Default: 20\n    5: NUMBER (Optional) - curvePointSpreadRadius. Default: idwSpreadRadius\n\nReturns:\n    BOOL - true on success\n\nExample:\n    call BIN_fnc_setIDWMapParams","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_setIDWMapStaticDataLayers","title":"BIN fnc setIDWMapStaticDataLayers","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setIDWMapStaticDataLayers","revid":281171,"updated":"2021-06-14T09:05:28Z","groups":["IDWMap"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Sets static data for extension use from argument or config \"CfgIDWMap\"\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"arg call BIN_fnc_setIDWMapStaticDataLayers","params":[{"name":"arg","type":"Array","type_expr":"Array","optional":true,"description":"static data in format:\n[\n    [[x,y,strengh],[x,y,strengh],...], // data layer 0\n    [[x,y,strengh],[x,y,strengh],...], // data layer 1\n    ...\n    [[x,y,strengh],[x,y,strengh],...] // data layer N\n]","text":"ARRAY (optional) - static data in format:\n[\n    [[x,y,strengh],[x,y,strengh],...], // data layer 0\n    [[x,y,strengh],[x,y,strengh],...], // data layer 1\n    ...\n    [[x,y,strengh],[x,y,strengh],...] // data layer N\n]","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true on success","text":"BOOL - true on success","source":"docblock"},"inferred":true}],"examples":[{"code":["call BIN_fnc_setIDWMapStaticDataLayers"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Sets static data for extension use from argument or config \"CfgIDWMap\"\n\nParameter(s):\n    ARRAY (optional) - static data in format:\n    [\n        [[x,y,strengh],[x,y,strengh],...], // data layer 0\n        [[x,y,strengh],[x,y,strengh],...], // data layer 1\n        ...\n        [[x,y,strengh],[x,y,strengh],...] // data layer N\n    ]\n\nReturns:\n    BOOL - true on success\n\nExample:\n    call BIN_fnc_setIDWMapStaticDataLayers","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_setModuleSpeed","title":"BIN fnc setModuleSpeed","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setModuleSpeed","revid":281216,"updated":"2021-06-14T09:06:10Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_setMoveProperties","title":"BIN fnc setMoveProperties","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setMoveProperties","revid":281376,"updated":"2021-06-14T09:09:32Z","groups":["Movement"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_setObjectGrid","title":"BIN fnc setObjectGrid","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setObjectGrid","revid":364346,"updated":"2024-05-06T10:35:22Z","groups":["Movement"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_setPlayerSelectedBand","title":"BIN fnc setPlayerSelectedBand","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setPlayerSelectedBand","revid":281192,"updated":"2021-06-14T09:05:49Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_setPointOfInterest","title":"BIN fnc setPointOfInterest","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setPointOfInterest","revid":364347,"updated":"2024-05-06T10:35:41Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Add point of interest shown in the map\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0, param1, param2, param3, param4, param5, param0] call BIN_fnc_setPointOfInterest","params":[{"name":"param0","type":"String","type_expr":"String","description":"unique ID of the point","text":"0: STRING - unique ID of the point","source":"docblock"},{"name":"param1","type":"Boolean, Number","type_expr":"Boolean | Number","description":"BOOL - true if the point is completed (shown faded in the map)\nNUMBER - status, can be:\n    -1: dormant, will be activated when player gets close\n     0: shown, but not completed\n    +1: completed","text":"1: BOOL - true if the point is completed (shown faded in the map)\nNUMBER - status, can be:\n    -1: dormant, will be activated when player gets close\n     0: shown, but not completed\n    +1: completed","source":"docblock"},{"name":"param2","type":"Array","type_expr":"Array","description":"position","text":"2: ARRAY - position","source":"docblock"},{"name":"param3","type":"Array","type_expr":"Array","description":"area in format [width,height,angle,isRectangle]","text":"3: ARRAY - area in format [width,height,angle,isRectangle]","source":"docblock"},{"name":"param4","type":"String","type_expr":"String","default":"\"Unknown\"","description":"type, can be \"Unknown\" or \"Warning\" (default: \"Unknown\")","text":"4: STRING - type, can be \"Unknown\" or \"Warning\" (default: \"Unknown\")","source":"docblock"},{"name":"param5","type":"String","type_expr":"String","default":"\"Black\"","description":"color, can be \"Black\", \"Blue\" or \"Red\" (default: \"Black\")\nor","text":"5: STRING - color, can be \"Black\", \"Blue\" or \"Red\" (default: \"Black\")\nor","source":"docblock"},{"name":"param0","type":"Object","type_expr":"Object","description":"\"Point of interest\" module","text":"0: OBJECT - \"Point of interest\" module","source":"docblock"}],"returns":{"type":"String","type_expr":"String","description":"ID of the point","text":"STRING - ID of the point","source":"docblock"},"inferred":true}],"examples":[{"code":["//--- Activate existing module\n_myID = myModule call BIN_fnc_setPointOfInterest;"]},{"code":["//--- Mark POI as completed\n[_myID,true] call BIN_fnc_setPointOfInterest;"]},{"code":["//--- Set custom POI\n[\"myID\",false,position myObject,[50,50,0,false],\"Warning\",\"Red\"] call BIN_fnc_setPointOfInterest;"]},{"code":["//--- Set custom POI using default type and color\n[\"myID\",false,position myObject,[50,50,0,false]] call BIN_fnc_setPointOfInterest;"]}],"docblock":{"text":"Description:\n    Add point of interest shown in the map\n\nParameter(s):\n    0: STRING - unique ID of the point\n    1:\n        BOOL - true if the point is completed (shown faded in the map)\n        NUMBER - status, can be:\n            -1: dormant, will be activated when player gets close\n             0: shown, but not completed\n            +1: completed\n    2: ARRAY - position\n    3: ARRAY - area in format [width,height,angle,isRectangle]\n    4: STRING - type, can be \"Unknown\" or \"Warning\" (default: \"Unknown\")\n    5: STRING - color, can be \"Black\", \"Blue\" or \"Red\" (default: \"Black\")\n\n    or\n\n    0: OBJECT - \"Point of interest\" module\n\nReturns:\n    STRING - ID of the point\n\nExamples:\n\n    //--- Activate existing module\n    _myID = myModule call BIN_fnc_setPointOfInterest;\n\n    //--- Mark POI as completed\n    [_myID,true] call BIN_fnc_setPointOfInterest;\n\n    //--- Set custom POI\n    [\"myID\",false,position myObject,[50,50,0,false],\"Warning\",\"Red\"] call BIN_fnc_setPointOfInterest;\n\n    //--- Set custom POI using default type and color\n    [\"myID\",false,position myObject,[50,50,0,false]] call BIN_fnc_setPointOfInterest;"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_setRadioConversation","title":"BIN fnc setRadioConversation","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setRadioConversation","revid":281256,"updated":"2021-06-14T09:06:47Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_setRadioHandshake","title":"BIN fnc setRadioHandshake","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setRadioHandshake","revid":281129,"updated":"2021-06-14T09:04:44Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_setRadioSilence","title":"BIN fnc setRadioSilence","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setRadioSilence","revid":281253,"updated":"2021-06-14T09:06:44Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_setRagdoll","title":"BIN fnc setRagdoll","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setRagdoll","revid":369823,"updated":"2024-10-14T09:22:12Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Set the provided unit in ragdoll state (pushed by an invisible object).\n\n> [!NOTE]\n> Arma 3 v2.18 addForce can be used in vanilla Arma 3.\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[unit, force, selectionPos] call BIN_fnc_setRagdoll","params":[{"name":"unit","type":"Object","description":"the unit to ragdoll","type_expr":"Object"},{"name":"unit","type":"Array format Vector3D","description":"force applied to the colliding object","type_expr":"Vector3D","types":["Array","Vector3D"]},{"name":"unit","type":"String","type_expr":"String"}],"returns":{"type":"String","type_expr":"String","description":"event ID from BIS_fnc_addStackedEventHandler","text":"String event ID from BIS_fnc_addStackedEventHandler"}}],"examples":[{"code":["[player, [0, 100, 0]] call BIN_fnc_setRagdoll;"]}],"see_also":["setUnconscious","addForce"]},{"name":"BIN_fnc_setSite","title":"BIN fnc setSite","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setSite","revid":296447,"updated":"2021-12-14T15:29:39Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"```\n#define DEBUG\n#define ALPHA_ON    1.0\n#define ALPHA_OFF    0.4\n#define DRAW(SHOW)\\\n    _color = [[1,0,0,1],[0,1,0,1],[0,0,1,1],[1,1,0,1],[1,0,1,1],[0,1,1,1],[1,0.5,0,1]] select ((_logic getvariable [\"#index\",0]) % 7);\\\n    if !(SHOW) then {_color set [3,0.4];};\\\n    _drawIcon = [\"\\a3\\Ui_f\\data\\Map\\LocationTypes\\borderCrossing_CA.paa\",_color,position _logic,0.75,0.75,0,_class,2,0.04,\"RobotoCondensed\",\"right\"];\\\n    [\"bin_diagSites\",_class,\"icon\",[_drawIcon]] call BIN_fnc_debugDraw;\\\n    _isRectangle = false;\\\n    _drawArea = if (SHOW) then {\\\n        _areaOut = _logic getvariable [\"areaOut\",[position _logic,0,0,0,false]];\\\n        _isRectangle = _areaOut select 4;\\\n        [_areaOut select 0,_areaOut select 1,_areaOut select 2,_areaOut select 3,_color,\"\"]\\\n    } else {\\\n        _areaIn = _logic getvariable [\"areaIn\",[position _logic,0,0,0,false]];\\\n        _isRectangle = _areaIn select 4;\\\n        [_areaIn select 0,_areaIn select 1,_areaIn select 2,_areaIn select 3,_color,\"\"]\\\n    };\\\n    [\"bin_diagSites\",_class,if (_isRectangle) then {\"rectangle\"} else {\"ellipse\"},[_drawArea]] call BIN_fnc_debugDraw;\n\n#define VAR_IGNORE    \"$i\"\n#define VAR_KILL    \"$k\"\n#define VAR_VISITED    \"$v\"\n#define VAR_SPAWNED    \"#spawned\"\n```\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_setSpectrumAnalyzer","title":"BIN fnc setSpectrumAnalyzer","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setSpectrumAnalyzer","revid":281281,"updated":"2021-06-14T09:07:28Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_setTargetWeight","title":"BIN fnc setTargetWeight","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setTargetWeight","revid":379543,"updated":"2026-10-31T13:38:55Z","groups":["Behavior"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","locality":{"effect":"local"},"description":"Sets the target priority (weight) of a unit, vehicle, group or side for the weapons of the alien drone. The weight is stored in the object variable \"#bTargetPrio\" (default 1 when not set) and is later read by:\n\n- BIN_fnc_findTargetWeight, which picks the drone's target among nearby entities with selectRandomWeighted; entities with weight 0 are excluded\n- BIN_fnc_missileSwarm, which picks missile targets among allUnits within 200 m; units with weight 0 or lower are excluded\n\nThe higher the weight, the more likely the target is to be selected. Objects initialised with BIN_fnc_behaviorInit and the drone module (BIN_fnc_initDroneModule) get weight 0.\n\nNothing in the Contact functions calls this function; it is meant to be used in mission scripts.\n\n> [!IMPORTANT]\n> - A vehicle passed as *target* gets the weight on the vehicle object only, not on its crew. BIN_fnc_findTargetWeight uses this value for the vehicle, but BIN_fnc_missileSwarm reads the weight of the units.\n> - For a unit that is inside a vehicle, the code runs `crew _x` where `_x` is not defined by the function, so the weight is not set on that unit.\n> - A Side only affects units that exist at the moment of the call.\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[target, weight] call BIN_fnc_setTargetWeight","params":[{"name":"target","type":"Object, Group or Side","optional":true,"default":"objNull","description":"Object - a unit on foot or a vehicle; the weight is set on that object\n- Group - the weight is set on every unit of the group\n- Side - the weight is set on every unit of allUnits that belongs to this side","type_expr":"Object | Group | Side","text":"target: Object, Group or Side - (Optional, default objNull)\n\n- Object - a unit on foot or a vehicle; the weight is set on that object\n- Group - the weight is set on every unit of the group\n- Side - the weight is set on every unit of allUnits that belongs to this side"},{"name":"weight","type":"Number","optional":true,"default":"1","description":"target weight; 0 excludes the target from selection","type_expr":"Number","text":"weight: Number - (Optional, default 1) target weight; 0 excludes the target from selection"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[west, 0] call BIN_fnc_setTargetWeight; // all current BLUFOR units are ignored by the drone's weapons"]},{"code":["[player, 10] call BIN_fnc_setTargetWeight; // the player is much more likely to be targeted"]},{"code":["[group player, 0] call BIN_fnc_setTargetWeight; // the player's group is ignored"]}],"see_also":["BIN_fnc_findTargetWeight","selectRandomWeighted"]},{"name":"BIN_fnc_setTXScanAngle","title":"BIN fnc setTXScanAngle","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setTXScanAngle","revid":281166,"updated":"2021-06-14T09:05:23Z","groups":["TXScan"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Sets TXScan angle\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0, param1] call BIN_fnc_setTXScanAngle","params":[{"name":"param0","type":"String","type_expr":"String","description":"scan name","text":"0: STRING - scan name","source":"docblock"},{"name":"param1","type":"Number","type_expr":"Number","description":"cone angle","text":"1: NUMBER - cone angle","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true on success","text":"BOOL - true on success","source":"docblock"},"inferred":true}],"examples":[{"code":["[\"MyScan\", 45] call BIN_fnc_setTXScanAngle"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Sets TXScan angle\n\nParameter(s):\n    0: STRING - scan name\n    1: NUMBER - cone angle\n\nReturns:\n    BOOL - true on success\n\nExample:\n    [\"MyScan\", 45] call BIN_fnc_setTXScanAngle","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_setTXScanPolygon","title":"BIN fnc setTXScanPolygon","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setTXScanPolygon","revid":281378,"updated":"2021-06-14T09:09:32Z","groups":["TXScan"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Pre-sets intersection polygon for given scan. Can only be done with newly created scans since once the first scan is made, the polygon cannot be overwritten\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0, param1] call BIN_fnc_setTXScanPolygon","params":[{"name":"param0","type":"String","type_expr":"String","description":"TXScan name","text":"0: STRING - TXScan name","source":"docblock"},{"name":"param1","type":"Array","type_expr":"Array","description":"polygon points","text":"1: ARRAY - polygon points","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"false on error","text":"BOOL - false on error","source":"docblock"},"inferred":true}],"examples":[{"code":["[\"MyScan\",[p1,p2,p3...]] call BIN_fnc_setTXScanPolygon"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Pre-sets intersection polygon for given scan. Can only be done with newly created scans since once the first scan is made, the polygon cannot be overwritten\n\nParameter(s):\n    0: STRING - TXScan name\n    1: ARRAY - polygon points\n\nReturns:\n    BOOL - false on error\n\nExample:\n    [\"MyScan\",[p1,p2,p3...]] call BIN_fnc_setTXScanPolygon","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_setTXScanPosition","title":"BIN fnc setTXScanPosition","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setTXScanPosition","revid":281188,"updated":"2021-06-14T09:05:44Z","groups":["TXScan"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Sets TXScan transmitter position\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0, param1] call BIN_fnc_setTXScanPosition","params":[{"name":"param0","type":"String","type_expr":"String","description":"scan name","text":"0: STRING - scan name","source":"docblock"},{"name":"param1","type":"Array","type_expr":"Array","description":"transmitter position","text":"1: ARRAY - transmitter position","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true on success","text":"BOOL - true on success","source":"docblock"},"inferred":true}],"examples":[{"code":["[\"MyScan\", position player] call BIN_fnc_setTXScanPosition"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Sets TXScan transmitter position\n\nParameter(s):\n    0: STRING - scan name\n    1: ARRAY - transmitter position\n\nReturns:\n    BOOL - true on success\n\nExample:\n    [\"MyScan\", position player] call BIN_fnc_setTXScanPosition","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_setTXScanPrecision","title":"BIN fnc setTXScanPrecision","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setTXScanPrecision","revid":281249,"updated":"2021-06-14T09:06:38Z","groups":["TXScan"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Sets TXScan precision\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0, param1] call BIN_fnc_setTXScanPrecision","params":[{"name":"param0","type":"String","type_expr":"String","description":"scan name","text":"0: STRING - scan name","source":"docblock"},{"name":"param1","type":"Number","type_expr":"Number","description":"cone precision","text":"1: NUMBER - cone precision","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true on success","text":"BOOL - true on success","source":"docblock"},"inferred":true}],"examples":[{"code":["[\"MyScan\", 0.1] call BIN_fnc_setTXScanPrecision"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Sets TXScan precision\n\nParameter(s):\n    0: STRING - scan name\n    1: NUMBER - cone precision\n\nReturns:\n    BOOL - true on success\n\nExample:\n    [\"MyScan\", 0.1] call BIN_fnc_setTXScanPrecision","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_setTXScanWorldBounds","title":"BIN fnc setTXScanWorldBounds","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_setTXScanWorldBounds","revid":364348,"updated":"2024-05-06T10:35:54Z","groups":["TXScan"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Sets map bounds in which scans could be carried out. Default [0,0,worldSize,worldSize]\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0, param1, param2, param3] call BIN_fnc_setTXScanWorldBounds","params":[{"name":"param0","type":"Number","type_expr":"Number","description":"minX","text":"0: NUMBER - minX","source":"docblock"},{"name":"param1","type":"Number","type_expr":"Number","description":"minY","text":"1: NUMBER - minY","source":"docblock"},{"name":"param2","type":"Number","type_expr":"Number","description":"maxX","text":"2: NUMBER - maxX","source":"docblock"},{"name":"param3","type":"Number","type_expr":"Number","description":"maxY\nor [] to use config values or default","text":"3: NUMBER - maxY\nor [] to use config values or default","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true on success","text":"BOOL - true on success","source":"docblock"},"inferred":true}],"examples":[{"code":["[0,0,worldSize,worldSize] call BIN_fnc_setTXScanWorldBounds\n[] call BIN_fnc_setTXScanWorldBounds"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Sets map bounds in which scans could be carried out. Default [0,0,worldSize,worldSize]\n\nParameter(s):\n    0: NUMBER - minX\n    1: NUMBER - minY\n    2: NUMBER - maxX\n    3: NUMBER - maxY\n\n    or [] to use config values or default\n\nReturns:\n    BOOL - true on success\n\nExample:\n    [0,0,worldSize,worldSize] call BIN_fnc_setTXScanWorldBounds\n    [] call BIN_fnc_setTXScanWorldBounds","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_showAntennaIcon","title":"BIN fnc showAntennaIcon","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_showAntennaIcon","revid":281184,"updated":"2021-06-14T09:05:41Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_showAntennaIcons","title":"BIN fnc showAntennaIcons","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_showAntennaIcons","revid":281164,"updated":"2021-06-14T09:05:22Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_showCurrentTask","title":"BIN fnc showCurrentTask","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_showCurrentTask","revid":281130,"updated":"2021-06-14T09:04:46Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_showHorizontalCompass","title":"BIN fnc showHorizontalCompass","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_showHorizontalCompass","revid":281284,"updated":"2021-06-14T09:07:32Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Show or hide horizontal compass\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0] call BIN_fnc_showHorizontalCompass","params":[{"name":"param0","type":"Boolean","type_expr":"Boolean","description":"true to show, false to hide","text":"0: BOOL - true to show, false to hide","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","text":"NOTHING","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\n    Show or hide horizontal compass\n\nParameter(s):\n    0: BOOL - true to show, false to hide\n\nReturns:\n    NOTHING"},"filled_from_docblock":["params","syntax","returns","description"]},{"name":"BIN_fnc_showMapOptions","title":"BIN fnc showMapOptions","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_showMapOptions","revid":364349,"updated":"2024-05-06T10:36:04Z","groups":["Diary"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Select which maps will be available\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0] call BIN_fnc_showMapOptions","params":[{"name":"param0","type":"Number","type_expr":"Number","description":"mode, can be:\n0 - all options available (default)\n1 - probe map not available\n2 - no options available (i.e., only main map is shown)","text":"0: NUMBER - mode, can be:\n0 - all options available (default)\n1 - probe map not available\n2 - no options available (i.e., only main map is shown)","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","text":"NOTHING","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\n    Select which maps will be available\n\nParameter(s):\n    0: NUMBER - mode, can be:\n        0 - all options available (default)\n        1 - probe map not available\n        2 - no options available (i.e., only main map is shown)\n\nReturns:\n    NOTHING"},"filled_from_docblock":["params","syntax","returns","description"]},{"name":"BIN_fnc_showPlayerSpectrumAnalyzer","title":"BIN fnc showPlayerSpectrumAnalyzer","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_showPlayerSpectrumAnalyzer","revid":281265,"updated":"2021-06-14T09:06:58Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_showSimpleNotification","title":"BIN fnc showSimpleNotification","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_showSimpleNotification","revid":281301,"updated":"2021-06-14T09:07:50Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_showSpectrumAnalyzer","title":"BIN fnc showSpectrumAnalyzer","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_showSpectrumAnalyzer","revid":281311,"updated":"2021-06-14T09:08:08Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_showSpectrumAnalyzerGUI","title":"BIN fnc showSpectrumAnalyzerGUI","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_showSpectrumAnalyzerGUI","revid":281181,"updated":"2021-06-14T09:05:39Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_showSpectrumAnalyzerMuzzle","title":"BIN fnc showSpectrumAnalyzerMuzzle","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_showSpectrumAnalyzerMuzzle","revid":281341,"updated":"2021-06-14T09:08:46Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_showSpectrumAnalyzerPiP","title":"BIN fnc showSpectrumAnalyzerPiP","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_showSpectrumAnalyzerPiP","revid":281262,"updated":"2021-06-14T09:06:53Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_showVision","title":"BIN fnc showVision","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_showVision","revid":281212,"updated":"2021-06-14T09:06:09Z","groups":["Puzzles"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_skip","title":"BIN fnc skip","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_skip","revid":281186,"updated":"2021-06-14T09:05:43Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"```\n//#define TIME_SKIP    1.4 // Apex\n#define TIME_SKIP    0.5\n```\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_soundDrone","title":"BIN fnc soundDrone","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_soundDrone","revid":281356,"updated":"2021-06-14T09:09:11Z","groups":["Sound","Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_switchMap","title":"BIN fnc switchMap","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_switchMap","revid":364350,"updated":"2024-05-06T10:36:15Z","groups":["Diary"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_taskActive","title":"BIN fnc taskActive","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_taskActive","revid":286076,"updated":"2021-06-20T17:25:19Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Return if task is active, i.e., added to player, but not yet completed. Only in this state can player assign it.\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0] call BIN_fnc_taskActive","params":[{"name":"param0","type":"String","type_expr":"String","description":"task ID","text":"0: STRING - task ID","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","text":"BOOL","source":"docblock"},"inferred":true}],"examples":[{"code":["if (\"q_schnobble\" call BIN_fnc_taskActive) then {hint \"ACTIVE!\";};"]}],"docblock":{"text":"Description:\n    Return if task is active, i.e., added to player, but not yet completed.\n    Only in this state can player assign it.\n\nParameter(s):\n    0: STRING - task ID\n\nReturns:\n    BOOL\n\nExample:\n    if (\"q_schnobble\" call BIN_fnc_taskActive) then {hint \"ACTIVE!\";};"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_taskAdded","title":"BIN fnc taskAdded","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_taskAdded","revid":286091,"updated":"2021-06-20T17:25:37Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Return if task was added to player. Includes both finished and unfinished tasks.\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0] call BIN_fnc_taskAdded","params":[{"name":"param0","type":"String","type_expr":"String","description":"task ID","text":"0: STRING - task ID","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","text":"BOOL","source":"docblock"},"inferred":true}],"examples":[{"code":["if (\"q_schnobble\" call BIN_fnc_taskAdded) then {hint \"ADDED!\";};"]}],"docblock":{"text":"Description:\n    Return if task was added to player.\n    Includes both finished and unfinished tasks.\n\nParameter(s):\n    0: STRING - task ID\n\nReturns:\n    BOOL\n\nExample:\n    if (\"q_schnobble\" call BIN_fnc_taskAdded) then {hint \"ADDED!\";};"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_terminatePuzzle","title":"BIN fnc terminatePuzzle","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_terminatePuzzle","revid":281263,"updated":"2021-06-14T09:06:55Z","groups":["Puzzles"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_translationDone","title":"BIN fnc translationDone","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_translationDone","revid":281309,"updated":"2021-06-14T09:08:06Z","groups":["Movement"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_travelToPoint","title":"BIN fnc travelToPoint","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_travelToPoint","revid":281372,"updated":"2021-06-14T09:09:28Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_tvSaveExpanded","title":"BIN fnc tvSaveExpanded","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_tvSaveExpanded","revid":281295,"updated":"2021-06-14T09:07:41Z","groups":["Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_updateEM","title":"BIN fnc updateEM","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_updateEM","revid":281221,"updated":"2021-06-14T09:06:15Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_updateGravityPulse","title":"BIN fnc updateGravityPulse","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_updateGravityPulse","revid":281300,"updated":"2021-06-14T09:07:50Z","groups":["Puzzles"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_updateIDWMapDrawData","title":"BIN fnc updateIDWMapDrawData","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_updateIDWMapDrawData","revid":281261,"updated":"2021-06-14T09:06:51Z","groups":["IDWMap"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Retrieves draw data for IDWMap and stores it in 'IDWMapDrawData' variable on map control for use in 'Draw' event handler. Should be called in scheduled environment to spread the load.\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true on success if called from scheduled\nNOTHING - if called from unscheduled","text":"BOOL - true on success if called from scheduled\nNOTHING - if called from unscheduled","source":"docblock"}}],"examples":[{"code":["call BIN_fnc_updateIDWMapDrawData"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Retrieves draw data for IDWMap and stores it in 'IDWMapDrawData' variable on map control for use in 'Draw' event handler. Should be called in scheduled environment to spread the load.\n\nParameter(s):\n    NONE\n\nReturns:\n    BOOL - true on success if called from scheduled\n    NOTHING - if called from unscheduled\n\nExample:\n    call BIN_fnc_updateIDWMapDrawData","author":"Killzone_Kid"},"filled_from_docblock":["returns","examples","description"]},{"name":"BIN_fnc_updatePlayerAntenna","title":"BIN fnc updatePlayerAntenna","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_updatePlayerAntenna","revid":281315,"updated":"2021-06-14T09:08:11Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_updatePlayerInput","title":"BIN fnc updatePlayerInput","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_updatePlayerInput","revid":281362,"updated":"2021-06-14T09:09:16Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_updatePlayerSpectrumAnalyzer","title":"BIN fnc updatePlayerSpectrumAnalyzer","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_updatePlayerSpectrumAnalyzer","revid":281194,"updated":"2021-06-14T09:05:50Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_updatePlayerSpectrumAnalyzerSounds","title":"BIN fnc updatePlayerSpectrumAnalyzerSounds","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_updatePlayerSpectrumAnalyzerSounds","revid":281215,"updated":"2021-06-14T09:06:10Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_updateSignalDurations","title":"BIN fnc updateSignalDurations","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_updateSignalDurations","revid":281274,"updated":"2021-06-14T09:07:21Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_updateSpectrumAnalyzerInput","title":"BIN fnc updateSpectrumAnalyzerInput","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_updateSpectrumAnalyzerInput","revid":281320,"updated":"2021-06-14T09:08:17Z","groups":["EM Interface"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_updateTXScanDrawData","title":"BIN fnc updateTXScanDrawData","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_updateTXScanDrawData","revid":364351,"updated":"2024-05-06T10:36:27Z","groups":["TXScan"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Retrieves draw data for TXScan and updates drawing\n\n> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"[param0] call BIN_fnc_updateTXScanDrawData","params":[{"name":"param0","type":"String","type_expr":"String","description":"scan name, \"\" - all scans","text":"0: STRING - scan name, \"\" - all scans","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true on success","text":"BOOL - true on success","source":"docblock"},"inferred":true}],"examples":[{"code":["\"myScan\" call BIN_fnc_updateTXScanDrawData\n\"\" call BIN_fnc_updateTXScanDrawData - all scans"]}],"docblock":{"text":"    Killzone_Kid\n\nDescription:\n    Retrieves draw data for TXScan and updates drawing\n\nParameter(s):\n    0: STRING - scan name, \"\" - all scans\n\nReturns:\n    BOOL - true on success\n\nExample:\n    \"myScan\" call BIN_fnc_updateTXScanDrawData\n    \"\" call BIN_fnc_updateTXScanDrawData - all scans","author":"Killzone_Kid"},"filled_from_docblock":["params","syntax","returns","examples","description"]},{"name":"BIN_fnc_vectorToEuler","title":"BIN fnc vectorToEuler","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_vectorToEuler","revid":364352,"updated":"2024-05-06T10:36:38Z","groups":["Vectors","Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_wpAddScript","title":"BIN fnc wpAddScript","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_wpAddScript","revid":281360,"updated":"2021-06-14T09:09:13Z","groups":["Waypoints","Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_wpDroneMove","title":"BIN fnc wpDroneMove","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_wpDroneMove","revid":281245,"updated":"2021-06-14T09:06:34Z","groups":["Waypoints","Contact"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_wpMoveFast","title":"BIN fnc wpMoveFast","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_wpMoveFast","revid":281324,"updated":"2021-06-14T09:08:22Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIN_fnc_wpPatrol","title":"BIN fnc wpPatrol","type":"function","url":"https://community.bistudio.com/wiki/BIN_fnc_wpPatrol","revid":272978,"updated":"2021-06-13T00:35:37Z","groups":["AI Human"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"> [!NOTE]\n> This content is exclusive to the Arma 3 Contact Expansion.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_3Dcredits","title":"BIS fnc 3Dcredits","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3Dcredits","revid":327969,"updated":"2022-07-13T14:24:24Z","groups":["GUI"],"status":"ok","games":{"arma2oa":"1.56","tkoh":"1.00","arma3":"0.50"},"since":"arma2oa 1.56","arma3_since":"0.50","locality":{"effect":"local"},"exec":"spawn","description":"Displays structured text in 3D world. GUI layer for indicator is `2733`.","syntaxes":[{"syntax":"[text, position, minDist, fadeDist] spawn BIS_fnc_3Dcredits","params":[{"name":"text","type":"String with optional Structured Text formatting","type_expr":"String"},{"name":"position","type":"Array in format Position","type_expr":"Position","types":["Array","Position"]},{"name":"minDist","type":"Number","optional":true,"default":"20","description":"distance in which text is displayed","type_expr":"Number","text":"minDist: Number - (Optional, default 20) distance in which text is displayed"},{"name":"fadeDist","type":"Number","optional":true,"default":"1.5","description":"distance in which text starts fading again","type_expr":"Number","text":"fadeDist: Number - (Optional, default is 1.5) distance in which text starts fading again"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"<t size='2'>Hello World</t>\", getPosATL helloWorld, 15, 0] spawn BIS_fnc_3Dcredits;"]},{"code":["[\"<img size='2' image='img\\myImage.paa'/><br />Some text on the second line\", getPosATL someObject] spawn BIS_fnc_3Dcredits;"]}],"see_also":["Functions Library"]},{"name":"BIS_fnc_3den_init","title":"BIS fnc 3den init","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3den_init","revid":363858,"updated":"2024-04-23T20:52:51Z","groups":["KeyframeAnimation"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"Used internally by the Key Frame Animation system. Adds needed event handlers.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Key Frame Animation"]},{"name":"BIS_fnc_3den_onKeyDown","title":"BIS fnc 3den onKeyDown","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3den_onKeyDown","revid":363331,"updated":"2024-03-27T09:38:04Z","groups":["KeyframeAnimation"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"Used internally by the Arma 3: Key Frame Animation system. Called when a button is pressed.","syntaxes":[{"syntax":"[display, button, shift, ctrl, alt] call BIS_fnc_3den_onKeyDown","params":[{"name":"display","type":"Display","description":"the display","type_expr":"Display"},{"name":"button","type":"Number","description":"key code of the pressed button","type_expr":"Number"},{"name":"shift","type":"Boolean","description":"<kbd>⇧ Shift</kbd> key","type_expr":"Boolean"},{"name":"ctrl","type":"Boolean","description":"<kbd>Ctrl</kbd> key","type_expr":"Boolean"},{"name":"alt","type":"Boolean","description":"<kbd>Alt</kbd> key","type_expr":"Boolean"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"whether or not to consume the input"}}],"examples":[{"code":["findDisplay 313 displayAddEventHandler [\"keyDown\", { _this call BIS_fnc_3den_onKeyDown }];"]}],"see_also":["Arma 3: Key Frame Animation"]},{"name":"BIS_fnc_3den_onKeyUp","title":"BIS fnc 3den onKeyUp","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3den_onKeyUp","revid":363859,"updated":"2024-04-23T20:52:51Z","groups":["KeyframeAnimation"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"Used internally by the Key Frame Animation system. Called when a button is released.","syntaxes":[{"syntax":"[display, button, shift, ctrl, alt] call BIS_fnc_3den_onKeyUp","params":[{"name":"display","type":"Display","description":"the display","type_expr":"Display"},{"name":"button","type":"Number","description":"key code of the pressed button","type_expr":"Number"},{"name":"shift","type":"Boolean","description":"SHIFT key","type_expr":"Boolean"},{"name":"ctrl","type":"Boolean","description":"CTRL key","type_expr":"Boolean"},{"name":"alt","type":"Boolean","description":"ALT key","type_expr":"Boolean"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"whether or not to consume the input"}}],"examples":[{"code":["findDisplay 313 displayAddEventHandler [\"keyUp\", {_this call BIS_fnc_3den_onKeyUp}];"]}],"see_also":["Arma 3: Key Frame Animation"]},{"name":"BIS_fnc_3den_onMissionLoad","title":"BIS fnc 3den onMissionLoad","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3den_onMissionLoad","revid":363860,"updated":"2024-04-23T20:52:51Z","groups":["KeyframeAnimation"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"Used internally by the Key Frame Animation system. Executed when a new mission is loaded.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Key Frame Animation"]},{"name":"BIS_fnc_3den_onMissionNew","title":"BIS fnc 3den onMissionNew","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3den_onMissionNew","revid":363857,"updated":"2024-04-23T20:52:50Z","groups":["KeyframeAnimation"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"Used internally by the Key Frame Animation system. Executed when a new mission is created.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Key Frame Animation"]},{"name":"BIS_fnc_3den_onMissionPreviewEnd","title":"BIS fnc 3den onMissionPreviewEnd","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3den_onMissionPreviewEnd","revid":363862,"updated":"2024-04-23T20:52:52Z","groups":["KeyframeAnimation"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"Used internally by the Key Frame Animation system. Executed when preview ended.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Key Frame Animation"]},{"name":"BIS_fnc_3den_onSelectionChange","title":"BIS fnc 3den onSelectionChange","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3den_onSelectionChange","revid":363861,"updated":"2024-04-23T20:52:51Z","groups":["KeyframeAnimation"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"Used internally by the Key Frame Animation system.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Key Frame Animation"]},{"name":"BIS_fnc_3DENAttributeDoorStates","title":"BIS fnc 3DENAttributeDoorStates","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3DENAttributeDoorStates","revid":342156,"updated":"2023-07-09T12:26:50Z","groups":["Eden Editor"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Internal function used for the Eden Editor Edit Terrain Object module.","syntaxes":[{"syntax":"[] call BIS_fnc_3DENAttributeDoorStates","params":[],"returns":null}],"examples":[{"text":"-"}],"see_also":["Modules"]},{"name":"BIS_fnc_3DENCamera","title":"BIS fnc 3DENCamera","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3DENCamera","revid":348933,"updated":"2023-11-08T14:44:07Z","groups":["Eden Editor"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Moves Eden's camera depending on one of two modes:\n\n- \"random\" - A random position over land preferring non forested areas\n- \"selected\" - The current selected Eden entity or users cursor position if nothing is selected","syntaxes":[{"syntax":"[mode] call BIS_fnc_3DENCamera","params":[{"name":"mode","type":"String","description":"option mode to use","type_expr":"String"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"Move Eden's camera to the currently selected Eden entity\n\n```sqf\n[\"selected\"] call BIS_fnc_3DENCamera;\n```","code":["[\"selected\"] call BIS_fnc_3DENCamera;"]},{"text":"Move Eden's camera to a random position\n\n```sqf\n[\"random\"] call BIS_fnc_3DENCamera;\n```","code":["[\"random\"] call BIS_fnc_3DENCamera;"]}],"see_also":["BIS_fnc_3DENControlsHint","BIS_fnc_3DENDiagCreateList","BIS_fnc_3DENDiagFonts","BIS_fnc_3DENDiagMouseControl","BIS_fnc_3DENDrawLocations","BIS_fnc_3DENEntityMenu","BIS_fnc_3DENExportAttributes","BIS_fnc_3DENExportOldSQM","BIS_fnc_3DENExportTerrainBuilder","BIS_fnc_3DENFlashlight","BIS_fnc_3DENGrid","BIS_fnc_3DENIntel","BIS_fnc_3DENInterface","BIS_fnc_3DENListLocations","BIS_fnc_3DENMissionPreview","BIS_fnc_3DENModuleDescription","BIS_fnc_3DENShowMessage","BIS_fnc_3DENStatusBar","BIS_fnc_3DENToolbar","BIS_fnc_3DENTutorial","BIS_fnc_3DENVisionMode"]},{"name":"BIS_fnc_3DENControlsHint","title":"BIS fnc 3DENControlsHint","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3DENControlsHint","revid":379240,"updated":"2026-10-30T23:17:38Z","groups":["Eden Editor"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Used by Eden to display control hints for the current Eden operation as seen in the bottom right corner of the Editor display.","syntaxes":[{"syntax":"[mode] call BIS_fnc_3DENControlsHint","params":[{"name":"mode","type":"String","description":"**case-sensitive**, can be one of:\n\n- \"show\" - Shows controls hints\n- \"hide\" - Hides controls hints\n- \"toggle\" - Toggles controls hints","type_expr":"String"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"toggle\"] call BIS_fnc_3DENControlsHint; // toggle Eden controls hints"]}],"see_also":["BIS_fnc_3DENCamera","BIS_fnc_3DENDiagCreateList","BIS_fnc_3DENDiagFonts","BIS_fnc_3DENDiagMouseControl","BIS_fnc_3DENDrawLocations","BIS_fnc_3DENEntityMenu","BIS_fnc_3DENExportAttributes","BIS_fnc_3DENExportOldSQM","BIS_fnc_3DENExportTerrainBuilder","BIS_fnc_3DENFlashlight","BIS_fnc_3DENGrid","BIS_fnc_3DENIntel","BIS_fnc_3DENInterface","BIS_fnc_3DENListLocations","BIS_fnc_3DENMissionPreview","BIS_fnc_3DENModuleDescription","BIS_fnc_3DENShowMessage","BIS_fnc_3DENStatusBar","BIS_fnc_3DENToolbar","BIS_fnc_3DENTutorial","BIS_fnc_3DENVisionMode"],"notes":[{"user":"Larrow","date":"2017-07-23T02:34:00Z","text":"Although a lot of this function may be of no use to the end user there are a number of UINamespace variables a designer may find helpful\n\n**uiNamespace getVariable \"BIS_fnc_3DENControlsHint_selected\"**\n\ndefault - [0,[0,0,0,0,0,0],[[],[],[],[],[],[]]]\n\n- 0 - total number of selected Eden entities\n- 1 - count of selected Eden entities by type\n  - 0 - units\n  - 1 - groups\n  - 2 - triggers\n  - 3 - waypoints\n  - 4 - logics/systems/modules\n  - 5 - markers\n- 2 - same results as get3DENSelected \"\" . Which is the same order as above for counts\n\n**uiNamespace getVariable \"BIS_fnc_3DENControlsHint_place\"**\n\ndefault - [\"\", false]\n\n- 0 - Class name of current Eden entity being placed\n- 1 - true if class simulation type is a kind of vehicle\n\n[\"car\",\"carx\",\"tank\",\"tankx\",\"helicopter\",\"helicopterx\",\n\"helicopterrtd\",\"airplane\",\"airplanex\",\"ship\",\"shipx\",\n\"submarinex\",\"hovercraftx\",\"motorcycle\",\"parachute\",\"paraglide\"]\n\n**uiNamespace getVariable \"BIS_fnc_3DENControlsHint_mouseButtons\"**\n\ndefault - [false, false]\n\n- 0 - left mouse button is down in Asset tree\n- 1 - right mouse button is down in Asset tree\n\n**uiNamespace getVariable \"BIS_fnc_3DENControlsHint_connect\"**\n\ndefault - [\"\", \"\"]\n\n- 0 - text description of current connection being made eg \"Sync to\"\n- 1 - config path to CfgWrapperUI cursor texture\n\n**uiNamespace getVariable \"BIS_fnc_3DENControlsHint_pos\"**\n\ndefault - [1.40902,1.37676,0.309598,0.401606] - may vary between different setups\ndefault position and size of Eden controls hint - ctrlPosition"}]},{"name":"BIS_fnc_3DENDiagCreateList","title":"BIS fnc 3DENDiagCreateList","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3DENDiagCreateList","revid":342197,"updated":"2023-07-09T12:27:13Z","groups":["Eden Editor"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"Copies all in Eden Editor available objects to the clipboard.","syntaxes":[{"syntax":"class call BIS_fnc_3DENDiagCreateList","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_3DENDiagCreateList;"]}],"see_also":["BIS_fnc_3DENCamera","BIS_fnc_3DENControlsHint","BIS_fnc_3DENDiagFonts","BIS_fnc_3DENDiagMouseControl","BIS_fnc_3DENDrawLocations","BIS_fnc_3DENEntityMenu","BIS_fnc_3DENExportAttributes","BIS_fnc_3DENExportOldSQM","BIS_fnc_3DENExportTerrainBuilder","BIS_fnc_3DENFlashlight","BIS_fnc_3DENGrid","BIS_fnc_3DENIntel","BIS_fnc_3DENInterface","BIS_fnc_3DENListLocations","BIS_fnc_3DENMissionPreview","BIS_fnc_3DENModuleDescription","BIS_fnc_3DENShowMessage","BIS_fnc_3DENStatusBar","BIS_fnc_3DENToolbar","BIS_fnc_3DENTutorial","BIS_fnc_3DENVisionMode"]},{"name":"BIS_fnc_3DENDiagFonts","title":"BIS fnc 3DENDiagFonts","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3DENDiagFonts","revid":342196,"updated":"2023-07-09T12:27:13Z","groups":["Eden Editor"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"Displays given font in various different sizes. The fontID is the index of the font in `configFile >> \"CfgFontFamilies\"`.\nFonts for Arma 3 v2.00:\n\n1. LucidaConsoleB\n1. TahomaB\n1. EtelkaMonospacePro\n1. LCD14\n1. EtelkaMonospaceProBold\n1. EtelkaNarrowMediumPro\n1. PuristaBold\n1. PuristaLight\n1. PuristaMedium\n1. PuristaSemibold\n1. RobotoCondensed\n1. RobotoCondensedBold\n1. RobotoCondensedLight\n1. Caveat","syntaxes":[{"syntax":"fontID call BIS_fnc_3DENDiagFonts","params":[{"name":"fontID","type":"Number","type_expr":"Number"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["2 call BIS_fnc_3DENDiagFonts;"]}],"see_also":["BIS_fnc_3DENCamera","BIS_fnc_3DENControlsHint","BIS_fnc_3DENDiagCreateList","BIS_fnc_3DENDiagMouseControl","BIS_fnc_3DENDrawLocations","BIS_fnc_3DENEntityMenu","BIS_fnc_3DENExportAttributes","BIS_fnc_3DENExportOldSQM","BIS_fnc_3DENExportTerrainBuilder","BIS_fnc_3DENFlashlight","BIS_fnc_3DENGrid","BIS_fnc_3DENIntel","BIS_fnc_3DENInterface","BIS_fnc_3DENListLocations","BIS_fnc_3DENMissionPreview","BIS_fnc_3DENModuleDescription","BIS_fnc_3DENShowMessage","BIS_fnc_3DENStatusBar","BIS_fnc_3DENToolbar","BIS_fnc_3DENTutorial","BIS_fnc_3DENVisionMode"],"notes":[{"user":"7erra","date":"2020-11-01T15:36:00Z","text":"Code used to generate list:\n\n```sqf\n_version = str(productVersion select 2);\n_version = format[\"%1.%2\", _version select [0,1], _version select [1, count _version]];\n_firstLine = format [\"Fonts for {{GVI|arma3|%1}}:\n\", _version];\n_s = [_firstLine, \"<ol start{{=}}\"\"0\"\" style=\"\"column-count: 3\"\">\"];\n_cfgFonts = configProperties [configfile >> \"cfgfontfamilies\",\"isclass _x\"];\n_cfgFonts apply {\n    _s pushBack format[\"<li>%1</li>\", configName _x];\n};\n_s pushBack \"</ol>\";\n_s = _s joinString endl;\ncopyToClipboard _s;\n_s;\n```"}]},{"name":"BIS_fnc_3DENDiagMouseControl","title":"BIS fnc 3DENDiagMouseControl","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3DENDiagMouseControl","revid":342184,"updated":"2023-07-09T12:27:02Z","groups":["Eden Editor"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"Creates a display which highlights currently pressed mouse buttons and CTRL, ALT or SHIFT key.","syntaxes":[{"syntax":"call BIS_fnc_3DENDiagMouseControl","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_3DENDiagMouseControl;"]}],"see_also":["BIS_fnc_3DENCamera","BIS_fnc_3DENControlsHint","BIS_fnc_3DENDiagCreateList","BIS_fnc_3DENDiagFonts","BIS_fnc_3DENDrawLocations","BIS_fnc_3DENEntityMenu","BIS_fnc_3DENExportAttributes","BIS_fnc_3DENExportOldSQM","BIS_fnc_3DENExportTerrainBuilder","BIS_fnc_3DENFlashlight","BIS_fnc_3DENGrid","BIS_fnc_3DENIntel","BIS_fnc_3DENInterface","BIS_fnc_3DENListLocations","BIS_fnc_3DENMissionPreview","BIS_fnc_3DENModuleDescription","BIS_fnc_3DENShowMessage","BIS_fnc_3DENStatusBar","BIS_fnc_3DENToolbar","BIS_fnc_3DENTutorial","BIS_fnc_3DENVisionMode"]},{"name":"BIS_fnc_3DENDrawLocations","title":"BIS fnc 3DENDrawLocations","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3DENDrawLocations","revid":342141,"updated":"2023-07-09T12:26:47Z","groups":["Eden Editor"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Internal function used by Eden Editor to draw locations.","syntaxes":[{"syntax":"[] call BIS_fnc_3DENDrawLocations","params":[],"returns":null}],"examples":[{"text":"-"}],"see_also":["BIS_fnc_3DENCamera","BIS_fnc_3DENControlsHint","BIS_fnc_3DENDiagCreateList","BIS_fnc_3DENDiagFonts","BIS_fnc_3DENDiagMouseControl","BIS_fnc_3DENEntityMenu","BIS_fnc_3DENExportAttributes","BIS_fnc_3DENExportOldSQM","BIS_fnc_3DENExportTerrainBuilder","BIS_fnc_3DENFlashlight","BIS_fnc_3DENGrid","BIS_fnc_3DENIntel","BIS_fnc_3DENInterface","BIS_fnc_3DENListLocations","BIS_fnc_3DENMissionPreview","BIS_fnc_3DENModuleDescription","BIS_fnc_3DENShowMessage","BIS_fnc_3DENStatusBar","BIS_fnc_3DENToolbar","BIS_fnc_3DENTutorial","BIS_fnc_3DENVisionMode"]},{"name":"BIS_fnc_3DENEntityMenu","title":"BIS fnc 3DENEntityMenu","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3DENEntityMenu","revid":342170,"updated":"2023-07-09T12:26:57Z","groups":["Eden Editor"],"status":"ok","games":{"arma3":"1.58"},"since":"arma3 1.58","arma3_since":"1.58","description":"Excutes actions available in the entity menu (context menu).","syntaxes":[{"syntax":"[mode] call BIS_fnc_3DENEntityMenu","params":[{"name":"mode","type":"String","description":"case insensitive. Can be:\n\n- \"onEntityMenu\"\n- \"reset\"\n- \"moveCamera\"\n- \"playFromHere\"\n- \"playAsEntity\"\n- \"grid\"\n- \"arsenal\"\n- \"arsenalReset\"\n- \"garage\"\n- \"garageReset\"\n- \"findCreate\"\n- \"findConfig\"\n- \"logClasses\"\n- \"logPosition\"","type_expr":"String"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"reset\"] call BIS_fnc_3DENEntityMenu;"]}],"see_also":["BIS_fnc_3DENCamera","BIS_fnc_3DENControlsHint","BIS_fnc_3DENDiagCreateList","BIS_fnc_3DENDiagFonts","BIS_fnc_3DENDiagMouseControl","BIS_fnc_3DENDrawLocations","BIS_fnc_3DENExportAttributes","BIS_fnc_3DENExportOldSQM","BIS_fnc_3DENExportTerrainBuilder","BIS_fnc_3DENFlashlight","BIS_fnc_3DENGrid","BIS_fnc_3DENIntel","BIS_fnc_3DENInterface","BIS_fnc_3DENListLocations","BIS_fnc_3DENMissionPreview","BIS_fnc_3DENModuleDescription","BIS_fnc_3DENShowMessage","BIS_fnc_3DENStatusBar","BIS_fnc_3DENToolbar","BIS_fnc_3DENTutorial","BIS_fnc_3DENVisionMode"]},{"name":"BIS_fnc_3DENExportAttributes","title":"BIS fnc 3DENExportAttributes","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3DENExportAttributes","revid":364854,"updated":"2024-06-25T09:14:18Z","groups":["Eden Editor"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"Copies all available attributes to the clipboard.","syntaxes":[{"syntax":"class call BIS_fnc_3DENExportAttributes","params":[{"name":"mode","type":"String","optional":true,"default":"\"Object\"","description":"type of attributes to be exported (case-insensitive). Classes from `configFile >> \"Cfg3DEN\"`:\n\n- `\"Attributes\"`\n- `\"Camera\"`\n- `\"Comment\"`\n- `\"Connections\"`\n- `\"Default\"`\n- `\"EventHandlers\"`\n- `\"Favorites\"`\n- `\"Group\"`\n- `\"History\"`\n- `\"Layer\"`\n- `\"Logic\"`\n- `\"Marker\"`\n- `\"Messages\"`\n- `\"Mission\"`\n- `\"Notifications\"`\n- `\"Object\"`\n- `\"Trigger\"`\n- `\"Tutorials\"`\n- `\"Updates\"`\n- `\"Waypoint\"`","type_expr":"String","text":"mode: String - (Optional, default \"Object\") type of attributes to be exported (case-insensitive). Classes from `configFile >> \"Cfg3DEN\"`:\n\n- `\"Attributes\"`\n- `\"Camera\"`\n- `\"Comment\"`\n- `\"Connections\"`\n- `\"Default\"`\n- `\"EventHandlers\"`\n- `\"Favorites\"`\n- `\"Group\"`\n- `\"History\"`\n- `\"Layer\"`\n- `\"Logic\"`\n- `\"Marker\"`\n- `\"Messages\"`\n- `\"Mission\"`\n- `\"Notifications\"`\n- `\"Object\"`\n- `\"Trigger\"`\n- `\"Tutorials\"`\n- `\"Updates\"`\n- `\"Waypoint\"`"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["\"Trigger\" call BIS_fnc_3DENExportAttributes;"]}],"see_also":["BIS_fnc_3DENCamera","BIS_fnc_3DENControlsHint","BIS_fnc_3DENDiagCreateList","BIS_fnc_3DENDiagFonts","BIS_fnc_3DENDiagMouseControl","BIS_fnc_3DENDrawLocations","BIS_fnc_3DENEntityMenu","BIS_fnc_3DENExportOldSQM","BIS_fnc_3DENExportTerrainBuilder","BIS_fnc_3DENFlashlight","BIS_fnc_3DENGrid","BIS_fnc_3DENIntel","BIS_fnc_3DENInterface","BIS_fnc_3DENListLocations","BIS_fnc_3DENMissionPreview","BIS_fnc_3DENModuleDescription","BIS_fnc_3DENShowMessage","BIS_fnc_3DENStatusBar","BIS_fnc_3DENToolbar","BIS_fnc_3DENTutorial","BIS_fnc_3DENVisionMode"]},{"name":"BIS_fnc_3DENExportOldSQM","title":"BIS fnc 3DENExportOldSQM","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3DENExportOldSQM","revid":342122,"updated":"2023-07-09T12:26:41Z","groups":["Eden Editor"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"Export current mission (usually in Eden Editor) in 2D Editor format to the clipboard.","syntaxes":[{"syntax":"call BIS_fnc_3DENExportOldSQM","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","description":"old SQM is copied to the clipboard"}}],"examples":[{"text":"See Debug Console\n\n```sqf\ncall BIS_fnc_3DENExportOldSQM; // execute in debug console\n```","code":["call BIS_fnc_3DENExportOldSQM; // execute in debug console"]}],"see_also":["2D Editor"]},{"name":"BIS_fnc_3DENExportSQF","title":"BIS fnc 3DENExportSQF","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3DENExportSQF","revid":348022,"updated":"2023-11-08T11:22:58Z","groups":["Eden Editor"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Export 3DEN mission to SQF script. When called, the script will dynamically recreate the mission.","syntaxes":[{"syntax":"[showWindow,exportLayers,center,checkBlacklist] call BIS_fnc_3DENExportSQF","params":[{"name":"showWindow","type":"Boolean","optional":true,"default":"true","description":"true to show window with script code","type_expr":"Boolean","text":"showWindow: Boolean - (Optional, default true) true to show window with script code"},{"name":"exportLayers","type":"Boolean","optional":true,"default":"true","description":"true to export layers as conditions (it's possible to create only specific layers using params passed to the exported script)","type_expr":"Boolean","text":"exportLayers: Boolean - (Optional, default true) true to export layers as conditions (it's possible to create only specific layers using params passed to the exported script)"},{"name":"center","type":"Array format Position","optional":true,"default":"[0,0,0]","description":"center position, all entity positions will be exported as relative","type_expr":"Position","types":["Array","Position"],"text":"center: Array format Position - (Optional, default [0,0,0]) center position, all entity positions will be exported as relative"},{"name":"checkBlacklist","type":"Boolean","optional":true,"default":"false","description":"true to export with check if specific entity ID was blacklisted","type_expr":"Boolean","text":"checkBlacklist: Boolean - (Optional, default false) true to export with check if specific entity ID was blacklisted"}],"returns":{"type":"Array","type_expr":"Array","description":"in form [[objects,groups,triggers,waypoints,logics,markers],[objectIDs,groupIDs,triggerIDs,waypointIDs,logicIDs,markerIDs]]","text":"Array in form [[objects,groups,triggers,waypoints,logics,markers],[objectIDs,groupIDs,triggerIDs,waypointIDs,logicIDs,markerIDs]]"}}],"examples":[{"code":["[true, false, [1337,1337,0], true] call BIS_fnc_3DENExportSQF;"]}]},{"name":"BIS_fnc_3DENExportTerrainBuilder","title":"BIS fnc 3DENExportTerrainBuilder","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3DENExportTerrainBuilder","revid":342143,"updated":"2023-07-09T12:26:47Z","groups":["Eden Editor"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"Gets all empty vehicles placed in the currently opened Eden mission and converts data into the format used by the Terrain Builder.","syntaxes":[{"syntax":"call BIS_fnc_3DENExportTerrainBuilder","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_3DENExportTerrainBuilder;"]}],"see_also":["Terrain Builder"]},{"name":"BIS_fnc_3DENFlashlight","title":"BIS fnc 3DENFlashlight","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3DENFlashlight","revid":349107,"updated":"2023-11-08T14:49:36Z","groups":["Eden Editor"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"Toggle or set Eden Editor flashlight (light source snapped to the camera).","syntaxes":[{"syntax":"mode call BIS_fnc_3DENFlashlight","params":[{"name":"mode","type":"Number","description":"can be:\n\n- -2: restore the current mode\n- -1: toggle mode\n-  0: off\n-  1: on","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number","description":"selected mode"}}],"examples":[{"code":["private _mode = 0 call BIS_fnc_3DENFlashlight;"]}],"see_also":["BIS_fnc_3DENCamera","BIS_fnc_3DENControlsHint","BIS_fnc_3DENDiagCreateList","BIS_fnc_3DENDiagFonts","BIS_fnc_3DENDiagMouseControl","BIS_fnc_3DENDrawLocations","BIS_fnc_3DENEntityMenu","BIS_fnc_3DENExportAttributes","BIS_fnc_3DENExportOldSQM","BIS_fnc_3DENExportTerrainBuilder","BIS_fnc_3DENGrid","BIS_fnc_3DENIntel","BIS_fnc_3DENInterface","BIS_fnc_3DENListLocations","BIS_fnc_3DENMissionPreview","BIS_fnc_3DENModuleDescription","BIS_fnc_3DENShowMessage","BIS_fnc_3DENStatusBar","BIS_fnc_3DENToolbar","BIS_fnc_3DENTutorial","BIS_fnc_3DENVisionMode"]},{"name":"BIS_fnc_3DENGrid","title":"BIS fnc 3DENGrid","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3DENGrid","revid":348431,"updated":"2023-11-08T13:00:12Z","groups":["Eden Editor"],"status":"ok","games":{"arma3":"1.58"},"since":"arma3 1.58","arma3_since":"1.58","description":"Handles action when grid button is pressed in the toolbar in Eden Editor.","syntaxes":[{"syntax":"[mode, input] call BIS_fnc_3DENGrid","params":[{"name":"mode","type":"String","description":"can be:\n\n- \"increase\"\n- \"decrease\"\n- \"init\"\n- \"OnGridChange\"","type_expr":"String"},{"name":"input","type":"Array","description":"array in form:\n0: Control\n1: Config - Path to control","type_expr":"Array"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"-"}],"see_also":["BIS_fnc_3DENCamera","BIS_fnc_3DENControlsHint","BIS_fnc_3DENDiagCreateList","BIS_fnc_3DENDiagFonts","BIS_fnc_3DENDiagMouseControl","BIS_fnc_3DENDrawLocations","BIS_fnc_3DENEntityMenu","BIS_fnc_3DENExportAttributes","BIS_fnc_3DENExportOldSQM","BIS_fnc_3DENExportTerrainBuilder","BIS_fnc_3DENFlashlight","BIS_fnc_3DENIntel","BIS_fnc_3DENInterface","BIS_fnc_3DENListLocations","BIS_fnc_3DENMissionPreview","BIS_fnc_3DENModuleDescription","BIS_fnc_3DENShowMessage","BIS_fnc_3DENStatusBar","BIS_fnc_3DENToolbar","BIS_fnc_3DENTutorial","BIS_fnc_3DENVisionMode"]},{"name":"BIS_fnc_3DENIntel","title":"BIS fnc 3DENIntel","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3DENIntel","revid":349329,"updated":"2023-11-08T14:53:27Z","groups":["Eden Editor"],"status":"ok","games":{"arma3":"1.58"},"since":"arma3 1.58","arma3_since":"1.58","description":"Is used to set the weather settings in Eden Editor. Internal use only.","syntaxes":[{"syntax":"[controlGroup, value] call BIS_fnc_3DENIntel","params":[{"name":"controlGroup","type":"Control","description":"control group used in Eden Editor to manipulate the weather settings","type_expr":"Control"},{"name":"value","type":"Number","description":"value used for weather settings like setFog","type_expr":"Number"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"-"}],"see_also":["BIS_fnc_3DENCamera","BIS_fnc_3DENControlsHint","BIS_fnc_3DENDiagCreateList","BIS_fnc_3DENDiagFonts","BIS_fnc_3DENDiagMouseControl","BIS_fnc_3DENDrawLocations","BIS_fnc_3DENEntityMenu","BIS_fnc_3DENExportAttributes","BIS_fnc_3DENExportOldSQM","BIS_fnc_3DENExportTerrainBuilder","BIS_fnc_3DENFlashlight","BIS_fnc_3DENGrid","BIS_fnc_3DENInterface","BIS_fnc_3DENListLocations","BIS_fnc_3DENModuleDescription","BIS_fnc_3DENShowMessage","BIS_fnc_3DENStatusBar","BIS_fnc_3DENToolbar","BIS_fnc_3DENTutorial","BIS_fnc_3DENVisionMode"]},{"name":"BIS_fnc_3DENInterface","title":"BIS fnc 3DENInterface","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3DENInterface","revid":342176,"updated":"2023-07-09T12:26:58Z","groups":["Eden Editor"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}],"see_also":["BIS_fnc_3DENCamera","BIS_fnc_3DENControlsHint","BIS_fnc_3DENDiagCreateList","BIS_fnc_3DENDiagFonts","BIS_fnc_3DENDiagMouseControl","BIS_fnc_3DENDrawLocations","BIS_fnc_3DENEntityMenu","BIS_fnc_3DENExportAttributes","BIS_fnc_3DENExportOldSQM","BIS_fnc_3DENExportTerrainBuilder","BIS_fnc_3DENFlashlight","BIS_fnc_3DENGrid","BIS_fnc_3DENIntel","BIS_fnc_3DENListLocations","BIS_fnc_3DENMissionPreview","BIS_fnc_3DENModuleDescription","BIS_fnc_3DENShowMessage","BIS_fnc_3DENStatusBar","BIS_fnc_3DENToolbar","BIS_fnc_3DENTutorial","BIS_fnc_3DENVisionMode"]},{"name":"BIS_fnc_3DENListLocations","title":"BIS fnc 3DENListLocations","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3DENListLocations","revid":348356,"updated":"2023-11-08T12:59:53Z","groups":["Eden Editor"],"status":"ok","games":{"arma3":"1.58"},"since":"arma3 1.58","arma3_since":"1.58","description":"Used in the locations display in Eden Editor. Internal use only.","syntaxes":[{"syntax":"[mode] call BIS_fnc_3DENListLocations","params":[{"name":"mode","type":"String","description":"can be:\n\n- \"init\"\n- \"select\"","type_expr":"String"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"init\"] call BIS_fnc_3DENListLocations;"]}],"see_also":["BIS_fnc_3DENCamera","BIS_fnc_3DENControlsHint","BIS_fnc_3DENDiagCreateList","BIS_fnc_3DENDiagFonts","BIS_fnc_3DENDiagMouseControl","BIS_fnc_3DENDrawLocations","BIS_fnc_3DENEntityMenu","BIS_fnc_3DENExportAttributes","BIS_fnc_3DENExportOldSQM","BIS_fnc_3DENExportTerrainBuilder","BIS_fnc_3DENFlashlight","BIS_fnc_3DENGrid","BIS_fnc_3DENIntel","BIS_fnc_3DENInterface","BIS_fnc_3DENMissionPreview","BIS_fnc_3DENModuleDescription","BIS_fnc_3DENShowMessage","BIS_fnc_3DENStatusBar","BIS_fnc_3DENToolbar","BIS_fnc_3DENTutorial","BIS_fnc_3DENVisionMode"]},{"name":"BIS_fnc_3DENMissionPreview","title":"BIS fnc 3DENMissionPreview","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3DENMissionPreview","revid":342234,"updated":"2023-07-09T12:27:32Z","groups":["Eden Editor"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"> [!IMPORTANT]\n> This function is used internally by the Eden Editor","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["BIS_fnc_3DENCamera","BIS_fnc_3DENControlsHint","BIS_fnc_3DENDiagCreateList","BIS_fnc_3DENDiagFonts","BIS_fnc_3DENDiagMouseControl","BIS_fnc_3DENDrawLocations","BIS_fnc_3DENEntityMenu","BIS_fnc_3DENExportAttributes","BIS_fnc_3DENExportOldSQM","BIS_fnc_3DENExportTerrainBuilder","BIS_fnc_3DENFlashlight","BIS_fnc_3DENGrid","BIS_fnc_3DENIntel","BIS_fnc_3DENInterface","BIS_fnc_3DENListLocations","BIS_fnc_3DENModuleDescription","BIS_fnc_3DENShowMessage","BIS_fnc_3DENStatusBar","BIS_fnc_3DENToolbar","BIS_fnc_3DENTutorial","BIS_fnc_3DENVisionMode"]},{"name":"BIS_fnc_3DENMissionStats","title":"BIS fnc 3DENMissionStats","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3DENMissionStats","revid":281161,"updated":"2021-06-14T09:05:19Z","groups":["Eden Editor","Broken Functions"],"status":"broken","games":{"arma3":"1.96"},"since":"arma3 1.96","arma3_since":"1.96","description":"This functions does nothing.","syntaxes":[{"syntax":"call BIS_fnc_3DENMissionStats","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}]},{"name":"BIS_fnc_3DENModuleDescription","title":"BIS fnc 3DENModuleDescription","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3DENModuleDescription","revid":348233,"updated":"2023-11-08T11:40:29Z","groups":["Eden Editor"],"status":"ok","games":{"arma3":"1.58"},"since":"arma3 1.58","arma3_since":"1.58","description":"Used to display module description in the attribute window.","syntaxes":[{"syntax":"[ctrl,cfg] call BIS_fnc_3DENModuleDescription","params":[{"name":"ctrl","type":"Control","description":"attribute control","type_expr":"Control"},{"name":"cfg","type":"Config","type_expr":"Config"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"-"}],"see_also":["BIS_fnc_3DENCamera","BIS_fnc_3DENControlsHint","BIS_fnc_3DENDiagCreateList","BIS_fnc_3DENDiagFonts","BIS_fnc_3DENDiagMouseControl","BIS_fnc_3DENDrawLocations","BIS_fnc_3DENEntityMenu","BIS_fnc_3DENExportAttributes","BIS_fnc_3DENExportOldSQM","BIS_fnc_3DENExportTerrainBuilder","BIS_fnc_3DENFlashlight","BIS_fnc_3DENGrid","BIS_fnc_3DENIntel","BIS_fnc_3DENInterface","BIS_fnc_3DENListLocations","BIS_fnc_3DENMissionPreview","BIS_fnc_3DENShowMessage","BIS_fnc_3DENStatusBar","BIS_fnc_3DENToolbar","BIS_fnc_3DENTutorial","BIS_fnc_3DENVisionMode"]},{"name":"BIS_fnc_3DENNotification","title":"BIS fnc 3DENNotification","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3DENNotification","revid":352420,"updated":"2024-02-09T15:26:08Z","groups":["Eden Editor"],"status":"ok","games":{"arma3":"1.58"},"since":"arma3 1.58","arma3_since":"1.58","locality":{"effect":"local"},"description":"Shows notification banner with given text, animated or not, at the top of the screen in the Eden Editor.\nSince Arma 3 v2.10 this function will no longer throw an error outside of Eden Editor. Because `Display3DEN` (`findDisplay 313`) is not available, it will only play the sound according to the message type.\nThe sound is played through the UI channel with playSoundUI.","syntaxes":[{"syntax":"[text, type, duration, animate] call BIS_fnc_3DENNotification","params":[{"name":"text","type":"String or Structured Text","description":"either text or class from `\"Cfg3DEN\" >> \"Notifications\"`","type_expr":"String | Structured Text"},{"name":"type","type":"Number","optional":true,"default":"0","description":"0: Notification (Green) 1: Warning (Red)","type_expr":"Number","text":"type: Number - (Optional, default 0) 0: Notification (Green) 1: Warning (Red)"},{"name":"duration","type":"Number","optional":true,"default":"2","description":"duration in seconds (+ 1 sec for each new line)","type_expr":"Number","text":"duration: Number - (Optional, default 2) duration in seconds (+ 1 sec for each new line)"},{"name":"animate","type":"Boolean","optional":true,"default":"true","description":"toggle animation","type_expr":"Boolean","text":"animate: Boolean - (Optional, default true) toggle animation"},{"name":"volume","type":"Number","optional":true,"default":"1","description":"volume adjustment","type_expr":"Number","since":"arma3 2.10","text":"volume: Number - (Optional, default 1) volume adjustment"}],"returns":{"type":"Number","type_expr":"Number","description":"selected Mode"}}],"examples":[{"code":["[\"This is an animated notification\", 0] call BIS_fnc_3DENNotification;"]},{"code":["[\"This is a warning that is not animated\", 1, 2, false] call BIS_fnc_3DENNotification;"]},{"code":["[\"For more information visit <t colorLink='#E69710'><a href='https://community.bistudio.com/wiki/BIS_fnc_3DENNotification'>Community Wiki</a></t>\"] call BIS_fnc_3DENNotification;"]}],"see_also":["BIS_fnc_3DENShowMessage"]},{"name":"BIS_fnc_3DENShowMessage","title":"BIS fnc 3DENShowMessage","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3DENShowMessage","revid":376078,"updated":"2025-07-30T11:33:25Z","groups":["Eden Editor"],"status":"ok","games":{"arma3":"1.58"},"since":"arma3 1.58","arma3_since":"1.58","description":"Shows a pop-up message.\nIn order to skip any optional parameter in between other parameters, send nil as parameter.\n\n> [!NOTE]\n> The following stringtable entries are useful to add custom Code but keep the default button texts:\n>\n> - `\"STR_DISP_OK\"`\n> - `\"STR_DISP_CLOSE\"`\n> - `\"STR_DISP_CANCEL\"`","syntaxes":[{"syntax":"[text, title, buttonOK, buttonCancel, icon, parentDisplay] call BIS_fnc_3DENShowMessage","params":[{"name":"text","type":"String","description":"text to display. Text is parsed and therefore supports Structured Text tags","type_expr":"String"},{"name":"title","type":"String","optional":true,"default":"\"\"","description":"title header","type_expr":"String","text":"title: String - (Optional, default \"\") title header"},{"name":"buttonOK","type":"String, Boolean or Array","optional":true,"default":"\"\"","description":"can be one of:\n\n- String - button's text\n- Boolean - show button or not\n- Array - in format [String or Boolean, Code]:\n  - String or Boolean - same as above\n  - Code - code executed when button is pressed","type_expr":"String | Boolean | Array","text":"buttonOK: String, Boolean or Array - (Optional, default \"\") can be one of:\n\n- String - button's text\n- Boolean - show button or not\n- Array - in format [String or Boolean, Code]:\n  - String or Boolean - same as above\n  - Code - code executed when button is pressed"},{"name":"buttonCancel","type":"String, Boolean or Array","optional":true,"default":"\"\"","description":"can be one of:\n\n- String - button's text\n- Boolean - show button or not\n- Array - in format [String or Boolean, Code]:\n  - String or Boolean - same as above\n  - Code - code executed when button is pressed","type_expr":"String | Boolean | Array","text":"buttonCancel: String, Boolean or Array - (Optional, default \"\") can be one of:\n\n- String - button's text\n- Boolean - show button or not\n- Array - in format [String or Boolean, Code]:\n  - String or Boolean - same as above\n  - Code - code executed when button is pressed"},{"name":"icon","type":"String","optional":true,"default":"\"\"","description":"path to an icon which will be shown on the left side of the message","type_expr":"String","text":"icon: String - (Optional, default \"\") path to an icon which will be shown on the left side of the message"},{"name":"parentDisplay","type":"Display","optional":true,"default":"`findDisplay 313` (Eden Display)","description":"display from which the window is opened","type_expr":"Display","text":"parentDisplay: Display - (Optional, default `findDisplay 313` (Eden Display)) display from which the window is opened"}],"returns":{"type":"Display","type_expr":"Display"}}],"examples":[{"code":["[\"Message\",\"Title of the Message\"] call BIS_fnc_3DENShowMessage;"]},{"text":"```sqf\n[\n    \"Are you sure you want to delete / modify the selected variables?\",\n    \"Delete / Modify\",\n    [\n        \"Yes\",\n        { BIS_Message_Confirmed = true }\n    ],\n    [\n        \"No\",\n        { BIS_Message_Confirmed = false }\n    ],\n    \"\\A3\\ui_f\\data\\map\\markers\\handdrawn\\warning_CA.paa\",\n    findDisplay 313\n] call BIS_fnc_3DENShowMessage;\n```","code":["[\n\t\"Are you sure you want to delete / modify the selected variables?\",\n\t\"Delete / Modify\",\n\t[\n\t\t\"Yes\",\n\t\t{ BIS_Message_Confirmed = true }\n\t],\n\t[\n\t\t\"No\",\n\t\t{ BIS_Message_Confirmed = false }\n\t],\n\t\"\\A3\\ui_f\\data\\map\\markers\\handdrawn\\warning_CA.paa\",\n\tfindDisplay 313\n] call BIS_fnc_3DENShowMessage;"]},{"text":"```sqf\n// Only change the OK button's code\n[\n    \"Are you sure you want to delete / modify the selected variables?\",\n    \"Delete / Modify\",\n    [\n        nil,\n        { BIS_Message_Confirmed = true }\n    ],\n    nil,\n    \"\\A3\\ui_f\\data\\map\\markers\\handdrawn\\warning_CA.paa\",\n    findDisplay 313\n] call BIS_fnc_3DENShowMessage;\n```","code":["// Only change the OK button's code\n[\n\t\"Are you sure you want to delete / modify the selected variables?\",\n\t\"Delete / Modify\",\n\t[\n\t\tnil,\n\t\t{ BIS_Message_Confirmed = true }\n\t],\n\tnil,\n\t\"\\A3\\ui_f\\data\\map\\markers\\handdrawn\\warning_CA.paa\",\n\tfindDisplay 313\n] call BIS_fnc_3DENShowMessage;"]}],"see_also":["BIS_fnc_guiMessage"]},{"name":"BIS_fnc_3DENStatusBar","title":"BIS fnc 3DENStatusBar","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3DENStatusBar","revid":342106,"updated":"2023-07-09T12:26:36Z","groups":["Eden Editor"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}],"see_also":["BIS_fnc_3DENCamera","BIS_fnc_3DENControlsHint","BIS_fnc_3DENDiagCreateList","BIS_fnc_3DENDiagFonts","BIS_fnc_3DENDiagMouseControl","BIS_fnc_3DENDrawLocations","BIS_fnc_3DENEntityMenu","BIS_fnc_3DENExportAttributes","BIS_fnc_3DENExportOldSQM","BIS_fnc_3DENExportTerrainBuilder","BIS_fnc_3DENFlashlight","BIS_fnc_3DENGrid","BIS_fnc_3DENIntel","BIS_fnc_3DENInterface","BIS_fnc_3DENListLocations","BIS_fnc_3DENMissionPreview","BIS_fnc_3DENModuleDescription","BIS_fnc_3DENShowMessage","BIS_fnc_3DENToolbar","BIS_fnc_3DENTutorial","BIS_fnc_3DENVisionMode"]},{"name":"BIS_fnc_3DENToolbar","title":"BIS fnc 3DENToolbar","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3DENToolbar","revid":349085,"updated":"2023-11-08T14:47:24Z","groups":["Eden Editor"],"status":"ok","games":{"arma3":"1.58"},"since":"arma3 1.58","arma3_since":"1.58","description":"Interacts with the Eden Editor toolbar","syntaxes":[{"syntax":"[mode] call BIS_fnc_3DENToolbar","params":[{"name":"mode","type":"String","description":"can be:\n\n- \"init\"\n- \"VerticalToggle\"\n- \"SurfaceSnapToggle\"\n- \"MoveGridToggle\"\n- \"RotateGridToggle\"\n- \"ScaleGridToggle\"\n- \"WidgetToggle\"\n- \"ToggleMap\"\n- \"ToggleVision\"\n- \"ToggleFlashlight\"\n- \"MissionSection\"","type_expr":"String"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"returns true if it was added successfully"}}],"examples":[{"code":["\"ToggleFlashlight\" call BIS_fnc_3DENToolbar;"]}],"see_also":["BIS_fnc_3DENCamera","BIS_fnc_3DENGrid","BIS_fnc_3DENFlashlight"]},{"name":"BIS_fnc_3DENTutorial","title":"BIS fnc 3DENTutorial","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3DENTutorial","revid":348963,"updated":"2023-11-08T14:45:40Z","groups":["Eden Editor"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"Show tutorial in Eden Editor.","syntaxes":[{"syntax":"[path, index, oneStep, display] call BIS_fnc_3DENTutorial","params":[{"name":"path","type":"Array","description":"path in format [<categoryClass>,<tutorialClass>], classes are from **Cfg3DEN >> Tutorials**","type_expr":"Array"},{"name":"index","type":"Number","optional":true,"default":"0","description":"index of step at which tutorial starts","type_expr":"Number","text":"index: Number - (Optional, default 0) index of step at which tutorial starts"},{"name":"oneStep","type":"Boolean","optional":true,"default":"false","description":"true to show only one step, without ability to go forward or backward","type_expr":"Boolean","text":"oneStep: Boolean - (Optional, default false) true to show only one step, without ability to go forward or backward"},{"name":"display","type":"Display","optional":true,"default":"Eden display","description":"display used","type_expr":"Display","text":"display: Display - (Optional, default Eden display) display used"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[[\"Editing\", \"Connecting\"], 0, false] call BIS_fnc_3DENTutorial;"]}],"see_also":["Eden Editor: Configuring Tutorials"]},{"name":"BIS_fnc_3DENVisionMode","title":"BIS fnc 3DENVisionMode","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_3DENVisionMode","revid":349152,"updated":"2023-11-08T14:49:49Z","groups":["Eden Editor"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"Toggle or set Eden Editor vision mode. Has to be executed while Eden interface is opened.","syntaxes":[{"syntax":"mode call BIS_fnc_3DENVisionMode","params":[{"name":"mode","type":"Number","description":"can be:\n\n- -2: restore the current mode\n- -1: toggle mode\n-  0: Normal\n-  1: Night vision\n-  2: Thermal","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number","description":"selected mode"}}],"examples":[{"code":["private _mode = 0 call BIS_fnc_3DENVisionMode;"]}],"see_also":["BIS_fnc_3DENCamera","BIS_fnc_3DENControlsHint","BIS_fnc_3DENDiagCreateList","BIS_fnc_3DENDiagFonts","BIS_fnc_3DENDiagMouseControl","BIS_fnc_3DENDrawLocations","BIS_fnc_3DENEntityMenu","BIS_fnc_3DENExportAttributes","BIS_fnc_3DENExportOldSQM","BIS_fnc_3DENExportTerrainBuilder","BIS_fnc_3DENFlashlight","BIS_fnc_3DENGrid","BIS_fnc_3DENIntel","BIS_fnc_3DENInterface","BIS_fnc_3DENListLocations","BIS_fnc_3DENMissionPreview","BIS_fnc_3DENModuleDescription","BIS_fnc_3DENShowMessage","BIS_fnc_3DENStatusBar","BIS_fnc_3DENToolbar","BIS_fnc_3DENTutorial"]},{"name":"BIS_fnc_AAN","title":"BIS fnc AAN","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_AAN","revid":328448,"updated":"2022-07-13T16:04:00Z","groups":["GUI"],"status":"ok","games":{"arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2oa 1.50","arma3_since":"0.50","exec":"spawn","description":"Add an AAN overlay to the screen, with one headline and a rolling text on the bottom.","syntaxes":[{"syntax":"[headline, rollingText] spawn BIS_fnc_AAN","params":[{"name":"headline","type":"Structured Text","description":"main title, shown in bigger size","type_expr":"Structured Text"},{"name":"rollingText","type":"Structured Text","description":"bottom text under *headline* scrolling right to left","type_expr":"Structured Text"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"```sqf\n[\n    parseText \"<t size='2'>AAN live in Takistan</t>\",\n    parseText \"Weather coming up hot and steamy - Takistan shelled again from border area\"\n] spawn BIS_fnc_AAN;\n```","code":["[\n\tparseText \"<t size='2'>AAN live in Takistan</t>\",\n\tparseText \"Weather coming up hot and steamy - Takistan shelled again from border area\"\n] spawn BIS_fnc_AAN;"]}],"see_also":["parseText","BIS_fnc_showAANArticle"],"notes":[{"user":"Triteyker-","date":"2014-09-28T19:42:00Z","text":"Maximum size (added with <t size='x'></t> parameters) for the headline is 2 if you want another, size 1 text under it. Size 2.5 to 3 seems to be the max size for the headline if you don't want it to disappear.\nRolling text size has to be 1 or else it disappears entirely. Time in the bottom right is ingame time (see setDate). Do note that this function cannot center on an object, and additional camera work is required to achieve such effects. It merely adds an overlay to the screen, and the player retains control even with the overlay active."},{"user":"Jaffa","date":"2015-08-05T22:38:00Z","text":"To remove the overlay you must close the display from the BIS_AAN UI Namespace variable.\ni.e.\n\n```sqf\n(uiNamespace getVariable \"BIS_AAN\") closeDisplay 1;\n```"}]},{"name":"BIS_fnc_absSpeed","title":"BIS fnc absSpeed","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_absSpeed","revid":376534,"updated":"2025-10-25T14:37:02Z","groups":["Object Manipulation"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Returns absolute speed of a vehicle in kilometres per hour (km/h).","syntaxes":[{"syntax":"Object call BIS_fnc_absSpeed","params":[{"name":"Object","description":"vehicle","type_expr":"Object"}],"returns":{"type":"Number","type_expr":"Number"}}],"examples":[{"text":"```sqf\nif (((vehicle player) call BIS_fnc_absSpeed) > 150) then\n{\n    hint \"There goes my driver's license :(\";\n};\n```","code":["if (((vehicle player) call BIS_fnc_absSpeed) > 150) then\n{\n\thint \"There goes my driver's license :(\";\n};"]},{"code":["_kmh = (vehicle player) call BIS_fnc_absSpeed;\n_mph = _kmh / 1.609344; // miles per hour"]}],"see_also":["speed"]},{"name":"BIS_fnc_activateAddons","title":"BIS fnc activateAddons","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_activateAddons","revid":348644,"updated":"2023-11-08T13:48:23Z","groups":["Systems"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"server_exec":true},"description":"Activate addons upon mission start. Doesn't work when the mission is already running.","syntaxes":[{"syntax":"[addons] call BIS_fnc_activateAddons","params":[{"name":"addons","type":"Array of Strings","description":"addon classes from CfgPatches or object classes from CfgVehicles","type_expr":"Array<String>"}],"returns":{"type":"Array of Strings","type_expr":"Array<String>","description":"activated addons"}}],"examples":[{"code":["[\"class_1\",\"class_2\"] call BIS_fnc_activateAddons;"]}],"see_also":["activateAddons","unitAddons","activatedAddons"]},{"name":"BIS_fnc_addClassOO","title":"BIS fnc addClassOO","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_addClassOO","revid":348326,"updated":"2023-11-08T12:59:44Z","groups":["OO"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Registering a class for the OO scripting shell.","syntaxes":[{"syntax":"class call BIS_fnc_addClassOO","params":[{"name":"class","type":"String","description":"class for the OO scripting shell\n\n> [!IMPORTANT]\n> Class has to exist in CfgOO","type_expr":"String"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["\"someOOClass\" call BIS_fnc_addClassOO;"]}],"see_also":["BIS_fnc_createObjectOO"]},{"name":"BIS_fnc_addCommMenuItem","title":"BIS fnc addCommMenuItem","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_addCommMenuItem","revid":376524,"updated":"2025-10-23T22:35:51Z","groups":["Communication Menu"],"status":"ok","games":{"arma3":"0.50"},"since":"arma3 0.50","arma3_since":"0.50","locality":{"argument":"local","effect":"local"},"description":"Add communication menu to the given unit.\n\nThe item will be available in the Communication menu and visualized in comm menu icon area.","syntaxes":[{"syntax":"[owner, itemClass, textArguments, expressionArguments, notification] call BIS_fnc_addCommMenuItem","params":[{"name":"owner","type":"Object","description":"object to which the item belongs","type_expr":"Object","text":"**owner**: Object - object to which the item belongs"},{"name":"itemClass","type":"String","description":"`CfgCommunicationMenu` class","type_expr":"String","text":"**itemClass**: String - `CfgCommunicationMenu` class"},{"name":"textArguments","type":"Anything","optional":true,"description":"additional info to display in the `text` attribute. `%1` will be replaced by the first array element, `%2` with the second and so on.","type_expr":"Anything","text":"**textArguments**: Anything - (Optional) additional info to display in the `text` attribute. `%1` will be replaced by the first array element, `%2` with the second and so on."},{"name":"expressionArguments","type":"Anything","optional":true,"description":"similar to **textArguments**, just this time in the `expression` attribute.","type_expr":"Anything","text":"**expressionArguments**: Anything - (Optional) similar to **textArguments**, just this time in the `expression` attribute."},{"name":"notification","type":"String","optional":true,"description":"notification class from `CfgNotifications`. Empty string will disabled the notification.","type_expr":"String","text":"**notification**: String - (Optional) notification class from `CfgNotifications`. Empty string will disabled the notification."}],"returns":{"type":"Number","type_expr":"Number","description":"item ID, used in BIS_fnc_removeCommMenuItem"}}],"examples":[{"code":["private _supportHeli = [player, \"Support_Request_CAS_Heli\"] call BIS_fnc_addCommMenuItem;\n_supportHeli = [player, \"Support_Request_CAS_Heli\", nil, nil, \"\"] call BIS_fnc_addCommMenuItem; // do not show notification"]}],"see_also":["BIS_fnc_removeCommMenuItem","Arma 3: Communication Menu"]},{"name":"BIS_fnc_addCuratorAreaFromTrigger","title":"BIS fnc addCuratorAreaFromTrigger","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_addCuratorAreaFromTrigger","revid":348813,"updated":"2023-11-08T14:38:17Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Add curator editing / camera area based on triggers.","syntaxes":[{"syntax":"[curatorLogic, triggers, checkedPosition, triggerType, editingArea, cameraArea] call BIS_fnc_addCuratorAreaFromTrigger","params":[{"name":"curatorLogic","type":"Logic","description":"curator logic","type_expr":"Logic"},{"name":"triggers","type":"Array","description":"list of triggers","type_expr":"Array"},{"name":"checkedPosition","type":"Anything","description":"checked position. Check BIS_fnc_position for supported data types","type_expr":"Anything"},{"name":"triggerType","type":"Boolean","description":"true to use a trigger nearest to the *checkedPosition*, false to use all triggers which the position is in","type_expr":"Boolean"},{"name":"editingArea","type":"Boolean","description":"true to add editing area","type_expr":"Boolean"},{"name":"cameraArea","type":"Boolean","description":"true to add camera area","type_expr":"Boolean"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[BIS_curator, [trigger_1,trigger_2], [0,0,0], true, true, true] call BIS_fnc_addCuratorAreaFromTrigger;"]}],"see_also":["Arma 3: Curator"]},{"name":"BIS_fnc_addCuratorChallenge","title":"BIS fnc addCuratorChallenge","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_addCuratorChallenge","revid":279021,"updated":"2021-06-13T21:47:50Z","groups":["CuratorChallenges"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","locality":{"server_exec":true},"description":"Add challenges for curator to complete","syntaxes":[{"syntax":"[param0] call BIS_fnc_addCuratorChallenge","params":[{"name":"param0","type":"Object","type_expr":"Object","optional":true,"default":"all challenges","description":"curator\n1 (Optional): ARRAY - list of supported challenges from CfgCuratorChallenges (default: all challenges)\n2 (Optional): NUMBER - number of added challenges (default: 3)\n3 (Optional): CODE - condition for challenges to remain active {default: true}\n4 (optional):\n    CODE or [CODE,STRING] - code executed upon completing all challenges and reward description\n    Arguments passed to the code are:\n        0: OBJECT - curator\n        1: NUMBER - number of previously completed challenges by given curator\n        2: STRING - parent task ID\n5 (Optional): STRING - parent task ID","text":"0: OBJECT - curator\n1 (Optional): ARRAY - list of supported challenges from CfgCuratorChallenges (default: all challenges)\n2 (Optional): NUMBER - number of added challenges (default: 3)\n3 (Optional): CODE - condition for challenges to remain active {default: true}\n4 (optional):\n    CODE or [CODE,STRING] - code executed upon completing all challenges and reward description\n    Arguments passed to the code are:\n        0: OBJECT - curator\n        1: NUMBER - number of previously completed challenges by given curator\n        2: STRING - parent task ID\n5 (Optional): STRING - parent task ID","source":"docblock"}],"returns":{"type":"String","type_expr":"String","description":"ID of parent task under which all challenge tasks are","text":"STRING - ID of parent task under which all challenge tasks are","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nAdd challenges for curator to complete\n\nParameter(s):\n    0: OBJECT - curator\n    1 (Optional): ARRAY - list of supported challenges from CfgCuratorChallenges (default: all challenges)\n    2 (Optional): NUMBER - number of added challenges (default: 3)\n    3 (Optional): CODE - condition for challenges to remain active {default: true}\n    4 (optional):\n        CODE or [CODE,STRING] - code executed upon completing all challenges and reward description\n        Arguments passed to the code are:\n            0: OBJECT - curator\n            1: NUMBER - number of previously completed challenges by given curator\n            2: STRING - parent task ID\n    5 (Optional): STRING - parent task ID\n\nReturns:\nSTRING - ID of parent task under which all challenge tasks are"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_addCuratorIcon","title":"BIS fnc addCuratorIcon","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_addCuratorIcon","revid":349435,"updated":"2023-11-08T16:27:36Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Add an icon displayed in curator interface.","syntaxes":[{"syntax":"[object, iconParams, map, 3D] call BIS_fnc_addCuratorIcon","params":[{"name":"object","type":"Object","description":"curator module","type_expr":"Object"},{"name":"iconParams","type":"Array","description":"icon params (see drawIcon3D scripting command for its format)","type_expr":"Array"},{"name":"map","type":"Boolean","optional":true,"default":"true","description":"true to show icon on map","type_expr":"Boolean","text":"map: Boolean - (Optional, default true) true to show icon on map"},{"name":"3D","type":"Boolean","optional":true,"default":"true","description":"true to show icon in 3D scene","type_expr":"Boolean","text":"3D: Boolean - (Optional, default true) true to show icon in 3D scene"}],"returns":{"type":"Number","type_expr":"Number","description":"icon ID, used in BIS_fnc_removeCuratorIcon"}}],"examples":[{"code":["[curatorModule, [\"targetIcon.paa\", [1,1,1,1], position player, 1, 1, 45, \"Target\", 1, 0.05, \"TahomaB\"], false] call BIS_fnc_addCuratorIcon;"]}],"see_also":["Arma 3: Curator","BIS_fnc_removeCuratorIcon"]},{"name":"BIS_fnc_addEvidence","title":"BIS fnc addEvidence","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_addEvidence","revid":284951,"updated":"2021-06-20T15:56:44Z","groups":["Missions"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"```\n/*******************************************************************************\n *\n *    version:         1.0\n *    name:            Add evidence\n *    description:    add an evidence value to global campaign variable\n *    paramater:        evidence variable name (defined in init.sqf of campaign\n                     mission C1) or simply number (scalar)\n *    return value:    none\n *\n```","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_addRespawnInventory","title":"BIS fnc addRespawnInventory","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_addRespawnInventory","revid":379241,"updated":"2026-10-30T23:18:39Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.60"},"since":"arma3 1.60","arma3_since":"1.60","locality":{"effect":"global"},"description":"Add a respawn inventory for respawn menu.\nAvailable loadouts are defined in CfgRespawnInventory. Or you may use an existing CfgVehicles soldier class as reference.","syntaxes":[{"syntax":"[target, inventoryParams] call BIS_fnc_addRespawnInventory","params":[{"name":"target","type":"Namespace, Side, Group or Object","description":"Receiver of the respawn loadout\n\n- Namespace - use missionNamespace to add the loadout to everyone\n- Side\n- Group\n- Object","type_expr":"Namespace | Side | Group | Object"},{"name":"inventoryParams","type":"Array or String","description":"Array or String\n\n- String - CfgRespawnInventory class or CfgVehicles soldier class\n- Array - format [class, number, limit]\n  - class: String - CfgRespawnInventory class or CfgVehicles soldier class\n  - number: Number - Number of players who can use this inventory (-1 = no limit, default)\n  - limit: Number - Limit for role assigned to given loadout (-1 = no limit, default)\n    - Only role or only loadout can be limited at one moment, if there is limit for both, then only role uses limit.\n    - If the limit definition for role is called multiple times with different numbers, then the highest number is used.","type_expr":"Array | String","text":"inventoryParams: Array or String\n\n- String - CfgRespawnInventory class or CfgVehicles soldier class\n- Array - format [class, number, limit]\n  - class: String - CfgRespawnInventory class or CfgVehicles soldier class\n  - number: Number - Number of players who can use this inventory (-1 = no limit, default)\n  - limit: Number - Limit for role assigned to given loadout (-1 = no limit, default)\n    - Only role or only loadout can be limited at one moment, if there is limit for both, then only role uses limit.\n    - If the limit definition for role is called multiple times with different numbers, then the highest number is used."}],"returns":{"type":"Array","type_expr":"Array","description":"format [target, id] used in BIS_fnc_removeRespawnInventory"}}],"examples":[{"code":["[west, \"WEST1\"] call BIS_fnc_addRespawnInventory;"]},{"code":["private _myRespawnInventory = [missionNamespace, \"ATSniper\"] call BIS_fnc_addRespawnInventory;"]}],"see_also":["Arma 3: Respawn","BIS_fnc_removeRespawnInventory","BIS_fnc_getRespawnInventories","BIS_fnc_setRespawnInventory"]},{"name":"BIS_fnc_addRespawnPosition","title":"BIS fnc addRespawnPosition","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_addRespawnPosition","revid":342243,"updated":"2023-07-09T12:29:53Z","groups":["Respawn"],"status":"ok","games":{"arma3":"0.50"},"since":"arma3 0.50","arma3_since":"0.50","locality":{"effect":"global"},"description":"Add a respawn position for the Arma 3 Respawn Menu.","syntaxes":[{"syntax":"[target, position, name] call BIS_fnc_addRespawnPosition","params":[{"name":"target","type":"Namespace, Side, Group or Object","description":"receiver of the respawn position. Use missionNamespace to add the position to everyone","type_expr":"Namespace | Side | Group | Object","text":"**target**: Namespace, Side, Group or Object - receiver of the respawn position. Use missionNamespace to add the position to everyone"},{"name":"position","type":"Array, Object or String","description":"Array, Object or String\n\n- Array - format PositionATL\n- Object - specific object. When some crew positions are available and unlocked, players will be respawned on them, otherwise they will appear around the object.\n- String - marker name","type_expr":"Array | Object | String","text":"**position**: Array, Object or String\n\n- Array - format PositionATL\n- Object - specific object. When some crew positions are available and unlocked, players will be respawned on them, otherwise they will appear around the object.\n- String - marker name"},{"name":"name","type":"String","optional":true,"description":"respawn name, can be text or link to localization key","type_expr":"String","text":"**name**: String - (Optional) respawn name, can be text or link to localization key"}],"returns":{"type":"Array","type_expr":"Array","description":"format [target,id] (used in BIS_fnc_removeRespawnPosition)"}}],"examples":[{"code":["[west, myRespawnAPC] call BIS_fnc_addRespawnPosition;"]},{"code":["myRespawn = [missionNamespace,\"arena\",\"Battle Arena\"] call BIS_fnc_addRespawnPosition;"]}],"see_also":["BIS_fnc_removeRespawnPosition","Arma 3: Respawn","BIS_fnc_respawnTickets"],"notes":[{"user":"Krzmbrzl00","date":"2016-06-01T11:22:00Z","text":"Make sure the used Position is in format Position3D (i.e. it contains a third coordinate (z-coordinate)) because otherwise you will get an error as soon as you open the respawn screen and you will be respawned at position [0,0,0] (lower left corner of the map), although the map marker for the spawn position is placed as intended"},{"user":"Leopard20","date":"2022-07-08T17:38:14Z","text":"As of Arma 3 Arma 3 v2.10, when you use an object as the respawn position on water (e.g. on a carrier), the respawn position is incorrect. Instead, just pass the ATL position. For example, if you intend to add a respawn position in Eden Editor, instead of the respawn position module, place a dummy object such as **User Texture (1m)** (`class UserTexture1m_F`) and paste this in its init:\n\n```sqf\nif (isServer) then {\n    [BLUFOR, getPosATL this, \"My West Respawn\"] call BIS_fnc_addRespawnPosition;\n    deleteVehicle this;\n}\n```\n\nThis code adds a respawn position at the position of the dummy object, and deletes the dummy object afterwards."}]},{"name":"BIS_fnc_addScore","title":"BIS fnc addScore","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_addScore","revid":349163,"updated":"2023-11-08T14:49:51Z","groups":["Multiplayer"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"server_exec":true},"description":"Adds a set amount of points to the score of a unit *(MP only)*","syntaxes":[{"syntax":"[object, number] call BIS_fnc_addScore","params":[{"name":"Object","description":"unit to add score to.","type_expr":"Object"},{"name":"Number","description":"number of points (score) to add to unit.","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number","description":"score added to unit"}}],"examples":[{"code":["[player,20] call BIS_fnc_addScore;"]}],"see_also":["addScore"]},{"name":"BIS_fnc_addScriptedEventHandler","title":"BIS fnc addScriptedEventHandler","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_addScriptedEventHandler","revid":349191,"updated":"2023-11-08T14:50:40Z","groups":["Event Handlers"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Adds a Scripted Event Handler and returns its ID. Additionally, the \"ScriptedEventHandlerAdded\" Scripted EH is called. For the full list of all available Scripted EHs see Arma 3: Scripted Event Handlers.","syntaxes":[{"syntax":"[namespace, name, code] call BIS_fnc_addScriptedEventHandler","params":[{"name":"namespace","type":"Namespace, Object, Group, Location, Boolean, Control or Display","description":"namespace in which the EH is stored","type_expr":"Namespace | Object | Group | Location | Boolean | Control | Display"},{"name":"name","type":"String","description":"event name","type_expr":"String"},{"name":"code","type":"Code or String","description":"the code that is executed when the EH fires. The magic variable _thisScriptedEventHandler can be used to access the event handler ID within the code.","type_expr":"Code | String"}],"returns":{"type":"Number","type_expr":"Number","description":"the ID of the new Event Handler"}}],"examples":[{"code":["[missionNamespace, \"event\", { hint \"Hello World\" }] call BIS_fnc_addScriptedEventHandler;"]},{"text":"```sqf\n[true, \"event\", { hint \"Hello World\" }] call BIS_fnc_addScriptedEventHandler;\n```\n\nBoolean will default to missionNamespace.","code":["[true, \"event\", { hint \"Hello World\" }] call BIS_fnc_addScriptedEventHandler;"]}],"see_also":["BIS_fnc_callScriptedEventHandler","BIS_fnc_removeScriptedEventHandler","BIS_fnc_removeAllScriptedEventHandlers"]},{"name":"BIS_fnc_addStackedEventHandler","title":"BIS fnc addStackedEventHandler","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_addStackedEventHandler","revid":330780,"updated":"2022-11-01T16:06:55Z","groups":["Event Handlers"],"status":"deprecated","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"effect":"local"},"description":"> [!CAUTION]\n> This information is **obsolete** as of Arma 3 v1.58. Reason: Arma 3: Mission Event Handlers should be used instead.\n\nStacks an event handler. All event handlers accept user arguments, which are passed to the EH code in `_this` variable. If the EH has own params returned in `_this` variable as well, user arguments are appended to the end of `_this` array. Note that if you try to add an empty EH, i.e. with empty code, it will simply be ignored.\n\n**Supported Event Handlers**\n\n| Scripted Event Handler | Mission EH Equivalent | Description |\n|---|---|---|\n| \"onEachFrame\" | EachFrame | N/A |\n| \"onPlayerConnected\" | PlayerConnected | Special variables `_id`, `_uid`, `_name`, `_jip`, `_owner` are provided and are available in `_this` array as well.<br>`params [\"_id\", \"_uid\", \"_name\", \"_jip\", \"_owner\"];` |\n| \"onPlayerDisconnected\" | PlayerDisconnected | Special variables `_id`, `_uid`, `_name`, `_jip`, `_owner` are provided and are available in `_this` array as well.<br>`params [\"_id\", \"_uid\", \"_name\", \"_jip\", \"_owner\"];` |\n| \"onMapSingleClick\" | MapSingleClick | Special variables `_units`, `_pos`, `_alt`, `_shift` are provided and are available in `_this` array as well.<br>`params [\"_units\", \"_pos\", \"_alt\", \"_shift\"];` |\n| \"onPreloadStarted\" | PreloadStarted | N/A |\n| \"onPreloadFinished\" | PreloadFinished | N/A |","syntaxes":[{"syntax":"[id, event, code, arguments] call BIS_fnc_addStackedEventHandler","params":[{"name":"id","type":"String","description":"custom id, a unique identifier. Adding same type of EH with the same id will overwrite existing","type_expr":"String"},{"name":"event","type":"String","description":"event handler name, see description for supported EHs","type_expr":"String"},{"name":"code","description":"Code or String. The String is treated as function name","type_expr":"Code | String","text":"code: Code or String. The String is treated as function name"},{"name":"arguments","type":"Array of Anything","description":"arguments to make available in code in `_this` array","type_expr":"Array<Anything>"}],"returns":{"type":"String","type_expr":"String","description":"custom id on success or \"\" on failure"}}],"examples":[{"code":["[\"someId\", \"onEachFrame\", { hintSilent str time }] call BIS_fnc_addStackedEventHandler;"]},{"code":["[\"someId\", \"onEachFrame\", {hintSilent str position (_this select 0)}, [player]] call BIS_fnc_addStackedEventHandler;"]},{"code":["private _eventName = \"OnEachFrame\";\nmissionNamespace getVariable [format [\"BIS_stackedEventHandlers_%1\", _eventName], []]; // gets an array with all existing ids"]}],"multiplayer":"This command has the same locality as addMissionEventHandler.","see_also":["addMissionEventHandler","BIS_fnc_removeStackedEventHandler"],"notes":[{"user":"ffur2007slx2_5","date":"2014-06-25T12:08:00Z","text":"Stacking all the code into one PFH will be less demanding than separated calling within multiple PFH, e.g:\n\n```sqf\n{\n    [format [\"%1\", _forEachIndex], \"onEachFrame\", _code, [_x]] call BIS_fnc_addStackedEventHandler;\n} forEach [var0, var1, varN, var100]; // pretty demanding\n```\n\n```sqf\n[_id, \"onEachFrame\", {\n    { _x call _code } forEach [var0, var1, varN, var100];\n}] call BIS_fnc_addStackedEventHandler; // faster, only one event\n```"}]},{"name":"BIS_fnc_addSupportLink","title":"BIS fnc addSupportLink","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_addSupportLink","revid":321248,"updated":"2022-05-13T18:41:13Z","groups":["Supports"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Adds support types during a mission.","syntaxes":[{"syntax":"[requesterUnit, requesterMod, providerMod] call BIS_fnc_addSupportLink","params":[{"name":"requesterUnit","type":"Object","description":"requester unit","type_expr":"Object"},{"name":"requesterMod","type":"Object","description":"requester module","type_expr":"Object"},{"name":"providerMod","type":"Object","description":"provider module","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[player, BIS_requesterMod, BIS_providerMod] call BIS_fnc_addSupportLink;"]}],"see_also":["BIS_fnc_removeSupportLink"]},{"name":"BIS_fnc_addToPairs","title":"BIS fnc addToPairs","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_addToPairs","revid":352076,"updated":"2024-02-01T23:24:42Z","groups":["Arrays"],"status":"ok","games":{"arma3":"0.76"},"since":"arma3 0.76","arma3_since":"0.76","description":"Adds given value to pair array, stored under unique key.\n\n```\nIf value is found:\n\na) both values are scalars: values are added and stored as a single scalar\n\nb) one or both values are array: values are added and stored as a single array\n\nc) anything else: an array is created and both values are stored there\n```\n\n> [!NOTE]\n> Function by default modifies the input array. This can be overrriden by setting '_copyArray' param to true.","syntaxes":[{"syntax":"[array, key, value, copyArray] call BIS_fnc_addToPairs","params":[{"name":"array","type":"Array","description":"array to search through","type_expr":"Array"},{"name":"key","type":"String","description":"key to search for","type_expr":"String"},{"name":"value","type":"Number","optional":true,"default":"nil","description":"default return value if no match was found","type_expr":"Number","text":"value: Number - (Optional, default nil) default return value if no match was found"},{"name":"copyArray","type":"Boolean","optional":true,"default":"false","description":"true to copy the array and return it, false to modify the original array","type_expr":"Boolean","text":"copyArray: Boolean - (Optional, default false) true to copy the array and return it, false to modify the original array"}],"returns":{"type":"Array","type_expr":"Array","description":"resulting modified array or a copy"}}],"examples":[{"code":["[[[\"apple\",3],[\"pear\",2]],\"pear\",10] call BIS_fnc_addToPairs; // Returns [[\"apple\",3],[\"pear\",12]]"]},{"code":["[[[\"apple\",3],[\"pear\",2]],\"apple\",-2] call BIS_fnc_addToPairs; // Returns [[\"apple\",1],[\"pear\",2]]"]},{"code":["[[[\"greetings\",\"Hello!\"],[\"rudewords\",\"\"]],\"greetings\",\"Hi!\"] call BIS_fnc_addToPairs; // Returns [[\"greetings\",[\"Hello!\",\"Hi!\"]],[\"rudewords\",\"\"]]"]}],"see_also":["find","findIf","BIS_fnc_findInPairs","BIS_fnc_getFromPairs","BIS_fnc_removeFromPairs","BIS_fnc_setToPairs"]},{"name":"BIS_fnc_addVirtualBackpackCargo","title":"BIS fnc addVirtualBackpackCargo","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_addVirtualBackpackCargo","revid":349390,"updated":"2023-11-08T16:27:25Z","groups":["Inventory"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"Add virtual backpacks to an object (e.g., ammo box). Virtual items can be selected in the Arsenal.","syntaxes":[{"syntax":"[object,backpackClasses,addItemsGlobal,arsenal] call BIS_fnc_addVirtualBackpackCargo","params":[{"name":"object","type":"Object","description":"object to which items will be added","type_expr":"Object"},{"name":"backpackClasses","type":"Boolean, String or Array of Strings","description":"backpack classes","type_expr":"Boolean | String | Array<String>"},{"name":"addItemsGlobal","type":"Boolean","optional":true,"default":"false","description":"true to add items globally","type_expr":"Boolean","text":"addItemsGlobal: Boolean - (Optional, default false) true to add items globally"},{"name":"arsenal","type":"Boolean","optional":true,"default":"true","description":"true to add Arsenal action","type_expr":"Boolean","text":"arsenal: Boolean - (Optional, default true) true to add Arsenal action"}],"returns":{"type":"Array of Strings","type_expr":"Array<String>","description":"all virtual backpacks"}}],"examples":[{"code":["[BIS_ammoBox, [\"class_1\",\"class_2\"], false, true] call BIS_fnc_addVirtualBackpackCargo;"]}],"see_also":["Arsenal","BIS_fnc_addVirtualItemCargo","BIS_fnc_addVirtualMagazineCargo","BIS_fnc_addVirtualWeaponCargo","BIS_fnc_arsenal","BIS_fnc_getVirtualBackpackCargo","BIS_fnc_getVirtualItemCargo","BIS_fnc_getVirtualMagazineCargo","BIS_fnc_getVirtualWeaponCargo","BIS_fnc_removeVirtualBackpackCargo","BIS_fnc_removeVirtualItemCargo","BIS_fnc_removeVirtualMagazineCargo","BIS_fnc_removeVirtualWeaponCargo"]},{"name":"BIS_fnc_addVirtualItemCargo","title":"BIS fnc addVirtualItemCargo","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_addVirtualItemCargo","revid":325299,"updated":"2022-07-10T22:41:08Z","groups":["Inventory"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"Add virtual items to an object (e.g., ammo box). Virtual items can be selected in the Arsenal.\nIf parameters 4 and 5 are used this function can replace BIS_fnc_addVirtualWeaponCargo, BIS_fnc_addVirtualMagazineCargo and BIS_fnc_addVirtualBackpackCargo.","syntaxes":[{"syntax":"[object, itemClasses, addItemsGlobal, arsenal, mode, itemType] call BIS_fnc_addVirtualItemCargo","params":[{"name":"object","type":"Object","description":"object to which items will be added","type_expr":"Object"},{"name":"itemClasses","type":"Boolean, String or Array of Strings","description":"item classes","type_expr":"Boolean | String | Array<String>"},{"name":"addItemsGlobal","type":"Boolean","optional":true,"default":"false","description":"true to add items globally","type_expr":"Boolean","text":"addItemsGlobal: Boolean - (Optional, default false) true to add items globally"},{"name":"arsenal","type":"Boolean","optional":true,"default":"true","description":"true to add Arsenal action","type_expr":"Boolean","text":"arsenal: Boolean - (Optional, default true) true to add Arsenal action"},{"name":"mode","type":"Number","optional":true,"default":"1","description":"defines what the function will do, can be:\n\n- -1 - remove given items\n-  0 - return current content\n-  1 - add given items","type_expr":"Number","text":"mode: Number - (Optional, default 1) defines what the function will do, can be:\n\n- -1 - remove given items\n-  0 - return current content\n-  1 - add given items"},{"name":"itemType","type":"Number","optional":true,"default":"0","description":"define the item type, can be:\n\n- 0 - items\n- 1 - weapons\n- 2 - magazines\n- 3 - backpacks","type_expr":"Number","text":"itemType: Number - (Optional, default 0) define the item type, can be:\n\n- 0 - items\n- 1 - weapons\n- 2 - magazines\n- 3 - backpacks"}],"returns":{"type":"Array of Strings","type_expr":"Array<String>","description":"all virtual items"}}],"examples":[{"code":["[BIS_ammoBox, [\"class_1\", \"class_2\"], false, true] call BIS_fnc_addVirtualItemCargo;"]}],"see_also":["Arsenal","BIS_fnc_addVirtualBackpackCargo","BIS_fnc_addVirtualMagazineCargo","BIS_fnc_addVirtualWeaponCargo","BIS_fnc_arsenal","BIS_fnc_getVirtualBackpackCargo","BIS_fnc_getVirtualItemCargo","BIS_fnc_getVirtualMagazineCargo","BIS_fnc_getVirtualWeaponCargo","BIS_fnc_removeVirtualBackpackCargo","BIS_fnc_removeVirtualItemCargo","BIS_fnc_removeVirtualMagazineCargo","BIS_fnc_removeVirtualWeaponCargo"],"notes":[{"user":"Kamaradski","date":"2014-10-16T23:55:00Z","text":"In AmmoboxInit mode, for the ammobox to ONLY contain your white-listed items in the ammobox, you should first issue the BIS_fnc_removeVirtualItemCargo command. Otherwise the box will contain non whitelisted clutter.\n\n**Example:**\n\n```sqf\n[\"AmmoboxInit\", [_myBox, true]] call BIS_fnc_arsenal;\n[_myBox, [true], true] call BIS_fnc_removeVirtualItemCargo;\n[_myBox, [\"U_B_CombatUniform_mcam\", \"U_B_CombatUniform_mcam_tshirt\"], true] call BIS_fnc_addVirtualItemCargo;\n```"}]},{"name":"BIS_fnc_addVirtualMagazineCargo","title":"BIS fnc addVirtualMagazineCargo","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_addVirtualMagazineCargo","revid":349405,"updated":"2023-11-08T16:27:26Z","groups":["Inventory"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"Add virtual magazines to an object (e.g., ammo box). Virtual items can be selected in the Arsenal.","syntaxes":[{"syntax":"[object,magClasses,addItemsGlobal,arsenal] call BIS_fnc_addVirtualMagazineCargo","params":[{"name":"object","type":"Object","description":"object to which items will be added","type_expr":"Object"},{"name":"magClasses","type":"Boolean, String or Array of Strings","description":"magazine classes","type_expr":"Boolean | String | Array<String>"},{"name":"addItemsGlobal","type":"Boolean","optional":true,"default":"false","description":"true to add items globally","type_expr":"Boolean","text":"addItemsGlobal: Boolean - (Optional, default false) true to add items globally"},{"name":"arsenal","type":"Boolean","optional":true,"default":"true","description":"true to add Arsenal action","type_expr":"Boolean","text":"arsenal: Boolean - (Optional, default true) true to add Arsenal action"}],"returns":{"type":"Array of Strings","type_expr":"Array<String>","description":"all virtual magazines"}}],"examples":[{"code":["[BIS_ammoBox, [\"class_1\",\"class_2\"], false, true] call BIS_fnc_addVirtualMagazineCargo;"]}],"see_also":["Arsenal","BIS_fnc_addVirtualBackpackCargo","BIS_fnc_addVirtualItemCargo","BIS_fnc_addVirtualWeaponCargo","BIS_fnc_arsenal","BIS_fnc_getVirtualBackpackCargo","BIS_fnc_getVirtualItemCargo","BIS_fnc_getVirtualMagazineCargo","BIS_fnc_getVirtualWeaponCargo","BIS_fnc_removeVirtualBackpackCargo","BIS_fnc_removeVirtualItemCargo","BIS_fnc_removeVirtualMagazineCargo","BIS_fnc_removeVirtualWeaponCargo"]},{"name":"BIS_fnc_addVirtualWeaponCargo","title":"BIS fnc addVirtualWeaponCargo","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_addVirtualWeaponCargo","revid":349400,"updated":"2023-11-08T16:27:25Z","groups":["Inventory"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"Add virtual weapons to an object (e.g., ammo box). Virtual items can be selected in the Arsenal.","syntaxes":[{"syntax":"[object,weaponClasses,addItemsGlobal,arsenal] call BIS_fnc_addVirtualWeaponCargo","params":[{"name":"object","type":"Object","description":"object to which items will be added","type_expr":"Object"},{"name":"weaponClasses","type":"Boolean, String or Array of Strings","description":"weapon classes","type_expr":"Boolean | String | Array<String>"},{"name":"addItemsGlobal","type":"Boolean","optional":true,"default":"false","description":"true to add items globally","type_expr":"Boolean","text":"addItemsGlobal: Boolean - (Optional, default false) true to add items globally"},{"name":"arsenal","type":"Boolean","optional":true,"default":"true","description":"true to add Arsenal action","type_expr":"Boolean","text":"arsenal: Boolean - (Optional, default true) true to add Arsenal action"}],"returns":{"type":"Array of Strings","type_expr":"Array<String>","description":"all virtual weapons"}}],"examples":[{"code":["[BIS_ammoBox, [\"class_1\",\"class_2\"], false, true] call BIS_fnc_addVirtualWeaponCargo;"]}],"see_also":["Arsenal","BIS_fnc_addVirtualBackpackCargo","BIS_fnc_addVirtualItemCargo","BIS_fnc_addVirtualMagazineCargo","BIS_fnc_arsenal","BIS_fnc_getVirtualBackpackCargo","BIS_fnc_getVirtualItemCargo","BIS_fnc_getVirtualMagazineCargo","BIS_fnc_getVirtualWeaponCargo","BIS_fnc_removeVirtualBackpackCargo","BIS_fnc_removeVirtualItemCargo","BIS_fnc_removeVirtualMagazineCargo","BIS_fnc_removeVirtualWeaponCargo"]},{"name":"BIS_fnc_addWeapon","title":"BIS fnc addWeapon","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_addWeapon","revid":349361,"updated":"2023-11-08T15:35:10Z","groups":["Inventory","Weapons"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Adds a weapon to the specified unit, with magazine classnames taken from the weapon's config (in CfgWeapons).\nThis function does not remove magazines nor weapons prior to adding the new weapon, so that still has to be done manually.","syntaxes":[{"syntax":"[unit, weaponClassName, quantity, type] call BIS_fnc_addWeapon","params":[{"name":"unit","type":"Object","description":"unit to add weapon to.","type_expr":"Object"},{"name":"weaponClassName","type":"String","description":"weapon Classname (found in CfgWeapons).","type_expr":"String"},{"name":"quantity","type":"Number","description":"amount of magazines.","type_expr":"Number"},{"name":"type","type":"Number or String","optional":true,"default":"0","description":"Number - Index of magazine name that should be used - found in `magazines = {}` array.\n- String - Magazine name to be used.","type_expr":"Number | String","text":"type: Number or String - (Optional, default 0)\n\n- Number - Index of magazine name that should be used - found in `magazines = {}` array.\n- String - Magazine name to be used."}],"returns":{"type":"String","type_expr":"String","description":"primary(!) muzzle name of weapon.","text":"String - primary**(!)** muzzle name of weapon."}}],"examples":[{"text":"Add 6 dual-purpose magazines and the underwater gun to the player:\n\n```sqf\n[player, \"arifle_SDAR_F\", 6] call BIS_fnc_addWeapon;\n```","code":["[player, \"arifle_SDAR_F\", 6] call BIS_fnc_addWeapon;"]},{"text":"Adds 2 × 30 Rnd Stanag Tracer (Red) magazines to bluforUnit, with an Mk20_F:\n\n```sqf\n[bluforUnit, \"arifle_Mk20_F\", 2, 1] call BIS_fnc_addWeapon;\n```","code":["[bluforUnit, \"arifle_Mk20_F\", 2, 1] call BIS_fnc_addWeapon;"]},{"text":"Alternative syntax of second example, with magazine name written out:\n\n```sqf\n[bluforUnit, \"arifle_Mk20_F\", 2, \"30Rnd_556x45_Stanag_Tracer_red\"] call BIS_fnc_addWeapon;\n```","code":["[bluforUnit, \"arifle_Mk20_F\", 2, \"30Rnd_556x45_Stanag_Tracer_red\"] call BIS_fnc_addWeapon;"]}],"see_also":["addWeapon","selectWeapon"],"notes":[{"user":"Tryteyker-","date":"2014-09-29T18:13:00Z","text":"This function only returns the primary muzzle name of a gun. For more info on how to select guns' secondary muzzle names (like an underhand grenade launcher), view the notes on selectWeapon."}]},{"name":"BIS_fnc_adjustSimpleObject","title":"BIS fnc adjustSimpleObject","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_adjustSimpleObject","revid":349493,"updated":"2023-11-08T17:09:09Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Adjust simple object vertical position, animations and selection according to provided data.\nIn case both adjustment data and class are being used, data has higher priority and only undefined parts are filled from config.\n\n> [!IMPORTANT]\n> This function is automatically called by BIS_fnc_createSimpleObject.","syntaxes":[{"syntax":"[object, [class, model, reversed, verticalOffset, animAdjustments, selectionToHide]] call BIS_fnc_adjustSimpleObject","params":[{"name":"object","type":"Object","description":"simple object that will be adjusted","type_expr":"Object"},{"name":"class","type":"String","optional":true,"default":"\"\"","description":"asset `CfgVehicles` config class (**at least either *model* or *class* must be provided, ideally both**)","type_expr":"String","text":"class: String - (Optional, default \"\") asset `CfgVehicles` config class (**at least either *model* or *class* must be provided, ideally both**)"},{"name":"model","type":"String","optional":true,"default":"\"\"","description":"path to the vehicle p3d model; needs to start without backslash and must end with the proper file extension \".p3d\"","type_expr":"String","text":"model: String - (Optional, default \"\") path to the vehicle p3d model; needs to start without backslash and must end with the proper file extension \".p3d\""},{"name":"reversed","type":"Number","optional":true,"default":"0","description":"some objects, usually vehicles, are reveresed in p3d; valid values are:\n\n-  0: no change\n-  1: reverse\n- -1: unknown (behaves as 0)","type_expr":"Number","text":"reversed: Number - (Optional, default 0) some objects, usually vehicles, are reveresed in p3d; valid values are:\n\n-  0: no change\n-  1: reverse\n- -1: unknown (behaves as 0)"},{"name":"verticalOffset","type":"Array","optional":true,"default":"0","description":"fix for non-existant physX; usually needed only for vehicles","type_expr":"Array","text":"verticalOffset: Array - (Optional, default 0) fix for non-existant physX; usually needed only for vehicles"},{"name":"animationAdjustments","type":"Array","optional":true,"default":"`[]`","description":"animation that need to be animated to given state, in format [animationName, animationState]:\n\n- animationName: String - animation name\n- animationState: Number - animation state","type_expr":"Array","text":"animationAdjustments: Array - (Optional, default `[]`) animation that need to be animated to given state, in format [animationName, animationState]:\n\n- animationName: String - animation name\n- animationState: Number - animation state"},{"name":"selectionsToHide","type":"Array","optional":true,"default":"`[]`","description":"all listed selections will be hidden","type_expr":"Array","text":"selectionsToHide: Array - (Optional, default `[]`) all listed selections will be hidden"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[myCar, [\"B_MyCar_F\", \"path\\to\\file.p3d\"]] call BIS_fnc_adjustSimpleObject;"]}],"see_also":["createSimpleObject","BIS_fnc_createSimpleObject","BIS_fnc_simpleObjectData"]},{"name":"BIS_fnc_admin","title":"BIS fnc admin","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_admin","revid":364585,"updated":"2024-05-17T12:40:33Z","groups":["Multiplayer"],"status":"ok","games":{"arma3":"1.70"},"since":"arma3 1.70","arma3_since":"1.70","description":"Returns the admin state of a client the function is called on. Complements admin script command and used for self check on a local client.","syntaxes":[{"syntax":"call BIS_fnc_admin","params":[],"returns":{"type":"Number","type_expr":"Number","description":"admin state of current client:\n- 0 - client is not an admin - 1 - client is admin that is voted in - 2 - client is admin that is logged in","text":"Number - admin state of current client:\n\n- 0 - client is not an admin\n- 1 - client is admin that is voted in\n- 2 - client is admin that is logged in"}}],"examples":[{"code":["private _adminState = call BIS_fnc_admin;"]}],"see_also":["admin"]},{"name":"BIS_fnc_advHint","title":"BIS fnc advHint","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_advHint","revid":327971,"updated":"2022-07-13T14:30:14Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Shows advanced hint to player.","syntaxes":[{"syntax":"[classes, duration1, condition1, duration2, condition2, showing, onlyFullHint, onlyOnce, useSound] call BIS_fnc_advHint","params":[{"name":"classes","type":"Array","description":"array in format [\"hint main class\", \"hint class\"]","type_expr":"Array","text":"**classes**: Array - array in format [\"hint main class\", \"hint class\"]"},{"name":"duration1","type":"Number","optional":true,"default":"15","description":"duration of short hint in seconds","type_expr":"Number","text":"**duration1**: Number - (Optional, default 15) duration of short hint in seconds"},{"name":"condition1","type":"String","optional":true,"default":"\"\"","description":"condition for hiding the short hint","type_expr":"String","text":"**condition1**: String - (Optional, default \"\") condition for hiding the short hint"},{"name":"duration2","type":"Number","optional":true,"default":"35","description":"duration of full hint in seconds","type_expr":"Number","text":"**duration2**: Number - (Optional, default 35) duration of full hint in seconds"},{"name":"condition2","type":"String","optional":true,"default":"\"\"","description":"condition for hiding the full hint","type_expr":"String","text":"**condition2**: String - (Optional, default \"\") condition for hiding the full hint"},{"name":"showing","type":"Boolean","optional":true,"default":"false","description":"true shows hint even if tutorial hints are disabled in game settings","type_expr":"Boolean","text":"**showing**: Boolean - (Optional, default false) true shows hint even if tutorial hints are disabled in game settings"},{"name":"onlyFullHint","type":"Boolean","optional":true,"default":"false","description":"true shows full hint without using of short hint","type_expr":"Boolean","text":"**onlyFullHint**: Boolean - (Optional, default false) true shows full hint without using of short hint"},{"name":"onlyOnce","type":"Boolean","optional":true,"default":"false","description":"show the hint in mission only once (true) or multiple times (false)","type_expr":"Boolean","text":"**onlyOnce**: Boolean - (Optional, default false) show the hint in mission only once (true) or multiple times (false)"},{"name":"useSound","type":"Boolean","optional":true,"default":"true","description":"true plays a sound when the hint is opened","type_expr":"Boolean","text":"**useSound**: Boolean - (Optional, default true) true plays a sound when the hint is opened"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[[\"Common\", \"GPS\"]] call BIS_fnc_advHint;"]},{"code":["[[\"Common\", \"GPS\"], 15, \"\", 35, \"\", false, false, false, true] call BIS_fnc_advHint; // default"]}],"see_also":["Arma 3: Advanced Hints (Field Manual)","BIS_fnc_advHintFormat","BIS_fnc_advHintCall","BIS_fnc_advHintArg"],"notes":[{"user":"Sixtyfour","date":"2016-08-13T12:09:00Z","text":"This command will not do anything for players who have \"Tutorial Hints\" disabled in their Options > Game difficulty settings or on servers that disable it in their relevant difficulty preset."}]},{"name":"BIS_fnc_advHintArg","title":"BIS fnc advHintArg","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_advHintArg","revid":348204,"updated":"2023-11-08T11:40:13Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Advanced hint arguments preprocess.","syntaxes":[{"syntax":"[arguments, HTMLColour, hintClass] call BIS_fnc_advHintArg","params":[{"name":"arguments","type":"Array","type_expr":"Array"},{"name":"HTMLColour","type":"String","description":"HTML colour for highlighted text","type_expr":"String"},{"name":"hintClass","type":"String","optional":true,"default":"\"\"","description":"class of hint (in case of warning or error is used in logged info)","type_expr":"String","text":"hintClass: String - (Optional, default \"\") class of hint (in case of warning or error is used in logged info)"}],"returns":{"type":"Array","type_expr":"Array","description":"arguments"}}],"see_also":["BIS_fnc_advHint","BIS_fnc_advHintFormat","BIS_fnc_advHintCall"]},{"name":"BIS_fnc_advHintCall","title":"BIS fnc advHintCall","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_advHintCall","revid":363987,"updated":"2024-04-29T23:23:27Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.20"},"since":"arma3 1.20","arma3_since":"1.20","description":"Advanced hint call, creates hint itself.\nThis function gets parameters from variable **BIS_fnc_advHint_hint** in format [class, fullText, shortText, shortDur, shortHideCond, fullDur, fullHideCond, showFull, sound]:\n\n- class: String - class of hint\n- fullText: String - structured text of full hint\n- shortText: String - structured text of short hint\n- shortDur: Number - duration of short hint in seconds\n- hideCond: String - condition for hiding of short hint (default: \"false\")\n- fullDur: Number - duration of full hint in seconds\n- fullHideCond: String - condition for hiding of full hint (default: \"false\")\n- showFull: Boolean - true shows directly full hint (default: false)\n- sound: Boolean - true for using of sound (default: true)","syntaxes":[{"syntax":"fullText call BIS_fnc_advHintCall","params":[{"name":"fullText","type":"Boolean","description":"true to show full text, false to only show small hint notification","type_expr":"Boolean"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["false call BIS_fnc_advHintCall;"]}],"see_also":["BIS_fnc_advHint","BIS_fnc_advHintFormat","BIS_fnc_advHintArg"]},{"name":"BIS_fnc_advHintCredits","title":"BIS fnc advHintCredits","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_advHintCredits","revid":348418,"updated":"2023-11-08T13:00:08Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Advanced hint credits preprocessor.","syntaxes":[{"syntax":"call BIS_fnc_advHintCredits","params":[],"returns":{"type":"String","type_expr":"String","description":"credits"}}],"examples":[{"code":["call BIS_fnc_advHintCredits;"]}]},{"name":"BIS_fnc_advHintFormat","title":"BIS fnc advHintFormat","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_advHintFormat","revid":363518,"updated":"2024-04-02T15:08:52Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Return formatted texts of a CfgHints hint.","syntaxes":[{"syntax":"[topic,hint,subHint,colour] call BIS_fnc_advHintFormat","params":[{"name":"topic","type":"String","description":"topic","type_expr":"String"},{"name":"hint","type":"String","description":"hint","type_expr":"String"},{"name":"subHint","type":"String","description":"sub-hint","type_expr":"String"},{"name":"colour","type":"Array","description":"custom highlight color","type_expr":"Array"}],"returns":{"type":"Array","type_expr":"Array","description":"array in format:\n- 0: Config - Hint path - 1: String - Display name - 2: String - Display name (short) - 3: String - Description - 4: String - Tip - 5: String - Image - 6: Number - DLC ID - 7: Boolean - true if hint belongs to non-owned DLC","text":"Array - array in format:\n\n- 0: Config - Hint path\n- 1: String - Display name\n- 2: String - Display name (short)\n- 3: String - Description\n- 4: String - Tip\n- 5: String - Image\n- 6: Number - DLC ID\n- 7: Boolean - true if hint belongs to non-owned DLC"}}],"examples":[{"code":["[\"Arma3\",\"Feedback\",\"\",[0.5,0.3,0.6,1]] call BIS_fnc_advHintFormat;"]}],"see_also":["BIS_fnc_advHint","BIS_fnc_advHintArg","BIS_fnc_advHintCall"]},{"name":"BIS_fnc_aircraftCatapultLaunch","title":"BIS fnc aircraftCatapultLaunch","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_aircraftCatapultLaunch","revid":379486,"updated":"2026-10-31T00:25:10Z","groups":["Aircraft Carrier"],"status":"ok","games":{"arma3":"1.68"},"since":"arma3 1.68","arma3_since":"1.68","locality":{"argument":"local"},"description":"Accelerates an aircraft off the aircraft carrier. For this to work the aircraft must be properly configured in config. See Arma 3: Aircraft Systems for information about needed config changes.","syntaxes":[{"syntax":"[aircraft, direction] call BIS_fnc_aircraftCatapultLaunch","params":[{"name":"aircraft","type":"Object","description":"the aircraft that should be launched","type_expr":"Object"},{"name":"direction","type":"Number","optional":true,"default":"`direction _aircraft`","description":"direction to launch the aircraft off to","type_expr":"Number","text":"direction: Number - (Optional, default `direction _aircraft`) direction to launch the aircraft off to"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[_plane] call BIS_fnc_aircraftCatapultLaunch;"]}],"see_also":["BIS_fnc_aircraftTailhook"]},{"name":"BIS_fnc_aircraftFoldingWings","title":"BIS fnc aircraftFoldingWings","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_aircraftFoldingWings","revid":379487,"updated":"2026-10-31T00:25:18Z","groups":["Aircraft Functionality"],"status":"ok","games":{"arma3":"1.70"},"since":"arma3 1.70","arma3_since":"1.70","locality":{"argument":"local","effect":"global"},"description":"Handles foldable wings of aircrafts. Is supposed to be used from within class Eventhandlers of the vehicle. See Arma 3: Aircraft Systems for information about needed config changes.\n\n```cpp\nclass Eventhandlers : Eventhandlers\n{\n    engine = \"_this call BIS_fnc_aircraftFoldingWings\";\n    gear = \"_this call BIS_fnc_aircraftFoldingWings\";\n};\n```","syntaxes":[{"syntax":"[aircraft, animationState] call BIS_fnc_aircraftFoldingWings","params":[{"name":"aircraft","type":"Object","type_expr":"Object"},{"name":"animationState","type":"Boolean","optional":true,"default":"false","description":"if false, the function will just terminate","type_expr":"Boolean","text":"animationState: Boolean - (Optional, default false) if false, the function will just terminate"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[_aircraft, 1] call BIS_fnc_aircraftFoldingWings;"]}]},{"name":"BIS_fnc_aircraftTailhook","title":"BIS fnc aircraftTailhook","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_aircraftTailhook","revid":321359,"updated":"2022-05-13T19:53:34Z","groups":["Aircraft Carrier"],"status":"ok","games":{"arma3":"1.68"},"since":"arma3 1.68","arma3_since":"1.68","locality":{"argument":"local"},"description":"Aircraft carrier arrest/recovery function for USS Freedom aircraft carrier. If the aircraft exceeds the speed defined in config a wire snap will be simulated.","syntaxes":[{"syntax":"[aircraft] call BIS_fnc_aircraftTailhook","params":[{"name":"aircraft","type":"Object","description":"the aircraft to arrest/recover","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[_aircraft] call BIS_fnc_aircraftTailhook;"]}],"see_also":["BIS_fnc_aircraftCatapultLaunch"]},{"name":"BIS_fnc_aircraftTailhookAi","title":"BIS fnc aircraftTailhookAi","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_aircraftTailhookAi","revid":292962,"updated":"2021-08-13T10:25:44Z","groups":["Aircraft Functionality"],"status":"ok","games":{"arma3":"1.70"},"since":"arma3 1.70","arma3_since":"1.70","description":"Handles landing on the aircraft carrier for AI and player autopilot.","syntaxes":[{"syntax":"[params, isLanding] call BIS_fnc_aircraftTailhookAi","params":[{"name":"params","type":"Array","description":"Array\n\n- 0: aircraft: Object\n- 1: needsHook: Boolean - (optional, default false) if false, function will exit and no tailhook functionality is initialized","type_expr":"Array","text":"params: Array\n\n- 0: aircraft: Object\n- 1: needsHook: Boolean - (optional, default false) if false, function will exit and no tailhook functionality is initialized"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"-"}],"multiplayer":"While the animations are visible for everyone, the sounds for the tailhook are local to where the function was executed.","see_also":["BIS_fnc_aircraftTailhook","Arma 3: Aircraft Systems"]},{"name":"BIS_fnc_alignTabs","title":"BIS fnc alignTabs","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_alignTabs","revid":328461,"updated":"2022-07-13T16:11:04Z","groups":["Strings"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Align two columns divided by tabs. A tab counts for 8 characters.","syntaxes":[{"syntax":"array call BIS_fnc_alignTabs","params":[{"name":"array","type":"Array","description":"in format\n\n```sqf\n[\n    [\"left column 1\", \"right column 1\"],\n    [\"left column 2\", \"right column 2\"],\n    // ...\n]\n```","type_expr":"Array"}],"returns":{"type":"String","type_expr":"String"}}],"examples":[{"text":"```sqf\n[\n    [\"Player:\", str player],\n    [\"Name:\", name player],\n    [\"Type:\", typeOf player],\n    [\"Location:\", str getPosATL player],\n    [\"Direction:\", str getDir player]\n] call BIS_fnc_alignTabs;\n```","code":["[\n\t[\"Player:\", str player],\n\t[\"Name:\", name player],\n\t[\"Type:\", typeOf player],\n\t[\"Location:\", str getPosATL player],\n\t[\"Direction:\", str getDir player]\n] call BIS_fnc_alignTabs;"]}]},{"name":"BIS_fnc_allSynchronizedObjects","title":"BIS fnc allSynchronizedObjects","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_allSynchronizedObjects","revid":379488,"updated":"2026-10-31T00:25:25Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Return all synchronised objects, including those synced to synced and so on.","syntaxes":[{"syntax":"[object, filter] call BIS_fnc_allSynchronizedObjects","params":[{"name":"object","type":"Object","description":"parent object","type_expr":"Object"},{"name":"filter","type":"String or Array of Strings","optional":true,"default":"\"\"","description":"class name filter. 1 or more class name of objects we are interested in","type_expr":"String | Array<String>","text":"filter: String or Array of Strings - (Optional, default \"\") class name filter. 1 or more class name of objects we are interested in"}],"returns":{"type":"Array","type_expr":"Array","description":"synchronized objects"}}],"examples":[{"code":["[BIS_Poliakko, \"LocationArea_F\"] call BIS_fnc_allSynchronizedObjects;"]}],"see_also":["BIS_fnc_synchronizedObjects"]},{"name":"BIS_fnc_allTurrets","title":"BIS fnc allTurrets","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_allTurrets","revid":378550,"updated":"2026-05-05T15:09:23Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Returns all vehicle turrets from config with options. Does what allTurrets command does, except the param is vehicle's config classname.","syntaxes":[{"syntax":"vehicleClass call BIS_fnc_allTurrets","params":[{"name":"vehicleClass","type":"String","description":"classname of the vehicle","type_expr":"String"}],"returns":{"type":"Array of Turret Paths","type_expr":"Array<Turret Path>"}},{"syntax":"[vehicleClass, personTurrets] call BIS_fnc_allTurrets","params":[{"name":"vehicleClass","type":"String","description":"classname of the vehicle","type_expr":"String"},{"name":"personTurrets","type":"Boolean","description":"true to include FFV (firing from vehicle) turrets, false to exclude them","type_expr":"Boolean"}],"returns":{"type":"Array of Turret Paths","type_expr":"Array<Turret Path>"}}],"examples":[{"code":["private _allTurrets = \"C_Offroad_01_F\" call BIS_fnc_allTurrets; // []"]},{"code":["private _allTurrets = [\"C_Offroad_01_F\", true] call BIS_fnc_allTurrets; // [[0],[1],[2],[3]]"]},{"code":["private _allTurrets = [\"C_Offroad_01_F\", false] call BIS_fnc_allTurrets; // []"]}],"see_also":["allTurrets","BIS_fnc_getTurrets","BIS_fnc_turretConfig","BIS_fnc_vehicleCrewTurrets"]},{"name":"BIS_fnc_ambientAnim","title":"BIS fnc ambientAnim","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_ambientAnim","revid":329376,"updated":"2022-07-27T12:38:16Z","groups":["Ambient"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Play set of ambient animations on given unit. If the unit should react to combat, use BIS_fnc_ambientAnimCombat instead.\n\n> [!NOTE]\n> Animations can be cancelled using `_unit call BIS_fnc_ambientAnim__terminate`.","syntaxes":[{"syntax":"[unit, animationSet, equipmentLevel, snapTo, interpolate, attachToLogic] call BIS_fnc_ambientAnim","params":[{"name":"unit","type":"Object","description":"unit that will play the animations","type_expr":"Object"},{"name":"animationSet","type":"String","description":"the animation set to play. Possible values:\n\n***some values are missing due to duplicate results, e.g \"STAND\" does the same as \"STAND1\"***\n\n|  |  |  |\n|---|---|---|\n| - STAND1<br>- STAND2<br>- STAND_U1<br>- STAND_U2<br>- STAND_U3<br>- WATCH<br>- WATCH2<br>- GUARD<br>- LISTEN_BRIEFING<br>- LEAN_ON_TABLE<br>- LEAN | - SIT_AT_TABLE<br>- SIT1<br>- SIT<br>- SIT3<br>- SIT_U1<br>- SIT_U2<br>- SIT_U3<br>- SIT_HIGH1<br>- SIT_HIGH<br>- SIT_LOW<br>- SIT_LOW_U<br>- SIT_SAD1<br>- SIT_SAD2 | - KNEEL<br>- REPAIR_VEH_PRONE<br>- REPAIR_VEH_KNEEL<br>- REPAIR_VEH_STAND<br>- PRONE_INJURED_U1<br>- PRONE_INJURED_U2<br>- PRONE_INJURED<br>- KNEEL_TREAT<br>- KNEEL_TREAT2<br>- BRIEFING<br>- BRIEFING_POINT_LEFT<br>- BRIEFING_POINT_RIGHT<br>- BRIEFING_POINT_TABLE |","type_expr":"String"},{"name":"equipmentLevel","type":"String","description":"the equipment level of the unit. Possible values:\n\n- NONE\n- LIGHT\n- MEDIUM\n- FULL\n- ASIS\n- RANDOM","type_expr":"String"},{"name":"snapTo","type":"Object","optional":true,"default":"objNull","description":"the object where the unit will be snapped to","type_expr":"Object","text":"snapTo: Object - (Optional, default objNull) the object where the unit will be snapped to"},{"name":"interpolate","type":"Boolean","optional":true,"default":"false","description":"should try to interpolate into the ambient animation. Works only for some default stances","type_expr":"Boolean","text":"interpolate: Boolean - (Optional, default false) should try to interpolate into the ambient animation. Works only for some default stances"},{"name":"attachToLogic","type":"Boolean","optional":true,"default":"true","description":"true to attach the unit to the created logic object, forcing it in one position","type_expr":"Boolean","text":"attachToLogic: Boolean - (Optional, default true) true to attach the unit to the created logic object, forcing it in one position"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[player, \"STAND1\", \"ASIS\"] call BIS_fnc_ambientAnim;"]},{"code":["// will search for a chair within 2 meters around the unit and will place the unit on it\n[_unit, \"SIT\", \"NONE\"] call BIS_fnc_ambientAnim;"]}],"see_also":["BIS_fnc_ambientAnimCombat","BIS_fnc_ambientAnimGetParams"],"notes":[{"user":"PierreMGI","date":"2016-02-19T04:24:00Z","text":"In 3den editor, place a blufor unit (B_soldier_A_F) near a camping chair (land_campingChair_V2_F).\nIn init field of the unit:\n\n```sqf\n[this, \"SIT2\"] call BIS_fnc_ambientAnim;\n0 = this spawn {\n    waitUntil { behaviour _this == \"combat\"};\n    _this call BIS_fnc_ambientAnim__terminate;\n};\n```\n\nWhen this unit is aware of a threat, he will quit the \"ambient animation\" and will able to return fire.\nNote: BIS_fnc_ambientAnimCombat doesn't need this script but the list of animations is limited."},{"user":"PierreMGI","date":"2016-08-08T01:37:00Z","text":"To make this command working in MP (hosted server tested)\n\n```sqf\n[this, \"SIT2\"] call BIS_fnc_ambientAnim; // wrong! the first JIP will throw the unit to position [0,0,0]\nif (isServer) then { [this, \"SIT2\"] call BIS_fnc_ambientAnim; }; // wrong! only player located on server will see the animation\nif (local this) then { [this, \"SIT2\"] call BIS_fnc_ambientAnim; }; // OK, best way\nif (isServer) then { [this, \"SIT2\"] remoteExecCall [\"BIS_fnc_ambientAnim\"]; }; // OK\n```"},{"user":"Icaruk","date":"2016-08-11T16:33:00Z","text":"Be careful using this function multiple times on MP, it creates a Logic using createUnit (which is global).\nIf you use it on 20 units, 20 additional logics will be created."}]},{"name":"BIS_fnc_ambientAnimCombat","title":"BIS fnc ambientAnimCombat","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_ambientAnimCombat","revid":349315,"updated":"2023-11-08T14:52:25Z","groups":["Ambient"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Play set of ambient animations on given unit AND allows the unit to leave the ambient state and engage enemy or move away.\n\n> [!NOTE]\n> Animations can be cancelled using `_unit call BIS_fnc_ambientAnim__terminate`.","syntaxes":[{"syntax":"[unit, animationSet, equipmentLevel, condition, behaviour] call BIS_fnc_ambientAnimCombat","params":[{"name":"unit","type":"Object","description":"unit where the animations will be played","type_expr":"Object"},{"name":"animationSet","type":"String","optional":true,"default":"\"STAND\"","description":"the animation set to play. Possible values are:\n\n- \"STAND\"\n- \"STAND_IA\"\n- \"SIT_LOW\"\n- \"KNEEL\"\n- \"LEAN\"\n- \"WATCH\"\n- \"WATCH1\"\n- \"WATCH2\"","type_expr":"String","text":"animationSet: String - (Optional, default \"STAND\") the animation set to play. Possible values are:\n\n- \"STAND\"\n- \"STAND_IA\"\n- \"SIT_LOW\"\n- \"KNEEL\"\n- \"LEAN\"\n- \"WATCH\"\n- \"WATCH1\"\n- \"WATCH2\""},{"name":"equipmentLevel","type":"String","optional":true,"default":"\"RANDOM\"","description":"the equipment level of the unit. Possible values are:\n\n- \"NONE\"\n- \"LIGHT\"\n- \"MEDIUM\"\n- \"FULL\"\n- \"ASIS\"\n- \"RANDOM\"","type_expr":"String","text":"equipmentLevel: String - (Optional, default \"RANDOM\") the equipment level of the unit. Possible values are:\n\n- \"NONE\"\n- \"LIGHT\"\n- \"MEDIUM\"\n- \"FULL\"\n- \"ASIS\"\n- \"RANDOM\""},{"name":"condition","type":"Code or String","optional":true,"default":"`{ false }`","description":"condition that if true frees the unit from the animation loop","type_expr":"Code | String","text":"condition: Code or String - (Optional, default `{ false }`) condition that if true frees the unit from the animation loop"},{"name":"behaviour","type":"String","optional":true,"default":"\"COMBAT\"","description":"behaviour the unit should go to, when freed. Default \"COMBAT\"","type_expr":"String","text":"behaviour: String - (Optional, default \"COMBAT\") behaviour the unit should go to, when freed. Default \"COMBAT\""}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[_unit, \"STAND\", \"FULL\", { (player distance _this) < 5 }] call BIS_fnc_ambientAnimCombat;"]}],"see_also":["BIS_fnc_ambientAnim"]},{"name":"BIS_fnc_ambientAnimGetParams","title":"BIS fnc ambientAnimGetParams","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_ambientAnimGetParams","revid":348306,"updated":"2023-11-08T12:59:37Z","groups":["Ambient"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Feeds params of given animset to BIS_fnc_ambientAnim.","syntaxes":[{"syntax":"animType call BIS_fnc_ambientAnimGetParams","params":[{"name":"animType","type":"String","description":"can be:\n\n- \"STAND1\"\n- \"STAND2\"\n- \"STAND_U1\"\n- \"STAND_U2\"\n- \"STAND_U3\"\n- \"WATCH\"\n- \"WATCH2\"\n- \"GUARD\"\n- \"LISTEN_BRIEFING\"\n- \"LEAN_ON_TABLE\"\n- \"LEAN\"\n- \"SIT_AT_TABLE\"\n- \"SIT1\"\n- \"SIT\"\n- \"SIT3\"\n- \"SIT_U1\"\n- \"SIT_U2\"\n- \"SIT_U3\"\n- \"SIT_HIGH1\"\n- \"SIT_HIGH\"\n- \"SIT_LOW\"\n- \"SIT_LOW_U\"\n- \"SIT_SAD1\"\n- \"SIT_SAD2\"\n- \"KNEEL\"\n- \"REPAIR_VEH_PRONE\"\n- \"REPAIR_VEH_KNEEL\"\n- \"REPAIR_VEH_STAND\"\n- \"PRONE_INJURED_U1\"\n- \"PRONE_INJURED_U2\"\n- \"PRONE_INJURED\"\n- \"KNEEL_TREAT\"\n- \"KNEEL_TREAT2\"\n- \"BRIEFING\"\n- \"BRIEFING_POINT_LEFT\"\n- \"BRIEFING_POINT_RIGHT\"\n- \"BRIEFING_POINT_TABLE\"","type_expr":"String"}],"returns":{"type":"Array","type_expr":"Array","description":"animation parameters"}}],"examples":[{"code":["private _animParams = \"KNEEL\" call BIS_fnc_ambientAnimGetParams;"]}],"see_also":["BIS_fnc_ambientAnimCombat","BIS_fnc_ambientAnim"]},{"name":"BIS_fnc_ambientBlacklist","title":"BIS fnc ambientBlacklist","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_ambientBlacklist","revid":349062,"updated":"2023-11-08T14:47:20Z","groups":["Ambient","Positions"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Check if area is blacklisted. Blacklist triggers are to be named 'bis_ambientBlacklist_#', where # is number from 0 to 99.","syntaxes":[{"syntax":"[input] call BIS_fnc_ambientBlacklist","params":[{"name":"input","type":"Array","description":"if array, function checks if givin position is in blacklisted areas. If any Number is passed to the function instead of an Array blacklisted areas are initialized and saved in BIS_ambientBlacklist","type_expr":"Array"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"returns Boolean when in blacklisted area, when initialization was triggered, it returns nil"}}],"examples":[{"code":["[1337,1337,0] call BIS_fnc_ambientBlacklist;"]},{"code":["[0] call BIS_fnc_ambientBlacklist;"]}],"see_also":["BIS_fnc_ambientBlacklistAdd"]},{"name":"BIS_fnc_ambientBlacklistAdd","title":"BIS fnc ambientBlacklistAdd","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_ambientBlacklistAdd","revid":349185,"updated":"2023-11-08T14:50:39Z","groups":["Ambient","Positions"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Add a new ambient blacklist trigger","syntaxes":[{"syntax":"[trigger] call BIS_fnc_ambientBlacklistAdd","params":[{"name":"trigger","type":"Object","description":"trigger","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"returns true if it was added successfully"}}],"examples":[{"code":["[BIS_trigger] call BIS_fnc_ambientBlacklistAdd;"]}],"see_also":["BIS_fnc_ambientBlacklist"]},{"name":"BIS_fnc_ambientBoats","title":"BIS fnc ambientBoats","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_ambientBoats","revid":283011,"updated":"2021-06-16T22:11:35Z","groups":["Ambient"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_ambientFlyby","title":"BIS fnc ambientFlyby","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_ambientFlyby","revid":364496,"updated":"2024-05-16T20:42:01Z","groups":["Ambient"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Spawns an air unit that moves from point A to point B, never engaging nor being engaged. It is set as captive and will despawn once it reaches its destination.\n\n> [!NOTE]\n> Created vehicle is set captive, making its side civilian.","syntaxes":[{"syntax":"[startPos, endPos, altitude, speedMode, classname, side] call BIS_fnc_ambientFlyby","params":[{"name":"startPos","type":"Position","description":"start position of the air unit. The Z value does not matter and is replaced by *altitude*","type_expr":"Position"},{"name":"endPos","type":"Array format PositionAGL","description":"end position where the air unit moves to and despawns (through addWaypoint)","type_expr":"PositionAGL","types":["Array","PositionAGL"]},{"name":"altitude","type":"Number","optional":true,"default":"100","description":"height at which air unit will spawn and fly above ground level","type_expr":"Number","text":"altitude: Number - (Optional, default 100) height at which air unit will spawn and fly above ground level"},{"name":"speedMode","type":"String","optional":true,"default":"\"NORMAL\"","description":"speed mode at which air unit travels. Possible values are \"LIMITED\", \"NORMAL\" and \"FULL\"","type_expr":"String","text":"speedMode: String - (Optional, default \"NORMAL\") speed mode at which air unit travels. Possible values are \"LIMITED\", \"NORMAL\" and \"FULL\""},{"name":"classname","type":"String","optional":true,"default":"\"B_Heli_Light_01_F\"","description":"vehicle classname defined in CfgVehicles","type_expr":"String","text":"classname: String - (Optional, default \"B_Heli_Light_01_F\") vehicle classname defined in CfgVehicles"},{"name":"side","type":"Side","optional":true,"default":"west","description":"side to which the vehicle belongs","type_expr":"Side","text":"side: Side - (Optional, default west) side to which the vehicle belongs"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if function executed successfully."}}],"examples":[{"code":["// spawns a Littlebird that flies from position 200,200,50 to 250,250,75 at altitude 100 and normal speed\n[[200,200,50], [250,250,75]] call BIS_fnc_ambientFlyby;"]},{"code":["[getPosATL player, getPosATL opforUnit, 400, \"FULL\", \"B_Heli_Light_01_Armed_F\", west] call BIS_fnc_ambientFlyby;"]}],"see_also":["createVehicle","BIS_fnc_spawnVehicle"]},{"name":"BIS_fnc_ambientHelicopters","title":"BIS fnc ambientHelicopters","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_ambientHelicopters","revid":283037,"updated":"2021-06-16T22:12:07Z","groups":["Ambient"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_ambientPlanes","title":"BIS fnc ambientPlanes","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_ambientPlanes","revid":378072,"updated":"2026-02-11T08:03:13Z","groups":["Ambient"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","locality":{"effect":"global"},"description":"Creates ambient airplanes fly-by near airports around the player. It will automatically get classes from `configFile >> \"CfgVehicles\"` on all planes that have \"ambientType\" attribute > 0.","syntaxes":[{"syntax":"[quantity, areaRadius, dirStep] call BIS_fnc_ambientPlanes","params":[{"name":"quantity","type":"Number","optional":true,"default":"5","type_expr":"Number","text":"quantity: Number - (Optional, default 5)"},{"name":"areaRadius","type":"Number","optional":true,"default":"10000","description":"area radius around airports where planes can spawn/fly","type_expr":"Number","text":"areaRadius: Number - (Optional, default 10000) area radius around airports where planes can spawn/fly"},{"name":"dirStep","type":"Number","optional":true,"default":"30","type_expr":"Number","text":"dirStep: Number - (Optional, default 30)"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[] call BIS_fnc_ambientPlanes;"]},{"code":["[30, 3000] call BIS_fnc_ambientPlanes;"]}],"multiplayer":"Since this function uses player and its effect is global,\nthis can only be used in singleplayer or executed locally on a player, usually the group leader.","see_also":["createUnit","createVehicle","BIS_fnc_spawnGroup"]},{"name":"BIS_fnc_ambientPostprocess","title":"BIS fnc ambientPostprocess","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_ambientPostprocess","revid":327503,"updated":"2022-07-12T22:24:52Z","groups":["Ambient"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","locality":{"effect":"local"},"description":"Initialize terrain-related postprocess effects.","syntaxes":[{"syntax":"[terrain, activation] call BIS_fnc_ambientPostprocess","params":[{"name":"terrain","type":"String","optional":true,"default":"worldName","description":"terrain from which to take post-process effets configuration","type_expr":"String","text":"terrain: String - (Optional, default worldName) terrain from which to take post-process effets configuration"},{"name":"String or Boolean","optional":true,"default":"true","description":"post-process type to get, or true to get all of them. **Any effect but \"filmGrain\"**.","type_expr":"String | Boolean","text":"String or Boolean - (Optional, default true) post-process type to get, or true to get all of them. **Any effect but \"filmGrain\"**."}],"returns":{"type":"Array of initialized effects with values","type_expr":"Array"}}],"examples":[{"code":["[] call BIS_fnc_ambientPostprocess;"]},{"code":["[\"Malden\", \"ColorCorrections\"] call BIS_fnc_ambientPostprocess;"]}],"see_also":["Post Process Effects"]},{"name":"BIS_fnc_animalBehaviour","title":"BIS fnc animalBehaviour","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_animalBehaviour","revid":379243,"updated":"2026-10-30T23:22:52Z","groups":["Ambient"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Animal behaviour control. Called by `Animals_F\\Data\\Scripts\\main.fsm`.","syntaxes":[{"syntax":"[animal] call BIS_fnc_animalBehaviour","params":[{"name":"animal","type":"Object","description":"the controlled animal","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[animal] call BIS_fnc_animalBehaviour;"]}],"see_also":["Arma 3: Animals: Override Default Animal Behaviour Via Script","createAgent"],"notes":[{"user":"Killzone_Kid","date":"2014-09-29T19:38:00Z","text":"To override, add\n\n```sqf\n_agent setVariable [\"BIS_fnc_animalBehaviour_disable\", true];\n```\n\nright after agent creation."}]},{"name":"BIS_fnc_animalRandomization","title":"BIS fnc animalRandomization","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_animalRandomization","revid":325112,"updated":"2022-07-01T12:25:00Z","groups":["Ambient"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"local","effect":"global"},"description":"Randomise animals skin.\nWorks on:\n\n- \"Alsatian_Random_F\"\n- \"ButterFly_random\"\n- \"Cock_random_F\"\n- \"Fin_random_F\"\n- \"Goat_random_F\"\n- \"Sheep_random_F\"\n- \"Snake_random_F\"","syntaxes":[{"syntax":"animal call BIS_fnc_animalRandomization","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["myDog call BIS_fnc_animalRandomization;"]}],"see_also":["BIS_fnc_unitHeadgear","setObjectTextureGlobal","setObjectMaterialGlobal"]},{"name":"BIS_fnc_animalSiteSpawn","title":"BIS fnc animalSiteSpawn","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_animalSiteSpawn","revid":364276,"updated":"2024-05-06T09:38:32Z","groups":["Ambient"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"server_exec":true},"description":"Create an area that spawns animals. The animals will be created or deleted if a player is inside or outside the area's radius.","syntaxes":[{"syntax":"[animalSite, classnamesToSpawn, radius] call BIS_fnc_animalSiteSpawn","params":[{"name":"animalSite","type":"Object","description":"the object to create the site around.","type_expr":"Object"},{"name":"classnamesToSpawn","type":"Array of Strings","description":"animals that can be spawned.","type_expr":"Array<String>"},{"name":"radius","type":"Number","description":"the radius by which animals are created or deleted.","type_expr":"Number"}],"returns":{"type":"Script Handle","type_expr":"Script Handle"}}],"examples":[{"code":["[player, [\"rabbit_f\", \"turtle_f\", \"hen_random_f\"], 200] call BIS_fnc_animalSiteSpawn;"]}],"see_also":["Arma 3: CfgVehicles Animals"],"notes":[{"user":"DreadedEntity","date":"2014-12-07T08:37:00Z","text":"The only way to stop the animals from spawning is to delete the object. When using this function, I recommend creating a non-solid object (almost anything from the \"Objects (Helpers)\" list in the editor, and using hideObjectGlobal on it. Using setVariable you can add the animal site to a reference object to find it easily when you want to delete it.\n\n```sqf\nprivate _obj = createVehicle [\"Sign_Sphere10cm_F\", getPos player, [], 0, \"CAN_COLLIDE\"];\nhideObjectGlobal _obj;\nplayer setVariable [\"animalSite\", _obj];\n_obj = nil;\n```\n\nThere are two hidden variables, \"animalCount\" and \"radius\". Use setVariable on the object to change these.\nanimalCount is supposed to limit the amount of animals that can spawn. In the code, the algorithm for this is hard to understand.\nradius refers to how far away from the object the animals can spawn.\nBoth are numbers.\n\nThe \"area\" is imaginary. It is not a tangible area defined by trigger or marker radius, the area is only saved as an integer within the function."},{"user":"Strangepete","date":"2014-12-07T09:26:00Z","text":"Using the Script Handle returned, the function can be checked using scriptDone or killed with terminate; Existing generated animals will *not* be cleaned up when terminated.\n\n```sqf\n_handle = [params] call BIS_fnc_animalSiteSpawn;\n\nif !(scriptDone _handle) then {\n    terminate _handle;\n};\n```"}]},{"name":"BIS_fnc_animatedBriefing","title":"BIS fnc animatedBriefing","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_animatedBriefing","revid":363759,"updated":"2024-04-17T21:17:53Z","groups":["Systems","Briefing"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","locality":{"effect":"local"},"exec":"spawn","description":"Plays the Animated Briefings. Basically, it is a wrap function for the BIS_fnc_eventTimeline function.","syntaxes":[{"syntax":"[timeline, indexEvent, music, markersHide, markersShow, endPosition] call BIS_fnc_animatedBriefing","params":[{"name":"timeline","type":"Array","description":"array in format [time, code]:\n\n- time: Number - time the code is executed\n- code: Code - code executed when *time* is reached","type_expr":"Array"},{"name":"indexEvent","type":"Number","description":"index of the event to play","type_expr":"Number"},{"name":"music","type":"String","optional":true,"default":"\"\"","description":"CfgMusic class","type_expr":"String","text":"music: String - (Optional, default \"\") CfgMusic class"},{"name":"markersHide","type":"Array","optional":true,"default":"`[]`","description":"array of markers which should be hidden when briefing starts","type_expr":"Array","text":"markersHide: Array - (Optional, default `[]`) array of markers which should be hidden when briefing starts"},{"name":"markersShow","type":"Array","optional":true,"default":"`[]`","description":"array of markers which should be shown when the briefing is done","type_expr":"Array","text":"markersShow: Array - (Optional, default `[]`) array of markers which should be shown when the briefing is done"},{"name":"endPosition","type":"String","optional":true,"default":"\"\"","description":"marker to focus when the briefing is done","type_expr":"String","text":"endPosition: String - (Optional, default \"\") marker to focus when the briefing is done"},{"name":"codeEnd","type":"Code","optional":true,"default":"`{}`","description":"code executed when briefing is done","type_expr":"Code","text":"codeEnd: Code - (Optional, default `{}`) code executed when briefing is done"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"```sqf\n// timeline of events\n_timeline = [\n    [0.0, { hint \"Start of the Timeline\" }],\n    [1.0, { hint \"Event 1\" }],\n    [3.0, { hint \"End of the timeline\" }]\n];\n\n// get markers to be shown at end by using the layer's name\nprivate _showMarkers = (getMissionLayerEntities \"showAtEnd\") select 1;\n\n// start the Animated Briefing at index 0\n// hide all markers and show the markers from the \"showAtEnd\" layer after the briefing is done\n// zoom on marker_rect_1 at the end of the briefing\n[_timeline, 0, \"\", nil, allMapMarkers, _showMarkers, \"marker_rect_1\"] spawn BIS_fnc_animatedBriefing;\n\n// Wait until timeline is over\nwaitUntil { !(missionNamespace getVariable \"BIS_fnc_eventTimeline_playing\"); };\n```","code":["// timeline of events\n_timeline = [\n\t[0.0, { hint \"Start of the Timeline\" }],\n\t[1.0, { hint \"Event 1\" }],\n\t[3.0, { hint \"End of the timeline\" }]\n];\n\n// get markers to be shown at end by using the layer's name\nprivate _showMarkers = (getMissionLayerEntities \"showAtEnd\") select 1;\n\n// start the Animated Briefing at index 0\n// hide all markers and show the markers from the \"showAtEnd\" layer after the briefing is done\n// zoom on marker_rect_1 at the end of the briefing\n[_timeline, 0, \"\", nil, allMapMarkers, _showMarkers, \"marker_rect_1\"] spawn BIS_fnc_animatedBriefing;\n\n// Wait until timeline is over\nwaitUntil { !(missionNamespace getVariable \"BIS_fnc_eventTimeline_playing\"); };"]}],"see_also":["Arma 3: Animated Briefing","BIS_fnc_eventTimeline"]},{"name":"BIS_fnc_animatedOpening","title":"BIS fnc animatedOpening","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_animatedOpening","revid":273901,"updated":"2021-06-13T01:13:06Z","groups":["Systems"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"","syntaxes":[{"syntax":"[] call BIS_fnc_animatedOpening","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"none","source":"docblock"}}],"docblock":{"text":"Author: BIS\n\nDescription:\n\n Parameters:\n\nReturns:\nnone","author":"BIS"},"filled_from_docblock":["returns"]},{"name":"BIS_fnc_animatedScreen","title":"BIS fnc animatedScreen","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_animatedScreen","revid":286030,"updated":"2021-06-20T17:24:33Z","groups":["Systems"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"","syntaxes":[{"syntax":"[] call BIS_fnc_animatedScreen","params":[],"returns":null}],"examples":[{"code":["[_mode] call BIS_fnc_animatedScreen;"]}],"docblock":{"text":"Example:\n[_mode] call BIS_fnc_animatedScreen;"},"filled_from_docblock":["examples"]},{"name":"BIS_fnc_animateFlag","title":"BIS fnc animateFlag","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_animateFlag","revid":379244,"updated":"2026-10-30T23:23:22Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.68"},"since":"arma3 1.68","arma3_since":"1.68","locality":{"argument":"global","effect":"global"},"description":"Smoothly animates given flag from current position on the flag pole to the given position. When flag animation is done, the scripted event handler \"FlagAnimationDone\" is called.","syntaxes":[{"syntax":"[flag, phase, instant] call BIS_fnc_animateFlag","params":[{"name":"flag","type":"Object","description":"flag object of the type \"FlagCarrier\"","type_expr":"Object"},{"name":"phase","type":"Number","description":"desired animation phase 0..1 (0 - bottom of the flag pole, 1 - top of the flag pole)","type_expr":"Number"},{"name":"instant","type":"Boolean or Number","optional":true,"default":"false","description":"Boolean - when true, animation is instant (\"FlagAnimationDone\" EH is not called in this case)\n- Number - animation duration multiplier","type_expr":"Boolean | Number","text":"instant: Boolean or Number - (Optional, default false)\n\n- Boolean - when true, animation is instant (\"FlagAnimationDone\" EH is not called in this case)\n- Number - animation duration multiplier"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[flag1, 0] call BIS_fnc_animateFlag;"]},{"code":["// Adding the \"FlagAnimationDone\" EH\nprivate _eh = [<yourflag>, \"FlagAnimationDone\", { /* your code */ }] call BIS_fnc_addScriptedEventHandler;"]}],"multiplayer":"The effect is global, MP compatible and its effect is persistent.","see_also":["flag","flagOwner","setFlagOwner","setFlagSide","setFlagTexture","flagSide","flagTexture","setFlagAnimationPhase","flagAnimationPhase","Arma 3: Flag Textures"],"notes":[{"user":"Killzone_Kid","date":"2016-12-12T20:02:00Z","text":"Flag Demo (https://www.youtube.com/watch?v=sJtQfRML0cc)\n\n```sqf\nfnc_addFlagAction =\n{\n    _this addAction\n    [\n        \"Pull The Cord\",\n        {\n            player playAction \"PutDown\";\n            sleep 0.5;\n            [_this select 0, flagAnimationPhase (_this select 0) + 0.2, 0.2] call BIS_fnc_animateFlag;\n            _this select 0 removeAction (_this select 2);\n        },\n        \"\",\n        10,\n        true,\n        true,\n        \"\",\n        \"_this distance2D _target < 2\"\n    ];\n};\n\nprivate _flag = createVehicle [\"Flag_BI_F\", player getRelPos [10, 0], [], 0, \"CAN_COLLIDE\"];\n[_flag, 0, true] call BIS_fnc_animateFlag;\n_flag call fnc_addFlagAction;\n\n[\n    _flag,\n    \"FlagAnimationDone\",\n    {\n        if (_this select 1 > 0.9) exitWith\n        {\n            [_this select 0, \"FlagAnimationDone\"] call BIS_fnc_removeAllScriptedEventHandlers;\n            removeAllActions (_this select 0);\n        };\n        _this select 0 call fnc_addFlagAction;\n    }\n]\ncall BIS_fnc_addScriptedEventHandler;\n```"}]},{"name":"BIS_fnc_animatePicture","title":"BIS fnc animatePicture","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_animatePicture","revid":379489,"updated":"2026-10-31T00:25:34Z","groups":["Systems"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Translates (relative or absolute), scales (relative or absolute), and sets the alpha over time on the provided control.","syntaxes":[{"syntax":"[control, durationOrSpeed, [translationPosition, isRelativeTranslation, useDuration], [scalePosition, isRelativeScale, scalePivot], alpha] call BIS_fnc_animatePicture","params":[{"name":"control","type":"Control","description":"the control to be moved","type_expr":"Control"},{"name":"durationOrSpeed","type":"Number","optional":true,"default":"2","description":"transition duration *or* movement speed, depending on *useDuration*","type_expr":"Number","text":"durationOrSpeed: Number - (Optional, default 2) transition duration *or* movement speed, depending on *useDuration*"},{"name":"translationPosition","type":"Array format Position2D","optional":true,"default":"[0,0]","type_expr":"Position2D","types":["Array","Position2D"],"text":"translationPosition: Array format Position2D - (Optional, default [0,0])"},{"name":"isRelativeTranslation","type":"Boolean","optional":true,"default":"true","description":"is *translationPosition* relative to the original *control*'s position","type_expr":"Boolean","text":"isRelativeTranslation: Boolean - (Optional, default true) is *translationPosition* relative to the original *control*'s position"},{"name":"useDuration","type":"Boolean","optional":true,"default":"true","description":"if set to false, *durationOrSpeed* will be used as *control* speed (and effect duration will be recalculated from it)","type_expr":"Boolean","text":"useDuration: Boolean - (Optional, default true) if set to false, *durationOrSpeed* will be used as *control* speed (and effect duration will be recalculated from it)"},{"name":"scalePosition","type":"Number or Array of Numbers","optional":true,"default":"1","description":"define X and Y scale value","type_expr":"Number | Array<Number>","text":"scalePosition: Number or Array of Numbers - (Optional, default 1) define X and Y scale value"},{"name":"isRelativeScale","type":"Boolean","optional":true,"default":"true","description":"is *scalePosition* relative to the original *control*'s scale","type_expr":"Boolean","text":"isRelativeScale: Boolean - (Optional, default true) is *scalePosition* relative to the original *control*'s scale"},{"name":"scalePivot","type":"String","optional":true,"default":"\"center\"","description":"case-**in**sensitive. Possible values:\n\n- \"topLeft\"\n- \"topCenter\"\n- \"topRight\"\n- \"centerLeft\"\n- \"center\" - fallback value\n- \"centerRight\"\n- \"bottomLeft\"\n- \"bottomCenter\"\n- \"bottomRight\"","type_expr":"String","text":"scalePivot: String - (Optional, default \"center\") case-**in**sensitive. Possible values:\n\n- \"topLeft\"\n- \"topCenter\"\n- \"topRight\"\n- \"centerLeft\"\n- \"center\" - fallback value\n- \"centerRight\"\n- \"bottomLeft\"\n- \"bottomCenter\"\n- \"bottomRight\""},{"name":"alpha","type":"Number","optional":true,"default":"0","description":"*control*'s final opacity","type_expr":"Number","text":"alpha: Number - (Optional, default 0) *control*'s final opacity"}],"returns":{"type":"Number","type_expr":"Number","description":"animation's duration"}}],"examples":[{"text":"```sqf\nprivate _t =\n[\n    _controlFront,\n    1,\n    [[0.5, 0.5], true, false],\n    [],\n    0.5\n]\ncall BIS_fnc_animatePicture;\n```","code":["private _t =\n[\n\t_controlFront,\n\t1,\n\t[[0.5, 0.5], true, false],\n\t[],\n\t0.5\n] \ncall BIS_fnc_animatePicture;"]}]},{"name":"BIS_fnc_animateTaskWaypoint","title":"BIS fnc animateTaskWaypoint","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_animateTaskWaypoint","revid":348615,"updated":"2023-11-08T13:45:39Z","groups":["Tasks"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"Plays an animation that pushes the active task waypoint up and down.","syntaxes":[{"syntax":"param call BIS_fnc_animateTaskWaypoint","params":[{"name":"Object","description":"unit that should have animations played.","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[player] call BIS_fnc_animateTaskWaypoint;"]}],"see_also":["Task Framework"]},{"name":"BIS_fnc_animType","title":"BIS fnc animType","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_animType","revid":379247,"updated":"2026-10-30T23:40:45Z","groups":["Object Manipulation"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Function that returns a categorized array using a single string with the animation name.","syntaxes":[{"syntax":"param call BIS_fnc_animType","params":[{"name":"String","description":"animation name.","type_expr":"String"}],"returns":{"type":"Array","type_expr":"Array","description":"sorted arrays within an array with details about animation."}}],"examples":[{"code":["animType = [\"AmovPsitMstpSrasWrflDnon\"] call BIS_fnc_animType;\n// Returns [[\"Action\",\"Move\"],[\"Pose\",\"Sit\"],[\"Movement\",\"Stop\"],[\"Stance\",\"Raised\"],[\"Hand item\",\"Rifle\"],[\"Direction\",\"Not specified\"]]"]}],"notes":[{"user":"Tryteyker-","date":"2014-10-01T20:26:00Z","text":"The categorization is identical to that of the animation viewer, minus the direction array.\n\nSo if the animation you are running through this function is found in the following categories:\n\n```\nAction: Move\nPose: Erect\nMovement: Stop\nStance: Raised\nWeapon: Rifle\n```\n\nThen the following array will be returned:\n\n```sqf\n[[\"Action\", \"Move\"], [\"Pose\", \"Erect\"], [\"Movement\", \"Stop\"], [\"Stance\", \"Raised\"], [\"Hand item\", \"Rifle\"], [\"Direction\", \"Not specified\"]];\n```"}]},{"name":"BIS_fnc_animViewer","title":"BIS fnc animViewer","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_animViewer","revid":349489,"updated":"2023-11-08T17:09:07Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Opens the Splendid™ Animation Viewer.","syntaxes":[{"syntax":"[] call BIS_fnc_animViewer","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[] call BIS_fnc_animViewer;"]}],"see_also":["BIS_fnc_configViewer"]},{"name":"BIS_fnc_areEqual","title":"BIS fnc areEqual","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_areEqual","revid":363456,"updated":"2024-03-30T21:12:17Z","groups":["Variables"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"This function returns true if all of the passed data elements are of the same type and value. One or more elements can be passed.\n\n> [!NOTE]\n> **Arma 3:** In Arma 3, see isEqualTo.\n\nNote:\n\n- This function is an improvement over the == operator because it can handle any data type in any combination.\n- For arrays, it returns true if both arrays hold the same elements in the same order.\n- If both values are undefined / nil / null, then this function will return true.","syntaxes":[{"syntax":"[anything1, anything2, ..., anythingN] call BIS_fnc_areEqual","params":[{"name":"anythingM","type":"Anything","description":"any data type","type_expr":"Anything"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"text":"```sqf\n[0, \"0\"]        call BIS_fnc_areEqual; // false\n[0, 1 + 1 - 2]    call BIS_fnc_areEqual; // true\n[str 50, \"50\"]    call BIS_fnc_areEqual; // true\n```","code":["[0, \"0\"]\t\tcall BIS_fnc_areEqual; // false\n[0, 1 + 1 - 2]\tcall BIS_fnc_areEqual; // true\n[str 50, \"50\"]\tcall BIS_fnc_areEqual; // true"]}],"problems":"EXTREMELY large strings (> 4k) or compiled code (from a file, for example) might not be properly compared if they are only different near the end of the file.","see_also":["isEqualTo","BIS_fnc_areEqualNotNil"]},{"name":"BIS_fnc_areEqualNotNil","title":"BIS fnc areEqualNotNil","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_areEqualNotNil","revid":327972,"updated":"2022-07-13T14:31:18Z","groups":["Variables"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Compares all elements of passed array between each other and returns true is all are defined and identical.\nVery fast, different from BIS_fnc_areEqual in that nil values will not be considered equal to each other.","syntaxes":[{"syntax":"[anything1, anything2, …] call BIS_fnc_areEqualNotNil","params":[{"name":"anythings","type":"Anything","description":"nil values won't be considered equal","type_expr":"Anything"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"text":"```sqf\n[[1, 2, [3, [4, 5]]],    [1, 2, [3, [4, 5]]]]    call BIS_fnc_areEqualNotNil; // true\n[[1, 2, [3, [4, nil]]],    [1, 2, [3, [4, nil]]]]    call BIS_fnc_areEqualNotNil; // false\n```","code":["[[1, 2, [3, [4, 5]]],\t[1, 2, [3, [4, 5]]]]\tcall BIS_fnc_areEqualNotNil; // true\n[[1, 2, [3, [4, nil]]],\t[1, 2, [3, [4, nil]]]]\tcall BIS_fnc_areEqualNotNil; // false"]},{"code":["[nil, nil] call BIS_fnc_areEqualNotNil; // false"]}],"see_also":["isEqualTo","BIS_fnc_areEqual"]},{"name":"BIS_fnc_areFriendly","title":"BIS fnc areFriendly","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_areFriendly","revid":379311,"updated":"2026-10-30T23:49:38Z","groups":["Sides"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Function that takes two Sides and compares them, returning whether they are friendly or not.","syntaxes":[{"syntax":"[side1, side2] call BIS_fnc_areFriendly","params":[{"name":"side1","type":"Side","description":"first side, will be compared to second side.","type_expr":"Side"},{"name":"side2","type":"Side","description":"second side, will be compared to first side.","type_expr":"Side"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if sides are friendly to each other, false if not."}}],"examples":[{"code":["private _areFriendly = [west, east] call BIS_fnc_areFriendly;"]}],"see_also":["getFriend","BIS_fnc_sideIsFriendly","BIS_fnc_sideIsEnemy"],"notes":[{"user":"Tryteyker-","date":"2014-09-29T19:31:00Z","text":"The friendly limit determined in the script is 0.6. Anything under 0.6 is considered hostile, whilst >=0.6 is considered friendly."}]},{"name":"BIS_fnc_arithmeticMean","title":"BIS fnc arithmeticMean","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_arithmeticMean","revid":338181,"updated":"2023-02-23T23:53:44Z","groups":["Math"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Returns the [arithmetic mean](https://en.wikipedia.org/wiki/Mean#Arithmetic_mean_(AM)) (\"average value\") of an array of numbers.","syntaxes":[{"syntax":"numbers call BIS_fnc_arithmeticMean","params":[{"name":"numbers","type":"Array of Numbers","description":"must not be empty","type_expr":"Array<Number>"}],"returns":{"type":"Number","type_expr":"Number","description":"arithmetic mean"}}],"examples":[{"code":["[1, 3] call BIS_fnc_arithmeticMean; // returns 2"]},{"code":["[1, 9, 8, 2] call BIS_fnc_arithmeticMean; // returns 5"]}],"see_also":["BIS_fnc_randomInt","BIS_fnc_geometricMean","BIS_fnc_nearestNum","BIS_fnc_sortNum","BIS_fnc_roundNum"]},{"name":"BIS_fnc_arrayCompare","title":"BIS fnc arrayCompare","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_arrayCompare","revid":327523,"updated":"2022-07-12T22:31:18Z","groups":["Arrays"],"status":"deprecated","replaced_by":["BIS_fnc_areEqual"],"games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"This function checks if two arrays are containing the same elements in the same order.\n\n> [!IMPORTANT]\n> This function is deprecated in Arma 2 as it fails with certain data types; see BIS_fnc_areEqual for Arma 2.\n\n> [!NOTE]\n> **Arma 3:** Use isEqualTo instead.","syntaxes":[{"syntax":"[array1, array2] call BIS_fnc_arrayCompare","params":[{"name":"array1","type":"Array","type_expr":"Array"},{"name":"array2","type":"Array","type_expr":"Array"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["private _array1 = [0,1,2];\nprivate _array2 = [0,1,2];\n[_array1, _array2] call BIS_fnc_arrayCompare; // returns true"]}],"see_also":["BIS_fnc_areEqual","BIS_fnc_areEqualNotNil","isEqualTo"]},{"name":"BIS_fnc_arrayFindDeep","title":"BIS fnc arrayFindDeep","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_arrayFindDeep","revid":379490,"updated":"2026-10-31T00:25:42Z","groups":["Arrays"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Searches an array for a specific value and returns its index.","syntaxes":[{"syntax":"[array,value] call BIS_fnc_arrayFindDeep","params":[{"name":"array","type":"Array","description":"array to be searched","type_expr":"Array"},{"name":"value","type":"Anything","description":"value to be searched for","type_expr":"Anything"}],"returns":{"type":"Array","type_expr":"Array","description":"returns array with index of found element, if it was not found it returns -1"}}],"examples":[{"code":["[[1,2,3,4,5], 3] call BIS_fnc_arrayFindDeep;//Returns [2]"]}],"see_also":["BIS_fnc_addToPairs","find","select","BIS_fnc_removeIndex"]},{"name":"BIS_fnc_arrayInsert","title":"BIS fnc arrayInsert","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_arrayInsert","revid":327948,"updated":"2022-07-13T12:52:47Z","groups":["Arrays"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Inserts the elements of one array into another, at a specified index. Neither arrays are touched by reference, a new array is returned.","syntaxes":[{"syntax":"[array1, array2, index] call BIS_fnc_arrayInsert","params":[{"name":"array1","type":"Array","description":"array to insert into","type_expr":"Array"},{"name":"array2","type":"Array","description":"array to be inserted","type_expr":"Array"},{"name":"index","type":"Number","description":"insertion index","type_expr":"Number"}],"returns":{"type":"Array","type_expr":"Array","description":"a new array"}}],"examples":[{"code":["private _result = [[0,1,2,3,4], [\"a\",\"b\",\"c\"], 1] call BIS_fnc_arrayInsert; // returns [0,\"a\",\"b\",\"c\",1,2,3,4]"]}]},{"name":"BIS_fnc_arrayPop","title":"BIS fnc arrayPop","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_arrayPop","revid":327524,"updated":"2022-07-12T22:31:42Z","groups":["Arrays"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"This function removes the last (rightmost) element of an array and returns it.\n**The array is passed by reference** so changes inside the function will be reflected outside of it.","syntaxes":[{"syntax":"array call BIS_fnc_arrayPop","params":[{"name":"array","type":"Array","type_expr":"Array"}],"returns":{"type":"Anything","type_expr":"Anything","description":"the removed array element"}}],"examples":[{"code":["private _array = [1,2,3,4];\n_removedElement = _array call BIS_fnc_arrayPop; // _array is now [1,2,3] and _removedElement = 4"]}],"see_also":["deleteAt","resize"]},{"name":"BIS_fnc_arrayPush","title":"BIS fnc arrayPush","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_arrayPush","revid":327182,"updated":"2022-07-12T22:09:49Z","groups":["Arrays"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"This function adds an element to the end of an array and returns the array.\n**The array is passed by reference** so changes inside the function will be reflected outside of it.\n\n> [!NOTE]\n> **Arma 3:** Use append or pushBack instead.","syntaxes":[{"syntax":"[array, element] call BIS_fnc_arrayPush","params":[{"name":"array","type":"Array","type_expr":"Array"},{"name":"element","type":"Anything","type_expr":"Anything"}],"returns":{"type":"Array","type_expr":"Array","description":"modified array","text":"Array - modified *array*"}}],"examples":[{"code":["_newArray = [[0,1,2], 3] call BIS_fnc_arrayPush; // _newArray is [0,1,2,3]"]},{"code":["private _array = [0,1,2]; [_array, [3]] call BIS_fnc_arrayPush; // _array is [0,1,2,[3]]"]}],"see_also":["append","pushBack","BIS_fnc_arrayPushStack"]},{"name":"BIS_fnc_arrayPushStack","title":"BIS fnc arrayPushStack","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_arrayPushStack","revid":327475,"updated":"2022-07-12T22:13:25Z","groups":["Arrays"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"This function is similar to the array push function; however, it pushes the contents of an array onto the stack array.\n\n> [!NOTE]\n> **Arma 3:** Use append or pushBack instead","syntaxes":[{"syntax":"[array1, array2] call BIS_fnc_arrayPushStack","params":[{"name":"array1","type":"Array","type_expr":"Array"},{"name":"array2","type":"Array","type_expr":"Array"}],"returns":{"type":"Array","type_expr":"Array","description":"the modified array1","text":"Array - the modified *array1*"}}],"examples":[{"code":["private _array = [0,1,2];\n[_array, [3,4,5]] call BIS_fnc_arrayPushStack; // _array is [0,1,2,3,4,5]"]},{"code":["private _array = [[5, 6, 7], [8, [9], 10]] call BIS_fnc_arrayPushStack; // _array is [5, 6, 7, 8, [9], 10]"]}],"see_also":["BIS_fnc_arrayPush","pushBack","append"]},{"name":"BIS_fnc_arrayShift","title":"BIS fnc arrayShift","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_arrayShift","revid":329366,"updated":"2022-07-27T12:29:43Z","groups":["Arrays"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"This function removes the first (leftmost) element of an array and returns it.\nThe array is passed by reference so changes inside the function will be reflected outside of it.\n\n> [!NOTE]\n> **Arma 3:** In Arma 3, use `array deleteAt 0`.","syntaxes":[{"syntax":"[array] call BIS_fnc_arrayShift","params":[{"name":"array","type":"Array","description":"**NOTE:** given array must be within an array (e.g `[[10, 20, 30]] call BIS_fnc_arrayShift`)","type_expr":"Array"}],"returns":{"type":"Anything","type_expr":"Anything","description":"the removed element"}}],"examples":[{"text":"```sqf\nprivate _myArray = [\"2\", \"report\", \"status\"];\n_removedElement = [_myArray] call BIS_fnc_arrayShift;    // array is -within an array-\n_removedElement == \"2\";                                    // true\n_myArray isEqualTo [\"report\", \"status\"];                // true\n```","code":["private _myArray = [\"2\", \"report\", \"status\"];\n_removedElement = [_myArray] call BIS_fnc_arrayShift;\t// array is -within an array-\n_removedElement == \"2\";\t\t\t\t\t\t\t\t\t// true\n_myArray isEqualTo [\"report\", \"status\"];\t\t\t\t// true"]}],"see_also":["deleteAt","pushBack"]},{"name":"BIS_fnc_arrayShuffle","title":"BIS fnc arrayShuffle","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_arrayShuffle","revid":327476,"updated":"2022-07-12T22:13:51Z","groups":["Arrays"],"status":"ok","games":{"arma3":"0.58"},"since":"arma3 0.58","arma3_since":"0.58","description":"Return a new array with randomized order of elements from input array.","syntaxes":[{"syntax":"array call BIS_fnc_arrayShuffle","params":[{"name":"array","type":"Array","type_expr":"Array"}],"returns":{"type":"Array","type_expr":"Array","description":"a new array instance"}}],"examples":[{"code":["[1,2,3] call BIS_fnc_arrayShuffle; // can return [1,2,3] (the original order), [3,1,2], [2,3,1], [1,3,2], [2,1,3] or [3,2,1]"]}],"see_also":["sort","BIS_fnc_sortBy","random"]},{"name":"BIS_fnc_arrayUnShift","title":"BIS fnc arrayUnShift","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_arrayUnShift","revid":327477,"updated":"2022-07-12T22:16:10Z","groups":["Arrays"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"This function adds an element to the beginning of an array and returns the array.\nThe array is passed by reference so changes inside the function will be reflected outside of it.","syntaxes":[{"syntax":"[array, value] call BIS_fnc_arrayUnShift","params":[{"name":"array","type":"Array","type_expr":"Array"},{"name":"value","type":"Anything","type_expr":"Anything"}],"returns":{"type":"Array","type_expr":"Array","description":"array reference","text":"Array - *array* reference"}}],"examples":[{"text":"```sqf\nprivate _array = [2,3,4];\n[_array, 1] call BIS_fnc_arrayUnShift;                        // _array is now [1,2,3,4]\n```","code":["private _array = [2,3,4];\n[_array, 1] call BIS_fnc_arrayUnShift;\t\t\t\t\t\t// _array is now [1,2,3,4]"]},{"text":"```sqf\nprivate _array = [[2,3,4], 1] call BIS_fnc_arrayUnShift;    // _array is now [1,2,3,4]\n```","code":["private _array = [[2,3,4], 1] call BIS_fnc_arrayUnShift;\t// _array is now [1,2,3,4]"]}],"see_also":["BIS_fnc_arrayShift","pushBack","select","set"]},{"name":"BIS_fnc_arsenal","title":"BIS fnc arsenal","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_arsenal","revid":364490,"updated":"2024-05-16T20:41:59Z","groups":["Inventory"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"Function used for the Virtual Arsenal. The function features four different modes, each mode comes with its own parameters.\n\n> [!NOTE]\n> If Arsenal is launched within the first second from the mission start, the unit loadout will be randomised.","syntaxes":[{"syntax":"[mode, params] call BIS_fnc_arsenal","params":[{"name":"mode","type":"String","description":"mode, can be one of:\n\n- \"Open\" - opens the Arsenal\n- \"Preload\" - preloads item configs, without preloading the configs are parsed the first time it is opened\n- \"AmmoboxInit\" - adds a virtual ammobox. Action to access the Arsenal will be added automatically to all clients\n- \"AmmoboxExit\" - remove virtual ammobox","type_expr":"String"},{"name":"params","type":"Anything","description":"mode parameters:\n\n- **\"Open\"**: [full, cargo, center]\n  - full: Boolean - (Optional, default false) true to open full Arsenal with all items available\n  - cargo: Object to use as the cargo carrier (cargo is added with the BIS_fnc_addVirtualItemCargo functions)\n  - center: Object whose arsenal will be modified\n- **\"Preload\"**: no parameters\n- **\"AmmoboxInit\"**: [ammobox, allItems, condition]\n  - ammobox: Object - Object which should get a virtual ammobox\n  - allItems: Boolean - (Optional, default false) true to make all items available\n  - condition: Code - (Optional, default `{ true }`) condition for the Arsenal to be accessible. Available arguments are the same as in addAction's *condition* parameter:\n    - _target: Object - object to which the action is attached or, if the object is a unit inside of vehicle, the vehicle\n    - _this: Object - caller person to whom the action is shown (or not depending on *condition*)\n    - _originalTarget: Object - original object to which the action is attached, regardless if the object/unit is in a vehicle or not\n- **\"AmmoboxExit\"**: [ammobox]\n  - ammobox: Object - the object to which the Arsenal was added","type_expr":"Anything"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"Opens Arsenal with all items:\n\n```sqf\n[\"Open\", [true]] call BIS_fnc_arsenal;\n```","code":["[\"Open\", [true]] call BIS_fnc_arsenal;"]},{"text":"Preloads Arsenal's config:\n\n```sqf\n[\"Preload\"] call BIS_fnc_arsenal;\n```","code":["[\"Preload\"] call BIS_fnc_arsenal;"]},{"text":"Adds full Arsenal to the player object and makes the action available when the player is closer than 10 meters from ammoBox:\n\n```sqf\n[\"AmmoboxInit\", [ammoBox, true, { _this distance _target  < 10 }]] call BIS_fnc_arsenal;\n```","code":["[\"AmmoboxInit\", [ammoBox, true, { _this distance _target  < 10 }]] call BIS_fnc_arsenal;"]},{"text":"Removes Arsenal from player object:\n\n```sqf\n[\"AmmoboxExit\", player] call BIS_fnc_arsenal;\n```","code":["[\"AmmoboxExit\", player] call BIS_fnc_arsenal;"]}],"see_also":["Arma 3: Arsenal","BIS_fnc_garage"]},{"name":"BIS_fnc_assignPlayerRole","title":"BIS fnc assignPlayerRole","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_assignPlayerRole","revid":326919,"updated":"2022-07-12T21:44:38Z","groups":["Object Manipulation"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","locality":{"effect":"local"},"description":"Ensures the player can only get in the specific vehicle role.","syntaxes":[{"syntax":"[vehicle, role, path] call BIS_fnc_assignPlayerRole","params":[{"name":"vehicle","type":"Object","description":"targeted vehicle","type_expr":"Object"},{"name":"role","type":"String","description":"can be one of:\n\n- \"driver\"\n- \"gunner\"\n- \"commander\"\n- \"cargo\"\n- \"turret\"","type_expr":"String"},{"name":"path","type":"Array or Numbers","description":"the turret path","type_expr":"Array | Number"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when done"}}],"examples":[{"code":["[myVehicle, \"turret\", [0, 1]] call BIS_fnc_assignPlayerRole;"]}],"see_also":["assignAsDriver","assignAsGunner","assignAsCommander","assignAsCargo","assignAsTurret"]},{"name":"BIS_fnc_attachToRelative","title":"BIS fnc attachToRelative","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_attachToRelative","revid":378576,"updated":"2026-05-10T12:49:53Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.64"},"since":"arma3 1.64","arma3_since":"1.64","locality":{"argument":"local","effect":"global"},"description":"Attaches an object to another, preserving their relative position and orientation.","syntaxes":[{"syntax":"[attachedObject, destinationObject, visual] call BIS_fnc_attachToRelative","params":[{"name":"attachedObject","type":"Object","type_expr":"Object"},{"name":"destinationObject","type":"Object","type_expr":"Object"},{"name":"visual","type":"Boolean","optional":true,"default":"true","description":"if true render scope is used else simulation scope. See Simulation vs Render Time Scope for more information","type_expr":"Boolean","text":"visual: Boolean (Optional, default true) if true render scope is used else simulation scope. See Simulation vs Render Time Scope for more information"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[player, car] call BIS_fnc_attachToRelative;"]}],"see_also":["BIS_fnc_weaponDirectionRelative","BIS_fnc_vectorDirAndUpRelative","attachTo"]},{"name":"BIS_fnc_baseVehicle","title":"BIS fnc baseVehicle","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_baseVehicle","revid":310379,"updated":"2022-05-05T18:02:57Z","groups":["Configs","Vehicles"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns base vehicle (i.e., vehicle which is not just derivative of other with different textures / animations).","syntaxes":[{"syntax":"class call BIS_fnc_baseVehicle","params":[{"name":"class","type":"String","description":"vehicle class","type_expr":"String"}],"returns":{"type":"class: String","types":["String"],"description":"base vehicle class"}}],"examples":[{"code":["[\"O_MBT_04_cannon_F\"] call BIS_fnc_baseVehicle;"]}],"see_also":["typeOf"]},{"name":"BIS_fnc_baseWeapon","title":"BIS fnc baseWeapon","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_baseWeapon","revid":349362,"updated":"2023-11-08T15:35:11Z","groups":["Weapons"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Determines base weapon class, with no attachments.","syntaxes":[{"syntax":"[weaponName] call BIS_fnc_baseWeapon","params":[{"name":"weaponName","type":"String","description":"weapon classname.","type_expr":"String"}],"returns":{"type":"String","type_expr":"String","description":"weapon classname that features no attachments."}}],"examples":[{"code":["[\"arifle_Mk20_MRCO_pointer_F\"] call BIS_fnc_baseWeapon; // Returns \"arifle_Mk20_F\""]}],"see_also":["BIS_fnc_weaponAddon","BIS_fnc_addWeapon"]},{"name":"BIS_fnc_basicBackpack","title":"BIS fnc basicBackpack","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_basicBackpack","revid":349020,"updated":"2023-11-08T14:47:08Z","groups":["Inventory"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Determines basic backpack with no equipment present (ie empty).","syntaxes":[{"syntax":"backPackClassName call BIS_fnc_basicBackpack","params":[{"name":"String","description":"backpack classname.","type_expr":"String"}],"returns":{"type":"String","type_expr":"String","description":"returns classname of base backpack."}}],"examples":[{"code":["baseBackpack = \"b_assaultpack_rgr_medic\" call BIS_fnc_basicBackpack; // returns \"b_assaultpack_rgr\", the base class"]}]},{"name":"BIS_fnc_basicTask","title":"BIS fnc basicTask","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_basicTask","revid":379544,"updated":"2026-10-31T13:40:20Z","groups":["Tasks"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"> [!NOTE]\n> **Arma 3:** Internally used **.fsm**.\n\nCompiled FSM that creates a predefined task for the player or changes its state. The only defined task type is \"ATTACK\"; its task ID is \"ATTACK_\" followed by the given number.\n\n- If the task does not exist yet, it is created with BIS_fnc_taskCreate (title \"Attack *name*\", description \"Attack the location and neutralize all enemies.\").\n- If the task exists and its state is \"Assigned\" or \"Created\", its state is changed with BIS_fnc_taskSetState.\n\n> [!NOTE]\n> The state check is case-sensitive, while a task created as current is stored as \"ASSIGNED\"; such a task is therefore not updated by a second call.","syntaxes":[{"syntax":"[taskType, taskNumber, params] call BIS_fnc_basicTask","params":[{"name":"taskType","type":"String","description":"\"ATTACK\"; any other value logs an error","type_expr":"String"},{"name":"taskNumber","type":"Number","optional":true,"default":"0","description":"number appended to the task ID","type_expr":"Number","text":"taskNumber: Number - (Optional, default 0) number appended to the task ID"},{"name":"params","type":"Array","optional":true,"default":"`[]`","description":"when the task does not exist: [position, name, isCurrent]\n  - position: anything accepted by BIS_fnc_position - (Optional, default `markerPos \"BIS_attack\"`) task destination; none is set if the position is [0,0,0]\n  - name: String - (Optional, default \"the location\") name used in the task title\n  - isCurrent: Boolean - (Optional, default true) set the task as current\n- when the task exists: [state]\n  - state: String - (Optional, default \"succeeded\") new task state","type_expr":"Array","text":"params: Array - (Optional, default `[]`)\n\n- when the task does not exist: [position, name, isCurrent]\n  - position: anything accepted by BIS_fnc_position - (Optional, default `markerPos \"BIS_attack\"`) task destination; none is set if the position is [0,0,0]\n  - name: String - (Optional, default \"the location\") name used in the task title\n  - isCurrent: Boolean - (Optional, default true) set the task as current\n- when the task exists: [state]\n  - state: String - (Optional, default \"succeeded\") new task state"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"ATTACK\", 1, [getMarkerPos \"target\", \"Agia Marina\"]] call BIS_fnc_basicTask; // creates task \"ATTACK_1\""]}],"see_also":["BIS_fnc_taskCreate","BIS_fnc_taskSetState","BIS_fnc_taskExists","BIS_fnc_taskState"]},{"name":"BIS_fnc_berp","title":"BIS fnc berp","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_berp","revid":338047,"updated":"2023-02-23T21:15:20Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Derivative of the [Kelvin function](https://en.wikipedia.org/wiki/Kelvin_functions) [ber](https://en.wikipedia.org/wiki/Kelvin_functions#ber(x)).","syntaxes":[{"syntax":"[a, b, delta] call BIS_fnc_berp","params":[{"name":"a","type":"Number","optional":true,"default":"0","description":"first point (start)","type_expr":"Number","text":"a: Number - (Optional, default 0) first point (start)"},{"name":"b","type":"Number","optional":true,"default":"0","description":"second point (end)","type_expr":"Number","text":"b: Number - (Optional, default 0) second point (end)"},{"name":"delta","type":"Number","optional":true,"default":"0","description":"the delta time, 0..1","type_expr":"Number","text":"delta: Number - (Optional, default 0) the delta time, 0..1"}],"returns":{"type":"Number","type_expr":"Number","description":"the interpolated value"}}],"examples":[{"code":["private _value = [0, 1, 0.5] call BIS_fnc_berp;"]}],"see_also":["BIS_fnc_berpVector"]},{"name":"BIS_fnc_berpVector","title":"BIS fnc berpVector","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_berpVector","revid":348150,"updated":"2023-11-08T11:32:41Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Wrapper for BIS_fnc_berp applying to each respective element of current and target vectors.","syntaxes":[{"syntax":"[a, b, delta] call BIS_fnc_berpVector","params":[{"name":"a","type":"Array format Vector3D","optional":true,"default":"[0,0,0]","description":"the current vector","type_expr":"Vector3D","types":["Array","Vector3D"],"text":"a: Array format Vector3D - (Optional, default [0,0,0]) the current vector"},{"name":"b","type":"Array format Vector3D","optional":true,"default":"[0,0,0]","description":"the target vector","type_expr":"Vector3D","types":["Array","Vector3D"],"text":"b: Array format Vector3D - (Optional, default [0,0,0]) the target vector"},{"name":"delta","type":"Number","optional":true,"default":"0","description":"the delta time in range 0..1","type_expr":"Number","text":"delta: Number - (Optional, default 0) the delta time in range 0..1"}],"returns":{"type":"Array","type_expr":"Array","description":"the interpolated vector"}}],"examples":[{"code":["private _vector = [[1,2,3], [11,12,13], 0.1] call BIS_fnc_berpVector;"]}],"see_also":["BIS_fnc_berp"]},{"name":"BIS_fnc_bezierInterpolate","title":"BIS fnc bezierInterpolate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_bezierInterpolate","revid":274026,"updated":"2021-06-13T01:15:21Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_bezierInterpolate","params":[],"returns":null}]},{"name":"BIS_fnc_bezierInterpolateVector","title":"BIS fnc bezierInterpolateVector","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_bezierInterpolateVector","revid":274127,"updated":"2021-06-13T01:17:02Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_bezierInterpolateVector","params":[],"returns":null}]},{"name":"BIS_fnc_bezierLength","title":"BIS fnc bezierLength","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_bezierLength","revid":273966,"updated":"2021-06-13T01:14:16Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_bezierLength","params":[],"returns":null}]},{"name":"BIS_fnc_bitflagsCheck","title":"BIS fnc bitflagsCheck","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_bitflagsCheck","revid":329417,"updated":"2022-07-27T15:28:10Z","groups":["Bitwise"],"status":"ok","games":{"arma3":"1.66"},"since":"arma3 1.66","arma3_since":"1.66","description":"Checks if one or more flags are set in the given flagset, represented with decimal or hexadecimal number\n(Hexadecimal number representation is simply auto-converted into decimal by the engine)\nIn other words, it simply performs a bitwise AND (&) operation on the two numbers: `flags & flagset > 0`\nTo check which flags are present in given flagset use BIS_fnc_bitflagsToArray","syntaxes":[{"syntax":"[flagset, flag] call BIS_fnc_bitflagsCheck","params":[{"name":"flagset","type":"Number","description":"flagset","type_expr":"Number"},{"name":"flag","type":"Number","description":"one or more flags to check","type_expr":"Number"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"- true: one or more flags are set in given flagset - false: no given flag or flags are set in the given flagset","text":"Boolean\n\n- true: one or more flags are set in given flagset\n- false: no given flag or flags are set in the given flagset"}}],"examples":[{"code":["[2 + 4 + 8, 8] call BIS_fnc_bitflagsCheck; // true\n[2 + 4 + 8, 2 + 32] call BIS_fnc_bitflagsCheck; // true\n[2 + 4 + 8, 1] call BIS_fnc_bitflagsCheck; // false\n[2 + 4 + 8, 1 + 32] call BIS_fnc_bitflagsCheck; // false"]}],"problems":"Due to various limitations of the Real Virtuality engine this function is intended to work with unsigned 24 bit integers only. This means that the supported range is 2^0...2^24 (1..16777216).","see_also":["BIS_fnc_bitflagsFlip","BIS_fnc_bitflagsSet","BIS_fnc_bitflagsToArray","BIS_fnc_bitflagsUnset"]},{"name":"BIS_fnc_bitflagsFlip","title":"BIS fnc bitflagsFlip","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_bitflagsFlip","revid":328595,"updated":"2022-07-13T17:02:29Z","groups":["Bitwise"],"status":"ok","games":{"arma3":"1.66"},"since":"arma3 1.66","arma3_since":"1.66","description":"Flips one or more flags (set gets unset and vice versa) in the given flagset, represented with decimal or hexadecimal number\n(Hexadecimal number representation is simply auto-converted into decimal by the engine)\nTo check which flags are present in given flagset use BIS_fnc_bitflagsToArray\n\n**Limitations**:\nDue to various limitations of the Real Virtuality engine this function is\nintended to work with unsigned 24 bit integers only. This means that the\nsupported range is 2^0...2^24 (1...16777216)","syntaxes":[{"syntax":"[flagset, flag] call BIS_fnc_bitflagsFlip","params":[{"name":"flagset","type":"Number","description":"flagset","type_expr":"Number"},{"name":"flag","type":"Number","description":"one or more flags to flip","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number","description":"new flagset with given flag or flags flipped"}}],"examples":[{"code":["[1 + 16, 8] call BIS_fnc_bitflagsFlip; // 25 (which is 1 + 8 + 16)\n[25, 8] call BIS_fnc_bitflagsFlip; // 17 (which is 1 + 16)\n[2 + 4 + 8, 2 + 8] call BIS_fnc_bitflagsFlip; // 4\n[4, 2 + 8] call BIS_fnc_bitflagsFlip; // 14 (which is 2 + 4 + 8)"]}],"see_also":["BIS_fnc_bitflagsSet","BIS_fnc_bitflagsCheck","BIS_fnc_bitflagsToArray","BIS_fnc_bitflagsUnset"]},{"name":"BIS_fnc_bitflagsSet","title":"BIS fnc bitflagsSet","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_bitflagsSet","revid":328600,"updated":"2022-07-13T17:02:31Z","groups":["Bitwise"],"status":"ok","games":{"arma3":"1.66"},"since":"arma3 1.66","arma3_since":"1.66","description":"Sets one or more flags in the given flagset, represented with decimal or hexadecimal number\n(Hexadecimal number representation is simply auto-converted into decimal by the engine)\nTo check which flags are present in given flagset use BIS_fnc_bitflagsToArray\n\n**Limitations**:\nDue to various limitations of the Real Virtuality engine this function is\nintended to work with unsigned 24 bit integers only. This means that the\nsupported range is 2^0...2^24 (1...16777216)","syntaxes":[{"syntax":"[flagset, flag] call BIS_fnc_bitflagsSet","params":[{"name":"flagset","type":"Number","description":"flagset","type_expr":"Number"},{"name":"flag","type":"Number","description":"one or more flags to set","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number","description":"new flagset with given flag or flags set"}}],"examples":[{"code":["[0, 16] call BIS_fnc_bitflagsSet; // 16\n[16, 2] call BIS_fnc_bitflagsSet; // 18 (which is 2 + 16)\n[18, 2 + 8 + 16] call BIS_fnc_bitflagsSet; // 26 (which is 2 + 8 + 16)"]}],"see_also":["BIS_fnc_bitflagsFlip","BIS_fnc_bitflagsCheck","BIS_fnc_bitflagsToArray","BIS_fnc_bitflagsUnset"]},{"name":"BIS_fnc_bitflagsToArray","title":"BIS fnc bitflagsToArray","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_bitflagsToArray","revid":328601,"updated":"2022-07-13T17:02:31Z","groups":["Bitwise"],"status":"ok","games":{"arma3":"1.66"},"since":"arma3 1.66","arma3_since":"1.66","description":"Returns array with all bit flags which are set in the given flagset\n\n**Limitations**:\nDue to various limitations of the Real Virtuality engine this function is\nintended to work with unsigned 24 bit integers only. This means that the\nsupported range is 2^0...2^24 (1...16777216)","syntaxes":[{"syntax":"flagset call BIS_fnc_bitflagsToArray","params":[{"name":"flagset","type":"Number","description":"decimal or hexadecimal unsigned 24 bit integer","type_expr":"Number"}],"returns":{"type":"Array","type_expr":"Array","description":"array of set bit flags"}}],"examples":[{"code":["15 call BIS_fnc_bitflagsToArray; // [1,2,4,8]\n2342 call BIS_fnc_bitflagsToArray; // [2,4,32,256,2048]\n[2 + 4 + 8] call BIS_fnc_bitflagsToArray; // [2,4,8]\n[2 + 2 + 2 + 4 + 8 + 8 + 8] call BIS_fnc_bitflagsToArray; // [2,32]"]}],"see_also":["BIS_fnc_bitflagsFlip","BIS_fnc_bitflagsSet","BIS_fnc_bitflagsCheck","BIS_fnc_bitflagsUnset"]},{"name":"BIS_fnc_bitflagsUnset","title":"BIS fnc bitflagsUnset","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_bitflagsUnset","revid":328654,"updated":"2022-07-13T17:04:22Z","groups":["Bitwise"],"status":"ok","games":{"arma3":"1.66"},"since":"arma3 1.66","arma3_since":"1.66","description":"Unsets one or more flags in the given flagset, represented with decimal or hexadecimal number\n(Hexadecimal number representation is simply auto-converted into decimal by the engine)\nTo check which flags are present in given flagset use BIS_fnc_bitflagsToArray\n\n**Limitations**:\nDue to various limitations of the Real Virtuality engine this function is\nintended to work with unsigned 24 bit integers only. This means that the\nsupported range is 2^0...2^24 (1...16777216)","syntaxes":[{"syntax":"[flagset, flag] call BIS_fnc_bitflagsUnset","params":[{"name":"flagset","type":"Number","description":"flagset","type_expr":"Number"},{"name":"flag","type":"Number","description":"one or more flags to unset","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number","description":"new flagset with given flag or flags unset"}}],"examples":[{"code":["[2 + 4 + 8, 8] call BIS_fnc_bitflagsUnset; // 6 (which is 2 + 4)\n[2 + 4 + 8, 2 + 8] call BIS_fnc_bitflagsUnset; // 4\n[2 + 4 + 8, 1 + 8] call BIS_fnc_bitflagsUnset; // 6 (which is 2 + 4)\n[2 + 4 + 8, 1 + 8 + 8 + 2 + 2] call BIS_fnc_bitflagsUnset; // 10 (which is 2 + 8, since 1 + 8 + 8 + 2 + 2 is in fact 1 + 4 + 16)"]}],"see_also":["BIS_fnc_bitflagsFlip","BIS_fnc_bitflagsCheck","BIS_fnc_bitflagsToArray","BIS_fnc_bitflagsSet"]},{"name":"BIS_fnc_bitwiseAND","title":"BIS fnc bitwiseAND","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_bitwiseAND","revid":328579,"updated":"2022-07-13T17:02:25Z","groups":["Bitwise"],"status":"ok","games":{"arma3":"1.66"},"since":"arma3 1.66","arma3_since":"1.66","description":"Performs bitwise AND operation on two decimal or hexadecimal unsigned 24 bit integers\n(Hexadecimal number representation is simply auto-converted into decimal by the engine)\n\n**Limitations**:\nDue to various limitations of the Real Virtuality engine this function is\nintended to work with unsigned 24 bit integers only. This means that the\nsupported range is 2^0...2^24 (1...16777216)","syntaxes":[{"syntax":"[num1, num2] call BIS_fnc_bitwiseAND","params":[{"name":"num1","type":"Number","description":"decimal or hexadecimal unsigned 24 bit integer","type_expr":"Number"},{"name":"num2","type":"Number","description":"decimal or hexadecimal unsigned 24 bit integer","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number","description":"decimal number"}}],"examples":[{"code":["[2 + 4 + 8 + 32, 1] call BIS_fnc_bitwiseAND; // 0\n[2 + 4 + 8 + 32, 2] call BIS_fnc_bitwiseAND; // 2\n[1 + 2 + 16 + 32, 4 + 8] call BIS_fnc_bitwiseAND; // 0\n[1 + 2 + 16 + 32, 4 + 32] call BIS_fnc_bitwiseAND; // 32\n[1 + 2 + 16 + 32, 16 + 32] call BIS_fnc_bitwiseAND; // 48"]}],"see_also":["BIS_fnc_bitwiseOR","BIS_fnc_bitwiseXOR","BIS_fnc_bitwiseNOT"]},{"name":"BIS_fnc_bitwiseNOT","title":"BIS fnc bitwiseNOT","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_bitwiseNOT","revid":328587,"updated":"2022-07-13T17:02:27Z","groups":["Bitwise"],"status":"ok","games":{"arma3":"1.66"},"since":"arma3 1.66","arma3_since":"1.66","description":"Performs bitwise NOT operation on decimal or hexadecimal unsigned 24 bit integer\n(Hexadecimal number representation is simply auto-converted into decimal by the engine)\n\n**Limitations**:\nDue to various limitations of the Real Virtuality engine this function is\nintended to work with unsigned 24 bit integers only. This means that the\nsupported range is 2^0...2^24 (1...16777216)","syntaxes":[{"syntax":"num call BIS_fnc_bitwiseNOT","params":[{"name":"num","type":"Number","description":"decimal or hexadecimal unsigned 24 bit integer","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number","description":"decimal number"}}],"examples":[{"code":["873687 call BIS_fnc_bitwiseNOT; // 15903528\n[2 + 4 + 8 + 32 + 256 + 1024] call BIS_fnc_bitwiseNOT; // 16775889"]}],"see_also":["BIS_fnc_bitwiseAND","BIS_fnc_bitwiseXOR","BIS_fnc_bitwiseOR"]},{"name":"BIS_fnc_bitwiseOR","title":"BIS fnc bitwiseOR","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_bitwiseOR","revid":328577,"updated":"2022-07-13T17:02:24Z","groups":["Bitwise"],"status":"ok","games":{"arma3":"1.66"},"since":"arma3 1.66","arma3_since":"1.66","description":"Performs bitwise OR operation on two decimal or hexadecimal unsigned 24 bit integers\n(Hexadecimal number representation is simply auto-converted into decimal by the engine)\n\n**Limitations**:\nDue to various limitations of the Real Virtuality engine this function is\nintended to work with unsigned 24 bit integers only. This means that the\nsupported range is 2^0...2^24 (1...16777216)","syntaxes":[{"syntax":"[num1, num2] call BIS_fnc_bitwiseOR","params":[{"name":"num1","type":"Number","description":"decimal or hexadecimal unsigned 24 bit integer","type_expr":"Number"},{"name":"num2","type":"Number","description":"decimal or hexadecimal unsigned 24 bit integer","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number","description":"decimal number"}}],"examples":[{"code":["[2 + 4 + 8 + 32, 1] call BIS_fnc_bitwiseOR; // 47\n[1 + 2 + 16 + 32, 4 + 8] call BIS_fnc_bitwiseOR; // 63\n[1 + 2 + 16 + 32, 4 + 32] call BIS_fnc_bitwiseOR; // 55\n[1 + 2 + 16 + 32, 16 + 32] call BIS_fnc_bitwiseOR; // 51"]}],"see_also":["BIS_fnc_bitwiseAND","BIS_fnc_bitwiseXOR","BIS_fnc_bitwiseNOT"]},{"name":"BIS_fnc_bitwiseXOR","title":"BIS fnc bitwiseXOR","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_bitwiseXOR","revid":328591,"updated":"2022-07-13T17:02:28Z","groups":["Bitwise"],"status":"ok","games":{"arma3":"1.66"},"since":"arma3 1.66","arma3_since":"1.66","description":"Performs bitwise XOR operation on two decimal or hexadecimal unsigned 24 bit integers\n(Hexadecimal number representation is simply auto-converted into decimal by the engine)\n\n**Limitations**:\nDue to various limitations of the Real Virtuality engine this function is\nintended to work with unsigned 24 bit integers only. This means that the\nsupported range is 2^0...2^24 (1...16777216)","syntaxes":[{"syntax":"[num1, num2] call BIS_fnc_bitwiseXOR","params":[{"name":"num1","type":"Number","description":"decimal or hexadecimal unsigned 24 bit integer","type_expr":"Number"},{"name":"num2","type":"Number","description":"decimal or hexadecimal unsigned 24 bit integer","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number","description":"decimal number"}}],"examples":[{"code":["[1 + 4 + 16, 1] call BIS_fnc_bitwiseXOR; // 20\n[1 + 2 + 32, 4 + 8] call BIS_fnc_bitwiseXOR; // 47\n[16 + 32, 4 + 16] call BIS_fnc_bitwiseXOR; // 36\n[1 + 16 + 32, 2 + 32] call BIS_fnc_bitwiseXOR; // 19"]}],"see_also":["BIS_fnc_bitwiseAND","BIS_fnc_bitwiseOR","BIS_fnc_bitwiseNOT"]},{"name":"BIS_fnc_blackIn","title":"BIS fnc blackIn","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_blackIn","revid":327342,"updated":"2022-07-12T22:11:55Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Unregister a black screen. When none other black screen is registered, fade it out.","syntaxes":[{"syntax":"[id, smoothing, fadeSpeed] call BIS_fnc_blackIn","params":[{"name":"id","type":"String","description":"black screen id used for registration (case sensitive)","type_expr":"String"},{"name":"smoothing","type":"Boolean","optional":true,"default":"true","description":"smooth transition - false for an immediate blackout","type_expr":"Boolean","text":"smoothing: Boolean - (Optional, default true) smooth transition - false for an immediate blackout"},{"name":"fadeSpeed","type":"Number","optional":true,"default":"2","description":"transition duration (if *smoothing* is true)","type_expr":"Number","text":"fadeSpeed: Number - (Optional, default 2) transition duration (if *smoothing* is true)"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"TAG_aVeryUniqueID\", false, 5] call BIS_fnc_blackIn;"]}],"see_also":["BIS_fnc_blackOut"]},{"name":"BIS_fnc_blackOut","title":"BIS fnc blackOut","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_blackOut","revid":327267,"updated":"2022-07-12T22:11:50Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Register a black screen. Start the black screen when the first request is registered.","syntaxes":[{"syntax":"[id, smoothing, fadeSpeed] call BIS_fnc_blackOut","params":[{"name":"id","type":"String","description":"black screen id used for registration (case sensitive)","type_expr":"String"},{"name":"smoothing","type":"Boolean","optional":true,"default":"true","description":"smooth transition - false for an immediate blackout","type_expr":"Boolean","text":"smoothing: Boolean - (Optional, default true) smooth transition - false for an immediate blackout"},{"name":"fadeSpeed","type":"Number","optional":true,"default":"2","description":"transition duration (if *smoothing* is true)","type_expr":"Number","text":"fadeSpeed: Number - (Optional, default 2) transition duration (if *smoothing* is true)"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"TAG_aVeryUniqueID\", false, 5] call BIS_fnc_blackOut;"]}],"see_also":["BIS_fnc_blackIn"]},{"name":"BIS_fnc_bleedTickets","title":"BIS fnc bleedTickets","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_bleedTickets","revid":348045,"updated":"2023-11-08T11:28:46Z","groups":["Missions"],"status":"ok","games":{"arma3":"1.10"},"since":"arma3 1.10","arma3_since":"1.10","description":"Function that handles bleeding ticket system. Tickets are set beforehand using BIS_fnc_respawnTickets.","syntaxes":[{"syntax":"[sides, dominanceRatio, bleedingAmount, bleedingDelay] call BIS_fnc_bleedTickets","params":[{"name":"sides","type":"Array","optional":true,"default":"All sides","description":"array of effected sides","type_expr":"Array","text":"sides: Array - (Optional, default All sides) array of effected sides"},{"name":"dominanceRatio","type":"Number","optional":true,"default":"0.5","description":"dominance ratio, values from 0 to 1. Determines how much of a sector a side must hold for bleeding tickets to start","type_expr":"Number","text":"dominanceRatio: Number - (Optional, default 0.5) dominance ratio, values from 0 to 1. Determines how much of a sector a side must hold for bleeding tickets to start"},{"name":"bleedingAmount","type":"Number","optional":true,"default":"3","description":"amount of tickets bled every step. Optional parameter","type_expr":"Number","text":"bleedingAmount: Number - (Optional, default 3) amount of tickets bled every step. Optional parameter"},{"name":"bleedingDelay","type":"Object","optional":true,"default":"5","description":"delay in seconds between every bleeding step","type_expr":"Object","text":"bleedingDelay: Object - (Optional, default 5) delay in seconds between every bleeding step"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["call BIS_fnc_bleedTickets;"]},{"code":["[[west, east], 1, 1, 10] call BIS_fnc_bleedTickets;"]}],"multiplayer":"Server-side execution only.","see_also":["BIS_fnc_addScriptedEventHandler","BIS_fnc_respawnTickets"],"notes":[{"user":"Tryteyker-","date":"2014-09-29T19:58:00Z","text":"The function calls on the scripted eventhandler (see BIS_fnc_addScriptedEventHandler) \"dominantSideChanged\" everytime a sector changes dominant side (this again depending on the value given to the function)."}]},{"name":"BIS_fnc_blinkMarker","title":"BIS fnc blinkMarker","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_blinkMarker","revid":373736,"updated":"2025-06-24T12:24:58Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","locality":{"argument":"global","effect":"global"},"exec":"spawn","description":"Makes given marker blink.","syntaxes":[{"syntax":"[marker, blinkDuration, blinkAmount] spawn BIS_fnc_blinkMarker","params":[{"name":"marker","type":"String","description":"marker's name","type_expr":"String"},{"name":"blinkDuration","type":"Number","optional":true,"default":"1","description":"a blink's time","type_expr":"Number","text":"blinkDuration: Number - (Optional, default 1) a blink's time"},{"name":"blinkAmount","type":"Number","optional":true,"default":"2","description":"quantity of blinks","type_expr":"Number","text":"blinkAmount: Number - (Optional, default 2) quantity of blinks"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"BIS_marker\", 3, 10] spawn BIS_fnc_blinkMarker; // blinks 10 times using 3 seconds intervals"]},{"code":["[\"BIS_marker\"] spawn BIS_fnc_blinkMarker; // keeps blinking"]}],"see_also":["setMarkerAlpha"]},{"name":"BIS_fnc_bloodEffect","title":"BIS fnc bloodEffect","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_bloodEffect","revid":348502,"updated":"2023-11-08T13:01:32Z","groups":["Feedback"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Adds the bleeding effect post-processing effect to the players screen.","syntaxes":[{"syntax":"[10] call BIS_fnc_bloodEffect","params":[{"name":"Number","description":"duration in (milli?)seconds in which effect should be visible.","type_expr":"Number"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[10] call BIS_fnc_bloodEffect; // Adds the blood effect for 10 (milli)seconds."]}],"see_also":["BIS_fnc_indicateBleeding"]},{"name":"BIS_fnc_boatRack01ActionAdd","title":"BIS fnc boatRack01ActionAdd","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_boatRack01ActionAdd","revid":379545,"updated":"2026-10-31T13:42:01Z","groups":["Boat Recovery"],"status":"ok","games":{"arma3":"1.84"},"since":"arma3 1.84","arma3_since":"1.84","description":"Part of the boat recovery system: adds the \"Recover Boat\" hold action (see BIS_fnc_holdActionAdd) to the boat that the player is driving near a boat rack.\nThe function is the on-activation statement of the trigger that BIS_fnc_boatRack01Init creates around the boat rack; it is meant for internal use.\n\nThe function:\n\n- gets the boat rack from the trigger's `\"BIS_linkedBoatRack\"` variable and, if a list of objects is given, takes the boat from it: the first object of kind `\"Ship\"` that is cameraOn\n- stores the boat on the trigger in the variable `\"bis_loadedVehicle\"`\n- adds a 5 seconds hold action with priority 1000 to the boat; whether it is shown and can progress is decided once, when it is added, by BIS_fnc_boatRack01CanExetuteAction and BIS_fnc_boatRack01CanProgressAction\n- while the action is held, the boat is slowed down and then held in place\n- when it is completed, the boat is loaded onto the empty rack with setVehicleCargo and BIS_fnc_boatRack01AdjustZOffset is called; the action is then removed\n- appends `[boat, trigger, actionID]` to the boat's `\"bis_attachedActionID\"` variable, which BIS_fnc_boatRack01ActionRemove uses (a boat can have actions from several racks)","syntaxes":[{"syntax":"[trigger, boat] call BIS_fnc_boatRack01ActionAdd","params":[{"name":"trigger","type":"Object","description":"the boat rack's trigger","type_expr":"Object"},{"name":"boat","type":"Array or Object","optional":true,"default":"objNull","description":"the boat, or the trigger's list of objects (`thisList`) to find the boat in","type_expr":"Array | Object","text":"boat: Array or Object - (Optional, default objNull) the boat, or the trigger's list of objects (`thisList`) to find the boat in"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"Trigger statements set by BIS_fnc_boatRack01Init:\n\n```sqf\n_triggerLoad setTriggerStatements\n[\n    format [\"%1 call BIS_fnc_boatRack01ActionCondition\", [_triggerAreaSizeX, _triggerAreaSizeY, _triggerAreaSizeZ, _boatRecoveryPointList]],\n    \"[thisTrigger,thisList] call bis_fnc_boatRack01ActionAdd;\",\n    \"[thisTrigger] call bis_fnc_boatRack01ActionRemove;\"\n];\n```","code":["_triggerLoad setTriggerStatements\n[\n\tformat [\"%1 call BIS_fnc_boatRack01ActionCondition\", [_triggerAreaSizeX, _triggerAreaSizeY, _triggerAreaSizeZ, _boatRecoveryPointList]],\n\t\"[thisTrigger,thisList] call bis_fnc_boatRack01ActionAdd;\",\n\t\"[thisTrigger] call bis_fnc_boatRack01ActionRemove;\"\n];"]}],"see_also":["BIS_fnc_boatRack01Init","BIS_fnc_boatRack01ActionRemove","BIS_fnc_boatRack01AdjustZOffset","BIS_fnc_holdActionAdd"]},{"name":"BIS_fnc_BoatRack01ActionCondition","title":"BIS fnc BoatRack01ActionCondition","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_BoatRack01ActionCondition","revid":261288,"updated":"2021-06-09T19:00:39Z","groups":["Boat Recovery"],"status":"ok","games":{"arma3":"1.84"},"since":"arma3 1.84","arma3_since":"1.84","description":"","syntaxes":[{"syntax":"BIS_fnc_BoatRack01ActionCondition","params":[],"returns":null}],"categories_extra":["Stubs"]},{"name":"BIS_fnc_boatRack01ActionRemove","title":"BIS fnc boatRack01ActionRemove","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_boatRack01ActionRemove","revid":379546,"updated":"2026-10-31T13:42:37Z","groups":["Boat Recovery"],"status":"ok","games":{"arma3":"1.84"},"since":"arma3 1.84","arma3_since":"1.84","description":"Part of the boat recovery system: removes the \"Recover Boat\" hold action that BIS_fnc_boatRack01ActionAdd added for the given boat rack trigger.\nIt takes the boat stored on the trigger in the variable `\"bis_loadedVehicle\"`, looks in the boat's `\"bis_attachedActionID\"` list for the entry of this boat and trigger, removes that action with BIS_fnc_holdActionRemove and deletes the entry from the list.\nThe function is the on-deactivation statement of the trigger that BIS_fnc_boatRack01Init creates around the boat rack; it is meant for internal use.","syntaxes":[{"syntax":"[trigger] call BIS_fnc_boatRack01ActionRemove","params":[{"name":"trigger","type":"Object","description":"the boat rack's trigger","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"On-deactivation statement of the boat rack's trigger:\n\n```sqf\n[thisTrigger] call BIS_fnc_boatRack01ActionRemove;\n```","code":["[thisTrigger] call BIS_fnc_boatRack01ActionRemove;"]}],"see_also":["BIS_fnc_boatRack01Init","BIS_fnc_boatRack01ActionAdd","BIS_fnc_holdActionRemove"]},{"name":"BIS_fnc_boatRack01AdjustZOffset","title":"BIS fnc boatRack01AdjustZOffset","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_boatRack01AdjustZOffset","revid":379547,"updated":"2026-10-31T13:43:34Z","groups":["Boat Recovery"],"status":"ok","games":{"arma3":"1.84"},"since":"arma3 1.84","arma3_since":"1.84","description":"Part of the boat recovery system: raises or lowers the boat rack's cargo bay to suit the loaded boat, so that different boats do not clip into the rack.\nIt reads two entries of the rack's `CfgVehicles >> class >> BoatRecoverySystem` config class:\n\n- `cargoBayAnimationSelection` - name of the animation that moves the cargo bay, e.g. `\"CargoBay_Move_Z\"`\n- `supportedVehicleOffsetsZ[]` - list of `{ \"boatClass\", offset }` pairs, e.g. `{ { \"C_Boat_Civil_01_F\", 0.55 } }`\n\nIt then instantly animates the cargo bay to the offset of the boat's exact class (typeOf, inheritance is not checked), or to 0 if the class is not listed.\n\nThe function is called when the \"Recover Boat\" hold action of BIS_fnc_boatRack01ActionAdd has loaded a boat, and by BIS_fnc_boatRack01InitAdjustZOffsets for a boat loaded at mission start. It does nothing if either object is objNull.","syntaxes":[{"syntax":"[boatRack, boat] call BIS_fnc_boatRack01AdjustZOffset","params":[{"name":"boatRack","type":"Object","description":"the boat rack","type_expr":"Object"},{"name":"boat","type":"Object","description":"the boat loaded on the rack","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"Load a boat onto a rack by script and adjust the rack to it, as the hold action does:\n\n```sqf\nif (myBoatRack setVehicleCargo myBoat) then\n{\n    [myBoatRack, myBoat] call BIS_fnc_boatRack01AdjustZOffset;\n};\n```","code":["if (myBoatRack setVehicleCargo myBoat) then\n{\n\t[myBoatRack, myBoat] call BIS_fnc_boatRack01AdjustZOffset;\n};"]}],"see_also":["BIS_fnc_boatRack01Init","BIS_fnc_boatRack01InitAdjustZOffsets","BIS_fnc_boatRack01ActionAdd","setVehicleCargo"]},{"name":"BIS_fnc_boatRack01CanExetuteAction","title":"BIS fnc boatRack01CanExetuteAction","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_boatRack01CanExetuteAction","revid":286073,"updated":"2021-06-20T17:25:17Z","groups":["Boat Recovery"],"status":"ok","games":{"arma3":"1.84"},"since":"arma3 1.84","arma3_since":"1.84","description":"- This is sub function for 'boat recovery' functionality.","syntaxes":[{"syntax":"[] call BIS_fnc_boatRack01CanExetuteAction","params":[{"name":"mode","type":"Number","type_expr":"Number","description":"(Scalar)","text":"0: (Scalar)","source":"docblock"},{"name":"param0","type":"Object","type_expr":"Object","text":"0: Object (boat)","source":"docblock"},{"name":"param1","type":"Object","type_expr":"Object","text":"1: Object (boat rack)","source":"docblock"}],"returns":{"type":"Display","types":["Display"],"type_expr":"Boolean","text":"true if all conditions are met to display the \"Hold Action\"\nCheck to show \"Hold Action\" to player.","source":"docblock"}}],"examples":[{"code":["[_target,_boatRack] call BIS_fnc_boatRack01CanExetuteAction;"]}],"docblock":{"text":"Author: Bravo Zero One development\n- John_Spartan\n\nDescription:\n- This is sub function for 'boat recovery' functionality.\n\nExecution:\n- Call from script that invokes the \"Hold Action\" for boat recovery.\n\nExample:\n    [_target,_boatRack] call BIS_fnc_boatRack01CanExetuteAction;\n\nRequired:\n    Object (boat)\n    Object (boat rack) must have vehicle in vehicle behavior configured (https://community.bistudio.com/wiki/Arma_3_Vehicle_in_Vehicle_Transport).\n\nParameter(s):\n    _this select 0: mode (Scalar)\n    0: Object (boat)\n    1: Object (boat rack)\n\nReturns: true if all conditions are met to display the \"Hold Action\"\nResult: Check to show \"Hold Action\" to player.","author":"Bravo Zero One development, John_Spartan"},"filled_from_docblock":["description","params","returns","examples"]},{"name":"BIS_fnc_boatRack01CanProgressAction","title":"BIS fnc boatRack01CanProgressAction","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_boatRack01CanProgressAction","revid":286022,"updated":"2021-06-20T17:24:25Z","groups":["Boat Recovery"],"status":"ok","games":{"arma3":"1.84"},"since":"arma3 1.84","arma3_since":"1.84","description":"- This is sub function for 'boat recovery' functionality.","syntaxes":[{"syntax":"[] call BIS_fnc_boatRack01CanProgressAction","params":[{"name":"mode","type":"Number","type_expr":"Number","description":"(Scalar)","text":"0: (Scalar)","source":"docblock"},{"name":"param0","type":"Object","type_expr":"Object","text":"0: Object (boat)","source":"docblock"},{"name":"param1","type":"Object","type_expr":"Object","text":"1: Object (boat rack)","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","text":"true if all conditions are met during the process of \"Hold Action\", can continue with action\nCheck to allow continue with \"Hold Action\".","source":"docblock"}}],"examples":[{"code":["[_target,_boatRack] call BIS_fnc_boatRack01CanProgressAction;"]}],"docblock":{"text":"Author: Bravo Zero One development\n- John_Spartan\n\nDescription:\n- This is sub function for 'boat recovery' functionality.\n\nExecution:\n- Call from script that invokes the \"Hold Action\" for boat recovery.\n\nExample:\n    [_target,_boatRack] call BIS_fnc_boatRack01CanProgressAction;\n\nRequired:\n    Object (boat)\n    Object (boat rack) must have vehicle in vehicle behavior configured (https://community.bistudio.com/wiki/Arma_3_Vehicle_in_Vehicle_Transport).\n\nParameter(s):\n    _this select 0: mode (Scalar)\n    0: Object (boat)\n    1: Object (boat rack)\n\nReturns: true if all conditions are met during the process of \"Hold Action\", can continue with action\nResult: Check to allow continue with \"Hold Action\".","author":"Bravo Zero One development, John_Spartan"},"filled_from_docblock":["description","params","returns","examples"]},{"name":"BIS_fnc_boatRack01Init","title":"BIS fnc boatRack01Init","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_boatRack01Init","revid":379548,"updated":"2026-10-31T13:44:08Z","groups":["Boat Recovery"],"status":"ok","games":{"arma3":"1.84"},"since":"arma3 1.84","arma3_since":"1.84","description":"Main function of the boat recovery system, which lets a player drive a boat onto a boat rack and load it with a hold action. The boat rack must support Vehicle in Vehicle transport.\nThe function is called by the `init` event handler of the boat rack's class. It does nothing in the Eden Editor or when the boat rack is objNull.\n\nIt reads these entries of the rack's `CfgVehicles >> class >> BoatRecoverySystem` config class:\n\n- `triggerAreaSizeX`, `triggerAreaSizeY`, `triggerAreaSizeZ` - size of the area around each recovery point in which the boat must be\n- every subclass is a recovery point; its `memoryPointPosLoad` is the name of the rack's memory point at the centre of that area\n\nIt then creates a local, repeatedly activated trigger (`\"ANYPLAYER\"`, `\"PRESENT\"`) around the rack, large enough to cover all recovery areas, and stores the rack on it in the variable `\"BIS_linkedBoatRack\"`. The trigger uses:\n\n- `BIS_fnc_boatRack01ActionCondition` as condition: the player drives a boat under 25 km/h inside a recovery area, the rack is empty and can carry the boat\n- BIS_fnc_boatRack01ActionAdd on activation, which gives the boat the \"Recover Boat\" hold action\n- BIS_fnc_boatRack01ActionRemove on deactivation\n\nFinally it spawns BIS_fnc_boatRack01InitAdjustZOffsets to adjust the rack to a boat that is already loaded at mission start.","syntaxes":[{"syntax":"[boatRack] call BIS_fnc_boatRack01Init","params":[{"name":"boatRack","type":"Object","description":"the boat rack (the init event handler passes it as `_this`)","type_expr":"Object"}],"returns":{"type":"Script Handle","type_expr":"Script Handle","description":"handle of the spawned BIS_fnc_boatRack01InitAdjustZOffsets; Nothing in the Eden Editor or if the boat rack is objNull"}}],"examples":[{"text":"Event handler of the boat rack's class:\n\n```cpp\nclass EventHandlers\n{\n    init = \"_this call BIS_fnc_BoatRack01Init;\";\n};\n```"}],"see_also":["BIS_fnc_boatRack01ActionAdd","BIS_fnc_boatRack01ActionRemove","BIS_fnc_boatRack01AdjustZOffset","BIS_fnc_boatRack01InitAdjustZOffsets","Arma 3: Vehicle in Vehicle Transport"]},{"name":"BIS_fnc_boatRack01InitAdjustZOffsets","title":"BIS fnc boatRack01InitAdjustZOffsets","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_boatRack01InitAdjustZOffsets","revid":379549,"updated":"2026-10-31T13:44:53Z","groups":["Boat Recovery"],"status":"ok","games":{"arma3":"1.84"},"since":"arma3 1.84","arma3_since":"1.84","exec":"spawn","description":"Part of the boat recovery system: adjusts the boat rack's cargo bay to a boat that is already loaded on it at mission start.\nIt waits until the rack's simulation is enabled, then, if the rack carries a boat (getVehicleCargo), calls BIS_fnc_boatRack01AdjustZOffset with the first one.\nThe function is spawned by BIS_fnc_boatRack01Init; it is meant for internal use. It does nothing in the Eden Editor or when the boat rack is objNull.","syntaxes":[{"syntax":"[boatRack] spawn BIS_fnc_boatRack01InitAdjustZOffsets","params":[{"name":"boatRack","type":"Object","description":"the boat rack","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[myBoatRack] spawn BIS_fnc_boatRack01InitAdjustZOffsets;"]}],"see_also":["BIS_fnc_boatRack01Init","BIS_fnc_boatRack01AdjustZOffset","getVehicleCargo"]},{"name":"BIS_fnc_bounceIn","title":"BIS fnc bounceIn","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_bounceIn","revid":273891,"updated":"2021-06-13T01:12:59Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_bounceIn","params":[],"returns":null}]},{"name":"BIS_fnc_bounceInOut","title":"BIS fnc bounceInOut","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_bounceInOut","revid":273883,"updated":"2021-06-13T01:12:50Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_bounceInOut","params":[],"returns":null}]},{"name":"BIS_fnc_bounceInOutVector","title":"BIS fnc bounceInOutVector","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_bounceInOutVector","revid":274000,"updated":"2021-06-13T01:14:56Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_bounceInOutVector","params":[],"returns":null}]},{"name":"BIS_fnc_bounceInVector","title":"BIS fnc bounceInVector","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_bounceInVector","revid":273942,"updated":"2021-06-13T01:13:50Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_bounceInVector","params":[],"returns":null}]},{"name":"BIS_fnc_bounceOut","title":"BIS fnc bounceOut","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_bounceOut","revid":274011,"updated":"2021-06-13T01:15:07Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_bounceOut","params":[],"returns":null}]},{"name":"BIS_fnc_bounceOutVector","title":"BIS fnc bounceOutVector","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_bounceOutVector","revid":274073,"updated":"2021-06-13T01:16:13Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_bounceOutVector","params":[],"returns":null}]},{"name":"BIS_fnc_boundingBoxCorner","title":"BIS fnc boundingBoxCorner","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_boundingBoxCorner","revid":292391,"updated":"2021-08-07T23:55:04Z","groups":["Object Manipulation"],"status":"ok","games":{"arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2oa 1.50","arma3_since":"0.50","description":"Returns position of all four bounding box corners OR Returns position of the nearest corner to the given position","syntaxes":[{"syntax":"[param0, param1] call BIS_fnc_boundingBoxCorner","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"object with bounding box","text":"0: OBJECT - object with bounding box","source":"docblock"},{"name":"param1","type":"Array, Object","type_expr":"Array | Object","description":"position for which the nearest corner is returned","text":"1: ARRAY or OBJECT - position for which the nearest corner is returned","source":"docblock"}],"returns":{"type":"Array","type_expr":"Array","description":"4 corners of the bounding box\n    OR\n    ARRAY in format [x,y,z] - position of the nearest corner\n\nExample 1:\n    _corners = car call BIS_fnc_boundingBoxCorner;\n\nExample 2:\n    _nearestCorner = [car, player] call BIS_fnc_boundingBoxCorner;","text":"ARRAY in format [pos1, pos2, pos3, pos4] - 4 corners of the bounding box\n    OR\n    ARRAY in format [x,y,z] - position of the nearest corner\n\nExample 1:\n    _corners = car call BIS_fnc_boundingBoxCorner;\n\nExample 2:\n    _nearestCorner = [car, player] call BIS_fnc_boundingBoxCorner;","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\n    Returns position of all four bounding box corners\n    OR\n    Returns position of the nearest corner to the given position\n\nParameter(s):\n    _this: OBJECT - object with bounding box\n    OR\n    _this: ARRAY in format:\n        0: OBJECT - object with bounding box\n        1: ARRAY or OBJECT - position for which the nearest corner is returned\nReturns:\n    ARRAY in format [pos1, pos2, pos3, pos4] - 4 corners of the bounding box\n    OR\n    ARRAY in format [x,y,z] - position of the nearest corner\n\nExample 1:\n    _corners = car call BIS_fnc_boundingBoxCorner;\n\nExample 2:\n    _nearestCorner = [car, player] call BIS_fnc_boundingBoxCorner;"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_boundingBoxDimensions","title":"BIS fnc boundingBoxDimensions","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_boundingBoxDimensions","revid":348566,"updated":"2023-11-08T13:42:07Z","groups":["Object Manipulation"],"status":"ok","games":{"arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2oa 1.50","arma3_since":"0.50","description":"Returns the sizes of the three dimensions of an object's bounding box.","syntaxes":[{"syntax":"object call BIS_fnc_boundingBoxDimensions","params":[{"name":"object","type":"Object","description":"object which bounding box should be returned.","type_expr":"Object"}],"returns":{"type":"Array","type_expr":"Array","description":"bounding box dimensions in [X, Y, Z]"}}],"examples":[{"code":["player call BIS_fnc_boundingBoxDimensions;//Returns [1.6,2.2,2] for soldier"]}],"see_also":["boundingBox","boundingCenter","boundingBoxReal","BIS_fnc_boundingBoxCorner","BIS_fnc_boundingBoxMarker"]},{"name":"BIS_fnc_boundingBoxMarker","title":"BIS fnc boundingBoxMarker","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_boundingBoxMarker","revid":348837,"updated":"2023-11-08T14:39:09Z","groups":["Object Manipulation"],"status":"ok","games":{"arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2oa 1.50","arma3_since":"0.50","description":"Creates marker on object with size of objects' bounding box.","syntaxes":[{"syntax":"object call BIS_fnc_boundingBoxMarker","params":[{"name":"object","type":"Object","type_expr":"Object"}],"returns":{"type":"String","type_expr":"String","description":"marker"}}],"examples":[{"code":["BIS_Vehicle call BIS_fnc_boundingBoxMarker;"]}],"see_also":["boundingBox","sizeOf","boundingBoxReal","boundingCenter"]},{"name":"BIS_fnc_boundingCircle","title":"BIS fnc boundingCircle","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_boundingCircle","revid":327119,"updated":"2022-07-12T21:44:51Z","groups":["Object Manipulation"],"status":"ok","games":{"arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2oa 1.50","arma3_since":"0.50","description":"Returns size of bounding circle (calculated from X and Y coordinates). This is actually the 2D horizontal diagonal length of the boundingBox.","syntaxes":[{"syntax":"object call BIS_fnc_boundingCircle","params":[{"name":"object","type":"Object","type_expr":"Object"}],"returns":{"type":"Number","type_expr":"Number"}}],"examples":[{"code":["vehicle player call BIS_fnc_boundingCircle;"]}],"see_also":["boundingBox","boundingBoxReal"]},{"name":"BIS_fnc_briefingAnimate","title":"BIS fnc briefingAnimate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_briefingAnimate","revid":327693,"updated":"2022-07-13T10:03:03Z","groups":["Briefing"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Animate briefing markers.","syntaxes":[{"syntax":"[markerName, stepId, delay] call BIS_fnc_briefingAnimate","params":[{"name":"markerName","type":"String","description":"marker to animate","type_expr":"String"},{"name":"stepId","type":"Number","description":"step ID (steps are invisible markers named `<markerName>_<stepId>`)","type_expr":"Number"},{"name":"delay","type":"String","description":"commit time (transition duration)","type_expr":"String"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"```sqf\n// given you have 6 markers:\n// - \"myMarker\"\n// - \"myMarker_0\"\n// - \"myMarker_1\"\n// - \"myMarker_2\"\n// - \"myMarker_3\"\n// - \"myMarker_4\"\nfor \"_i\" from 0 to 4 do {\n    private _commit = 1;\n    [\"myMarker\", 5, _commit] call BIS_fnc_briefingAnimate;\n    sleep _commit;\n};\n```","code":["// given you have 6 markers:\n// - \"myMarker\"\n// - \"myMarker_0\"\n// - \"myMarker_1\"\n// - \"myMarker_2\"\n// - \"myMarker_3\"\n// - \"myMarker_4\"\nfor \"_i\" from 0 to 4 do {\n\tprivate _commit = 1;\n\t[\"myMarker\", 5, _commit] call BIS_fnc_briefingAnimate;\n\tsleep _commit;\n};"]}],"see_also":["BIS_fnc_briefingInit"]},{"name":"BIS_fnc_briefingInit","title":"BIS fnc briefingInit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_briefingInit","revid":348860,"updated":"2023-11-08T14:39:13Z","groups":["Briefing"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Initialize animated briefing markers.","syntaxes":[{"syntax":"marker call BIS_fnc_briefingInit","params":[{"name":"marker","type":"String","description":"marker to initialise","type_expr":"String"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"\"marker_1\" call BIS_fnc_briefingInit;"}],"see_also":["BIS_fnc_briefingAnimate"]},{"name":"BIS_fnc_buildingPositions","title":"BIS fnc buildingPositions","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_buildingPositions","revid":309416,"updated":"2022-05-05T12:04:36Z","groups":["Positions"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Get all available positions within a building or structure.","syntaxes":[{"syntax":"param call BIS_fnc_buildingPositions","params":[{"name":"param","type":"Object","type_expr":"Object"},{"name":"param","type":"Number","type_expr":"Number"}],"returns":{"type":"Array","type_expr":"Array"}}],"examples":[{"code":["[_building] call BIS_fnc_buildingPositions;"]},{"code":["[_building, _maxNumberOfPositions] call BIS_fnc_buildingPositions;"]}],"see_also":["buildingPos","buildingExit"]},{"name":"BIS_fnc_calculateDateTime","title":"BIS fnc calculateDateTime","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_calculateDateTime","revid":327310,"updated":"2022-07-12T22:11:53Z","groups":["Environment"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Returns the end datetime if an offset is passed, or the offset between start and end dates.","syntaxes":[{"syntax":"[startDate, endDateOrOffset, timeUnit] call BIS_fnc_calculateDateTime","params":[{"name":"startDate","type":"Array in Date format","optional":true,"default":"date","type_expr":"Date","types":["Array","Date"],"text":"startDate: Array in Date format - (Optional, default date)"},{"name":"endDateOrOffset","type":"Array in Date format or Number","optional":true,"default":"date","description":"either the end date of the period to calculate, or time in seconds from *startDate*","type_expr":"Date | Number","types":["Array","Date","Number"],"text":"endDateOrOffset: Array in Date format or Number - (Optional, default date) either the end date of the period to calculate, or time in seconds from *startDate*"},{"name":"timeUnit","type":"String","optional":true,"default":"\"s\"","description":"one of:\n\n- \"s\" - seconds\n- \"m\" - minutes\n- \"h\" - hours\n- \"d\" - days","type_expr":"String","text":"timeUnit: String - (Optional, default \"s\") one of:\n\n- \"s\" - seconds\n- \"m\" - minutes\n- \"h\" - hours\n- \"d\" - days"}],"returns":{"type":"Date or Number","type_expr":"Date | Number","description":"- Date if endDateOrOffset is a Number - Number is endDateOrOffset is a Date","text":"Date or Number\n\n- Date if *endDateOrOffset* is a Number\n- Number is *endDateOrOffset* is a Date"}}],"examples":[{"text":"```sqf\n[date, 3600] call BIS_fnc_calculateDateTime;                                // returns date in 3600 seconds (60min, 1h)\n[date, 60, \"m\"] call BIS_fnc_calculateDateTime;                                // returns date in 60 minutes (1h)\n[[2035,8,28,11,55], [2035,8,29,11,55], \"h\"] call BIS_fnc_calculateDateTime;    // returns 24\n```","code":["[date, 3600] call BIS_fnc_calculateDateTime;\t\t\t\t\t\t\t\t// returns date in 3600 seconds (60min, 1h)\n[date, 60, \"m\"] call BIS_fnc_calculateDateTime;\t\t\t\t\t\t\t\t// returns date in 60 minutes (1h)\n[[2035,8,28,11,55], [2035,8,29,11,55], \"h\"] call BIS_fnc_calculateDateTime;\t// returns 24"]}],"see_also":["date","setDate","BIS_fnc_setDate"]},{"name":"BIS_fnc_call","title":"BIS fnc call","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_call","revid":327597,"updated":"2022-07-13T09:49:02Z","groups":["Program Flow"],"status":"ok","games":{"arma3":"0.50"},"since":"arma3 0.50","arma3_since":"0.50","description":"Execute given code with or without parameter.\n\n> [!NOTE]\n> **Arma 3:** Since Arma 3 v1.50, use remoteExec/remoteExecCall instead.","syntaxes":[{"syntax":"[params, code] call BIS_fnc_call","params":[{"name":"params","type":"Anything","description":"function arguments","type_expr":"Anything"},{"name":"code","type":"Code","description":"function code","type_expr":"Code"}],"returns":{"type":"Anything","type_expr":"Anything"}},{"syntax":"code call BIS_fnc_call","params":[{"name":"code","type":"Code","type_expr":"Code"}],"returns":{"type":"Anything","type_expr":"Anything"}}],"examples":[{"text":"Show a message for the current player.\n\n```sqf\n[[\"Hello\"], {hint (_this select 0);}] call BIS_fnc_call;\n```","code":["[[\"Hello\"], {hint (_this select 0);}] call BIS_fnc_call;"]},{"text":"Alternative syntax\n\n```sqf\n{ hint \"Hello\"; } call BIS_fnc_call;\n```","code":["{ hint \"Hello\"; } call BIS_fnc_call;"]}],"see_also":["remoteExec","remoteExecCall","BIS_fnc_spawn","BIS_fnc_execVM","BIS_fnc_execFSM","BIS_fnc_execRemote"],"notes":[{"user":"Strangepete","date":"2014-11-30T02:22:00Z","text":"As of writing (ver. 1.37) BIS_fnc_call is only a wrapper for BIS_fnc_spawn. Both functions use call to execute the code."}]},{"name":"BIS_fnc_callScriptedEventHandler","title":"BIS fnc callScriptedEventHandler","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_callScriptedEventHandler","revid":327926,"updated":"2022-07-13T12:24:31Z","groups":["Event Handlers"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Calls all the codes assigned to scripted event handler with given name. Since Arma 3 v1.68 the code receives current EH id in the special variable: `_thisScriptedEventHandler`","syntaxes":[{"syntax":"[namespace, name, arguments, returnResults] call BIS_fnc_callScriptedEventHandler","params":[{"name":"namespace","type":"Namespace, Object, Group, Location, Boolean, Control or Display","description":"namespace in which handler is saved","type_expr":"Namespace | Object | Group | Location | Boolean | Control | Display"},{"name":"name","type":"String","description":"handler name","type_expr":"String"},{"name":"arguments","type":"Array","description":"array of arguments passed to the EH code","type_expr":"Array"},{"name":"returnResults","type":"Boolean","optional":true,"default":"false","description":"if true EH will place results from each code execution into an array using EH id as index","type_expr":"Boolean","text":"returnResults: Boolean - (Optional, default false) if true EH will place results from each code execution into an array using EH id as index"}],"returns":{"type":"Array","type_expr":"Array","description":"array with EH results or empty array"}}],"examples":[{"code":["[missionNamespace, \"event\", [player, 123]] call BIS_fnc_callScriptedEventHandler;"]}],"see_also":["BIS_fnc_addScriptedEventHandler","BIS_fnc_removeScriptedEventHandler","BIS_fnc_removeAllScriptedEventHandlers"]},{"name":"BIS_fnc_camera","title":"BIS fnc camera","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_camera","revid":379312,"updated":"2026-10-30T23:49:46Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Splendid™ Camera, *\"Ultimate Screenshot Simulator\"*","syntaxes":[{"syntax":"[mode, parameter] call BIS_fnc_camera","params":[{"name":"mode","type":"String","optional":true,"default":"\"Init\"","description":"**case-sensitive**, for internal use. Can be one of:\n\n- \"Init\"\n- \"Mouse\"\n- \"MouseButtonDown\"\n- \"MouseButtonUp\"\n- \"MouseZChanged\"\n- \"KeyDown\"\n- \"KeyUp\"\n- \"Draw3D\"\n- \"MapDraw\"\n- \"MapClick\"\n- \"SliderFocus\"\n- \"SliderAperture\"\n- \"SliderDaytime\"\n- \"SliderOvercast\"\n- \"SliderAcctime\"\n- \"SliderColor\"\n- \"SliderContrast\"\n- \"SliderSaturation\"\n- \"Paste\"\n- \"InitDummy\"\n- \"ExitDummy\"\n- \"Exit\"","type_expr":"String","text":"mode: String - (Optional, default \"Init\") **case-sensitive**, for internal use. Can be one of:\n\n- \"Init\"\n- \"Mouse\"\n- \"MouseButtonDown\"\n- \"MouseButtonUp\"\n- \"MouseZChanged\"\n- \"KeyDown\"\n- \"KeyUp\"\n- \"Draw3D\"\n- \"MapDraw\"\n- \"MapClick\"\n- \"SliderFocus\"\n- \"SliderAperture\"\n- \"SliderDaytime\"\n- \"SliderOvercast\"\n- \"SliderAcctime\"\n- \"SliderColor\"\n- \"SliderContrast\"\n- \"SliderSaturation\"\n- \"Paste\"\n- \"InitDummy\"\n- \"ExitDummy\"\n- \"Exit\""},{"name":"parameter","type":"Anything","optional":true,"default":"`[]`","type_expr":"Anything","text":"parameter: Anything - (Optional, default `[]`)"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[] call BIS_fnc_camera;"]},{"code":["[] spawn BIS_fnc_camera;"]},{"code":["[\"Init\"] call BIS_fnc_camera;"]}],"see_also":["Camera.sqs","Arma 3: Splendid Camera","BIS_fnc_cameraOld"],"notes":[{"user":"Benargee","date":"2014-10-10T00:15:00Z","text":"(Arma 3 1.30) Calling from pause menu debug console without arguments will crash the game. Tested in singleplayer editor preview."}]},{"name":"BIS_fnc_camera_deleted","title":"BIS fnc camera deleted","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_camera_deleted","revid":349243,"updated":"2023-11-08T14:50:59Z","groups":["Camera"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Deletes given camera.","syntaxes":[{"syntax":"[camera] call BIS_fnc_camera_deleted","params":[{"name":"camera","type":"Object","description":"the camera","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[BIS_camera] call BIS_fnc_camera_deleted;"]}],"see_also":["BIS_fnc_camera_setCam"]},{"name":"BIS_fnc_camera_edenAttributesChanged","title":"BIS fnc camera edenAttributesChanged","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_camera_edenAttributesChanged","revid":273968,"updated":"2021-06-13T01:14:17Z","groups":["Camera3DEN"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"Attributes change in EDEN for a camera","syntaxes":[{"syntax":"[] call BIS_fnc_camera_edenAttributesChanged","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The camera","text":"0: Object    - The camera","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nAttributes change in EDEN for a camera\n\nParameter(s):\n_this select 0: Object    - The camera\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_camera_edenConnectionChanged","title":"BIS fnc camera edenConnectionChanged","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_camera_edenConnectionChanged","revid":273947,"updated":"2021-06-13T01:13:58Z","groups":["Camera3DEN"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"3DEN connections of a camera are changed","syntaxes":[{"syntax":"[] call BIS_fnc_camera_edenConnectionChanged","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The camera","text":"0: Object    - The camera","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\n3DEN connections of a camera are changed\n\nParameter(s):\n_this select 0: Object    - The camera\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_camera_edenDeleted","title":"BIS fnc camera edenDeleted","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_camera_edenDeleted","revid":274124,"updated":"2021-06-13T01:16:59Z","groups":["Camera3DEN"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"Camera is deleted","syntaxes":[{"syntax":"[] call BIS_fnc_camera_edenDeleted","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The destroyed camera","text":"0: Object - The destroyed camera","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nCamera is deleted\n\nParameter(s):\n_this select 0: Object - The destroyed camera\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_camera_edenInit","title":"BIS fnc camera edenInit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_camera_edenInit","revid":273969,"updated":"2021-06-13T01:14:18Z","groups":["Camera3DEN"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"Camera is initialized in 3den","syntaxes":[{"syntax":"[] call BIS_fnc_camera_edenInit","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The camera","text":"0: Object    - The camera","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nCamera is initialized in 3den\n\nParameter(s):\n_this select 0: Object    - The camera\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_camera_edenIsSelected","title":"BIS fnc camera edenIsSelected","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_camera_edenIsSelected","revid":274116,"updated":"2021-06-13T01:16:54Z","groups":["Camera3DEN"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"Whether this camera is selected in 3den","syntaxes":[{"syntax":"[] call BIS_fnc_camera_edenIsSelected","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The camera","text":"0: Object    - The camera","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"True if selected, false if not","text":"Bool - True if selected, false if not","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nWhether this camera is selected in 3den\n\nParameter(s):\n_this select 0: Object    - The camera\n\nReturns:\nBool - True if selected, false if not","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_camera_edenRegisteredToWorld","title":"BIS fnc camera edenRegisteredToWorld","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_camera_edenRegisteredToWorld","revid":273941,"updated":"2021-06-13T01:13:48Z","groups":["Camera3DEN"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_camera_edenRegisteredToWorld","params":[],"returns":null}]},{"name":"BIS_fnc_camera_edenReset","title":"BIS fnc camera edenReset","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_camera_edenReset","revid":273911,"updated":"2021-06-13T01:13:13Z","groups":["Camera3DEN"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"Resets camera in 3DEN","syntaxes":[{"syntax":"[] call BIS_fnc_camera_edenReset","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The camera","text":"0: Object    - The camera","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nResets camera in 3DEN\n\nParameter(s):\n_this select 0: Object    - The camera\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_camera_edenSelectionChanged","title":"BIS fnc camera edenSelectionChanged","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_camera_edenSelectionChanged","revid":274024,"updated":"2021-06-13T01:15:19Z","groups":["Camera3DEN"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"The selection state of given camera changes","syntaxes":[{"syntax":"[] call BIS_fnc_camera_edenSelectionChanged","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The camera","text":"0: Object    - The camera","source":"docblock"},{"name":"param1","type":"Boolean","type_expr":"Boolean","description":"True if selected, false if not","text":"1: Bool    - True if selected, false if not","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nThe selection state of given camera changes\n\nParameter(s):\n_this select 0: Object    - The camera\n_this select 1: Bool    - True if selected, false if not\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_camera_edenUnregisteredFromWorld","title":"BIS fnc camera edenUnregisteredFromWorld","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_camera_edenUnregisteredFromWorld","revid":273880,"updated":"2021-06-13T01:12:48Z","groups":["Camera3DEN"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"Attributes change in EDEN for a camera","syntaxes":[{"syntax":"[] call BIS_fnc_camera_edenUnregisteredFromWorld","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The camera","text":"0: Object    - The camera","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nAttributes change in EDEN for a camera\n\nParameter(s):\n_this select 0: Object    - The camera\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_camera_getCam","title":"BIS fnc camera getCam","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_camera_getCam","revid":349206,"updated":"2023-11-08T14:50:44Z","groups":["Camera"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Gets camera instance of camerea object","syntaxes":[{"syntax":"[camera] call BIS_fnc_camera_getCam","params":[{"name":"camera","type":"Object","description":"the camera","type_expr":"Object"}],"returns":{"type":"Object","type_expr":"Object","description":"camera instance"}}],"examples":[{"code":["[BIS_camera] call BIS_fnc_camera_getCam;"]}],"see_also":["BIS_fnc_camera_setCam"]},{"name":"BIS_fnc_camera_getCinemaBordersEnabled","title":"BIS fnc camera getCinemaBordersEnabled","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_camera_getCinemaBordersEnabled","revid":349202,"updated":"2023-11-08T14:50:43Z","groups":["Camera"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Check if camera uses cinema borders.","syntaxes":[{"syntax":"[camera] call BIS_fnc_camera_getCinemaBordersEnabled","params":[{"name":"camera","type":"Object","description":"the camera","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"returns true if cinema borders are used"}}],"examples":[{"code":["[BIS_camera] call BIS_fnc_camera_getCinemaBordersEnabled;"]}],"see_also":["BIS_fnc_camera_setCinemaBordersEnabled"]},{"name":"BIS_fnc_camera_getFocus","title":"BIS fnc camera getFocus","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_camera_getFocus","revid":349239,"updated":"2023-11-08T14:50:57Z","groups":["Camera"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns camera focus.","syntaxes":[{"syntax":"[camera] call BIS_fnc_camera_getFocus","params":[{"name":"camera","type":"Object","description":"the camera","type_expr":"Object"}],"returns":{"type":"Array","type_expr":"Array","description":"array with focus values in format [distance, blur]"}}],"examples":[{"code":["[BIS_camera] call BIS_fnc_camera_getFocus;"]}],"see_also":["BIS_fnc_camera_setFocus"]},{"name":"BIS_fnc_camera_getFOV","title":"BIS fnc camera getFOV","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_camera_getFOV","revid":349254,"updated":"2023-11-08T14:51:03Z","groups":["Camera"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Gets FOV of camera.","syntaxes":[{"syntax":"[camera] call BIS_fnc_camera_getFOV","params":[{"name":"camera","type":"Object","description":"the camera","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[BIS_camera] call BIS_fnc_camera_getFOV;"]}],"see_also":["BIS_fnc_camera_setFOV"]},{"name":"BIS_fnc_camera_getHUDEnabled","title":"BIS fnc camera getHUDEnabled","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_camera_getHUDEnabled","revid":349232,"updated":"2023-11-08T14:50:53Z","groups":["Camera"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns wether camera HUD is enabled.","syntaxes":[{"syntax":"[camera] call BIS_fnc_camera_getHUDEnabled","params":[{"name":"camera","type":"Object","description":"the camera","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"returns true if HUD is enabled"}}],"examples":[{"code":["[BIS_camera] call BIS_fnc_camera_getHUDEnabled;"]}],"see_also":["BIS_fnc_camera_setHUDEnabled"]},{"name":"BIS_fnc_camera_getVisionMode","title":"BIS fnc camera getVisionMode","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_camera_getVisionMode","revid":378107,"updated":"2026-02-15T11:03:14Z","groups":["Camera"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns camera vision mode.","syntaxes":[{"syntax":"[camera] call BIS_fnc_camera_getVisionMode","params":[{"name":"camera","type":"Object","description":"the camera","type_expr":"Object"}],"returns":{"type":"Number","type_expr":"Number","description":"one of:\n- 0 - normal vision - 1 - night vision - 2 - thermal imaging","text":"Number - one of:\n\n- 0 - normal vision\n- 1 - night vision\n- 2 - thermal imaging"}}],"examples":[{"code":["[BIS_camera] call BIS_fnc_camera_getVisionMode;"]}],"see_also":["BIS_fnc_camera_setVisionMode"]},{"name":"BIS_fnc_camera_init","title":"BIS fnc camera init","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_camera_init","revid":349235,"updated":"2023-11-08T14:50:55Z","groups":["Camera"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Initialises a camera.","syntaxes":[{"syntax":"[camera] call BIS_fnc_camera_init","params":[{"name":"camera","type":"Object","description":"the camera","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[BIS_camera] call BIS_fnc_camera_init;"]}],"see_also":["BIS_fnc_camera_deleted"]},{"name":"BIS_fnc_camera_setCam","title":"BIS fnc camera setCam","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_camera_setCam","revid":349229,"updated":"2023-11-08T14:50:53Z","groups":["Camera"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Sets camera instance of camera object.","syntaxes":[{"syntax":"[camera, cameraInstance] call BIS_fnc_camera_setCam","params":[{"name":"camera","type":"Object","description":"the camera","type_expr":"Object"},{"name":"cameraInstance","type":"Object","description":"camera instance","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[BIS_camera,BIS_camera_instance] call BIS_fnc_camera_setCam;"]}],"see_also":["BIS_fnc_camera_getCam"]},{"name":"BIS_fnc_camera_setCinemaBordersEnabled","title":"BIS fnc camera setCinemaBordersEnabled","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_camera_setCinemaBordersEnabled","revid":378073,"updated":"2026-02-11T08:04:24Z","groups":["Camera"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Sets cinema borders.","syntaxes":[{"syntax":"[camera, enabled] call BIS_fnc_camera_setCinemaBordersEnabled","params":[{"name":"camera","type":"Object","description":"the camera","type_expr":"Object"},{"name":"enabled","type":"Boolean","optional":true,"default":"false","description":"true to show cinema borders, false to hide them.","type_expr":"Boolean","text":"enabled: Boolean - (Optional, default false) true to show cinema borders, false to hide them."}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[BIS_camera, true] call BIS_fnc_camera_setCinemaBordersEnabled;"]}],"see_also":["BIS_fnc_camera_getCinemaBordersEnabled"]},{"name":"BIS_fnc_camera_setFocus","title":"BIS fnc camera setFocus","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_camera_setFocus","revid":348055,"updated":"2023-11-08T11:29:08Z","groups":["Camera"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Sets camera focus.","syntaxes":[{"syntax":"[camera, focusValues] call BIS_fnc_camera_setFocus","params":[{"name":"camera","type":"Object","description":"the camera","type_expr":"Object"},{"name":"focusValues","type":"Array","optional":true,"default":"[-1, -1]","description":"focus values in format [distance, blur]","type_expr":"Array","text":"focusValues: Array - (Optional, default [-1, -1]) focus values in format [distance, blur]"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[BIS_camera, [0.5,0.5]] call BIS_fnc_camera_setFocus;"]}],"see_also":["BIS_fnc_camera_getFocus"]},{"name":"BIS_fnc_camera_setFOV","title":"BIS fnc camera setFOV","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_camera_setFOV","revid":349262,"updated":"2023-11-08T14:51:06Z","groups":["Camera"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Sets the FOV of given camera.","syntaxes":[{"syntax":"[camera, FOV] call BIS_fnc_camera_setFOV","params":[{"name":"camera","type":"Object","description":"the camera","type_expr":"Object"},{"name":"FOV","type":"Number","optional":true,"default":"0,75","description":"wanted FOV","type_expr":"Number","text":"FOV: Number - (Optional, default 0,75) wanted FOV"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[BIS_camera,0.5] call BIS_fnc_camera_setFOV;"]}],"see_also":["BIS_fnc_camera_getFOV"]},{"name":"BIS_fnc_camera_setHUDEnabled","title":"BIS fnc camera setHUDEnabled","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_camera_setHUDEnabled","revid":349223,"updated":"2023-11-08T14:50:50Z","groups":["Camera"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Enables or disables camera HUD.","syntaxes":[{"syntax":"[camera, state] call BIS_fnc_camera_setHUDEnabled","params":[{"name":"camera","type":"Object","description":"the camera","type_expr":"Object"},{"name":"state","type":"Boolean","optional":true,"default":"false","description":"true to enable HUD, false to disable","type_expr":"Boolean","text":"state: Boolean - (Optional, default false) true to enable HUD, false to disable"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[BIS_camera,true] call BIS_fnc_camera_setHUDEnabled;"]}],"see_also":["BIS_fnc_camera_getHUDEnabled"]},{"name":"BIS_fnc_camera_setVisionMode","title":"BIS fnc camera setVisionMode","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_camera_setVisionMode","revid":349280,"updated":"2023-11-08T14:51:14Z","groups":["Camera"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Sets camera vision mode.","syntaxes":[{"syntax":"[camera, mode] call BIS_fnc_camera_setVisionMode","params":[{"name":"camera","type":"Object","description":"the camera","type_expr":"Object"},{"name":"mode","type":"Number","optional":true,"default":"0","description":"0 - no vision mode\n- 1 - Night vision\n- 2 - Ti","type_expr":"Number","text":"mode: Number - (Optional, default 0)\n\n- 0 - no vision mode\n- 1 - Night vision\n- 2 - Ti"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[BIS_camera,1] call BIS_fnc_camera_setVisionMode;"]}],"see_also":["BIS_fnc_camera_getVisionMode"]},{"name":"BIS_fnc_camera_tick","title":"BIS fnc camera tick","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_camera_tick","revid":349290,"updated":"2023-11-08T14:51:16Z","groups":["Camera"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Ticks a camera. Updates position and view mode.","syntaxes":[{"syntax":"[camera] call BIS_fnc_camera_tick","params":[{"name":"camera","type":"Object","description":"the camera","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[BIS_camera] call BIS_fnc_camera_tick;"]}],"see_also":["BIS_fnc_camera_init"]},{"name":"BIS_fnc_cameraOld","title":"BIS fnc cameraOld","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_cameraOld","revid":329961,"updated":"2022-08-09T17:17:13Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Classic camera script, replaced by the Splendid™ BIS_fnc_camera.","syntaxes":[{"syntax":"[target] call BIS_fnc_cameraOld","params":[{"name":"target","type":"Object","optional":true,"default":"cameraOn","type_expr":"Object","text":"target: Object - (Optional, default cameraOn)"}],"returns":{"type":"Script Handle","type_expr":"Script Handle"}}],"examples":[{"code":["[player] call BIS_fnc_cameraOld; // starts the camera on the player"]}],"see_also":["BIS_fnc_camera"]},{"name":"BIS_fnc_camFollow","title":"BIS fnc camFollow","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_camFollow","revid":326944,"updated":"2022-07-12T21:44:40Z","groups":["Camera"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Refresh a camera Field of View according to its distance with the target.","syntaxes":[{"syntax":"[camera, target, refreshTime] call BIS_fnc_camFollow","params":[{"name":"camera","type":"Object","type_expr":"Object"},{"name":"target","type":"Object or Position","type_expr":"Object | Position"},{"name":"refreshTime","type":"Number","optional":true,"default":"1","description":"transition time in seconds.\nIf *refreshTime* is **positive**, a refresh happens only once.\nif *refreshTime* is **negative**, the refresh will loop (with a transition time of absolute *refreshTime*) until camera is null","type_expr":"Number","text":"refreshTime: Number - (Optional, default 1) transition time in seconds.\nIf *refreshTime* is **positive**, a refresh happens only once.\nif *refreshTime* is **negative**, the refresh will loop (with a transition time of absolute *refreshTime*) until camera is null"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["private _camera = \"camera\" camCreate ((getPos player) vectorAdd [0,0,3]);\n[_camera, player, -2] call BIS_fnc_camFollow;"]}]},{"name":"BIS_fnc_cancelMarker","title":"BIS fnc cancelMarker","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_cancelMarker","revid":348835,"updated":"2023-11-08T14:39:09Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","locality":{"argument":"global","effect":"global"},"exec":"spawn","description":"Cancels a marker by a red 'X' marker. Also sets its variable to \"Canceled\" to true.","syntaxes":[{"syntax":"[marker, duration, fadeTime, sizeMultiplier, angleOffset] spawn BIS_fnc_cancelMarker","params":[{"name":"marker","type":"String","description":"marker","type_expr":"String"},{"name":"duration","type":"Number","optional":true,"default":"1","description":"duration of canceling in seconds","type_expr":"Number","text":"duration: Number - (Optional, default 1) duration of canceling in seconds"},{"name":"fadeTime","type":"Number","optional":true,"default":"-1","description":"time in seconds after which cancel marker fades. If value is <0 then marker won't fade out and will be deleted after duration","type_expr":"Number","text":"fadeTime: Number - (Optional, default -1) time in seconds after which cancel marker fades. If value is <0 then marker won't fade out and will be deleted after duration"},{"name":"sizeMultiplier","type":"Number","optional":true,"default":"1","description":"multiplier for a size of the 'cancel' marker compared to the original","type_expr":"Number","text":"sizeMultiplier: Number - (Optional, default 1) multiplier for a size of the 'cancel' marker compared to the original"},{"name":"angleOffset","type":"Number","optional":true,"default":"45","description":"angle offset from the original marker","type_expr":"Number","text":"angleOffset: Number - (Optional, default 45) angle offset from the original marker"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"BIS_marker\",2,1.5,75] spawn BIS_fnc_cancelMarker;"]}],"see_also":["BIS_fnc_blinkMarker","BIS_fnc_colorMarker","BIS_fnc_changeColorMarker","BIS_fnc_getMarkers","BIS_fnc_getMarkerState"]},{"name":"BIS_fnc_carAlarm","title":"BIS fnc carAlarm","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_carAlarm","revid":327206,"updated":"2022-07-12T22:11:45Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Play car alarm effect.","syntaxes":[{"syntax":"[mode, car] call BIS_fnc_carAlarm","params":[{"name":"mode","type":"String","description":"can be one of:\n\n- \"init\": add \"Hit\" and \"GetIn\" event handler on the car\n- \"play\": play the alarm effect","type_expr":"String"},{"name":"car","type":"Object","description":"vehicle protected by alarm","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"init\", myCar] call BIS_fnc_carAlarm;"]}],"see_also":["Arma 3: Event Handlers"]},{"name":"BIS_fnc_cargoTurretIndex","title":"BIS fnc cargoTurretIndex","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_cargoTurretIndex","revid":327249,"updated":"2022-07-12T22:11:49Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Return cargo index of a person turret and the other way around.","syntaxes":[{"syntax":"[vehicle, personOrTurretPath] call BIS_fnc_cargoTurretIndex","params":[{"name":"vehicle","type":"Object","description":"the vehicle to check","type_expr":"Object"},{"name":"personOrTurretPath","type":"Person or Array of Numbers","description":"unit to find or turret path","type_expr":"Object | Array<Number>"}],"returns":{"type":"Array","type_expr":"Array | Number","description":"(turret path) or Number (cargo index)","text":"Array (turret path) or Number (cargo index)"}}],"examples":[{"code":["private _vehicle = vehicle player;\nprivate _turretCargoIndex = [_vehicle, [0, 1]] call BIS_fnc_cargoTurretIndex;\nprivate _playerTurretPath = [_vehicle, player] call BIS_fnc_cargoTurretIndex;"]}],"see_also":["turretUnit","moveInTurret","allTurrets"]},{"name":"BIS_fnc_carrier01AnimateDeflectors","title":"BIS fnc carrier01AnimateDeflectors","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_carrier01AnimateDeflectors","revid":321361,"updated":"2022-05-13T19:57:19Z","groups":["Aircraft Carrier"],"status":"ok","games":{"arma3":"1.68"},"since":"arma3 1.68","arma3_since":"1.68","locality":{"argument":"local","effect":"local"},"exec":"spawn","description":"Plays a set of animations to animate the carriers' catapult jet blast deflectors. See Arma 3: Aircraft Systems for information about needed config changes.","syntaxes":[{"syntax":"[carrierPart, animations, animationState] spawn BIS_fnc_carrier01AnimateDeflectors","params":[{"name":"carrierPart","type":"Object","description":"part to animate","type_expr":"Object"},{"name":"animations","type":"Array","description":"animations to be played","type_expr":"Array"},{"name":"animationState","type":"Number","description":"animation state","type_expr":"Number"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[_carrierPart, [\"Deflector_1\", \"Deflector_1_hydraulic_1\", \"Deflector_1_hydraulic_2\", \"Deflector_1_hydraulic_3\"], 10] spawn BIS_fnc_carrier01AnimateDeflectors;"]}],"see_also":["BIS_fnc_aircraftTailhook","BIS_fnc_aircraftCatapultLaunch"]},{"name":"BIS_fnc_carrier01CatapultActionAdd","title":"BIS fnc carrier01CatapultActionAdd","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_carrier01CatapultActionAdd","revid":278790,"updated":"2021-06-13T21:39:54Z","groups":["Aircraft Carrier"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_carrier01CatapultActionRemove","title":"BIS fnc carrier01CatapultActionRemove","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_carrier01CatapultActionRemove","revid":273510,"updated":"2021-06-13T00:53:13Z","groups":["Aircraft Carrier"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_carrier01CatapultID","title":"BIS fnc carrier01CatapultID","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_carrier01CatapultID","revid":273434,"updated":"2021-06-13T00:51:30Z","groups":["Aircraft Carrier"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_carrier01CatapultLockTo","title":"BIS fnc carrier01CatapultLockTo","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_carrier01CatapultLockTo","revid":273322,"updated":"2021-06-13T00:49:53Z","groups":["Aircraft Carrier"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_carrier01CrewInAnim","title":"BIS fnc carrier01CrewInAnim","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_carrier01CrewInAnim","revid":273335,"updated":"2021-06-13T00:50:08Z","groups":["Aircraft Carrier"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_carrier01CrewPlayAnim","title":"BIS fnc carrier01CrewPlayAnim","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_carrier01CrewPlayAnim","revid":273527,"updated":"2021-06-13T00:53:39Z","groups":["Aircraft Carrier"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_carrier01EdenDelete","title":"BIS fnc carrier01EdenDelete","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_carrier01EdenDelete","revid":379550,"updated":"2026-10-31T13:45:43Z","groups":["Aircraft Carrier"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Deletes all parts of a dynamic aircraft carrier in Eden Editor after its base object has been deleted.\nThe function reads the part list stored in the base's `\"bis_carrierParts\"` variable (created by BIS_fnc_carrier01EdenInit or BIS_fnc_carrier01Init) and deletes every part with deleteVehicle. It does nothing where isServer is false.\n\nThe function is meant for internal use: it is called from the carrier base's `UnregisteredFromWorld3DEN` Eden event handler.","syntaxes":[{"syntax":"carrier call BIS_fnc_carrier01EdenDelete","params":[{"name":"carrier","type":"Object","description":"the carrier base object holding the `\"bis_carrierParts\"` variable","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"Carrier base config (event handlers as given in the function's header):\n\n```cpp\nclass EventHandlers\n{\n    init = \"_this call BIS_fnc_carrier01Init\";\n    AttributesChanged3DEN = \"_this call BIS_fnc_carrier01EdenInit\";\n    Dragged3DEN = \"_this call BIS_fnc_carrier01PosUpdate\";\n    RegisteredToWorld3DEN = \"_this call BIS_fnc_carrier01EdenInit\";\n    UnregisteredFromWorld3DEN = \"_this call BIS_fnc_carrier01EdenDelete\";\n};\n```"}],"see_also":["BIS_fnc_carrier01Init","BIS_fnc_carrier01EdenInit","BIS_fnc_carrier01PosUpdate","BIS_fnc_destroyer01EdenDelete"]},{"name":"BIS_fnc_carrier01EdenInit","title":"BIS fnc carrier01EdenInit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_carrier01EdenInit","revid":379551,"updated":"2026-10-31T13:46:13Z","groups":["Aircraft Carrier"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Assembles a dynamic aircraft carrier in Eden Editor.\nThe function reads the carrier base's `multiStructureParts` config array (pairs of part class name and memory point name), creates each part with createVehicle, aligns it with the base, places it at the base's memory point, disables its damage and stores the list of parts as `[[part, memoryPoint], ...]` in the base's public variable `\"bis_carrierParts\"`.\nParts are only created where isServer is true. Parts created by an earlier call are not deleted.\n\nThis is the assembly part of BIS_fnc_carrier01Init without the catapult action setup. It is meant for internal use: it is called from the carrier base's `RegisteredToWorld3DEN` and `AttributesChanged3DEN` Eden event handlers.","syntaxes":[{"syntax":"carrier call BIS_fnc_carrier01EdenInit","params":[{"name":"carrier","type":"Object","description":"the carrier base object (the object whose config holds `multiStructureParts`)","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"Carrier base config (event handlers as given in the function's header):\n\n```cpp\nclass EventHandlers\n{\n    init = \"_this call BIS_fnc_carrier01Init\";\n    AttributesChanged3DEN = \"_this call BIS_fnc_carrier01EdenInit\";\n    Dragged3DEN = \"_this call BIS_fnc_carrier01PosUpdate\";\n    RegisteredToWorld3DEN = \"_this call BIS_fnc_carrier01EdenInit\";\n    UnregisteredFromWorld3DEN = \"_this call BIS_fnc_carrier01EdenDelete\";\n};\n```"}],"see_also":["BIS_fnc_carrier01Init","BIS_fnc_carrier01EdenDelete","BIS_fnc_carrier01PosUpdate","BIS_fnc_destroyer01EdenInit"]},{"name":"BIS_fnc_carrier01Init","title":"BIS fnc carrier01Init","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_carrier01Init","revid":321483,"updated":"2022-05-14T19:58:31Z","groups":["Aircraft Carrier"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"This is a main function designed to assemble a dynamic aircraft carrier.\nA carrier consists of multiple sub-objects that are linked together based on precise memory point positions in 3D space.","syntaxes":[{"syntax":"carrier call BIS_fnc_carrier01Init","params":[{"name":"carrier","type":"Object","description":"an object from which the script will wait to get variable \"BIS_carrierParts\"","type_expr":"Object"}],"returns":{"type":"Script Handle","type_expr":"Script Handle"}}],"examples":[{"code":["myCarrier call BIS_fnc_carrier01Init;"]}],"see_also":["BIS_fnc_carrier01CatapultActionAdd","BIS_fnc_carrier01CatapultActionRemove"]},{"name":"BIS_fnc_carrier01PosUpdate","title":"BIS fnc carrier01PosUpdate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_carrier01PosUpdate","revid":379552,"updated":"2026-10-31T13:46:44Z","groups":["Aircraft Carrier"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Moves all parts of a dynamic aircraft carrier back into place relative to its base object.\nFor every entry of the base's `\"bis_carrierParts\"` variable, the part gets the base's vectorDir and vectorUp and is moved with setPosWorld to the position of its memory point on the base. It does nothing where isServer is false.\n\nThe function is called from the carrier base's `Dragged3DEN` Eden event handler when the carrier is dragged in Eden Editor. As the code does not depend on Eden, it can also be called by scripts after the base has been moved during a mission.","syntaxes":[{"syntax":"carrier call BIS_fnc_carrier01PosUpdate","params":[{"name":"carrier","type":"Object","description":"the carrier base object holding the `\"bis_carrierParts\"` variable","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"Carrier base config (event handlers as given in the function's header):\n\n```cpp\nclass EventHandlers\n{\n    init = \"_this call BIS_fnc_carrier01Init\";\n    AttributesChanged3DEN = \"_this call BIS_fnc_carrier01EdenInit\";\n    Dragged3DEN = \"_this call BIS_fnc_carrier01PosUpdate\";\n    RegisteredToWorld3DEN = \"_this call BIS_fnc_carrier01EdenInit\";\n    UnregisteredFromWorld3DEN = \"_this call BIS_fnc_carrier01EdenDelete\";\n};\n```"},{"text":"Move a carrier during a mission (server side):\n\n```sqf\nmyCarrier setPosWorld (getPosWorld myCarrier vectorAdd [0, 500, 0]);\nmyCarrier call BIS_fnc_carrier01PosUpdate;\n```","code":["myCarrier setPosWorld (getPosWorld myCarrier vectorAdd [0, 500, 0]);\nmyCarrier call BIS_fnc_carrier01PosUpdate;"]}],"see_also":["BIS_fnc_carrier01Init","BIS_fnc_carrier01EdenInit","BIS_fnc_carrier01EdenDelete","BIS_fnc_destroyer01PosUpdate"]},{"name":"BIS_fnc_changeColorMarker","title":"BIS fnc changeColorMarker","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_changeColorMarker","revid":348824,"updated":"2023-11-08T14:39:08Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","locality":{"effect":"global"},"exec":"spawn","description":"Makes the marker go from its original color to a specified color over time","syntaxes":[{"syntax":"[marker, color, duration] spawn BIS_fnc_changeColorMarker","params":[{"name":"marker","type":"String","description":"marker","type_expr":"String"},{"name":"color","type":"String","description":"color from CfgMarkerColors","type_expr":"String"},{"name":"duration","type":"Number","optional":true,"default":"1","description":"duration of transition in seconds","type_expr":"Number","text":"duration: Number - (Optional, default 1) duration of transition in seconds"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"BIS_marker\",\"ColorRed\"] spawn BIS_fnc_changeColorMarker;"]}],"see_also":["BIS_fnc_blinkMarker","BIS_fnc_colorMarker"]},{"name":"BIS_fnc_changeSupportRadioChannel","title":"BIS fnc changeSupportRadioChannel","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_changeSupportRadioChannel","revid":272937,"updated":"2021-06-13T00:34:58Z","groups":["Supports"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Changes the radio channel for Support module-related protocol.","syntaxes":[{"syntax":"[param0, param1] call BIS_fnc_changeSupportRadioChannel","params":[{"name":"param0","type":"Side","type_expr":"Side","description":"Affected side","text":"0: SIDE - Affected side","source":"docblock"},{"name":"param1","type":"Anything","type_expr":"Anything","description":"Channel setting","text":"1: ANY - Channel setting","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","text":"nothing","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nChanges the radio channel for Support module-related protocol.\n\nParameter(s):\n_this select 0: SIDE - Affected side\n_this select 1: ANY - Channel setting\n\nReturns:\nnothing"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_channelNumToRadioChannelID","title":"BIS fnc channelNumToRadioChannelID","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_channelNumToRadioChannelID","revid":378101,"updated":"2026-02-13T20:44:52Z","groups":["Radio"],"status":"ok","games":{"arma3":"2.22"},"since":"arma3 2.22","arma3_since":"2.22","description":"Converts chat channel number, used in currentChannel, enableChannel, etc to radio channel id, used in radioChannelAdd, radioChannelSetLabel, etc.","syntaxes":[{"syntax":"channelNum call BIS_fnc_channelNumToRadioChannelID","params":[{"name":"channelNum","type":"Number","description":"channel number (6..15, 26..65)","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number","description":"radio channel id (1..50)"}}],"examples":[{"code":["26 call BIS_fnc_channelNumToRadioChannelID; // 11"]}],"see_also":["BIS_fnc_radioChannelIDToChannelNum","radioChannelCreate","currentChannel"]},{"name":"BIS_fnc_cinemaBorder","title":"BIS fnc cinemaBorder","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_cinemaBorder","revid":348331,"updated":"2023-11-08T12:59:44Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Creates cinematic borders. Player cannot move during cutscene.","syntaxes":[{"syntax":"[mode, duration, sound, view] call BIS_fnc_cinemaBorder","params":[{"name":"mode","type":"Number","description":"can be:\n\n- 0 - In\n- 1 - Out","type_expr":"Number"},{"name":"duration","type":"Number","optional":true,"default":"1.5","description":"duration in seconds","type_expr":"Number","text":"duration: Number - (Optional, default 1.5) duration in seconds"},{"name":"sound","type":"Boolean","optional":true,"default":"true","description":"play sound","type_expr":"Boolean","text":"sound: Boolean - (Optional, default true) play sound"},{"name":"view","type":"Boolean","optional":true,"default":"false","description":"lock 1st-person-view","type_expr":"Boolean","text":"view: Boolean - (Optional, default false) lock 1st-person-view"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[1, 2, true, true] call BIS_fnc_cinemaBorder;"]}],"see_also":["disableUserInput","userInputDisabled"],"notes":[{"user":"Honger","date":"2022-10-15T14:43:35Z","text":"When cinematic borders are active and player is not provided with any animation, he can abuse the movement lock by vaulting (default button V)."}]},{"name":"BIS_fnc_clamp","title":"BIS fnc clamp","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_clamp","revid":341317,"updated":"2023-05-21T15:49:57Z","groups":["Math"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Clamps provided value within min..max range.\n\n> [!NOTE]\n> This function is for readability; for performance, directly use min and max.","syntaxes":[{"syntax":"[value, min, max] call BIS_fnc_clamp","params":[{"name":"value","type":"Number","description":"value to be clamped","type_expr":"Number"},{"name":"min","type":"Number","optional":true,"default":"0","description":"lower limit","type_expr":"Number","text":"min: Number - (Optional, default 0) lower limit"},{"name":"max","type":"Number","optional":true,"default":"0","description":"upper limit","type_expr":"Number","text":"max: Number - (Optional, default 0) upper limit"}],"returns":{"type":"Number","type_expr":"Number","description":"the clamped value"}}],"examples":[{"text":"```sqf\n [5, 0, 10] call BIS_fnc_clamp;    // returns 5\n [0, 0, 10] call BIS_fnc_clamp;    // returns 0\n[10, 0, 10] call BIS_fnc_clamp;    // returns 10\n[-5, 0, 10] call BIS_fnc_clamp;    // returns 0\n[15, 0, 10] call BIS_fnc_clamp;    // returns 10\n [5, 10, 3] call BIS_fnc_clamp;    // returns 10\n```","code":[" [5, 0, 10] call BIS_fnc_clamp;\t// returns 5\n [0, 0, 10] call BIS_fnc_clamp;\t// returns 0\n[10, 0, 10] call BIS_fnc_clamp;\t// returns 10\n[-5, 0, 10] call BIS_fnc_clamp;\t// returns 0\n[15, 0, 10] call BIS_fnc_clamp;\t// returns 10\n [5, 10, 3] call BIS_fnc_clamp;\t// returns 10"]},{"text":"```sqf\n[5, 0, 10] call BIS_fnc_clamp;    // 0.0098 ms\n0 max 5 min 10;                    // 0.0011 ms - about 10x faster\n```","code":["[5, 0, 10] call BIS_fnc_clamp;\t// 0.0098 ms\n0 max 5 min 10;\t\t\t\t\t// 0.0011 ms - about 10x faster"]}],"see_also":["min","max"]},{"name":"BIS_fnc_clampVector","title":"BIS fnc clampVector","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_clampVector","revid":327749,"updated":"2022-07-13T11:07:26Z","groups":["Vectors"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Clamps vector values between provided min/max boundaries.\n\n> [!NOTE]\n> This function can be used to clamp any Array of Numbers (even though it is not its main usage).","syntaxes":[{"syntax":"[vector, min, max] call BIS_fnc_clampVector","params":[{"name":"vector","type":"Vector3D","optional":true,"default":"[0,0,0]","description":"the vector to be clamped","type_expr":"Vector3D","text":"vector: Vector3D - (Optional, default [0,0,0]) the vector to be clamped"},{"name":"min","type":"Number","optional":true,"default":"0","type_expr":"Number","text":"min: Number - (Optional, default 0)"},{"name":"max","type":"Number","optional":true,"default":"0","type_expr":"Number","text":"max: Number - (Optional, default 0)"}],"returns":{"type":"Vector3D","type_expr":"Vector3D","description":"the clamped vector","text":"Vector3D - the clamped *vector*"}}],"examples":[{"code":["private _newVelocity = [velocity vehicle player, -100, 100] call BIS_fnc_clampVector;\nvehicle player setVelocity _newVelocity;"]}],"see_also":["BIS_fnc_clamp","vectorNormalized","vectorMultiply"]},{"name":"BIS_fnc_classMagazine","title":"BIS fnc classMagazine","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_classMagazine","revid":326979,"updated":"2022-07-12T21:44:42Z","groups":["Configs"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Returns class of magazine given by string.","syntaxes":[{"syntax":"magazineClass call BIS_fnc_classMagazine","params":[{"name":"magazineClass","type":"String","type_expr":"String"}],"returns":{"type":"Config","type_expr":"Config"}}],"examples":[{"code":["private _magazineConfig = currentMagazine player call BIS_fnc_classMagazine;"]}],"see_also":["BIS_fnc_classWeapon","isClass"]},{"name":"BIS_fnc_classWeapon","title":"BIS fnc classWeapon","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_classWeapon","revid":328542,"updated":"2022-07-13T17:02:16Z","groups":["Weapons"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Returns class of weapon given by string.","syntaxes":[{"syntax":"weaponClass call BIS_fnc_classWeapon","params":[{"name":"weaponClass","type":"String","type_expr":"String"}],"returns":{"type":"Config","type_expr":"Config"}}],"examples":[{"code":["private _weaponConfig = currentWeapon player call BIS_fnc_classWeapon;"]}],"see_also":["BIS_fnc_classMagazine","isClass"]},{"name":"BIS_fnc_clerp","title":"BIS fnc clerp","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_clerp","revid":349253,"updated":"2023-11-08T14:51:03Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"CLerp - Circular Lerp - is like lerp but handles the wraparound from 0 to 360\n\n```\nThis is useful when interpolating eulerAngles and the object crosses the 0/360 boundary\nThe standard Lerp function causes the object to rotate in the wrong direction, clerp fixes that\n```","syntaxes":[{"syntax":"[currentValue, targetValue, alpha] call BIS_fnc_clerp","params":[{"name":"currentValue","type":"Number","description":"the current value","type_expr":"Number"},{"name":"targetValue","type":"Number","description":"the target value","type_expr":"Number"},{"name":"alpha","type":"Number","description":"the alpha","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number","description":"interpolated value"}}],"examples":[{"code":["[90,170,0.1] call BIS_fnc_clerp; // Returns 98"]}],"see_also":["BIS_fnc_slerp","BIS_fnc_lerp","BIS_fnc_lerpVector","BIS_fnc_inverseLerp"]},{"name":"BIS_fnc_codePerformance","title":"BIS fnc codePerformance","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_codePerformance","revid":349499,"updated":"2023-11-08T17:09:10Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"0.50"},"since":"arma3 0.50","arma3_since":"0.50","description":"Measures how much time it takes to execute given expression.\nResults may vary based on overall performance; use this function to compare alternative scripting approaches rather than to measure specific values.\nUpon function execution, window with results is opened. The user then has a choice to copy the result into clipboard or not.\nThis function is using diag_codePerformance command.\n\n> [!NOTE]\n> Use toString to stringify Code, as str adds curly braces - See Example 2.","syntaxes":[{"syntax":"[expression, arguments, cycles, display] call BIS_fnc_codePerformance","params":[{"name":"expression","type":"String","description":"tested expression","type_expr":"String"},{"name":"arguments","type":"Anything","optional":true,"default":"`[]`","description":"arguments to pass into the code","type_expr":"Anything","text":"arguments: Anything - (Optional, default `[]`) arguments to pass into the code"},{"name":"cycles","type":"Number","optional":true,"default":"10000","description":"number of wanted cycles","type_expr":"Number","text":"cycles: Number - (Optional, default 10000) number of wanted cycles"},{"name":"display","type":"Display","optional":true,"default":"`findDisplay 46`","description":"display in which the message window with results will be opened. Use displayNull to disable the window","type_expr":"Display","text":"display: Display - (Optional, default `findDisplay 46`) display in which the message window with results will be opened. Use displayNull to disable the window"}],"returns":{"type":"Number","type_expr":"Number","description":"average execution time of the expression"}}],"examples":[{"code":["// compare three methods of adding elements into array\ntestArray = [];\n[\"testArray = testArray + [1]\"] call BIS_fnc_codePerformance;\ntestArray = [];\n[\"testArray set [count testArray, 1]\"] call BIS_fnc_codePerformance;\ntestArray = [];\n[\"testArray pushBack 1\"] call BIS_fnc_codePerformance;"]},{"code":["[toString { hint \"Hello there\" }] call BIS_fnc_codePerformance;"]}],"see_also":["diag_codePerformance"]},{"name":"BIS_fnc_colorConfigToRGBA","title":"BIS fnc colorConfigToRGBA","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_colorConfigToRGBA","revid":327483,"updated":"2022-07-12T22:17:18Z","groups":["Arrays"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Converts config color format to RGBA array of numbers.","syntaxes":[{"syntax":"configColor call BIS_fnc_colorConfigToRGBA","params":[{"name":"configColor","type":"Array","description":"config color","type_expr":"Array"}],"returns":{"type":"Array format Color (RGBA)","types":["Array","Color"],"type_expr":"Color"}}],"examples":[{"code":["[\"0.5 + 0.25\",0,0,1] call BIS_fnc_colorConfigToRGBA; // returns [0.75,0,0,1]"]}],"see_also":["Color","BIS_fnc_colorRGBtoHTML","BIS_fnc_colorRGBAtoHTML","BIS_fnc_colorRGBAtoTexture"]},{"name":"BIS_fnc_colorMarker","title":"BIS fnc colorMarker","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_colorMarker","revid":348838,"updated":"2023-11-08T14:39:09Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","locality":{"argument":"global","effect":"global"},"exec":"spawn","description":"Changes color of a marker with a little effect","syntaxes":[{"syntax":"[marker, color, duration] spawn BIS_fnc_colorMarker","params":[{"name":"marker","type":"String","description":"marker","type_expr":"String"},{"name":"color","type":"String","description":"color from CfgMarkerColors","type_expr":"String"},{"name":"duration","type":"Number","optional":true,"default":"1","description":"duration of the transition","type_expr":"Number","text":"duration: Number - (Optional, default 1) duration of the transition"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"BIS_marker\",\"ColorRed\",2] spawn BIS_fnc_colorMarker;"]}],"see_also":["BIS_fnc_blinkMarker","BIS_fnc_changeColorMarker","BIS_fnc_getMarkers","BIS_fnc_getMarkerState"]},{"name":"BIS_fnc_colorRGBAtoHTML","title":"BIS fnc colorRGBAtoHTML","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_colorRGBAtoHTML","revid":327485,"updated":"2022-07-12T22:19:04Z","groups":["Arrays"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Converts RGBA color format to #AARRGGBB HTML color format.","syntaxes":[{"syntax":"colorArray call BIS_fnc_colorRGBAtoHTML","params":[{"name":"colorArray","type":"Color (RGBA)","description":"in [r, g, b, a] format","type_expr":"Color"}],"returns":{"type":"String","type_expr":"String","description":"format #AARRGGBB"}}],"examples":[{"code":["[0,0,0,1] call BIS_fnc_colorRGBAtoHTML; // will return #FF000000"]},{"code":["[2,93,0,1] call BIS_fnc_colorRGBAtoHTML; // will return #FF025D00"]}],"see_also":["Color","BIS_fnc_colorConfigToRGBA","BIS_fnc_colorRGBtoHTML","BIS_fnc_colorRGBAtoTexture"]},{"name":"BIS_fnc_colorRGBAtoTexture","title":"BIS fnc colorRGBAtoTexture","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_colorRGBAtoTexture","revid":340322,"updated":"2023-04-30T00:15:24Z","groups":["Arrays"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Converts RGB color format to procedural texture, e.g `[0,0,0,1]` becomes `\"#(argb,8,8,3)color(0,0,0,1)\"`.\nValues are in range 0..1.","syntaxes":[{"syntax":"color call BIS_fnc_colorRGBAtoTexture","params":[{"name":"color","type":"Array","description":"format [R,G,B,A]","type_expr":"Array"}],"returns":{"type":"String","type_expr":"String","description":"procedural texture to format \"#(argb,8,8,3)color(R,G,B,A)\""}}],"examples":[{"code":["private _texture = [0,0,0,1] call BIS_fnc_colorRGBAtoTexture;"]}],"see_also":["BIS_fnc_colorRGBAtoHTML"]},{"name":"BIS_fnc_colorRGBtoHTML","title":"BIS fnc colorRGBtoHTML","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_colorRGBtoHTML","revid":323934,"updated":"2022-07-01T11:58:28Z","groups":["Arrays"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Converts RGB color format to HTML color format.","syntaxes":[{"syntax":"colorArray call BIS_fnc_colorRGBtoHTML","params":[{"name":"colorArray","type":"Color (RGBA)","description":"can be [r, g, b, a] or [r, g, b], alpha value will be ignored in both cases","type_expr":"Color"}],"returns":{"type":"String","type_expr":"String","description":"format #RRGGBB"}}],"examples":[{"code":["private _htmlColor = [0,0,0,1] call BIS_fnc_colorRGBtoHTML; // will return #000000"]},{"code":["private _htmlColor = [2,93,0,1] call BIS_fnc_colorRGBtoHTML; // will return #025D00"]}],"see_also":["Color","BIS_fnc_colorConfigToRGBA","BIS_fnc_colorRGBAtoHTML","BIS_fnc_colorRGBAtoTexture"]},{"name":"BIS_fnc_commsMenuCreate","title":"BIS fnc commsMenuCreate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_commsMenuCreate","revid":309303,"updated":"2022-05-05T12:04:22Z","groups":["Communication Menu"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Creates the global communications menu, if it is not already created. All entries are invisible by default. Unhide appropriate sections by using BIS_fnc_commsMenuToggleVisibility.","syntaxes":[{"syntax":"call BIS_fnc_commsMenuCreate","params":[],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if successful"}}],"examples":[{"code":["call BIS_fnc_commsMenuCreate;"]}],"see_also":["BIS_fnc_commsMenuToggleVisibility"]},{"name":"BIS_fnc_commsMenuToggleAvailability","title":"BIS fnc commsMenuToggleAvailability","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_commsMenuToggleAvailability","revid":283019,"updated":"2021-06-16T22:11:47Z","groups":["Communication Menu"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Enables or disables certain sections of the global communications menu.","syntaxes":[{"syntax":"[index, mode] call BIS_fnc_commsMenuToggleAvailability","params":[{"name":"index","type":"String","type_expr":"String","description":"(Scalar) or list of indices (Array of Scalars) or section name (String)\n\"som\" - SecOps section\n\"wf\" - Warfare section","text":"0: (Scalar) or list of indices (Array of Scalars) or section name (String)\n\"som\" - SecOps section\n\"wf\" - Warfare section","source":"docblock"},{"name":"mode","type":"Number","type_expr":"Number","description":"(Scalar)\n0 - disable\n1 - enable","text":"1: (Scalar)\n0 - disable\n1 - enable","source":"docblock"}],"returns":{"type":"Boolean","types":["Boolean"],"text":"Success flag (Boolean)","source":"docblock"},"inferred":true}],"docblock":{"text":"File: fn_commsMenuToggleAvailability.sqf\n\nDescription:\nEnables or disables certain sections of the global communications menu.\n\nParameter(s):\n_this select 0: index (Scalar) or list of indices (Array of Scalars) or section name (String)\n    \"som\" - SecOps section\n    \"wf\" - Warfare section\n_this select 1: mode (Scalar)\n    0 - disable\n    1 - enable\n\nReturns:\nSuccess flag (Boolean)","meta":{"file":"fn_commsMenuToggleAvailability.sqf"}},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_commsMenuToggleVisibility","title":"BIS fnc commsMenuToggleVisibility","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_commsMenuToggleVisibility","revid":283052,"updated":"2021-06-16T22:12:22Z","groups":["Communication Menu"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Shows or hides certain sections of the global communications menu.","syntaxes":[{"syntax":"[index, mode] call BIS_fnc_commsMenuToggleVisibility","params":[{"name":"index","type":"String","type_expr":"String","description":"(Scalar) or list of indices (Array of Scalars) or section name (String)\n\"som\" - SecOps section\n\"wf\" - Warfare section","text":"0: (Scalar) or list of indices (Array of Scalars) or section name (String)\n\"som\" - SecOps section\n\"wf\" - Warfare section","source":"docblock"},{"name":"mode","type":"Number","type_expr":"Number","description":"(Scalar)\n0 - hide\n1 - show","text":"1: (Scalar)\n0 - hide\n1 - show","source":"docblock"}],"returns":{"type":"Boolean","types":["Boolean"],"text":"Success flag (Boolean)","source":"docblock"},"inferred":true}],"docblock":{"text":"File: fn_commsMenuToggleVisibility.sqf\n\nDescription:\nShows or hides certain sections of the global communications menu.\n\nParameter(s):\n_this select 0: index (Scalar) or list of indices (Array of Scalars) or section name (String)\n    \"som\" - SecOps section\n    \"wf\" - Warfare section\n_this select 1: mode (Scalar)\n    0 - hide\n    1 - show\n\nReturns:\nSuccess flag (Boolean)","meta":{"file":"fn_commsMenuToggleVisibility.sqf"}},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_compareDateTimes","title":"BIS fnc compareDateTimes","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_compareDateTimes","revid":323790,"updated":"2022-07-01T11:53:40Z","groups":["Environment"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Returns the newer date or returns true if they are identical.","syntaxes":[{"syntax":"[date1, date2] call BIS_fnc_compareDateTimes","params":[{"name":"date1","type":"Array format Date","type_expr":"Date","types":["Array","Date"]},{"name":"date2","type":"Array format Date","type_expr":"Date","types":["Array","Date"]}],"returns":{"type":"Boolean or Array","type_expr":"Boolean | Array"}}],"examples":[{"code":["[[2035,5,28,13,37], [2032,5,28,13,37]] call BIS_fnc_compareDateTimes;"]}],"see_also":["date","BIS_fnc_isDateTimeNewer","BIS_fnc_calculateDateTime"]},{"name":"BIS_fnc_compatibleItems","title":"BIS fnc compatibleItems","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_compatibleItems","revid":349367,"updated":"2023-11-08T15:35:11Z","groups":["Inventory"],"status":"deprecated","replaced_by":["compatibleItems"],"games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!CAUTION]\n> This information is **obsolete**. Reason: Use compatibleItems instead.\n\nReturn all compatible weapon attachments.","syntaxes":[{"syntax":"weapon call BIS_fnc_compatibleItems","params":[{"name":"weapon","type":"String","description":"weapon class","type_expr":"String"}],"returns":{"type":"Array of Strings","type_expr":"Array<String>"}}],"examples":[{"code":["(currentWeapon player) call BIS_fnc_compatibleItems;"]}],"see_also":["compatibleItems","currentWeapon","BIS_fnc_limitWeaponItems","BIS_fnc_baseWeapon"]},{"name":"BIS_fnc_compatibleMagazines","title":"BIS fnc compatibleMagazines","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_compatibleMagazines","revid":348182,"updated":"2023-11-08T11:39:58Z","groups":["Weapons"],"status":"deprecated","replaced_by":["compatibleMagazines"],"games":{"arma3":"1.96"},"since":"arma3 1.96","arma3_since":"1.96","description":"> [!CAUTION]\n> This information is **obsolete** as of Arma 3 v2.10. Reason:\n> Use compatibleMagazines instead.\n\nGets all compatible magazines for selected weapons. Function looks both for magazines listed in `magazines` array and compatible `magazineWells`.","syntaxes":[{"syntax":"[weapon, returnHidden] call BIS_fnc_compatibleMagazines","params":[{"name":"weapon","type":"String","description":"weapon's classname","type_expr":"String"},{"name":"returnHidden","type":"Boolean","optional":true,"default":"false","description":"true to also return magazines with scope 1","type_expr":"Boolean","text":"returnHidden: Boolean - (Optional, default false) true to also return magazines with scope 1"}],"returns":{"type":"Array","type_expr":"Array","description":"array of magazine classes"}}],"examples":[{"code":["[\"arifle_mx_f\"] call BIS_fnc_compatibleMagazines;"]}],"see_also":["currentMagazine","currentWeapon","compatibleMagazines"],"notes":[{"user":"PierreMGI","date":"2020-09-01T18:59:00Z","text":"This function returns all magazines in lower case.\nExample:\n\n```sqf\ncurrentMagazine player;                                    //  \"30Rnd_762x39_AK12_Mag_F\"\ncurrentWeapon player call BIS_fnc_compatibleMagazines;    // [\"30rnd_762x39_ak12_mag_f\", ...]\ncurrentMagazine player in (currentWeapon player call BIS_fnc_compatibleMagazines);                // never works\ntoLowerANSI currentMagazine player in (currentWeapon player call BIS_fnc_compatibleMagazines);    // works\n```"}]},{"name":"BIS_fnc_completedCuratorChallengesCount","title":"BIS fnc completedCuratorChallengesCount","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_completedCuratorChallengesCount","revid":348891,"updated":"2023-11-08T14:39:51Z","groups":["CuratorChallenges"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Return number of completed curator challenges.","syntaxes":[{"syntax":"curator call BIS_fnc_completedCuratorChallengesCount","params":[{"name":"curator","type":"Object","description":"curator module","type_expr":"Object"}],"returns":{"type":"Number","type_expr":"Number","description":"number of completed challenges"}}],"examples":[{"code":["curatorModule call BIS_fnc_completedCuratorChallengesCount;"]}],"see_also":["Arma 3: Curator"]},{"name":"BIS_fnc_conditionalSelect","title":"BIS fnc conditionalSelect","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_conditionalSelect","revid":327949,"updated":"2022-07-13T12:57:27Z","groups":["Arrays"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"This returns a sub-array of elements that satisfy a specific condition **in the order they have been passed**.\n\n> [!NOTE]\n> **Arma 3:** Since Arma 3 v1.55, use `array select condition` instead.\n\nIn the condition, the currently tested element is assigned to the variable \"_x\".\nThe original array is **not** modified.","syntaxes":[{"syntax":"[items, condition] call BIS_fnc_conditionalSelect","params":[{"name":"items","type":"Array","description":"array to check","type_expr":"Array"},{"name":"condition","type":"Code","description":"selection code","type_expr":"Code"}],"returns":{"type":"Array","type_expr":"Array"}}],"examples":[{"code":["[[10, 0, 8, 2, 6, 4], { _x > 5 }] call BIS_fnc_conditionalSelect; // will return [10,8,6]"]},{"code":["[[10, true, 8, player], { typeName _x == \"STRING\" }] call BIS_fnc_conditionalSelect; // will return []"]}],"see_also":["select","count"]},{"name":"BIS_fnc_configExtremes","title":"BIS fnc configExtremes","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_configExtremes","revid":327750,"updated":"2022-07-13T11:09:06Z","groups":["Configs"],"status":"ok","games":{"arma3":"1.36"},"since":"arma3 1.36","arma3_since":"1.36","description":"Scan config paths and return min and max values for each property.\nCan be used only for properties of type Number and Array (value is considered to be the geometric mean of all numbers in the array).","syntaxes":[{"syntax":"[paths, properties, propertyTypes, propertyDefaults] call BIS_fnc_configExtremes","params":[{"name":"paths","type":"Array of Configs","description":"paths to be scanned.","type_expr":"Array<Config>"},{"name":"properties","type":"Array of Strings","description":"class names of properties to be evaluated.","type_expr":"Array<String>"},{"name":"propertyTypes","type":"Array of Booleans","optional":true,"default":"false","description":"whether the property at the respective index should be evaluated and returned as a logarithmic number","type_expr":"Array<Boolean>","text":"propertyTypes: Array of Booleans - (Optional, default false) whether the property at the respective index should be evaluated and returned as a logarithmic number"},{"name":"propertyDefaults","type":"Array of Numbers","optional":true,"default":"0","description":"value to be used in cases where the property at the respective index is not defined","type_expr":"Array<Number>","text":"propertyDefaults: Array of Numbers - (Optional, default 0) value to be used in cases where the property at the respective index is not defined"}],"returns":{"type":"Array","type_expr":"Array","description":"[minValues, maxValues] where minValues and maxValues are arrays respective to the properties array."}}],"examples":[{"code":["private _paths = [configFile >> \"CfgWeapons\"] call BIS_fnc_returnChildren;\n[_paths, [\"maxRange\", \"reloadTime\"]] call BIS_fnc_configExtremes;"]}]},{"name":"BIS_fnc_configPath","title":"BIS fnc configPath","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_configPath","revid":327973,"updated":"2022-07-13T14:34:58Z","groups":["Configs"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns config path to given entry in given format.","syntaxes":[{"syntax":"[config, format, strict] call BIS_fnc_configPath","params":[{"name":"config","type":"Array, String or Config","description":"input config","type_expr":"Array | String | Config"},{"name":"format","type":"Array, String or Config","optional":true,"default":"`[]` or `configNull` if config is Array - see Example 1","description":"desired format of output","type_expr":"Array | String | Config","text":"format: Array, String or Config - (Optional, default `[]` or `configNull` if *config* is Array - see Example 1) desired format of output"},{"name":"strict","type":"Boolean","optional":true,"default":"false","description":"if false, the function will not attempt to construct a valid config before certain format conversions (see Example 2).\nSet this param to true to invoke the strict mode","type_expr":"Boolean","text":"strict: Boolean - (Optional, default false) if false, the function will not attempt to construct a valid config before certain format conversions (see Example 2).\nSet this param to true to invoke the strict mode"}],"returns":{"type":"Array, String or Config","type_expr":"Array | String | Config"}}],"examples":[{"code":["[\"configFile >> \"\"CfgVehicles\"\" >> \"\"Car\"\"\"] call BIS_fnc_configPath; // [\"configFile\",\"CfgVehicles\",\"Car\"]"]},{"code":["[[\"mary\", \"had\", \"a\", \"little\", \"lamb\"], \"\"] call BIS_fnc_configPath; // \"mary >> \"\"had\"\" >> \"\"a\"\" >> \"\"little\"\" >> \"\"lamb\"\"\""]},{"code":["[[\"configFile\",\"CfgVehicles\",\"Car\"]] call BIS_fnc_configPath; // bin\\config.cpp/CfgVehicles/Car"]},{"code":["[\"bin\\config.cpp/CfgVehicles/Car\"] call BIS_fnc_configPath; // [\"configFile\",\"CfgVehicles\",\"Car\"]"]},{"code":["[configFile >> \"CfgVehicles\" >> \"Car\", \"\"] call BIS_fnc_configPath; // \"configFile >> \"\"CfgVehicles\"\" >> \"\"Car\"\"\""]},{"code":["[\"bin\\config.cpp/CfgVehicles/Car\", \"\", true] call BIS_fnc_configPath; // \"configFile >> \"\"CfgVehicles\"\" >> \"\"Car\"\"\""]},{"code":["[\"bin\\config.cpp/CfgVehicles/Car\", \"\"] call BIS_fnc_configPath; // \"bin\\config.cpp/CfgVehicles/Car\""]},{"code":["[[\"mary\", \"had\", \"a\", \"little\", \"lamb\"], \"\", true] call BIS_fnc_configPath; // \"\" invalid config"]}],"see_also":["configHierarchy"]},{"name":"BIS_fnc_configViewer","title":"BIS fnc configViewer","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_configViewer","revid":348118,"updated":"2023-11-08T11:32:17Z","groups":["Diagnostic"],"status":"ok","games":{"arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2oa 1.50","arma3_since":"0.50","description":"Opens the Splendid™ Config Viewer.","syntaxes":[{"syntax":"[parent, cfg, showOk, onSelect, onAdd, header] call BIS_fnc_configViewer","params":[{"name":"parent","type":"Display","optional":true,"default":"mission display","description":"parent display","type_expr":"Display","text":"parent: Display - (Optional, default mission display) parent display"},{"name":"cfg","type":"Config","optional":true,"default":"all configs","description":"root config","type_expr":"Config","text":"cfg: Config - (Optional, default all configs) root config"},{"name":"showOk","type":"Boolean","optional":true,"default":"false","description":"true to display OK button. Script will then wait until viewer is closed and return selected class and param","type_expr":"Boolean","text":"showOk: Boolean - (Optional, default false) true to display OK button. Script will then wait until viewer is closed and return selected class and param"},{"name":"onSelect","type":"Code","optional":true,"default":"{}","description":"executed upon selecting a class. **Must return String**, which will be shown as structured text instead of params. Currently evaluated config is passed in the `_this` variable.","type_expr":"Code","text":"onSelect: Code - (Optional, default {}) executed upon selecting a class. **Must return String**, which will be shown as structured text instead of params. Currently evaluated config is passed in the `_this` variable."},{"name":"onAdd","type":"Code","optional":true,"default":"{}","description":"executed upon adding a class to list. Returned value (STRING) is item text. Empty string will skip the item. Currently evaluated config is passed in the `_this` variable.","type_expr":"Code","text":"onAdd: Code - (Optional, default {}) executed upon adding a class to list. Returned value (STRING) is item text. Empty string will skip the item. Currently evaluated config is passed in the `_this` variable."},{"name":"header","type":"String","optional":true,"default":"\"%1\"","description":"custom header. Use %1 to refer to original name (\"Splendid Config Viewer\")","type_expr":"String","text":"header: String - (Optional, default \"%1\") custom header. Use %1 to refer to original name (\"Splendid Config Viewer\")"}],"returns":{"type":"Array","type_expr":"Array","description":"- When OK button is not displayed, empty array is returned - Else, an array of currently selected entries in format [class (Config), param (String)] is returned.","text":"Array\n\n- When OK button is not displayed, empty array is returned\n- Else, an array of currently selected entries in format [class (Config), param (String)] is returned."}}],"examples":[{"code":["call BIS_fnc_configViewer;"]},{"text":"```sqf\nprivate _return = [\n    nil,\n    configFile >> \"CfgWeapons\",\n    true,\n    nil,\n    {\n        params [\"_cfg\"];\n        if (\n            getNumber(_cfg >> \"scope\") == 2 &&\n            { // Layzy evaluation\n                getNumber(_cfg >> \"type\") in [1,2,4] && // primary, secondary, handgun weapons\n                { !isClass (_cfg >> \"LinkedItems\") or getText(_cfg >> \"baseWeapon\") == configName _cfg } // only base weapons, no accessories\n            }\n        ) exitWith {\n            [_cfg] call BIS_fnc_displayName; // add the weapon with its displayname\n        };\n        \"\" // don't add\n    },\n    \"Select Weapon\"\n] call BIS_fnc_configViewer;\n_cfgSelected = _return param [0, configNull];\nsystemChat str [configName _cfgSelected, _cfgSelected];\n```","code":["private _return = [\n\tnil,\n\tconfigFile >> \"CfgWeapons\",\n\ttrue,\n\tnil,\n\t{\n\t\tparams [\"_cfg\"];\n\t\tif (\n\t\t\tgetNumber(_cfg >> \"scope\") == 2 &&\n\t\t\t{ // Layzy evaluation\n\t\t\t\tgetNumber(_cfg >> \"type\") in [1,2,4] && // primary, secondary, handgun weapons\n\t\t\t\t{ !isClass (_cfg >> \"LinkedItems\") or getText(_cfg >> \"baseWeapon\") == configName _cfg } // only base weapons, no accessories\n\t\t\t}\n\t\t) exitWith {\n\t\t\t[_cfg] call BIS_fnc_displayName; // add the weapon with its displayname\n\t\t};\n\t\t\"\" // don't add\n\t},\n\t\"Select Weapon\"\n] call BIS_fnc_configViewer;\n_cfgSelected = _return param [0, configNull];\nsystemChat str [configName _cfgSelected, _cfgSelected];"]}],"see_also":["BIS_fnc_animViewer","BIS_fnc_help"]},{"name":"BIS_fnc_consolidateArray","title":"BIS fnc consolidateArray","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_consolidateArray","revid":327950,"updated":"2022-07-13T12:58:05Z","groups":["Arrays"],"status":"ok","games":{"arma3":"0.76"},"since":"arma3 0.76","arma3_since":"0.76","description":"Finds duplicates in the given array of anything and consolidates them into an array of sub-arrays","syntaxes":[{"syntax":"array call BIS_fnc_consolidateArray","params":[{"name":"array","type":"Array","description":"array of anything","type_expr":"Array"}],"returns":{"type":"Array","type_expr":"Array","description":"array of sub-arrays in format [[value, count],...], where:\n- value: Anything - consolidated element - count: Number - occurrence count","text":"Array - array of sub-arrays in format [[value, count],...], where:\n\n- value: Anything - consolidated element\n- count: Number - occurrence count"}}],"examples":[{"code":["[\"apple\",\"apple\",\"pear\",\"pear\",\"apple\"] call BIS_fnc_consolidateArray; // return: [[\"apple\",3],[\"pear\",2]]"]},{"code":["[\"apple\",\"apple\",1,1,nil,nil] call BIS_fnc_consolidateArray; // return: [[\"apple\",2],[1,2],[any,2]]"]}]},{"name":"BIS_fnc_controlConfigs","title":"BIS fnc controlConfigs","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_controlConfigs","revid":364047,"updated":"2024-04-30T11:36:54Z","groups":["GUI","Configs"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Return config paths to all display controls.","syntaxes":[{"syntax":"[display, path] call BIS_fnc_controlConfigs","params":[{"name":"display","type":"Display","type_expr":"Display"},{"name":"path","type":"Config","description":"root display config path","type_expr":"Config"}],"returns":{"type":"Array","type_expr":"Array","description":"in format [[control1, configpath1], [control2, configpath2], ..., [controlN, configpathN]]","text":"Array in format [[control1, configpath1], [control2, configpath2], ..., [controlN, configpathN]]"}}],"examples":[{"code":["[findDisplay 313, configFile >> \"Display3DEN\"] call BIS_fnc_controlConfigs;"]}],"see_also":["findDisplay"]},{"name":"BIS_fnc_controlPoint_compute","title":"BIS fnc controlPoint compute","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_controlPoint_compute","revid":349198,"updated":"2023-11-08T14:50:41Z","groups":["ControlPoint"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Computes data for control point.","syntaxes":[{"syntax":"[controlPoint] call BIS_fnc_controlPoint_compute","params":[{"name":"controlPoint","type":"Object","description":"the control point","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[controlPoint] call BIS_fnc_controlPoint_compute;"]}],"see_also":["BIS_fnc_controlPoint_isArrive","BIS_fnc_controlPoint_computeOwnerKey","BIS_fnc_controlPoint_getOwnerKey","BIS_fnc_controlPoint_setIsArrive"]},{"name":"BIS_fnc_controlPoint_computeOwnerKey","title":"BIS fnc controlPoint computeOwnerKey","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_controlPoint_computeOwnerKey","revid":348614,"updated":"2023-11-08T13:45:21Z","groups":["ControlPoint"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Returns the key owner of given control point.","syntaxes":[{"syntax":"[controlPoint] call BIS_fnc_controlPoint_computeOwnerKey","params":[{"name":"controlPoint","type":"Object","description":"the control point","type_expr":"Object"}],"returns":{"type":"Object","type_expr":"Object","description":"the owner key"}}],"examples":[{"code":["private _key = [controlPoint] call BIS_fnc_controlPoint_computeOwnerKey;"]}],"see_also":["BIS_fnc_controlPoint_isArrive","BIS_fnc_controlPoint_compute","BIS_fnc_controlPoint_getOwnerKey","BIS_fnc_controlPoint_setIsArrive"]},{"name":"BIS_fnc_controlPoint_edenAttributesChanged","title":"BIS fnc controlPoint edenAttributesChanged","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_controlPoint_edenAttributesChanged","revid":274132,"updated":"2021-06-13T01:17:06Z","groups":["ControlPoint3DEN"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Attributes change in EDEN for a control point","syntaxes":[{"syntax":"[] call BIS_fnc_controlPoint_edenAttributesChanged","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The control point","text":"0: Object    - The control point","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nAttributes change in EDEN for a control point\n\nParameter(s):\n_this select 0: Object    - The control point\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_controlPoint_edenConnectionChanged","title":"BIS fnc controlPoint edenConnectionChanged","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_controlPoint_edenConnectionChanged","revid":274070,"updated":"2021-06-13T01:16:10Z","groups":["ControlPoint3DEN"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"3DEN connections of a control point is changed","syntaxes":[{"syntax":"[] call BIS_fnc_controlPoint_edenConnectionChanged","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The control point","text":"0: Object    - The control point","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\n3DEN connections of a control point is changed\n\nParameter(s):\n_this select 0: Object    - The control point\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_controlPoint_edenDragged","title":"BIS fnc controlPoint edenDragged","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_controlPoint_edenDragged","revid":274071,"updated":"2021-06-13T01:16:12Z","groups":["ControlPoint3DEN"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Entity is dragged in 3DEN","syntaxes":[{"syntax":"[] call BIS_fnc_controlPoint_edenDragged","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The control point","text":"0: Object    - The control point","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nEntity is dragged in 3DEN\n\nParameter(s):\n_this select 0: Object    - The control point\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_controlPoint_edenIsSelected","title":"BIS fnc controlPoint edenIsSelected","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_controlPoint_edenIsSelected","revid":274128,"updated":"2021-06-13T01:17:04Z","groups":["ControlPoint3DEN"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Whether given control point is selected in 3den","syntaxes":[{"syntax":"[] call BIS_fnc_controlPoint_edenIsSelected","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The control point object","text":"0: Object    - The control point object","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"True if selected, false if not","text":"Bool - True if selected, false if not","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nWhether given control point is selected in 3den\n\nParameter(s):\n_this select 0: Object    - The control point object\n\nReturns:\nBool - True if selected, false if not","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_controlPoint_edenRegisteredToWorld","title":"BIS fnc controlPoint edenRegisteredToWorld","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_controlPoint_edenRegisteredToWorld","revid":274129,"updated":"2021-06-13T01:17:06Z","groups":["ControlPoint3DEN"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Attributes change in EDEN for a control point","syntaxes":[{"syntax":"[] call BIS_fnc_controlPoint_edenRegisteredToWorld","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The control point","text":"0: Object    - The control point","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nAttributes change in EDEN for a control point\n\nParameter(s):\n_this select 0: Object    - The control point\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_controlPoint_edenUnregisteredFromWorld","title":"BIS fnc controlPoint edenUnregisteredFromWorld","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_controlPoint_edenUnregisteredFromWorld","revid":274005,"updated":"2021-06-13T01:15:01Z","groups":["ControlPoint3DEN"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Attributes change in EDEN for a control point","syntaxes":[{"syntax":"[] call BIS_fnc_controlPoint_edenUnregisteredFromWorld","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The control point","text":"0: Object    - The control point","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nAttributes change in EDEN for a control point\n\nParameter(s):\n_this select 0: Object    - The control point\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_controlPoint_getOwnerKey","title":"BIS fnc controlPoint getOwnerKey","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_controlPoint_getOwnerKey","revid":348611,"updated":"2023-11-08T13:45:20Z","groups":["ControlPoint"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Returns the key owner of given control point.","syntaxes":[{"syntax":"[controlPoint] call BIS_fnc_controlPoint_getOwnerKey","params":[{"name":"controlPoint","type":"Object","description":"the control point","type_expr":"Object"}],"returns":{"type":"Object","type_expr":"Object","description":"the key"}}],"examples":[{"code":["private _key = [controlPoint] call BIS_fnc_controlPoint_getOwnerKey;"]}],"see_also":["BIS_fnc_controlPoint_isArrive","BIS_fnc_controlPoint_compute","BIS_fnc_controlPoint_computeOwnerKey","BIS_fnc_controlPoint_setIsArrive"]},{"name":"BIS_fnc_controlPoint_isArrive","title":"BIS fnc controlPoint isArrive","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_controlPoint_isArrive","revid":349268,"updated":"2023-11-08T14:51:09Z","groups":["ControlPoint"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Whether given control point is arrive, not leave.","syntaxes":[{"syntax":"[controlPoint] call BIS_fnc_controlPoint_isArrive","params":[{"name":"controlPoint","type":"Object","description":"the control point","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"returns true if control point is arrive, false if leave"}}],"examples":[{"code":["private _isArrive = [controlPoint] call BIS_fnc_controlPoint_isArrive;"]}],"see_also":["BIS_fnc_controlPoint_compute","BIS_fnc_controlPoint_computeOwnerKey","BIS_fnc_controlPoint_getOwnerKey","BIS_fnc_controlPoint_setIsArrive"]},{"name":"BIS_fnc_controlPoint_setIsArrive","title":"BIS fnc controlPoint setIsArrive","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_controlPoint_setIsArrive","revid":349230,"updated":"2023-11-08T14:50:53Z","groups":["ControlPoint"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Set's whether this control point is arrive or leave.","syntaxes":[{"syntax":"[controlPoint, isArrive] call BIS_fnc_controlPoint_setIsArrive","params":[{"name":"controlPoint","type":"Object","description":"the control point","type_expr":"Object"},{"name":"isArrive","type":"Object","optional":true,"default":"true","description":"true - arrive\nfalse - leave","type_expr":"Object","text":"isArrive: Object - (Optional, default true) true - arrive\nfalse - leave"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[controlPoint,false] call BIS_fnc_controlPoint_setIsArrive;"]}],"see_also":["BIS_fnc_controlPoint_isArrive","BIS_fnc_controlPoint_compute","BIS_fnc_controlPoint_computeOwnerKey","BIS_fnc_controlPoint_getOwnerKey"]},{"name":"BIS_fnc_convertUnits","title":"BIS fnc convertUnits","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_convertUnits","revid":370880,"updated":"2025-02-21T10:44:03Z","groups":["Math"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Converts values to a target system of units.","syntaxes":[{"syntax":"[value, from, to, mode, precision] call BIS_fnc_convertUnits","params":[{"name":"value","type":"Number","description":"source value","type_expr":"Number"},{"name":"from","type":"Number","description":"source unit. Can be one of:\n\n- 0: m (meters)\n- 1: km (kilometers)\n- 2: ms (meters per second)\n- 3: kmh (kilometers per hour)\n- 4: ft (feet)\n- 5: mi (miles)\n- 6: fts (feet per second)\n- 7: mph (miles per hour)\n- 8: nm (nautical miles)\n- 9: kts (knots)","type_expr":"Number"},{"name":"to","type":"Number","optional":true,"default":"detected system of units via systemOfUnits","description":"destination unit. See *from*.","type_expr":"Number","text":"to: Number - (Optional, default detected system of units via systemOfUnits) destination unit. See *from*."},{"name":"mode","type":"Number","optional":true,"default":"0","description":"can be one of:\n\n- 0: destination value (Scalar)\n- 1: destination text long (String) e.g \"5 meters\"\n- 2: destination text short (String) e.g \"5 m\"","type_expr":"Number","text":"mode: Number - (Optional, default 0) can be one of:\n\n- 0: destination value (Scalar)\n- 1: destination text long (String) e.g \"5 meters\"\n- 2: destination text short (String) e.g \"5 m\""},{"name":"precision","type":"Number","optional":true,"default":"1","description":"destination precision factor, -1 for no precision change. **cannot be 0**","type_expr":"Number","text":"precision: Number - (Optional, default 1) destination precision factor, -1 for no precision change. **cannot be 0**"}],"returns":{"type":"Number or String","type_expr":"Number | String","description":"converted value"}}],"examples":[{"code":["private _distString = [500, 0, 5, 1, -1] call BIS_fnc_convertUnits;"]}],"see_also":["systemOfUnits"]},{"name":"BIS_fnc_countdown","title":"BIS fnc countdown","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_countdown","revid":378252,"updated":"2026-03-25T14:24:56Z","groups":["Missions"],"status":"ok","games":{"arma3":"1.02"},"since":"arma3 1.02","arma3_since":"1.02","description":"Triggers a countdown.\n\n> [!NOTE]\n> The **initial** countdown can be accessed via missionNamespace's variable **BIS_fnc_countdown_time**.\n>\n> The initial value is either `serverTime + timeInSeconds` (if set globally) or `time + timeInSeconds` (if set locally).\n>\n> To return the left-over time see Example 4.","syntaxes":[{"syntax":"[timeInSeconds, global] call BIS_fnc_countdown","params":[{"name":"timeInSeconds","type":"Number or Boolean:","description":"Number or Boolean:\n\n- Number:\n  - Any number to set the length of the countdown in seconds\n  - -1 to set the countdown to nil\n  - 0 to return the left-over time\n- Boolean:\n  - true to find out if countdown is active and if there is left-over time","type_expr":"Number | Boolean","text":"timeInSeconds: Number or Boolean:\n\n- Number:\n  - Any number to set the length of the countdown in seconds\n  - -1 to set the countdown to nil\n  - 0 to return the left-over time\n- Boolean:\n  - true to find out if countdown is active and if there is left-over time"},{"name":"global","type":"Boolean","optional":true,"default":"true","description":"true to set it globally, false to set it locally","type_expr":"Boolean","text":"global: Boolean - (Optional, default true) true to set it globally, false to set it locally"}],"returns":{"type_expr":"Number | Boolean","description":"- Number: - If set locally: time + timeInSeconds (see Example 1) - If set globally: serverTime + timeInSeconds (see Example 2) - Returns -1 if countdown is set to nil (see Example 3) - Return left-over time (see Example 4) - Boolean: returns true when countdown is > 0 else false (see Example 5)","text":"- Number:\n  - If set locally: time + timeInSeconds (see Example 1)\n  - If set globally: serverTime + timeInSeconds (see Example 2)\n  - Returns -1 if countdown is set to nil (see Example 3)\n  - Return left-over time (see Example 4)\n- Boolean: returns true when countdown is > 0 else false (see Example 5)"}}],"examples":[{"code":["private _initialCountdown = [50, false] call BIS_fnc_countdown; // sets countdown to 50 seconds where function is executed"]},{"code":["private _initialCountdown = [50] call BIS_fnc_countdown; // sets countdown to 50 seconds globally"]},{"code":["[-1] call BIS_fnc_countdown; // sets BIS_fnc_countdown_time to nil"]},{"code":["private _timeLeft = [0] call BIS_fnc_countdown; // returns the left over-time"]},{"code":["private _isTimeLeft = [true] call BIS_fnc_countdown; // returns true if countdown is greater than 0"]}],"see_also":["BIS_fnc_VRTimer"]},{"name":"BIS_fnc_counter","title":"BIS fnc counter","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_counter","revid":363648,"updated":"2024-04-11T15:43:06Z","groups":["Systems"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","locality":{"argument":"global","effect":"local"},"description":"Modify the given counter, create it if does not exist.\n\n> [!IMPORTANT]\n> It is **not** possible to broadcast the counter (like setVariable does) with this function.","syntaxes":[{"syntax":"[varName, add, modulo] call BIS_fnc_counter","params":[{"name":"varName","type":"String or Array format [varName, namespace]","description":"default namespace is missionNamespace","type_expr":"String | Array"},{"name":"add","type":"Number","optional":true,"default":"0","description":"the value to be added","type_expr":"Number","text":"add: Number - (Optional, default 0) the value to be added"},{"name":"modulo","type":"Number","optional":true,"default":"-1","description":"the modulo to use for counter cycle, applied after the addition","type_expr":"Number","text":"modulo: Number - (Optional, default -1) the modulo to use for counter cycle, applied after the addition"}],"returns":{"type":"Number","type_expr":"Number","description":"the new counter value","text":"Number the new counter value"}}],"examples":[{"code":["[[\"TAG_Score\", player], 1] call BIS_fnc_counter;"]}],"see_also":["BIS_fnc_deleteCounter"]},{"name":"BIS_fnc_CPDummy","title":"BIS fnc CPDummy","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_CPDummy","revid":274126,"updated":"2021-06-13T01:17:00Z","groups":["CombatPatrol"],"status":"ok","games":{"arma3":"1.72"},"since":"arma3 1.72","arma3_since":"1.72","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_CPDummy","params":[],"returns":null}]},{"name":"BIS_fnc_CPFindEmptyPosition","title":"BIS fnc CPFindEmptyPosition","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_CPFindEmptyPosition","revid":273902,"updated":"2021-06-13T01:13:06Z","groups":["CombatPatrol"],"status":"ok","games":{"arma3":"1.72"},"since":"arma3 1.72","arma3_since":"1.72","description":"Combat Patrol empty position locator","syntaxes":[{"syntax":"[] call BIS_fnc_CPFindEmptyPosition","params":[],"returns":null}],"docblock":{"text":"Author: Josef Zemanek\n\nDescription:\nCombat Patrol empty position locator","author":"Josef Zemanek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_CPInit","title":"BIS fnc CPInit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_CPInit","revid":274041,"updated":"2021-06-13T01:15:41Z","groups":["CombatPatrol"],"status":"ok","games":{"arma3":"1.72"},"since":"arma3 1.72","arma3_since":"1.72","description":"Combat Patrol init & general handle","syntaxes":[{"syntax":"[] call BIS_fnc_CPInit","params":[],"returns":null}],"docblock":{"text":"Author: Josef Zemanek\n\nDescription:\nCombat Patrol init & general handle","author":"Josef Zemanek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_CPLog","title":"BIS fnc CPLog","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_CPLog","revid":273946,"updated":"2021-06-13T01:13:58Z","groups":["CombatPatrol"],"status":"ok","games":{"arma3":"1.72"},"since":"arma3 1.72","arma3_since":"1.72","description":"Combat Patrol dedicated logging fnc","syntaxes":[{"syntax":"[] call BIS_fnc_CPLog","params":[],"returns":null}],"docblock":{"text":"Author: Josef Zemanek\n\nDescription:\nCombat Patrol dedicated logging fnc","author":"Josef Zemanek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_CPPickSafeDir","title":"BIS fnc CPPickSafeDir","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_CPPickSafeDir","revid":274099,"updated":"2021-06-13T01:16:36Z","groups":["CombatPatrol"],"status":"ok","games":{"arma3":"1.72"},"since":"arma3 1.72","arma3_since":"1.72","description":"Combat Patrol safe azimuth picker.","syntaxes":[{"syntax":"[] call BIS_fnc_CPPickSafeDir","params":[],"returns":null}],"docblock":{"text":"Author: Josef Zemanek\n\nDescription:\nCombat Patrol safe azimuth picker.","author":"Josef Zemanek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_CPSafeAzimuths","title":"BIS fnc CPSafeAzimuths","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_CPSafeAzimuths","revid":273963,"updated":"2021-06-13T01:14:14Z","groups":["CombatPatrol"],"status":"ok","games":{"arma3":"1.72"},"since":"arma3 1.72","arma3_since":"1.72","description":"Combat Patrol safe azimuth finder. Scans around the AO for usable & convenient approach routes","syntaxes":[{"syntax":"[] call BIS_fnc_CPSafeAzimuths","params":[],"returns":null}],"docblock":{"text":"Author: Josef Zemanek\n\nDescription:\nCombat Patrol safe azimuth finder. Scans around the AO for usable & convenient approach routes","author":"Josef Zemanek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_CPSendReinforcements","title":"BIS fnc CPSendReinforcements","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_CPSendReinforcements","revid":274105,"updated":"2021-06-13T01:16:41Z","groups":["CombatPatrol"],"status":"ok","games":{"arma3":"1.72"},"since":"arma3 1.72","arma3_since":"1.72","description":"Combat Patrol reinforcements handle","syntaxes":[{"syntax":"[] call BIS_fnc_CPSendReinforcements","params":[],"returns":null}],"docblock":{"text":"Author: Josef Zemanek\n\nDescription:\nCombat Patrol reinforcements handle","author":"Josef Zemanek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_CPSpawnGarrisonGrp","title":"BIS fnc CPSpawnGarrisonGrp","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_CPSpawnGarrisonGrp","revid":273986,"updated":"2021-06-13T01:14:37Z","groups":["CombatPatrol"],"status":"ok","games":{"arma3":"1.72"},"since":"arma3 1.72","arma3_since":"1.72","description":"Combat Patrol garrison spawning","syntaxes":[{"syntax":"[] call BIS_fnc_CPSpawnGarrisonGrp","params":[],"returns":null}],"docblock":{"text":"Author: Josef Zemanek\n\nDescription:\nCombat Patrol garrison spawning","author":"Josef Zemanek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_CPWaitUntil","title":"BIS fnc CPWaitUntil","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_CPWaitUntil","revid":348068,"updated":"2023-11-08T11:29:53Z","groups":["CombatPatrol","Program Flow"],"status":"ok","games":{"arma3":"1.72"},"since":"arma3 1.72","arma3_since":"1.72","exec":"spawn","description":"Function waits until condition becomes true. Condition is checked with given interval.","syntaxes":[{"syntax":"[condition, interval] spawn BIS_fnc_CPWaitUntil","params":[{"name":"condition","type":"Code","optional":true,"default":"`{ true }`","description":"condition to be checked","type_expr":"Code","text":"condition: Code - (Optional, default `{ true }`) condition to be checked"},{"name":"interval","type":"Number","optional":true,"default":"0.5","description":"interval in which the condition will be checked","type_expr":"Number","text":"interval: Number - (Optional, default 0.5) interval in which the condition will be checked"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[{ not alive player }, 2] spawn BIS_fnc_CPWaitUntil;"]}],"see_also":["waitUntil"]},{"name":"BIS_fnc_createLogRecord","title":"BIS fnc createLogRecord","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_createLogRecord","revid":328379,"updated":"2022-07-13T16:00:48Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"local","effect":"local"},"description":"Create a dated, timed diary record in the owner's \"Log\" subject.","syntaxes":[{"syntax":"[owner, title, text] call BIS_fnc_createLogRecord","params":[{"name":"owner","type":"Object","type_expr":"Object"},{"name":"title","type":"String","optional":true,"default":"\"\"","type_expr":"String","text":"title: String - (Optional, default \"\")"},{"name":"text","type":"String","optional":true,"default":"\"\"","type_expr":"String","text":"text: String - (Optional, default \"\")"}],"returns":{"type":"String","type_expr":"String"}}],"examples":[{"code":["[player, \"Title\", \"This is a log entry. Have fun!\"] call BIS_fnc_createLogRecord;"]}],"see_also":["createDiaryRecord"]},{"name":"BIS_fnc_createMenu","title":"BIS fnc createMenu","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_createMenu","revid":376525,"updated":"2025-10-23T22:37:32Z","groups":["Communication Menu"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Create custom commanding menu (with multiple pages if necessary).","syntaxes":[{"syntax":"[namePath, variable, itemDetails, subMenu, codeStr, parameters, showKey] call BIS_fnc_createMenu","params":[{"name":"namePath","type":"String or Array","description":"can be one of:\n\n- String - menu name\n- Array - format [menuName, context]","type_expr":"String | Array"},{"name":"variable","type":"String","description":"variable in which will be menu params stored (as `variable_0`, `variable_1` etc)","type_expr":"String"},{"name":"itemDetails","type":"Array","description":"menu items, format can be one of:\n\n- [items]\n- [[items], [itemNames], [itemEnable]] if custom parameters are to be set (names, enable values)","type_expr":"Array"},{"name":"subMenu","type":"String","description":"name of the submenu which will open when item is activated. Name of the selected item is passed to string as `%1`","type_expr":"String"},{"name":"codeStr","type":"String","description":"expression which is executed when *item* is activated; item's name is passed to string as `%1`, ID as `%2`, *parameters* (below) as `%3`","type_expr":"String"},{"name":"parameters","type":"Anything","optional":true,"description":"passed to *codeStr* as `%3`","type_expr":"Anything","text":"parameters: Anything - (Optional) passed to *codeStr* as `%3`"},{"name":"showKey","type":"Boolean","optional":true,"default":"true","description":"false to hide number shortcuts","type_expr":"Boolean","text":"showKey: Boolean - (Optional, default true) false to hide number shortcuts"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"always true"}}],"examples":[{"code":["[\"Menu\", \"b\", [\"first\", \"second\"], \"\",\"hint 'ahoj'\"] call BIS_fnc_createMenu;\nshowCommandingMenu \"#USER:b_0\";"]},{"code":["private _itemDetails = [[\"firstData\", \"secondData\"], [\"First\", \"Second\"]];\n[\"Menu\", \"b\", _itemDetails, \"\", \"hint (str '%1' + str '%2' + str '%3')\"] call BIS_fnc_createMenu;\nshowCommandingMenu \"#USER:b_0\";"]}],"see_also":["Conversations"]},{"name":"BIS_fnc_createObjectOO","title":"BIS fnc createObjectOO","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_createObjectOO","revid":349495,"updated":"2023-11-08T17:09:09Z","groups":["OO"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Instantiates an object of a certain class.","syntaxes":[{"syntax":"[class,params] call BIS_fnc_createObjectOO","params":[{"name":"class","type":"String","description":"class for the OO scripting shell\n\n> [!IMPORTANT]\n> Class has to exist in CfgOO","type_expr":"String"},{"name":"params","type":"Array","optional":true,"default":"`[]`","description":"optional parameters for constructor","type_expr":"Array","text":"params: Array - (Optional, default `[]`) optional parameters for constructor"}],"returns":{"type":"Logic","type_expr":"Logic","description":"created logic object"}}],"examples":[{"code":["[\"someOOClass\", [1,2,3]] call BIS_fnc_createObjectOO;"]}],"see_also":["BIS_fnc_addClassOO","BIS_fnc_validateParametersOO"]},{"name":"BIS_fnc_createRuin","title":"BIS fnc createRuin","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_createRuin","revid":347313,"updated":"2023-09-10T15:21:43Z","groups":["Environment"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Create a building ruin and hide the original object.","syntaxes":[{"syntax":"building call BIS_fnc_createRuin","params":[{"name":"building","type":"Object","description":"building to \"destroy\"","type_expr":"Object"}],"returns":{"type":"Object","type_expr":"Object","description":"the created ruin"}}],"examples":[{"code":["aBuilding call BIS_fnc_createRuin;"]},{"code":["// will destroy every building in a 50m radius around the player\nprivate _nearBuildings = player nearObjects [\"House\", 50];\n{ _x call BIS_fnc_createRuin } forEach _nearBuildings;"]}],"see_also":["setDamage"],"notes":[{"user":"Beno_83au","date":"2019-06-01T13:14:00Z","text":"In MP this function doesn't hide the building globally, so other clients will see both the original building *AND* the newly created ruined building - <https://feedback.bistudio.com/T140045>.\nTo get around this I've been hiding the object manually on all other clients:\n\n```sqf\n_building call BIS_fnc_createRuin;\n[_building, true] remoteExecCall [\"hideObject\", -clientOwner];\n```\n\nThis will run hideObject on all other clients besides the client (or server) that this was executed from."}]},{"name":"BIS_fnc_createSimpleObject","title":"BIS fnc createSimpleObject","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_createSimpleObject","revid":352418,"updated":"2024-02-09T15:26:08Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Creates non-simulated framerate and network performance friendly object - a Simple Object - and applies different adjustments to fake non-existing physX and engine interactions. The adjustments need either to be stored in the object config or provided as the function input, otherwise they need to be done manually.\n\nSimple objects cannot be destroyed and do not interact with the environment. They are useful for creating low performance-demanding static compositions (walls, rocks, wrecks, …) and/or environments where shooting and collisions are not expected.","syntaxes":[{"syntax":"[input, position, direction, followTerrain, forceSuperSimpleObject, local] call BIS_fnc_createSimpleObject","params":[{"name":"input","type":"String or Array:","description":"String or Array:\n\n- String: classname of the object to be created. This is the preferred way if the asset config definition contains the adjustment data or the data are not needed (most objects do not need adjustments).\n- Array: adjustment data in format [class, model, reversed, verticalOffset, animationAdjustments, selectionsToHide]:\n  - class: String - (Optional, default \"\") asset CfgVehicles config class (**at least either *model* or *class* must be provided, ideally both**)\n  - model: String - (Optional, default \"\") Path to the vehicle p3d model; needs to start without backslash and must end with the proper file extension \".p3d\"\n  - reversed: Number - (Optional, default 0) some objects, usually vehicles, are reversed in p3d; valid values are:\n    - 1: reverse\n    - 0: no change - any value other than 1 will result in no change\n  - verticalOffset: Number - (Optional, default 0) fix for non-existant physX; usually needed only for vehicles\n  - animationAdjustments: Array - (Optional, default `[]`) animation that need to be animated to given state, in format [animationName, animationState]:\n    - animationName: String - animation name\n    - animationState: Number - animation state\n  - selectionsToHide: Array - (Optional, default `[]`) all listed selections will be hidden","type_expr":"String | Array","text":"input: String or Array:\n\n- String: classname of the object to be created. This is the preferred way if the asset config definition contains the adjustment data or the data are not needed (most objects do not need adjustments).\n- Array: adjustment data in format [class, model, reversed, verticalOffset, animationAdjustments, selectionsToHide]:\n  - class: String - (Optional, default \"\") asset CfgVehicles config class (**at least either *model* or *class* must be provided, ideally both**)\n  - model: String - (Optional, default \"\") Path to the vehicle p3d model; needs to start without backslash and must end with the proper file extension \".p3d\"\n  - reversed: Number - (Optional, default 0) some objects, usually vehicles, are reversed in p3d; valid values are:\n    - 1: reverse\n    - 0: no change - any value other than 1 will result in no change\n  - verticalOffset: Number - (Optional, default 0) fix for non-existant physX; usually needed only for vehicles\n  - animationAdjustments: Array - (Optional, default `[]`) animation that need to be animated to given state, in format [animationName, animationState]:\n    - animationName: String - animation name\n    - animationState: Number - animation state\n  - selectionsToHide: Array - (Optional, default `[]`) all listed selections will be hidden"},{"name":"position","type":"Array format PositionASL","description":"the object will be placed by the **model centre**'s position (see getPosWorld)","type_expr":"PositionASL","types":["Array","PositionASL"]},{"name":"direction","type":"Number","optional":true,"default":"0","type_expr":"Number","text":"direction: Number - (Optional, default 0)"},{"name":"followTerrain","type":"Boolean","optional":true,"default":"true","description":"true to follow terrain inclination, false to be horizontally aligned","type_expr":"Boolean","text":"followTerrain: Boolean - (Optional, default true) true to follow terrain inclination, false to be horizontally aligned"},{"name":"forceSuperSimpleObject","type":"Boolean","optional":true,"default":"false","description":"true to create a **Super Simple Object** from p3d path (that **must** be provided)","type_expr":"Boolean","text":"forceSuperSimpleObject: Boolean - (Optional, default false) true to create a **Super Simple Object** from p3d path (that **must** be provided)"},{"name":"local","type":"Boolean","optional":true,"default":"false","description":"true to create local instance of the object","type_expr":"Boolean","since":"arma3 2.08","text":"local: Boolean - (Optional, default false) true to create local instance of the object"}],"returns":{"type":"Object","type_expr":"Object","description":"the created Simple Object, objNull if creation failed"}}],"examples":[{"code":["[\"B_Boat_Armed_01_minigun_F\", getPosWorld player, getDir player] call BIS_fnc_createSimpleObject;"]},{"code":["[\"B_Boat_Armed_01_minigun_F\", player modelToWorldWorld [0,5,0], getDir player + 90, false, false] call BIS_fnc_createSimpleObject;"]}],"see_also":["Arma 3: Simple Objects","createSimpleObject","BIS_fnc_adjustSimpleObject","BIS_fnc_replaceWithSimpleObject","BIS_fnc_simpleObjectData","getPosWorld","setPosWorld"]},{"name":"BIS_fnc_createTooltip","title":"BIS fnc createTooltip","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_createTooltip","revid":352466,"updated":"2024-02-11T23:22:48Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Shows group tooltip. Adapted for Tac Ops DLC for use in the animated briefings.","syntaxes":[{"syntax":"[input, display, mousePos] call BIS_fnc_createTooltip","params":[{"name":"input","type":"Array format [config, parameters]:","description":"Array format [config, parameters]:\n\n- config: Config - group from CfgORBAT\n- parameters: Array - group params returned by BIS_fnc_ORBATGetGroupParams","type_expr":"Array","text":"input: Array format [config, parameters]:\n\n- config: Config - group from CfgORBAT\n- parameters: Array - group params returned by BIS_fnc_ORBATGetGroupParams"},{"name":"display","type":"Display","description":"display where tooltip controls group is created","type_expr":"Display"},{"name":"mousePos","type":"Array","description":"mouse position in format [x, y]","type_expr":"Array"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"text":"```sqf\n// enable icons in 2D and 3D\nsetGroupIconsVisible [true, true];\nsetGroupIconsSelectable true;\n\n// add the icon for all existing groups\nprivate _group = group player;\nprivate _color = [side _group, false] call BIS_fnc_sideColor;\n_group addGroupIcon [\"o_inf\", [0, 0]];\n_group setGroupIconParams [_color, groupID _group, 1, true];\n\n// show tooltip when hovering over group icon of player group\naddMissionEventHandler [\"GroupIconOverEnter\",\n{\n    [configFile >> \"CfgORBAT\" >> \"BIS\" >> \"I_AAF\", findDisplay 12, getMousePosition] call BIS_fnc_createTooltip;\n}];\n\n// remove tooltip when leaving group icon area\naddMissionEventHandler [\"GroupIconOverLeave\",\n{\n    [nil, findDisplay 12, getMousePosition] call BIS_fnc_createTooltip;\n}];\n```","code":["// enable icons in 2D and 3D\nsetGroupIconsVisible [true, true];\nsetGroupIconsSelectable true;\n\n// add the icon for all existing groups\nprivate _group = group player;\nprivate _color = [side _group, false] call BIS_fnc_sideColor;\n_group addGroupIcon [\"o_inf\", [0, 0]];\n_group setGroupIconParams [_color, groupID _group, 1, true];\n\n// show tooltip when hovering over group icon of player group\naddMissionEventHandler [\"GroupIconOverEnter\",\n{\n\t[configFile >> \"CfgORBAT\" >> \"BIS\" >> \"I_AAF\", findDisplay 12, getMousePosition] call BIS_fnc_createTooltip;\n}];\n\n// remove tooltip when leaving group icon area\naddMissionEventHandler [\"GroupIconOverLeave\",\n{\n\t[nil, findDisplay 12, getMousePosition] call BIS_fnc_createTooltip;\n}];"]},{"text":"```sqf\nprivate _marker = createMarker [\"marker_0\", [worldSize / 2, worldSize / 2]];\n_marker setMarkerType \"flag_Germany\";\n_marker setMarkerText \"GERMANY\";\n\n_marker = createMarker [\"marker_1\", [worldSize / 1.5, worldSize / 1.5]];\n_marker setMarkerType \"flag_Altis\";\n_marker setMarkerText \"ALTIS\";\n\nfindDisplay 12 displayCtrl 51 ctrlAddEventHandler\n[\n    \"draw\",\n    {\n        params [\"_ctrlMap\"];\n\n        ctrlMapMouseOver _ctrlMap params [[\"_type\", \"\"], [\"_markerName\", \"\"]];\n\n        if (_type == \"marker\") then\n        {\n            private _markerTexture = getText (configFile >> \"CfgMarkers\" >> markerType _markerName >> \"icon\");\n            private _markerText = markerText _markerName;\n\n            [[nil, nil, _markerName, nil, _markerTexture, nil, nil, nil, _markerText, nil, nil, \"Some Description\"], findDisplay 12, getMousePosition] call BIS_fnc_createTooltip;\n        }\n        else\n        {\n            [nil, findDisplay 12, getMousePosition] call BIS_fnc_createTooltip;\n        };\n    }\n];\n```","code":["private _marker = createMarker [\"marker_0\", [worldSize / 2, worldSize / 2]];\n_marker setMarkerType \"flag_Germany\";\n_marker setMarkerText \"GERMANY\";\n\n_marker = createMarker [\"marker_1\", [worldSize / 1.5, worldSize / 1.5]];\n_marker setMarkerType \"flag_Altis\";\n_marker setMarkerText \"ALTIS\";\n\nfindDisplay 12 displayCtrl 51 ctrlAddEventHandler\n[\n\t\"draw\",\n\t{\n\t\tparams [\"_ctrlMap\"];\n\n\t\tctrlMapMouseOver _ctrlMap params [[\"_type\", \"\"], [\"_markerName\", \"\"]];\n\n\t\tif (_type == \"marker\") then\n\t\t{\n\t\t\tprivate _markerTexture = getText (configFile >> \"CfgMarkers\" >> markerType _markerName >> \"icon\");\n\t\t\tprivate _markerText = markerText _markerName;\n\n\t\t\t[[nil, nil, _markerName, nil, _markerTexture, nil, nil, nil, _markerText, nil, nil, \"Some Description\"], findDisplay 12, getMousePosition] call BIS_fnc_createTooltip;\n\t\t}\n\t\telse\n\t\t{\n\t\t\t[nil, findDisplay 12, getMousePosition] call BIS_fnc_createTooltip;\n\t\t};\n\t}\n];"]}],"see_also":["BIS_fnc_ORBATGetGroupParams"]},{"name":"BIS_fnc_credits","title":"BIS fnc credits","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_credits","revid":327607,"updated":"2022-07-13T09:50:31Z","groups":["GUI"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","exec":"spawn","description":"Opens credits, identical to those found in main menu (Arma 3). Also present in Arma 3.","syntaxes":[{"syntax":"[] spawn BIS_fnc_credits","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[] spawn BIS_fnc_credits;"]}]},{"name":"BIS_fnc_credits_movie","title":"BIS fnc credits movie","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_credits_movie","revid":328530,"updated":"2022-07-13T16:47:54Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","exec":"spawn","description":"Movie credits function.","syntaxes":[{"syntax":"[display, mode] call BIS_fnc_credits_movie","params":[{"name":"display","type":"Display","optional":true,"description":"display to use to show the credits","type_expr":"Display","text":"display: Display - (Optional) display to use to show the credits"},{"name":"mode","type":"Number","optional":true,"default":"0","description":"0 to start the credits, 1 to end them","type_expr":"Number","text":"mode: Number - (Optional, default 0) 0 to start the credits, 1 to end them"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[] spawn BIS_fnc_credits_movie;"]},{"text":"Display the credits full screen:\n\n```sqf\n[] spawn {\n    disableSerialization;\n    // create credits\n    (findDisplay 46) createDisplay \"RscCredits\";\n    [] call BIS_fnc_credits_movie;\n};\n```","code":["[] spawn {\n\tdisableSerialization;\n\t// create credits\n\t(findDisplay 46) createDisplay \"RscCredits\";\n\t[] call BIS_fnc_credits_movie;\n};"]}],"see_also":["BIS_fnc_credits","BIS_fnc_credits_movieConfig","BIS_fnc_credits_movieSupport"]},{"name":"BIS_fnc_credits_movieConfig","title":"BIS fnc credits movieConfig","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_credits_movieConfig","revid":272861,"updated":"2021-06-13T00:33:51Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Movie credits config preprocessor.","syntaxes":[{"syntax":"[param0] call BIS_fnc_credits_movieConfig","params":[{"name":"param0","type":"Number","type_expr":"Number","description":"Index of item in config (CfgCredits >> CreditsMovie >> item)","text":"0: Number - Index of item in config (CfgCredits >> CreditsMovie >> item)","source":"docblock"}],"returns":{"type":"Array","type_expr":"Array","text":"_array: Array\n_array select 0: String - Position name (and tags) as structured text.\n_array select 1: String - Names (and tags) as structured text.\n_array select 2: Number - Required space coeficient (numberOfNames * textSizeCoef), -1 if config entry doesn't exist","source":"docblock"},"inferred":true}],"docblock":{"text":"File: fn_credits_movieConfig.sqf\n\nDescription:\nMovie credits config preprocessor.\n\nParameter(s):\n_this select 0: Number - Index of item in config (CfgCredits >> CreditsMovie >> item)\n\nReturned value:\n_array: Array\n_array select 0: String - Position name (and tags) as structured text.\n_array select 1: String - Names (and tags) as structured text.\n_array select 2: Number - Required space coeficient (numberOfNames * textSizeCoef), -1 if config entry doesn't exist","meta":{"file":"fn_credits_movieConfig.sqf"}},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_credits_movieSupport","title":"BIS fnc credits movieSupport","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_credits_movieSupport","revid":272860,"updated":"2021-06-13T00:33:50Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Movie credits supporters preprocessor.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Array","type_expr":"Array","text":"_array: Array\n_array select 0: String - Position name (and tags) as structured text.\n_array select 1: String - Names (and tags) as structured text - 1st paragraph.\n_array select 2: String - Names (and tags) as structured text - 2nd paragraph.\n_array select 3: String - Names (and tags) as structured text - 3rd paragraph.\n_array select 4: Number - Required space coeficient (numberOfNamesInOneParagraph * textSizeCoef)","source":"docblock"}}],"docblock":{"text":"File: fn_credits_movieSupport.sqf\n\nDescription:\nMovie credits supporters preprocessor.\n\nParameter(s):\nNone.\n\nReturned value:\n_array: Array\n_array select 0: String - Position name (and tags) as structured text.\n_array select 1: String - Names (and tags) as structured text - 1st paragraph.\n_array select 2: String - Names (and tags) as structured text - 2nd paragraph.\n_array select 3: String - Names (and tags) as structured text - 3rd paragraph.\n_array select 4: Number - Required space coeficient (numberOfNamesInOneParagraph * textSizeCoef)","meta":{"file":"fn_credits_movieSupport.sqf"}},"filled_from_docblock":["description","returns"]},{"name":"BIS_fnc_crewCount","title":"BIS fnc crewCount","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_crewCount","revid":379313,"updated":"2026-10-30T23:49:54Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.08"},"since":"arma3 1.08","arma3_since":"1.08","description":"Function that counts amount of seats, both for crew and cargo seats.","syntaxes":[{"syntax":"param call BIS_fnc_crewCount","params":[{"name":"String","description":"classname of vehicle.","type_expr":"String"},{"name":"Boolean","description":"true if cargo seats should be included (see notes)","type_expr":"Boolean"}],"returns":{"type":"Number","type_expr":"Number","description":"amount of seats in vehicle."}}],"examples":[{"code":["crewCount = [\"B_Heli_Light_01_F\", false] call BIS_fnc_crewCount; // Counts all available seats excluding cargo slots. Returns 6 (see notes)."]},{"code":["crewCount = [\"B_Heli_Transport_01_F\", true] call BIS_fnc_crewCount; // Counts all available seats including cargo slots. Returns 12."]}],"see_also":["crew"],"notes":[{"user":"Tryteyker-","date":"2014-10-01T20:12:00Z","text":"This function goes through config values and as such is dependant on these. In some instances, this can lead to weird results; the user may, for example, expect the skids on the Littlebird to be cargo slots.\nHowever, in reality, they are not and as such will be counted even if the boolean value is set to false.\n\nIf the bool value is set to true, it will return the **total** amount of seats available. To get the cargo seats only, running this function twice (once with false and once with true as bool values), and then subtracting the total with crew-only will yield the cargo (F^cargo = Ftotal - Fcrew) slots.\nCrew slots include gunners and in some instances some cargo slots. The above may not work for every vehicle."}]},{"name":"BIS_fnc_crossProduct","title":"BIS fnc crossProduct","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_crossProduct","revid":327951,"updated":"2022-07-13T12:58:34Z","groups":["Vectors"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Return the cross product of two 3D vectors.\n\n> [!NOTE]\n> **Arma 3:** Use vectorCrossProduct instead.","syntaxes":[{"syntax":"[vector1, vector2] call BIS_fnc_crossProduct","params":[{"name":"vector1","type":"Array","type_expr":"Array"},{"name":"vector2","type":"Array","type_expr":"Array"}],"returns":{"type":"Array","type_expr":"Array"}}],"examples":[{"code":["private _product = [[1,2,3], [3,2,1]] call BIS_fnc_crossProduct;"]}],"see_also":["vectorCrossProduct"]},{"name":"BIS_fnc_crows","title":"BIS fnc crows","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_crows","revid":348822,"updated":"2023-11-08T14:38:19Z","groups":["Environment"],"status":"ok","games":{"arma2oa":"1.56","tkoh":"1.00","arma3":"0.50"},"since":"arma2oa 1.56","arma3_since":"0.50","locality":{"effect":"local"},"description":"Spawns flock of crows circling the area.","syntaxes":[{"syntax":"[position, areaSize, number, height] call BIS_fnc_crows","params":[{"name":"position","type":"Array (in format position) or Object (object position) or String (marker position)","type_expr":"Array | Object | String"},{"name":"areaSize","type":"Number","optional":true,"default":"50","description":"area radius","type_expr":"Number","text":"areaSize *(Optional)*: Number - area radius - default: 50"},{"name":"number","type":"Number of crows","optional":true,"default":"areaSize/5","type_expr":"Number","text":"number *(Optional)*: Number of crows - default: areaSize/5"},{"name":"height","type":"Number","optional":true,"default":"30 + random 10","description":"height in which crows flies","type_expr":"Number","text":"height *(Optional)*: Number - height in which crows flies - default: 30 + random 10"}],"returns":{"type":"Array","type_expr":"Array","description":"list of spawned crows"}}],"examples":[{"code":["bis_crows = [BIS_scientist, 20, 8, 20] call BIS_fnc_crows;"]}],"see_also":["Functions Library"]},{"name":"BIS_fnc_ctrlFitToTextHeight","title":"BIS fnc ctrlFitToTextHeight","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_ctrlFitToTextHeight","revid":349284,"updated":"2023-11-08T14:51:14Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Resize structured text control to fit its text height.","syntaxes":[{"syntax":"[control,offset,time] call BIS_fnc_ctrlFitToTextHeight","params":[{"name":"control","type":"Control","description":"the control which should be scaled","type_expr":"Control"},{"name":"offset","type":"Number","optional":true,"default":"0","description":"offset","type_expr":"Number","text":"offset: Number - (Optional, default 0) offset"},{"name":"time","type":"Number","optional":true,"default":"0","description":"commit time","type_expr":"Number","text":"time: Number - (Optional, default 0) commit time"}],"returns":{"type":"Number","type_expr":"Number","description":"text height"}}],"examples":[{"code":["private _height = [_ctrl, 1.5, 3] call BIS_fnc_ctrlFitToTextHeight;"]}],"see_also":["ctrlCommitted","ctrlSetPosition","ctrlSetFade"]},{"name":"BIS_fnc_ctrlSetScale","title":"BIS fnc ctrlSetScale","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_ctrlSetScale","revid":349189,"updated":"2023-11-08T14:50:39Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Scale a control while maintaining its centering.","syntaxes":[{"syntax":"[control,scale,time] spawn BIS_fnc_ctrlSetScale","params":[{"name":"control","type":"Control","description":"the control which should be scaled","type_expr":"Control"},{"name":"scale","type":"Number","optional":true,"default":"1","description":"scale","type_expr":"Number","text":"scale: Number - (Optional, default 1) scale"},{"name":"time","type":"Number","optional":true,"default":"0","description":"commit time","type_expr":"Number","text":"time: Number - (Optional, default 0) commit time"}],"returns":{"type":"Array","type_expr":"Array","description":"final position"}}],"examples":[{"code":["private _finalPos = [_ctrl, 1.5, 3] spawn BIS_fnc_ctrlSetScale;"]}],"see_also":["ctrlCommitted","ctrlSetPosition","ctrlSetFade"]},{"name":"BIS_fnc_ctrlTextHeight","title":"BIS fnc ctrlTextHeight","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_ctrlTextHeight","revid":349287,"updated":"2023-11-08T14:51:15Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Resize control according to it is text.","syntaxes":[{"syntax":"[control] call BIS_fnc_ctrlTextHeight","params":[{"name":"control","type":"Control","description":"the control which should changed","type_expr":"Control"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true"}}],"examples":[{"code":["[_ctrl] call BIS_fnc_ctrlTextHeight;"]}],"see_also":["ctrlCommitted","ctrlSetPosition","ctrlSetFade"]},{"name":"BIS_fnc_curatorAttachObject","title":"BIS fnc curatorAttachObject","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_curatorAttachObject","revid":348595,"updated":"2023-11-08T13:44:38Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Attach an object on another one under cursor.","syntaxes":[{"syntax":"[object] call BIS_fnc_curatorAttachObject","params":[{"name":"object","type":"Object","description":"some object","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[BIS_vehicle] call BIS_fnc_curatorAttachObject;"]}],"see_also":["Arma 3: Curator"]},{"name":"BIS_fnc_curatorAttributes","title":"BIS fnc curatorAttributes","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_curatorAttributes","revid":281206,"updated":"2021-06-14T09:06:06Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Return attributes available for given entity","syntaxes":[{"syntax":"[param0, param1] call BIS_fnc_curatorAttributes","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"curator","text":"0: OBJECT - curator","source":"docblock"},{"name":"param1","type":"Object, Group, Array, String","type_expr":"Object | Group | Array | String","description":"checked entity","text":"1: OBJECT or GROUp or ARRAY or STRING - checked entity","source":"docblock"}],"returns":{"type":"Array, String","type_expr":"Array<String>","text":"ARRAY of STRINGs","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nReturn attributes available for given entity\n\nParameter(s):\n    0: OBJECT - curator\n    1: OBJECT or GROUp or ARRAY or STRING - checked entity\n\nReturns:\nARRAY of STRINGs"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_curatorAutomatic","title":"BIS fnc curatorAutomatic","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_curatorAutomatic","revid":376126,"updated":"2025-09-01T08:21:54Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Spawn units based on curator settings. Used when curator role is not taken.","syntaxes":[{"syntax":"[curator, sides, cheatCoef, infantryProb, groundProb, airProb, marineProb] call BIS_fnc_curatorAutomatic","params":[{"name":"curator","type":"Object","description":"curator module, costs and coefficients will be read from it","type_expr":"Object"},{"name":"sides","type":"Array","description":"array of sides of the placed entities","type_expr":"Array"},{"name":"cheatCoef","type":"Number","description":"cheat coefficient (1 means default costs, 0.5 means 50% values; allows spawning of more units)","type_expr":"Number"},{"name":"infantryProb","type":"Number","description":"infantry probability (probabilities are compared together, the ones with higher number have better chance of spawning)","type_expr":"Number"},{"name":"groundProb","type":"Number","description":"ground vehicle probability","type_expr":"Number"},{"name":"airProb","type":"Number","description":"aircraft probability","type_expr":"Number"},{"name":"marineProb","type":"Number","description":"marine probability","type_expr":"Number"}],"returns":{"type":"Array of Groups","type_expr":"Array<Group>"}}],"examples":[{"code":["[curator_module, [west, independent, 0.1, 40, 30, 20, 10] call BIS_fnc_curatorAutomatic;"]}],"see_also":["Arma 3: Curator"]},{"name":"BIS_fnc_curatorAutomaticPositions","title":"BIS fnc curatorAutomaticPositions","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_curatorAutomaticPositions","revid":273000,"updated":"2021-06-13T00:36:13Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_curatorChallengeDestroyVehicle","title":"BIS fnc curatorChallengeDestroyVehicle","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_curatorChallengeDestroyVehicle","revid":273027,"updated":"2021-06-13T00:36:37Z","groups":["CuratorChallenges"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_curatorChallengeFindIntel","title":"BIS fnc curatorChallengeFindIntel","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_curatorChallengeFindIntel","revid":272901,"updated":"2021-06-13T00:34:28Z","groups":["CuratorChallenges"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_curatorChallengeFireWeapon","title":"BIS fnc curatorChallengeFireWeapon","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_curatorChallengeFireWeapon","revid":272816,"updated":"2021-06-13T00:33:11Z","groups":["CuratorChallenges"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_curatorChallengeGetInVehicle","title":"BIS fnc curatorChallengeGetInVehicle","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_curatorChallengeGetInVehicle","revid":272966,"updated":"2021-06-13T00:35:27Z","groups":["CuratorChallenges"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_curatorChallengeIlluminate","title":"BIS fnc curatorChallengeIlluminate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_curatorChallengeIlluminate","revid":273057,"updated":"2021-06-13T00:37:02Z","groups":["CuratorChallenges"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_curatorChallengeSpawnLightning","title":"BIS fnc curatorChallengeSpawnLightning","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_curatorChallengeSpawnLightning","revid":272878,"updated":"2021-06-13T00:34:04Z","groups":["CuratorChallenges"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_curatorHint","title":"BIS fnc curatorHint","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_curatorHint","revid":347964,"updated":"2023-11-08T08:50:05Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Show hint in curator interface.","syntaxes":[{"syntax":"[title, text, duration] call BIS_fnc_curatorHint","params":[{"name":"title","type":"String","type_expr":"String"},{"name":"text","type":"String","type_expr":"String"},{"name":"duration","type":"Number","optional":true,"default":"30","description":"duration in seconds","type_expr":"Number","text":"duration: Number - (Optional, default 30) duration in seconds"}],"returns":{"type":"Control","type_expr":"Control","description":"UI control of the hint text"}}],"examples":[{"code":["[\"Title\", \"Some text\", 1337] call BIS_fnc_curatorHint;"]}],"see_also":["Arma 3: Curator"]},{"name":"BIS_fnc_curatorObjectEdited","title":"BIS fnc curatorObjectEdited","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_curatorObjectEdited","revid":349402,"updated":"2023-11-08T16:27:25Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Code executed when curator object is edited (i.e., moved or rotated). When a soldier or a vehicle is moved high above ground, create a parachute for them.","syntaxes":[{"syntax":"[module, object] call BIS_fnc_curatorObjectEdited","params":[{"name":"module","type":"Object","description":"Arma 3: Curator module","type_expr":"Object"},{"name":"object","type":"Object","description":"object which was edited","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[module_curator, someObject] call BIS_fnc_curatorObjectEdited;"]}],"see_also":["Arma 3: Curator"]},{"name":"BIS_fnc_curatorObjectPlaced","title":"BIS fnc curatorObjectPlaced","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_curatorObjectPlaced","revid":349408,"updated":"2023-11-08T16:27:27Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Code executed when curator object is placed.","syntaxes":[{"syntax":"[module,object] call BIS_fnc_curatorObjectPlaced","params":[{"name":"module","type":"Object","description":"Arma 3: Curator module","type_expr":"Object"},{"name":"object","type":"Object","description":"object which was edited","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[curatorModule, player] call BIS_fnc_curatorObjectPlaced;"]}],"see_also":["Arma 3: Curator"]},{"name":"BIS_fnc_curatorObjectRegistered","title":"BIS fnc curatorObjectRegistered","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_curatorObjectRegistered","revid":348555,"updated":"2023-11-08T13:27:57Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Register \"curatorObjectRegistered\" handler. Cost of vehicles with crews will be automatically calculated based on vehicle + crew cost.","syntaxes":[{"syntax":"[curator, code] call BIS_fnc_curatorObjectRegistered","params":[{"name":"curator","type":"Object","description":"curator module","type_expr":"Object"},{"name":"code","type":"Code","description":"handler code, passed arguments are:\n0: Object - Curator\n1: Array - Classes","type_expr":"Code"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[curatorModule, { hint format [\"Curator:%1, Classes:%2\", _this # 0, _this # 1] }] call BIS_fnc_curatorObjectRegistered;"]}],"see_also":["Arma 3: Curator","BIS_fnc_registerCuratorObject"]},{"name":"BIS_fnc_curatorObjectRegisteredTable","title":"BIS fnc curatorObjectRegisteredTable","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_curatorObjectRegisteredTable","revid":379314,"updated":"2026-10-30T23:50:02Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Register curator object costs from a table.\nA table can be exported into a spreadsheet using BIS_fnc_exportCuratorCostTable and used as argument for this function.","syntaxes":[{"syntax":"[curatorLogic, [className, cost, className, cost...]] call BIS_fnc_curatorObjectRegisteredTable","params":[{"name":"curatorLogic","type":"Object","description":"the curator logic to set the object costs for.","type_expr":"Object"},{"name":"className","type":"String","description":"the class name of the object you wish to assign a cost to. Any objects not listed in the array won't appear in the curator's unit list.","type_expr":"String"},{"name":"cost","type":"Number","description":"the cost you wish to assign to the preceding object. The cost should be between 0 and 1, with 1 representing the entire resource bar of the curator.","type_expr":"Number"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["// Nothing but the listed flare modules will show up in the curator's unit list\n[getAssignedCuratorLogic player, [\"ModuleFlareWhite_F\",0.02,\"ModuleFlareYellow_F\",0.02,\"ModuleFlareGreen_F\",0.02]] call BIS_fnc_curatorObjectRegisteredTable;"]}],"multiplayer":"Must be executed where the logic is local (on the machine of the player it is assigned to)","see_also":["BIS_fnc_exportCuratorCostTable"],"notes":[{"user":"SilentSpike","date":"2014-11-10T17:02:00Z","text":"Be aware that you must provide an equal number of elements to the array of class names and costs.\nThat mean every class name should be followed by an associated cost.\nYou can add as many objects as you want as long as this condition is met."}]},{"name":"BIS_fnc_curatorPinged","title":"BIS fnc curatorPinged","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_curatorPinged","revid":349428,"updated":"2023-11-08T16:27:34Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Show effects when player pings curator. Icon and entity list highlighting is handled by engine","syntaxes":[{"syntax":"[module, player] call BIS_fnc_curatorPinged","params":[{"name":"module","type":"Object","description":"Arma 3: Curator module","type_expr":"Object"},{"name":"player","type":"Object","description":"Player entity","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[module_curator, player] call BIS_fnc_curatorPinged;"]}],"see_also":["Arma 3: Curator"]},{"name":"BIS_fnc_curatorRespawn","title":"BIS fnc curatorRespawn","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_curatorRespawn","revid":379491,"updated":"2026-10-31T00:25:50Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Restore unit for curators after respawn.\nWhen curator owner, it will transfer ownership to the new unit.\nWhen editable by curator, it will remove the dead unit and register the new one.","syntaxes":[{"syntax":"[newUnit,oldUnit] call BIS_fnc_curatorRespawn","params":[{"name":"newUnit","type":"Object","description":"new unit","type_expr":"Object"},{"name":"oldUnit","type":"Object","description":"old, dead unit","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[BIS_newUnit,BIS_oldUnit] call BIS_fnc_curatorRespawn;"]}],"see_also":["Arma 3: Curator"]},{"name":"BIS_fnc_curatorSayMessage","title":"BIS fnc curatorSayMessage","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_curatorSayMessage","revid":349430,"updated":"2023-11-08T16:27:36Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Plays some radio message from CfgRadio locally.","syntaxes":[{"syntax":"[speaker, sentence] call BIS_fnc_curatorSayMessage","params":[{"name":"target","type":"Object","description":"curator entity","type_expr":"Object"},{"name":"sentence","type":"String","description":"sentence from CfgRadio","type_expr":"String"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[player, \"mp_groundsupport_01_casrequested_BHQ_0\"] call BIS_fnc_curatorSayMessage;"]}],"see_also":["Arma 3: Curator","globalRadio"]},{"name":"BIS_fnc_curatorVisionModes","title":"BIS fnc curatorVisionModes","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_curatorVisionModes","revid":348668,"updated":"2023-11-08T13:51:42Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Toggle curator vision mode.","syntaxes":[{"syntax":"[curator] call BIS_fnc_curatorVisionModes","params":[{"name":"curator","type":"Object","description":"curator","type_expr":"Object"}],"returns":{"type":"Array of Numbers","type_expr":"Array<Number>","description":"vision modes"}}],"examples":[{"code":["private _visionModes = [Curator] call BIS_fnc_curatorVisionModes;"]}],"see_also":["BIS_fnc_toggleCuratorVisionMode","Arma 3: Curator"]},{"name":"BIS_fnc_curatorWaypointPlaced","title":"BIS fnc curatorWaypointPlaced","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_curatorWaypointPlaced","revid":348724,"updated":"2023-11-08T14:31:30Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Code executed when curator waypoint is placed.","syntaxes":[{"syntax":"[object, waypointGroup, waypointID] call BIS_fnc_curatorWaypointPlaced","params":[{"name":"object","type":"Object","description":"curator module **Isn't used in the function**","type_expr":"Object"},{"name":"waypointGroup","type":"Array","description":"group owning the edited waypoint","type_expr":"Array"},{"name":"waypointID","type":"Number","description":"ID of the edited waypoint","type_expr":"Number"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[curatorModule, group player, 5] call BIS_fnc_curatorWaypointPlaced;"]}],"see_also":["Arma 3: Curator"]},{"name":"BIS_fnc_customGPS","title":"BIS fnc customGPS","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_customGPS","revid":327288,"updated":"2022-07-12T22:11:51Z","groups":["GUI"],"status":"ok","games":{"arma2oa":"1.56","tkoh":"1.00","arma3":"0.50"},"since":"arma2oa 1.56","arma3_since":"0.50","locality":{"effect":"local"},"description":"Replaces GPS frame.\nThe following line **must** be defined in mission Description.ext:\n\n```cpp\nonMinimapScript[] = {\"BIS_fnc_customGPS_Spawn\"};\n```","syntaxes":[{"syntax":"[path, deltaX, deltaY] call BIS_fnc_customGPS","params":[{"name":"path","type":"String","description":"full path to image file","type_expr":"String"},{"name":"deltaX","type":"Number","optional":true,"type_expr":"Number","text":"deltaX *(Optional)*: Number"},{"name":"deltaY","type":"Number","optional":true,"type_expr":"Number","text":"deltaY *(Optional)*: Number"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[\"ca\\missions_pmc\\data\\ui_gps_ca.paa\", -0.05, 0.16] call BIS_fnc_customGPS;"]}],"see_also":["Functions Library"]},{"name":"BIS_fnc_customGPSVideo","title":"BIS fnc customGPSVideo","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_customGPSVideo","revid":365057,"updated":"2024-07-16T09:31:55Z","groups":["GUI"],"status":"ok","games":{"arma2oa":"1.56","tkoh":"1.00","arma3":"0.50"},"since":"arma2oa 1.56","arma3_since":"0.50","locality":{"effect":"local"},"exec":"spawn","description":"Plays in-game video in GPS frame.\nIf BIS_fnc_customGPS changed the GPS texture, it is used. GPS GUI layer is `19`.\n\n> [!NOTE]\n> **Arma 3:** Does not work in Arma 3. See BIS_fnc_playVideo instead.","syntaxes":[{"syntax":"[path, sizeCoef] spawn BIS_fnc_customGPSVideo","params":[{"name":"path","type":"String","description":"full path to image file","type_expr":"String"},{"name":"sizeCoef","type":"Number","optional":true,"default":"1","description":"screen size coefficient","type_expr":"Number","text":"sizeCoef: Number - (Optional, default 1) screen size coefficient"}],"returns":{"type":"Script Handle","type_expr":"Script Handle","description":"script which terminates itself once video ends"}}],"examples":[{"code":["private _script = [\"\\ca\\video_pmc\\CP00_Reynolds_b.ogv\", 1.04] spawn BIS_fnc_customGPSVideo;\nwaitUntil { scriptDone _script };"]}],"see_also":["BIS_fnc_playVideo","BIS_fnc_customGPS"]},{"name":"BIS_fnc_cutDecimals","title":"BIS fnc cutDecimals","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_cutDecimals","revid":349047,"updated":"2023-11-08T14:47:17Z","groups":["Math"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Function that rounds specified number to specified amount of decimals.\n\n> [!NOTE]\n> **Arma 3:** Use toFixed instead.","syntaxes":[{"syntax":"[number, precision] call BIS_fnc_cutDecimals","params":[{"name":"number","type":"Number","description":"decimal number to round.","type_expr":"Number"},{"name":"precision","type":"Number","optional":true,"default":"0","description":"amount of decimals to round to","type_expr":"Number","text":"precision: Number - (Optional, default 0) amount of decimals to round to"}],"returns":{"type":"Number","type_expr":"Number","description":"rounded number."}}],"examples":[{"code":["private _cutDecimals = [33.3333, 1] call BIS_fnc_cutDecimals; // returns 33.3"]}],"see_also":["toFixed","BIS_fnc_numberDigits","BIS_fnc_numberText"]},{"name":"BIS_fnc_damageChanged","title":"BIS fnc damageChanged","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_damageChanged","revid":309384,"updated":"2022-05-05T12:04:33Z","groups":["Feedback"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Handle effects caused by changing of damage.","syntaxes":[{"syntax":"call BIS_fnc_damageChanged","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_damageChanged;"]}],"see_also":["BIS_fnc_incapacitatedEffect","BIS_fnc_healing"]},{"name":"BIS_fnc_damagePulsing","title":"BIS fnc damagePulsing","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_damagePulsing","revid":329958,"updated":"2022-08-09T17:17:12Z","groups":["Feedback"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Game pulsing damage effect.","syntaxes":[{"syntax":"call BIS_fnc_damagePulsing","params":[],"returns":{"type":"Script Handle","type_expr":"Script Handle"}}],"examples":[{"code":["call BIS_fnc_damagePulsing;"]}],"see_also":["BIS_fnc_fatigueEffect","BIS_fnc_incapacitatedEffect","BIS_fnc_indicateBleeding","BIS_fnc_bloodEffect"]},{"name":"BIS_fnc_dataTerminalAnimate","title":"BIS fnc dataTerminalAnimate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_dataTerminalAnimate","revid":327212,"updated":"2022-07-12T22:11:46Z","groups":["Scripts"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","description":"Animate a Data Terminal (\"Land_DataTerminal_01_F\").","syntaxes":[{"syntax":"[dataTerminal, step] call BIS_fnc_dataTerminalAnimate","params":[{"name":"dataTerminal","type":"Object","type_expr":"Object"},{"name":"step","type":"Number","description":"in range 0..3, steps being:\n\n- 0: closed terminal\n- 1: case opened\n- 2: antenna up (but closed)\n- 3: antenna opened and transmitting.","type_expr":"Number"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[myTerminal, 3] call BIS_fnc_dataTerminalAnimate;"]}],"see_also":["MP End Game","BIS_fnc_dataTerminalColor"]},{"name":"BIS_fnc_dataTerminalColor","title":"BIS fnc dataTerminalColor","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_dataTerminalColor","revid":327228,"updated":"2022-07-12T22:11:46Z","groups":["Scripts"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","description":"Set Data Terminal colors for its different steps. Steps are:\n\n1. closed terminal\n1. opening terminal\n1. emitting terminal.\n\nDefault step colors are \"blue\", \"orange\", \"green\".\nSee BIS_fnc_dataTerminalAnimate to animate a terminal.","syntaxes":[{"syntax":"[dataTerminal, step1color, step2color, step3color] call BIS_fnc_dataTerminalColor","params":[{"name":"dataTerminal","type":"Object","type_expr":"Object"},{"name":"step1color","type":"String","description":"step 1 color. Can be one of:\n\n- \"blue\"\n- \"orange\"\n- \"green\"\n- \"red\"\n- \"purple\"\n\nIf not set, the selection color will simply not be changed.","type_expr":"String"},{"name":"step2color","type":"String","description":"step 2 color","type_expr":"String"},{"name":"step3color","type":"String","description":"step 3 color","type_expr":"String"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"false if data terminal is null, true if the script ends properly"}}],"examples":[{"code":["[myTerminal, \"purple\", \"red\", \"orange\"] call BIS_fnc_dataTerminalColor;"]}],"see_also":["MP End Game","BIS_fnc_dataTerminalAnimate"]},{"name":"BIS_fnc_dbClassCheck","title":"BIS fnc dbClassCheck","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_dbClassCheck","revid":379245,"updated":"2026-10-30T23:24:28Z","groups":["Database"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Check if class exists in Scripted Database.","syntaxes":[{"syntax":"[databaseArray, path] call BIS_fnc_dbClassCheck","params":[{"name":"databaseArray","type":"Array","description":"An array in the Scripted Database format","type_expr":"Array"},{"name":"path","type":"Array","description":"Database path to be checked","type_expr":"Array"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"True if class exists"}}],"examples":[{"code":["[[\"#MILLER\", [\"&NAME\", \"Miller\", \"&UID\", \"1234\", \"&MONEY\", 1000], [\"miller\"]] call BIS_fnc_dbClassCheck // true"]}],"see_also":["BIS_fnc_dbClassId","BIS_fnc_dbClassIndex","BIS_fnc_dbClassList","BIS_fnc_dbClassRemove","BIS_fnc_dbClassReturn","BIS_fnc_dbClassSet","BIS_fnc_dbConfigPath","BIS_fnc_dbImportConfig","BIS_fnc_dbImportXML","BIS_fnc_dbisClass","BIS_fnc_dbisValue","BIS_fnc_dbPrint","BIS_fnc_dbSymbolClass","BIS_fnc_dbSymbolValue","BIS_fnc_dbValueCheck","BIS_fnc_dbValueId","BIS_fnc_dbValueIndex","BIS_fnc_dbValueList","BIS_fnc_dbValueRemove","BIS_fnc_dbValueReturn","BIS_fnc_dbValueSet"]},{"name":"BIS_fnc_dbClassId","title":"BIS fnc dbClassId","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_dbClassId","revid":379246,"updated":"2026-10-30T23:24:44Z","groups":["Database"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Converts string to class definition.","syntaxes":[{"syntax":"text call BIS_fnc_dbClassId","params":[{"name":"text","type":"String","description":"string to convert to class definition","type_expr":"String"}],"returns":{"type":"String","type_expr":"String","description":"class definition"}}],"examples":[{"code":["\"miller\" call BIS_fnc_dbClassId; // \"#MILLER\""]}],"see_also":["BIS_fnc_dbClassCheck","BIS_fnc_dbClassIndex","BIS_fnc_dbClassList","BIS_fnc_dbClassRemove","BIS_fnc_dbClassReturn","BIS_fnc_dbClassSet","BIS_fnc_dbConfigPath","BIS_fnc_dbImportConfig","BIS_fnc_dbImportXML","BIS_fnc_dbisClass","BIS_fnc_dbisValue","BIS_fnc_dbPrint","BIS_fnc_dbSymbolClass","BIS_fnc_dbSymbolValue","BIS_fnc_dbValueCheck","BIS_fnc_dbValueId","BIS_fnc_dbValueIndex","BIS_fnc_dbValueList","BIS_fnc_dbValueRemove","BIS_fnc_dbValueReturn","BIS_fnc_dbValueSet"]},{"name":"BIS_fnc_dbClassIndex","title":"BIS fnc dbClassIndex","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_dbClassIndex","revid":379248,"updated":"2026-10-30T23:41:19Z","groups":["Database"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Returns indices leading to given class.","syntaxes":[{"syntax":"[database, path] call BIS_fnc_dbClassIndex","params":[{"name":"database","type":"Array","description":"database array","type_expr":"Array"},{"name":"path","type":"Array","description":"path to class","type_expr":"Array"}],"returns":{"type":"Array","type_expr":"Array","description":"List of indices"}}],"examples":[{"code":["[[\"#MILLER\", [\"&NAME\", \"Miller\", \"&UID\", \"1234\", \"&MONEY\", 1000]], [\"miller\"]] call BIS_fnc_dbClassIndex; // [0]"]}],"see_also":["BIS_fnc_dbClassCheck","BIS_fnc_dbClassId","BIS_fnc_dbClassList","BIS_fnc_dbClassRemove","BIS_fnc_dbClassReturn","BIS_fnc_dbClassSet","BIS_fnc_dbConfigPath","BIS_fnc_dbImportConfig","BIS_fnc_dbImportXML","BIS_fnc_dbisClass","BIS_fnc_dbisValue","BIS_fnc_dbPrint","BIS_fnc_dbSymbolClass","BIS_fnc_dbSymbolValue","BIS_fnc_dbValueCheck","BIS_fnc_dbValueId","BIS_fnc_dbValueIndex","BIS_fnc_dbValueList","BIS_fnc_dbValueRemove","BIS_fnc_dbValueReturn","BIS_fnc_dbValueSet"]},{"name":"BIS_fnc_dbClassList","title":"BIS fnc dbClassList","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_dbClassList","revid":379249,"updated":"2026-10-30T23:41:26Z","groups":["Database"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Returns all classes within class.","syntaxes":[{"syntax":"[database, path] call BIS_fnc_dbClassList","params":[{"name":"database","type":"Array","description":"database array","type_expr":"Array"},{"name":"path","type":"Array","description":"path to array of classes","type_expr":"Array"}],"returns":{"type":"Array","type_expr":"Array","description":"List of classnames"}}],"examples":[{"code":["[[\"#MILLER\", [\"&KILLS\", 1000], \"#TERRA\", [\"&WEAPON\", \"MX 6.5mm\"]], []] call BIS_fnc_dbClassList; // [\"MILLER\",\"TERRA\"]"]}],"see_also":["BIS_fnc_dbClassCheck","BIS_fnc_dbClassId","BIS_fnc_dbClassIndex","BIS_fnc_dbClassRemove","BIS_fnc_dbClassReturn","BIS_fnc_dbClassSet","BIS_fnc_dbConfigPath","BIS_fnc_dbImportConfig","BIS_fnc_dbImportXML","BIS_fnc_dbisClass","BIS_fnc_dbisValue","BIS_fnc_dbPrint","BIS_fnc_dbSymbolClass","BIS_fnc_dbSymbolValue","BIS_fnc_dbValueCheck","BIS_fnc_dbValueId","BIS_fnc_dbValueIndex","BIS_fnc_dbValueList","BIS_fnc_dbValueRemove","BIS_fnc_dbValueReturn","BIS_fnc_dbValueSet"]},{"name":"BIS_fnc_dbClassRemove","title":"BIS fnc dbClassRemove","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_dbClassRemove","revid":379250,"updated":"2026-10-30T23:41:33Z","groups":["Database"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Remove class from Scripted Database. The function does not return the modified database but modifies the passed array directly.","syntaxes":[{"syntax":"[database, path] call BIS_fnc_dbClassRemove","params":[{"name":"database","type":"Array","description":"Database array","type_expr":"Array"},{"name":"path","type":"Array","description":"Path to class to be deleted","type_expr":"Array"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"True if class was removed"}}],"examples":[{"code":["private _db = [\"#MILLER\", [\"&KILLS\", 1000], \"#TERRA\", [\"&WEAPON\", \"MX 6.5mm\"]];\n[_db, [\"terra\"]] call BIS_fnc_dbClassRemove; // true\n_db // [\"#MILLER\",[\"&KILLS\",1000]]"]}],"see_also":["BIS_fnc_dbClassCheck","BIS_fnc_dbClassId","BIS_fnc_dbClassIndex","BIS_fnc_dbClassList","BIS_fnc_dbClassReturn","BIS_fnc_dbClassSet","BIS_fnc_dbConfigPath","BIS_fnc_dbImportConfig","BIS_fnc_dbImportXML","BIS_fnc_dbisClass","BIS_fnc_dbisValue","BIS_fnc_dbPrint","BIS_fnc_dbSymbolClass","BIS_fnc_dbSymbolValue","BIS_fnc_dbValueCheck","BIS_fnc_dbValueId","BIS_fnc_dbValueIndex","BIS_fnc_dbValueList","BIS_fnc_dbValueRemove","BIS_fnc_dbValueReturn","BIS_fnc_dbValueSet"]},{"name":"BIS_fnc_dbClassReturn","title":"BIS fnc dbClassReturn","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_dbClassReturn","revid":379251,"updated":"2026-10-30T23:41:41Z","groups":["Database"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Returns content of given class.","syntaxes":[{"syntax":"[database, path] call BIS_fnc_dbClassReturn","params":[{"name":"database","type":"Array","description":"database array","type_expr":"Array"},{"name":"path","type":"Array","description":"path to the class which content should be returned","type_expr":"Array"}],"returns":{"type":"Array","type_expr":"Array","description":"class content"}}],"examples":[{"code":["[[\"#MILLER\", [\"&KILLS\", 1000], \"#TERRA\", [\"&WEAPON\", \"MX 6.5mm\"]], [\"miller\"]] call BIS_fnc_dbClassReturn; // [\"&KILLS\", 1000]"]}],"see_also":["BIS_fnc_dbClassCheck","BIS_fnc_dbClassId","BIS_fnc_dbClassIndex","BIS_fnc_dbClassList","BIS_fnc_dbClassRemove","BIS_fnc_dbClassSet","BIS_fnc_dbConfigPath","BIS_fnc_dbImportConfig","BIS_fnc_dbImportXML","BIS_fnc_dbisClass","BIS_fnc_dbisValue","BIS_fnc_dbPrint","BIS_fnc_dbSymbolClass","BIS_fnc_dbSymbolValue","BIS_fnc_dbValueCheck","BIS_fnc_dbValueId","BIS_fnc_dbValueIndex","BIS_fnc_dbValueList","BIS_fnc_dbValueRemove","BIS_fnc_dbValueReturn","BIS_fnc_dbValueSet"]},{"name":"BIS_fnc_dbClassSet","title":"BIS fnc dbClassSet","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_dbClassSet","revid":379252,"updated":"2026-10-30T23:41:48Z","groups":["Database"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Add class to Scripted Database. The function modifies the passed array and returns a success flag.","syntaxes":[{"syntax":"[database, path, (value)] call BIS_fnc_dbClassSet","params":[{"name":"database","type":"Array","description":"database array","type_expr":"Array"},{"name":"path","type":"Array","description":"path to class","type_expr":"Array"},{"name":"value","type":"Array","optional":true,"default":"`[]`","description":"the class' values","type_expr":"Array","text":"value: Array - (Optional, default `[]`) the class' values"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"True if class was added"}}],"examples":[{"code":["private _db = [\"#MILLER\", [\"&KILLS\", 1000], \"#TERRA\", [\"&WEAPON\", \"MX 6.5mm\"]];\n[_db, [\"kavala\"], [\"&POPULATION\", 42]] call BIS_fnc_dbClassSet;\n_db // [\"#MILLER\",[\"&KILLS\",1000],\"#TERRA\",[\"&WEAPON\",\"MX 6.5mm\"],\"#KAVALA\",[\"&POPULATION\",42]]"]}],"see_also":["BIS_fnc_dbClassCheck","BIS_fnc_dbClassId","BIS_fnc_dbClassIndex","BIS_fnc_dbClassList","BIS_fnc_dbClassRemove","BIS_fnc_dbClassReturn","BIS_fnc_dbConfigPath","BIS_fnc_dbImportConfig","BIS_fnc_dbImportXML","BIS_fnc_dbisClass","BIS_fnc_dbisValue","BIS_fnc_dbPrint","BIS_fnc_dbSymbolClass","BIS_fnc_dbSymbolValue","BIS_fnc_dbValueCheck","BIS_fnc_dbValueId","BIS_fnc_dbValueIndex","BIS_fnc_dbValueList","BIS_fnc_dbValueRemove","BIS_fnc_dbValueReturn","BIS_fnc_dbValueSet"]},{"name":"BIS_fnc_dbConfigPath","title":"BIS fnc dbConfigPath","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_dbConfigPath","revid":379253,"updated":"2026-10-30T23:41:56Z","groups":["Database"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"If there is a database present in the config (config.cpp or descritpion.ext) then this function can be used to get the config path of the passed array. So it basically converts the array into a config entry.","syntaxes":[{"syntax":"[path, config] call BIS_fnc_dbConfigPath","params":[{"name":"path","type":"Array","description":"Path to class or value","type_expr":"Array"},{"name":"config","type":"Config","description":"Database config","type_expr":"Config"}],"returns":{"type":"Config","type_expr":"Config","description":"Config path to the class or value"}}],"see_also":["BIS_fnc_dbClassCheck","BIS_fnc_dbClassId","BIS_fnc_dbClassIndex","BIS_fnc_dbClassList","BIS_fnc_dbClassRemove","BIS_fnc_dbClassReturn","BIS_fnc_dbClassSet","BIS_fnc_dbImportConfig","BIS_fnc_dbImportXML","BIS_fnc_dbisClass","BIS_fnc_dbisValue","BIS_fnc_dbPrint","BIS_fnc_dbSymbolClass","BIS_fnc_dbSymbolValue","BIS_fnc_dbValueCheck","BIS_fnc_dbValueId","BIS_fnc_dbValueIndex","BIS_fnc_dbValueList","BIS_fnc_dbValueRemove","BIS_fnc_dbValueReturn","BIS_fnc_dbValueSet"]},{"name":"BIS_fnc_dbImportConfig","title":"BIS fnc dbImportConfig","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_dbImportConfig","revid":379254,"updated":"2026-10-30T23:42:04Z","groups":["Database"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Copy config classes and adds them to Scripted Database. Config values can not be passed through this function. The passed array gets modified.","syntaxes":[{"syntax":"[database, path, config] call BIS_fnc_dbImportConfig","params":[{"name":"database","type":"Array","description":"Database array","type_expr":"Array"},{"name":"path","type":"Array","description":"Path to class","type_expr":"Array"},{"name":"config","type":"Config","description":"Config from where to import database","type_expr":"Config"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"True if copied"}}],"see_also":["BIS_fnc_dbClassCheck","BIS_fnc_dbClassId","BIS_fnc_dbClassIndex","BIS_fnc_dbClassList","BIS_fnc_dbClassRemove","BIS_fnc_dbClassReturn","BIS_fnc_dbClassSet","BIS_fnc_dbConfigPath","BIS_fnc_dbImportXML","BIS_fnc_dbisClass","BIS_fnc_dbisValue","BIS_fnc_dbPrint","BIS_fnc_dbSymbolClass","BIS_fnc_dbSymbolValue","BIS_fnc_dbValueCheck","BIS_fnc_dbValueId","BIS_fnc_dbValueIndex","BIS_fnc_dbValueList","BIS_fnc_dbValueRemove","BIS_fnc_dbValueReturn","BIS_fnc_dbValueSet"]},{"name":"BIS_fnc_dbImportXML","title":"BIS fnc dbImportXML","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_dbImportXML","revid":348501,"updated":"2023-11-08T13:01:32Z","groups":["Database"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Import XML file into Scripted Database.","syntaxes":[{"syntax":"xmlFile call BIS_fnc_dbImportXML","params":[{"name":"xmlFile","type":"String","description":"XML file path","type_expr":"String"}],"returns":{"type":"Array","type_expr":"Array","description":"database"}}],"examples":[{"code":["private _xmlDB = \"myFile.xml\" call BIS_fnc_dbImportXML;"]}],"see_also":["BIS_fnc_dbClassCheck","BIS_fnc_dbClassId","BIS_fnc_dbClassIndex","BIS_fnc_dbClassList","BIS_fnc_dbClassRemove","BIS_fnc_dbClassReturn","BIS_fnc_dbClassSet","BIS_fnc_dbConfigPath","BIS_fnc_dbImportConfig","BIS_fnc_dbisClass","BIS_fnc_dbisValue","BIS_fnc_dbPrint","BIS_fnc_dbSymbolClass","BIS_fnc_dbSymbolValue","BIS_fnc_dbValueCheck","BIS_fnc_dbValueId","BIS_fnc_dbValueIndex","BIS_fnc_dbValueList","BIS_fnc_dbValueRemove","BIS_fnc_dbValueReturn","BIS_fnc_dbValueSet"]},{"name":"BIS_fnc_dbIsClass","title":"BIS fnc dbIsClass","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_dbIsClass","revid":379492,"updated":"2026-10-31T00:25:58Z","groups":["Database"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Checks if string is class definition.","syntaxes":[{"syntax":"text call BIS_fnc_dbIsClass","params":[{"name":"text","type":"String","description":"Check if text is in class format","type_expr":"String"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when the argument starts with \"#\" (class symbol returned with BIS_fnc_dbSymbolClass)"}}],"examples":[{"code":["\"#MYCLASS\" call BIS_fnc_dbIsClass; // true\n\"#myclass\" call BIS_fnc_dbIsClass; // true\n\"MYCLASS\" call BIS_fnc_dbIsClass; // false\n1234 call BIS_fnc_dbIsClass; // false"]}],"see_also":["BIS_fnc_dbClassCheck","BIS_fnc_dbClassId","BIS_fnc_dbClassIndex","BIS_fnc_dbClassList","BIS_fnc_dbClassRemove","BIS_fnc_dbClassReturn","BIS_fnc_dbClassSet","BIS_fnc_dbConfigPath","BIS_fnc_dbImportConfig","BIS_fnc_dbImportXML","BIS_fnc_dbIsValue","BIS_fnc_dbPrint","BIS_fnc_dbSymbolClass","BIS_fnc_dbSymbolValue","BIS_fnc_dbValueCheck","BIS_fnc_dbValueId","BIS_fnc_dbValueIndex","BIS_fnc_dbValueList","BIS_fnc_dbValueRemove","BIS_fnc_dbValueReturn","BIS_fnc_dbValueSet"]},{"name":"BIS_fnc_dbIsValue","title":"BIS fnc dbIsValue","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_dbIsValue","revid":379493,"updated":"2026-10-31T00:26:06Z","groups":["Database"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Checks if string is value definition.","syntaxes":[{"syntax":"text call BIS_fnc_dbIsValue","params":[{"name":"text","type":"String","description":"Check if text is in value format","type_expr":"String"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when the argument starts with \"&\" (value symbol returned with BIS_fnc_dbSymbolValue)"}}],"examples":[{"code":["\"&MYVALUE\" call BIS_fnc_dbIsValue; // true\n\"&myvalue\" call BIS_fnc_dbIsValue; // true\n\"MYVALUE\" call BIS_fnc_dbIsValue; // false\n1234 call BIS_fnc_dbIsValue; // false"]}],"see_also":["BIS_fnc_dbClassCheck","BIS_fnc_dbClassId","BIS_fnc_dbClassIndex","BIS_fnc_dbClassList","BIS_fnc_dbClassRemove","BIS_fnc_dbClassReturn","BIS_fnc_dbClassSet","BIS_fnc_dbConfigPath","BIS_fnc_dbImportConfig","BIS_fnc_dbImportXML","BIS_fnc_dbIsClass","BIS_fnc_dbPrint","BIS_fnc_dbSymbolClass","BIS_fnc_dbSymbolValue","BIS_fnc_dbValueCheck","BIS_fnc_dbValueId","BIS_fnc_dbValueIndex","BIS_fnc_dbValueList","BIS_fnc_dbValueRemove","BIS_fnc_dbValueReturn","BIS_fnc_dbValueSet"]},{"name":"BIS_fnc_dbPrint","title":"BIS fnc dbPrint","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_dbPrint","revid":379255,"updated":"2026-10-30T23:42:12Z","groups":["Database"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Copy Scripted Database content into clipboard for evaluation. Text will be formatted as config.\n\n> [!IMPORTANT]\n> Arma 3 v1.92 The function does not insert semicolons at the end of values (not intentional?). You have to manually add them to make the config functional.","syntaxes":[{"syntax":"[database, tabs] call BIS_fnc_dbPrint","params":[{"name":"database","type":"Array","description":"Database array","type_expr":"Array"},{"name":"tabs","type":"Number","description":"Number of tabs","type_expr":"Number"}],"returns":{"type":"String","type_expr":"String","description":"Printed text"}}],"examples":[{"code":["[[\"#MILLER\", [\"&KILLS\", 1000, \"&RANK\", \"CAPTAIN\"], \"#TERRA\", [\"&WEAPON\", \"MX 6.5mm\"]]] call BIS_fnc_dbPrint;"]},{"code":["[[\"#MILLER\", [\"&KILLS\", 1000, \"&RANK\", \"CAPTAIN\"], \"#TERRA\", [\"&WEAPON\", \"MX 6.5mm\"]], 1] call BIS_fnc_dbPrint;"]}],"see_also":["BIS_fnc_dbClassCheck","BIS_fnc_dbClassId","BIS_fnc_dbClassIndex","BIS_fnc_dbClassList","BIS_fnc_dbClassRemove","BIS_fnc_dbClassReturn","BIS_fnc_dbClassSet","BIS_fnc_dbConfigPath","BIS_fnc_dbImportConfig","BIS_fnc_dbImportXML","BIS_fnc_dbisClass","BIS_fnc_dbisValue","BIS_fnc_dbSymbolClass","BIS_fnc_dbSymbolValue","BIS_fnc_dbValueCheck","BIS_fnc_dbValueId","BIS_fnc_dbValueIndex","BIS_fnc_dbValueList","BIS_fnc_dbValueRemove","BIS_fnc_dbValueReturn","BIS_fnc_dbValueSet"]},{"name":"BIS_fnc_dbSymbolClass","title":"BIS fnc dbSymbolClass","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_dbSymbolClass","revid":379256,"updated":"2026-10-30T23:42:20Z","groups":["Database"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"A getter function to return the symbol used for declaring a class.","syntaxes":[{"syntax":"call BIS_fnc_dbSymbolClass","params":[],"returns":{"type":"String","type_expr":"String","description":"the symbol used for classes"}}],"examples":[{"code":["call BIS_fnc_dbSymbolClass; // #"]}],"see_also":["BIS_fnc_dbClassCheck","BIS_fnc_dbClassId","BIS_fnc_dbClassIndex","BIS_fnc_dbClassList","BIS_fnc_dbClassRemove","BIS_fnc_dbClassReturn","BIS_fnc_dbClassSet","BIS_fnc_dbConfigPath","BIS_fnc_dbImportConfig","BIS_fnc_dbImportXML","BIS_fnc_dbisClass","BIS_fnc_dbisValue","BIS_fnc_dbPrint","BIS_fnc_dbSymbolValue","BIS_fnc_dbValueCheck","BIS_fnc_dbValueId","BIS_fnc_dbValueIndex","BIS_fnc_dbValueList","BIS_fnc_dbValueRemove","BIS_fnc_dbValueReturn","BIS_fnc_dbValueSet"]},{"name":"BIS_fnc_dbSymbolValue","title":"BIS fnc dbSymbolValue","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_dbSymbolValue","revid":379257,"updated":"2026-10-30T23:42:28Z","groups":["Database"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"A getter function to return the symobl used for declaring a value.","syntaxes":[{"syntax":"call BIS_fnc_dbSymbolValue","params":[],"returns":{"type":"String","type_expr":"String","description":"the symbol used for values"}}],"examples":[{"code":["call BIS_fnc_dbSymbolValue; // &"]}],"see_also":["BIS_fnc_dbClassCheck","BIS_fnc_dbClassId","BIS_fnc_dbClassIndex","BIS_fnc_dbClassList","BIS_fnc_dbClassRemove","BIS_fnc_dbClassReturn","BIS_fnc_dbClassSet","BIS_fnc_dbConfigPath","BIS_fnc_dbImportConfig","BIS_fnc_dbImportXML","BIS_fnc_dbisClass","BIS_fnc_dbisValue","BIS_fnc_dbPrint","BIS_fnc_dbSymbolClass","BIS_fnc_dbValueCheck","BIS_fnc_dbValueId","BIS_fnc_dbValueIndex","BIS_fnc_dbValueList","BIS_fnc_dbValueRemove","BIS_fnc_dbValueReturn","BIS_fnc_dbValueSet"]},{"name":"BIS_fnc_dbValueCheck","title":"BIS fnc dbValueCheck","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_dbValueCheck","revid":379258,"updated":"2026-10-30T23:42:36Z","groups":["Database"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Check if value exists in Scripted Database.","syntaxes":[{"syntax":"[database, path] call BIS_fnc_dbValueCheck","params":[{"name":"database","type":"Array","description":"Database array","type_expr":"Array"},{"name":"path","type":"Array","description":"Path to value","type_expr":"Array"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"True when value exists"}}],"examples":[{"code":["[[\"#MILLER\", [\"&KILLS\", 1000, \"&RANK\", \"CAPTAIN\"]]] call BIS_fnc_dbValueCheck; // true"]}],"see_also":["BIS_fnc_dbClassCheck","BIS_fnc_dbClassId","BIS_fnc_dbClassIndex","BIS_fnc_dbClassList","BIS_fnc_dbClassRemove","BIS_fnc_dbClassReturn","BIS_fnc_dbClassSet","BIS_fnc_dbConfigPath","BIS_fnc_dbImportConfig","BIS_fnc_dbImportXML","BIS_fnc_dbisClass","BIS_fnc_dbisValue","BIS_fnc_dbPrint","BIS_fnc_dbSymbolClass","BIS_fnc_dbSymbolValue","BIS_fnc_dbValueId","BIS_fnc_dbValueIndex","BIS_fnc_dbValueList","BIS_fnc_dbValueRemove","BIS_fnc_dbValueReturn","BIS_fnc_dbValueSet"]},{"name":"BIS_fnc_dbValueId","title":"BIS fnc dbValueId","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_dbValueId","revid":379259,"updated":"2026-10-30T23:42:44Z","groups":["Database"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Converts string to value definition or vice versa.","syntaxes":[{"syntax":"valueString call BIS_fnc_dbValueId","params":[{"name":"valueString","type":"String or Array","description":"String or Array\n\n- String - converts string to value definition\n- Array: converts value definition to string","type_expr":"String | Array","text":"valueString: String or Array\n\n- String - converts string to value definition\n- Array: converts value definition to string"}],"returns":null}],"examples":[{"code":["\"MYVALUE\" call BIS_fnc_dbValueId; // \"&MYVALUE\""]},{"code":["[\"&MYVALUE\"] call BIS_fnc_dbValueId; // \"MYVALUE\""]}],"see_also":["BIS_fnc_dbClassCheck","BIS_fnc_dbClassId","BIS_fnc_dbClassIndex","BIS_fnc_dbClassList","BIS_fnc_dbClassRemove","BIS_fnc_dbClassReturn","BIS_fnc_dbClassSet","BIS_fnc_dbConfigPath","BIS_fnc_dbImportConfig","BIS_fnc_dbImportXML","BIS_fnc_dbisClass","BIS_fnc_dbisValue","BIS_fnc_dbPrint","BIS_fnc_dbSymbolClass","BIS_fnc_dbSymbolValue","BIS_fnc_dbValueCheck","BIS_fnc_dbValueIndex","BIS_fnc_dbValueList","BIS_fnc_dbValueRemove","BIS_fnc_dbValueReturn","BIS_fnc_dbValueSet"]},{"name":"BIS_fnc_dbValueIndex","title":"BIS fnc dbValueIndex","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_dbValueIndex","revid":379260,"updated":"2026-10-30T23:42:51Z","groups":["Database"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Returns indexes leading to given value.","syntaxes":[{"syntax":"[database, path] call BIS_fnc_dbValueIndex","params":[{"name":"database","type":"Array","description":"Database array","type_expr":"Array"},{"name":"path","type":"Array","description":"Path leading to value entry","type_expr":"Array"}],"returns":{"type":"Array","type_expr":"Array","description":"List of indexes"}}],"see_also":["BIS_fnc_dbClassCheck","BIS_fnc_dbClassId","BIS_fnc_dbClassIndex","BIS_fnc_dbClassList","BIS_fnc_dbClassRemove","BIS_fnc_dbClassReturn","BIS_fnc_dbClassSet","BIS_fnc_dbConfigPath","BIS_fnc_dbImportConfig","BIS_fnc_dbImportXML","BIS_fnc_dbisClass","BIS_fnc_dbisValue","BIS_fnc_dbPrint","BIS_fnc_dbSymbolClass","BIS_fnc_dbSymbolValue","BIS_fnc_dbValueCheck","BIS_fnc_dbValueId","BIS_fnc_dbValueList","BIS_fnc_dbValueRemove","BIS_fnc_dbValueReturn","BIS_fnc_dbValueSet"]},{"name":"BIS_fnc_dbValueList","title":"BIS fnc dbValueList","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_dbValueList","revid":379261,"updated":"2026-10-30T23:42:59Z","groups":["Database"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Returns all values within class.","syntaxes":[{"syntax":"[database, path] call BIS_fnc_dbValueList","params":[{"name":"database","type":"Array","description":"database array","type_expr":"Array"},{"name":"path","type":"Array","description":"path to class","type_expr":"Array"}],"returns":{"type":"Array","type_expr":"Array","description":"List of all value names"}}],"examples":[{"code":["[[\"#MILLER\", [\"&KILLS\", 1000, \"&RANK\", \"CAPTAIN\"]], [\"miller\"]] call BIS_fnc_dbValueList; // [\"KILLS\", \"RANK\"]"]}],"see_also":["BIS_fnc_dbClassCheck","BIS_fnc_dbClassId","BIS_fnc_dbClassIndex","BIS_fnc_dbClassList","BIS_fnc_dbClassRemove","BIS_fnc_dbClassReturn","BIS_fnc_dbClassSet","BIS_fnc_dbConfigPath","BIS_fnc_dbImportConfig","BIS_fnc_dbImportXML","BIS_fnc_dbisClass","BIS_fnc_dbisValue","BIS_fnc_dbPrint","BIS_fnc_dbSymbolClass","BIS_fnc_dbSymbolValue","BIS_fnc_dbValueCheck","BIS_fnc_dbValueId","BIS_fnc_dbValueIndex","BIS_fnc_dbValueRemove","BIS_fnc_dbValueReturn","BIS_fnc_dbValueSet"]},{"name":"BIS_fnc_dbValueRemove","title":"BIS fnc dbValueRemove","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_dbValueRemove","revid":379262,"updated":"2026-10-30T23:43:07Z","groups":["Database"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Remove value from Scripted Database.","syntaxes":[{"syntax":"[database, path] call BIS_fnc_dbValueRemove","params":[{"name":"database","type":"Array","description":"Databse array","type_expr":"Array"},{"name":"path","type":"Array","description":"Path to the value to remove","type_expr":"Array"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"True if the value was removed"}}],"see_also":["BIS_fnc_dbClassCheck","BIS_fnc_dbClassId","BIS_fnc_dbClassIndex","BIS_fnc_dbClassList","BIS_fnc_dbClassRemove","BIS_fnc_dbClassReturn","BIS_fnc_dbClassSet","BIS_fnc_dbConfigPath","BIS_fnc_dbImportConfig","BIS_fnc_dbImportXML","BIS_fnc_dbisClass","BIS_fnc_dbisValue","BIS_fnc_dbPrint","BIS_fnc_dbSymbolClass","BIS_fnc_dbSymbolValue","BIS_fnc_dbValueCheck","BIS_fnc_dbValueId","BIS_fnc_dbValueIndex","BIS_fnc_dbValueList","BIS_fnc_dbValueReturn","BIS_fnc_dbValueSet"]},{"name":"BIS_fnc_dbValueReturn","title":"BIS fnc dbValueReturn","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_dbValueReturn","revid":379263,"updated":"2026-10-30T23:43:15Z","groups":["Database"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Returns content of given value.","syntaxes":[{"syntax":"[database, path, (defaultValue)] call BIS_fnc_dbValueReturn","params":[{"name":"database","type":"Array","description":"Databse array","type_expr":"Array"},{"name":"path","type":"Array","description":"Path to value","type_expr":"Array"},{"name":"defaultValue","type":"Anything","optional":true,"default":"nil","description":"in case the value does not exist return this value","type_expr":"Anything","text":"defaultValue: Anything - (Optional, default nil) in case the value does not exist return this value"}],"returns":{"type":"Anything","type_expr":"Anything","description":"Value's content"}}],"examples":[{"code":["[[\"#MILLER\", [\"&KILLS\", 1000, \"&RANK\", \"CAPTAIN\"]], [\"miller\",\"kills\"]] call BIS_fnc_dbValueReturn; // 1000"]}],"see_also":["BIS_fnc_dbClassCheck","BIS_fnc_dbClassId","BIS_fnc_dbClassIndex","BIS_fnc_dbClassList","BIS_fnc_dbClassRemove","BIS_fnc_dbClassReturn","BIS_fnc_dbClassSet","BIS_fnc_dbConfigPath","BIS_fnc_dbImportConfig","BIS_fnc_dbImportXML","BIS_fnc_dbisClass","BIS_fnc_dbisValue","BIS_fnc_dbPrint","BIS_fnc_dbSymbolClass","BIS_fnc_dbSymbolValue","BIS_fnc_dbValueCheck","BIS_fnc_dbValueId","BIS_fnc_dbValueIndex","BIS_fnc_dbValueList","BIS_fnc_dbValueRemove","BIS_fnc_dbValueSet"]},{"name":"BIS_fnc_dbValueSet","title":"BIS fnc dbValueSet","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_dbValueSet","revid":379264,"updated":"2026-10-30T23:43:23Z","groups":["Database"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Add value to Scripted Database. If the provided path does not exist it is created, otherwise the value is overwritten. The passed array gets modified.","syntaxes":[{"syntax":"[database, path, newvalue] call BIS_fnc_dbValueSet","params":[{"name":"database","type":"Array","description":"database array","type_expr":"Array"},{"name":"path","type":"Array","description":"path to value","type_expr":"Array"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"True if value was added"}}],"examples":[{"code":["private _db = [\"#MILLER\", [\"&KILLS\", 1000, \"&RANK\", \"CAPTAIN\"]];\n[_db, [\"miller\",\"kills\"],200] call BIS_fnc_dbValueSet;\n_db // [\"#MILLER\",[\"&KILLS\",200,\"&RANK\",\"CAPTAIN\"]]"]},{"code":["private _db = [\"#MILLER\", [\"&KILLS\", 1000, \"&RANK\", \"CAPTAIN\"]];\n[_db, [\"miller\",\"iq\"],200] call BIS_fnc_dbValueSet;\n_db // [\"#MILLER\",[\"&KILLS\",1000,\"&RANK\",\"CAPTAIN\",\"&IQ\",200]]"]}],"see_also":["BIS_fnc_dbClassCheck","BIS_fnc_dbClassId","BIS_fnc_dbClassIndex","BIS_fnc_dbClassList","BIS_fnc_dbClassRemove","BIS_fnc_dbClassReturn","BIS_fnc_dbClassSet","BIS_fnc_dbConfigPath","BIS_fnc_dbImportConfig","BIS_fnc_dbImportXML","BIS_fnc_dbisClass","BIS_fnc_dbisValue","BIS_fnc_dbPrint","BIS_fnc_dbSymbolClass","BIS_fnc_dbSymbolValue","BIS_fnc_dbValueCheck","BIS_fnc_dbValueId","BIS_fnc_dbValueIndex","BIS_fnc_dbValueList","BIS_fnc_dbValueRemove","BIS_fnc_dbValueReturn"]},{"name":"BIS_fnc_debugConsoleExec","title":"BIS fnc debugConsoleExec","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_debugConsoleExec","revid":348453,"updated":"2023-11-08T13:00:17Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Executes Debug Console code.","syntaxes":[{"syntax":"[target, code] call BIS_fnc_debugConsoleExec","params":[{"name":"target","type":"Number -","description":"Number -\n\n- 0 - local\n- 1 - global\n- 2 - server","type_expr":"Number","text":"target: Number -\n\n- 0 - local\n- 1 - global\n- 2 - server"},{"name":"code","type":"Code","description":"code to be executed","type_expr":"Code"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[1,{hint \"Hello Players!\"}] call BIS_fnc_debugConsoleExec;"]}],"see_also":["Arma 3: Debug Console","BIS_fnc_isDebugConsoleAllowed"]},{"name":"BIS_fnc_debugProfile","title":"BIS fnc debugProfile","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_debugProfile","revid":309379,"updated":"2022-05-05T12:04:33Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Purges user profile from unwanted BIS_fnc_diagAAR data. If more than 7500 entries are found, the user is asked to delete profileNamespace variable **BIS_fnc_diagAAR_data**.","syntaxes":[{"syntax":"call BIS_fnc_debugProfile","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_debugProfile;"]}],"see_also":["BIS_fnc_diagAAR","BIS_fnc_GUImessage"]},{"name":"BIS_fnc_decodeFlags","title":"BIS fnc decodeFlags","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_decodeFlags","revid":349095,"updated":"2023-11-08T14:49:33Z","groups":["Bitwise"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Decodes a single scalar into array of unique binary flags with indexes between 0-15.","syntaxes":[{"syntax":"scalar call BIS_fnc_decodeFlags","params":[{"name":"scalar","type":"Number","description":"scalar (max. 65535, 2^16-1)","type_expr":"Number"}],"returns":{"type":"Array","type_expr":"Array","description":"flags (See parameter of BIS_fnc_encodeFlags)"}}],"examples":[{"code":["private _decodedFlags = 13 call BIS_fnc_decodeFlags;//Returns [0,2,3]"]}],"see_also":["BIS_fnc_encodeFlags"]},{"name":"BIS_fnc_decodeFlags2","title":"BIS fnc decodeFlags2","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_decodeFlags2","revid":327243,"updated":"2022-07-12T22:11:47Z","groups":["Bitwise"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Decodes a single scalar into array of unique binary flags (zeroes or ones).\n\n> [!NOTE]\n> The maximal decodable number is **16777215** (224 - 1).","syntaxes":[{"syntax":"[value, size] call BIS_fnc_decodeFlags2","params":[{"name":"value","type":"Number","optional":true,"default":"0","description":"the value to be converted","type_expr":"Number","text":"value: Number - (Optional, default 0) the value to be converted"},{"name":"size","type":"Number","optional":true,"default":"1","description":"wanted array size","type_expr":"Number","text":"size: Number - (Optional, default 1) wanted array size"}],"returns":{"type":"Array of Numbers","type_expr":"Array<Number>","description":"\"boolean\" flags where 0 = false and 1 = true"}}],"examples":[{"code":["private _result = 13 call BIS_fnc_decodeFlags2; // returns [1,0,1,1]"]},{"code":["private _result = [13, 8] call BIS_fnc_decodeFlags2; // returns [1,0,1,1,0,0,0,0]"]}],"see_also":["BIS_fnc_encodeFlags","BIS_fnc_encodeFlags2","BIS_fnc_encodeFlags4","BIS_fnc_encodeFlags8","BIS_fnc_decodeFlags","BIS_fnc_decodeFlags4","BIS_fnc_decodeFlags8"]},{"name":"BIS_fnc_decodeFlags4","title":"BIS fnc decodeFlags4","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_decodeFlags4","revid":373738,"updated":"2025-06-24T18:40:13Z","groups":["Bitwise"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Decodes a single scalar into array of unique 4-state flags (values 0,1,2,3).","syntaxes":[{"syntax":"[encodedFlags, size] call BIS_fnc_decodeFlags4","params":[{"name":"encodedFlags","type":"Number","description":"non-decimal number between 0 and 16777215","type_expr":"Number"},{"name":"size","type":"Number","optional":true,"default":"-1","description":"output size. Size -1 means output will not be resized","type_expr":"Number","text":"size: Number - (Optional, default -1) output size. Size -1 means output will not be resized"}],"returns":{"type":"Number","type_expr":"Number","description":"decoded flags"}}],"examples":[{"code":["private _decodedFlags = 225 call BIS_fnc_decodeFlags4; // [1,0,2,3]"]},{"code":["private _decodedFlags = [225, 8] call BIS_fnc_decodeFlags4; // [1,0,2,3,0,0,0,0]"]}],"see_also":["BIS_fnc_encodeFlags4"]},{"name":"BIS_fnc_decodeFlags8","title":"BIS fnc decodeFlags8","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_decodeFlags8","revid":373739,"updated":"2025-06-24T19:02:20Z","groups":["Bitwise"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Decodes a single scalar into array of unique 8-state flags (values 0,1,2,3,4,5,6,7).","syntaxes":[{"syntax":"[encodedFlags, size] call BIS_fnc_decodeFlags8","params":[{"name":"encodedFlags","type":"Number","description":"non-decimal number between 0 and 16777215","type_expr":"Number"},{"name":"size","type":"Number","optional":true,"default":"-1","description":"output size. Size -1 means output will not be resized","type_expr":"Number","text":"size: Number - (Optional, default -1) output size. Size -1 means output will not be resized"}],"returns":{"type":"Number","type_expr":"Number","description":"decoded flags"}}],"examples":[{"code":["private _decodedFlags = 4311 call BIS_fnc_decodeFlags8; // [7,2,3,0,1]"]},{"code":["private _decodedFlags = [4311, 8] call BIS_fnc_decodeFlags8; // [7,2,3,0,1,0,0,0]"]}],"see_also":["BIS_fnc_encodeFlags8"]},{"name":"BIS_fnc_deleteCounter","title":"BIS fnc deleteCounter","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_deleteCounter","revid":363649,"updated":"2024-04-11T15:44:05Z","groups":["Systems"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"global","effect":"local"},"description":"Delete the provided counter added by BIS_fnc_counter.","syntaxes":[{"syntax":"[varName] call BIS_fnc_deleteCounter","params":[{"name":"varName","type":"String or Array format [varName, namespace]","description":"default namespace is missionNamespace","type_expr":"String | Array"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[[\"TAG_Score\", player]] call BIS_fnc_deleteCounter;"]}],"see_also":["BIS_fnc_counter"]},{"name":"BIS_fnc_deleteInventory","title":"BIS fnc deleteInventory","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_deleteInventory","revid":353798,"updated":"2024-03-23T18:01:25Z","groups":["Inventory"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Delete loadout saved using BIS_fnc_saveInventory.","syntaxes":[{"syntax":"[unit, [target, loadout]] call BIS_fnc_deleteInventory","params":[{"name":"unit","type":"Object","description":"unit whose inventory should be saved","type_expr":"Object"},{"name":"target","type":"Namespace, Group or Object","description":"target where the loadout is stored","type_expr":"Namespace | Group | Object"},{"name":"loadout","type":"String","description":"loadout name","type_expr":"String"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[player, [missionNamespace, \"BIS_inv\"]] call BIS_fnc_deleteInventory;"]}],"see_also":["BIS_fnc_loadInventory","BIS_fnc_exportInventory","BIS_fnc_saveInventory","getUnitLoadout"]},{"name":"BIS_fnc_deleteTask","title":"BIS fnc deleteTask","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_deleteTask","revid":364798,"updated":"2024-06-14T14:01:53Z","groups":["Tasks"],"status":"ok","games":{"arma3":"1.06"},"since":"arma3 1.06","arma3_since":"1.06","locality":{"argument":"global","effect":"global"},"description":"Deletes given task.\n\n> [!NOTE]\n> See Arma 3: Task Framework.","syntaxes":[{"syntax":"[taskID, owner, removeFromJIP] call BIS_fnc_deleteTask","params":[{"name":"taskID","type":"String","description":"ID of the task","type_expr":"String"},{"name":"owner","type":"String","optional":true,"description":"owner of the task. Can be:\n\n- Boolean - true to use all playable units\n- Object - specific object\n- Group - all objects in the group\n- Side - all objects of the given side\n- Array - collection of above types","type_expr":"String","text":"owner: String - (Optional) owner of the task. Can be:\n\n- Boolean - true to use all playable units\n- Object - specific object\n- Group - all objects in the group\n- Side - all objects of the given side\n- Array - collection of above types"},{"name":"removeFromJIP","type":"Boolean","optional":true,"default":"false","description":"true to also remove task from JIP queue","type_expr":"Boolean","since":"arma3 2.08","text":"removeFromJIP: Boolean - (Optional, default false) true to also remove task from JIP queue"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"task_1\"] call BIS_fnc_deleteTask;"]},{"code":["[\"task_1\", west] call BIS_fnc_deleteTask;"]},{"code":["[\"task_1\", [west, player, group soldier]] call BIS_fnc_deleteTask;"]}],"see_also":["Arma 3: Task Framework"]},{"name":"BIS_fnc_deleteVehicleCrew","title":"BIS fnc deleteVehicleCrew","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_deleteVehicleCrew","revid":327416,"updated":"2022-07-12T22:11:59Z","groups":["Vehicles"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Deletes specific crew member directly from the vehicle.","syntaxes":[{"syntax":"[vehicle, crewMember] call BIS_fnc_deleteVehicleCrew","params":[{"name":"vehicle","type":"Object","type_expr":"Object"},{"name":"crewMember","type":"Object","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[BIS_tank, gunner BIS_tank] call BIS_fnc_deleteVehicleCrew;"]}],"see_also":["crew"]},{"name":"BIS_fnc_deltaTime","title":"BIS fnc deltaTime","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_deltaTime","revid":364505,"updated":"2024-05-16T20:42:05Z","groups":["Math","Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Calculates and returns the time's delta between previous and current call to this function.\n\n> [!NOTE]\n> This commands internally uses time. For accurate-critical time measurement, use diag_tickTime.","syntaxes":[{"syntax":"[id, clear] call BIS_fnc_deltaTime","params":[{"name":"id","type":"String","optional":true,"default":"\"generic\"","description":"used to not create conflicts between different systems calling this function, each system can calculate delta time since it last ticked. Will be a missionNamespace variable","type_expr":"String","text":"id: String - (Optional, default \"generic\") used to not create conflicts between different systems calling this function, each system can calculate delta time since it last ticked. Will be a missionNamespace variable"},{"name":"clear","type":"Boolean","optional":true,"default":"false","description":"if set to true, will delete the missionNamespace variable (defined by *id*)","type_expr":"Boolean","text":"clear: Boolean - (Optional, default false) if set to true, will delete the missionNamespace variable (defined by *id*)"}],"returns":{"type":"Number","type_expr":"Number","description":"the delta time - 0.001 if clear is true","text":"Number - the delta time - 0.001 if *clear* is true"}}],"examples":[{"code":["[\"TAG_duration\"] call BIS_fnc_deltaTime; // Defines the starting point\n// ...\nprivate _duration1 = [\"TAG_duration\"] call BIS_fnc_deltaTime; // Gets time between starting point and now\n// ...\nprivate _duration2 = [\"TAG_duration\"] call BIS_fnc_deltaTime; // Gets time between _duration1 and now\n[\"TAG_duration\", true] call BIS_fnc_deltaTime; // deletes the global variable \"TAG_duration\""]}],"see_also":["diag_tickTime","diag_deltaTime"]},{"name":"BIS_fnc_destroyCity","title":"BIS fnc destroyCity","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_destroyCity","revid":349509,"updated":"2023-11-08T17:09:13Z","groups":["Environment"],"status":"ok","games":{"arma2oa":"1.56","tkoh":"1.00","arma3":"0.50"},"since":"arma2oa 1.56","arma3_since":"0.50","locality":{"effect":"global","server_exec":true},"description":"Destroys building in given area based on input seed.","syntaxes":[{"syntax":"[position, areaSize, seed, blacklist] call BIS_fnc_destroyCity","params":[{"name":"position","type":"Object, String or Position","description":"center of the area:\n\n- Object - position of the object will be used\n- String - marker name\n- Position","type_expr":"Object | String | Position"},{"name":"areaSize","type":"Number","optional":true,"default":"1000","description":"area radius","type_expr":"Number","text":"areaSize: Number - (Optional, default 1000) area radius"},{"name":"seed","type":"Number","optional":true,"default":"1138","description":"destruction's random seed","type_expr":"Number","text":"seed: Number - (Optional, default 1138) destruction's random seed"},{"name":"blacklist","type":"Array","optional":true,"default":"`[]`","description":"array of spared buildings","type_expr":"Array","text":"blacklist: Array - (Optional, default `[]`) array of spared buildings"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when completed"}}],"examples":[{"code":["[\"destroyBase\", 500, 42, [ourHouseInTheMiddleOfTheStreet]] call BIS_fnc_destroyCity;"]}],"see_also":["setDamage","nearestBuilding","buildingPos"]},{"name":"BIS_fnc_destroyer01AnimateHangarDoors","title":"BIS fnc destroyer01AnimateHangarDoors","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_destroyer01AnimateHangarDoors","revid":379553,"updated":"2026-10-31T13:47:28Z","groups":["Destroyer"],"status":"ok","games":{"arma3":"1.84"},"since":"arma3 1.84","arma3_since":"1.84","description":"Opens or closes the destroyer's hangar doors by animating the six animations `Door_Hangar_1_1_open` ... `Door_Hangar_1_3_open` and `Door_Hangar_2_1_open` ... `Door_Hangar_2_3_open` of the given ship part to the given phase.\nUnless the animation is instant, it also spawns BIS_fnc_destroyer01PlayHangarDoorSound at the part's `Door_Hangar_SoundPos` memory point.\nThe function is spawned by BIS_fnc_destroyer01OperateHangarDoors (the hangar door user actions, which use the `Land_Destroyer_01_hull_04_F` part) and, according to its header, used by the destroyer's Eden attributes. It can also be used in scripts. It does nothing if the ship part is objNull.","syntaxes":[{"syntax":"[shipPart, phase, instant] call BIS_fnc_destroyer01AnimateHangarDoors","params":[{"name":"shipPart","type":"Object","description":"the ship part that has the hangar doors (`Land_Destroyer_01_hull_04_F`)","type_expr":"Object"},{"name":"phase","type":"Number","optional":true,"default":"0","description":"animation phase of the doors: 1 open, 0 closed","type_expr":"Number","text":"phase: Number - (Optional, default 0) animation phase of the doors: 1 open, 0 closed"},{"name":"instant","type":"Boolean","optional":true,"default":"false","description":"true to set the doors to the phase instantly and without sound, false to animate them smoothly with sound","type_expr":"Boolean","text":"instant: Boolean - (Optional, default false) true to set the doors to the phase instantly and without sound, false to animate them smoothly with sound"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["// open the hangar doors of the destroyer named myDestroyer (on the server, where the ship's parts are known)\nprivate _hull = [myDestroyer, \"Land_Destroyer_01_hull_04_F\"] call BIS_fnc_destroyer01GetShipPart;\n[_hull, 1, false] call BIS_fnc_destroyer01AnimateHangarDoors;"]}],"see_also":["BIS_fnc_destroyer01OperateHangarDoors","BIS_fnc_destroyer01PlayHangarDoorSound","BIS_fnc_destroyer01GetShipPart","animate"]},{"name":"BIS_fnc_destroyer01EdenDelete","title":"BIS fnc destroyer01EdenDelete","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_destroyer01EdenDelete","revid":379554,"updated":"2026-10-31T13:48:14Z","groups":["Destroyer"],"status":"ok","games":{"arma3":"1.84"},"since":"arma3 1.84","arma3_since":"1.84","locality":{"effect":"global"},"description":"Deletes all parts of a multi-part ship, i.e. every object stored in the base object's `\"bis_carrierParts\"` variable (see BIS_fnc_destroyer01Init).\nThe function is called by the `UnregisteredFromWorld3DEN` event handler of the ship's base class, so that the parts disappear when the ship is deleted in the Eden Editor. It does nothing outside the server.","syntaxes":[{"syntax":"[ship] call BIS_fnc_destroyer01EdenDelete","params":[{"name":"ship","type":"Object","description":"the ship's base object","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"Event handler of the ship's base class:\n\n```cpp\nclass EventHandlers\n{\n    UnregisteredFromWorld3DEN = \"_this call BIS_fnc_Destroyer01EdenDelete\";\n};\n```"}],"see_also":["BIS_fnc_destroyer01Init","BIS_fnc_destroyer01EdenInit","BIS_fnc_destroyer01PosUpdate","BIS_fnc_carrier01EdenDelete"]},{"name":"BIS_fnc_destroyer01EdenInit","title":"BIS fnc destroyer01EdenInit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_destroyer01EdenInit","revid":378106,"updated":"2026-02-14T23:03:19Z","groups":["Destroyer"],"status":"ok","games":{"arma3":"1.84"},"since":"arma3 1.84","arma3_since":"1.84","description":"- This is a sub function designed to assemble dynamic ship (multi-part structure) in EDEN editor. Ship consists of multiple sub-objects that are linked together based on precise memory point positions in 3D space. Function will update initial init setup on EDEN editor invoked.","syntaxes":[{"syntax":"[mode] call BIS_fnc_destroyer01EdenInit","params":[{"name":"mode","type":"Number","description":"0 for ship base, 1 for array of objects","type_expr":"Number"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["class Eventhandlers\n{\n    init = \"_this call BIS_fnc_Destroyer01Init\";                                //main init fnc, will assemble ship in game\n    AttributesChanged3DEN = \"_this call BIS_fnc_Destroyer01PosUpdate\";            //function to update objects position in EDEN editor if attributes changed by player\n    Dragged3DEN = \"_this call BIS_fnc_Destroyer01PosUpdate\";                    //function to update objects position in EDEN editor if attributes changed by player\n    RegisteredToWorld3DEN = \"_this call BIS_fnc_Destroyer01EdenInit\";            //initial EDEN init fnc (main init is still called)\n    UnregisteredFromWorld3DEN = \"_this call BIS_fnc_Destroyer01EdenDelete\";        //function  to delete all ship objects in EDEN editor\n};"]}],"docblock":{"text":"Author: Bravo Zero One development\n- John_Spartan\n\nDescription:\n- This is a sub function designed to assemble dynamic ship (multi-part structure) in EDEN editor. Ship consists of multiple sub-objects that are linked together based on precise memory point positions in 3D space.\nFunction will update initial init setup on EDEN editor invoked.\n\nExecution:\n- Call from EH on the main ship's base model (blank model with memory points and reference config).\n\n    Example:\n    class Eventhandlers\n    {\n        init = \"_this call BIS_fnc_Destroyer01Init\";                                //main init fnc, will assemble ship in game\n        AttributesChanged3DEN = \"_this call BIS_fnc_Destroyer01PosUpdate\";            //function to update objects position in EDEN editor if attributes changed by player\n        Dragged3DEN = \"_this call BIS_fnc_Destroyer01PosUpdate\";                    //function to update objects position in EDEN editor if attributes changed by player\n        RegisteredToWorld3DEN = \"_this call BIS_fnc_Destroyer01EdenInit\";            //initial EDEN init fnc (main init is still called)\n        UnregisteredFromWorld3DEN = \"_this call BIS_fnc_Destroyer01EdenDelete\";        //function  to delete all ship objects in EDEN editor\n    };\n\nRequirements:\n- An array of ship parts/objects as a variable attached to main ship base. This array is created by main BIS_fnc_Destroyer01Init.\n\nParameter(s):\n    _this select 0: mode (Scalar)\n    0: ship Base/object\n    and\n    1: array of objects in variable in base objects names-pace [\"bis_carrierParts\", []];\n\nReturns: nothing\nResult: Ship's position is updated in EDEN editor.","author":"Bravo Zero One development, John_Spartan"},"filled_from_docblock":["description","examples"]},{"name":"BIS_fnc_destroyer01GetShipPart","title":"BIS fnc destroyer01GetShipPart","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_destroyer01GetShipPart","revid":379555,"updated":"2026-10-31T13:48:52Z","groups":["Destroyer"],"status":"ok","games":{"arma3":"1.84"},"since":"arma3 1.84","arma3_since":"1.84","description":"Helper function that returns one part of a multi-part ship by its class name. It searches the ship's `\"bis_carrierParts\"` variable, which BIS_fnc_destroyer01Init creates on the server.\nIt is used by the destroyer's Eden Editor attribute expressions (e.g. to pass the hull part to BIS_fnc_destroyer01InitHullNumbers) and can also be used in scripts.\n\n> [!IMPORTANT]\n> The function only works on the server. On other machines, and when the ship has no parts or no class name is given, it returns Nothing.\n\nIf several parts have the same class, the last one in the list is returned.","syntaxes":[{"syntax":"[ship, partClass] call BIS_fnc_destroyer01GetShipPart","params":[{"name":"ship","type":"Object","description":"the ship's base object","type_expr":"Object"},{"name":"partClass","type":"String","description":"class name of the part to find, e.g. `\"Land_Destroyer_01_hull_04_F\"`","type_expr":"String"}],"returns":{"type":"Object","type_expr":"Object","description":"the part, or objNull if the ship has no part of this class"}}],"examples":[{"code":["// on the server: open the hangar doors of the destroyer named myDestroyer\nprivate _hull = [myDestroyer, \"Land_Destroyer_01_hull_04_F\"] call BIS_fnc_destroyer01GetShipPart;\n[_hull, 1, false] call BIS_fnc_destroyer01AnimateHangarDoors;"]}],"see_also":["BIS_fnc_destroyer01Init","BIS_fnc_destroyer01InitHullNumbers","BIS_fnc_destroyer01AnimateHangarDoors"]},{"name":"BIS_fnc_destroyer01HandleDamage","title":"BIS fnc destroyer01HandleDamage","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_destroyer01HandleDamage","revid":273884,"updated":"2021-06-13T01:12:52Z","groups":["Destroyer"],"status":"ok","games":{"arma3":"1.84"},"since":"arma3 1.84","arma3_since":"1.84","description":"- This is a damage visual FX simulation function designed to animate ships bridge windows when shot. Due to engine limitation (damage simulation is disabled for indestructible objects e.g. ships components) this workaround is applied.","syntaxes":[{"syntax":"[] call BIS_fnc_destroyer01HandleDamage","params":[{"name":"mode","type":"Number","type_expr":"Number","description":"(Scalar)","text":"0: (Scalar)","source":"docblock"},{"name":"param0","type":"Array","types":["Array"],"description":"https://community.bistudio.com/wiki/Arma_3:_Event_Handlers#HitPart","text":"0: event Handler Array as documented here - https://community.bistudio.com/wiki/Arma_3:_Event_Handlers#HitPart","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","text":"nothing\nDestroyer (ship) window textures are swapped for damaged ones. Simple swap.","source":"docblock"}}],"examples":[{"code":["class Eventhandlers\n{\n    HitPart = \"_this call BIS_fnc_Destroyer01HandleDamage;\";\n};"]}],"docblock":{"text":"Author: Bravo Zero One development\n- John_Spartan\n\nDescription:\n- This is a damage visual FX simulation function designed to animate ships bridge windows when shot.\n  Due to engine limitation (damage simulation is disabled for indestructible objects e.g. ships components) this workaround is applied.\n\nExecution:\n- Call from EH on the ship's model part with windows.\n\n    Example:\n    class Eventhandlers\n    {\n        HitPart = \"_this call BIS_fnc_Destroyer01HandleDamage;\";\n    };\n\nRequirements:\n- Compatible object (e.g. ship component) must have a set of selections that are setup and named by convention.\n  Selections must be defined as hidden selections in order for setObjectTexture to work.\n\nParameter(s):\n    _this select 0: mode (Scalar)\n    0: event Handler Array as documented here - https://community.bistudio.com/wiki/Arma_3:_Event_Handlers#HitPart\n\nReturns: nothing\nResult: Destroyer (ship) window textures are swapped for damaged ones. Simple swap.","author":"Bravo Zero One development, John_Spartan"},"filled_from_docblock":["description","params","returns","examples"]},{"name":"BIS_fnc_destroyer01Init","title":"BIS fnc destroyer01Init","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_destroyer01Init","revid":379556,"updated":"2026-10-31T13:49:06Z","groups":["Destroyer"],"status":"ok","games":{"arma3":"1.84"},"since":"arma3 1.84","arma3_since":"1.84","locality":{"effect":"global"},"description":"Main function that assembles a multi-part ship such as the destroyer. The ship's base object is a blank model with memory points; every other part is a separate object that is created and placed on one of these memory points.\nThe function is called by the `init` event handler of the ship's base class and does nothing outside the server. It is not meant to be called from scripts: calling it again creates a second set of parts.\n\nThe parts are read from the base class's `multiStructureParts[]` config array, where each entry has the format `{ \"partClassName\", \"memoryPointName\" }`. For each entry the function:\n\n- creates the part with createVehicle (special \"CAN_COLLIDE\")\n- gives it the base's direction, pitch and bank\n- places it with setPosWorld on the base's memory point\n- disables its damage with allowDamage\n\nFinally it stores the created parts on the base object as the public variable `\"bis_carrierParts\"`, format `[[part, memoryPointName], ...]`, which the other destroyer functions read.","syntaxes":[{"syntax":"[ship] call BIS_fnc_destroyer01Init","params":[{"name":"ship","type":"Object","description":"the ship's base object (the init event handler passes it as `_this`)","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"Event handlers of the ship's base class:\n\n```cpp\nclass EventHandlers\n{\n    init = \"_this call BIS_fnc_Destroyer01Init\";\n    AttributesChanged3DEN = \"_this call BIS_fnc_Destroyer01EdenInit\";\n    Dragged3DEN = \"_this call BIS_fnc_Destroyer01PosUpdate\";\n    RegisteredToWorld3DEN = \"_this call BIS_fnc_Destroyer01EdenInit\";\n    UnregisteredFromWorld3DEN = \"_this call BIS_fnc_Destroyer01EdenDelete\";\n};\n```"},{"text":"Get the parts created by the function (server only):\n\n```sqf\nprivate _parts = myDestroyer getVariable [\"bis_carrierParts\", []];\n{\n    _x params [\"_part\", \"_memoryPoint\"];\n    systemChat format [\"%1 at %2\", typeOf _part, _memoryPoint];\n} forEach _parts;\n```","code":["private _parts = myDestroyer getVariable [\"bis_carrierParts\", []];\n{\n\t_x params [\"_part\", \"_memoryPoint\"];\n\tsystemChat format [\"%1 at %2\", typeOf _part, _memoryPoint];\n} forEach _parts;"]}],"see_also":["BIS_fnc_destroyer01EdenInit","BIS_fnc_destroyer01PosUpdate","BIS_fnc_destroyer01EdenDelete","BIS_fnc_destroyer01GetShipPart","BIS_fnc_carrier01Init"],"categories_extra":["Pages with SQF errors"]},{"name":"BIS_fnc_destroyer01InitHullNumbers","title":"BIS fnc destroyer01InitHullNumbers","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_destroyer01InitHullNumbers","revid":379557,"updated":"2026-10-31T13:49:20Z","groups":["Destroyer"],"status":"ok","games":{"arma3":"1.84"},"since":"arma3 1.84","arma3_since":"1.84","locality":{"effect":"global"},"description":"Sets the number shown on one of the destroyer's hull number selections. It applies the texture `\\A3\\Boat_F_Destroyer\\Destroyer_01\\Data\\Destroyer_01_N_0<number>_co.paa` to the given hidden selection of a ship part with setObjectTextureGlobal. Because the number is put after a fixed \"0\" in the file name, it is meant to be a single digit (0..9).\nThe function is called by the expressions of the destroyer's custom hull number attributes in the Eden Editor, and does nothing outside the server.","syntaxes":[{"syntax":"[shipPart, number, selection] call BIS_fnc_destroyer01InitHullNumbers","params":[{"name":"shipPart","type":"Object","description":"the ship part that has the hull number selections, e.g. the result of BIS_fnc_destroyer01GetShipPart","type_expr":"Object"},{"name":"number","type":"Number","optional":true,"default":"0","description":"digit to display","type_expr":"Number","text":"number: Number - (Optional, default 0) digit to display"},{"name":"selection","type":"Number","optional":true,"default":"0","description":"index of the hidden selection to retexture","type_expr":"Number","text":"selection: Number - (Optional, default 0) index of the hidden selection to retexture"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"Eden attribute of the destroyer that sets the first digit (from the function's header):\n\n```cpp\nclass CustomShipNumber1\n{\n    displayName = \"$STR_3den_object_attribute_CustomShipNumber1_displayname\";\n    tooltip = \"$STR_3den_object_attribute_CustomShipNumber1_tooltip\";\n    property = \"CustomShipNumber1\";\n    control = \"EditShort\";\n    expression = \"[([_this, 'Land_Destroyer_01_hull_01_F'] call bis_fnc_destroyer01GetShipPart), _value, 0] spawn bis_fnc_destroyer01InitHullNumbers;\";\n    defaultValue = \"0\";\n    validate = \"number\";\n    condition = \"object\";\n    typeName = \"NUMBER\";\n};\n```"},{"code":["// on the server: show the digit 7 on hidden selection 0 of the first hull part\nprivate _hull = [myDestroyer, \"Land_Destroyer_01_hull_01_F\"] call BIS_fnc_destroyer01GetShipPart;\n[_hull, 7, 0] call BIS_fnc_destroyer01InitHullNumbers;"]}],"see_also":["BIS_fnc_destroyer01GetShipPart","BIS_fnc_destroyer01Init","setObjectTextureGlobal"]},{"name":"BIS_fnc_destroyer01OperateHangarDoors","title":"BIS fnc destroyer01OperateHangarDoors","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_destroyer01OperateHangarDoors","revid":364795,"updated":"2024-06-13T20:08:17Z","groups":["Destroyer"],"status":"ok","games":{"arma3":"1.84"},"since":"arma3 1.84","arma3_since":"1.84","description":"This function is designed to handle animations of ship hangar doors from vehicle user action (see Examples).\nIt calls BIS_fnc_destroyer01AnimateHangarDoors.\n\n> [!IMPORTANT]\n> Object (ship) must have all animations correctly defined and user actions configured.","syntaxes":[{"syntax":"[shipPart, doorState] call BIS_fnc_destroyer01OperateHangarDoors","params":[{"name":"shipPart","type":"Object","type_expr":"Object"},{"name":"doorState","type":"Number","description":"doors' animation state; 1 to open, 0 to close","type_expr":"Number"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"```sqf\n[this, 1] call BIS_fnc_destroyer01OperateHangarDoors; // to open doors\n[this, 0] call BIS_fnc_destroyer01OperateHangarDoors; // to close doors\n```\n\n```cpp\nclass OpenHangarDoor_1\n{\n    displayNameDefault        = \"<img image='\\A3\\Ui_f\\data\\IGUI\\Cfg\\Actions\\open_door_ca.paa' size='2.5' />\";\n    displayName             = \"$STR_DN_OUT_O_DOOR\";\n    position                 = \"pos_Door_Hangar_1_Trigger\";\n    priority                 = 0.4;\n    radius                     = 1.5;\n    onlyForPlayer             = 0;\n    condition                 = \"(((nearestObjects [this, ['Land_Destroyer_01_hull_04_F'], 50, false]) select 0) animationPhase 'Door_Hangar_1_1_open') < 0.1;\";\n    statement                 = \"[this, 1] call BIS_fnc_destroyer01OperateHangarDoors;\";\n};\n\nclass CloseHangarDoor_1 : OpenHangarDoor_1\n{\n    displayName             = \"$STR_DN_OUT_C_DOOR\";\n    position                 = \"pos_Door_Hangar_1_Trigger\";\n    condition                 = \"(((nearestObjects [this, ['Land_Destroyer_01_hull_04_F'], 50, false]) select 0) animationPhase 'Door_Hangar_1_1_open') >= 0.1;\";\n    statement                 = \"[this, 0] call BIS_fnc_destroyer01OperateHangarDoors;\";\n};\n```","code":["[this, 1] call BIS_fnc_destroyer01OperateHangarDoors; // to open doors\n[this, 0] call BIS_fnc_destroyer01OperateHangarDoors; // to close doors"]}],"see_also":["BIS_fnc_destroyer01AnimateHangarDoors"]},{"name":"BIS_fnc_destroyer01PlayHangarDoorSound","title":"BIS fnc destroyer01PlayHangarDoorSound","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_destroyer01PlayHangarDoorSound","revid":379558,"updated":"2026-10-31T13:49:42Z","groups":["Destroyer"],"status":"ok","games":{"arma3":"1.84"},"since":"arma3 1.84","arma3_since":"1.84","locality":{"effect":"global"},"exec":"spawn","description":"Plays the sounds of the destroyer's moving hangar doors with playSound3D (volume 5, audible up to 15 m):\n\n1. a slam sound (`A3\\sounds_f\\structures\\doors\\servoramp\\servorampslam.wss`)\n1. one second later, the servo sound (`A3\\sounds_f\\structures\\doors\\servoramp\\servorampsound_2.wss`)\n1. the slam sound again once the part's `Door_Hangar_1_1_open` animation phase equals the target phase.\n\nThe function is spawned by BIS_fnc_destroyer01AnimateHangarDoors when the doors are animated smoothly; it is meant for internal use.","syntaxes":[{"syntax":"[shipPart, position, phase] spawn BIS_fnc_destroyer01PlayHangarDoorSound","params":[{"name":"shipPart","type":"Object","description":"the ship part whose hangar doors move; it is the sound source and its animation phase is watched","type_expr":"Object"},{"name":"position","type":"Array format PositionASL","optional":true,"default":"[0,0,0]","description":"where the sounds are played","type_expr":"PositionASL","types":["Array","PositionASL"],"text":"position: Array format PositionASL - (Optional, default [0,0,0]) where the sounds are played"},{"name":"phase","type":"Number","optional":true,"default":"0","description":"target phase of the doors; the last sound plays when `Door_Hangar_1_1_open` reaches it","type_expr":"Number","text":"phase: Number - (Optional, default 0) target phase of the doors; the last sound plays when `Door_Hangar_1_1_open` reaches it"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"How BIS_fnc_destroyer01AnimateHangarDoors uses it:\n\n```sqf\nprivate _soundPos = _shipPart modelToWorldWorld (_shipPart selectionPosition \"Door_Hangar_SoundPos\");\n[_shipPart, _soundPos, _animationState] spawn BIS_fnc_destroyer01PlayHangarDoorSound;\n```","code":["private _soundPos = _shipPart modelToWorldWorld (_shipPart selectionPosition \"Door_Hangar_SoundPos\");\n[_shipPart, _soundPos, _animationState] spawn BIS_fnc_destroyer01PlayHangarDoorSound;"]}],"see_also":["BIS_fnc_destroyer01AnimateHangarDoors","BIS_fnc_destroyer01OperateHangarDoors","playSound3D"]},{"name":"BIS_fnc_destroyer01PosUpdate","title":"BIS fnc destroyer01PosUpdate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_destroyer01PosUpdate","revid":379559,"updated":"2026-10-31T13:50:34Z","groups":["Destroyer"],"status":"ok","games":{"arma3":"1.84"},"since":"arma3 1.84","arma3_since":"1.84","locality":{"effect":"global"},"description":"Moves all parts of a multi-part ship back onto their places after the ship's base object has been moved. For every part stored in the base's `\"bis_carrierParts\"` variable (see BIS_fnc_destroyer01Init), it applies the base's direction, pitch and bank and puts the part on its memory point of the base.\nThe function is called by the `Dragged3DEN` event handler of the ship's base class, so that the ship follows when it is dragged in the Eden Editor. It does nothing outside the server.","syntaxes":[{"syntax":"[ship] call BIS_fnc_destroyer01PosUpdate","params":[{"name":"ship","type":"Object","description":"the ship's base object","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"Event handler of the ship's base class:\n\n```cpp\nclass EventHandlers\n{\n    Dragged3DEN = \"_this call BIS_fnc_Destroyer01PosUpdate\";\n};\n```"}],"see_also":["BIS_fnc_destroyer01Init","BIS_fnc_destroyer01EdenInit","BIS_fnc_destroyer01EdenDelete","BIS_fnc_carrier01PosUpdate"]},{"name":"BIS_fnc_diagAAR","title":"BIS fnc diagAAR","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagAAR","revid":379560,"updated":"2026-10-31T13:52:21Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Opens an **AAR** (After Action Review) display and fills it with data and Event Handlers. The display replays recordings made by BIS_fnc_diagAARrecord (recording is enabled by `diagAAR = 1;` in the mission's Description.ext), which are stored in profileNamespace in the variable \"BIS_fnc_diagAAR_data\".\n\n> [!IMPORTANT]\n> BIS_fnc_diagAARrecord **must** have been previously executed to have data to display. If there are no recordings for the current world, the display is closed and an error message is shown.\n\nThe display lists the recorded missions of the current world and their recordings:\n\n- selecting a mission draws the player's path from all its recordings on the map, with start and end markers, death markers and circles where the player moved less than 5 m between two steps\n- selecting a recording plays it back, one recorded step per second: units are drawn with their side colour (black when dead) and the player is highlighted; the player's deaths are marked in red on the timeline slider, which can be dragged to jump in time\n\nKeys:\n\n- <kbd>Space</kbd> - pause / resume the playback\n- <kbd>I</kbd> - cycle unit labels: none, unit identifier, unit type, damage\n- <kbd>Del</kbd> - delete the selected recording; <kbd>⇧ Shift</kbd> + <kbd>Del</kbd> - delete all recordings of the selected mission\n- <kbd>Esc</kbd> - quit the display (after confirmation)\n\nAll modes except \"Init\" are used internally by the Event Handlers that \"Init\" adds to the display.","syntaxes":[{"syntax":"[] call BIS_fnc_diagAAR","params":[],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if the AAR display (\"RscDisplayAAR\") was created, as returned by createDialog"}},{"syntax":"[mode, arguments] call BIS_fnc_diagAAR","params":[{"name":"mode","type":"String","description":"can be one of:\n\n- \"Init\" - Fill display with AAR data\n- \"Init_List\" - *internal function usage*\n- \"Display_keydown\" - *internal function usage*\n- \"Timeline_sliderposchanged\" - *internal function usage*\n- \"ListMissions_lbselchanged\" - *internal function usage*\n- \"ListSessions_lbselchanged\" - *internal function usage*; it plays the recording in a loop and must be spawned\n- \"draw\" - *internal function usage*","type_expr":"String"},{"name":"arguments","type":"Array","description":"Array\n\n- \"Init\" arguments: [display]: Display\n- \"Init_List\" arguments: [display]: Display\n- \"Display_keydown\" arguments: see onKeyDown event\n- \"Timeline_sliderposchanged\" arguments: see onSliderPosChanged event\n- \"ListMissions_lbselchanged\" arguments: see onLBSelChanged event\n- \"ListSessions_lbselchanged\" arguments: see onLBSelChanged event\n- \"draw\" arguments: see onDraw event","type_expr":"Array","text":"arguments: Array\n\n- \"Init\" arguments: [display]: Display\n- \"Init_List\" arguments: [display]: Display\n- \"Display_keydown\" arguments: see onKeyDown event\n- \"Timeline_sliderposchanged\" arguments: see onSliderPosChanged event\n- \"ListMissions_lbselchanged\" arguments: see onLBSelChanged event\n- \"ListSessions_lbselchanged\" arguments: see onLBSelChanged event\n- \"draw\" arguments: see onDraw event"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"for \"Display_keydown\" (true for Esc and Space, which overrides the default action of these keys), Nothing for the other modes","text":"Boolean for \"Display_keydown\" (true for <kbd>Esc</kbd> and <kbd>Space</kbd>, which overrides the default action of these keys), Nothing for the other modes"}}],"examples":[{"code":["[] call BIS_fnc_diagAAR; // opens the AAR display"]},{"code":["[\"Init\", [_anAARDisplay]] call BIS_fnc_diagAAR;"]}],"see_also":["BIS_fnc_diagAARrecord"]},{"name":"BIS_fnc_diagAARrecord","title":"BIS fnc diagAARrecord","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagAARrecord","revid":329377,"updated":"2022-07-27T13:08:54Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Starts recording units position and events for an **AAR** (After Action Review).\nThe following keys must be added to Description.ext for AAR to work properly:\n\n```cpp\ndiagAAR = 1;        // to enable diag AAR\ndiagAARauthor = 1;    // if description.ext/dev == profileName, allows the creator to debug himself\ndiagAARunits = 2;    // which units to record:\n                        // 1 = units player\n                        // 2 = allunits + alldead\n                        // any other value = player\ndiagAARdelay = 3;    // delay between recording steps\n```\n\nThe data can be accessed with `profileNamespace getVariable \"BIS_fnc_diagAAR_data\"`.","syntaxes":[{"syntax":"call BIS_fnc_diagAARrecord","params":[],"returns":{"type":"Number","type_expr":"Number","description":"the FSM handle (see execFSM)"}}],"examples":[{"code":["call BIS_fnc_diagAARrecord;"]}],"see_also":["BIS_fnc_diagAAR"]},{"name":"BIS_fnc_diagAnim","title":"BIS fnc diagAnim","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagAnim","revid":347979,"updated":"2023-11-08T09:52:31Z","groups":["Diagnostic"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Displays or logs animation states:\n\n- **animChanged** - when action is performed (only to debug.log)\n- **animDone** - when animation chain that was started by action is finished (only to debug.log)\n- **animStateChanged** - each animation state changes(debug.log + globalchat).","syntaxes":[{"syntax":"[target] call BIS_fnc_diagAnim","params":[{"name":"target","type":"Object","optional":true,"default":"player","description":"the unit whose animation should be logged","type_expr":"Object","text":"target: Object - (Optional, default player) - the unit whose animation should be logged"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_diagAnim;"]}]},{"name":"BIS_fnc_diagBulletCam","title":"BIS fnc diagBulletCam","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagBulletCam","revid":327735,"updated":"2022-07-13T10:30:15Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Add a \"bullet camera\" to shots fired by the specified unit.","syntaxes":[{"syntax":"unit call BIS_fnc_diagBulletCam","params":[{"name":"unit","type":"Object","description":"the shooting unit. Can be a vehicle.","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when done"}}],"examples":[{"code":["player call BIS_fnc_diagBulletCam;"]},{"code":["// bullet camera will be removed after 10s\n_unit = player;\n_unit call BIS_fnc_diagBulletCam;\n_ehIndex = _unit getVariable \"BIS_fnc_diagBulletCam_fired\";\nsleep 10;\n_unit removeEventHandler [\"fired\", _ehIndex];"]}]},{"name":"BIS_fnc_diagConfig","title":"BIS fnc diagConfig","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagConfig","revid":309644,"updated":"2022-05-05T12:07:55Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Prints config entries.","syntaxes":[{"syntax":"[param0, param1, param2] call BIS_fnc_diagConfig","params":[{"name":"param0","type":"Config","type_expr":"Config","default":"configFile","description":"config class which will be searched (default: configFile)","text":"0: CONFIG - config class which will be searched (default: configFile)","source":"docblock"},{"name":"param1","type":"String, Array","type_expr":"String | Array","description":"entry name(s) whose values will be printed","text":"1: STRING or ARRAY - entry name(s) whose values will be printed","source":"docblock"},{"name":"param2","type":"String","type_expr":"String","description":"scan mode, can be one of following:\n\"controls\" - recursively scans controls in root, class controls, class controlsBackground and in RscControlsGroup controls (type = 15).\n\"turrets\" - recursively scans vehicles's turrets.\n\"weapons\" - scans weapon muzzles and modes.\n(default) - scans just class roots.","text":"2: STRING - scan mode, can be one of following:\n\"controls\" - recursively scans controls in root, class controls, class controlsBackground and in RscControlsGroup controls (type = 15).\n\"turrets\" - recursively scans vehicles's turrets.\n\"weapons\" - scans weapon muzzles and modes.\n(default) - scans just class roots.","source":"docblock"}],"returns":{"type":"String","type_expr":"String","text":"STRING\n\nResults are printed to debug log and wiki compatible table is copied to clipboard.","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nPrints config entries.\n\nParameter(s):\n    0: CONFIG - config class which will be searched (default: configFile)\n    1: STRING or ARRAY - entry name(s) whose values will be printed\n    2: STRING - scan mode, can be one of following:\n        \"controls\" - recursively scans controls in root, class controls, class controlsBackground and in RscControlsGroup controls (type = 15).\n        \"turrets\" - recursively scans vehicles's turrets.\n        \"weapons\" - scans weapon muzzles and modes.\n        (default) - scans just class roots.\n\nReturns:\nSTRING\n\nResults are printed to debug log and wiki compatible table is copied to clipboard."},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_diagFindMissingAuthors","title":"BIS fnc diagFindMissingAuthors","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagFindMissingAuthors","revid":309317,"updated":"2022-05-05T12:04:26Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Copies a list of objects to the clipboard which miss the author attribute.","syntaxes":[{"syntax":"call BIS_fnc_diagFindMissingAuthors","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_diagFindMissingAuthors;"]}]},{"name":"BIS_fnc_diagHit","title":"BIS fnc diagHit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagHit","revid":309315,"updated":"2022-05-05T12:04:26Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Tracks received wounds. (getNumber (missionConfigFile >> \"diagHit\") > 0) has to be true.","syntaxes":[{"syntax":"call BIS_fnc_diagHit","params":[],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when activated"}}],"examples":[{"code":["call BIS_fnc_diagHit;"]}]},{"name":"BIS_fnc_diagJIRAlink","title":"BIS fnc diagJIRAlink","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagJIRAlink","revid":274097,"updated":"2021-06-13T01:16:35Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_diagJIRAlink","params":[],"returns":null}]},{"name":"BIS_fnc_diagKey","title":"BIS fnc diagKey","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagKey","revid":309361,"updated":"2022-05-05T12:04:31Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Tracks pressed keys. (getNumber (missionConfigFile >> \"diagKey\") > 0) has to be true.","syntaxes":[{"syntax":"call BIS_fnc_diagKey","params":[],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when activated"}}],"examples":[{"code":["call BIS_fnc_diagKey;"]}]},{"name":"BIS_fnc_diagKeyLayout","title":"BIS fnc diagKeyLayout","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagKeyLayout","revid":309542,"updated":"2022-05-05T12:06:57Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Exports default key layout to wiki template.","syntaxes":[{"syntax":"[param0, param1] call BIS_fnc_diagKeyLayout","params":[{"name":"param0","type":"String","type_expr":"String","description":"category, can be one of following\n\"\" - all controls in game\n\"All\"\n\"BasicInfantryControls\"\n\"Car\"\n\"Air\"\n\"Helicopter\"\n\"Submarine\"\n\"Buldozer\"\n\"UserActions\"","text":"0: STRING - category, can be one of following\n\"\" - all controls in game\n\"All\"\n\"BasicInfantryControls\"\n\"Car\"\n\"Air\"\n\"Helicopter\"\n\"Submarine\"\n\"Buldozer\"\n\"UserActions\"","source":"docblock"},{"name":"param1","type":"String","type_expr":"String","description":"selection method, can be one of following\n\"\" - single tap\n\"double\" - double tap\n\"LCtrl\" - with left control pressed\n\"RCtrl\" - with right control pressed\n\"LShift\" - with left shift pressed\n\"RShift\" - with right shift pressed","text":"1: STRING - selection method, can be one of following\n\"\" - single tap\n\"double\" - double tap\n\"LCtrl\" - with left control pressed\n\"RCtrl\" - with right control pressed\n\"LShift\" - with left shift pressed\n\"RShift\" - with right shift pressed","source":"docblock"}],"returns":{"type":"String","type_expr":"String","description":"wiki export text (also copied to clipboard)","text":"STRING - wiki export text (also copied to clipboard)","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nExports default key layout to wiki template.\n\nParameter(s):\n_this select 0: STRING - category, can be one of following\n    \"\" - all controls in game\n    \"All\"\n    \"BasicInfantryControls\"\n    \"Car\"\n    \"Air\"\n    \"Helicopter\"\n    \"Submarine\"\n    \"Buldozer\"\n    \"UserActions\"\n_this select 1: STRING - selection method, can be one of following\n    \"\" - single tap\n    \"double\" - double tap\n    \"LCtrl\" - with left control pressed\n    \"RCtrl\" - with right control pressed\n    \"LShift\" - with left shift pressed\n    \"RShift\" - with right shift pressed\n\nReturns:\nSTRING - wiki export text (also copied to clipboard)"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_diagKeyTest","title":"BIS fnc diagKeyTest","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagKeyTest","revid":348390,"updated":"2023-11-08T13:00:00Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns all user actions according to mode.","syntaxes":[{"syntax":"mode call BIS_fnc_diagKeyTest","params":[{"name":"mode","type":"Number","description":"can be:\n0 - Log all categories\n1 - Log Uncategorized\n2 - Log unassigned\n3 - Log undefined\n4 - Log localized names","type_expr":"Number"}],"returns":{"type":"String","type_expr":"String"}}],"examples":[{"code":["0 call BIS_fnc_diagKeyTest;"]}]},{"name":"BIS_fnc_diagKnownAsTarget","title":"BIS fnc diagKnownAsTarget","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagKnownAsTarget","revid":309532,"updated":"2022-05-05T12:06:51Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Visualize and profile which units know about one specific unit and how much they do. Calling function again stops diagnostics.","syntaxes":[{"syntax":"[param0, radius] call BIS_fnc_diagKnownAsTarget","params":[{"name":"param0","type":"Object","type_expr":"Object","default":"player","description":"profile unit (Object) [default player]","text":"0: profile unit (Object) [default player]","source":"docblock"},{"name":"radius","type":"Number","types":["Number"],"default":"1000m","description":"meters) [default 1000m]","text":"1: (Scalar - meters) [default 1000m]","source":"docblock"}],"returns":{"text":"-","source":"docblock"},"inferred":true}],"docblock":{"text":"File: fn_diagKnownAsTarget.sqf\n\nDescription:\nVisualize and profile which units know about one specific unit and how much they do.\nCalling function again stops diagnostics.\n\nParameter(s):\n_this select 0: profile unit (Object) [default player]\n_this select 1: radius (Scalar - meters) [default 1000m]\n\nReturns:\n-","meta":{"file":"fn_diagKnownAsTarget.sqf"}},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_diagKnownTargets","title":"BIS fnc diagKnownTargets","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagKnownTargets","revid":347981,"updated":"2023-11-08T09:53:29Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Visualize and profile which units one specific unit knows about and how much. Calling function again stops diagnostics.","syntaxes":[{"syntax":"[target, radius] call BIS_fnc_diagKnownTargets","params":[{"name":"target","type":"Object","optional":true,"default":"player","description":"profiled unit","type_expr":"Object","text":"target: Object - (Optional, default player) profiled unit"},{"name":"radius","type":"Number","optional":true,"default":"3000","description":"radius of the scanned area","type_expr":"Number","text":"radius: Number - (Optional, default 3000) radius of the scanned area"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[leader player, 500] call BIS_fnc_diagKnownTargets;"]}]},{"name":"BIS_fnc_diagLoop","title":"BIS fnc diagLoop","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagLoop","revid":348046,"updated":"2023-11-08T11:28:47Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","exec":"spawn","description":"Runs scripted loop. Repeated call terminates previous loops.","syntaxes":[{"syntax":"[code, delay] spawn BIS_fnc_diagLoop","params":[{"name":"code","type":"Code","description":"code to be executed","type_expr":"Code"},{"name":"code","type":"Number","optional":true,"default":"0.1","description":"delay between loops","type_expr":"Number","text":"code: Number - (Optional, default 0.1) delay between loops"}],"returns":{"type":"Script Handle","type_expr":"Script Handle","description":"spawn handle"}}],"examples":[{"code":["[{ systemChat \"Loop!\" }, 0.5] spawn BIS_fnc_diagLoop;"]}]},{"name":"BIS_fnc_diagMacros","title":"BIS fnc diagMacros","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagMacros","revid":309630,"updated":"2022-05-05T12:07:49Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Exports config macros.","syntaxes":[{"syntax":"[param0, param1] call BIS_fnc_diagMacros","params":[{"name":"param0","type":"Config, Array","type_expr":"Config | Array","description":"config container to be searched (e.g. configFile >> \"CfgVehicles\") or list of classes or classnames","text":"0: CONFIG or ARRAY - config container to be searched (e.g. configFile >> \"CfgVehicles\") or list of classes or classnames","source":"docblock"},{"name":"param1","type":"Array","type_expr":"Array","optional":true,"default":"- e.g","description":"list of macro names to be used (e.g. [\"MAPSIZE\",\"NAMESOUND\"])\n2 (Optional): STRING - macro category name (when param 0 is CONFIG, its classname is used by default - e.g. \"CfgVehicles\")","text":"1: ARRAY - list of macro names to be used (e.g. [\"MAPSIZE\",\"NAMESOUND\"])\n2 (Optional): STRING - macro category name (when param 0 is CONFIG, its classname is used by default - e.g. \"CfgVehicles\")","source":"docblock"}],"returns":{"type":"String","type_expr":"String","text":"STRING","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nExports config macros.\n\nParameter(s):\n    0: CONFIG or ARRAY - config container to be searched (e.g. configFile >> \"CfgVehicles\") or list of classes or classnames\n    1: ARRAY - list of macro names to be used (e.g. [\"MAPSIZE\",\"NAMESOUND\"])\n    2 (Optional): STRING - macro category name (when param 0 is CONFIG, its classname is used by default - e.g. \"CfgVehicles\")\n\nReturns:\nSTRING"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_diagMacrosAuthor","title":"BIS fnc diagMacrosAuthor","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagMacrosAuthor","revid":309536,"updated":"2022-05-05T12:06:52Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_diagMacrosEditorPreview","title":"BIS fnc diagMacrosEditorPreview","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagMacrosEditorPreview","revid":274051,"updated":"2021-06-13T01:15:52Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_diagMacrosEditorPreview","params":[],"returns":null}]},{"name":"BIS_fnc_diagMacrosMapSize","title":"BIS fnc diagMacrosMapSize","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagMacrosMapSize","revid":309506,"updated":"2022-05-05T12:06:33Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Prints mapSize values based on real object size and copies it to clipboard. Mission has to be running on order to get the values.","syntaxes":[{"syntax":"[param0, param1, param2] call BIS_fnc_diagMacrosMapSize","params":[{"name":"param0","type":"Config, Array","type_expr":"Config | Array","description":"either config container, or list of classes or classnames","text":"0: CONFIG or ARRAY - either config container, or list of classes or classnames","source":"docblock"},{"name":"param1","type":"String","type_expr":"String","description":"output mode, can be on of following:\n\"wiki\" - wiki table\n\"config\" - #define macros with model dimension values\n\"config_current\" - #define macros with current config values","text":"1: STRING - output mode, can be on of following:\n\"wiki\" - wiki table\n\"config\" - #define macros with model dimension values\n\"config_current\" - #define macros with current config values","source":"docblock"},{"name":"param2","type":"Array","type_expr":"Array","description":"list of classnames which will be excluded from the scan","text":"2: ARRAY - list of classnames which will be excluded from the scan","source":"docblock"}],"returns":{"type":"String","type_expr":"String","text":"STRING","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nPrints mapSize values based on real object size and copies it to clipboard.\nMission has to be running on order to get the values.\n\nParameter(s):\n    0: CONFIG or ARRAY - either config container, or list of classes or classnames\n    1: STRING - output mode, can be on of following:\n        \"wiki\" - wiki table\n        \"config\" - #define macros with model dimension values\n        \"config_current\" - #define macros with current config values\n    2: ARRAY - list of classnames which will be excluded from the scan\n\nReturns:\nSTRING"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_diagMacrosNameSound","title":"BIS fnc diagMacrosNameSound","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagMacrosNameSound","revid":309426,"updated":"2022-05-05T12:04:38Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Detects vehicle types and prints their radio protocol definitions to clipboard.","syntaxes":[{"syntax":"call BIS_fnc_diagMacrosNameSound","params":[],"returns":{"type":"String","type_expr":"String"}}],"examples":[{"code":["call BIS_fnc_diagMacrosNameSound;"]}]},{"name":"BIS_fnc_diagMacrosSimpleObject","title":"BIS fnc diagMacrosSimpleObject","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagMacrosSimpleObject","revid":286045,"updated":"2021-06-20T17:24:45Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Generates simple object config data.","syntaxes":[{"syntax":"[] call BIS_fnc_diagMacrosSimpleObject","params":[{"name":"param0","type":"Object, Array","type_expr":"Object | Array","default":"position calculated 15 meters away from player","description":"ground position where ground objects will be created (default: position calculated 15 meters away from player)","text":"0: OBJECT or ARRAY - ground position where ground objects will be created (default: position calculated 15 meters away from player)","source":"docblock"},{"name":"param1","type":"Number, Boolean","type_expr":"Number | Boolean","default":"false","description":"autolog mode (default: false)\n0 or false - no autolog, results will be only stored in clipboard\n1 or true - autolog on, results will be stored in \\A3\\macros_CfgVehicles_simpleObject_auto_A3.hpp file.\n2 - autlog on + world name, random number and custom suffix are appended to name of generated file to prevent overwriting and provide extra info","text":"1: SCALAR or BOOL - autolog mode (default: false)\n0 or false - no autolog, results will be only stored in clipboard\n1 or true - autolog on, results will be stored in \\A3\\macros_CfgVehicles_simpleObject_auto_A3.hpp file.\n2 - autlog on + world name, random number and custom suffix are appended to name of generated file to prevent overwriting and provide extra info","source":"docblock"},{"name":"param2","type":"Array","type_expr":"Array","default":"[]","description":"classes you want to scan, use [] to scan all (default: []).","text":"2: ARRAY - classes you want to scan, use [] to scan all (default: []).","source":"docblock"},{"name":"param3","type":"Object, Array","type_expr":"Object | Array","default":"position calculated 15 meters away from player","description":"sea position where ground objects will be created (default: position calculated 15 meters away from player)","text":"3: OBJECT or ARRAY - sea position where ground objects will be created (default: position calculated 15 meters away from player)","source":"docblock"},{"name":"param4","type":"String","type_expr":"String","default":"\"\"","description":"custom suffix added to filename if autolog is used (default: \"\").","text":"4: STRING - custom suffix added to filename if autolog is used (default: \"\").","source":"docblock"}],"returns":null}],"examples":[{"code":["bis_scriptHandle = [] spawn BIS_fnc_diagMacrosSimpleObject;"]},{"code":["Expected output per class (animate and hide arrays can have varying amount of elements):\n#define CFGVEHICLES_SIMPLEOBJECT_class_F\\\n    class SimpleObject\\\n    {\\\n        animate[] =\\\n        {\\\n            {\"animationName1\", 1},\\\n            {\"animationName2\", 2}\\\n        };\\\n        hide[] =\\\n        {\\\n            \"animationSelection1\",\\\n            \"animationSelection2\"\\\n        };\\\n        verticalOffsetAsl = 0;\\\n    };"]}],"docblock":{"text":"Generates simple object config data.\n\nParameters:\n    0: OBJECT or ARRAY - ground position where ground objects will be created (default: position calculated 15 meters away from player)\n    1: SCALAR or BOOL - autolog mode (default: false)\n        0 or false - no autolog, results will be only stored in clipboard\n        1 or true - autolog on, results will be stored in \\A3\\macros_CfgVehicles_simpleObject_auto_A3.hpp file.\n        2 - autlog on + world name, random number and custom suffix are appended to name of generated file to prevent overwriting and provide extra info\n    2: ARRAY - classes you want to scan, use [] to scan all (default: []).\n    3: OBJECT or ARRAY - sea position where ground objects will be created (default: position calculated 15 meters away from player)\n    4: STRING - custom suffix added to filename if autolog is used (default: \"\").\n\nExample:\nbis_scriptHandle = [] spawn BIS_fnc_diagMacrosSimpleObject;\n\nExpected output per class (animate and hide arrays can have varying amount of elements):\n#define CFGVEHICLES_SIMPLEOBJECT_class_F\\\n    class SimpleObject\\\n    {\\\n        animate[] =\\\n        {\\\n            {\"animationName1\", 1},\\\n            {\"animationName2\", 2}\\\n        };\\\n        hide[] =\\\n        {\\\n            \"animationSelection1\",\\\n            \"animationSelection2\"\\\n        };\\\n        verticalOffsetAsl = 0;\\\n    };"},"filled_from_docblock":["description","params","examples"]},{"name":"BIS_fnc_diagMacrosVerify","title":"BIS fnc diagMacrosVerify","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagMacrosVerify","revid":309471,"updated":"2022-05-05T12:06:11Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_diagMissionPositions","title":"BIS fnc diagMissionPositions","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagMissionPositions","revid":327911,"updated":"2022-07-13T11:55:05Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Displays positions of units from all missions","syntaxes":[{"syntax":"[configPath, allUnits, isCampaign] call BIS_fnc_diagMissionPositions","params":[{"name":"configPath","type":"Config","optional":true,"default":"`configFile >> \"CfgMissions\"`","type_expr":"Config","text":"configPath: Config - (Optional, default `configFile >> \"CfgMissions\"`)"},{"name":"allUnits","type":"Boolean","optional":true,"default":"false","description":"true to display all units, false to display only player positions","type_expr":"Boolean","text":"allUnits: Boolean - (Optional, default false) true to display all units, false to display only player positions"},{"name":"isCampaign","type":"Boolean","optional":true,"default":"false","description":"true for the scan to perceive the main folder as campaign (required when *configPath* is direct path to campaign)","type_expr":"Boolean","text":"isCampaign: Boolean - (Optional, default false) true for the scan to perceive the main folder as campaign (required when *configPath* is direct path to campaign)"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when done"}}],"examples":[{"code":["[configFile >> \"CfgMissions\", true, false] call BIS_fnc_diagMissionPositions;"]}]},{"name":"BIS_fnc_diagMissionWeapons","title":"BIS fnc diagMissionWeapons","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagMissionWeapons","revid":348817,"updated":"2023-11-08T14:38:18Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Lists all weapons and magazines available in a mission.","syntaxes":[{"syntax":"[clipboard] call BIS_fnc_diagMissionWeapons","params":[{"name":"clipboard","type":"Boolean","optional":true,"default":"false","description":"true to copy list to clipboard","type_expr":"Boolean","text":"clipboard: Boolean - (Optional, default false) - true to copy list to clipboard"}],"returns":{"type":"Array","type_expr":"Array","description":"list of weapons available in mission"}}],"examples":[{"code":["true call BIS_fnc_diagMissionWeapons;"]}]},{"name":"BIS_fnc_diagObjectPerformance","title":"BIS fnc diagObjectPerformance","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagObjectPerformance","revid":286023,"updated":"2021-06-20T17:24:25Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.58"},"since":"arma3 1.58","arma3_since":"1.58","description":"Benchmarks objects vs. simple objects performance and exports the data into .csv sheet.\n\nOutput format: classname,simulation,fpsClean,fpsObjects,fpsSimpleObjects","syntaxes":[{"syntax":"[] call BIS_fnc_diagObjectPerformance","params":[],"returns":null}],"examples":[{"code":["bis_scriptHandle = [] spawn BIS_fnc_diagObjectPerformance;"]}],"docblock":{"text":"Benchmarks objects vs. simple objects performance and exports the data into .csv sheet.\n\nOutput format:\nclassname,simulation,fpsClean,fpsObjects,fpsSimpleObjects\n\nExample:\nbis_scriptHandle = [] spawn BIS_fnc_diagObjectPerformance;"},"filled_from_docblock":["description","examples"]},{"name":"BIS_fnc_diagPreview","title":"BIS fnc diagPreview","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagPreview","revid":347982,"updated":"2023-11-08T09:55:10Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Previews selected classes from given container.","syntaxes":[{"syntax":"[container, parentClass, distance, startPos] call BIS_fnc_diagPreview","params":[{"name":"container","type":"String","optional":true,"default":"\"CfgVehicles\"","description":"class container. Can be:\n\n- \"CfgVehicles\"\n- \"CfgWeapons\"","type_expr":"String","text":"container: String - (Optional, default \"CfgVehicles\") class container. Can be:\n\n- \"CfgVehicles\"\n- \"CfgWeapons\""},{"name":"parentClass","type":"String","optional":true,"default":"typeOf player","description":"parent class of the objects (e.g. \"Car\" or \"Rifle\")","type_expr":"String","text":"parentClass: String - (Optional, default typeOf player) parent class of the objects (e.g. \"Car\" or \"Rifle\")"},{"name":"distance","type":"Number","optional":true,"default":"10","description":"distance between objects","type_expr":"Number","text":"distance: Number - (Optional, default 10) distance between objects"},{"name":"startPos","type":"Position","optional":true,"default":"`getPos player` or `screenToWorld]] [0.5,0.5]` in Eden Editor","description":"start position","type_expr":"Position","text":"startPos: Position - (Optional, default `getPos player` or `screenToWorld]] [0.5,0.5]` in Eden Editor) start position"}],"returns":{"type":"Array","type_expr":"Array","description":"list of created classes"}}],"examples":[{"code":["[\"CfgVehicles\", \"Car\", 15, [0,0,0]] call BIS_fnc_diagPreview;"]}]},{"name":"BIS_fnc_diagPreviewCycle","title":"BIS fnc diagPreviewCycle","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagPreviewCycle","revid":379205,"updated":"2026-10-30T21:11:31Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Previews selected class from the list. When **cheat1** (?) is activated, classnames will be shown instead of display names.","syntaxes":[{"syntax":"[container, position, vector, display] call BIS_fnc_diagPreviewCycle","params":[{"name":"container","type":"String","optional":true,"default":"\"CfgVehicles\"","description":"class container. Can be:\n\n- \"CfgVehicles\"\n- \"CfgWeapons\"","type_expr":"String","text":"container: String - (Optional, default \"CfgVehicles\") class container. Can be:\n\n- \"CfgVehicles\"\n- \"CfgWeapons\""},{"name":"position","type":"Array format Position","optional":true,"default":"`[position player, 10, 0] call BIS_fnc_relPos`","description":"position of the previewed object","type_expr":"Position","types":["Array","Position"],"text":"position: Array format Position - (Optional, default `[position player, 10, 0] call BIS_fnc_relPos`) position of the previewed object"},{"name":"vector","type":"Array of Numbers","optional":true,"default":"[0,0]","description":"vector of previewed object in format:\n\n- 0: Pitch\n- 1: Bank","type_expr":"Array<Number>","text":"vector: Array of Numbers - (Optional, default [0,0]) vector of previewed object in format:\n\n- 0: Pitch\n- 1: Bank"},{"name":"display","type":"Display","optional":true,"default":"BIS_fnc_displayMission","description":"parent display","type_expr":"Display","text":"display: Display - (Optional, default BIS_fnc_displayMission) parent display"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[\"CfgVehicles\"] call BIS_fnc_diagPreviewCycle;"]}]},{"name":"BIS_fnc_diagPreviewVehicleCrew","title":"BIS fnc diagPreviewVehicleCrew","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagPreviewVehicleCrew","revid":347965,"updated":"2023-11-08T08:52:15Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Creates vehicles with their crew.","syntaxes":[{"syntax":"[class, dimensions, distance] call BIS_fnc_diagPreviewVehicleCrew","params":[{"name":"class","type":"String","description":"vehicle class name","type_expr":"String"},{"name":"dimensions","type":"Array of Numbers","description":"number of vehicles in format [rows, columns] (number of vehicles = rows × columns)","type_expr":"Array<Number>"},{"name":"distance","type":"Number","description":"distance between vehicles","type_expr":"Number"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"B_MRAP_01_F\", [5,5], 10] call BIS_fnc_diagPreviewVehicleCrew;"]}]},{"name":"BIS_fnc_diagRadio","title":"BIS fnc diagRadio","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagRadio","revid":327609,"updated":"2022-07-13T09:50:31Z","groups":["Radio","Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Tracks played radio sentences.","syntaxes":[{"syntax":"call BIS_fnc_diagRadio","params":[],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["call BIS_fnc_diagRadio;"]}]},{"name":"BIS_fnc_diagVehicleIcons","title":"BIS fnc diagVehicleIcons","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagVehicleIcons","revid":352139,"updated":"2024-02-01T23:25:13Z","groups":["Diagnostic","Broken Functions"],"status":"broken","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Previews all vehicle icons on map.\n\n> [!WARNING]\n> This function is broken as it uses bad arguments for BIS_fnc_returnParents (**line 35**, `\"\"` instead of `true`)","syntaxes":[{"syntax":"[parentClass, position, map] call BIS_fnc_diagVehicleIcons","params":[{"name":"parentClass","type":"String","optional":true,"default":"\"all\"","type_expr":"String","text":"parentClass: String - (Optional, default \"all\")"},{"name":"position","type":"Position","optional":true,"default":"[100,100]","description":"position of the first icon on the *map*, others will be layered on top of it","type_expr":"Position","text":"position: Position - (Optional, default [100,100]) position of the first icon on the *map*, others will be layered on top of it"},{"name":"map","type":"Control","optional":true,"default":"`findDisplay 12 displayCtrl 51` a.k.a main map","type_expr":"Control","text":"map: Control - (Optional, default `findDisplay 12 displayCtrl 51` a.k.a main map)"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"all\", getPos player] call BIS_fnc_diagVehicleIcons;"]}]},{"name":"BIS_fnc_diagWiki","title":"BIS fnc diagWiki","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagWiki","revid":353796,"updated":"2024-03-23T16:33:07Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Scans specific config folder and outputs the values in wiki format.","syntaxes":[{"syntax":"[mode] call BIS_fnc_diagWiki","params":[{"name":"mode","type":"String","description":"can be one of:\n\n- `\"Anims_aimPrecision\"`\n- `\"CfgDiary_Icons\"`\n- `\"CfgActions\"`\n- `\"CfgActions_CfgVehicles\"`\n- `\"CfgLocationTypes\"`\n- `\"CfgMarkers\"`\n- `\"CfgMarkerBrushes\"`\n- `\"CfgMarkerColors\"`\n- `\"CfgVehicles_identityTypes\"`\n- `\"CfgVehicles_mapSize\"`\n- `\"CfgVehicles_speechVariants\"`\n- `\"CfgVehicleIcons\"`\n- `\"CfgWrapperUI_Cursors\"`\n- `\"IslandMap_colors\"`\n- `\"IslandMap_icons\"`\n- `\"RadioProtocol_Select\"`\n- `\"RadioProtocol_Sent\"`\n- `\"RadioProtocol_Stats\"`\n- `\"RadioProtocol_Variables\"`\n- `\"RadioProtocol_Words\"`\n- `\"RscMapControl_colors\"`\n- `\"RscMapControl_icons\"`\n- `\"RscMapControl_fonts\"`","type_expr":"String"}],"returns":{"type":"String","type_expr":"String","description":"data in wiki format"}}],"examples":[{"code":["[\"RadioProtocol_Sent\"] call BIS_fnc_diagWiki;"]}],"see_also":["BIS_fnc_exportFunctionsToWiki"]},{"name":"BIS_fnc_diaryHints","title":"BIS fnc diaryHints","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diaryHints","revid":309702,"updated":"2022-05-05T12:08:50Z","groups":["GUI"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"```\n#define DIARY_CATEGORY    \"BIS_fnc_diaryHints\"\n```","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_diaryMaps","title":"BIS fnc diaryMaps","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diaryMaps","revid":309605,"updated":"2022-05-05T12:07:38Z","groups":["GUI"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"```\n#define DIARY_CATEGORY    \"BIS_fnc_diaryMaps\"\n```","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_didJIP","title":"BIS fnc didJIP","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_didJIP","revid":336277,"updated":"2022-12-21T11:09:46Z","groups":["Multiplayer"],"status":"ok","games":{"arma3":"1.34"},"since":"arma3 1.34","arma3_since":"1.34","description":"Return whether or not the local player joined the game while it was already in progress.\n\n> [!IMPORTANT]\n> Arma 3 v1.50 Use didJIP instead.","syntaxes":[{"syntax":"[] call BIS_fnc_didJIP","params":[],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["if ([] call BIS_fnc_didJIP) then { forceRespawn player };"]}],"see_also":["remoteExec","remoteExecCall","didJIP","didJIPOwner","exportJIPMessages"]},{"name":"BIS_fnc_dirIndicator","title":"BIS fnc dirIndicator","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_dirIndicator","revid":329960,"updated":"2022-08-09T17:17:13Z","groups":["GUI"],"status":"ok","games":{"arma2oa":"1.56","tkoh":"1.00","arma3":"0.50"},"since":"arma2oa 1.56","arma3_since":"0.50","locality":{"argument":"global","effect":"local"},"description":"Show a 4-directions indicator.\nIndicator GUI layer is 17, its Display is accessible with `uiNamespace getVariable \"BIS_RscMissionScreen_dirIndicator\"`.\nCan be reexecuted to change its colour, but once executed this function **cannot** be halted until *origin*'s death.","syntaxes":[{"syntax":"[origin, target, color, sizeCoef] call BIS_fnc_dirIndicator","params":[{"name":"origin","type":"Object","description":"origin, usually player","type_expr":"Object"},{"name":"target","type":"Code, String, Object or Array format Position","description":"to which indicator points to:\n\n- Code - code result must be Object or Position\n- String - missionNamespace variable name\n- Object - any object\n- Array format Position - any position","type_expr":"Code | String | Object | Position","types":["Code","String","Object","Array","Position"]},{"name":"color","type":"Array format Color (RGBA)","optional":true,"default":"[0.424,0.651,0.247,1] (Arma 2 green)","type_expr":"Color","types":["Array","Color"],"text":"color: Array format Color (RGBA) - (Optional, default [0.424,0.651,0.247,1] (Arma 2 green))"},{"name":"sizeCoef","type":"Number","optional":true,"default":"0.1045752 (command bar height)","description":"size coefficient","type_expr":"Number","text":"sizeCoef: Number - (Optional, default 0.1045752 (command bar height)) size coefficient"}],"returns":{"type":"Script Handle","type_expr":"Script Handle"}}],"examples":[{"code":["[player, TheBoss, [0.706, 0.0745, 0.0196, 1]] call BIS_fnc_dirIndicator;"]}],"see_also":["getRelDir"]},{"name":"BIS_fnc_dirtEffect","title":"BIS fnc dirtEffect","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_dirtEffect","revid":327927,"updated":"2022-07-13T12:25:13Z","groups":["Feedback"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"effect":"local"},"description":"Screen dirt (texture) postprocess.\nDisplays dust PP according to damage obtained from near explosion; takes array from \"Explosion\" event handler.","syntaxes":[{"syntax":"[unit, damage] call BIS_fnc_dirtEffect","params":[{"name":"unit","type":"Object","description":"who gets the damage. **Unused and useless parameter**","type_expr":"Object"},{"name":"damage","type":"Number","description":"damage given to unit by explosion","type_expr":"Number"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[nil, 0.5] call BIS_fnc_dirtEffect;"]}],"see_also":["BIS_fnc_bloodEffect","BIS_fnc_flamesEffect"]},{"name":"BIS_fnc_dirTo","title":"BIS fnc dirTo","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_dirTo","revid":327975,"updated":"2022-07-13T14:37:05Z","groups":["Geometry"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Function which returns vector direction from pos1 to pos2.\n\n> [!NOTE]\n> **Arma 3:** Use `obj1 getDir obj2` instead of BIS_fnc_dirTo.","syntaxes":[{"syntax":"[param1, param2] call BIS_fnc_dirTo","params":[{"name":"param1","description":"vector starting point, Position **or** Object","type_expr":"Position | Object"},{"name":"param2","description":"vector ending point, Position **or** Object","type_expr":"Position | Object"}],"returns":{"type":"Number","type_expr":"Number"}}],"examples":[{"text":"sets unit1 in the direction of unit2\n\n```sqf\nunit1 setDir ([unit1, unit2] call BIS_fnc_dirTo);\n```","code":["unit1 setDir ([unit1, unit2] call BIS_fnc_dirTo);"]}],"see_also":["getDir","setDir"],"notes":[{"user":"AgentRev","date":"2015-01-21T14:20:00Z","text":"Be careful when using this function in conjunction with BIS_fnc_rotateVector2D, which rotates vectors counterclockwise as per trigonometric conventions, while BIS_fnc_dirTo returns a clockwise angle.\nTo counter this, simply negate the output of BIS_fnc_dirTo:\n\n```sqf\n[0,1,0], -([_unit, _vehicle] call BIS_fnc_dirTo)] call BIS_fnc_rotateVector2D;\n```"}]},{"name":"BIS_fnc_disableLoading","title":"BIS fnc disableLoading","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_disableLoading","revid":348269,"updated":"2023-11-08T11:40:36Z","groups":["Missions"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Disables the load/restart button. Currently only for BIS_fnc_cinemaBorder used within the Prologue and Survive campaigns. Only works in single player.","syntaxes":[{"syntax":"call BIS_fnc_disableLoading","params":[],"returns":{"type":"Boolean","type_expr":"Boolean","description":"always true"}}],"examples":[{"code":["call BIS_fnc_disableLoading;"]}],"see_also":["BIS_fnc_cinemaBorder"]},{"name":"BIS_fnc_disableRevive","title":"BIS fnc disableRevive","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_disableRevive","revid":348214,"updated":"2023-11-08T11:40:18Z","groups":["Revive"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","description":"Disable revive on given unit.","syntaxes":[{"syntax":"[player] call BIS_fnc_disableRevive","params":[{"name":"player","type":"Object","description":"affected player","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[BIS_unit] call BIS_fnc_disableRevive;"]}],"see_also":["Arma 3: Revive","BIS_fnc_reenableRevive"]},{"name":"BIS_fnc_disableSaving","title":"BIS fnc disableSaving","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_disableSaving","revid":349305,"updated":"2023-11-08T14:52:21Z","groups":["Missions"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Controls the disabling of saving, stacking each request to prevent saving being enabled too early.","syntaxes":[{"syntax":"id call BIS_fnc_disableSaving","params":[{"name":"id","type":"String","description":"unique id to be used with BIS_fnc_enableSaving","type_expr":"String"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if successful, false if not"}}],"examples":[{"code":["\"savingID\" call BIS_fnc_disableSaving;"]}],"see_also":["BIS_fnc_enableSaving","saveGame","BIS_fnc_saveGame","loadGame"]},{"name":"BIS_fnc_displayClouds","title":"BIS fnc displayClouds","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_displayClouds","revid":309606,"updated":"2022-05-05T12:07:38Z","groups":["GUI"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"```\n#define DISPLAY        (uinamespace getvariable 'hsim_RscClouds')\n#define CONTROL        (DISPLAY displayctrl _idc)\n#define RSC_LAYER    759\n```","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_displayColorGet","title":"BIS fnc displayColorGet","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_displayColorGet","revid":349349,"updated":"2023-11-08T14:53:31Z","groups":["GUI"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Loads custom color settings from CfgUIDefault.\n\nIf variables are not stored in profileNamespace yet, the function will declare them.\n\n|  |  |\n|---|---|\n| **Arma 3 v1.99**<br>\\| Tag \\| Variable \\| Description \\|<br>\\|---\\|---\\|---\\|<br>\\| \"IGUI\" \\| \"BCG_RGB\" \\| Backgrounds \\|<br>\\| \"IGUI\" \\| \"TEXT_RGB\" \\| Active Elements \\|<br>\\| \"IGUI\" \\| \"WARNING_RGB\" \\| Warnings \\|<br>\\| \"IGUI\" \\| \"ERROR_RGB\" \\| Errors \\|<br>\\| \"IGUI\" \\| \"TACTPING_RGB\" \\| Tactical Ping \\|<br>\\| \"GUI\" \\| \"BCG_RGB\" \\| Backgrounds \\|<br>\\| \"GUI\" \\| \"TITLETEXT_RGB\" \\| Title Text \\|<br>\\| \"Map\" \\| \"BLUFOR\" \\| BLUFOR \\|<br>\\| \"Map\" \\| \"OPFOR\" \\| OPFOR \\|<br>\\| \"Map\" \\| \"Independent\" \\| Independent \\|<br>\\| \"Map\" \\| \"Civilian\" \\| Civilian \\|<br>\\| \"Map\" \\| \"Unknown\" \\| Unknown \\|<br>\\| \"Subtitles\" \\| \"Background\" \\| Subtitle background \\|<br>\\| \"Subtitles\" \\| \"Text\" \\| Subtitle text \\| | **Take On Helicopters v1.00**<br>\\| Tag \\| Variable \\| Description \\|<br>\\|---\\|---\\|---\\|<br>\\| \"IGUI\" \\| \"IGUI_TEXT_RGB\" \\| HUD color **RGB** \\|<br>\\| \"IGUI\" \\| \"IGUI_TEXT_COLOR\" \\| HUD color **RGBA** \\|<br>\\| \"GUI\" \\| \"BCG_RGB\" \\| menu background **RGB** \\|<br>\\| \"GUI\" \\| \"GUI_BCG_COLOR\" \\| menu background **RGBA** \\|<br>\\| \"GUI\" \\| \"GUI_BCG_MEDIUM_RGB\" \\| button background **RGB** (darker version of GUI_BCG_RGB) \\|<br>\\| \"GUI\" \\| \"GUI_BCG_MEDIUM_COLOR\" \\| button background **RGBA** \\|<br>\\| \"GUI\" \\| \"GUI_BCG_ACTIVE_RGB\" \\| active button background color (e.g. focused buttons) **RGB** \\| |","syntaxes":[{"syntax":"[tag, variable] call BIS_fnc_displayColorGet","params":[{"name":"tag","type":"String","description":"tag defined in CfgUIDefault","type_expr":"String"},{"name":"variable","type":"String","description":"variable defined in \"CfgUIColors\" >> Variables","type_expr":"String"}],"returns":{"type":"Array","type_expr":"Array","description":"in format Color (RGBA)"}},{"syntax":"init call BIS_fnc_displayColorGet","params":[{"name":"init","type":"Boolean","description":"when used, function will initialize all color presets","type_expr":"Boolean"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"GUI\", \"BCG_RGB\"] call BIS_fnc_displayColorGet;//Returns menu color"]}],"see_also":["Color","BIS_fnc_colorRGBtoHTML","BIS_fnc_colorRGBAtoHTML","BIS_fnc_colorRGBAtoTexture"]},{"name":"BIS_fnc_displayColorSet","title":"BIS fnc displayColorSet","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_displayColorSet","revid":329650,"updated":"2022-08-01T00:36:45Z","groups":["GUI"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Applies custom color settings to given Display.\n\nDisplay must be already using color macros, function will just refresh the values according to current color settings.","syntaxes":[{"syntax":"[displayClass, display, commitTime, code] call BIS_fnc_displayColorSet","params":[{"name":"displayClass","type":"Config","description":"display config class","type_expr":"Config"},{"name":"display","type":"Display","type_expr":"Display"},{"name":"commitTime","type":"Number","optional":true,"default":"0","description":"commit time","type_expr":"Number","text":"commitTime: Number - (Optional, default 0) commit time"},{"name":"code","type":"Code","optional":true,"default":"`{}`","description":"code executed for every control element (which is passed as _this)","type_expr":"Code","text":"code: Code - (Optional, default `{}`) code executed for every control element (which is passed as _this)"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[configFile >> (GUI_classes select _forEachIndex), _x] call BIS_fnc_displayColorSet;"]},{"text":"```sqf\n[\n    configFile >> _class,\n    _display,\n    0,\n    {\n        _this ctrlSetFade 0;\n        _this ctrlCommit 0.5;\n    }\n] call BIS_fnc_displayColorSet;\n```","code":["[\n\tconfigFile >> _class,\n\t_display,\n\t0,\n\t{\n\t\t_this ctrlSetFade 0;\n\t\t_this ctrlCommit 0.5;\n\t}\n] call BIS_fnc_displayColorSet;"]}],"see_also":["BIS_fnc_displayColorGet"]},{"name":"BIS_fnc_displayControls","title":"BIS fnc displayControls","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_displayControls","revid":309465,"updated":"2022-05-05T12:06:10Z","groups":["GUI"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Return all controls of given display class","syntaxes":[{"syntax":"[param0, param1, param2] call BIS_fnc_displayControls","params":[{"name":"param0","type":"Config","type_expr":"Config","description":"display config","text":"0: CONFIG - display config","source":"docblock"},{"name":"param1","type":"Number, Config, String","type_expr":"Number | Config | String","default":"configfile","description":"type of returned values (control configs, their names or IDCs; default: configfile))","text":"1: NUMBER or CONFIG or STRING - type of returned values (control configs, their names or IDCs; default: configfile))","source":"docblock"},{"name":"param2","type":"Boolean","type_expr":"Boolean","default":"true","description":"true to search content of controls group (default: true)","text":"2: BOOL - true to search content of controls group (default: true)","source":"docblock"}],"returns":{"type":"Array","type_expr":"Array","text":"ARRAY","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nReturn all controls of given display class\n\nParameter(s):\n_this select 0: CONFIG - display config\n_this select 1: NUMBER or CONFIG or STRING - type of returned values (control configs, their names or IDCs; default: configfile))\n_this select 2: BOOL - true to search content of controls group (default: true)\n\nReturns:\nARRAY"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_displayLoading","title":"BIS fnc displayLoading","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_displayLoading","revid":327045,"updated":"2022-07-12T21:44:46Z","groups":["GUI"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Loading Screens init.","syntaxes":[{"syntax":"[onLoad, id] call BIS_fnc_displayLoading","params":[{"name":"onLoad","type":"Array","description":"params provided by onLoad UI Event Handler","type_expr":"Array"},{"name":"id","type":"Number","description":"id of loading screen. Used only for debugging","type_expr":"Number"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["([_this, 2302] call (uiNamespace getVariable 'BIS_fnc_displayLoading')"]}],"see_also":["Loading Screens"]},{"name":"BIS_fnc_displayMission","title":"BIS fnc displayMission","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_displayMission","revid":329370,"updated":"2022-07-27T12:33:56Z","groups":["GUI"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Returns main display of current mission/intro/outro. A cleaner alternative to `findDisplay 46`.","syntaxes":[{"syntax":"call BIS_fnc_displayMission","params":[],"returns":{"type":"Display","type_expr":"Display"}}],"examples":[{"code":["_mainDisplay = call BIS_fnc_displayMission;"]}],"see_also":["findDisplay"]},{"name":"BIS_fnc_displayName","title":"BIS fnc displayName","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_displayName","revid":353211,"updated":"2024-03-12T18:47:11Z","groups":["Configs"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Return given class displayName value. Return base class name if displayName not defined.","syntaxes":[{"syntax":"[config] call BIS_fnc_displayName","params":[{"name":"config","type":"Config","description":"config path","type_expr":"Config"}],"returns":{"type":"String","type_expr":"String","description":"displayName, else configName"}}],"examples":[{"code":["private _myDisplayName = [configFile >> \"CfgVehicles\" >> typeOf vehicle player] call BIS_fnc_displayName;"]},{"code":["private _myDisplayName = [configOf player] call BIS_fnc_displayName; // Since Arma 3 2.00"]}],"see_also":["configName"]},{"name":"BIS_fnc_displayResize","title":"BIS fnc displayResize","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_displayResize","revid":309521,"updated":"2022-05-05T12:06:43Z","groups":["GUI"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_distance2D","title":"BIS fnc distance2D","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_distance2D","revid":348503,"updated":"2023-11-08T13:01:33Z","groups":["Geometry"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Returns the distance between two objects or positions.\n\n> [!NOTE]\n> **Arma 3:** Use distance2D instead.","syntaxes":[{"syntax":"[param1, param2] call BIS_fnc_distance2D","params":[{"name":"param1","type":"Object or Array in format Position or Position2D","type_expr":"Object | Position | Position2D","types":["Object","Array","Position","Position2D"]},{"name":"param2","type":"Object or Array in format Position or Position2D","type_expr":"Object | Position | Position2D","types":["Object","Array","Position","Position2D"]}],"returns":{"type":"Number","type_expr":"Number","description":"distance in meters or 1e10 if distance cannot be calculated"}}],"examples":[{"code":["[player, rescueHelicopter] call BIS_fnc_distance2D;"]}],"see_also":["distance2D","BIS_fnc_distance2Dsqr"]},{"name":"BIS_fnc_distance2Dsqr","title":"BIS fnc distance2Dsqr","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_distance2Dsqr","revid":347966,"updated":"2023-11-08T08:53:39Z","groups":["Geometry"],"status":"deprecated","replaced_by":["distanceSqr"],"games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Returns the SQUARE of the distance between the two objects or positions \"as the crow flies\" (ignoring elevation).\n\n> [!NOTE]\n> This function became obsolete with the introduction of distanceSqr.","syntaxes":[{"syntax":"[pointA, pointB] call BIS_fnc_distance2Dsqr","params":[{"name":"pointA","type":"Object or Position","type_expr":"Object | Position"},{"name":"pointB","type":"Object or Position","type_expr":"Object | Position"}],"returns":{"type":"Number","type_expr":"Number","description":"squared distance"}}],"examples":[{"code":["[player, soldier_1] call BIS_fnc_distance2Dsqr;"]},{"code":["[[100,100,0], [0,0,0]] call BIS_fnc_distance2Dsqr;"]}],"see_also":["BIS_fnc_distance2D","distance2D","distance"]},{"name":"BIS_fnc_door","title":"BIS fnc door","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_door","revid":349005,"updated":"2023-11-08T14:46:14Z","groups":["Scripts"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"global","effect":"global"},"description":"Changes animation phase of given door.","syntaxes":[{"syntax":"[building, doorIndex, animationPhase] call BIS_fnc_door","params":[{"name":"building","type":"Object","description":"building","type_expr":"Object"},{"name":"doorIndex","type":"Number","description":"index of the door used in \"bis_disabled_Door_%1\", \"Door_%1_sound_source\", \"Door_%1_noSound_source\", \"Door_%1_locked_source\"","type_expr":"Number"},{"name":"animationPhase","type":"Number","description":"phase of the animation, see animateSource for more information","type_expr":"Number"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[_building, 5, 1] call BIS_fnc_door;"]}],"see_also":["BIS_fnc_doorOpen","BIS_fnc_doorNoHandleOpen","BIS_fnc_doorClose"]},{"name":"BIS_fnc_doorClose","title":"BIS fnc doorClose","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_doorClose","revid":364843,"updated":"2024-06-17T11:13:02Z","groups":["Scripts"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"global","effect":"global"},"description":"Close a door with an animated doorhandle.","syntaxes":[{"syntax":"[building, doorAnimation, handleDownAnimation, doorHandleUpAnimation, animationPhase] call BIS_fnc_doorClose","params":[{"name":"building","type":"Object","optional":true,"default":"objNull","description":"building","type_expr":"Object","text":"building: Object - (Optional, default objNull) building"},{"name":"doorAnimation","type":"String","optional":true,"default":"\"\"","description":"name of the door animation","type_expr":"String","text":"doorAnimation: String - (Optional, default \"\") name of the door animation"},{"name":"handleDownAnimation","type":"String","optional":true,"default":"\"\"","description":"animation source of handle down","type_expr":"String","text":"handleDownAnimation: String - (Optional, default \"\") animation source of handle down"},{"name":"doorHandleUpAnimation","type":"String","optional":true,"default":"\"\"","description":"animation source of handle up","type_expr":"String","text":"doorHandleUpAnimation: String - (Optional, default \"\") animation source of handle up"},{"name":"animationPhase","type":"Number","optional":true,"default":"0","description":"value from 0-1","type_expr":"Number","text":"animationPhase: Number - (Optional, default 0) value from 0-1"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[building, \"doorAnimation\", \"animationUp\", \"animationDown\", 1] call BIS_fnc_doorClose;"]}],"see_also":["animate","animateSource","BIS_fnc_door"]},{"name":"BIS_fnc_doorNoHandleClose","title":"BIS fnc doorNoHandleClose","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_doorNoHandleClose","revid":273895,"updated":"2021-06-13T01:13:03Z","groups":["Scripts"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_doorNoHandleClose","params":[],"returns":null}]},{"name":"BIS_fnc_doorNoHandleOpen","title":"BIS fnc doorNoHandleOpen","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_doorNoHandleOpen","revid":274111,"updated":"2021-06-13T01:16:50Z","groups":["Scripts"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_doorNoHandleOpen","params":[],"returns":null}]},{"name":"BIS_fnc_doorOpen","title":"BIS fnc doorOpen","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_doorOpen","revid":364482,"updated":"2024-05-16T20:41:57Z","groups":["Scripts"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"global","effect":"global"},"description":"Open a door with an animated doorhandle.\n\n> [!NOTE]\n> This function uses animate internally.","syntaxes":[{"syntax":"[building, doorAnimation, upDownAnimation, downUpAnimation, animationPhase] call BIS_fnc_doorOpen","params":[{"name":"building","type":"Object","optional":true,"default":"objNull","type_expr":"Object","text":"building: Object - (Optional, default objNull)"},{"name":"doorAnimation","type":"String","optional":true,"default":"\"\"","type_expr":"String","text":"doorAnimation: String - (Optional, default \"\")"},{"name":"upDownAnimation","type":"String","optional":true,"default":"\"\"","type_expr":"String","text":"upDownAnimation: String - (Optional, default \"\")"},{"name":"downUpAnimation","type":"String","optional":true,"default":"\"\"","type_expr":"String","text":"downUpAnimation: String - (Optional, default \"\")"},{"name":"animationPhase","type":"Number","optional":true,"default":"1","type_expr":"Number","text":"animationPhase: Number - (Optional, default 1)"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[_house, \"door_1_rot\", nil, nil, 0.25]  call BIS_fnc_doorOpen;"]}],"see_also":["BIS_fnc_doorClose","BIS_fnc_door","animate","animateSource","animateDoor"]},{"name":"BIS_fnc_dotProduct","title":"BIS fnc dotProduct","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_dotProduct","revid":341319,"updated":"2023-05-21T15:52:21Z","groups":["Vectors"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Dot product of two vectors.\n\n> [!NOTE]\n> **Arma 3:** In Arma 3 use vectorDotProduct.","syntaxes":[{"syntax":"[vector1, vector2] call BIS_fnc_dotProduct","params":[{"name":"vector1","type":"Array","type_expr":"Array"},{"name":"vector2","type":"Array","type_expr":"Array"}],"returns":{"type":"Number","type_expr":"Number"}}],"examples":[{"code":["[[1,2,3], [1,2,3]] call BIS_fnc_dotProduct; // returns: 1*1 + 2*2 + 3*3 = 14"]},{"code":["[[1,2,3,4], [1,2,3,4]] call BIS_fnc_dotProduct; // returns 1*1 + 2*2 + 3*3 + 4*4 = 30"]}],"see_also":["vectorDotProduct"]},{"name":"BIS_fnc_drawAO","title":"BIS fnc drawAO","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_drawAO","revid":330782,"updated":"2022-11-01T16:08:24Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Draws a dashed line around the outer edges of a trigger.","syntaxes":[{"syntax":"[triggers, distance] call BIS_fnc_drawAO","params":[{"name":"triggers","type":"Object or Array","description":"trigger or list of triggers that indicate AO","type_expr":"Object | Array"},{"name":"distance","type":"Number","optional":true,"default":"50","description":"number that decides distance between each new line drawn","type_expr":"Number","text":"distance: Number - (Optional, default 50) number that decides distance between each new line drawn"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[Trigger1] call BIS_fnc_drawAO; // draws a dashed line around trigger1's outer edge, with 50m between each line"]},{"code":["[Trigger1, 10] call BIS_fnc_drawAO; // draws a dashed line around trigger1's outer edge, with 10m between each line"]},{"code":["[[Trigger1, Trigger2]] call BIS_fnc_drawAO; // draws dashed lines around multiple triggers, useful for multiple AOs in one mission"]}],"notes":[{"user":"Tryteyker-","date":"2014-09-28T17:16:00Z","text":"It is worth noting that the size, color and other attributes that the line may have are dependant on the trigger itself.\nThe crucial attributes for the function to work properly seem to be the following:\n\nActivation: Anybody OR side player\nSize: Has to be bigger than 50x50 to be visible (below 50x50 it will not work properly as the function increments in 50 for each new line)\n\nThe following attributes are saved by the function once it is called, all attributes originating from trigger:\n\n```sqf\nprivate _triggerPos = position _x;\n_triggerPosX = _triggerPos select 0;\n_triggerPosY = _triggerPos select 1;\n_triggerArea = triggerArea _x;\n_triggerSizeX = _triggerArea select 0;\n_triggerSizeY = _triggerArea select 1;\n_triggerSize = _triggerSizeX max _triggerSizeY;\n_triggerDir = _triggerArea select 2;\n_triggerType = _triggerArea select 3;\n_triggerText = triggerText _x;\n_triggerActivation = triggerActivation _x select 0;\n_triggerPresent = triggerActivation _x select 1;\n```\n\nThis is taken directly from the function.\nText will generally show up on the left hand side (*inside* the circle/rectangle) AND on the right hand side (*outside* the circle/rectangle).\nSize increments can be changed using *_this select 1*, another example provided above."}]},{"name":"BIS_fnc_drawArrow","title":"BIS fnc drawArrow","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_drawArrow","revid":352164,"updated":"2024-02-01T23:25:26Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.74"},"since":"arma3 1.74","arma3_since":"1.74","description":"Draws a static arrow (outline or color filled) on map. See Example 4 for arrow removal.\n\n> [!NOTE]\n> Note that the order in which arrows are added to map is reversed, the last added arrow will appear under the first added arrow","syntaxes":[{"syntax":"[from, to, color, pars, fill, map] call BIS_fnc_drawArrow","params":[{"name":"from","type":"Array","description":"arrow start position in format [x,y] or [x,y,z]","type_expr":"Array"},{"name":"to","type":"Array","description":"arrow end position in format [x,y] or [x,y,z]","type_expr":"Array"},{"name":"color","type":"Array format Color (RGBA)","optional":true,"default":"[1,1,1,1]","description":"arrow line or fill color","type_expr":"Color","types":["Array","Color"],"text":"color: Array format Color (RGBA) - (Optional, default [1,1,1,1]) arrow line or fill color"},{"name":"pars","type":"Array","optional":true,"description":"arrow geometry details in format [arrowThickness, arrowHeadLengthCoef, arrowHeadWidthCoef], where:\n\n- arrowThickness: Number - (Optional, default 10) arrow thickness in meters\n- arrowHeadLengthCoef: Number - (Optional, default 1/3) arrow head length compared to the total length of the arrow\n- arrowHeadWidthCoef: Number - (Optional, default 2) arrow head width compared to the arrow thickness\n- Arma 3 v1.98 arrowBaseWidthCoef: Number - (Optional, default 1) arrow base width compared to the arrow thickness","type_expr":"Array","text":"pars: Array - (Optional) arrow geometry details in format [arrowThickness, arrowHeadLengthCoef, arrowHeadWidthCoef], where:\n\n- arrowThickness: Number - (Optional, default 10) arrow thickness in meters\n- arrowHeadLengthCoef: Number - (Optional, default 1/3) arrow head length compared to the total length of the arrow\n- arrowHeadWidthCoef: Number - (Optional, default 2) arrow head width compared to the arrow thickness\n- Arma 3 v1.98 arrowBaseWidthCoef: Number - (Optional, default 1) arrow base width compared to the arrow thickness"},{"name":"fill","type":"Boolean","optional":true,"default":"true","description":"true to draw color filled arrow, false to draw outline","type_expr":"Boolean","text":"fill: Boolean - (Optional, default true) true to draw color filled arrow, false to draw outline"},{"name":"map","type":"Control","optional":true,"default":"display 12 displayCtrl 51","description":"map control","type_expr":"Control","text":"map: Control - (Optional, default display 12 displayCtrl 51) map control"}],"returns":{"type":"Array","type_expr":"Array","description":"arrow reference for removal in format [idd, idc, ehId] or empty array [] on removal operation"}}],"examples":[{"text":"Draw a semi-transparent, blue arrow with default geometry:\n\n```sqf\nmyArrow1 = [_pos1, _pos2, [0,0,1,0.5]] call BIS_fnc_drawArrow;\n```","code":["myArrow1 = [_pos1, _pos2, [0,0,1,0.5]] call BIS_fnc_drawArrow;"]},{"text":"Draw a wide, green arrow outline:\n\n```sqf\nmyArrow2 = [_pos1, _pos2, [0,1,0,1], [20], false] call BIS_fnc_drawArrow;\n```","code":["myArrow2 = [_pos1, _pos2, [0,1,0,1], [20], false] call BIS_fnc_drawArrow;"]},{"text":"Draw a thin, red arrow with custom head geometry:\n\n```sqf\nmyArrow3 = [_pos1, _pos2, [1,0,0,1], [1,1/5,5]] call BIS_fnc_drawArrow;\n```","code":["myArrow3 = [_pos1, _pos2, [1,0,0,1], [1,1/5,5]] call BIS_fnc_drawArrow;"]},{"text":"Remove the arrow created in Example 3:\n\n```sqf\nmyArrow3 call BIS_fnc_drawArrow;\n```","code":["myArrow3 call BIS_fnc_drawArrow;"]},{"code":["myArrow1 = [[100,400,0], [200,500,0], [1,0,0,1], [20], true] call BIS_fnc_drawArrow;\nmyArrow2 = [[400,700,0], [300,600,0], [0,1,0,1], [20, 1/3, 2, 2], true] call BIS_fnc_drawArrow;\nmyArrow3 = [[600,700,0], [400,900,0], [0,0,1,1], [20, 1/3, 2, 0.5], true] call BIS_fnc_drawArrow;\nmyArrow4 = [[100,100,0], [200,200,0], [0,0,0,1], [20], false] call BIS_fnc_drawArrow;\nmyArrow5 = [[400,400,0], [300,300,0], [1,1,1,1], [20, 1/3, 2, 2], false] call BIS_fnc_drawArrow;\nmyArrow6 = [[600,400,0], [400,600,0], [0,1,1,1], [20, 1/3, 2, 0.5], false] call BIS_fnc_drawArrow;"]}],"see_also":["drawArrow"]},{"name":"BIS_fnc_drawBoundingBox","title":"BIS fnc drawBoundingBox","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_drawBoundingBox","revid":376923,"updated":"2025-12-29T12:16:33Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"Draws bounding box around given objects.","syntaxes":[{"syntax":"[objects, color, draw] call BIS_fnc_drawBoundingBox","params":[{"name":"objects","type":"Array of Objects","optional":true,"default":"`[objNull]`","type_expr":"Array<Object>","text":"objects: Array of Objects - (Optional, default `[objNull]`)"},{"name":"color","type":"Array in format Color (RGBA)","optional":true,"default":"[1,0,1,1]","type_expr":"Color","types":["Array","Color"],"text":"color: Array in format Color (RGBA) - (Optional, default [1,0,1,1])"},{"name":"draw","type":"Boolean","optional":true,"default":"nil","description":"true to draw, false to remove","type_expr":"Boolean","text":"draw: Boolean - (Optional, default nil) true to draw, false to remove"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if successful, false if not"}}],"examples":[{"code":["[[BIS_building], [1,0,1,1], true] call BIS_fnc_drawBoundingBox;"]},{"code":["[[], [], false] call BIS_fnc_drawBoundingBox;"]}],"see_also":["boundingBoxReal","boundingBox"]},{"name":"BIS_fnc_drawCuratorDeaths","title":"BIS fnc drawCuratorDeaths","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_drawCuratorDeaths","revid":349318,"updated":"2023-11-08T14:52:27Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Show skull unit for curator when the unit dies.","syntaxes":[{"syntax":"[unit] call BIS_fnc_drawCuratorDeaths","params":[{"name":"unit","type":"Object","description":"unit","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["player call BIS_fnc_drawCuratorDeaths;"]}],"see_also":["Arma 3: Curator"]},{"name":"BIS_fnc_drawCuratorLocations","title":"BIS fnc drawCuratorLocations","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_drawCuratorLocations","revid":309583,"updated":"2022-05-05T12:07:20Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Label every vilage, town and city in curator interface","syntaxes":[{"syntax":"[param0] call BIS_fnc_drawCuratorLocations","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"curator module","text":"0: OBJECT - curator module","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","text":"BOOL","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nLabel every vilage, town and city in curator interface\n\nParameter(s):\n    0: OBJECT - curator module\n\nReturns:\nBOOL"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_drawCuratorRespawnMarkers","title":"BIS fnc drawCuratorRespawnMarkers","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_drawCuratorRespawnMarkers","revid":309637,"updated":"2022-05-05T12:07:51Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Create a curator icon on every respawn marker","syntaxes":[{"syntax":"[param0, param1] call BIS_fnc_drawCuratorRespawnMarkers","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"curator module","text":"0: OBJECT - curator module","source":"docblock"},{"name":"param1","type":"Array, Side","type_expr":"Array<Side>","text":"1: ARRAY of SIDEs","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","text":"BOOL","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nCreate a curator icon on every respawn marker\n\nParameter(s):\n    0: OBJECT - curator module\n    1: ARRAY of SIDEs\n\nReturns:\nBOOL"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_drawMinefields","title":"BIS fnc drawMinefields","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_drawMinefields","revid":309394,"updated":"2022-05-05T12:04:35Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Draw minefields on the map. Dynamically calculated from all mines positions. Distinguishes AP and AT minefields.","syntaxes":[{"syntax":"call BIS_fnc_drawMinefields","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_drawMinefields;"]}],"see_also":["allMines"]},{"name":"BIS_fnc_drawRespawnPositions","title":"BIS fnc drawRespawnPositions","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_drawRespawnPositions","revid":349423,"updated":"2023-11-08T16:27:33Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Draws respawn positions on the map which were added by BIS_fnc_addRespawnPosition.","syntaxes":[{"syntax":"[state] call BIS_fnc_drawRespawnPositions","params":[{"name":"state","type":"Boolean","description":"true to start drawing, false to end it","type_expr":"Boolean"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[true] call BIS_fnc_drawRespawnPositions;"]}]},{"name":"BIS_fnc_dynamicGroups","title":"BIS fnc dynamicGroups","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_dynamicGroups","revid":327978,"updated":"2022-07-13T15:12:52Z","groups":["Systems"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","description":"Function that adds dynamic groups to the mission as seen in End Game. Function needs to be initialized on server and client. Clients can then use action TeamSwitch (\"U\" by default) to access the Dynamic Groups interface.","syntaxes":[{"syntax":"[mode, params] call BIS_fnc_dynamicGroups","params":[{"name":"mode","type":"String","description":"mode, can be:\n\n- \"Initialize\" - Initializes dynamic groups on the server\n- \"Terminate\" - Terminates dynamic groups on the server\n- \"InitializePlayer\" - Does client side initialization\n- \"TerminatePlayer\" - Does client side termination\n- \"IsInitialized\" - Checks whether dynamic groups was initialized\n- \"RegisterGroup\" - Registers a group\n- \"UnregisterGroup\" - Unregisters a group\n- \"IsGroupRegistered\" - Whether a group was already registered or not\n- \"SetName\" - Sets the name of the group, in future, will also update GroupId of the group\n- \"SetPrivateState\" - Set the private state of a group\n- \"SwitchLeader\" - Switches the leader of given group to the given player\n- \"AddGroupMember\" - Add a group member to group\n- \"RemoveGroupMember\" - Switches a player from one group to another\n- \"KickPlayer\" - Kicks a player from group, player wont be able to join the group unless invited or is unkicked using UnKickPlayer\n- \"UnKickPlayer\" - Unkicks a player from a group\n- \"WasPlayerKickedFrom\" - Whether given player was kicked from given group\n- \"GetAllGroups\" - Returns all registered and valid groups","type_expr":"String"},{"name":"params","type":"Array","description":"parameter changes according to `mode`. Check the function in the Functions Viewer for detailed information","type_expr":"Array"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"Initialize\"] call BIS_fnc_dynamicGroups; // exec on Server"]},{"code":["[\"InitializePlayer\", [player]] call BIS_fnc_dynamicGroups; // exec on client"]}],"see_also":["Dynamic Groups"]},{"name":"BIS_fnc_dynamicText","title":"BIS fnc dynamicText","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_dynamicText","revid":330683,"updated":"2022-10-21T17:13:50Z","groups":["GUI"],"status":"ok","games":{"arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2oa 1.50","arma3_since":"0.50","locality":{"effect":"local"},"exec":"spawn","description":"Shows dynamic opening credits or any type of text.","syntaxes":[{"syntax":"[text, x, y, duration, fadeInTime, deltaY, rscLayer] spawn BIS_fnc_dynamicText","params":[{"name":"text","type":"String","description":"text to display","type_expr":"String"},{"name":"x","type":"Number or Array","optional":true,"default":"-1","description":"Number - Position in x\n- Array\n  - 0: Position in x\n  - 1: Width of the control","type_expr":"Number | Array","text":"x: Number or Array - (Optional, default -1)\n\n- Number - Position in x\n- Array\n  - 0: Position in x\n  - 1: Width of the control"},{"name":"y","type":"Number or Array","optional":true,"default":"-1","description":"Number - Position in y\n- Array\n  - 0: Position in y\n  - 1: Height of the control","type_expr":"Number | Array","text":"y: Number or Array - (Optional, default -1)\n\n- Number - Position in y\n- Array\n  - 0: Position in y\n  - 1: Height of the control"},{"name":"duration","type":"Number","optional":true,"default":"4","description":"display duration","type_expr":"Number","text":"duration: Number - (Optional, default 4) display duration"},{"name":"fadeInTime","type":"Number","optional":true,"default":"1","description":"fade-in time","type_expr":"Number","text":"fadeInTime: Number - (Optional, default 1) fade-in time"},{"name":"deltaY","type":"Number","optional":true,"default":"0","description":"Y position delta:\n\n- = 0: Text will not move\n- > 0: Text will move down\n- < 0: Text will move up\n\n*duration* and the absolute *deltaY* value will influence the movement speed.","type_expr":"Number","text":"deltaY: Number - (Optional, default 0) Y position delta:\n\n- = 0: Text will not move\n- > 0: Text will move down\n- < 0: Text will move up\n\n*duration* and the absolute *deltaY* value will influence the movement speed."},{"name":"rscLayer","type":"Number","description":"resource layer","type_expr":"Number"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"<t color='#ff0000' size='.8'>Warning!<br />Stop doing what you are doing</t>\",-1,-1,4,1,0,789] spawn BIS_fnc_dynamicText;"]}],"see_also":["BIS_fnc_infoText","BIS_fnc_textTiles","BIS_fnc_typeText","BIS_fnc_typeText2","BIS_fnc_EXP_camp_SITREP"]},{"name":"BIS_fnc_earthquake","title":"BIS fnc earthquake","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_earthquake","revid":378184,"updated":"2026-03-09T19:48:10Z","groups":["Environment"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"effect":"local"},"exec":"spawn","description":"Earthquake simulated through camera shake and sound. Stamina is impacted by the earthquake too.\nEarthquake will last between 13 and 20 seconds. While earthquake is in progress missionNamespace variable `BIS_fnc_earthquake_inprogress` will be true.","syntaxes":[{"syntax":"[intensity] spawn BIS_fnc_earthquake","params":[{"name":"intensity","type":"Number","optional":true,"default":"2","description":"can be 1, 2, 3 or 4. Any other value will fall back to the default value","type_expr":"Number","text":"intensity: Number - (Optional, default 2) can be 1, 2, 3 or 4. Any other value will fall back to the default value"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[4] spawn BIS_fnc_earthquake;"]}],"see_also":["addCamShake"]},{"name":"BIS_fnc_easeIn","title":"BIS fnc easeIn","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_easeIn","revid":348777,"updated":"2023-11-08T14:33:15Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Wraps BIS_fnc_lerp.","syntaxes":[{"syntax":"[a, b, alpha, exp] call BIS_fnc_easeIn","params":[{"name":"a","type":"Number","optional":true,"default":"0","description":"first point (start)","type_expr":"Number","text":"a: Number - (Optional, default 0) first point (start)"},{"name":"b","type":"Number","optional":true,"default":"0","description":"second point (end)","type_expr":"Number","text":"b: Number - (Optional, default 0) second point (end)"},{"name":"alpha","type":"Number","optional":true,"default":"0","description":"original interpolation speed","type_expr":"Number","text":"alpha: Number - (Optional, default 0) original interpolation speed"},{"name":"exp","type":"Number","optional":true,"default":"2","description":"power applied to alpha","type_expr":"Number","text":"exp: Number - (Optional, default 2) power applied to alpha"}],"returns":{"type":"Number","type_expr":"Number","description":"interpolated value"}}],"examples":[{"code":["[] call BIS_fnc_easeIn; // returns 0"]},{"code":["[0, 2, 0.5] call BIS_fnc_easeIn; // returns 0.5"]},{"code":["([0, 2, 0.5] call BIS_fnc_lerp) == ([0, 2, 0.5, 1] call BIS_fnc_easeIn); // returns true"]}],"see_also":["BIS_fnc_lerp"]},{"name":"BIS_fnc_easeInOut","title":"BIS fnc easeInOut","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_easeInOut","revid":274090,"updated":"2021-06-13T01:16:28Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_easeInOut","params":[],"returns":null}]},{"name":"BIS_fnc_easeInOutVector","title":"BIS fnc easeInOutVector","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_easeInOutVector","revid":273918,"updated":"2021-06-13T01:13:25Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_easeInOutVector","params":[],"returns":null}]},{"name":"BIS_fnc_easeInVector","title":"BIS fnc easeInVector","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_easeInVector","revid":274066,"updated":"2021-06-13T01:16:06Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_easeInVector","params":[],"returns":null}]},{"name":"BIS_fnc_easeOut","title":"BIS fnc easeOut","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_easeOut","revid":274006,"updated":"2021-06-13T01:15:04Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_easeOut","params":[],"returns":null}]},{"name":"BIS_fnc_easeOutVector","title":"BIS fnc easeOutVector","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_easeOutVector","revid":273919,"updated":"2021-06-13T01:13:26Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_easeOutVector","params":[],"returns":null}]},{"name":"BIS_fnc_effectFired","title":"BIS fnc effectFired","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_effectFired","revid":309594,"updated":"2022-05-05T12:07:28Z","groups":["Effects"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_effectFiredArtillery","title":"BIS fnc effectFiredArtillery","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_effectFiredArtillery","revid":309529,"updated":"2022-05-05T12:06:48Z","groups":["Effects"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_effectFiredCruiseMissile","title":"BIS fnc effectFiredCruiseMissile","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_effectFiredCruiseMissile","revid":274045,"updated":"2021-06-13T01:15:46Z","groups":["Effects"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Cruise Missile Start VFX BIS_fnc_effectFiredCruiseMissile\n\na: reyhard","syntaxes":[{"syntax":"[] call BIS_fnc_effectFiredCruiseMissile","params":[],"returns":null}],"docblock":{"text":"Cruise Missile Start VFX\nBIS_fnc_effectFiredCruiseMissile\n\na: reyhard"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_effectFiredFlares","title":"BIS fnc effectFiredFlares","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_effectFiredFlares","revid":309703,"updated":"2022-05-05T12:08:50Z","groups":["Effects"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Arma 2 flares, by Maddmatt","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"Arma 2 flares, by Maddmatt"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_effectFiredHeliRocket","title":"BIS fnc effectFiredHeliRocket","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_effectFiredHeliRocket","revid":309518,"updated":"2022-05-05T12:06:41Z","groups":["Effects"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_effectFiredLongSmoke","title":"BIS fnc effectFiredLongSmoke","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_effectFiredLongSmoke","revid":281344,"updated":"2021-06-14T09:08:48Z","groups":["Broken Functions"],"status":"broken","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"This function does nothing.","syntaxes":[{"syntax":"[] call BIS_fnc_effectFiredLongSmoke","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"-"}]},{"name":"BIS_fnc_effectFiredRifle","title":"BIS fnc effectFiredRifle","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_effectFiredRifle","revid":349187,"updated":"2023-11-08T14:50:39Z","groups":["Effects"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"effect":"local"},"description":"Used to add an effect to fired bullets. Should be executed from Fired Event Handler.","syntaxes":[{"syntax":"[unit, nil, nil, nil, ammoType] call BIS_fnc_effectFiredRifle","params":[{"name":"unit","type":"Object","description":"the unit, the effect should be added to","type_expr":"Object"},{"name":"nil","type":"Nothing","type_expr":"Nothing"},{"name":"nil","type":"Nothing","type_expr":"Nothing"},{"name":"nil","type":"Nothing","type_expr":"Nothing"},{"name":"ammoType","type":"String","description":"the type of ammo the effect should be triggered for","type_expr":"String"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"```sqf\nunit addEventHandler [\"Fired\",\n{\n   _this call BIS_fnc_effectFiredRifle;\n}];\n```","code":["unit addEventHandler [\"Fired\", \n{\n   _this call BIS_fnc_effectFiredRifle;\n}];"]}],"see_also":["addEventHandler","Arma 3: Event Handlers"]},{"name":"BIS_fnc_effectFiredRocket","title":"BIS fnc effectFiredRocket","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_effectFiredRocket","revid":379315,"updated":"2026-10-30T23:50:10Z","groups":["Effects"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}],"notes":[{"user":"DreadedEntity","date":"2014-11-13T21:21:00Z","text":"This function only makes a puff of smoke come out the back of the vehicle used as input\n**(A3 1.34.128075)**"}]},{"name":"BIS_fnc_effectFiredSmokeLauncher","title":"BIS fnc effectFiredSmokeLauncher","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_effectFiredSmokeLauncher","revid":309611,"updated":"2022-05-05T12:07:41Z","groups":["Effects"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Arma 2 smokscreen, by Maddmatt Uses code from VBS2 Smoke launcher by Philipp Pilhofer (raedor) & Andrew Barron","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"Arma 2 smokscreen, by Maddmatt\nUses code from VBS2 Smoke launcher by Philipp Pilhofer (raedor) & Andrew Barron"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_effectFiredSmokeLauncher_boat","title":"BIS fnc effectFiredSmokeLauncher boat","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_effectFiredSmokeLauncher_boat","revid":309870,"updated":"2022-05-05T12:09:53Z","groups":["Effects"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Arma 2 smokscreen, by Maddmatt Uses code from VBS2 Smoke launcher by Philipp Pilhofer (raedor) & Andrew Barron","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"Arma 2 smokscreen, by Maddmatt\nUses code from VBS2 Smoke launcher by Philipp Pilhofer (raedor) & Andrew Barron"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_effectKilled","title":"BIS fnc effectKilled","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_effectKilled","revid":309763,"updated":"2022-05-05T12:09:49Z","groups":["Effects"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_effectKilledAirDestruction","title":"BIS fnc effectKilledAirDestruction","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_effectKilledAirDestruction","revid":309724,"updated":"2022-05-05T12:09:47Z","groups":["Effects"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"server_exec":true},"description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_effectKilledAirDestructionStage2","title":"BIS fnc effectKilledAirDestructionStage2","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_effectKilledAirDestructionStage2","revid":309817,"updated":"2022-05-05T12:09:51Z","groups":["Effects"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_effectKilledSecondaries","title":"BIS fnc effectKilledSecondaries","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_effectKilledSecondaries","revid":309837,"updated":"2022-05-05T12:09:52Z","groups":["Effects"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"server_exec":true},"description":"```\n//Small secondary fuel explosions\n//By Maddmatt for Arma 2\n```","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_effectPlankton","title":"BIS fnc effectPlankton","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_effectPlankton","revid":309355,"updated":"2022-05-05T12:04:31Z","groups":["Effects"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"effect":"local"},"description":"Create underwater plankton particle effect.","syntaxes":[{"syntax":"call BIS_fnc_effectPlankton","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_effectPlankton;"]}]},{"name":"BIS_fnc_EGObjectiveVisualizer","title":"BIS fnc EGObjectiveVisualizer","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EGObjectiveVisualizer","revid":270266,"updated":"2021-06-12T19:52:59Z","groups":["Spectator"],"status":"ok","games":{"arma3":"1.54"},"since":"arma3 1.54","arma3_since":"1.54","description":"Part of the EG Spectator Mode.\n\n> [!IMPORTANT]\n> For internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["EG Spectator Mode"]},{"name":"BIS_fnc_EGObjectiveVisualizerDraw","title":"BIS fnc EGObjectiveVisualizerDraw","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EGObjectiveVisualizerDraw","revid":275254,"updated":"2021-06-13T02:23:02Z","groups":["Spectator"],"status":"ok","games":{"arma3":"1.54"},"since":"arma3 1.54","arma3_since":"1.54","description":"Part of the EG Spectator Mode.\n\n> [!IMPORTANT]\n> For internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["EG Spectator Mode"]},{"name":"BIS_fnc_EGSpectator","title":"BIS fnc EGSpectator","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EGSpectator","revid":348958,"updated":"2023-11-08T14:45:39Z","groups":["Spectator"],"status":"ok","games":{"arma3":"1.54"},"since":"arma3 1.54","arma3_since":"1.54","description":"Spectator instance.","syntaxes":[{"syntax":"[mode, [spectator, whitelistedSides, allowAi, allowFreeCamera, allow3PPCamera, showFocusInfo, showCameraButtons, showControlsHelper, showHeader, showLists]] call BIS_fnc_EGSpectator","params":[{"name":"mode","type":"String","description":"function mode, can be:\n\n- \"Initialize\"\n- \"Terminate\"\n\n**See the in-game Functions Viewer to see all the possible values. The following parameters are for \"Initialize\".**","type_expr":"String"},{"name":"spectator","type":"Object","description":"player","type_expr":"Object"},{"name":"whitelistedSides","type":"Array","optional":true,"default":"[]","description":"sides that can be spectated","type_expr":"Array","text":"whitelistedSides: Array - (Optional, default: []) sides that can be spectated"},{"name":"allowAi","type":"Boolean","optional":true,"default":"false","description":"whether AI can be viewed by the spectator","type_expr":"Boolean","text":"allowAi: Boolean - (Optional, default: false) whether AI can be viewed by the spectator"},{"name":"allowFreeCamera","type":"Boolean","optional":true,"default":"true","description":"whether free camera mode is available","type_expr":"Boolean","text":"allowFreeCamera: Boolean - (Optional, default: true) whether free camera mode is available"},{"name":"allow3PPCamera","type":"Boolean","optional":true,"default":"true","description":"whether 3rd Person camera mode is available","type_expr":"Boolean","text":"allow3PPCamera: Boolean - (Optional, default: true) whether 3rd Person camera mode is available"},{"name":"showFocusInfo","type":"Boolean","optional":true,"default":"true","description":"whether to show Focus Info stats widget","type_expr":"Boolean","text":"showFocusInfo: Boolean - (Optional, default: true) whether to show Focus Info stats widget"},{"name":"showCameraButtons","type":"Boolean","optional":true,"default":"true","description":"whether or not to show camera buttons widget","type_expr":"Boolean","text":"showCameraButtons: Boolean - (Optional, default: true) whether or not to show camera buttons widget"},{"name":"showControlsHelper","type":"Boolean","optional":true,"default":"true","description":"whether to show controls helper widget","type_expr":"Boolean","text":"showControlsHelper: Boolean - (Optional, default: true) whether to show controls helper widget"},{"name":"showHeader","type":"Boolean","optional":true,"default":"true","description":"whether to show header widget","type_expr":"Boolean","text":"showHeader: Boolean - (Optional, default: true) whether to show header widget"},{"name":"showLists","type":"Boolean","optional":true,"default":"true","description":"whether to show entities / locations lists","type_expr":"Boolean","text":"showLists: Boolean - (Optional, default: true) whether to show entities / locations lists"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"the return value depends on the mode. For \"Initialize\" and \"Terminate\" a Boolean indicating successful execution is returned."}}],"examples":[{"code":["[\"Initialize\", [player]] call BIS_fnc_EGSpectator;"]}],"see_also":["Arma 3: End Game Spectator Mode"]},{"name":"BIS_fnc_EGSpectatorCamera","title":"BIS fnc EGSpectatorCamera","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EGSpectatorCamera","revid":278956,"updated":"2021-06-13T21:47:03Z","groups":["Spectator"],"status":"ok","games":{"arma3":"1.54"},"since":"arma3 1.54","arma3_since":"1.54","description":"Part of the EG Spectator Mode.\n\n> [!IMPORTANT]\n> For internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["EG Spectator Mode"]},{"name":"BIS_fnc_EGSpectatorCameraPrepareTarget","title":"BIS fnc EGSpectatorCameraPrepareTarget","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EGSpectatorCameraPrepareTarget","revid":278681,"updated":"2021-06-13T21:38:37Z","groups":["Spectator"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_EGSpectatorCameraResetTarget","title":"BIS fnc EGSpectatorCameraResetTarget","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EGSpectatorCameraResetTarget","revid":278707,"updated":"2021-06-13T21:38:56Z","groups":["Spectator"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_EGSpectatorCameraSetTarget","title":"BIS fnc EGSpectatorCameraSetTarget","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EGSpectatorCameraSetTarget","revid":278672,"updated":"2021-06-13T21:38:27Z","groups":["Spectator"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_EGSpectatorCameraTick","title":"BIS fnc EGSpectatorCameraTick","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EGSpectatorCameraTick","revid":278729,"updated":"2021-06-13T21:39:12Z","groups":["Spectator"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_EGSpectatorDraw2D","title":"BIS fnc EGSpectatorDraw2D","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EGSpectatorDraw2D","revid":278581,"updated":"2021-06-13T21:37:15Z","groups":["Spectator"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_EGSpectatorDraw3D","title":"BIS fnc EGSpectatorDraw3D","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EGSpectatorDraw3D","revid":278766,"updated":"2021-06-13T21:39:39Z","groups":["Spectator"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_EGSpectatorGetUnitsToDraw","title":"BIS fnc EGSpectatorGetUnitsToDraw","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EGSpectatorGetUnitsToDraw","revid":278641,"updated":"2021-06-13T21:38:02Z","groups":["Spectator"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_ejectionSeatRelease","title":"BIS fnc ejectionSeatRelease","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_ejectionSeatRelease","revid":376188,"updated":"2025-09-13T16:42:56Z","groups":["Aircraft Functionality"],"status":"ok","games":{"arma3":"1.70"},"since":"arma3 1.70","arma3_since":"1.70","description":"- This function is designed as part of set of functions to implement semi-authenthic ejection system on fixed wing aircrfat that have such functionality enabled/configured.\n- Additional option for player to separate from ejetor seat via user action. default ejection function will ato deploy parachute at 350 m altitude. This is a manual override.\n- Generic parachute used, currently only one model in game so no need to parametarize.","syntaxes":[{"syntax":"vehicle call BIS_fnc_ejectionSeatRelease","params":[{"name":"vehicle","type":"Object","description":"object with a unit in it. Despite the name this does not have to be an ejection seat - the function is essentially a simple wrapper for moveOut. The first unit in the crew array will be used.","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["_ejectionSeat call BIS_fnc_ejectionSeatRelease;"]}],"see_also":["BIS_fnc_planeEjection","BIS_fnc_planeAiEject","BIS_fnc_planeEjectionFX"],"docblock":{"text":"Author: Bravo Zero One development\n- John_Spartan\n\nDescription:\n- This function is designed as part of set of functions to implement semi-authenthic ejection system on fixed wing aircrfat that have such functionality enabled/configured.\n- Additional option for player to separate from ejetor seat via user action. default ejection function will ato deploy parachute at 350 m altitude. This is a manual override.\n- Generic parachute used, currently only one model in game so no need to parametarize.\n\nExecution:\n- Call the function via user action defined on the ejector seat vehicle.\n\n    Example:\n    class UserActions\n    {\n\n        class Ejection_Seat_Eject\n        {\n            priority = 0.05;\n            shortcut = \"Eject\";\n            displayName = \"$STR_A3_action_deploy_parachute\";\n            condition = \"player in this\";\n            statement = \"[this] spawn BIS_fnc_ejectionSeatRelease\";\n            position = \"pilotcontrol\";\n            radius = 10;\n            onlyforplayer = 1;\n            showWindow = 0;\n            hideOnUse = 1;\n        };\n    };\n\nRequirements:\n- Compatible ejector seat must have a user action set up to triger this fnc.\n\nParameter(s):\n    _this select 0: mode (Scalar)\n    0: ejector seat/object\n\nReturns: nothing\nResult: Pilot will be forced from ejection seat vehicle to parachute. Semi-authenthic behaviour.","author":"Bravo Zero One development, John_Spartan"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_enableSaving","title":"BIS fnc enableSaving","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_enableSaving","revid":349320,"updated":"2023-11-08T14:52:29Z","groups":["Missions"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Controls the enabling of saving. Will only enable saving if there are no remaining requests for disabled saving.","syntaxes":[{"syntax":"id call BIS_fnc_enableSaving","params":[{"name":"id","type":"String","description":"unique id previously used to disable saving via BIS_fnc_disableSaving","type_expr":"String"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if successful, false if not"}}],"examples":[{"code":["\"savingID\" call BIS_fnc_enableSaving;"]}],"see_also":["BIS_fnc_disableSaving","saveGame","BIS_fnc_saveGame","loadGame"]},{"name":"BIS_fnc_encodeFlags","title":"BIS fnc encodeFlags","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_encodeFlags","revid":348540,"updated":"2023-11-08T13:06:07Z","groups":["Bitwise"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Encodes array of unique binary flags with indexes between 0-15 into a single scalar.","syntaxes":[{"syntax":"flags call BIS_fnc_encodeFlags","params":[{"name":"flags","type":"Array","description":"array of unique binary flags with indexes between 0-15","type_expr":"Array"}],"returns":{"type":"Number","type_expr":"Number","description":"encoded flags"}}],"examples":[{"code":["private _encodedFlags = [0,2,3] call BIS_fnc_encodeFlags;//Returns 13"]}],"see_also":["BIS_fnc_decodeFlags"]},{"name":"BIS_fnc_encodeFlags2","title":"BIS fnc encodeFlags2","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_encodeFlags2","revid":337995,"updated":"2023-02-23T21:11:09Z","groups":["Bitwise"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Encodes array of unique binary flags (zeroes or ones) into a single scalar.\n\n> [!IMPORTANT]\n> Note that the input array is in [Big Endian](https://en.wikipedia.org/wiki/Endianness#Definition), meaning that the smallest value is **to the left**.","syntaxes":[{"syntax":"arrayOfNumbers call BIS_fnc_encodeFlags2","params":[{"name":"arrayOfNumbers","type":"Array of Numbers","description":"\"boolean\" flags where 0 = false and 1 = true","type_expr":"Array<Number>"}],"returns":{"type":"Number","type_expr":"Number","description":"the calculated number"}}],"examples":[{"code":["private _result = [1,0,1,1] call BIS_fnc_encodeFlags2;\nhint str _result; // Displays 13"]}],"see_also":["BIS_fnc_encodeFlags","BIS_fnc_encodeFlags4","BIS_fnc_encodeFlags8","BIS_fnc_decodeFlags","BIS_fnc_decodeFlags2","BIS_fnc_decodeFlags4","BIS_fnc_decodeFlags8"]},{"name":"BIS_fnc_encodeFlags4","title":"BIS fnc encodeFlags4","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_encodeFlags4","revid":373737,"updated":"2025-06-24T17:58:44Z","groups":["Bitwise"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Encodes array of unique 4-state flags (0,1,2,3) into a single number.","syntaxes":[{"syntax":"flags call BIS_fnc_encodeFlags4","params":[{"name":"flags","type":"Array of Numbers","description":"collections of 4-state flags. Maximum number of flags is 12.","type_expr":"Array<Number>"}],"returns":{"type":"Number","type_expr":"Number","description":"encoded flags"}}],"examples":[{"code":["private _encodedFlags = [1, 0, 2, 3] call BIS_fnc_encodeFlags4; // 225"]}],"see_also":["BIS_fnc_decodeFlags4"]},{"name":"BIS_fnc_encodeFlags8","title":"BIS fnc encodeFlags8","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_encodeFlags8","revid":373740,"updated":"2025-06-24T19:05:41Z","groups":["Bitwise"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Encodes array of unique 8-state flags (0,1,2,3,4,5,6,7) into a single number.","syntaxes":[{"syntax":"flags call BIS_fnc_encodeFlags8","params":[{"name":"flags","type":"Array of Numbers","description":"collections of 8-state flags. Maximum number of flags is 12.","type_expr":"Array<Number>"}],"returns":{"type":"Number","type_expr":"Number","description":"encoded flags"}}],"examples":[{"code":["private _encodedFlags = [7, 2, 3, 0, 1] call BIS_fnc_encodeFlags8; // 4311"]}],"see_also":["BIS_fnc_decodeFlags8"]},{"name":"BIS_fnc_endLoadingScreen","title":"BIS fnc endLoadingScreen","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_endLoadingScreen","revid":369457,"updated":"2024-09-06T08:44:54Z","groups":["GUI"],"status":"ok","games":{"arma3":"0.58"},"since":"arma3 0.58","arma3_since":"0.58","description":"Unregister a loading screen. When none other remains, end the loading.\n\n> [!NOTE]\n> **Arma 3:** The loading screen can be force-ended with the ENDLOAD cheat code.","syntaxes":[{"syntax":"screenId call BIS_fnc_endLoadingScreen","params":[{"name":"screenId","type":"String","description":"screen ID, used in BIS_fnc_startLoadingScreen","type_expr":"String"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when unregistered"}}],"examples":[{"code":["[\"myLoadingScreen\", \"Loading… wait for my splendid™ mission!\"] call BIS_fnc_startLoadingScreen;\nuiSleep 3;\n\"myLoadingScreen\" call BIS_fnc_endLoadingScreen;"]}],"see_also":["BIS_fnc_startLoadingScreen","startLoadingScreen","endLoadingScreen"]},{"name":"BIS_fnc_endMission","title":"BIS fnc endMission","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_endMission","revid":379265,"updated":"2026-10-30T23:43:31Z","groups":["Missions"],"status":"ok","games":{"arma3":"0.50"},"since":"arma3 0.50","arma3_since":"0.50","locality":{"effect":"local"},"description":"Ends mission with a signature shot or a fade effect, marks it finished for Steam and activates a key in format `activateKey format [\"BIS_%1.%2_done\", missionName, worldName];`.\n\n> [!IMPORTANT]\n> This function should always be used instead of the simple endMission/failMission commands or trigger endings; otherwise, singleplayer scenarios will not properly be marked as played/finished in the game and on Steam!","syntaxes":[{"syntax":"[endName, isVictory, fadeType, playMusic, cancelTasks] call BIS_fnc_endMission","params":[{"name":"endName","type":"String or Array","optional":true,"default":"\"end1\"","description":"String - end type from `configFile >> \"CfgDebriefing\"`. Same as with endMission and failMission\n- Array - in format [endName, ID], will be composed to \"endName_ID\" string","type_expr":"String | Array","text":"endName: String or Array - (Optional, default \"end1\")\n\n- String - end type from `configFile >> \"CfgDebriefing\"`. Same as with endMission and failMission\n- Array - in format [endName, ID], will be composed to \"endName_ID\" string"},{"name":"isVictory","type":"Boolean","optional":true,"default":"true","description":"true for successful end, false for failed end","type_expr":"Boolean","text":"isVictory: Boolean - (Optional, default true) true for successful end, false for failed end"},{"name":"fadeType","type":"Boolean or Number","optional":true,"default":"true","description":"true for signature closing shot. When number, simple fade to black of given duration is used","type_expr":"Boolean | Number","text":"fadeType: Boolean or Number - (Optional, default true) true for signature closing shot. When number, simple fade to black of given duration is used"},{"name":"playMusic","type":"Boolean","optional":true,"default":"true","description":"false to disable automatic music during closing shot","type_expr":"Boolean","text":"playMusic: Boolean - (Optional, default true) false to disable automatic music during closing shot"},{"name":"cancelTasks","type":"Boolean","optional":true,"default":"false","description":"true to cancel all pending tasks","type_expr":"Boolean","text":"cancelTasks: Boolean - (Optional, default false) true to cancel all pending tasks"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["\"end1\" call BIS_fnc_endMission;"]},{"code":["[\"epicFail\", false, 2] call BIS_fnc_endMission;"]}],"see_also":["BIS_fnc_endMissionServer","Debriefing","endMission","markAsFinishedOnSteam"],"notes":[{"user":"R3vo","date":"2016-03-21T11:12:00Z","text":"To end a multiplayer mission one can use `[\"end1\", true] remoteExecCall [\"BIS_fnc_endMission\"];` - see also BIS_fnc_endMissionServer."}],"categories_extra":["Introduced with Take On Helicopters version 1.00","Take On Helicopters: Functions","Take On Helicopters: New Functions"]},{"name":"BIS_fnc_endMissionServer","title":"BIS fnc endMissionServer","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_endMissionServer","revid":363361,"updated":"2024-03-27T20:01:55Z","groups":["Multiplayer"],"status":"deprecated","replaced_by":["remoteExec","BIS_fnc_endMission"],"games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"effect":"global","server_exec":true},"description":"Ends the mission properly for all players in a multiplayer environment.\n\n> [!NOTE]\n> This function is somewhat deprecated for custom endings since Arma 3 v1.50 as remote-executing BIS_fnc_endMission allows for more options:\n>\n> ```sqf\n> [\"MyEnding\", true, 3] remoteExec [\"BIS_fnc_endMission\", 0, true];\n> ```","syntaxes":[{"syntax":"endType call BIS_fnc_endMissionServer","params":[{"name":"endType","type":"String","description":"class name of ending defined in CfgDebriefing.\nCan be **custom** or one of dynamically calculated ones:\n\n- \"EveryoneWon\" - Show \"MISSION COMPLETED\" to everyone\n- \"EveryoneLost\" - Show \"MISSION FAILED\" to everyone\n- \"SideTickets\" - Show \"YOUR SIDE WON\" to side/s with most tickets and \"YOUR SIDE LOST\" to everyone else\n- \"SideScore\" - Show \"YOUR SIDE WON\" to side with largest score\n- \"GroupScore\" - Show \"YOUR GROUP WON\" to group with largest score\n- \"PlayerScore\" - Show \"YOU WON\" to player with largest score","type_expr":"String"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["\"SideScore\" call BIS_fnc_endMissionServer;"]}],"see_also":["BIS_fnc_endMission","failMission","forceEnd","endMission"]},{"name":"BIS_fnc_enemyDetected","title":"BIS fnc enemyDetected","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_enemyDetected","revid":379494,"updated":"2026-10-31T00:26:14Z","groups":["Combat"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns true if unit knows about nearby enemy unit or driven vehicle.","syntaxes":[{"syntax":"unit call BIS_fnc_enemyDetected","params":[{"name":"unit","type":"Object","description":"unit that is inspected","type_expr":"Object"},{"name":"distance","type":"Number","description":"radius around unit to check","type_expr":"Number","text":"distance - Number: radius around unit to check"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"True if an enemy was detected"}}],"examples":[{"code":["private _enemyDetected = _unit call BIS_fnc_enemyDetected;"]},{"code":["private _enemyDetected = [_unit, 100] call BIS_fnc_enemyDetected;"]}],"see_also":["BIS_fnc_enemyTargets"]},{"name":"BIS_fnc_enemySides","title":"BIS fnc enemySides","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_enemySides","revid":341631,"updated":"2023-06-12T19:02:54Z","groups":["Sides"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns sides hostile to the given side / object.","syntaxes":[{"syntax":"input call BIS_fnc_enemySides","params":[{"name":"input","type":"Object or Side","description":"side or object whose hostile sides should be returned","type_expr":"Object | Side"}],"returns":{"type":"Array","type_expr":"Array","description":"containing all hostile sides of given side or object","text":"Array containing all hostile sides of given side or object"}}],"examples":[{"code":["player call BIS_fnc_enemySides;"]}],"see_also":["side","countSide","Side","playerSide","west","east","resistance","civilian","sideLogic","sideFriendly","sideEnemy","sideUnknown","sideEmpty","sideAmbientLife","Side Relations"]},{"name":"BIS_fnc_enemyTargets","title":"BIS fnc enemyTargets","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_enemyTargets","revid":379495,"updated":"2026-10-31T00:26:22Z","groups":["Combat"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Return list of nearby enemy targets for given unit.","syntaxes":[{"syntax":"unit call BIS_fnc_enemyTargets","params":[{"name":"unit","type":"Object","description":"unit that is inspected","type_expr":"Object"}],"returns":{"type_expr":"Array","text":"Array of enemies, empty if unit doesn't know about any enemy"}}],"examples":[{"code":["private _targets = _unit call BIS_fnc_enemyTargets;"]}],"see_also":["BIS_fnc_enemyDetected"]},{"name":"BIS_fnc_error","title":"BIS fnc error","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_error","revid":352467,"updated":"2024-02-11T23:23:56Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"0.50"},"since":"arma3 0.50","arma3_since":"0.50","description":"Logs an error message and shows an ingame error message. The message is shown when either of the following is true:\n\n- In 2D Editor\n- In Eden Editor via BIS_fnc_3DENNotification\n- Display `313` (Eden Editor display) is available\n- `profileNamespace getVariable [\"BIS_fnc_init_displayErrors\", false]` is set to `true`.\n\n**Output format:**\n\n- In multiplayer (isMultiplayer) the function will add the profileName in front of the message\n- If `_fnc_error_exit` is set to `true` before the function call, the log message will display `HALT:` instead of `ERROR:`\n- If function is called from within another function, the name of the parent function will be displayed. This can be overwritten by setting `_fnc_scriptName` to a custom value\n\n> [!NOTE]\n> `allowFunctionsLog` has to be set to **1** in Description.ext for this function to have any effect.","syntaxes":[{"syntax":"[message, param1, ..., paramN] call BIS_fnc_error","params":[{"name":"message","type":"String","description":"(formatted) logged message","type_expr":"String"},{"name":"param1..paramN","type":"Anything","optional":true,"description":"format arguments, if any","type_expr":"Anything","text":"param1..paramN: Anything - (Optional) format arguments, if any"}],"returns":{"type":"Array","type_expr":"Array","description":"in format: [message, param1..paramN]","text":"Array in format: [message, param1..paramN]"}}],"examples":[{"code":["[\"Player is too far away (%1 metres)\", round (player distance [0, 0, 0])] call BIS_fnc_error;"]},{"code":["// some useful function cases\nif (!isServer) exitWith { [\"This function must run on the server\"] call BIS_fnc_error };\nif (!hasInterface) exitWith { [\"This function must not run on a headless machine\"] call BIS_fnc_error };\nif (!local _vehicle) exitWith { [\"This function must run on the vehicle owner's machine\"] call BIS_fnc_error };"]},{"text":"```sqf\n// Change rpt log to \"HALT\" indicating that function exited\nprivate _fnc_error_exit = true;\nif (exitHere) exitWith\n{\n    \"Some error message!\" call BIS_fnc_error; // Output in rpt: \"log: HALT: [BIS_fnc_debugConsoleExec] Some error message!\"\n};\n```","code":["// Change rpt log to \"HALT\" indicating that function exited\nprivate _fnc_error_exit = true;\nif (exitHere) exitWith\n{\n\t\"Some error message!\" call BIS_fnc_error; // Output in rpt: \"log: HALT: [BIS_fnc_debugConsoleExec] Some error message!\"\n};"]},{"code":["private _fnc_scriptName = \"My_Awesome_Custom_Function\";\n\"Some error message!\" call BIS_fnc_error; // Output in rpt: \"log: ERROR: [My_Awesome_Custom_Function] Some error message!\""]}],"see_also":["BIS_fnc_errorMsg","BIS_fnc_log","BIS_fnc_logFormat","BIS_fnc_logFormatServer"]},{"name":"BIS_fnc_errorMsg","title":"BIS fnc errorMsg","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_errorMsg","revid":351742,"updated":"2023-12-30T21:31:28Z","groups":["Broken Functions"],"status":"broken","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Display error window.\n\n> [!NOTE]\n> **Arma 3:** Broken in Arma 3. Use BIS_fnc_error instead","syntaxes":[{"syntax":"[message, otherParameters] call BIS_fnc_errorMsg","params":[{"name":"message","type":"String","type_expr":"String"},{"name":"otherParameters","type":"Anything","description":"to format format command","type_expr":"Anything"}],"returns":{"type":"Script Handle","type_expr":"Script Handle"}}],"examples":[{"code":["[\"This is an error message\"] call BIS_fnc_errorMsg;"]},{"code":["[\"This is an error message: player is: %1\", player] call BIS_fnc_errorMsg;"]}],"see_also":["BIS_fnc_error","BIS_fnc_logFormat","BIS_fnc_log","BIS_fnc_logFormatServer"]},{"name":"BIS_fnc_errorParamsType","title":"BIS fnc errorParamsType","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_errorParamsType","revid":348544,"updated":"2023-11-08T13:06:09Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"effect":"local"},"description":"Displays a parameter type error message (using BIS_fnc_error) explaining the problem.","syntaxes":[{"syntax":"[value, method, expected] call BIS_fnc_errorParamsType","params":[{"name":"value","type":"Anything","optional":true,"default":"nil","description":"value received.","type_expr":"Anything","text":"**value**: Anything - (Optional, default nil) value received."},{"name":"method","type":"String","optional":true,"default":"\"\"","description":"validation method, can be one of:\n\n- \"isEqualType\"\n- \"isEqualTypeArray\"\n- \"isEqualTypeAll\"\n- \"isEqualTypeAny\"\n- \"isEqualTypeParams\"","type_expr":"String","text":"**method**: String - (Optional, default \"\") validation method, can be one of:\n\n- \"isEqualType\"\n- \"isEqualTypeArray\"\n- \"isEqualTypeAll\"\n- \"isEqualTypeAny\"\n- \"isEqualTypeParams\""},{"name":"expected","type":"Anything","optional":true,"default":"nil","description":"expected type.","type_expr":"Anything","text":"**expected** (Optional, default: nil): Anything - expected type."}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["// show error and abort if input is not of type ARRAY:\nif !(_this isEqualType []) exitWith { [_this, \"isEqualType\", []] call BIS_fnc_errorParamsType; };"]},{"code":["// show error and abort if array input is not in format [SCALAR, STRING, BOOL]:\nif !(_this isEqualTypeArray [0, \"\", true]) exitWith { [_this, \"isEqualTypeArray\", [0, \"\", true]] call BIS_fnc_errorParamsType; };"]},{"code":["// show error and abort if array input is not in format [BOOL, BOOL, BOOL, ...]:\nif !(_this isEqualTypeAll true) exitWith { [_this, \"isEqualTypeAll\", true] call BIS_fnc_errorParamsType; };"]},{"code":["// show error and abort if input is neither ARRAY nor OBJECT:\nif !(_this isEqualTypeAny [[], objNull]) exitWith { [_this, \"isEqualTypeAny\", [[], objNull]] call BIS_fnc_errorParamsType; };"]},{"code":["// show error and abort if input is neither of type ARRAY nor array in format [SCALAR, ARRAY, <ANYTHING>, OBJECT]:\nif !(_this isEqualTypeParams [0, [], nil, objNull]) exitWith { [_this, \"isEqualTypeParams\", [0, [], nil, objNull]] call BIS_fnc_errorParamsType; };"]}],"see_also":["BIS_fnc_error"]},{"name":"BIS_fnc_escortAI","title":"BIS fnc escortAI","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_escortAI","revid":309705,"updated":"2022-05-05T12:09:44Z","groups":["Interaction"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_escortAIHoldAction","title":"BIS fnc escortAIHoldAction","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_escortAIHoldAction","revid":309880,"updated":"2022-05-05T12:09:54Z","groups":["Interaction"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_establishingShot","title":"BIS fnc establishingShot","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_establishingShot","revid":370443,"updated":"2024-12-10T00:25:43Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"global","effect":"local"},"exec":"spawn","description":"Plays a fake UAV observational sequence which serves as an establishing shot.","syntaxes":[{"syntax":"[target, text, altitude, radius, angle, rotation, iconOptions, mode, fadeIn, waitTime] spawn BIS_fnc_establishingShot","params":[{"name":"target","type":"Object or Array","description":"target or target's position","type_expr":"Object | Array"},{"name":"text","type":"String","optional":true,"default":"\"\"","description":"text to display","type_expr":"String","text":"text: String - (Optional, default \"\") text to display"},{"name":"altitude","type":"Number","optional":true,"default":"500","description":"altitude in meters","type_expr":"Number","text":"altitude: Number - (Optional, default 500) altitude in meters"},{"name":"radius","type":"Number","optional":true,"default":"200","description":"radius of the circular movement in meters","type_expr":"Number","text":"radius: Number - (Optional, default 200) radius of the circular movement in meters"},{"name":"angle","type":"Number","optional":true,"default":"random","description":"viewing angle in degrees","type_expr":"Number","text":"angle: Number - (Optional, default random) viewing angle in degrees"},{"name":"rotation","type":"Number","optional":true,"default":"random","description":"direction of camera movement\n\n- 0: anti-clockwise\n- 1: clockwise","type_expr":"Number","text":"rotation: Number - (Optional, default random) direction of camera movement\n\n- 0: anti-clockwise\n- 1: clockwise"},{"name":"iconOptions","type":"Array of Arrays","optional":true,"default":"`[]`","description":"each array in format [icon, color, target, sizeX, sizeY, angle, text, shadow]:\n\n- icon: String - path to icon texture\n- color: Array format Color (RGBA)\n- target: Object, Position or Group - where the texture should be drawn\n- sizeX: Number - (Optional, default 1) icon width\n- sizeY: Number - (Optional, default 1) icon height\n- angle: Number - (Optional, default random 360) icon angle\n- text: String - (Optional, default \"\") text displayed underneath the icon\n- shadow: Number - (Optional, default 0)\n  - 0 to draw a flat icon\n  - 1 to draw a shadowed icon","type_expr":"Array<Array>","text":"iconOptions: Array of Arrays - (Optional, default `[]`) each array in format [icon, color, target, sizeX, sizeY, angle, text, shadow]:\n\n- icon: String - path to icon texture\n- color: Array format Color (RGBA)\n- target: Object, Position or Group - where the texture should be drawn\n- sizeX: Number - (Optional, default 1) icon width\n- sizeY: Number - (Optional, default 1) icon height\n- angle: Number - (Optional, default random 360) icon angle\n- text: String - (Optional, default \"\") text displayed underneath the icon\n- shadow: Number - (Optional, default 0)\n  - 0 to draw a flat icon\n  - 1 to draw a shadowed icon"},{"name":"mode","type":"Number","optional":true,"default":"0","description":"0: normal (disables saving and sets `BIS_missionStarted` to nil)\n- 1: world scenes (i.e. for main menu background, doesn't display text and does not end)","type_expr":"Number","text":"mode: Number - (Optional, default 0)\n\n- 0: normal (disables saving and sets `BIS_missionStarted` to nil)\n- 1: world scenes (i.e. for main menu background, doesn't display text and does not end)"},{"name":"fadeIn","type":"Boolean","optional":true,"default":"true","description":"fade in after completion","type_expr":"Boolean","text":"fadeIn: Boolean - (Optional, default true) fade in after completion"},{"name":"waitTime","type":"Number","optional":true,"default":"2","description":"wait time in seconds after the shot has been completed","type_expr":"Number","since":"arma3 1.82","text":"waitTime: Number - (Optional, default 2) wait time in seconds after the shot has been completed"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when done"}}],"examples":[{"code":["[player, \"I can see my house from here\", 500, 250, 75, 1, [], 0, true] spawn BIS_fnc_establishingShot;"]},{"text":"```sqf\n[\n    [5229.97, 5233.07, 0],\n    \"BLUFOR and OPFOR firefight\",\n    500,\n    250,\n    75,\n    1,\n    [\n        [\"\\A3\\ui_f\\data\\map\\markers\\nato\\b_inf.paa\", [0, 0.3, 0.6, 1], group_1, 1, 1, 0, \"BLUFOR\"],\n        [\"\\A3\\ui_f\\data\\map\\markers\\nato\\o_inf.paa\", [0.5, 0, 0, 1], group_2, 1, 1, 0, \"OPFOR\"]\n    ],\n    0,\n    true,\n    15\n] spawn BIS_fnc_establishingShot;\n```","code":["[\n\t[5229.97, 5233.07, 0],\n\t\"BLUFOR and OPFOR firefight\",\n\t500,\n\t250,\n\t75,\n\t1,\n\t[\n\t\t[\"\\A3\\ui_f\\data\\map\\markers\\nato\\b_inf.paa\", [0, 0.3, 0.6, 1], group_1, 1, 1, 0, \"BLUFOR\"],\n\t\t[\"\\A3\\ui_f\\data\\map\\markers\\nato\\o_inf.paa\", [0.5, 0, 0, 1], group_2, 1, 1, 0, \"OPFOR\"]\n\t],\n\t0,\n\ttrue,\n\t15\n] spawn BIS_fnc_establishingShot;"]}],"see_also":["BIS_fnc_dynamicText","Arma 3: Mission Presentation"],"notes":[{"user":"Lou Montana","date":"2018-01-28T02:01:00Z","text":"Be aware that spawning this function will set enableSaving to true. Quick workaround:\n\n```sqf\nprivate _savingEnabled = savingEnabled;\n_handle = [player, \"myText\"] spawn BIS_fnc_establishingShot;\nwaitUntil { scriptDone _handle };\nenableSaving [_savingEnabled, false];\n```\n\nOr, if you can't wait the end of the establishing shot:\n\n```sqf\nprivate _savingEnabled = savingEnabled;\n_handle = [player, \"myText\"] spawn BIS_fnc_establishingShot;\n_handle spawn { waitUntil { scriptDone _this }; enableSaving [_savingEnabled, false]; };\n```"},{"user":"R3vo","date":"2019-07-30T12:01:00Z","text":"In order to change the camera to TI or NVG mode execute the following right after BIS_fnc_establishingShot was spawned.\n\n```sqf\ntrue setCamUseTI 1;\n```\n\nThe effect will automatically be terminated once the establishing shot ended."}]},{"name":"BIS_fnc_estimatedTimeLeft","title":"BIS fnc estimatedTimeLeft","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_estimatedTimeLeft","revid":348865,"updated":"2023-11-08T14:39:13Z","groups":["Multiplayer"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Set mission countdown.","syntaxes":[{"syntax":"[time] call BIS_fnc_estimatedTimeLeft","params":[{"name":"time","type":"Number","description":"mission countdown","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number","description":"estimatedEndServerTime"}}],"examples":[{"code":["[180] call BIS_fnc_estimatedTimeLeft;"]}],"see_also":["estimatedEndServerTime"]},{"name":"BIS_fnc_eventTimeline","title":"BIS fnc eventTimeline","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_eventTimeline","revid":352082,"updated":"2024-02-01T23:24:45Z","groups":["Timeline","Systems"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","locality":{"effect":"local"},"exec":"spawn","description":"Universal system for playing sequential events defined by time.\n\n> [!NOTE]\n> *codeInterrupt* and *codeEnd* are called while the code in the timeline is spawned.","syntaxes":[{"syntax":"[timeline, index, music, codeInterrupt, codeEnd] call BIS_fnc_eventTimeline","params":[{"name":"timeline","type":"Array","description":"timeline in format [[1.0, {code}], [2.0, {code}], [2.3, {code}], [4.7, {code}]]","type_expr":"Array"},{"name":"index","type":"Number","optional":true,"default":"0","description":"index of the event to play","type_expr":"Number","text":"index: Number - (Optional, default 0) index of the event to play"},{"name":"music","type":"String","optional":true,"default":"\"\"","description":"music to be played which will provide the sync time for the timeline","type_expr":"String","text":"music: String - (Optional, default \"\") music to be played which will provide the sync time for the timeline"},{"name":"codeInterrupt","type":"Code","optional":true,"default":"`params [\"_pointer\", \"_baseTime\", \"_evenTime\"]; [\"Timeline interrupted while playing event nr.: %1 (%2)\", _pointer, _baseTime + _eventTime] call BIS_fnc_logFormat;`","description":"Code to be executed if the timeline is interrupted with\n`missionNamespace setVariable [\"BIS_fnc_eventTimeline_playing\", false]`","type_expr":"Code","text":"codeInterrupt: Code - (Optional, default\n`params [\"_pointer\", \"_baseTime\", \"_evenTime\"]; [\"Timeline interrupted while playing event nr.: %1 (%2)\", _pointer, _baseTime + _eventTime] call BIS_fnc_logFormat;`)\nCode to be executed if the timeline is interrupted with\n`missionNamespace setVariable [\"BIS_fnc_eventTimeline_playing\", false]`"},{"name":"codeEnd","type":"Array or Code","optional":true,"default":"nil","description":"Code or Array of codes to be executed once the timeline is finished. The codes are called one after the other.","type_expr":"Array | Code","text":"codeEnd: Array or Code - (Optional, default nil) Code or Array of codes to be executed once the timeline is finished. The codes are called one after the other."}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"```sqf\nprivate _timeline =\n[\n    [0.0, { hint \"Start of the Timeline\" }],\n    [1.0, { hint \"Event 1\" }],\n    [3.0, { hint \"End of the timeline\" }]\n];\n\n[_timeline, 0, \"\", { hint \"Interrupted\" }, { hint \"Timeline done\" }] spawn BIS_fnc_eventTimeline;\n```","code":["private _timeline =\n[\n\t[0.0, { hint \"Start of the Timeline\" }],\n\t[1.0, { hint \"Event 1\" }],\n\t[3.0, { hint \"End of the timeline\" }]\n];\n\n[_timeline, 0, \"\", { hint \"Interrupted\" }, { hint \"Timeline done\" }] spawn BIS_fnc_eventTimeline;"]}],"see_also":["BIS_fnc_animatedBriefing"]},{"name":"BIS_fnc_execFSM","title":"BIS fnc execFSM","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_execFSM","revid":330759,"updated":"2022-11-01T15:34:52Z","groups":["Program Flow"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Execute the scripted FSM. Shell for execFSM command","syntaxes":[{"syntax":"filename call BIS_fnc_execFSM","params":[{"name":"filename","type":"String","description":"FSM filename","type_expr":"String"}],"returns":{"type":"Number","type_expr":"Number","description":"FSM handle"}},{"syntax":"[params, filename] call BIS_fnc_execFSM","params":[{"name":"params","type":"Array","description":"parameters are passed to script as variable _this","type_expr":"Array"},{"name":"filename","type":"FSM","description":"FSM filename","type_expr":"FSM"}],"returns":{"type":"Number","type_expr":"Number","description":"FSM handle or 0 on error","text":"Number - FSM handle or **0** on error"}}],"examples":[{"code":["private _handle = [[_param1, _param2, _param3 /* etc */], \"test.fsm\"] call BIS_fnc_execFSM;"]},{"code":["private _handle = \"test.fsm\" call BIS_fnc_execFSM;"]}],"see_also":["execFSM","FSM","BIS_fnc_execRemote","BIS_fnc_execVM","BIS_fnc_call"]},{"name":"BIS_fnc_execRemote","title":"BIS fnc execRemote","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_execRemote","revid":379561,"updated":"2026-10-31T13:53:05Z","groups":["Multiplayer"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"This function is now an alias to BIS_fnc_MP: its file only includes the code of BIS_fnc_MP, so it takes the same parameters and sends the given function or scripting command for remote execution through remoteExec or remoteExecCall.\n\n> [!IMPORTANT]\n> Use remoteExec and remoteExecCall instead!","syntaxes":[{"syntax":"[params, functionName, targets, isPersistent, isCall] call BIS_fnc_execRemote","params":[{"name":"params","type":"Anything","optional":true,"default":"`[]`","description":"arguments passed to the function or command","type_expr":"Anything","text":"params: Anything - (Optional, default `[]`) arguments passed to the function or command"},{"name":"functionName","type":"String","optional":true,"default":"\"\"","description":"name of the function or scripting command to execute","type_expr":"String","text":"functionName: String - (Optional, default \"\") name of the function or scripting command to execute"},{"name":"targets","type":"Boolean, Number, Object, Group, Side, String or Array of these","optional":true,"default":"0","description":"where to execute; true means every machine, false the server only, the other types are passed to remoteExec as targets","type_expr":"Boolean | Number | Object | Group | Side | String | Array","text":"targets: Boolean, Number, Object, Group, Side, String or Array of these - (Optional, default 0) where to execute; true means every machine, false the server only, the other types are passed to remoteExec as targets"},{"name":"isPersistent","type":"Boolean","optional":true,"default":"false","description":"true to also execute for every JIP client","type_expr":"Boolean","text":"isPersistent: Boolean - (Optional, default false) true to also execute for every JIP client"},{"name":"isCall","type":"Boolean","optional":true,"default":"false","description":"true to use remoteExecCall, false to use remoteExec","type_expr":"Boolean","text":"isCall: Boolean - (Optional, default false) true to use remoteExecCall, false to use remoteExec"}],"returns":{"type":"Array","type_expr":"Array","description":"format [0, params, functionName, targets, isPersistent, isCall], where targets is the processed list of targets"}}],"examples":[{"code":["[\"Hello\", \"hint\", true] call BIS_fnc_execRemote; // same as \"Hello\" remoteExec [\"hint\", 0];"]}],"see_also":["remoteExec","remoteExecCall","BIS_fnc_MP","BIS_fnc_execFSM","BIS_fnc_execVM","BIS_fnc_spawn"]},{"name":"BIS_fnc_executeStackedEventHandler","title":"BIS fnc executeStackedEventHandler","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_executeStackedEventHandler","revid":347967,"updated":"2023-11-08T08:54:25Z","groups":["Event Handlers"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"This function executes the stacked items.\n\n> [!IMPORTANT]\n> This function should not be called independently.","syntaxes":[{"syntax":"[eventHandlerType] call BIS_fnc_executeStackedEventHandler","params":[{"name":"eventHandlerType","type":"String","description":"the onXXX event handler","type_expr":"String"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"always true"}}],"examples":[{"code":["[\"onEachFrame\"] call BIS_fnc_executeStackedEventHandler;"]}],"see_also":["BIS_fnc_addStackedEventHandler","BIS_fnc_removeStackedEventHandler"]},{"name":"BIS_fnc_execVM","title":"BIS fnc execVM","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_execVM","revid":336359,"updated":"2022-12-29T08:50:08Z","groups":["Program Flow"],"status":"deprecated","replaced_by":["remoteExec","remoteExecCall"],"games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"effect":"local"},"description":"> [!CAUTION]\n> This information is **obsolete** as of Arma 3 v1.50. Reason: use remoteExec/remoteExecCall instead.\n\nexecVM desired script with desired argument(s). This function is only really useful when combined with BIS_fnc_MP to execute a script remotely.","syntaxes":[{"syntax":"filename call BIS_fnc_execVM","params":[{"name":"filename","type":"String","type_expr":"String"}],"returns":{"type":"Script Handle","type_expr":"Script Handle","description":"can be used to determine (via scriptDone) when the script has finished."}},{"syntax":"[arguments, filename] call BIS_fnc_execVM","params":[{"name":"arguments","type":"Anything","description":"arguments are passed to script as magic variable _this.","type_expr":"Anything"},{"name":"filename","type":"String","type_expr":"String"}],"returns":{"type":"Script Handle","type_expr":"Script Handle","description":"can be used to determine (via scriptDone) when the script has finished."}}],"examples":[{"code":["\"Bonus\\initializeExtras.sqf\" call BIS_fnc_execVM;"]},{"code":["[player, \"reposition.sqf\"] call BIS_fnc_execVM;"]},{"code":["// before Arma 3 v1.50\n[[[_param1, _param2], \"addBonus.sqf\"], \"BIS_fnc_execVM\", true] call BIS_fnc_MP;\n\n// since Arma 3 v1.50\n[[_param1, _param2], \"addBonus.sqf\"] remoteExec [\"execVM\"];"]}],"see_also":["BIS_fnc_execFSM","BIS_fnc_execRemote","BIS_fnc_spawn","BIS_fnc_call"]},{"name":"BIS_fnc_EXP_camp_addTickets","title":"BIS fnc EXP camp addTickets","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_addTickets","revid":274010,"updated":"2021-06-13T01:15:06Z","groups":["Campaign"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_addTickets","params":[],"returns":null}]},{"name":"BIS_fnc_EXP_camp_balanceGroup","title":"BIS fnc EXP camp balanceGroup","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_balanceGroup","revid":379562,"updated":"2026-10-31T13:53:31Z","groups":["Campaign"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Reduces the size of a group depending on the number of connected players, assuming the Apex campaign's maximum of 4 players.\nThe wanted unit count is `ceil (unitCount * playerCount / 4)` (players counted with BIS_fnc_listPlayers). The last `minCount max (unitCount - wantedCount)` units of the group are selected for deletion, skipping the group leader and, if *excludeVehicleRoles* is true, units that are the driver, gunner or commander of their vehicle; skipped units are not replaced by others. The selected units are deleted with deleteVehicle (units in a vehicle are first moved to [-100, -100, 0] ASL), stopping as soon as the group has *minCount* units or fewer.\n\nThe function shows an error and does nothing if the group is null, has no living, non-fleeing unit, or has fewer than *minCount* units.\n\nThe Apex campaign missions call it from `initServer.sqf` and their mission flow FSMs, always as `[_group, 2, true]`.\n\n> [!NOTE]\n> Because *minCount* is also the smallest number of units selected for deletion, a group with more than *minCount* units loses units even when 4 players are connected (unless the selected units are all skipped).","syntaxes":[{"syntax":"[group, minCount, excludeVehicleRoles] call BIS_fnc_EXP_camp_balanceGroup","params":[{"name":"group","type":"Group","description":"the group to balance","type_expr":"Group"},{"name":"minCount","type":"Number","optional":true,"default":"1","description":"the number of units the group must keep","type_expr":"Number","text":"minCount: Number - (Optional, default 1) the number of units the group must keep"},{"name":"excludeVehicleRoles","type":"Boolean","optional":true,"default":"true","description":"true to never delete units that are the driver, gunner or commander of a vehicle","type_expr":"Boolean","text":"excludeVehicleRoles: Boolean - (Optional, default true) true to never delete units that are the driver, gunner or commander of a vehicle"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"```sqf\n// on the server, as in the Apex campaign\n{\n    [_x, 2, true] call BIS_fnc_EXP_camp_balanceGroup;\n} forEach [BIS_grp_AA_1, BIS_grp_AA_2, BIS_grp_AA_3];\n```","code":["// on the server, as in the Apex campaign\n{\n\t[_x, 2, true] call BIS_fnc_EXP_camp_balanceGroup;\n} forEach [BIS_grp_AA_1, BIS_grp_AA_2, BIS_grp_AA_3];"]}],"see_also":["BIS_fnc_listPlayers","deleteVehicle"]},{"name":"BIS_fnc_EXP_camp_checkpoint","title":"BIS fnc EXP camp checkpoint","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_checkpoint","revid":379563,"updated":"2026-10-31T13:54:01Z","groups":["Campaign"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Sets a mission checkpoint for the Apex campaign.\nIn single-player the game is saved with saveGame (*position* and *name* are not used). In multiplayer a respawn position is added with BIS_fnc_addRespawnPosition, which receives all three arguments.\n\nThe Apex campaign mission EXP_m05 calls it from triggers whose condition requires isServer and from its mission flow FSM.","syntaxes":[{"syntax":"[target, position, name] call BIS_fnc_EXP_camp_checkpoint","params":[{"name":"target","type":"Namespace, Side, Group or Object","optional":true,"default":"missionNamespace","description":"who gets the respawn position, see BIS_fnc_addRespawnPosition","type_expr":"Namespace | Side | Group | Object","text":"target: Namespace, Side, Group or Object - (Optional, default missionNamespace) who gets the respawn position, see BIS_fnc_addRespawnPosition"},{"name":"position","type":"String, Group, Object or Array","optional":true,"default":"\"\"","description":"the respawn position: marker name, group (leader), object or position","type_expr":"String | Group | Object | Array","text":"position: String, Group, Object or Array - (Optional, default \"\") the respawn position: marker name, group (leader), object or position"},{"name":"name","type":"String","optional":true,"default":"\"\"","description":"the respawn position's name, text or localization key","type_expr":"String","text":"name: String - (Optional, default \"\") the respawn position's name, text or localization key"}],"returns":{"type":"Array","type_expr":"Array","description":"format [target, id]:\n- in multiplayer, the value returned by BIS_fnc_addRespawnPosition (id is a Number, usable with BIS_fnc_removeRespawnPosition) - in single-player, [target, \"\"]","text":"Array - format [target, id]:\n\n- in multiplayer, the value returned by BIS_fnc_addRespawnPosition (id is a Number, usable with BIS_fnc_removeRespawnPosition)\n- in single-player, [target, \"\"]"}}],"examples":[{"code":["[west, getMarkerPos \"BIS_respawn_1\", localize \"STR_A3_Exp_m05_Respawn_2\"] call BIS_fnc_EXP_camp_checkpoint;"]}],"see_also":["BIS_fnc_addRespawnPosition","BIS_fnc_removeRespawnPosition","saveGame"]},{"name":"BIS_fnc_EXP_camp_dynamicAISkill","title":"BIS fnc EXP camp dynamicAISkill","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_dynamicAISkill","revid":364260,"updated":"2024-05-06T09:38:26Z","groups":["Campaign"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","locality":{"server_exec":true},"description":"Changes AI skill based on player count, responding to player connected / player disconnected events. This function does exactly the same as BIS_fnc_EXP_camp_setSkill execept that it automatically executes when a player joins or disconnects.","syntaxes":[{"syntax":"[mode, affectedSides] call BIS_fnc_EXP_camp_dynamicAISkill","params":[{"name":"mode","type":"Boolean","optional":true,"default":"true","description":"true to enable, false to disable","type_expr":"Boolean","text":"mode: Boolean - (Optional, default true) true to enable, false to disable"},{"name":"affectedSides","type":"Array","description":"array of affected sides and their skill sets. For details see BIS_fnc_EXP_camp_setSkill","type_expr":"Array"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"```sqf\n[\n    true,\n    [\n        [WEST, 0.1, 0.2, 0.7, 0.6],\n        [EAST, 0.1, 0.2, 0.7, 0.6]\n    ]\n] call BIS_fnc_EXP_camp_dynamicAISkill;\n```","code":["[\n\ttrue,\n\t[\n\t\t[WEST, 0.1, 0.2, 0.7, 0.6],\n\t\t[EAST, 0.1, 0.2, 0.7, 0.6]\n\t]\n] call BIS_fnc_EXP_camp_dynamicAISkill;"]}],"see_also":["Arma 3: AI Skill","setSkill","skillFinal","BIS_fnc_EXP_camp_setSkill"]},{"name":"BIS_fnc_EXP_camp_getCinematicMode","title":"BIS fnc EXP camp getCinematicMode","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_getCinematicMode","revid":309366,"updated":"2022-05-05T12:04:31Z","groups":["Campaign"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Returns whether or not player is in cinematic mode.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if in cinematic mode, false if not"}}],"examples":[{"code":["call BIS_fnc_EXP_camp_getCinematicMode;"]}],"see_also":["BIS_fnc_EXP_camp_setCinematicMode"]},{"name":"BIS_fnc_EXP_camp_getPlayersGroup","title":"BIS fnc EXP camp getPlayersGroup","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_getPlayersGroup","revid":348720,"updated":"2023-11-08T14:31:29Z","groups":["Campaign"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","locality":{"argument":"local"},"description":"Returns group that players belong to in coop campaign scenario.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Group","type_expr":"Group","description":"group the player belongs to"}}],"examples":[{"code":["private _group = call BIS_fnc_EXP_camp_getPlayersGroup;"]}],"see_also":["group"]},{"name":"BIS_fnc_EXP_camp_guidedProjectile","title":"BIS fnc EXP camp guidedProjectile","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_guidedProjectile","revid":278997,"updated":"2021-06-13T21:47:34Z","groups":["Campaign"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","locality":{"server_exec":true},"description":"Spawns object of given class and makes it travel, hooming towards the target To be used with CfgAmmo type of entity, but can be used with virtually any kind of object","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_guidedProjectile","params":[{"name":"_startPos","type":"Array, Position","types":["Array","Position"],"type_expr":"Array","description":"_class:         STRING or OBJECT    The class name of the object to spawn or an object entity already existing\n_target:        OBJECT            The target object the projectile will be hooming towards to\n_speed:            SCALAR            The speed the object should assume\n_destroyTarget:        BOOL            Whether to force destruction of the target object on detonation\n_localOffset:        ARRAY            The model space position offset that projectile should be hooming towards to\n_minDistanceToTarget:    SCALAR            The minimal distance projectile needs to be from target position to enter ballistic mode\n_function        STRING            The function to execute on the created object with params [<object>]\n_isGlobalFunction    BOOL            Whether the executed function should be executed on all connected machine, false to execute only on the server","text":"ARRAY             The initial position of the projectile (ASL)\n_class:         STRING or OBJECT    The class name of the object to spawn or an object entity already existing\n_target:        OBJECT            The target object the projectile will be hooming towards to\n_speed:            SCALAR            The speed the object should assume\n_destroyTarget:        BOOL            Whether to force destruction of the target object on detonation\n_localOffset:        ARRAY            The model space position offset that projectile should be hooming towards to\n_minDistanceToTarget:    SCALAR            The minimal distance projectile needs to be from target position to enter ballistic mode\n_function        STRING            The function to execute on the created object with params [<object>]\n_isGlobalFunction    BOOL            Whether the executed function should be executed on all connected machine, false to execute only on the server","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","text":"NOTHING","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte\n\nDescription:\nSpawns object of given class and makes it travel, hooming towards the target\nTo be used with CfgAmmo type of entity, but can be used with virtually any kind of object\n\nParameters:\n    _startPos:         ARRAY             The initial position of the projectile (ASL)\n    _class:         STRING or OBJECT    The class name of the object to spawn or an object entity already existing\n    _target:        OBJECT            The target object the projectile will be hooming towards to\n    _speed:            SCALAR            The speed the object should assume\n    _destroyTarget:        BOOL            Whether to force destruction of the target object on detonation\n    _localOffset:        ARRAY            The model space position offset that projectile should be hooming towards to\n    _minDistanceToTarget:    SCALAR            The minimal distance projectile needs to be from target position to enter ballistic mode\n    _function        STRING            The function to execute on the created object with params [<object>]\n    _isGlobalFunction    BOOL            Whether the executed function should be executed on all connected machine, false to execute only on the server\n\nReturns:\n    NOTHING","author":"Nelson Duarte"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_EXP_camp_hasMissionStarted","title":"BIS fnc EXP camp hasMissionStarted","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_hasMissionStarted","revid":273971,"updated":"2021-06-13T01:14:19Z","groups":["Campaign"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Returns whether the mission has actually started (see Manager)","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_hasMissionStarted","params":[],"returns":{"type":"Boolean","type_expr":"Boolean","text":"True if mission was started, false if not","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte\n\nDescription:\nReturns whether the mission has actually started (see Manager)\n\nParameters:\n    Nothing\n\nReturns:\n    True if mission was started, false if not","author":"Nelson Duarte"},"filled_from_docblock":["description","returns"]},{"name":"BIS_fnc_EXP_camp_IFF","title":"BIS fnc EXP camp IFF","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_IFF","revid":352439,"updated":"2024-02-10T14:09:11Z","groups":["Campaign","GUI"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","locality":{"argument":"local","effect":"local"},"description":"Simple handling of the Support Team's scripted IFF.\n\n> [!NOTE]\n> See Example 2 for icon and name options.","syntaxes":[{"syntax":"[units] call BIS_fnc_EXP_camp_IFF","params":[{"name":"units","type":"Array","description":"an array of units on which to apply IFF effect","type_expr":"Array"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if successful, false if not"}}],"examples":[{"code":["[units group player] call BIS_fnc_EXP_camp_IFF;"]},{"text":"```sqf\nindividualUnit setVariable [\"BIS_iconAlways\", true];    // to always show the icon and name of a unit\nindividualUnit setVariable [\"BIS_iconShow\", false];        // to hide the icon\nindividualUnit setVariable [\"BIS_iconName\", false];        // to hide the name\n```","code":["individualUnit setVariable [\"BIS_iconAlways\", true];\t// to always show the icon and name of a unit\nindividualUnit setVariable [\"BIS_iconShow\", false];\t\t// to hide the icon\nindividualUnit setVariable [\"BIS_iconName\", false];\t\t// to hide the name"]}]},{"name":"BIS_fnc_EXP_camp_initCharacter","title":"BIS fnc EXP camp initCharacter","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_initCharacter","revid":349246,"updated":"2023-11-08T14:51:00Z","groups":["Campaign"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","locality":{"effect":"local"},"description":"Assigns correct appearance and loadout of story characters based upon their vehicle classnames.","syntaxes":[{"syntax":"[unit, mode] call BIS_fnc_EXP_camp_initCharacter","params":[{"name":"unit","type":"Object","description":"the character to be initialized","type_expr":"Object"},{"name":"mode","type":"String","optional":true,"default":"\"DAY\"","description":"can be either \"DAY\" (unsilenced, no NVGs, default) or \"NIGHT\" (silenced, NVGs)","type_expr":"String","text":"mode: String - (Optional, default \"DAY\") can be either \"DAY\" (unsilenced, no NVGs, default) or \"NIGHT\" (silenced, NVGs)"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"returns true if successful, false if not"}}],"examples":[{"code":["[BIS_unit,\"NIGHT\"] call BIS_fnc_EXP_camp_initCharacter;"]}],"multiplayer":"Must be executed on all machines.","see_also":["BIS_fnc_EXP_camp_initClasses"]},{"name":"BIS_fnc_EXP_camp_initClasses","title":"BIS fnc EXP camp initClasses","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_initClasses","revid":349080,"updated":"2023-11-08T14:47:23Z","groups":["Campaign"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","locality":{"server_exec":true},"description":"Initializes the classes players can choose from before spawning.","syntaxes":[{"syntax":"[mode] call BIS_fnc_EXP_camp_initClasses","params":[{"name":"mode","type":"String","optional":true,"default":"\"DAY\"","description":"can be either \"DAY\" (unsilenced, no NVGs, default) or \"NIGHT\" (silenced, NVGs)","type_expr":"String","text":"mode: String - (Optional, default \"DAY\") can be either \"DAY\" (unsilenced, no NVGs, default) or \"NIGHT\" (silenced, NVGs)"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"returns true if successful, false if not"}}],"examples":[{"code":["[\"NIGHT\"] call BIS_fnc_EXP_camp_initClasses;"]}],"see_also":["BIS_fnc_EXP_camp_initCharacter"]},{"name":"BIS_fnc_EXP_camp_initDifficulty","title":"BIS fnc EXP camp initDifficulty","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_initDifficulty","revid":309346,"updated":"2022-05-05T12:04:30Z","groups":["Campaign"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","locality":{"effect":"local"},"description":"Initializes difficulty settings in Apex Protocol campaign.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true"}}],"examples":[{"code":["call BIS_fnc_EXP_camp_initDifficulty;"]}],"multiplayer":"Needs to be executed globally.","see_also":["BIS_fnc_EXP_camp_initClasses","BIS_fnc_EXP_camp_initCharacter"]},{"name":"BIS_fnc_EXP_camp_lobby","title":"BIS fnc EXP camp lobby","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_lobby","revid":273958,"updated":"2021-06-13T01:14:09Z","groups":["CampaignLobby"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Core Function","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_lobby","params":[],"returns":null}],"docblock":{"text":"PROJECT:    R&D\nAUTHOR:        Endstar\nDATE:        18-04-2016\n\nfn_EXP_camp_lobby.sqf\n\n    Campaign Lobby: Core Function\n\nParams\n\n    0:\n\nReturn\n\n    0:","author":"Endstar","meta":{"project":"R&D","date":"18-04-2016","file":"fn_EXP_camp_lobby.sqf"}},"filled_from_docblock":["description"]},{"name":"BIS_fnc_EXP_camp_lobby_clearVars","title":"BIS fnc EXP camp lobby clearVars","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_lobby_clearVars","revid":273925,"updated":"2021-06-13T01:13:34Z","groups":["CampaignLobby"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Clear variables","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_lobby_clearVars","params":[],"returns":null}],"docblock":{"text":"PROJECT:    R&D\nAUTHOR:        Endstar\nDATE:        18-04-2016\n\nfn_EXP_camp_lobby_clearVars.sqf\n\n    Campaign Lobby: Clear variables\n\nParams\n\n    0:\n\nReturn\n\n    0:","author":"Endstar","meta":{"project":"R&D","date":"18-04-2016","file":"fn_EXP_camp_lobby_clearVars.sqf"}},"filled_from_docblock":["description"]},{"name":"BIS_fnc_EXP_camp_lobby_ctrlSetColor","title":"BIS fnc EXP camp lobby ctrlSetColor","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_lobby_ctrlSetColor","revid":274028,"updated":"2021-06-13T01:15:22Z","groups":["CampaignLobby"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Updates controls with defined colors","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_lobby_ctrlSetColor","params":[],"returns":null}],"docblock":{"text":"PROJECT: R&D\nAUTHOR:  Endstar\nDATE:    18-04-2016\n\nfn_EXP_camp_lobby_ctrlSetColor.sqf\n\n    Campaign Lobby: Updates controls with defined colors\n\nParams\n\n    0:\n\nReturn\n\n    0:","author":"Endstar","meta":{"project":"R&D","date":"18-04-2016","file":"fn_EXP_camp_lobby_ctrlSetColor.sqf"}},"filled_from_docblock":["description"]},{"name":"BIS_fnc_EXP_camp_lobby_findHost","title":"BIS fnc EXP camp lobby findHost","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_lobby_findHost","revid":274125,"updated":"2021-06-13T01:17:00Z","groups":["CampaignLobby"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Find host","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_lobby_findHost","params":[],"returns":null}],"docblock":{"text":"PROJECT:    R&D\nAUTHOR:        Endstar\nDATE:        18-04-2016\n\nfn_EXP_camp_lobby_findHost.sqf\n\n    Campaign Lobby: Find host\n\nParams\n\n    0:\n\nReturn\n\n    0:","author":"Endstar","meta":{"project":"R&D","date":"18-04-2016","file":"fn_EXP_camp_lobby_findHost.sqf"}},"filled_from_docblock":["description"]},{"name":"BIS_fnc_EXP_camp_lobby_getHostSettings","title":"BIS fnc EXP camp lobby getHostSettings","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_lobby_getHostSettings","revid":273899,"updated":"2021-06-13T01:13:05Z","groups":["CampaignLobby"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Grabs the host settings for respawn and revive","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_lobby_getHostSettings","params":[],"returns":null}],"docblock":{"text":"PROJECT: R&D\nAUTHOR:  Endstar\nDATE:    08-08-2016\n\nfn_EXP_camp_lobby_getHostSettings.sqf\n\n    Campaign Lobby: Grabs the host settings for respawn and revive\n\nParams\n\n    0:\n\nReturn\n\n    0:","author":"Endstar","meta":{"project":"R&D","date":"08-08-2016","file":"fn_EXP_camp_lobby_getHostSettings.sqf"}},"filled_from_docblock":["description"]},{"name":"BIS_fnc_EXP_camp_lobby_getPlayerSquadName","title":"BIS fnc EXP camp lobby getPlayerSquadName","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_lobby_getPlayerSquadName","revid":274049,"updated":"2021-06-13T01:15:49Z","groups":["CampaignLobby"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Return the player squad name","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_lobby_getPlayerSquadName","params":[],"returns":null}],"docblock":{"text":"PROJECT: R&D\nAUTHOR:  Endstar\nDATE:    18-04-2016\n\nfn_EXP_camp_lobby_getPlayerSquadName.sqf\n\n    Campaign Lobby: Return the player squad name\n\nParams\n\n    0:\n\nReturn\n\n    0:","author":"Endstar","meta":{"project":"R&D","date":"18-04-2016","file":"fn_EXP_camp_lobby_getPlayerSquadName.sqf"}},"filled_from_docblock":["description"]},{"name":"BIS_fnc_EXP_camp_lobby_go","title":"BIS fnc EXP camp lobby go","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_lobby_go","revid":274017,"updated":"2021-06-13T01:15:14Z","groups":["CampaignLobby"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Run Mission","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_lobby_go","params":[],"returns":null}],"docblock":{"text":"PROJECT: R&D\nAUTHOR:  Endstar\nDATE:    18-04-2016\n\nfn_EXP_camp_lobby_go.sqf\n\n    Campaign Lobby: Run Mission\n\nParams\n\n    0:\n\nReturn\n\n    0:","author":"Endstar","meta":{"project":"R&D","date":"18-04-2016","file":"fn_EXP_camp_lobby_go.sqf"}},"filled_from_docblock":["description"]},{"name":"BIS_fnc_EXP_camp_lobby_intro","title":"BIS fnc EXP camp lobby intro","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_lobby_intro","revid":274034,"updated":"2021-06-13T01:15:29Z","groups":["CampaignLobby"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"On Load Function (Does nothing)","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_lobby_intro","params":[],"returns":null}],"docblock":{"text":"PROJECT: R&D\nAUTHOR:  Endstar\nDATE:    18-04-2016\n\nfn_EXP_camp_lobby_intro.sqf\n\n    Campaign Lobby: On Load Function (Does nothing)\n\nParams\n\n    0:\n\nReturn\n\n    0:","author":"Endstar","meta":{"project":"R&D","date":"18-04-2016","file":"fn_EXP_camp_lobby_intro.sqf"}},"filled_from_docblock":["description"]},{"name":"BIS_fnc_EXP_camp_lobby_launch","title":"BIS fnc EXP camp lobby launch","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_lobby_launch","revid":273988,"updated":"2021-06-13T01:14:38Z","groups":["CampaignLobby"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Launch Function","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_lobby_launch","params":[],"returns":null}],"docblock":{"text":"PROJECT: R&D\nAUTHOR:  Endstar\nDATE:    18-04-2016\n\nfn_EXP_camp_lobby_launch.sqf\n\n    Campaign Lobby: Launch Function\n\nParams\n\n    0:\n\nReturn\n\n    0:","author":"Endstar","meta":{"project":"R&D","date":"18-04-2016","file":"fn_EXP_camp_lobby_launch.sqf"}},"filled_from_docblock":["description"]},{"name":"BIS_fnc_EXP_camp_lobby_loop","title":"BIS fnc EXP camp lobby loop","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_lobby_loop","revid":273953,"updated":"2021-06-13T01:14:04Z","groups":["CampaignLobby"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Update UI Loop","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_lobby_loop","params":[],"returns":null}],"docblock":{"text":"PROJECT: R&D\nAUTHOR:  Endstar\nDATE:    18-04-2016\n\nfn_EXP_camp_lobby_loop.sqf\n\n    Campaign Lobby: Update UI Loop\n\nParams\n\n    0:\n\nReturn\n\n    0:","author":"Endstar","meta":{"project":"R&D","date":"18-04-2016","file":"fn_EXP_camp_lobby_loop.sqf"}},"filled_from_docblock":["description"]},{"name":"BIS_fnc_EXP_camp_lobby_missionCountdown","title":"BIS fnc EXP camp lobby missionCountdown","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_lobby_missionCountdown","revid":273991,"updated":"2021-06-13T01:14:42Z","groups":["CampaignLobby"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Countdown to run mission","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_lobby_missionCountdown","params":[],"returns":null}],"docblock":{"text":"PROJECT: R&D\nAUTHOR:  Endstar\nDATE:    18-04-2016\n\nfn_EXP_camp_lobby_missionCountdown.sqf\n\n    Campaign Lobby: Countdown to run mission\n\nParams\n\n    0:\n\nReturn\n\n    0:","author":"Endstar","meta":{"project":"R&D","date":"18-04-2016","file":"fn_EXP_camp_lobby_missionCountdown.sqf"}},"filled_from_docblock":["description"]},{"name":"BIS_fnc_EXP_camp_lobby_onLoad","title":"BIS fnc EXP camp lobby onLoad","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_lobby_onLoad","revid":273887,"updated":"2021-06-13T01:12:54Z","groups":["CampaignLobby"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"On Load Function (Does nothing)","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_lobby_onLoad","params":[],"returns":null}],"docblock":{"text":"PROJECT: R&D\nAUTHOR:  Endstar\nDATE:    18-04-2016\n\nfn_EXP_camp_lobby_onLoad.sqf\n\n    Campaign Lobby: On Load Function (Does nothing)\n\nParams\n\n    0:\n\nReturn\n\n    0:","author":"Endstar","meta":{"project":"R&D","date":"18-04-2016","file":"fn_EXP_camp_lobby_onLoad.sqf"}},"filled_from_docblock":["description"]},{"name":"BIS_fnc_EXP_camp_lobby_onUnLoad","title":"BIS fnc EXP camp lobby onUnLoad","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_lobby_onUnLoad","revid":274078,"updated":"2021-06-13T01:16:20Z","groups":["CampaignLobby"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"On display unload function - clear variables and close as necessary","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_lobby_onUnLoad","params":[],"returns":null}],"docblock":{"text":"PROJECT: R&D\nAUTHOR:  Endstar\nDATE:    18-04-2016\n\nfn_EXP_camp_lobby_onUnLoad.sqf\n\n    Campaign Lobby: On display unload function - clear variables and close as necessary\n\nParams\n\n    0:\n\nReturn\n\n    0:","author":"Endstar","meta":{"project":"R&D","date":"18-04-2016","file":"fn_EXP_camp_lobby_onUnLoad.sqf"}},"filled_from_docblock":["description"]},{"name":"BIS_fnc_EXP_camp_lobby_playMissionVideo","title":"BIS fnc EXP camp lobby playMissionVideo","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_lobby_playMissionVideo","revid":274059,"updated":"2021-06-13T01:15:58Z","groups":["CampaignLobby"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Creates the control and plays mission video","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_lobby_playMissionVideo","params":[],"returns":null}],"docblock":{"text":"PROJECT: R&D\nAUTHOR:  Endstar\nDATE:    18-04-2016\n\nfn_EXP_camp_lobby_playMissionVideo.sqf\n\n    Campaign Lobby: Creates the control and plays mission video\n\nParams\n\n    0:\n\nReturn\n\n    0:","author":"Endstar","meta":{"project":"R&D","date":"18-04-2016","file":"fn_EXP_camp_lobby_playMissionVideo.sqf"}},"filled_from_docblock":["description"]},{"name":"BIS_fnc_EXP_camp_lobby_serverPing","title":"BIS fnc EXP camp lobby serverPing","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_lobby_serverPing","revid":274100,"updated":"2021-06-13T01:16:36Z","groups":["CampaignLobby"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Updates player status","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_lobby_serverPing","params":[],"returns":null}],"docblock":{"text":"PROJECT: R&D\nAUTHOR:  Endstar\nDATE:    18-04-2016\n\nfn_EXP_camp_lobby_serverPing.sqf\n\n    Campaign Lobby: Updates player status\n\nParams\n\n    0:\n\nReturn\n\n    0:","author":"Endstar","meta":{"project":"R&D","date":"18-04-2016","file":"fn_EXP_camp_lobby_serverPing.sqf"}},"filled_from_docblock":["description"]},{"name":"BIS_fnc_EXP_camp_lobby_serverUpdate","title":"BIS fnc EXP camp lobby serverUpdate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_lobby_serverUpdate","revid":273936,"updated":"2021-06-13T01:13:44Z","groups":["CampaignLobby"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Server update function (runs on \"host\" machine for dedicated servers)","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_lobby_serverUpdate","params":[],"returns":null}],"docblock":{"text":"PROJECT: R&D\nAUTHOR:  Endstar\nDATE:    18-04-2016\n\nfn_EXP_camp_lobby_serverUpdate.sqf\n\n    Campaign Lobby: Server update function (runs on \"host\" machine for dedicated servers)\n\nParams\n\n    0:\n\nReturn\n\n    0:","author":"Endstar","meta":{"project":"R&D","date":"18-04-2016","file":"fn_EXP_camp_lobby_serverUpdate.sqf"}},"filled_from_docblock":["description"]},{"name":"BIS_fnc_EXP_camp_lobby_structuredText","title":"BIS fnc EXP camp lobby structuredText","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_lobby_structuredText","revid":274079,"updated":"2021-06-13T01:16:20Z","groups":["CampaignLobby"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Formats structured text","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_lobby_structuredText","params":[],"returns":null}],"docblock":{"text":"PROJECT: R&D\nAUTHOR:  Endstar\nDATE:    18-04-2016\n\nfn_EXP_camp_lobby_structuredText.sqf\n\n    Campaign Lobby: Formats structured text\n\nParams\n\n    0:\n\nReturn\n\n    0:","author":"Endstar","meta":{"project":"R&D","date":"18-04-2016","file":"fn_EXP_camp_lobby_structuredText.sqf"}},"filled_from_docblock":["description"]},{"name":"BIS_fnc_EXP_camp_lobby_UIMilitaryManager","title":"BIS fnc EXP camp lobby UIMilitaryManager","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_lobby_UIMilitaryManager","revid":274076,"updated":"2021-06-13T01:16:16Z","groups":["CampaignLobby"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Updates military efficiency based on mission settings","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_lobby_UIMilitaryManager","params":[],"returns":null}],"docblock":{"text":"PROJECT: R&D\nAUTHOR:  Endstar\nDATE:    15-08-2016\n\nfn_EXP_camp_lobby_UIMilitaryManager.sqf\n\n    Campaign Lobby: Updates military efficiency based on mission settings\n\nParams\n\n    0:\n\nReturn\n\n    0:","author":"Endstar","meta":{"project":"R&D","date":"15-08-2016","file":"fn_EXP_camp_lobby_UIMilitaryManager.sqf"}},"filled_from_docblock":["description"]},{"name":"BIS_fnc_EXP_camp_lobby_UIMissionCountdown","title":"BIS fnc EXP camp lobby UIMissionCountdown","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_lobby_UIMissionCountdown","revid":273905,"updated":"2021-06-13T01:13:09Z","groups":["CampaignLobby"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Countdown to run mission","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_lobby_UIMissionCountdown","params":[],"returns":null}],"docblock":{"text":"PROJECT: R&D\nAUTHOR:  Endstar\nDATE:    18-04-2016\n\nfn_EXP_camp_lobby_missionCountdown.sqf\n\n    Campaign Lobby: Countdown to run mission\n\nParams\n\n    0:\n\nReturn\n\n    0:","author":"Endstar","meta":{"project":"R&D","date":"18-04-2016","file":"fn_EXP_camp_lobby_missionCountdown.sqf"}},"filled_from_docblock":["description"]},{"name":"BIS_fnc_EXP_camp_lobby_UIMissionManager","title":"BIS fnc EXP camp lobby UIMissionManager","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_lobby_UIMissionManager","revid":274031,"updated":"2021-06-13T01:15:25Z","groups":["CampaignLobby"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Handles UI behaviour of tree mission options","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_lobby_UIMissionManager","params":[],"returns":null}],"docblock":{"text":"PROJECT: R&D\nAUTHOR:  Endstar\nDATE:    18-04-2016\n\nfn_EXP_camp_lobby_UIMissionManager.sqf\n\n    Campaign Lobby: Handles UI behaviour of tree mission options\n\nParams\n\n    0:\n\nReturn\n\n    0:","author":"Endstar","meta":{"project":"R&D","date":"18-04-2016","file":"fn_EXP_camp_lobby_UIMissionManager.sqf"}},"filled_from_docblock":["description"]},{"name":"BIS_fnc_EXP_camp_lobby_UIOverlayManager","title":"BIS fnc EXP camp lobby UIOverlayManager","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_lobby_UIOverlayManager","revid":274103,"updated":"2021-06-13T01:16:39Z","groups":["CampaignLobby"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Updates the mission overview and intel from tree interactions","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_lobby_UIOverlayManager","params":[],"returns":null}],"docblock":{"text":"PROJECT: R&D\nAUTHOR:  Endstar\nDATE:    18-04-2016\n\nfn_EXP_camp_lobby_updateIntel.sqf\n\n    Campaign Lobby: Updates the mission overview and intel from tree interactions\n\nParams\n\n    0:\n\nReturn\n\n    0:","author":"Endstar","meta":{"project":"R&D","date":"18-04-2016","file":"fn_EXP_camp_lobby_updateIntel.sqf"}},"filled_from_docblock":["description"]},{"name":"BIS_fnc_EXP_camp_lobby_UIProgressManager","title":"BIS fnc EXP camp lobby UIProgressManager","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_lobby_UIProgressManager","revid":273898,"updated":"2021-06-13T01:13:04Z","groups":["CampaignLobby"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Handles Progress button UI behaviour","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_lobby_UIProgressManager","params":[],"returns":null}],"docblock":{"text":"PROJECT: R&D\nAUTHOR:  Endstar\nDATE:    18-04-2016\n\nfn_EXP_camp_lobby_UIProgressManager.sqf\n\n    Campaign Lobby: Handles Progress button UI behaviour\n\nParams\n\n    0:\n\nReturn\n\n    0:","author":"Endstar","meta":{"project":"R&D","date":"18-04-2016","file":"fn_EXP_camp_lobby_UIProgressManager.sqf"}},"filled_from_docblock":["description"]},{"name":"BIS_fnc_EXP_camp_lobby_UISettingsManager","title":"BIS fnc EXP camp lobby UISettingsManager","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_lobby_UISettingsManager","revid":274130,"updated":"2021-06-13T01:17:06Z","groups":["CampaignLobby"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Handles the mission settings for Respawn and Revive","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_lobby_UISettingsManager","params":[],"returns":null}],"docblock":{"text":"PROJECT: R&D\nAUTHOR:  Endstar\nDATE:    08-08-2016\n\nfn_EXP_camp_lobby_UISettingsManager.sqf\n\n    Campaign Lobby: Handles the mission settings for Respawn and Revive\n\nParams\n\n    0:\n\nReturn\n\n    0:","author":"Endstar","meta":{"project":"R&D","date":"08-08-2016","file":"fn_EXP_camp_lobby_UISettingsManager.sqf"}},"filled_from_docblock":["description"]},{"name":"BIS_fnc_EXP_camp_lobby_updateHostSettings","title":"BIS fnc EXP camp lobby updateHostSettings","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_lobby_updateHostSettings","revid":274089,"updated":"2021-06-13T01:16:27Z","groups":["CampaignLobby"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Updates all clients with the latest host settings","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_lobby_updateHostSettings","params":[],"returns":null}],"docblock":{"text":"PROJECT: R&D\nAUTHOR:  Endstar\nDATE:    08-08-2016\n\nfn_EXP_camp_lobby_updateHostSettings.sqf\n\n    Campaign Lobby: Updates all clients with the latest host settings\n\nParams\n\n    0:\n\nReturn\n\n    0:","author":"Endstar","meta":{"project":"R&D","date":"08-08-2016","file":"fn_EXP_camp_lobby_updateHostSettings.sqf"}},"filled_from_docblock":["description"]},{"name":"BIS_fnc_EXP_camp_lobby_updateIntel","title":"BIS fnc EXP camp lobby updateIntel","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_lobby_updateIntel","revid":273984,"updated":"2021-06-13T01:14:37Z","groups":["CampaignLobby"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Updates the mission overview and intel from tree interactions","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_lobby_updateIntel","params":[],"returns":null}],"docblock":{"text":"PROJECT: R&D\nAUTHOR:  Endstar\nDATE:    18-04-2016\n\nfn_EXP_camp_lobby_updateIntel.sqf\n\n    Campaign Lobby: Updates the mission overview and intel from tree interactions\n\nParams\n\n    0:\n\nReturn\n\n    0:","author":"Endstar","meta":{"project":"R&D","date":"18-04-2016","file":"fn_EXP_camp_lobby_updateIntel.sqf"}},"filled_from_docblock":["description"]},{"name":"BIS_fnc_EXP_camp_lobby_updateMilitaryEfficiency","title":"BIS fnc EXP camp lobby updateMilitaryEfficiency","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_lobby_updateMilitaryEfficiency","revid":273914,"updated":"2021-06-13T01:13:17Z","groups":["CampaignLobby"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Updates military efficiency radial bar","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_lobby_updateMilitaryEfficiency","params":[],"returns":null}],"docblock":{"text":"PROJECT: R&D\nAUTHOR:  Endstar\nDATE:    15-08-2016\n\nfn_EXP_camp_lobby_updateMilitaryEfficiency.sqf\n\n    Campaign Lobby: Updates military efficiency radial bar\n\nParams\n\n    0:\n\nReturn\n\n    0:","author":"Endstar","meta":{"project":"R&D","date":"15-08-2016","file":"fn_EXP_camp_lobby_updateMilitaryEfficiency.sqf"}},"filled_from_docblock":["description"]},{"name":"BIS_fnc_EXP_camp_lobby_updatePlayers","title":"BIS fnc EXP camp lobby updatePlayers","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_lobby_updatePlayers","revid":273937,"updated":"2021-06-13T01:13:45Z","groups":["CampaignLobby"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Updates UI based on player status changes","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_lobby_updatePlayers","params":[],"returns":null}],"docblock":{"text":"PROJECT: R&D\nAUTHOR:  Endstar\nDATE:    18-04-2016\n\nfn_EXP_camp_lobby_updatePlayers.sqf\n\n    Campaign Lobby: Updates UI based on player status changes\n\nParams\n\n    0:\n\nReturn\n\n    0:","author":"Endstar","meta":{"project":"R&D","date":"18-04-2016","file":"fn_EXP_camp_lobby_updatePlayers.sqf"}},"filled_from_docblock":["description"]},{"name":"BIS_fnc_EXP_camp_lobby_updatePlayerStatus","title":"BIS fnc EXP camp lobby updatePlayerStatus","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_lobby_updatePlayerStatus","revid":273948,"updated":"2021-06-13T01:13:58Z","groups":["CampaignLobby"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Updates player status","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_lobby_updatePlayerStatus","params":[],"returns":null}],"docblock":{"text":"PROJECT: R&D\nAUTHOR:  Endstar\nDATE:    18-04-2016\n\nfn_EXP_camp_lobby_updatePlayerStatus.sqf\n\n    Campaign Lobby: Updates player status\n\nParams\n\n    0:\n\nReturn\n\n    0:","author":"Endstar","meta":{"project":"R&D","date":"18-04-2016","file":"fn_EXP_camp_lobby_updatePlayerStatus.sqf"}},"filled_from_docblock":["description"]},{"name":"BIS_fnc_EXP_camp_manager","title":"BIS fnc EXP camp manager","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_manager","revid":379564,"updated":"2026-10-31T13:54:37Z","groups":["CampaignManager"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","exec":"spawn","description":"Synchronises the start of an Apex campaign mission between the server and the clients by moving the mission through the states `\"Waiting\"`, `\"Intro\"`, `\"Loadout\"` and `\"Started\"`. Each state change fires a scripted event (see BIS_fnc_EXP_camp_manager_triggerEvent).\nThe function is spawned on every machine by the campaign's shared init script (`\\A3\\Missions_F_Exp\\Campaign\\Scripts\\init.sqf`, included by each mission's `init.sqf`), after the handlers for these events have been added. It is meant for internal use by the campaign.\n\nOn every machine, it stores the intro videos, their subtitle scripts and the *noCinematics* flag in missionNamespace.\n\nOn a machine with a player (hasInterface), it waits for player, fires the `\"Waiting\"` event locally, adds a public variable event handler that fires the event of every new state received from the server, and adds a \"Respawn\" event handler that deletes the player's old body (once).\n\nOn the server, after the mission time has started:\n\n1. setTimeMultiplier is set to 0.1 so the synchronisation does not move the time of day.\n1. It waits until every player has registered as preloaded (see BIS_fnc_EXP_camp_manager_onPlayerRegistered) or until mission time reaches *maxWaitDelay*, then waits *minWaitDelay* seconds.\n1. In multiplayer, if intro videos are given, it sets the state `\"Intro\"`.\n1. In multiplayer, if *wantsLoadoutSelection* is true, it sets the state `\"Loadout\"`, waits until every player has registered a finished loadout selection or *maxLoadoutDelay* seconds have passed, forces respawn on all machines (`0 remoteExecCall [\"setPlayerRespawnTime\", 0]`) and waits *minLoadoutDelay* seconds.\n1. It sets the state `\"Started\"` and restores the previous time multiplier.\n\nIn single-player the mission goes directly from `\"Waiting\"` to `\"Started\"`.","syntaxes":[{"syntax":"[introVideos, introVideosSubtitles, minWaitDelay, minLoadoutDelay, maxWaitDelay, maxLoadoutDelay, wantsLoadoutSelection, noCinematics] spawn BIS_fnc_EXP_camp_manager","params":[{"name":"introVideos","type":"Array of Strings","optional":true,"default":"[]","description":"paths of the intro videos to play in order; an empty array skips the intro","type_expr":"Array<String>","text":"introVideos: Array of Strings - (Optional, default []) paths of the intro videos to play in order; an empty array skips the intro"},{"name":"introVideosSubtitles","type":"Array of Strings","optional":true,"default":"[]","description":"for each intro video, the path of a subtitle script run with execVM, or \"\" for none","type_expr":"Array<String>","text":"introVideosSubtitles: Array of Strings - (Optional, default []) for each intro video, the path of a subtitle script run with execVM, or \"\" for none"},{"name":"minWaitDelay","type":"Number","optional":true,"default":"2","description":"seconds to wait after all players have preloaded","type_expr":"Number","text":"minWaitDelay: Number - (Optional, default 2) seconds to wait after all players have preloaded"},{"name":"minLoadoutDelay","type":"Number","optional":true,"default":"2","description":"seconds to wait after the loadout selection has ended","type_expr":"Number","text":"minLoadoutDelay: Number - (Optional, default 2) seconds to wait after the loadout selection has ended"},{"name":"maxWaitDelay","type":"Number","optional":true,"default":"30","description":"mission time in seconds after which the server stops waiting for players to preload","type_expr":"Number","text":"maxWaitDelay: Number - (Optional, default 30) mission time in seconds after which the server stops waiting for players to preload"},{"name":"maxLoadoutDelay","type":"Number","optional":true,"default":"300","description":"maximum time in seconds to wait for all players to finish the loadout selection","type_expr":"Number","text":"maxLoadoutDelay: Number - (Optional, default 300) maximum time in seconds to wait for all players to finish the loadout selection"},{"name":"wantsLoadoutSelection","type":"Boolean","optional":true,"default":"true","description":"false to skip the loadout selection","type_expr":"Boolean","text":"wantsLoadoutSelection: Boolean - (Optional, default true) false to skip the loadout selection"},{"name":"noCinematics","type":"Boolean","optional":true,"default":"false","description":"true to disable BIS_fnc_EXP_camp_setCinematicMode; cinematics must then be handled manually","type_expr":"Boolean","text":"noCinematics: Boolean - (Optional, default false) true to disable BIS_fnc_EXP_camp_setCinematicMode; cinematics must then be handled manually"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"As in the Apex campaign mission EXP_m02:\n\n```sqf\n[\n    [\"A3\\Missions_F_Exp\\video\\EXP_m02_vTitlecard.ogv\", \"A3\\Missions_F_Exp\\video\\EXP_m02_vIN.ogv\"],\n    [\"\", \"a3\\Missions_F_Exp\\Campaign\\Briefings\\EXP_m02_briefing.sqf\"],\n    nil, nil, nil, nil,\n    true,\n    false\n] spawn BIS_fnc_EXP_camp_manager;\n```","code":["[\n\t[\"A3\\Missions_F_Exp\\video\\EXP_m02_vTitlecard.ogv\", \"A3\\Missions_F_Exp\\video\\EXP_m02_vIN.ogv\"],\n\t[\"\", \"a3\\Missions_F_Exp\\Campaign\\Briefings\\EXP_m02_briefing.sqf\"],\n\tnil, nil, nil, nil,\n\ttrue,\n\tfalse\n] spawn BIS_fnc_EXP_camp_manager;"]}],"see_also":["BIS_fnc_EXP_camp_manager_getState","BIS_fnc_EXP_camp_manager_setState","BIS_fnc_EXP_camp_manager_triggerEvent","BIS_fnc_EXP_camp_manager_onPlayerRegistered","BIS_fnc_addScriptedEventHandler"]},{"name":"BIS_fnc_EXP_camp_manager_getState","title":"BIS fnc EXP camp manager getState","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_manager_getState","revid":274016,"updated":"2021-06-13T01:15:12Z","groups":["CampaignManager"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Get's the mission state, can be one of \"Waiting\", \"Intro\", \"Loadout\" or \"Started\"","syntaxes":[{"syntax":"[] call BIS_fnc_EXP_camp_manager_getState","params":[],"returns":{"text":"The mission state","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte\n\nDescription:\nGet's the mission state, can be one of \"Waiting\", \"Intro\", \"Loadout\" or \"Started\"\n\nParameters:\n    Nothing\n\nReturns:\n    The mission state","author":"Nelson Duarte"},"filled_from_docblock":["description","returns"]},{"name":"BIS_fnc_EXP_camp_manager_onPlayerRegistered","title":"BIS fnc EXP camp manager onPlayerRegistered","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_manager_onPlayerRegistered","revid":379565,"updated":"2026-10-31T13:55:08Z","groups":["CampaignManager"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","locality":{"server_exec":true},"description":"Registers a player as having finished a phase of the Apex campaign mission start (see BIS_fnc_EXP_camp_manager): the player is added (once) to the array stored in the server's missionNamespace variable *listName*. The array is not broadcast. Nothing is added if *player* is objNull.\nCalled on a client, the function shows an error and does nothing.\n\nThe function is meant for internal use. Clients call it on the server with remoteExecCall from the campaign's state scripts, with these lists:\n\n- `\"BIS_coop_campaign_ss_preloadPlayers\"` - the player has finished preloading; the manager waits for this list in the `\"Waiting\"` state\n- `\"BIS_coop_campaign_ss_introPlayers\"` - the player has finished watching the intro videos\n- `\"BIS_coop_campaign_ss_loadoutPlayers\"` - the player has respawned during the loadout selection; the manager waits for this list in the `\"Loadout\"` state","syntaxes":[{"syntax":"[player, listName] call BIS_fnc_EXP_camp_manager_onPlayerRegistered","params":[{"name":"player","type":"Object","optional":true,"default":"objNull","description":"the player to register","type_expr":"Object","text":"player: Object - (Optional, default objNull) the player to register"},{"name":"listName","type":"String","optional":true,"default":"\"\"","description":"name of the missionNamespace variable holding the list of registered players","type_expr":"String","text":"listName: String - (Optional, default \"\") name of the missionNamespace variable holding the list of registered players"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[player, \"BIS_coop_campaign_ss_loadoutPlayers\"] remoteExecCall [\"BIS_fnc_EXP_camp_manager_onPlayerRegistered\", 2];"]}],"see_also":["BIS_fnc_EXP_camp_manager","BIS_fnc_EXP_camp_manager_setState","BIS_fnc_EXP_camp_manager_triggerEvent"]},{"name":"BIS_fnc_EXP_camp_manager_setState","title":"BIS fnc EXP camp manager setState","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_manager_setState","revid":379566,"updated":"2026-10-31T13:55:37Z","groups":["CampaignManager"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","locality":{"server_exec":true},"description":"Sets the mission state of an Apex campaign mission. The state is stored in the public missionNamespace variable `\"BIS_coop_campaign_ss_state\"` (broadcast to all machines) and the state's event is fired on the server with BIS_fnc_EXP_camp_manager_triggerEvent. Clients running BIS_fnc_EXP_camp_manager fire the event when they receive the new value.\nCalled on a client, the function shows an error and does nothing.\n\nValid states are `\"Waiting\"`, `\"Intro\"`, `\"Loadout\"` and `\"Started\"`. The function is meant for internal use: it is called by BIS_fnc_EXP_camp_manager on the server.","syntaxes":[{"syntax":"[state] call BIS_fnc_EXP_camp_manager_setState","params":[{"name":"state","type":"String","optional":true,"default":"\"Waiting\"","description":"the new mission state: \"Waiting\", \"Intro\", \"Loadout\" or \"Started\"","type_expr":"String","text":"state: String - (Optional, default \"Waiting\") the new mission state: \"Waiting\", \"Intro\", \"Loadout\" or \"Started\""}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["// on the server\n[\"Started\"] call BIS_fnc_EXP_camp_manager_setState;"]}],"see_also":["BIS_fnc_EXP_camp_manager","BIS_fnc_EXP_camp_manager_getState","BIS_fnc_EXP_camp_manager_triggerEvent"]},{"name":"BIS_fnc_EXP_camp_manager_triggerEvent","title":"BIS fnc EXP camp manager triggerEvent","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_manager_triggerEvent","revid":379567,"updated":"2026-10-31T13:55:52Z","groups":["CampaignManager"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Fires the scripted event that belongs to an Apex campaign mission state, on the machine where it is called, with BIS_fnc_callScriptedEventHandler on missionNamespace:\n\n- \"Waiting\" - \"BIS_coop_campaign_ss_missionWaiting\"\n- \"Intro\" - \"BIS_coop_campaign_ss_missionIntro\"\n- \"Loadout\" - \"BIS_coop_campaign_ss_missionLoadout\"\n- \"Started\" - \"BIS_coop_campaign_ss_missionStarted\"\n\nAny other state shows an error. The function does not change the mission state (see BIS_fnc_EXP_camp_manager_setState).\n\nThe function is meant for internal use. It is called by BIS_fnc_EXP_camp_manager (on state changes), BIS_fnc_EXP_camp_manager_setState and the campaign's state scripts, e.g. for players joining a mission in progress. The campaign's shared init script and the missions add the handlers with BIS_fnc_addScriptedEventHandler.","syntaxes":[{"syntax":"[state] call BIS_fnc_EXP_camp_manager_triggerEvent","params":[{"name":"state","type":"String","optional":true,"default":"\"Waiting\"","description":"the mission state: \"Waiting\", \"Intro\", \"Loadout\" or \"Started\"","type_expr":"String","text":"state: String - (Optional, default \"Waiting\") the mission state: \"Waiting\", \"Intro\", \"Loadout\" or \"Started\""}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[missionNamespace, \"BIS_coop_campaign_ss_missionStarted\", { systemChat \"Mission started\"; }] call BIS_fnc_addScriptedEventHandler;\n[\"Started\"] call BIS_fnc_EXP_camp_manager_triggerEvent; // shows \"Mission started\""]}],"see_also":["BIS_fnc_EXP_camp_manager","BIS_fnc_EXP_camp_manager_setState","BIS_fnc_EXP_camp_manager_getState","BIS_fnc_addScriptedEventHandler","BIS_fnc_callScriptedEventHandler"]},{"name":"BIS_fnc_EXP_camp_playerChecklist","title":"BIS fnc EXP camp playerChecklist","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_playerChecklist","revid":348058,"updated":"2023-11-08T11:29:23Z","groups":["Campaign"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Display a checklist of players that don't meet the given condition, thus preventing mission progress.","syntaxes":[{"syntax":"[conditionProceed, conditionPlayer, code] call BIS_fnc_EXP_camp_playerChecklist","params":[{"name":"conditionProceed","type":"Code","optional":true,"default":"{true}","description":"general condition that must be met to proceed. Will not list player names.","type_expr":"Code","text":"conditionProceed: Code - (Optional, default {true}) general condition that must be met to proceed. Will not list player names."},{"name":"conditionPlayer","type":"Code","optional":true,"default":"{true}","description":"condition that must be met by each player. Use **_player** to reference the player unit.","type_expr":"Code","text":"conditionPlayer: Code - (Optional, default {true}) condition that must be met by each player. Use **_player** to reference the player unit."},{"name":"code","type":"Code","optional":true,"default":"{}","description":"code to be executed when all players meet the defined condition.","type_expr":"Code","text":"code: Code - (Optional, default {}) code to be executed when all players meet the defined condition."}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if successful, false if not"}}],"examples":[{"code":["[{count allPlayers == 4}] call BIS_fnc_EXP_camp_playerChecklist;"]}],"multiplayer":"Should only be excuted on the server."},{"name":"BIS_fnc_EXP_camp_playSubtitles","title":"BIS fnc EXP camp playSubtitles","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_playSubtitles","revid":364461,"updated":"2024-05-16T20:41:49Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","exec":"spawn","description":"Displays the given subtitles at the correctly defined moments. Each array added to the parameters represents one subtitle.\n\n> [!NOTE]\n> Subtitles can be cancelled by setting `BIS_fnc_EXP_camp_playSubtitles_terminate` to true.","syntaxes":[{"syntax":"[subtitleDetail1, subtitleDetail2, ...] spawn BIS_fnc_EXP_camp_playSubtitles","params":[{"name":"subtitleDetailN","type":"Array","description":"format [speaker, text, timing]:\n\n- speaker: String - speaker's name\n- text: String - subtitle\n- timing: Number - time at which the subtitle is played","type_expr":"Array"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if successful, false if not"}}],"examples":[{"text":"```sqf\n[\n    [\"CROSSROAD\", \"Mission is a go, I repeat, mission is a go! Crossroad, out.\", 0]\n] spawn BIS_fnc_EXP_camp_playSubtitles; // shows a subtitle immediately\n```","code":["[\n\t[\"CROSSROAD\", \"Mission is a go, I repeat, mission is a go! Crossroad, out.\", 0]\n] spawn BIS_fnc_EXP_camp_playSubtitles; // shows a subtitle immediately"]},{"text":"```sqf\n[\n    [\"Speaker1\", \"Subtitle1\", 0],\n    [\"Speaker2\", \"Subtitle2\", 5],\n    [\"Speaker3\", \"Subtitle3\", 10],\n    [\"Speaker4\", \"Subtitle4\", 15]\n] spawn BIS_fnc_EXP_camp_playSubtitles; // displays 4 subtitles with 5 seconds between them\n\nsleep 7;\nBIS_fnc_EXP_camp_playSubtitles_terminate = true; // closes subtitles\n```","code":["[\n\t[\"Speaker1\", \"Subtitle1\", 0],\n\t[\"Speaker2\", \"Subtitle2\", 5],\n\t[\"Speaker3\", \"Subtitle3\", 10],\n\t[\"Speaker4\", \"Subtitle4\", 15]\n] spawn BIS_fnc_EXP_camp_playSubtitles; // displays 4 subtitles with 5 seconds between them\n\nsleep 7;\nBIS_fnc_EXP_camp_playSubtitles_terminate = true; // closes subtitles"]}],"see_also":["Conversations","BIS_fnc_showSubtitle"]},{"name":"BIS_fnc_EXP_camp_playTimelineVideo","title":"BIS fnc EXP camp playTimelineVideo","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_playTimelineVideo","revid":348964,"updated":"2023-11-08T14:45:40Z","groups":["Campaign"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","locality":{"effect":"local"},"description":"Plays a video with BIS_fnc_EXP_camp_setCinematicMode enabled.","syntaxes":[{"syntax":"[videoPath] call BIS_fnc_EXP_camp_playTimelineVideo","params":[{"name":"videoPath","type":"String","description":"path to video","type_expr":"String"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["\"someVideoPath\" call BIS_fnc_EXP_camp_playTimelineVideo;"]}],"see_also":["BIS_fnc_playVideo"]},{"name":"BIS_fnc_EXP_camp_replaceVehicles","title":"BIS fnc EXP camp replaceVehicles","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_replaceVehicles","revid":309403,"updated":"2022-05-05T12:04:35Z","groups":["Campaign"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","locality":{"effect":"global","server_exec":true},"description":"Replaces textures of \"I_G_Offroad_01_armed_F\" and \"I_G_Quadbike_01_F\" randomly.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if in cinematic mode, false if not"}}],"examples":[{"code":["call BIS_fnc_EXP_camp_replaceVehicles;"]}],"see_also":["vehicles"]},{"name":"BIS_fnc_EXP_camp_setCinematicMode","title":"BIS fnc EXP camp setCinematicMode","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_setCinematicMode","revid":348061,"updated":"2023-11-08T11:29:36Z","groups":["Campaign"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Sets cinematic mode, with cinematic mode enabled the sounds are muted and screen is black.","syntaxes":[{"syntax":"[mode, fadeBlack, fadeSound] call BIS_fnc_EXP_camp_setCinematicMode","params":[{"name":"mode","type":"Boolean","optional":true,"default":"false","description":"true to enable, false to disable","type_expr":"Boolean","text":"mode: Boolean - (Optional, default false) true to enable, false to disable"},{"name":"fadeBlack","type":"Number","optional":true,"default":"5","description":"how long it takes in seconds to fade the screen","type_expr":"Number","text":"fadeBlack: Number - (Optional, default 5) how long it takes in seconds to fade the screen"},{"name":"fadeSound","type":"Number","optional":true,"default":"5","description":"how long it takes in seconds to fade the sound","type_expr":"Number","text":"fadeSound: Number - (Optional, default 5) how long it takes in seconds to fade the sound"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[true, 3, 3] call BIS_fnc_EXP_camp_setCinematicMode;"]}],"multiplayer":"Must be executed for every player.","see_also":["BIS_fnc_EXP_camp_getCinematicMode"]},{"name":"BIS_fnc_EXP_camp_setSkill","title":"BIS fnc EXP camp setSkill","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_setSkill","revid":364258,"updated":"2024-05-06T09:38:24Z","groups":["Campaign"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","locality":{"server_exec":true},"description":"Sets skill for an entire AI side. The skill will be calculated using a lerp function. Function will take player as multiplier.","syntaxes":[{"syntax":"[side,skillMin,skillAimMin,skillMax,skillAimMax] call BIS_fnc_EXP_camp_setSkill","params":[{"name":"side","type":"Side","description":"side of which AI skill should be changed","type_expr":"Side"},{"name":"skillMin","type":"Number","optional":true,"default":"0.5","description":"minimal general skill","type_expr":"Number","text":"skillMin: Number - (Optional, default 0.5) minimal general skill"},{"name":"skillAimMin","type":"Number","optional":true,"default":"0.3","description":"minimal aiming skill","type_expr":"Number","text":"skillAimMin: Number - (Optional, default 0.3) minimal aiming skill"},{"name":"skillMax","type":"Number","optional":true,"default":"0.8","description":"maximal general skill","type_expr":"Number","text":"skillMax: Number - (Optional, default 0.8) maximal general skill"},{"name":"skillAimMax","type":"Number","optional":true,"default":"0.5","description":"maximal aiming skill","type_expr":"Number","text":"skillAimMax: Number - (Optional, default 0.5) maximal aiming skill"}],"returns":null}],"examples":[{"code":["[WEST,0.1,0.2,0.7,0.6] call BIS_fnc_EXP_camp_setSkill;"]}],"see_also":["Arma 3: AI Skill","setSkill","skillFinal","BIS_fnc_EXP_camp_dynamicAISkill"]},{"name":"BIS_fnc_EXP_camp_SITREP","title":"BIS fnc EXP camp SITREP","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_EXP_camp_SITREP","revid":337428,"updated":"2023-01-30T14:05:14Z","groups":["Campaign","GUI"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","locality":{"effect":"local"},"exec":"spawn","description":"Displays multiple lines of text in given order.","syntaxes":[{"syntax":"[line1, line2, lineX] spawn BIS_fnc_EXP_camp_SITREP","params":[{"name":"line#","type":"Array","description":"lines to be displayed, format [text, fadeInTime, waitTime, fadeOutTime]:\n\n- 0: text: String - text to be displayed\n- 1: fadeInTime: Number - (Optional, default 2) fade-in duration in seconds\n- 2: waitTime: Number - (Optional, default 1) how many seconds to wait before showing the next line\n- 3: fadeOutTime: String - (Optional, default 2) fade-out duration in seconds. It is only used by the last line. Fades all other lines as well","type_expr":"Array"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if successful, false if not"}}],"examples":[{"code":["[[\"line1\", 4, 5], [\"line2\", 3, 5, 8]] spawn BIS_fnc_EXP_camp_SITREP;"]}],"see_also":["BIS_fnc_dynamicText","BIS_fnc_infoText","BIS_fnc_textTiles","BIS_fnc_typeText2"]},{"name":"BIS_fnc_exportCfgGroups","title":"BIS fnc exportCfgGroups","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_exportCfgGroups","revid":337401,"updated":"2023-01-25T12:37:23Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Export group or object composition for use in CfgGroups. The result will be copied to clipboard.","syntaxes":[{"syntax":"[param0, param1] call BIS_fnc_exportCfgGroups","params":[{"name":"param0","type":"Position","type_expr":"Position","text":"0: position (for supported types see BIS_fnc_position). Screen center is used by default","source":"docblock"},{"name":"param1","type":"Object","type_expr":"Object","default":"ARRAY of OBJECTs - specific objects to be saved","description":"ARRAY of OBJECTs - specific objects to be saved\narray in format used by nearEntities, which automatically get nearby objects\n    0: STRING or ARRAY of STRINGS - object types\n    1: NUMBER - radius in metres","text":"1: objects to be saved. Currently selected objects in curator are used by default\nARRAY of OBJECTs - specific objects to be saved\narray in format used by nearEntities, which automatically get nearby objects\n    0: STRING or ARRAY of STRINGS - object types\n    1: NUMBER - radius in metres","source":"docblock"}],"returns":{"type":"String","type_expr":"String","text":"STRING","source":"docblock"},"inferred":true}],"notes":[{"user":".kju","date":"2023-01-25T12:23:22Z","text":"How to export objects to a mod/config composition:\n\n1. Open the console (CTRL+D in Eden, ESC in Zeus)\n1. Select the desired object set\n1. Execute\n\n   ```sqf\n   [nil,get3DENSelected \"\" select 0] call BIS_fnc_exportCfgGroups; //Eden\n   [nil,nil] call BIS_fnc_exportCfgGroups; //Zeus\n   ```\n1. Paste (CTRL+V) in definitions into a text file\n1. Create a config.cpp\n1. Integrate into `class CfgGroups/Empty`"}],"docblock":{"text":"Description:\nExport group or object composition for use in CfgGroups. The result will be copied to clipboard.\n\nParameter(s):\n    0: position (for supported types see BIS_fnc_position). Screen center is used by default\n    1: objects to be saved. Currently selected objects in curator are used by default\n        ARRAY of OBJECTs - specific objects to be saved\n        array in format used by nearEntities, which automatically get nearby objects\n            0: STRING or ARRAY of STRINGS - object types\n            1: NUMBER - radius in metres\n\nReturns:\nSTRING"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_exportCfgHints","title":"BIS fnc exportCfgHints","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_exportCfgHints","revid":328568,"updated":"2022-07-13T17:02:21Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Exports `CfgHints` to wiki format (see Category:Arma 3: Field Manual).","syntaxes":[{"syntax":"[category, class] call BIS_fnc_exportCfgHints","params":[{"name":"category","type":"String","type_expr":"String"},{"name":"class","type":"String","type_expr":"String"}],"returns":{"type":"String","type_expr":"String","description":"wiki content"}}],"examples":[{"code":["[] call BIS_fnc_exportCfgHints;"]}],"see_also":["BIS_fnc_exportEditorPreviews","BIS_fnc_exportFunctionsToWiki"]},{"name":"BIS_fnc_exportCfgMagazines","title":"BIS fnc exportCfgMagazines","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_exportCfgMagazines","revid":353281,"updated":"2024-03-15T16:45:33Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","exec":"spawn","description":"Export list of magazines for Arma 3 Assets.","syntaxes":[{"syntax":"[classes] spawn BIS_fnc_exportCfgMagazines","params":[{"name":"classes","type":"Array of Strings","optional":true,"default":"`[]`","description":"list of CfgPatches classes","type_expr":"Array<String>","text":"classes: Array of Strings - (Optional, default `[]`) list of CfgPatches classes"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[] spawn BIS_fnc_exportCfgMagazines; // exports Arma 3: CfgMagazines"]},{"code":["[[\"class1\", \"class2\"]] spawn BIS_fnc_exportCfgMagazines;"]}],"see_also":["BIS_fnc_exportCfgWeapons"]},{"name":"BIS_fnc_exportCfgPatches","title":"BIS fnc exportCfgPatches","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_exportCfgPatches","revid":353277,"updated":"2024-03-15T16:37:26Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Export list of addons for Community Wiki - Arma 3: Assets.","syntaxes":[{"syntax":"[config, classes] call BIS_fnc_exportCfgPatches","params":[{"name":"config","type":"String","optional":true,"default":"\"CfgVehicles\"","type_expr":"String","text":"config: String - (Optional, default \"CfgVehicles\")"},{"name":"classes","type":"Array of Strings","description":"list of `CfgPatches` classes","type_expr":"Array<String>"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["call BIS_fnc_exportCfgPatches;"]},{"text":"```sqf\n[\"CfgVehicles\"] call BIS_fnc_exportCfgPatches;    // exports Arma 3: CfgPatches CfgVehicles\n[\"CfgWeapons\"]  call BIS_fnc_exportCfgPatches;    // exports Arma 3: CfgPatches CfgWeapons\n```","code":["[\"CfgVehicles\"] call BIS_fnc_exportCfgPatches;\t// exports Arma 3: CfgPatches CfgVehicles\n[\"CfgWeapons\"]  call BIS_fnc_exportCfgPatches;\t// exports Arma 3: CfgPatches CfgWeapons"]}],"see_also":["BIS_fnc_exportFunctionsToWiki","BIS_fnc_exportCfgWeapons"]},{"name":"BIS_fnc_exportCfgVehicles","title":"BIS fnc exportCfgVehicles","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_exportCfgVehicles","revid":379496,"updated":"2026-10-31T00:26:30Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Export list of objects for Community Wiki (Assets).","syntaxes":[{"syntax":"[mode,sides,classes,useAI] call BIS_fnc_exportCfgVehicles","params":[{"name":"mode","type":"String","description":"mode, can be one of:\n\n- \"config\" - copy the objects table to clipboard\n- \"screenshots\" - create objects one by one and take their screenshot. Works only on \"Render\" terrain.\n- \"screenshotsTest\" - create objects one by one without taking screen (to verify everything is ok)","type_expr":"String"},{"name":"sides","type":"Array of Sides","description":"only objects of these sides will be used","type_expr":"Array<Side>"},{"name":"classes","type":"Array of Strings","description":"list of CfgPatches classes. Only objects belonging to these addons will be used","type_expr":"Array<String>"},{"name":"useAI","type":"Boolean","description":"true to use only AI units (soldiers, vehicles), false to use empty ones","type_expr":"Boolean"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[] call BIS_fnc_exportCfgVehicles;"]},{"code":["[\"config\", [3], [\"A3_Characters_F_Beta\",\"A3_Characters_F_EPA\",\"A3_Characters_F_EPB\"], true] call BIS_fnc_exportCfgVehicles;"]}]},{"name":"BIS_fnc_exportCfgVehiclesAssetDB","title":"BIS fnc exportCfgVehiclesAssetDB","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_exportCfgVehiclesAssetDB","revid":353262,"updated":"2024-03-15T10:56:18Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","exec":"spawn","description":"Copies CfgVehicles information to clipboard in wiki format.","syntaxes":[{"syntax":"[side, category] call BIS_fnc_exportCfgVehiclesAssetDB","params":[{"name":"side","type":"Array or Numbers","optional":true,"default":"`[4,5,6,7,8,9]`","description":"side selection, can be:\n\n- 0: OPFOR / CSAT\n- 1: BLUFOR / NATO\n- 2: Independent / Guerrilla\n- 3: Civilian\n- 4: Unknown\n- 5: Enemy\n- 6: Friendly\n- 7: Logic\n- 8: Empty\n- 9: AmbientLife","type_expr":"Array | Number","text":"side: Array or Numbers - (Optional, default `[4,5,6,7,8,9]`) side selection, can be:\n\n- 0: OPFOR / CSAT\n- 1: BLUFOR / NATO\n- 2: Independent / Guerrilla\n- 3: Civilian\n- 4: Unknown\n- 5: Enemy\n- 6: Friendly\n- 7: Logic\n- 8: Empty\n- 9: AmbientLife"},{"name":"category","type":"Number","optional":true,"default":"0 if side is a number, always reverts to 1 if side an array","description":"only used when *side* is set to **3**.\nCan be one of the following:\n\n- 0: civilian units\n- 1: structures\n- 2: ruins and wrecks\n- 3: equipment\n- 4: objects\n- 5: VR\n- 6: animals","type_expr":"Number","text":"category: Number - (Optional, default 0 if *side* is a number, always reverts to 1 if *side* an array) only used when *side* is set to **3**.\nCan be one of the following:\n\n- 0: civilian units\n- 1: structures\n- 2: ruins and wrecks\n- 3: equipment\n- 4: objects\n- 5: VR\n- 6: animals"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"```sqf\n[0]   spawn BIS_fnc_exportCfgVehiclesAssetDB;    // exports Arma 3: CfgVehicles EAST\n[1]   spawn BIS_fnc_exportCfgVehiclesAssetDB;    // exports Arma 3: CfgVehicles WEST\n[2]   spawn BIS_fnc_exportCfgVehiclesAssetDB;    // exports Arma 3: CfgVehicles GUER\n[3,0] spawn BIS_fnc_exportCfgVehiclesAssetDB;    // exports Arma 3: CfgVehicles CIV\n[3,1] spawn BIS_fnc_exportCfgVehiclesAssetDB;    // exports Arma 3: CfgVehicles Structures\n[3,2] spawn BIS_fnc_exportCfgVehiclesAssetDB;    // exports Arma 3: CfgVehicles Ruins & Wrecks\n[3,3] spawn BIS_fnc_exportCfgVehiclesAssetDB;    // exports Arma 3: CfgVehicles Equipment\n[3,4] spawn BIS_fnc_exportCfgVehiclesAssetDB;    // exports Arma 3: CfgVehicles EMPTY\n[3,5] spawn BIS_fnc_exportCfgVehiclesAssetDB;    // exports Arma 3: CfgVehicles VR Objects\n[3,6] spawn BIS_fnc_exportCfgVehiclesAssetDB;    // exports Arma 3: CfgVehicles Animals\n[]    spawn BIS_fnc_exportCfgVehiclesAssetDB;    // exports Arma 3: CfgVehicles Other\n                                                // Unknown, Enemy, Friendly, Modules, Empty, Ambient Life\n```","code":["[0]   spawn BIS_fnc_exportCfgVehiclesAssetDB;\t// exports Arma 3: CfgVehicles EAST\n[1]   spawn BIS_fnc_exportCfgVehiclesAssetDB;\t// exports Arma 3: CfgVehicles WEST\n[2]   spawn BIS_fnc_exportCfgVehiclesAssetDB;\t// exports Arma 3: CfgVehicles GUER\n[3,0] spawn BIS_fnc_exportCfgVehiclesAssetDB;\t// exports Arma 3: CfgVehicles CIV\n[3,1] spawn BIS_fnc_exportCfgVehiclesAssetDB;\t// exports Arma 3: CfgVehicles Structures\n[3,2] spawn BIS_fnc_exportCfgVehiclesAssetDB;\t// exports Arma 3: CfgVehicles Ruins & Wrecks\n[3,3] spawn BIS_fnc_exportCfgVehiclesAssetDB;\t// exports Arma 3: CfgVehicles Equipment\n[3,4] spawn BIS_fnc_exportCfgVehiclesAssetDB;\t// exports Arma 3: CfgVehicles EMPTY\n[3,5] spawn BIS_fnc_exportCfgVehiclesAssetDB;\t// exports Arma 3: CfgVehicles VR Objects\n[3,6] spawn BIS_fnc_exportCfgVehiclesAssetDB;\t// exports Arma 3: CfgVehicles Animals\n[]    spawn BIS_fnc_exportCfgVehiclesAssetDB;\t// exports Arma 3: CfgVehicles Other\n\t\t\t\t\t\t\t\t\t\t\t\t// Unknown, Enemy, Friendly, Modules, Empty, Ambient Life"]}],"see_also":["side","CfgVehicles Config Reference","BIS_fnc_exportCfgGroups","BIS_fnc_exportCfgHints","BIS_fnc_exportCfgMagazines","BIS_fnc_exportCfgPatches","BIS_fnc_exportCfgVehicles","BIS_fnc_exportCfgWeapons"]},{"name":"BIS_fnc_exportCfgWeapons","title":"BIS fnc exportCfgWeapons","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_exportCfgWeapons","revid":353282,"updated":"2024-03-15T16:46:12Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","exec":"spawn","description":"Export list of weapons for Community Wiki Arma 3 Assets Category.","syntaxes":[{"syntax":"[mode, patches, types] spawn BIS_fnc_exportCfgWeapons","params":[{"name":"mode","type":"String","description":"can be one of:\n\n- \"Equipment\"\n- \"Item\"\n- \"VehicleWeapon\"\n- \"Weapon\" - specific item type, based on BIS_fnc_itemType\n- internal use only: \"screenshots\" - create items one by one and take their screenshot. Works only on \"Render\" terrain.\n- internal use only: \"screenshotsTest\" - create items one by one without taking screen (to verify everything is ok)","type_expr":"String"},{"name":"patches","type":"Array of Strings","optional":true,"default":"`[]`","description":"list of CfgPatches classes. Only weapons belonging to these addons will be used","type_expr":"Array<String>","text":"patches: Array of Strings - (Optional, default `[]`) list of CfgPatches classes. Only weapons belonging to these addons will be used"},{"name":"types","type":"Array of Strings","optional":true,"default":"`[]`","type_expr":"Array<String>","text":"types: Array of Strings - (Optional, default `[]`)"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when done"}}],"examples":[{"text":"```sqf\n[\"Weapon\"]            spawn BIS_fnc_exportCfgWeapons;    // exports Arma 3: CfgWeapons Weapons\n[\"VehicleWeapon\"]    spawn BIS_fnc_exportCfgWeapons;    // exports Arma 3: CfgWeapons Vehicle Weapons\n[\"Item\"]            spawn BIS_fnc_exportCfgWeapons;    // exports Arma 3: CfgWeapons Items\n[\"Equipment\"]        spawn BIS_fnc_exportCfgWeapons;    // exports Arma 3: CfgWeapons Equipment\n[\"screenshots\"]        spawn BIS_fnc_exportCfgWeapons;    // screenshots\n[\"screenshotsTest\"]    spawn BIS_fnc_exportCfgWeapons;    // screenshots test mode, does nothing\n```","code":["[\"Weapon\"]\t\t\tspawn BIS_fnc_exportCfgWeapons;\t// exports Arma 3: CfgWeapons Weapons\n[\"VehicleWeapon\"]\tspawn BIS_fnc_exportCfgWeapons;\t// exports Arma 3: CfgWeapons Vehicle Weapons\n[\"Item\"]\t\t\tspawn BIS_fnc_exportCfgWeapons;\t// exports Arma 3: CfgWeapons Items\n[\"Equipment\"]\t\tspawn BIS_fnc_exportCfgWeapons;\t// exports Arma 3: CfgWeapons Equipment\n[\"screenshots\"]\t\tspawn BIS_fnc_exportCfgWeapons;\t// screenshots\n[\"screenshotsTest\"]\tspawn BIS_fnc_exportCfgWeapons;\t// screenshots test mode, does nothing"]}]},{"name":"BIS_fnc_exportConfigHierarchy","title":"BIS fnc exportConfigHierarchy","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_exportConfigHierarchy","revid":349433,"updated":"2023-11-08T16:27:36Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Export config hierarchy of given config.","syntaxes":[{"syntax":"[config,class] call BIS_fnc_exportConfigHierarchy","params":[{"name":"config","type":"Config","type_expr":"Config"},{"name":"class","type":"String","description":"topmost class","type_expr":"String"}],"returns":{"type":"String","type_expr":"String","description":"exported text in wikitable format"}}],"examples":[{"code":["[configFile >> \"CfgWeapons\"] call BIS_fnc_exportConfigHierarchy;"]},{"code":["[configFile >> \"CfgWeapons\", \"LandVehicle\"] call BIS_fnc_exportConfigHierarchy;"]}],"see_also":["configFile","Config"]},{"name":"BIS_fnc_exportCuratorCostTable","title":"BIS fnc exportCuratorCostTable","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_exportCuratorCostTable","revid":281314,"updated":"2021-06-14T09:08:09Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Generate spreadsheet with object classes and copy it to clipboard. The table will generate export code to be used in BIS_fnc_curatorObjectRegisteredTable","syntaxes":[{"syntax":"arg call BIS_fnc_exportCuratorCostTable","params":[{"name":"arg","type":"Array, String","types":["Array","String"],"optional":true,"default":"{true}","description":"supported addons (classes from CfgPatches). When empty, all preloaded addons will be added. Use empty string to export just the cost calculation.\n1 (Optional): STRING - format, can be \"ods\" or \"xls\"\n2 (Optional): STRING - name of sheet with cost calculation. When empty, the calculation will be inserted on top of the table\n3 (Optional): ARRAY of SIDEs or NUMBERs - filter only objects of listed sides or side IDs. Supported sides are west, east, resistance, civilian, sideUnknown and sideLogic\n4 (Optional): CODE - condition for class to be listed. Config path to the class is passed as an argument (default: {true})\n5 (Optional): CODE - default cost, must return STRING. When empty string is returned, no default cost will be used (default: {\"\"})","text":"0 (Optional): ARRAY of STRINGs - supported addons (classes from CfgPatches). When empty, all preloaded addons will be added. Use empty string to export just the cost calculation.\n1 (Optional): STRING - format, can be \"ods\" or \"xls\"\n2 (Optional): STRING - name of sheet with cost calculation. When empty, the calculation will be inserted on top of the table\n3 (Optional): ARRAY of SIDEs or NUMBERs - filter only objects of listed sides or side IDs. Supported sides are west, east, resistance, civilian, sideUnknown and sideLogic\n4 (Optional): CODE - condition for class to be listed. Config path to the class is passed as an argument (default: {true})\n5 (Optional): CODE - default cost, must return STRING. When empty string is returned, no default cost will be used (default: {\"\"})","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","text":"BOOL","source":"docblock"},"inferred":true}],"see_also":["BIS_fnc_curatorObjectRegisteredTable"],"docblock":{"text":"Description:\nGenerate spreadsheet with object classes and copy it to clipboard.\nThe table will generate export code to be used in BIS_fnc_curatorObjectRegisteredTable\n\nParameter(s):\n    0 (Optional): ARRAY of STRINGs - supported addons (classes from CfgPatches). When empty, all preloaded addons will be added. Use empty string to export just the cost calculation.\n    1 (Optional): STRING - format, can be \"ods\" or \"xls\"\n    2 (Optional): STRING - name of sheet with cost calculation. When empty, the calculation will be inserted on top of the table\n    3 (Optional): ARRAY of SIDEs or NUMBERs - filter only objects of listed sides or side IDs. Supported sides are west, east, resistance, civilian, sideUnknown and sideLogic\n    4 (Optional): CODE - condition for class to be listed. Config path to the class is passed as an argument (default: {true})\n    5 (Optional): CODE - default cost, must return STRING. When empty string is returned, no default cost will be used (default: {\"\"})\n\nReturns:\nBOOL"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_exportEditorPreviews","title":"BIS fnc exportEditorPreviews","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_exportEditorPreviews","revid":370758,"updated":"2025-02-06T22:25:56Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.60"},"since":"arma3 1.60","arma3_since":"1.60","exec":"spawn","description":"Export screenshots of objects for Eden Editor and Community Wiki to `<Arma 3 Profile>\\Screenshots\\EditorPreviews` directory. See Arma 3 assets.\n\n> [!NOTE]\n> The file is saved into *Screenshots* folder in the Profile directory. The folder is by default limited to 250 MB to prevent abuse.\n>\n> To increase the limit, add the following line at the end of the profile file:\n>\n> ```cpp\n> maxScreenShotFolderSizeMB = 2000; // size in MB\n> ```","syntaxes":[{"syntax":"[duration, type, sides, mods, addons, classes] spawn BIS_fnc_exportEditorPreviews","params":[{"name":"duration","type":"Number","optional":true,"default":"1","description":"duration in seconds for which an objects remains on the screen before its screen is captured","type_expr":"Number","text":"duration: Number - (Optional, default 1) duration in seconds for which an objects remains on the screen before its screen is captured"},{"name":"type","type":"String","optional":true,"default":"\"all\"","description":"can be one of:\n\n- \"vehicles\" - only characters and vehicles will be used\n- \"props\" - only props will be used\n- \"all\" - all objects will be used","type_expr":"String","text":"type: String - (Optional, default \"all\") can be one of:\n\n- \"vehicles\" - only characters and vehicles will be used\n- \"props\" - only props will be used\n- \"all\" - all objects will be used"},{"name":"sides","type":"Array of Sides","optional":true,"default":"all sides","description":"list of sides. Only objects of these sides will be used","type_expr":"Array<Side>","text":"sides: Array of Sides - (Optional, default all sides) list of sides. Only objects of these sides will be used"},{"name":"mods","type":"Array of String","optional":true,"default":"all mods","description":"list of CfgMods classes. External mods should be prefixed with \"@\". Only objects belonging to these mods will be used","type_expr":"Array<String>","text":"mods: Array of String - (Optional, default all mods) list of CfgMods classes. External mods should be prefixed with \"@\". Only objects belonging to these mods will be used"},{"name":"addons","type":"Array of String","optional":true,"default":"all addons","description":"list of CfgPatches classes. Only objects belonging to these addons will be used","type_expr":"Array<String>","text":"addons: Array of String - (Optional, default all addons) list of CfgPatches classes. Only objects belonging to these addons will be used"},{"name":"classes","type":"Array of String","optional":true,"default":"all classes","description":"list of CfgVehicles classes. Only these objects will be used","type_expr":"Array<String>","text":"classes: Array of String - (Optional, default all classes) list of CfgVehicles classes. Only these objects will be used"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["// All objects\n[] spawn BIS_fnc_exportEditorPreviews;"]},{"code":["// All characters and vehicles. Capturing delay will be 0.5 seconds\n[0.5, \"vehicles\"] spawn BIS_fnc_exportEditorPreviews;"]},{"code":["// BLUFOR characters and vehicles\n[nil, \"vehicles\", [west]] spawn BIS_fnc_exportEditorPreviews;"]},{"code":["// Props in Karts DLC\n[nil, \"props\", [], [\"kart\"]] spawn BIS_fnc_exportEditorPreviews;"]},{"code":["// All objects in specified addons\n[nil, \"all\", [], [], [\"A3_Armor_F_Slammer\", \"A3_Air_F_Heli_Heli_Transport_03\"]] spawn BIS_fnc_exportEditorPreviews;"]},{"code":["// BLUFOR characters and vehicles in Marksmen DLC\n[nil, \"vehicles\", [west], [\"mark\"]] spawn BIS_fnc_exportEditorPreviews;"]},{"code":["// Only the B_Soldier_F\n[nil, \"all\", [], [], [], [\"B_Soldier_F\"]] spawn BIS_fnc_exportEditorPreviews;"]},{"code":["// Props in CBA\n[nil, \"props\", [], [\"@cba_a3\"]] spawn BIS_fnc_exportEditorPreviews;"]}],"see_also":["screenshot","Eden Editor: Configuring Asset Previews"]},{"name":"BIS_fnc_exportFunctionsToWiki","title":"BIS fnc exportFunctionsToWiki","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_exportFunctionsToWiki","revid":352115,"updated":"2024-02-01T23:25:00Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","exec":"spawn","description":"Export function descriptions to Community Wiki. Exported text will be copied to clipboard in XML format.\n**Wiki Admins** can import them using **Special:Import**.\nIf the page already exists, it will be replaced only when *timestamp* is newer.\n\n> [!WARNING]\n> This function should no longer be used to mass-import functions since the template for function pages has changed drastically!","syntaxes":[{"syntax":"[filter, timestamp] spawn BIS_fnc_exportFunctionsToWiki","params":[{"name":"filter","type":"Array","optional":true,"default":"`[]`","description":"functions filter in format [tags, categories, functions]:\n\n- tags: String or Array of Strings - CfgFunctions tags (e.g., \"A3_Oldman\"). Use empty string for all of them\n- categories: String or Array of Strings - categories (e.g., \"Debug\"). Use empty string for all of them\n- functions: String or Array of Strings - specific function names (e.g., \"BIS_fnc_log\"). Use empty string for all of them","type_expr":"Array","text":"filter: Array - (Optional, default `[]`) functions filter in format [tags, categories, functions]:\n\n- tags: String or Array of Strings - CfgFunctions tags (e.g., \"A3_Oldman\"). Use empty string for all of them\n- categories: String or Array of Strings - categories (e.g., \"Debug\"). Use empty string for all of them\n- functions: String or Array of Strings - specific function names (e.g., \"BIS_fnc_log\"). Use empty string for all of them"},{"name":"timestamp","type":"String","optional":true,"default":"\"2006-04-03T17:42:00Z\"","description":"in format \"2013-09-12T16:00:00Z\"","type_expr":"String","text":"timestamp: String - (Optional, default \"2006-04-03T17:42:00Z\") in format \"2013-09-12T16:00:00Z\""}],"returns":{"type":"String","type_expr":"String","description":"exported text"}}],"examples":[{"code":["[] spawn BIS_fnc_exportFunctionsToWiki; // export all functions"]},{"code":["[[\"\", \"Arrays\"]] spawn BIS_fnc_exportFunctionsToWiki; // export all Array functions"]},{"code":["[[\"\", \"\", [\"BIS_fnc_log\", \"BIS_fnc_param\"]]] spawn BIS_fnc_exportFunctionsToWiki; // export specific functions"]}],"see_also":["BIS_fnc_diagWiki"]},{"name":"BIS_fnc_exportGroupFormations","title":"BIS fnc exportGroupFormations","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_exportGroupFormations","revid":309757,"updated":"2022-05-05T12:09:49Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_exportGUIBaseClasses","title":"BIS fnc exportGUIBaseClasses","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_exportGUIBaseClasses","revid":347871,"updated":"2023-10-30T17:00:13Z","groups":["GUI","Diagnostic","Broken Functions"],"status":"broken","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Export GUI macros and base classes to the clipboard.\n\n> [!CAUTION]\n> This information is **obsolete** as of Arma 3 v2.01.146644. Reason: the import keyword was introduced.\n\n> [!WARNING]\n> The exported the Eden Editor base classes have several inheritance issues.\n> If you need the base classes you can get them [**here**](https://github.com/LarrowZurb/A3_GUI_Defines).","syntaxes":[{"syntax":"mode call BIS_fnc_exportGUIBaseClasses","params":[{"name":"mode","type":"String","description":"mode, **case-sensitive**; can be one of:\n\n- `\"Default\"` - classic base classes like `RscText` or `RscPicture`\n- `\"3DEN\"` - Eden Editor base classes like `ctrlStatic` or `ctrlStaticPicture`\n- `\"all\"` - all GUI base classes, including more exotic ones\n\n> [!IMPORTANT]\n> All modes are case sensitive. If the capitalisation is disregarded the function will default to the \"all\" mode.\n> In fact there is no explicit \"all\" mode, rather it is the fallback if the mode is not one of \"Default\" or \"3DEN\".","type_expr":"String"}],"returns":{"type":"String","type_expr":"String","description":"`.hpp` file content to be included in Description.ext, also copied to the clipboard"}}],"examples":[{"code":["\"all\" call BIS_fnc_exportGUIBaseClasses;"]}],"see_also":["Arma: GUI Configuration","Arma 3: Utilities"],"notes":[{"user":"Killzone_Kid","date":"2018-09-28T14:37:00Z","text":"You can use Arma 3: Utilities to get the base class for your mission config.\nFor example if you need `RscPicture` base, enter **utils 2** in the debug console and click **LOCAL EXEC**, type `RscPicture` and press Enter, check **Include Inherited** box, then click **COPY**.\nThe config is now copied to Clipboard and you can paste it in your description.ext and then derive your class from it."}]},{"name":"BIS_fnc_exportInventory","title":"BIS fnc exportInventory","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_exportInventory","revid":378118,"updated":"2026-02-20T08:53:31Z","groups":["Inventory"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Exports unit's loadout as a String, also copies it to clipboard.","syntaxes":[{"syntax":"[unit, type, includeIdentity] call BIS_fnc_exportInventory","params":[{"name":"unit","type":"Object","optional":true,"default":"player","description":"unit whose loadout should be saved","type_expr":"Object","text":"unit: Object - (Optional, default player) unit whose loadout should be saved"},{"name":"type","type":"String","optional":true,"default":"\"script\"","description":"export type, can be:\n\n- \"script\" - scripting commands, target is referred to as `_unit`\n- \"init\" - scripting commands, target is referred to as `this`\n- \"config\" - config attributes","type_expr":"String","text":"type: String - (Optional, default \"script\") export type, can be:\n\n- \"script\" - scripting commands, target is referred to as `_unit`\n- \"init\" - scripting commands, target is referred to as `this`\n- \"config\" - config attributes"},{"name":"includeIdentity","type":"Boolean","optional":true,"default":"true","description":"true to also export face, voice and insignia (applicable to \"script\" and \"init\" only)","type_expr":"Boolean","text":"includeIdentity: Boolean - (Optional, default true) true to also export face, voice and insignia (applicable to \"script\" and \"init\" only)"}],"returns":{"type":"String","type_expr":"String","description":"SQF code or Config text when \"config\" option is chosen"}}],"examples":[{"code":["[player, \"init\", true] call BIS_fnc_exportInventory;"]}],"see_also":["BIS_fnc_loadInventory","BIS_fnc_deleteInventory","BIS_fnc_saveInventory","getUnitLoadout"]},{"name":"BIS_fnc_exportMapToBiTXT","title":"BIS fnc exportMapToBiTXT","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_exportMapToBiTXT","revid":309369,"updated":"2022-05-05T12:04:32Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns terrain height map to BiTXT (Universal Bistudio TXT) format, which can be imported to Object Builder. Output is also copied to clipboard.\n\n> [!IMPORTANT]\n> Be wary that **this function is CPU-demanding** and may lock your computer for minutes!","syntaxes":[{"syntax":"[resolution, size, zCoeff] call BIS_fnc_exportMapToBiTXT","params":[{"name":"resolution","type":"Number","optional":true,"default":"64","description":"object resolution, i.e, number of points per side","type_expr":"Number","text":"resolution: Number - (Optional, default 64) object resolution, i.e, number of points per side"},{"name":"size","type":"Number","optional":true,"default":"10","description":"object size in metres","type_expr":"Number","text":"size: Number - (Optional, default 10) object size in metres"},{"name":"zCoeff","type":"Number","optional":true,"default":"2","description":"vertical coefficient. All Z coordinates will be multiplied by this number to highlight hills and mountains","type_expr":"Number","text":"zCoeff: Number - (Optional, default 2) vertical coefficient. All Z coordinates will be multiplied by this number to highlight hills and mountains"}],"returns":{"type":"String","type_expr":"String","description":"height map, same data as in the clipboard"}}],"examples":[{"code":["[10, 10, 1] call BIS_fnc_exportMapToBiTXT;"]},{"code":["call BIS_fnc_exportMapToBiTXT;"]}]},{"name":"BIS_fnc_exportVehicle","title":"BIS fnc exportVehicle","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_exportVehicle","revid":363634,"updated":"2024-04-08T21:57:47Z","groups":["Vehicles"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Export vehicle settings","syntaxes":[{"syntax":"[vehicle,vehicleClass] call BIS_fnc_exportVehicle","params":[{"name":"vehicle","type":"Object","type_expr":"Object"},{"name":"vehicleClass","type":"String","description":"use \"\" to skip createVehicle part and set components / textures only","type_expr":"String"}],"returns":{"type":"String","type_expr":"String","description":"SQF code"}}],"examples":[{"text":"```sqf\n[BIS_tank,\"\"] call BIS_fnc_exportVehicle;\n\n//Returns\n\"[\n  _this,\n  [\"\"Hex\"\",1],\n  [\"\"showCamonetHull\"\",1,\"\"showCamonetTurret\"\",1]\n] call BIS_fnc_initVehicle;\"\n```","code":["[BIS_tank,\"\"] call BIS_fnc_exportVehicle;\n\n//Returns \n\"[\n  _this,\n  [\"\"Hex\"\",1], \n  [\"\"showCamonetHull\"\",1,\"\"showCamonetTurret\"\",1]\n] call BIS_fnc_initVehicle;\""]},{"text":"```sqf\n[BIS_tank] call BIS_fnc_exportVehicle;\n\n//Returns\n\"_veh = createVehicle [\"\"O_MBT_04_cannon_F\"\",position player,[],0,\"\"NONE\"\"];\n[\n  _veh,\n  [\"\"Hex\"\",1],\n  [\"\"showCamonetHull\"\",1,\"\"showCamonetTurret\"\",1]\n] call BIS_fnc_initVehicle;\"\n```","code":["[BIS_tank] call BIS_fnc_exportVehicle;\n\n//Returns \n\"_veh = createVehicle [\"\"O_MBT_04_cannon_F\"\",position player,[],0,\"\"NONE\"\"];\n[\n  _veh,\n  [\"\"Hex\"\",1], \n  [\"\"showCamonetHull\"\",1,\"\"showCamonetTurret\"\",1]\n] call BIS_fnc_initVehicle;\""]}],"see_also":["BIS_fnc_initVehicle","Arma 3: Vehicle Customisation"]},{"name":"BIS_fnc_fadeEffect","title":"BIS fnc fadeEffect","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_fadeEffect","revid":324311,"updated":"2022-07-01T12:00:44Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"effect":"local"},"exec":"spawn","description":"Easily carry out complex fading. Default values will be used if parameters are not defined or set to nil.","syntaxes":[{"syntax":"[fadeInOrOut, blackOrWhite, duration, blur, music, ending, success] spawn BIS_fnc_fadeEffect","params":[{"name":"fadeInOrOut","type":"Number","optional":true,"default":"1","description":"0 to fade out, 1 to fade in","type_expr":"Number","text":"fadeInOrOut: Number - (Optional, default 1) 0 to fade out, 1 to fade in"},{"name":"fadeColor","type":"String","optional":true,"default":"\"BLACK\"","description":"**case-sensitive** can be \"BLACK\" or \"WHITE\"","type_expr":"String","text":"fadeColor: String - (Optional, default \"BLACK\") **case-sensitive** can be \"BLACK\" or \"WHITE\""},{"name":"duration","type":"Number","optional":true,"default":"3","description":"fade duration in seconds","type_expr":"Number","text":"duration: Number - (Optional, default 3) fade duration in seconds"},{"name":"blur","type":"Number","optional":true,"default":"0","description":"0 to not blur, 1 to blur (blur-in for fade-in, blur-out for fade-out)","type_expr":"Number","text":"blur: Number - (Optional, default 0) 0 to not blur, 1 to blur (blur-in for fade-in, blur-out for fade-out)"},{"name":"music","type":"String","optional":true,"default":"\"\"","description":"**only for fade-out** music class name defined in CfgMusic","type_expr":"String","text":"music: String - (Optional, default \"\") **only for fade-out** music class name defined in CfgMusic"},{"name":"ending","type":"String","optional":true,"default":"\"\"","description":"\"\" to not end the mission, else a value compatible with endMission or failMission. **Will end mission only for the local player**","type_expr":"String","text":"ending: String - (Optional, default \"\") \"\" to not end the mission, else a value compatible with endMission or failMission. **Will end mission only for the local player**"},{"name":"success","type":"Number","optional":true,"default":"1","description":"**if *ending* != \"\"** 1 to end mission with success, 0 to fail mission","type_expr":"Number","text":"success: Number - (Optional, default 1) **if *ending* != \"\"** 1 to end mission with success, 0 to fail mission"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[1, \"WHITE\", 5, 1] spawn BIS_fnc_fadeEffect;"]}],"see_also":["endMission","failMission","BIS_fnc_endMission","BIS_fnc_endMissionServer","titleCut"]},{"name":"BIS_fnc_fatigueEffect","title":"BIS fnc fatigueEffect","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_fatigueEffect","revid":309345,"updated":"2022-05-05T12:04:30Z","groups":["Feedback"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Effects for high fatigue values. Internal engine use only, as it relies on internal BIS_* variables.","syntaxes":[{"syntax":"call BIS_fnc_fatigueEffect","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_fatigueEffect;"]}]},{"name":"BIS_fnc_feedbackInit","title":"BIS fnc feedbackInit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_feedbackInit","revid":327500,"updated":"2022-07-12T22:24:51Z","groups":["Feedback"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Init function for feedback system. Declaration of variables, eventhandlers, etc. for in-game effects. Engine use only.","syntaxes":[{"syntax":"call BIS_fnc_feedbackInit","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_feedbackInit;"]}],"see_also":["Post Process Effects"]},{"name":"BIS_fnc_feedbackMain","title":"BIS fnc feedbackMain","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_feedbackMain","revid":327275,"updated":"2022-07-12T22:11:51Z","groups":["Feedback"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Main feedback FSM, used for feedback effects (fatigue, drowning, injury etc.). Internal use only.","syntaxes":[{"syntax":"[] call BIS_fnc_feedbackMain","params":[],"returns":{"type":"Number","type_expr":"Number","description":"? (execFSM)","text":"Number? (execFSM)"}}],"examples":[{"code":["[] call BIS_fnc_feedbackMain;"]}],"see_also":["FSM"]},{"name":"BIS_fnc_ffvUpdate","title":"BIS fnc ffvUpdate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_ffvUpdate","revid":327742,"updated":"2022-07-13T10:45:35Z","groups":["Vehicles"],"status":"ok","games":{"arma3":"1.34"},"since":"arma3 1.34","arma3_since":"1.34","description":"Update Firing From Vehicle feature depending on condition defined in turret's config.","syntaxes":[{"syntax":"vehicle call BIS_fnc_ffvUpdate","params":[{"name":"vehicle","type":"Object","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"```sqf\nif (local _vehicle) then\n{\n    _vehicle animate [\"Door_1\", 1];\n    _vehicle call BIS_fnc_ffvUpdate;\n};\n```","code":["if (local _vehicle) then\n{\n\t_vehicle animate [\"Door_1\", 1];\n\t_vehicle call BIS_fnc_ffvUpdate;\n};"]}]},{"name":"BIS_fnc_filterString","title":"BIS fnc filterString","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_filterString","revid":327982,"updated":"2022-07-13T15:22:00Z","groups":["Strings"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Removes characters from a string based on the list of allowed characters.","syntaxes":[{"syntax":"[text, allowedChars] call BIS_fnc_filterString","params":[{"name":"text","type":": String","description":"text to filter","type_expr":"String","text":"**text:**: String - text to filter"},{"name":"allowedChars","type":"String","optional":true,"default":"a..z, A..Z, 0..9, \"_\"","description":"allowed characters","type_expr":"String","text":"**allowedChars**: String - (Optional, default a..z, A..Z, 0..9, \"_\") allowed characters"}],"returns":{"type":"String","type_expr":"String","description":"filtered text with only the allowed characters supplied in the filter."}}],"examples":[{"code":["[\"Player 1 @%!@$\"] call BIS_fnc_filterString; // returns \"Player1\""]},{"code":["[\"Player 1\", \"aelrPy\"] call BIS_fnc_filterString; // returns \"Player\""]}],"see_also":["find","BIS_fnc_inString","splitString","joinString"]},{"name":"BIS_fnc_findAllNestedElements","title":"BIS fnc findAllNestedElements","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_findAllNestedElements","revid":327526,"updated":"2022-07-12T22:33:34Z","groups":["Arrays"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns array of paths to all matching elements in deeply nested array, similar to BIS_fnc_findNestedElement but with all occurences.","syntaxes":[{"syntax":"[array, query] call BIS_fnc_findAllNestedElements","params":[{"name":"array","type":"Array","description":"array to explore","type_expr":"Array"},{"name":"query","type":"Anything","description":"wanted item","type_expr":"Anything"}],"returns":{"type":"Array of Array of Numbers","type_expr":"Array<Array<Number>>","description":"path to the first occurence of query","text":"Array of Array of Numbers - path to the first occurence of *query*"}}],"examples":[{"code":["private _array = [[1, 2, 3], [[1, 2, 3], 1, 2, 3]];\n_result = [_array, 2] call BIS_fnc_findAllNestedElements; // returns [[0, 1], [1, 0, 1], [1, 2]]"]}],"see_also":["BIS_fnc_findNestedElement","BIS_fnc_removeNestedElement","BIS_fnc_returnNestedElement","BIS_fnc_setNestedElement"]},{"name":"BIS_fnc_findExtreme","title":"BIS fnc findExtreme","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_findExtreme","revid":327983,"updated":"2022-07-13T15:22:38Z","groups":["Arrays","Math"],"status":"ok","games":{"arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2oa 1.50","arma3_since":"0.50","description":"Returns the minimum or maximum value in an array of numbers.","syntaxes":[{"syntax":"[numbers, mode] call BIS_fnc_findExtreme","params":[{"name":"numbers","type":"Array","description":"a set of numbers","type_expr":"Array"},{"name":"mode","type":"Number","description":"0 (find minimum) or 1 (find maximum)","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number"}}],"examples":[{"code":["private _result = [[1,4,5,8,3,7], 1] call BIS_fnc_findExtreme; // returns 8\n_result = [[1,4,5,8,3,7], 0] call BIS_fnc_findExtreme; // returns 1"]}],"see_also":["BIS_fnc_lowestNum","BIS_fnc_greatestNum","selectMin","selectMax"]},{"name":"BIS_fnc_findInPairs","title":"BIS fnc findInPairs","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_findInPairs","revid":348806,"updated":"2023-11-08T14:37:38Z","groups":["Arrays"],"status":"ok","games":{"arma3":"0.76"},"since":"arma3 0.76","arma3_since":"0.76","description":"Searches the associative array for the first occurance of the key string and returns its index. Seach is not case-sensitive.","syntaxes":[{"syntax":"[array, key] call BIS_fnc_findInPairs","params":[{"name":"array","type":"Array","description":"array to search through","type_expr":"Array"},{"name":"key","type":"String","description":"key to search for","type_expr":"String"}],"returns":{"type":"Number","type_expr":"Number","description":"index of first occurence"}}],"examples":[{"code":["[[[\"apple\",3],[\"pear\",2]],\"apple\"] call BIS_fnc_findInPairs; // Returns 0"]}],"see_also":["find","findIf","BIS_fnc_getFromPairs","BIS_fnc_addToPairs","BIS_fnc_removeFromPairs","BIS_fnc_setToPairs"]},{"name":"BIS_fnc_findLookAt","title":"BIS fnc findLookAt","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_findLookAt","revid":274091,"updated":"2021-06-13T01:16:28Z","groups":["Vectors","Object Manipulation"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Given target location, calculates orientation vectors facing direction","syntaxes":[{"syntax":"[] call BIS_fnc_findLookAt","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object     - The curve","source":"docblock"}],"returns":{"type":"Array","type_expr":"Array","description":"In format [Dir Vector, Up Vector]","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nGiven target location, calculates orientation vectors facing direction\n\nParameter(s):\n_this select 0: Object     - The curve\n\nReturns:\nArray - In format [Dir Vector, Up Vector]","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_findNestedElement","title":"BIS fnc findNestedElement","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_findNestedElement","revid":327731,"updated":"2022-07-13T10:17:58Z","groups":["Arrays"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Function to find item in nested arrays and return a path to the first match.\n\n> [!NOTE]\n> **Arma 3:** In some cases findIf might be the better way of finding a nested element. It is a lot faster!","syntaxes":[{"syntax":"[array, query] call BIS_fnc_findNestedElement","params":[{"name":"array","type":"Array","description":"array to explore","type_expr":"Array"},{"name":"query","type":"Anything","description":"wanted item","type_expr":"Anything"}],"returns":{"type":"Array of Numbers","type_expr":"Array<Number>","description":"path to the first occurence of query","text":"Array of Numbers - path to the first occurence of *query*"}}],"examples":[{"code":["private _array = [[1, 2], [3, 4]];\n_path = [_array, 3] call BIS_fnc_findNestedElement; // expected result: [1, 0]\n// ((_array select 1) select 0) == 3"]}],"see_also":["BIS_fnc_findAllNestedElements","BIS_fnc_removeNestedElement","BIS_fnc_returnNestedElement","BIS_fnc_setNestedElement"]},{"name":"BIS_fnc_findOverwatch","title":"BIS fnc findOverwatch","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_findOverwatch","revid":327931,"updated":"2022-07-13T12:32:03Z","groups":["Positions"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Selects a position that provides overwatch onto another position.","syntaxes":[{"syntax":"[target, maxDistance, minDistance, minHeightAbove, searchCentre] call BIS_fnc_findOverwatch","params":[{"name":"target","type":"Position3D","description":"**not** an object","type_expr":"Position3D"},{"name":"maxDistance","type":"Number","optional":true,"default":"500","description":"maximum distance from target in meters","type_expr":"Number","text":"maxDistance: Number - (Optional, default 500) maximum distance from target in meters"},{"name":"minDistance","type":"Number","optional":true,"default":"100","description":"minimum distance from target in meters","type_expr":"Number","text":"minDistance: Number - (Optional, default 100) minimum distance from target in meters"},{"name":"minHeightAbove","type":"Number","optional":true,"default":"50","description":"minimum height in relation to target in meters","type_expr":"Number","text":"minHeightAbove: Number - (Optional, default 50) minimum height in relation to target in meters"},{"name":"searchCentre","type":"Position3D","optional":true,"default":"target","description":"position to start looking from, if different from target pos","type_expr":"Position3D","text":"searchCentre: Position3D - (Optional, default *target*) position to start looking from, if different from target pos"}],"returns":{"type":"Position","type_expr":"Position","description":"target position if no result were found","text":"Position - *target* position if no result were found"}}],"examples":[{"code":["[getPosATL enemyTank, 300, 75, 20, getPosATL player] call BIS_fnc_findOverwatch;"]}],"see_also":["BIS_fnc_findSafePos"],"notes":[{"user":"Tankbuster","date":"2018-10-19T21:40:00Z","text":"Note that this function returns a 2D position, that is, an array containing an x and a y value, but no z (no altitude)."},{"user":"Tankbuster","date":"2020-04-15T13:53:00Z","text":"Further note that when this function fails to find an overwatch position and returns the *target*, the x and y components will be exactly the same, but the z might not be."}]},{"name":"BIS_fnc_findSafePos","title":"BIS fnc findSafePos","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_findSafePos","revid":379266,"updated":"2026-10-30T23:43:39Z","groups":["Positions"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"This function generates position on a map according to several given parameters (see diagram).\n\nThe position **pos** will be generated inside an area which resides between **minDist** and **maxDist** from the given **center**. If **objDist** is also specified, the position will be selected **objDist** away from nearest terrain object. If **maxGrad** > 0 then the position will be also checked for how flat the area around is within **objDist** radius. The function can additionally be instructed to generate position specifically on water or land (**waterMode**) or on a shoreline (**shoreMode**). The **shoreLine** param will be ignored if position is not requested specifically on land.\n\nAdditionally, generated position could be checked against the list of blacklisted positions **blacklistPos**. If search for suitable position failed, **defaultPos** position will be used. The format for **defaultPos** is array with 2 positions: [posOnLand, posOnWater].","syntaxes":[{"syntax":"[center, minDist, maxDist, objDist, waterMode, maxGrad, shoreMode, blacklistPos, defaultPos] call BIS_fnc_findSafePos","params":[{"name":"center","type":"Array, Object or Nothing","optional":true,"default":"`[]`","description":"center position. Can be one of:\n\n- Array - position in format Position2D or Position3D\n- Object - object which position will be used\n- Nothing - when passing empty array [] or nothing, the world's \"safePositionAnchor\" entry will be used","type_expr":"Array | Object | Nothing","text":"center: Array, Object or Nothing - (Optional, default `[]`) center position. Can be one of:\n\n- Array - position in format Position2D or Position3D\n- Object - object which position will be used\n- Nothing - when passing empty array [] or nothing, the world's \"safePositionAnchor\" entry will be used"},{"name":"minDist","type":"Number","optional":true,"default":"0","description":"minimum distance from the center position","type_expr":"Number","text":"minDist: Number - (Optional, default 0) minimum distance from the center position"},{"name":"maxDist","type":"Number","optional":true,"default":"-1","description":"maximum distance from the center position. If -1, the world's \"safePositionRadius\" entry will be used","type_expr":"Number","text":"maxDist: Number - (Optional, default -1) maximum distance from the center position. If -1, the world's \"safePositionRadius\" entry will be used"},{"name":"objDist","type":"Number","optional":true,"default":"0","description":"minimum distance from the resulting position to the center of nearest object. Specifying quite large distance here will slow the function and might often fail to find suitable position. Recommended value: 0..10","type_expr":"Number","text":"objDist: Number - (Optional, default 0) minimum distance from the resulting position to the center of nearest object. Specifying quite large distance here will slow the function and might often fail to find suitable position. Recommended value: 0..10"},{"name":"waterMode","type":"Number","optional":true,"default":"0","description":"water mode. Can be one of:\n\n- 0 - cannot be in water\n- 1 - can either be in water or not\n- 2 - must be in water","type_expr":"Number","text":"waterMode: Number - (Optional, default 0) water mode. Can be one of:\n\n- 0 - cannot be in water\n- 1 - can either be in water or not\n- 2 - must be in water"},{"name":"maxGrad","type":"Number","optional":true,"default":"0","description":"maximum terrain gradient (hill steepness). A quite small non-zero value could result in failure to find suitable position. Recommended: 0.1+","type_expr":"Number","text":"maxGrad: Number - (Optional, default 0) maximum terrain gradient (hill steepness). A quite small non-zero value could result in failure to find suitable position. Recommended: 0.1+"},{"name":"shoreMode","type":"Number","optional":true,"default":"0","description":"shore mode. Can be one of:\n\n- 0 - does not have to be at a shore\n- 1 - must be at a shore","type_expr":"Number","text":"shoreMode: Number - (Optional, default 0) shore mode. Can be one of:\n\n- 0 - does not have to be at a shore\n- 1 - must be at a shore"},{"name":"blacklistPos","type":"Array","optional":true,"default":"`[]`","description":"list of blacklisted areas in format [area1, area2, area3... areaN]. Can be one of:\n\n- Array - in format [topLeftCorner, bottomRightCorner] - top and bottom coordinates of blacklisted area\n- Object - trigger area\n- String - marker area\n- Location - location\n- Array - array in format [center, distance] or [center, a, b, angle, rect] or [center, a, b, angle, rect, height]","type_expr":"Array","text":"blacklistPos: Array - (Optional, default `[]`) list of blacklisted areas in format [area1, area2, area3... areaN]. Can be one of:\n\n- Array - in format [topLeftCorner, bottomRightCorner] - top and bottom coordinates of blacklisted area\n- Object - trigger area\n- String - marker area\n- Location - location\n- Array - array in format [center, distance] or [center, a, b, angle, rect] or [center, a, b, angle, rect, height]"},{"name":"defaultPos","type":"Array","optional":true,"default":"`[]`","description":"default position when no position is found. Array format is [landPosition, seaPosition], where:\n\n- landPosition: Array - in format [x,y] or [x,y,z] - default position on land\n- seaPosition: Array - in format [x,y] or [x,y,z] - default position on water","type_expr":"Array","text":"defaultPos: Array - (Optional, default `[]`) default position when no position is found. Array format is [landPosition, seaPosition], where:\n\n- landPosition: Array - in format [x,y] or [x,y,z] - default position on land\n- seaPosition: Array - in format [x,y] or [x,y,z] - default position on water"}],"returns":{"type":"Array","type_expr":"Array","description":"in format [x,y] on success. When position cannot be found at all, default map center position is returned, which will be in format [x,y,0]"}}],"examples":[{"text":"Find position minimum 1m from from player but not further than 150m, not closer than 3m to any other object, not in the water, maximum gradient of 20, not on the shoreline:\n\n```sqf\nprivate _pos = [player, 1, 150, 3, 0, 20, 0] call BIS_fnc_findSafePos;\n```","code":["private _pos = [player, 1, 150, 3, 0, 20, 0] call BIS_fnc_findSafePos;"]},{"code":["private _pos = [getPos player, 2000, 5000, 1, 0, 0.7, 0, [], [getPos player, getPos player]] call BIS_fnc_findSafePos;"]},{"code":["private _pos = [[], 0, 1000] call BIS_fnc_findSafePos;"]}],"see_also":["BIS_fnc_randomPosTrigger","BIS_fnc_randomPos"],"notes":[{"user":"Killzone_Kid","date":"2017-03-15T19:30:00Z","text":"To make sure position is not inside a building, increase distance to nearest object param."},{"user":"AgentRev","date":"2021-09-24T22:23:05Z","text":"If *objDist* > 0, this function will unfortunately treat all roads and trails seen on the map as obstacles to avoid, due to its unfiltered usage of nearestTerrainObjects."}]},{"name":"BIS_fnc_finishCuratorChallenge","title":"BIS fnc finishCuratorChallenge","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_finishCuratorChallenge","revid":379267,"updated":"2026-10-30T23:43:47Z","groups":["CuratorChallenges"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Handle repeated curator challenges.\nWhen rewards defined in the argument are exceeded, refilling points bar fill be offered instead. Number of challenges can be retrieved by","syntaxes":[{"syntax":"[curator,input,taskState]] call BIS_fnc_finishCuratorChallenge","params":[{"name":"curator","type":"Object","description":"curator","type_expr":"Object"},{"name":"input","type":"Array","description":"array in format:\n\n- 0: String - Challenge class name\n- 1: Object - Curator","type_expr":"Array"},{"name":"taskState","type":"String","description":"task state, can be:\n\n- \"SUCCEEDED\"\n- \"FAILED\"\n- \"CANCELED\"\n- \"ASSIGNED\"","type_expr":"String"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[BIS_curator,[\"DestroyVehicle\",BIS_curator],\"SUCCEEDED\"] call BIS_fnc_finishCuratorChallenge;\n_number = BIS_curator getVariable \"DestroyVehicle\";"]}],"see_also":["Arma 3: Curator","BIS_fnc_formatCuratorChallengeObjects","BIS_fnc_manageCuratorChallenges","BIS_fnc_addCuratorChallenge"]},{"name":"BIS_fnc_fire","title":"BIS fnc fire","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_fire","revid":347331,"updated":"2023-09-11T00:28:50Z","groups":["Weapons","Object Manipulation","Combat"],"status":"ok","games":{"arma3":"1.74"},"since":"arma3 1.74","arma3_since":"1.74","locality":{"argument":"global","effect":"global"},"description":"Makes a unit or a vehicle fire given muzzle. Make sure that there is some ammo to fire, and, in case of a unit, the weapon with given muzzle is already selected. It can be used to fire pretty much any muzzle on unit or vehicle from anywhere. Available weapons could usually be found with weapons, weaponsTurret and allTurrets commands.","syntaxes":[{"syntax":"[entity, muzzle, turret] call BIS_fnc_fire","params":[{"name":"entity","type":"Object","description":"unit or vehicle","type_expr":"Object"},{"name":"muzzle","type":"String","description":"muzzle name of the muzzle to fire","type_expr":"String"},{"name":"turret","type":"Array","optional":true,"description":"turret path of the turret with given muzzle (vehicles only)","type_expr":"Array","text":"turret: Array - (Optional) turret path of the turret with given muzzle (vehicles only)"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"in SP and on hosted server in MP or Nothing on client in MP. When boolean, true if all checks have passed and muzzle should have fired, false if there was a problem, like:\n- no ammo - non-existing muzzle - the muzzle is on a weapon that is not selected - the weapon has no unit operating it","text":"Boolean - in SP and on hosted server in MP or Nothing on client in MP. When boolean, true if all checks have passed and muzzle should have fired, false if there was a problem, like:\n\n- no ammo\n- non-existing muzzle\n- the muzzle is on a weapon that is not selected\n- the weapon has no unit operating it"}}],"examples":[{"code":["marshall = \"B_APC_Wheeled_01_cannon_F\" createVehicle position player;\ncreateVehicleCrew marshall;\n\n[marshall, \"HE\"] call BIS_fnc_fire; // fires HE muzzle of the main cannon\n[marshall, \"AP\"] call BIS_fnc_fire; // fires AP muzzle of the main cannon\n[marshall, \"autocannon_40mm_CTWS\"] call BIS_fnc_fire; // fires HE muzzle, because it is default\n[marshall, \"LMG_M200_body\"] call BIS_fnc_fire; // fires machine gun\n[marshall, \"SmokeLauncher\"] call BIS_fnc_fire; // fires smoke launcher\n[marshall, \"TruckHorn\"] call BIS_fnc_fire; // beeps the horn"]},{"code":["[bob, \"SmokeShellMuzzle\"] call BIS_fnc_fire;  // bob throws smoke grenade, if he has one\n[bob, \"HandGrenadeMuzzle\"] call BIS_fnc_fire; // bob throws hand grenade, if he has one"]},{"code":["blackfoot = \"B_Heli_Attack_01_dynamicLoadout_F\" createVehicle position player;\ncreateVehicleCrew blackfoot;\n\n[blackfoot, \"missiles_DAGR\"]   call BIS_fnc_fire; // fires missiles\n[blackfoot, \"missiles_ASRAAM\"] call BIS_fnc_fire; // fires missiles\n[blackfoot, \"gatling_20mm\"]    call BIS_fnc_fire; // fires machine gun\n[blackfoot, \"CMFlareLauncher\"] call BIS_fnc_fire; // fires chaff"]},{"code":["[vehicle mortargunner, \"mortar_82mm\"] call BIS_fnc_fire; // mortargunner fires mortar"]}],"multiplayer":"The function is global, it is not to be used in unit fields.","problems":"unit will not fire its weapon from FFV position. This is due to forceWeaponFire command ignoring units in FFV.","see_also":["fire","fireAtTarget","forceWeaponFire"]},{"name":"BIS_fnc_firedBombDemine","title":"BIS fnc firedBombDemine","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_firedBombDemine","revid":309858,"updated":"2022-05-05T12:09:53Z","groups":["Scripts"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Function used inside the IDAP showcase.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_fireSupport","title":"BIS fnc fireSupport","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_fireSupport","revid":349210,"updated":"2023-11-08T14:50:46Z","groups":["Supports","Combat"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Mortar/artillery fire support.","syntaxes":[{"syntax":"[arty,target,mag,radius,rounds,delay,conditionEnd,safezone] spawn BIS_fnc_fireSupport","params":[{"name":"arty","type":"Object","description":"artillery unit.","type_expr":"Object"},{"name":"target","type":"Position or Object or String","description":"target position, can be object/position 3D or marker name","type_expr":"Position | Object | String"},{"name":"mag","type":"String","description":"magazine (if left empy, first magazine available will be used)","type_expr":"String"},{"name":"radius","type":"Number","description":"radius of target area in meters","type_expr":"Number"},{"name":"rounds","type":"Number","description":"number of rounds to be fired","type_expr":"Number"},{"name":"delay","type":"Array or Number","description":"delay between rounds:\n\n- Array\n  - 1: Min delay\n  - 2: Max delay\n- Number - Precise delay","type_expr":"Array | Number"},{"name":"conditionEnd","type":"Code","description":"condition to end bombardment before all rounds are fired","type_expr":"Code"},{"name":"safezone","type":"Number","description":"safezone radius - minimal distance from the target position where shells may be directed at","type_expr":"Number"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if successful"}}],"examples":[{"code":["[BIS_Mortar, [3600,3600,0], \"\", 100, 24, 10] spawn BIS_fnc_fireSupport;"]},{"code":["[BIS_Mortar, BIS_Player, \"8Rnd_82mm_Mo_shells\", 100, 24, 10] spawn BIS_fnc_fireSupport;"]},{"code":["[BIS_Mortar, \"BIS_mrkTargetArea\", \"8Rnd_82mm_Mo_shells\", 100, 24, 10, { BIS_Player distance BIS_EscapeZone < 100 }] spawn BIS_fnc_fireSupport;"]}],"see_also":["BIS_fnc_fireSupportCluster","BIS_fnc_fire","BIS_fnc_fireSupportVirtual"]},{"name":"BIS_fnc_fireSupportCluster","title":"BIS fnc fireSupportCluster","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_fireSupportCluster","revid":348400,"updated":"2023-11-08T13:00:03Z","groups":["Supports"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","exec":"spawn","description":"Virtual fire support - cluster shell.","syntaxes":[{"syntax":"[position,ammo,radius,rounds,delay,conditionEnd,safezone,altitude,velocity,sounds] spawn BIS_fnc_fireSupportCluster","params":[{"name":"position","type":"Position, Object or String","description":"can be position, an object, or a marker","type_expr":"Position | Object | String"},{"name":"ammo","type":"String","optional":true,"default":"\"G_40mm_HEDP\"","description":"ammunition class, nil or empty string to use 40mm HEDP shells","type_expr":"String","text":"ammo: String - (Optional, default \"G_40mm_HEDP\") ammunition class, nil or empty string to use 40mm HEDP shells"},{"name":"radius","type":"Number","optional":true,"default":"100","description":"radius of the area in metres","type_expr":"Number","text":"radius: Number - (Optional, default 100) radius of the area in metres"},{"name":"rounds","type":"Array","optional":true,"default":"[1,20]","description":"number of rounds to be fired, can be:\n\n- 0: Number of shells\n- 1: Number of submunition","type_expr":"Array","text":"rounds: Array - (Optional, default [1,20]) number of rounds to be fired, can be:\n\n- 0: Number of shells\n- 1: Number of submunition"},{"name":"delay","type":"Array or Number","optional":true,"default":"10","description":"delay between rounds in seconds, can be Number for precise delay or Array to set min and max delay","type_expr":"Array | Number","text":"delay: Array or Number - (Optional, default 10) delay between rounds in seconds, can be Number for precise delay or Array to set min and max delay"},{"name":"conditionEnd","type":"Code","optional":true,"default":"{}","description":"condition to end fire support","type_expr":"Code","text":"conditionEnd: Code - (Optional, default {}) condition to end fire support"},{"name":"safeZone","type":"Number","optional":true,"default":"0","description":"safezone radius in metres","type_expr":"Number","text":"safeZone: Number - (Optional, default 0) safezone radius in metres"},{"name":"altitude","type":"Number","optional":true,"default":"100","description":"altitude in metres where the submunition will be spawned","type_expr":"Number","text":"altitude: Number - (Optional, default 100) altitude in metres where the submunition will be spawned"},{"name":"velocity","type":"Number","optional":true,"default":"100","description":"descending velocity, in m/s","type_expr":"Number","text":"velocity: Number - (Optional, default 100) descending velocity, in m/s"},{"name":"sounds","type":"Array","optional":true,"default":"[\"\"]","description":"strings of sounds to be played on the incoming submunition","type_expr":"Array","text":"sounds: Array - (Optional, default [\"\"]) strings of sounds to be played on the incoming submunition"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[BIS_Player, \"G_40mm_HEDP\", 100, [4,10], 10] spawn BIS_fnc_fireSupportCluster;"]},{"code":["[BIS_Victim,\"G_40mm_HEDP\", 100, [5,25], 10, { dayTime > 20 }, 75, 500, 150, [\"shell1\", \"shell2\"]] spawn BIS_fnc_fireSupportCluster;"]},{"code":["[\"BIS_mrkTargetArea\", \"\", 100, [4,10], 10, { BIS_Player distance BIS_EscapeZone < 100 }] spawn BIS_fnc_fireSupportCluster;"]}],"see_also":["BIS_fnc_fireSupport","BIS_fnc_fireSupportVirtual"]},{"name":"BIS_fnc_fireSupportVirtual","title":"BIS fnc fireSupportVirtual","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_fireSupportVirtual","revid":349184,"updated":"2023-11-08T14:50:39Z","groups":["Supports"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","exec":"spawn","description":"Fires virtual mortar/artillery fire support.","syntaxes":[{"syntax":"[target, ammo, radius, rounds, delay, conditionEnd, safezone, alt, speed, sounds] spawn BIS_fnc_fireSupportVirtual","params":[{"name":"target","type":"Position, Object or String","description":"target position, can be object, position or marker name","type_expr":"Position | Object | String"},{"name":"ammo","type":"String","optional":true,"default":"\"Sh_82mm_AMOS\"","description":"ammunition to be used (if left empty, `Sh_82mm_AMOS` ammunition will be used)","type_expr":"String","text":"ammo: String - (Optional, default \"Sh_82mm_AMOS\") ammunition to be used (if left empty, `Sh_82mm_AMOS` ammunition will be used)"},{"name":"radius","type":"Number","optional":true,"default":"100","description":"radius of target area in meters","type_expr":"Number","text":"radius: Number - (Optional, default 100) radius of target area in meters"},{"name":"rounds","type":"Number","optional":true,"default":"10","description":"number of rounds to be fired","type_expr":"Number","text":"rounds: Number - (Optional, default 10) number of rounds to be fired"},{"name":"delay","type":"Array or Number","optional":true,"default":"10","description":"delay between rounds\n\n- Array [min, max]:\n  - min: Number - min delay\n  - max: Number - max delay\n- Number - Precise delay","type_expr":"Array | Number","text":"delay: Array or Number - (Optional, default 10) delay between rounds\n\n- Array [min, max]:\n  - min: Number - min delay\n  - max: Number - max delay\n- Number - Precise delay"},{"name":"conditionEnd","type":"Code","optional":true,"default":"`{ false }`","description":"condition to end bombardment before all rounds are fired","type_expr":"Code","text":"conditionEnd: Code - (Optional, default `{ false }`) condition to end bombardment before all rounds are fired"},{"name":"safezone","type":"Number","optional":true,"default":"0","description":"safezone radius - minimal distance from the target position where shells may be directed at","type_expr":"Number","text":"safezone: Number - (Optional, default 0) safezone radius - minimal distance from the target position where shells may be directed at"},{"name":"alt","type":"Number","optional":true,"default":"250","description":"altitude where the shell will be created","type_expr":"Number","text":"alt: Number - (Optional, default 250) altitude where the shell will be created"},{"name":"speed","type":"Number","optional":true,"default":"150","description":"descending velocity, in m/s. If you use flare as ammo, set it to lower value (1-5) to let it fall down slowly","type_expr":"Number","text":"speed: Number - (Optional, default 150) descending velocity, in m/s. Default is 150, if you use flare as ammo, set it to lower value (1-5) to let it fall down slowly"},{"name":"sounds","type":"Array of Strings","optional":true,"default":"[\"\"]","description":"sounds to be played on the incoming shell","type_expr":"Array<String>","text":"sounds: Array of Strings - (Optional, default [\"\"]) sounds to be played on the incoming shell"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if successful"}}],"examples":[{"code":["[BIS_Player, \"Sh_82mm_AMOS\", 100, 24, 10] spawn BIS_fnc_fireSupportVirtual;"]},{"code":["[[3600, 3600, 0], nil, 100, 24, 10] spawn BIS_fnc_fireSupportVirtual;"]},{"code":["[BIS_Player, nil, 100, 24, 10, {dayTime > 20}, 50] spawn BIS_fnc_fireSupportVirtual;"]}],"see_also":["BIS_fnc_fireSupport","BIS_fnc_fireSupportCluster","BIS_fnc_fire"]},{"name":"BIS_fnc_fixDate","title":"BIS fnc fixDate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_fixDate","revid":329336,"updated":"2022-07-27T10:16:56Z","groups":["Math","Environment"],"status":"ok","games":{"arma3":"1.10"},"since":"arma3 1.10","arma3_since":"1.10","description":"Checks the array with date data and makes sure the values are within the boundries.","syntaxes":[{"syntax":"date call BIS_fnc_fixDate","params":[{"name":"date","type":"Array format Date","description":"date to be checked","type_expr":"Date","types":["Array","Date"]}],"returns":{"type":"Array format Date","types":["Array","Date"],"type_expr":"Date","description":"resulting date"}}],"examples":[{"code":["private _fixedDate = [2033, -2, 89, 25, 75] call BIS_fnc_fixDate;"]}],"see_also":["date","setDate"]},{"name":"BIS_fnc_flamesEffect","title":"BIS fnc flamesEffect","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_flamesEffect","revid":309325,"updated":"2022-05-05T12:04:28Z","groups":["Feedback"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Flames (texture) postprocess.","syntaxes":[{"syntax":"call BIS_fnc_flamesEffect","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_flamesEffect;"]}],"see_also":["BIS_fnc_dirtEffect"]},{"name":"BIS_fnc_flies","title":"BIS fnc flies","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_flies","revid":348815,"updated":"2023-11-08T14:38:17Z","groups":["Environment"],"status":"ok","games":{"arma2oa":"1.56","tkoh":"1.00","arma3":"0.50"},"since":"arma2oa 1.56","arma3_since":"0.50","locality":{"effect":"local"},"description":"Spawns flies around position.","syntaxes":[{"syntax":"[position, interval, areaSize] call BIS_fnc_flies","params":[{"name":"position","type":"Array (in format position)","type_expr":"Array"},{"name":"interval","type":"Number","optional":true,"default":"0.1","description":"particle refresh time","type_expr":"Number","text":"interval *(Optional)*: Number - particle refresh time (default is 0.1)"},{"name":"areaSize","type":"Number","optional":true,"default":"1","description":"area radius","type_expr":"Number","text":"areaSize *(Optional)*: Number - area radius (default is 1)"}],"returns":{"type":"Array","type_expr":"Array","description":"list of particle source objects"}}],"examples":[{"code":["private _flies = [position deadBody, 0.05, 1.5] call BIS_fnc_flies;"]}],"see_also":["Functions Library"]},{"name":"BIS_fnc_forceCuratorInterface","title":"BIS fnc forceCuratorInterface","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_forceCuratorInterface","revid":349418,"updated":"2023-11-08T16:27:32Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Force curator interface, so user cannot exit it by pressing Zeus key.","syntaxes":[{"syntax":"[mode, waitUntil] call BIS_fnc_forceCuratorInterface","params":[{"name":"mode","type":"Boolean","description":"true to force","type_expr":"Boolean"},{"name":"waitUntil","type":"Boolean","optional":true,"default":"false","description":"true to keep trying until the interface is actually opened","type_expr":"Boolean","text":"waitUntil: Boolean - (Optional, default false) - true to keep trying until the interface is actually opened"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[true, true] call BIS_fnc_forceCuratorInterface;"]}],"see_also":["Arma 3: Curator"]},{"name":"BIS_fnc_forceEnd","title":"BIS fnc forceEnd","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_forceEnd","revid":309797,"updated":"2022-05-05T12:09:50Z","groups":["Missions"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_formatCuratorChallengeObjects","title":"BIS fnc formatCuratorChallengeObjects","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_formatCuratorChallengeObjects","revid":348646,"updated":"2023-11-08T13:48:23Z","groups":["CuratorChallenges"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Format the list of objects compatible with curator challenge to be displayed in the task descriptipon.","syntaxes":[{"syntax":"classes call BIS_fnc_formatCuratorChallengeObjects","params":[{"name":"classes","type":"Array of Strings","description":"CfgVehicle classes","type_expr":"Array<String>"}],"returns":{"type":"String","type_expr":"String"}}],"examples":[{"code":["[\"class_1\",\"class_2\"] call BIS_fnc_formatCuratorChallengeObjects;"]}],"see_also":["Arma 3: Curator","BIS_fnc_manageCuratorChallenges","BIS_fnc_finishCuratorChallenge","BIS_fnc_addCuratorChallenge"]},{"name":"BIS_fnc_fps","title":"BIS fnc fps","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_fps","revid":370886,"updated":"2025-02-21T10:44:04Z","groups":["Diagnostic"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","locality":{"effect":"local"},"description":"Function to measure FPS. Spawns code running for given time and displays result on screen via titleText, globalChat **and** diag_log.\nVariable **BIS_fps_output** is filled with diag_log content too.","syntaxes":[{"syntax":"[duration, sceneId, startDelay] call BIS_fnc_fps","params":[{"name":"duration","type":"Number","description":"the FPS test duration","type_expr":"Number"},{"name":"sceneId","type":"String","optional":true,"default":"\"\"","description":"scene ID, used in outputs. Fills global variable **currentScene**","type_expr":"String","text":"sceneId: String - (Optional, default \"\") scene ID, used in outputs. Fills global variable **currentScene**"},{"name":"startDelay","type":"Number","optional":true,"default":"0","description":"delay before starting measurement","type_expr":"Number","text":"startDelay: Number - (Optional, default 0) delay before starting measurement"}],"returns":{"type":"Script Handle","type_expr":"Script Handle"}}],"examples":[{"code":["private _scriptHandle = [10, \"50 units on screen\", 3] call BIS_fnc_fps;"]}],"see_also":["diag_fps","diag_fpsMin","diag_frameNo","diag_tickTime"]},{"name":"BIS_fnc_friendlySides","title":"BIS fnc friendlySides","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_friendlySides","revid":379497,"updated":"2026-10-31T00:26:38Z","groups":["Sides"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns sides allied to the given side / object.","syntaxes":[{"syntax":"toCheck call BIS_fnc_friendlySides","params":[{"name":"toCheck","type":"Side or Object","description":"Side or object whose friendly sides should be returned","type_expr":"Side | Object"}],"returns":{"type":"Array of Sides","type_expr":"Array<Side>"}}],"examples":[{"code":["player call BIS_fnc_friendlySides; // -can- return [FRIENDLY,WEST,GUER,CIV]"]}],"see_also":["CfgVehicles Config Reference","Side","playerSide","west","east","resistance","civilian","sideLogic","sideFriendly","sideEnemy","sideUnknown","sideEmpty","sideAmbientLife","Side Relations","BIS_fnc_sideID","BIS_fnc_objectSide"]},{"name":"BIS_fnc_FTLmanager","title":"BIS fnc FTLmanager","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_FTLmanager","revid":348927,"updated":"2023-11-08T14:44:05Z","groups":["Sides"],"status":"ok","games":{"arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2oa 1.50","arma3_since":"0.50","description":"**FTL** (**F**riendly **T**o **L**ocal) manager tracks relationship between player and civilian side.\n**FTL State** can be one of the following: \"LOW\", \"NEUTRAL\", \"HIGH\". See FriendlyToLocal System.","syntaxes":[{"syntax":"[functionCalled, type] call BIS_fnc_FTLmanager","params":[{"name":"functionCalled","type":"String","description":"one of the following:\n\n- \"Init\" - initialises the FTL manager\n  Return: Number - FTL State\n- \"Destroy\" - destroys the current FTL manager instance\n  Return:\n- \"GetFTLState\" - returns current FTL state\n  Return: String - FTL state: \"LOW\", \"NEUTRAL\" or \"HIGH\"\n- \"SetFTLState\" - computes and sets the new FTLValue and FTLState afterwards\n  Return:\n- \"GetNearestTownRespect\" - Returns nearest (in 500m radius) town respect for player\n  Return: Number - respect","type_expr":"String"},{"name":"type","type":"String","description":"can be one of the following:\n\n- \"sysUpdate\" (internal use)\n- \"NONE\" (no change)\n- \"CivKilled\" (-0.5)\n- \"VIPCivKilled\" (-0.7)\n- \"RebelKilled\" (-0.3)\n- \"TaskSmallRefused\" (-0.05)\n- \"TaskSmallDone\" (+0.4)\n- \"TaskSmallFailed\" (-0.4)\n- \"TaskGreatRefused\" (-0.1)\n- \"TaskGreatDone\" (+0.6)\n- \"TaskGreatFailed\" (-0.6)\n- \"CivHouseDestroyed\" (-0.5)\n- \"GreatHouseDestroyed\" (-0.8)","type_expr":"String"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"false if the manager is not initialised yet"}}],"examples":[{"code":["[\"Init\"] call BIS_fnc_FTLmanager;"]}],"see_also":["FriendlyToLocal System"]},{"name":"BIS_fnc_functionMeta","title":"BIS fnc functionMeta","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_functionMeta","revid":330725,"updated":"2022-11-01T15:16:55Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns function's meta data.","syntaxes":[{"syntax":"functionName call BIS_fnc_functionMeta","params":[{"name":"functionName","type":"String","optional":true,"default":"parent function's name","description":"function name, e.g., \"BIS_fnc_stalk\"","type_expr":"String","text":"functionName: String - (Optional, default parent function's name) function name, e.g., \"BIS_fnc_stalk\""}],"returns":{"type":"Array","type_expr":"Array","description":"to format [fileLocation, extension, headerType, preInit, postInit, recompile, game, category, name]:\n- fileLocation: String - extension: String - to format \".extension\", e.g \".sqf\", \".fsm\" - headerType: Number - one of: - 0: No Debug - header saves parent script name and current script name into variables - 1: Save script Map - header additionaly save an array of all parent scripts into variable - 2: Save and log script map - apart from saving into variable, script map is also logged through debugLog - preInit: Boolean - postInit: Boolean - recompile: Boolean - game: String - category: String - name: String - simple name, without TAG_fnc","text":"Array to format [fileLocation, extension, headerType, preInit, postInit, recompile, game, category, name]:\n\n- fileLocation: String\n- extension: String - to format \".extension\", e.g \".sqf\", \".fsm\"\n- headerType: Number - one of:\n  - 0: No Debug - header saves parent script name and current script name into variables\n  - 1: Save script Map - header additionaly save an array of all parent scripts into variable\n  - 2: Save and log script map - apart from saving into variable, script map is also logged through debugLog\n- preInit: Boolean\n- postInit: Boolean\n- recompile: Boolean\n- game: String\n- category: String\n- name: String - simple name, without TAG_fnc"}}],"examples":[{"code":["// returns [\"A3\\functions_f\\Debug\\fn_functionMeta.sqf\", \".sqf\", 0, false, false, false, \"A3\", \"Debug\", \"functionMeta\"]\n\"BIS_fnc_functionMeta\" call BIS_fnc_functionMeta;"]},{"code":["// returns [\"\", \"\", 0, false, false, false, \"\", \"\", \"\"]\n\"unknownFunction\" call BIS_fnc_functionMeta;"]}],"see_also":["BIS_fnc_exportFunctionsToWiki"]},{"name":"BIS_fnc_functionPath","title":"BIS fnc functionPath","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_functionPath","revid":326933,"updated":"2022-07-12T21:44:39Z","groups":["Diagnostic"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Returns path to function file.","syntaxes":[{"syntax":"functionName call BIS_fnc_functionPath","params":[{"name":"functionName","type":"String","description":"function name (if not defined, name of parent function is used)","type_expr":"String"}],"returns":{"type":"String","type_expr":"String"}}],"examples":[{"code":["private _path = \"BIS_fnc_wpLand\" call BIS_fnc_functionPath;"]}]},{"name":"BIS_fnc_functionsDebug","title":"BIS fnc functionsDebug","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_functionsDebug","revid":325092,"updated":"2022-07-01T12:24:49Z","groups":["Diagnostic"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Changes debug mode used when compiling functions from the Arma 3: Functions Library. Also recompiles all functions. See Arma 3: Functions Library for more information.","syntaxes":[{"syntax":"mode call BIS_fnc_functionsDebug","params":[{"name":"mode","type":"Number","description":"debug mode, can be:\n\n- 0 - no debugging\n- 1 - script map will be saved\n- 2 - script map will be saved and logged","type_expr":"Number"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["2 call BIS_fnc_functionsDebug;"]}],"see_also":["Arma 3: Functions Library"]},{"name":"BIS_fnc_garage","title":"BIS fnc garage","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_garage","revid":349504,"updated":"2023-11-08T17:09:12Z","groups":["Vehicles","Broken Functions"],"status":"broken","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","description":"Splendid™ Virtual Arsenal Garage.","syntaxes":[{"syntax":"[mode, params] call BIS_fnc_garage","params":[{"name":"mode","type":"String","optional":true,"default":"\"Open\"","description":"**case-sensitive**. Can be \"Open\"; other cases are for internal use","type_expr":"String","text":"mode: String - (Optional, default \"Open\") **case-sensitive**. Can be \"Open\"; other cases are for internal use"},{"name":"params","type":"Anything","optional":true,"default":"`[]`","description":"depending on *mode*, can be:\n\n- \"Open\": [fullGarage, garageCentre]\n  - fullGarage: Boolean - (Optional, default false)\n  - garageCentre: Object - (Optional, default objNull) the garage centre as vehicle; will be deleted on opening","type_expr":"Anything","text":"params: Anything - (Optional, default `[]`) depending on *mode*, can be:\n\n- \"Open\": [fullGarage, garageCentre]\n  - fullGarage: Boolean - (Optional, default false)\n  - garageCentre: Object - (Optional, default objNull) the garage centre as vehicle; will be deleted on opening"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[] call BIS_fnc_garage;"]},{"text":"```sqf\nplayer addAction [\"Open Garage\", {\n\n     // create a position 30 meters infront of the player\n    _pos = player getPos [30,getDir player];\n\n    // create empty helipad at the position and save it in the global variable BIS_fnc_garage_center\n    BIS_fnc_garage_center = createVehicle [\"Land_HelipadEmpty_F\", _pos, [], 0, \"CAN_COLLIDE\"];\n\n    [\"Open\", true] call BIS_fnc_garage;\n}];\n```","code":["player addAction [\"Open Garage\", {\n\n \t// create a position 30 meters infront of the player\n\t_pos = player getPos [30,getDir player];\n\n\t// create empty helipad at the position and save it in the global variable BIS_fnc_garage_center\n\tBIS_fnc_garage_center = createVehicle [\"Land_HelipadEmpty_F\", _pos, [], 0, \"CAN_COLLIDE\"];\n\n\t[\"Open\", true] call BIS_fnc_garage;\n}];"]},{"text":"```sqf\nplayer addAction [\"Open Garage\", {\n\n     // create a position 30 meters infront of the player\n    _pos = player getPos [30, getDir player];\n\n    // create empty helipad at the position\n    _vehicle = createVehicle [\"Land_HelipadEmpty_F\", _pos, [], 0, \"CAN_COLLIDE\"];\n\n    // pass created vehicle to function for use as position\n    [\"Open\", [true, _vehicle]] call BIS_fnc_garage;\n}];\n```","code":["player addAction [\"Open Garage\", {\n\n \t// create a position 30 meters infront of the player\n\t_pos = player getPos [30, getDir player];\n\n\t// create empty helipad at the position\n\t_vehicle = createVehicle [\"Land_HelipadEmpty_F\", _pos, [], 0, \"CAN_COLLIDE\"];\n\n\t// pass created vehicle to function for use as position\n\t[\"Open\", [true, _vehicle]] call BIS_fnc_garage;\n}];"]}],"see_also":["BIS_fnc_arsenal","Arsenal"],"notes":[{"user":"Larrow","date":"2015-05-31T07:09:00Z","text":"Available namespace variables\n\n```sqf\nmissionNamespace\n    BIS_fnc_arsenal_center            // copy of BIS_fnc_garage_center\n    BIS_fnc_arsenal_fullGarage        // holds param 1 of \"open\" statement\n    BIS_fnc_arsenal_group            // Group spawned vehicle is created in, default players group\n    BIS_fnc_arsenal_type            // --- 0 - Arsenal, 1 - Garage\n    BIS_fnc_garage_center            // Hold a reference to an OBJECT of where to spawn selected garage vehicle\n    BIS_fnc_garage_centerType        // ? // default selected vehicle model from config\n    BIS_fnc_garage_data                // Array of vehicles for garage tabs - see below\n    BIS_fnc_garage_turretPaths        // ? // []\n\nuiNamespace\n    BIS_fnc_arsenal_cam                // null if arsenal is not open else holds reference to arsenal display\n    BIS_fnc_arsenal_toggleSpace        // ?\n    BIS_fnc_garage_defaultClass        // Default class to display\n    BIS_fnc_garage_stats            // min and max values of config [\"maxspeed\",\"armor\",\"fuelcapacity\",\"threat\"] of cfgVehicles >> crew\n```\n\nAvailable scripted eventHandlers\n\n```sqf\n// [namespace event is stored in, event name, passed variables]\n[missionNamespace, \"garageOpened\", [_display, _toggleSpace]]\n[missionNamespace, \"garageClosed\", [displayNull, uiNamespace getVariable [\"BIS_fnc_arsenal_toggleSpace\", false]]]\n```\n\nStructure of BIS_fnc_garage_data\n\n```sqf\nBIS_fnc_garage_data = [\n    // CARS\n    [\n        //model\n        \"\\a3\\soft_f\\offroad_01\\offroad_01_unarmed_f\",\n        // config paths of classes that use above model\n        [\n            config.bin/CfgVehicles/C_Offroad_01_F,\n            config.bin/CfgVehicles/B_G_Offroad_01_F\n        ],\n        \"\\a3\\soft_f\\mrap_02\\mrap_02_gmg_f\",\n        [\n            config.bin/CfgVehicles/O_MRAP_02_gmg_F\n        ]\n    ],\n    [],        // ARMOR\n    [],        // HELIS\n    [],        // PLANES\n    [],        // NAVAL\n    []        // STATICS\n]\n```"},{"user":".kju","date":"2018-05-01T14:40:00Z","text":"The above overview isn't fully correct:\n\n1. BIS_fnc_garage_centerType returns by default the model path of the \"default class\"\n\n   ```sqf\n   getText (configFile >> \"cfgvehicles\" >> _classDefault >> \"model\")\n   ```\n\n   yet once a vehicle is selected it returns its class name.\n1. BIS_fnc_garage_center returns by default the player reference, yet otherwise the created vehicle object"}]},{"name":"BIS_fnc_garage3DEN","title":"BIS fnc garage3DEN","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_garage3DEN","revid":342146,"updated":"2023-07-09T12:26:48Z","groups":["Eden Editor"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"The code is identical to the one of BIS_fnc_garage, except that `FNC_IS3DEN` is set to 1. For more information about the garage, visit BIS_fnc_garage\n\n> [!IMPORTANT]\n> This function is used internally by the Eden Editor.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["BIS_fnc_3DENCamera","BIS_fnc_3DENControlsHint","BIS_fnc_3DENDiagCreateList","BIS_fnc_3DENDiagFonts","BIS_fnc_3DENDiagMouseControl","BIS_fnc_3DENDrawLocations","BIS_fnc_3DENEntityMenu","BIS_fnc_3DENExportAttributes","BIS_fnc_3DENExportOldSQM","BIS_fnc_3DENExportTerrainBuilder","BIS_fnc_3DENFlashlight","BIS_fnc_3DENGrid","BIS_fnc_3DENIntel","BIS_fnc_3DENInterface","BIS_fnc_3DENListLocations","BIS_fnc_3DENModuleDescription","BIS_fnc_3DENShowMessage","BIS_fnc_3DENStatusBar","BIS_fnc_3DENToolbar","BIS_fnc_3DENTutorial","BIS_fnc_3DENVisionMode"]},{"name":"BIS_fnc_GC","title":"BIS fnc GC","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_GC","revid":326906,"updated":"2022-07-12T21:44:38Z","groups":["Diagnostic"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","exec":"spawn","description":"Sends an entity to the garbage collection queue. Replaces Arma 2 Garbage Collector.","syntaxes":[{"syntax":"entity spawn BIS_fnc_GC","params":[{"name":"entity","type":"Object or Group or String (marker) or Array (array of entities)","type_expr":"Object | Group | String | Array"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if function was executed successfuly"}}],"examples":[{"code":["[dude1] spawn BIS_fnc_GC;"]},{"code":["[dude1, group dude1, \"marker1\"] spawn BIS_fnc_GC;"]}],"see_also":["Garbage Collector"]},{"name":"BIS_fnc_GCinit","title":"BIS fnc GCinit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_GCinit","revid":336929,"updated":"2023-01-04T16:44:03Z","groups":["Diagnostic"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Initializes Garbage Collection.","syntaxes":[{"syntax":"[] call BIS_fnc_GCinit","params":[],"returns":null}],"examples":[{"code":["[] call BIS_fnc_GCinit;"]}],"see_also":["Arma 2: Garbage Collector"]},{"name":"BIS_fnc_genericSentence","title":"BIS fnc genericSentence","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_genericSentence","revid":329652,"updated":"2022-08-01T00:38:41Z","groups":["Conversations"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Play generic sentence with probablity set by bis_genericSentenceMode variable (0.5 = 50%, 1 = 100%)","syntaxes":[{"syntax":"[class, speaker, delay, canRepeat] call BIS_fnc_genericSentence","params":[{"name":"class","type":"String","description":"sentence name (from *class RadioProtocol_EN_H*)","type_expr":"String"},{"name":"speaker","type":"Object or Code","optional":true,"default":"2nd crew member","description":"sentence speaker (when code, speaker is it is returned value).","type_expr":"Object | Code","text":"speaker: Object or Code - (Optional) sentence speaker (when code, speaker is it is returned value). Default is 2nd crew member."},{"name":"delay","type":"Number","optional":true,"description":"delay from previous generic sentence: When negative, sentence is played always.","type_expr":"Number","text":"delay: Number - (Optional) delay from previous generic sentence: When negative, sentence is played always."},{"name":"canRepeat","type":"Boolean","optional":true,"description":"true to allow repeating same sentence","type_expr":"Boolean","text":"canRepeat: Boolean - (Optional) true to allow repeating same sentence"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if sentence was played"}}],"examples":[{"code":["[\"FeedbackFlightNegativeHeightTooHigh\"] call BIS_fnc_genericSentence;"]},{"code":["[\"FeedbackFlightNegativeSpeedTooSlow\",nil,5,true] call BIS_fnc_genericSentence;"]}],"see_also":["Generic Sentences"]},{"name":"BIS_fnc_genericSentenceInit","title":"BIS fnc genericSentenceInit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_genericSentenceInit","revid":309713,"updated":"2022-05-05T12:09:47Z","groups":["Conversations"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","locality":{"server_exec":true},"description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_geometricMean","title":"BIS fnc geometricMean","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_geometricMean","revid":348249,"updated":"2023-11-08T11:40:33Z","groups":["Math"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Returns the [geometric mean](https://en.wikipedia.org/wiki/Geometric_mean) of an array of numbers.","syntaxes":[{"syntax":"array call BIS_fnc_geometricMean","params":[{"name":"array","type":"Array","description":"array of numbers.","type_expr":"Array"}],"returns":{"type":"Number","type_expr":"Number","description":"geometric mean"}}],"examples":[{"code":["[0,1,3] call BIS_fnc_geometricMean;//Returns 1.73205"]}],"see_also":["BIS_fnc_randomInt","BIS_fnc_arithmeticMean","BIS_fnc_nearestNum","BIS_fnc_sortNum","BIS_fnc_roundNum"]},{"name":"BIS_fnc_getAngleDelta","title":"BIS fnc getAngleDelta","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getAngleDelta","revid":349127,"updated":"2023-11-08T14:49:40Z","groups":["Geometry"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns the smallest difference between two angles in degrees.","syntaxes":[{"syntax":"[angleA, angleB] call BIS_fnc_getAngleDelta","params":[{"name":"angleA","type":"Number","description":"first angle","type_expr":"Number"},{"name":"angleB","type":"Number","description":"second angle","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number","description":"angle delta"}}],"examples":[{"code":["private _delta = [90,193] call BIS_fnc_getAngleDelta;//-103"]}],"see_also":["tan","cos","sin"]},{"name":"BIS_fnc_getArea","title":"BIS fnc getArea","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getArea","revid":379268,"updated":"2026-10-30T23:43:55Z","groups":["Geometry","Map and Markers"],"status":"ok","games":{"arma3":"1.58"},"since":"arma3 1.58","arma3_since":"1.58","description":"Extracts area information from trigger, marker, location or array","syntaxes":[{"syntax":"param call BIS_fnc_getArea","params":[{"name":"param","type":"Object, String, Location or Array","description":"Object, String, Location or Array\n\n- Object - trigger\n- String - marker\n- Location - location\n- Array - array in format [center, distance] or [center, [a, b, angle, rect]] or [center, [a, b, angle, rect, height]]","type_expr":"Object | String | Location | Array","text":"param: Object, String, Location or Array\n\n- Object - trigger\n- String - marker\n- Location - location\n- Array - array in format [center, distance] or [center, [a, b, angle, rect]] or [center, [a, b, angle, rect, height]]"}],"returns":{"type":"Array","type_expr":"Array","description":"in format [center, a, b, angle, isRectangle, height]"}}],"examples":[{"code":["private _area = [player, 100] call BIS_fnc_getArea;"]}],"see_also":["createTrigger","createMarker","setTriggerArea","setMarkerSize","triggerArea","markerSize","inArea","inAreaArray","BIS_fnc_inTrigger"]},{"name":"BIS_fnc_getBorderMarkers","title":"BIS fnc getBorderMarkers","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getBorderMarkers","revid":309405,"updated":"2022-05-05T12:04:36Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Retrieves marker names used in the border restrictions module.","syntaxes":[{"syntax":"call BIS_fnc_getBorderMarkers","params":[],"returns":{"type":"Array of Strings","type_expr":"Array<String>","description":"list of markers"}}],"examples":[{"code":["call BIS_fnc_getBorderMarkers;"]}],"see_also":["BIS_fnc_moveMarker"]},{"name":"BIS_fnc_getCfg","title":"BIS fnc getCfg","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getCfg","revid":349406,"updated":"2023-11-08T16:27:26Z","groups":["Configs"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Smart-return config (extension for BIS_fnc_getCfgXXXX functions).\nCan by called 2 ways:\n\n- 1st way - passing config directly\n- 2nd way - passing array of strings or config and strings","syntaxes":[{"syntax":"input call BIS_fnc_getCfg","params":[{"name":"input","type":"Config or Array","description":"can be Config path or array of strings with config names","type_expr":"Config | Array"}],"returns":{"type":"Config","type_expr":"Config"}}],"examples":[{"code":["( configFile >> \"BulletBubbles\" >> \"BulletBubbles1\" ) call BIS_fnc_getCfg;"]},{"code":["[configFile >> \"BulletBubbles\" >> \"BulletBubbles1\"] call BIS_fnc_getCfg;"]},{"code":["[configFile, \"BulletBubbles\", \"BulletBubbles1\"] call BIS_fnc_getCfg;"]},{"code":["[\"Hubs\", \"A1\", \"QuickStart\", \"trigger\"] call BIS_fnc_getCfg;"]},{"code":["[\"Hubs\"] call BIS_fnc_getCfg;"]}],"see_also":["configClasses","configProperties","missionConfigFile","campaignConfigFile","configName","getArray","getText","getNumber","inheritsFrom","isClass","isText","configHierarchy"]},{"name":"BIS_fnc_getCfgData","title":"BIS fnc getCfgData","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getCfgData","revid":363873,"updated":"2024-04-23T21:03:46Z","groups":["Configs"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Smart-return number, text or array value from config.\n\n- Default syntax works for any config.\n- Alternative syntax is for working comfortably with Description.ext.","syntaxes":[{"syntax":"config call BIS_fnc_getCfgData","params":[{"name":"config","type":"Config","description":"Config path","type_expr":"Config"}],"returns":{"type":"Array, String, Number or nil","type_expr":"Array | String | Number | Nothing"}},{"syntax":"array call BIS_fnc_getCfgData","params":[{"name":"Array of Strings","description":"missionConfigFile classes and an attribute","type_expr":"Array<String>"}],"returns":{"type":"Array, String, Number or nil","type_expr":"Array | String | Number | Nothing"}}],"examples":[{"code":["private _value = (configFile >> \"BulletBubbles\" >> \"BulletBubbles1\" >> \"type\") call BIS_fnc_getCfgData;"]},{"code":["private _value = (missionConfigFile >> \"Hubs\" >> \"A1\" >> \"QuickStart\" >> \"trigger\") call BIS_fnc_getCfgData;"]}],"see_also":["BIS_fnc_getCfgDataArray","BIS_fnc_getCfgDataObject","BIS_fnc_getCfgDataPool","BIS_fnc_getCfgDataBool"]},{"name":"BIS_fnc_getCfgDataArray","title":"BIS fnc getCfgDataArray","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getCfgDataArray","revid":352627,"updated":"2024-02-16T20:51:51Z","groups":["Configs"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Gets an array defined in Config. If the value is not an array, it is retyped into one.\n\n- Default syntax works for any config.\n- Alternative syntax is for comfortable working with mission description.ext.","syntaxes":[{"syntax":"config call BIS_fnc_getCfgDataArray","params":[{"name":"config","type":"Config","description":"Config path","type_expr":"Config"}],"returns":{"type":"Array or nil","type_expr":"Array | Nothing"}},{"syntax":"array call BIS_fnc_getCfgDataArray","params":[{"name":"Array of Strings","description":"missionConfigFile classes and an attribute","type_expr":"Array<String>"}],"returns":{"type":"Array or nil","type_expr":"Array | Nothing"}}],"examples":[{"code":["private _array = (missionConfigFile >> \"Characters\" >> \"Default\" >> \"equipAdjust\") call BIS_fnc_getCfgDataArray;"]},{"code":["private _array = [\"Characters\",\"Default\",\"equipAdjust\"] call BIS_fnc_getCfgDataArray;"]}],"see_also":["BIS_fnc_getCfgData","BIS_fnc_getCfgDataObject","BIS_fnc_getCfgDataPool","BIS_fnc_getCfgDataBool"]},{"name":"BIS_fnc_getCfgDataBool","title":"BIS fnc getCfgDataBool","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getCfgDataBool","revid":352618,"updated":"2024-02-16T20:51:49Z","groups":["Configs"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Gets a number defined in config and retype it into a boolean. Everything greater than 0 is true, otherwise it is false.\n\n- Default syntax works for any config\n- Alternative syntax is for comfortable working with mission's Description.ext.","syntaxes":[{"syntax":"config call BIS_fnc_getCfgDataBool","params":[{"name":"config","type":"Config","description":"Config path","type_expr":"Config"}],"returns":{"type":"Boolean","type_expr":"Boolean"}},{"syntax":"array call BIS_fnc_getCfgDataBool","params":[{"name":"Array of Strings","description":"missionConfigFile classes and an attribute","type_expr":"Array<String>"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["private _value = (missionConfigFile >> \"Characters\" >> \"Default\" >> \"equipAdjust\") call BIS_fnc_getCfgDataBool;"]},{"code":["private _value = [\"Characters\", \"Default\", \"equipAdjust\"] call BIS_fnc_getCfgDataBool;"]}],"see_also":["BIS_fnc_getCfgData","BIS_fnc_getCfgDataArray","BIS_fnc_getCfgDataObject","BIS_fnc_getCfgDataPool"]},{"name":"BIS_fnc_getCfgDataObject","title":"BIS fnc getCfgDataObject","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getCfgDataObject","revid":309768,"updated":"2022-05-05T12:09:49Z","groups":["Configs"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Get the object defined in cfg by its name (global variable).","syntaxes":[{"syntax":"_this call BIS_fnc_getCfgDataObject","params":[{"name":"_this","type":"Config, Array, String","type_expr":"Config | Array<String>","description":"_this: ARRAY of STRINGS - missionConfigFile classes and an attribute.","text":"CFG\n_this: ARRAY of STRINGS - missionConfigFile classes and an attribute.","source":"docblock"}],"returns":{"type":"Object","type_expr":"Object","text":"OBJECT or OBJNULL","source":"docblock"},"inferred":true}],"examples":[{"code":["1st way of calling:"]},{"code":["_value = (missionconfigfile >> \"Hubs\" >> \"A1\" >> \"QuickStart\" >> \"trigger\") call BIS_fnc_getCfgDataObject;"]},{"code":["2nd way of calling:"]},{"code":["_value = [\"Hubs\",\"A1\",\"QuickStart\",\"trigger\"] call BIS_fnc_getCfgDataObject;"]}],"docblock":{"text":"Description:\nGet the object defined in cfg by its name (global variable).\n\nRemark(s):\n Can by called 2 ways:\n     1st way (general) works for any config.\n     2nd way is for comfortable working with mission description.ext.\n\nParameter(s):\n    _this: CFG\n    _this: ARRAY of STRINGS - missionConfigFile classes and an attribute.\n\nExample:\n\n 1st way of calling:\n\n    _value = (missionconfigfile >> \"Hubs\" >> \"A1\" >> \"QuickStart\" >> \"trigger\") call BIS_fnc_getCfgDataObject;\n\n 2nd way of calling:\n\n    _value = [\"Hubs\",\"A1\",\"QuickStart\",\"trigger\"] call BIS_fnc_getCfgDataObject;\n\nReturns:\n    OBJECT or OBJNULL"},"filled_from_docblock":["description","params","syntax","returns","examples"]},{"name":"BIS_fnc_getCfgDataPool","title":"BIS fnc getCfgDataPool","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getCfgDataPool","revid":309841,"updated":"2022-05-05T12:09:52Z","groups":["Configs"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Get array of attribute values out of the parent config class. Attributes need to be in this format: \"_n\", where n is an index number (starting from 0). If any discrepancy in indexing is detected, loading will stop and only the correctly indexed values will be returned. Max. index supported is 99. If more then 9 attributes used, 0-9 need to use leading zeroes.\n\nCFG example:\n\nclass Timeline {\n    class StageA\n    {\n        _0[] = {2035,7,7,04,30};\n        _1[] = {2035,7,7,06,15};\n        _2[] = {2035,7,7,18,35};\n        _3[] = {2035,7,8,09,05};\n        _4[] = {2035,7,8,13,25};\n        _5[] = {2035,7,8,17,10};\n        _6[] = {2035,7,8,21,40};\n        _7[] = {2035,7,9,19,55};\n    };\n};","syntaxes":[{"syntax":"_this call BIS_fnc_getCfgDataPool","params":[{"name":"_this","type":"Config, Array, String","type_expr":"Config | Array<String>","description":"_this: ARRAY of STRINGS - missionConfigFile classes.","text":"CFG\n_this: ARRAY of STRINGS - missionConfigFile classes.","source":"docblock"}],"returns":{"type":"Array","type_expr":"Array","text":"ARRAY or nil, if parent class is not found","source":"docblock"},"inferred":true}],"examples":[{"code":["1st way of calling:"]},{"code":["_array = (configfile >> \"BulletBubbles\" >> \"BulletBubbles1\") call BIS_fnc_getCfgData;\n_array = (missionconfigfile >> \"Timeline\" >> \"StageA\") call BIS_fnc_getCfgData;"]},{"code":["2nd way of calling:"]},{"code":["_array = [\"Timeline\",\"StageA\"] call BIS_fnc_getCfgData;"]}],"docblock":{"text":"Description:\n Get array of attribute values out of the parent config class.\n Attributes need to be in this format: \"_n\", where n is an index number (starting from 0).\n If any discrepancy in indexing is detected, loading will stop and only the correctly indexed values will be returned.\n Max. index supported is 99.\n If more then 9 attributes used, 0-9 need to use leading zeroes.\n\nCFG example:\n\nclass Timeline\n{\n    class StageA\n    {\n        _0[] = {2035,7,7,04,30};\n        _1[] = {2035,7,7,06,15};\n        _2[] = {2035,7,7,18,35};\n        _3[] = {2035,7,8,09,05};\n        _4[] = {2035,7,8,13,25};\n        _5[] = {2035,7,8,17,10};\n        _6[] = {2035,7,8,21,40};\n        _7[] = {2035,7,9,19,55};\n    };\n};\n\nRemark(s):\n Can by called 2 ways:\n     1st way (general) works for any config.\n     2nd way is for comfortable working with mission description.ext.\n\nParameter(s):\n    _this: CFG\n    _this: ARRAY of STRINGS - missionConfigFile classes.\n\nExample:\n\n 1st way of calling:\n\n    _array = (configfile >> \"BulletBubbles\" >> \"BulletBubbles1\") call BIS_fnc_getCfgData;\n    _array = (missionconfigfile >> \"Timeline\" >> \"StageA\") call BIS_fnc_getCfgData;\n\n 2nd way of calling:\n\n    _array = [\"Timeline\",\"StageA\"] call BIS_fnc_getCfgData;\n\nReturns:\n    ARRAY or nil, if parent class is not found"},"filled_from_docblock":["description","params","syntax","returns","examples"]},{"name":"BIS_fnc_getCfgIsClass","title":"BIS fnc getCfgIsClass","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getCfgIsClass","revid":328662,"updated":"2022-07-13T17:04:23Z","groups":["Configs"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Return true if it is a class. Can by called in two ways:\n\n- first way (general) works for any config\n- second way is for comfortable working with mission description.ext","syntaxes":[{"syntax":"configEntry call BIS_fnc_getCfgIsClass","params":[{"name":"configEntry","type":"Config","type_expr":"Config"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if it is a class"}},{"syntax":"classNames call BIS_fnc_getCfgIsClass","params":[{"name":"classNames","type":"Array of String","description":"missionConfigFile classes and an attribute","type_expr":"Array<String>"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if it is a class"}}],"examples":[{"code":["private _isClass = (missionConfigFile >> \"Hubs\" >> \"A1\" >> \"QuickStart\") call BIS_fnc_getCfgIsClass;"]},{"code":["private _isClass = [\"Hubs\"] call BIS_fnc_getCfgIsClass;"]}],"see_also":["BIS_fnc_getCfg","BIS_fnc_getCfgData","BIS_fnc_getCfgDataArray","BIS_fnc_getCfgDataBool","BIS_fnc_getCfgDataObject","BIS_fnc_getCfgDataPool","BIS_fnc_getCfgSubClasses"]},{"name":"BIS_fnc_getCfgSubClasses","title":"BIS fnc getCfgSubClasses","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getCfgSubClasses","revid":326874,"updated":"2022-07-12T21:44:34Z","groups":["Configs"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Return all child classes of given class.","syntaxes":[{"syntax":"_this call BIS_fnc_getCfgSubClasses","params":[{"name":"_this","type":"Config, Array, String","type_expr":"Config | Array<String>","description":"_this: ARRAY of STRINGS - missionConfigFile classes and an attribute.","text":"CFG\n_this: ARRAY of STRINGS - missionConfigFile classes and an attribute.","source":"docblock"}],"returns":{"type":"Array, String","types":["Array","String"],"type_expr":"Array","text":"ARRAY (of STRINGS with sub-classes names)","source":"docblock"},"inferred":true}],"examples":[{"code":["private _allVehHitPoints = (configfile >> \"CfgVehicles\" >> \"C_Hatchback_01_sport_F\" >> \"HitPoints\") call BIS_fnc_getCfgSubClasses;"]}],"docblock":{"text":"Description:\nReturn all child classes of given class.\n\nRemark(s):\n Can by called 2 ways:\n     1st way (general) works for any config.\n     2nd way is for comfortable working with mission description.ext.\n\nParameter(s):\n    _this: CFG\n    _this: ARRAY of STRINGS - missionConfigFile classes and an attribute.\n\nExample:\n\n 1st way of calling:\n\n    _subclasses = (missionconfigfile >> \"Hubs\" >> \"A1\" >> \"QuickStart\") call Bis_fnc_getCfgSubClasses;\n\n 2nd way of calling:\n\n    _subclasses = [\"Hubs\"] call Bis_fnc_getCfgSubClasses;\n\nReturns:\n    ARRAY (of STRINGS with sub-classes names)"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_getCloudletParams","title":"BIS fnc getCloudletParams","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getCloudletParams","revid":349529,"updated":"2023-11-08T17:16:25Z","groups":["Systems"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Return particle params of CfgCloudlets class.","syntaxes":[{"syntax":"[cfgCloudletClass] call BIS_fnc_getCloudletParams","params":[{"name":"cfgCloudletClass","type":"String","description":"wanted class in cfgCloudlets","type_expr":"String"}],"returns":{"type":"Array","type_expr":"Array","description":"format [setParticleParams, setParticleRandom, setDropInterval]\n[ [ [particleShape, particleFSNtieth, particleFSIndex, particleFSFrameCount, particleFSLoop], animationName, particleType, timerPeriod, lifeTime, position, moveVelocity, rotationVelocity, weight, volume, rubbing, size, color, animationSpeed, randomDirectionPeriod, randomDirectionIntensity, onTimerScript, beforeDestroyScript, \"\", angle, onSurface, bounceOnSurface, emissiveColor ], [ lifeTimeVar, positionVar, moveVelocityVar, rotationVelocityVar, sizeVar, colorVar, randomDirectionPeriodVar, randomDirectionIntensityVar, angleVar, bounceOnSurfaceVar ], interval ]","text":"Array - format [setParticleParams, setParticleRandom, setDropInterval]\n\n```\n[\n    [\n        [particleShape, particleFSNtieth, particleFSIndex, particleFSFrameCount, particleFSLoop],\n        animationName,\n        particleType,\n        timerPeriod,\n        lifeTime,\n        position,\n        moveVelocity,\n        rotationVelocity,\n        weight,\n        volume,\n        rubbing,\n        size,\n        color,\n        animationSpeed,\n        randomDirectionPeriod,\n        randomDirectionIntensity,\n        onTimerScript,\n        beforeDestroyScript,\n        \"\",\n        angle,\n        onSurface,\n        bounceOnSurface,\n        emissiveColor\n    ],\n    [\n        lifeTimeVar,\n        positionVar,\n        moveVelocityVar,\n        rotationVelocityVar,\n        sizeVar,\n        colorVar,\n        randomDirectionPeriodVar,\n        randomDirectionIntensityVar,\n        angleVar,\n        bounceOnSurfaceVar\n    ],\n    interval\n```\n\n]"}}],"examples":[{"code":["[\"AmmoLightSmokeParticles\"] call BIS_fnc_getCloudletParams;"]}],"see_also":["Arma 3: Particle Effects","setParticleParams","setParticleRandom","setDropInterval","drop"]},{"name":"BIS_fnc_getFactions","title":"BIS fnc getFactions","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getFactions","revid":379498,"updated":"2026-10-31T00:26:46Z","groups":["Sides"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Gets list and sides of current factions.","syntaxes":[{"syntax":"[parameter] call BIS_fnc_getFactions","params":[{"name":"parameter","type":"Nothing, Object or Array","description":"Nothing, Object or Array\n\n- Nothing or empty Array - returns all factions\n- Object - returns index of the object side\n- Array - side of the first element is returned, others are ignored","type_expr":"Nothing | Object | Array","text":"parameter: Nothing, Object or Array\n\n- Nothing or empty Array - returns all factions\n- Object - returns index of the object side\n- Array - side of the first element is returned, others are ignored"}],"returns":{"types":["Array","String"],"type_expr":"Array<String> | Array<Side> | Number","description":"- Array of Strings - Array of Sides - Number - an index","text":"- Array of Strings\n- Array of Sides\n- Number - an index"}}],"examples":[{"code":["call BIS_fnc_getFactions; // returns all factions"]},{"code":["[] call BIS_fnc_getFactions; // same as Example 1"]},{"code":["[player] call BIS_fnc_getFactions; // returns index of player's faction"]},{"code":["[\"BLU_F\"] call BIS_fnc_getFactions; // returns index of given faction"]},{"code":["[[]] call BIS_fnc_getFactions; // will return all faction sides"]},{"code":["[[player]] call BIS_fnc_getFactions; // will return player's side"]}],"see_also":["faction","side"]},{"name":"BIS_fnc_getFromPairs","title":"BIS fnc getFromPairs","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getFromPairs","revid":349332,"updated":"2023-11-08T14:53:28Z","groups":["Arrays"],"status":"ok","games":{"arma3":"1.02"},"since":"arma3 1.02","arma3_since":"1.02","description":"Searches the associative array for the 1st occurance of the key string and returns the value associated with it. Search is not case sensitiv.","syntaxes":[{"syntax":"[array, key, defaultValue] call BIS_fnc_getFromPairs","params":[{"name":"array","type":"Array","description":"array to search through","type_expr":"Array"},{"name":"key","type":"String","description":"key to search for","type_expr":"String"},{"name":"defaultValue","type":"Anything","optional":true,"default":"nil","description":"default return value if no match was found","type_expr":"Anything","text":"defaultValue: Anything - (Optional, default nil) default return value if no match was found"}],"returns":{"type":"Anything","type_expr":"Anything","description":"value associated with the key."}}],"examples":[{"code":["[[[\"apple\",3],[\"pear\",\"test\"]],\"pear\"] call BIS_fnc_getFromPairs; // Returns \"test\""]},{"code":["[[[\"apple\",3],[\"pear\",6]],\"pear\"] call BIS_fnc_getFromPairs; // Returns \"6\""]}],"see_also":["find","findIf","BIS_fnc_findInPairs","BIS_fnc_addToPairs","BIS_fnc_removeFromPairs","BIS_fnc_setToPairs"],"notes":[{"user":"Benargee","date":"2014-10-02T01:17:00Z","text":"BIS_fnc_findInPairs renamed to BIS_fnc_getFromPairs and now supports all variable types [Source](http://dev.arma3.com/post/spotrep-00011)"}]},{"name":"BIS_fnc_getIDC","title":"BIS fnc getIDC","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getIDC","revid":348396,"updated":"2023-11-08T13:00:01Z","groups":["GUI"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Returns IDD of given display.","syntaxes":[{"syntax":"[config, ctrlName] call BIS_fnc_getIDC","params":[{"name":"config","type":"Config","description":"config path to display","type_expr":"Config"},{"name":"ctrlName","type":"String","description":"config name of control","type_expr":"String"}],"returns":{"type":"Number","type_expr":"Number","description":"IDC, returns -1 if control was not found"}}],"examples":[{"code":["private _IDC = [configFile >> \"Display3DENPlace\", \"ButtonCancel\"] call BIS_fnc_getIDC;"]}],"see_also":["configFile","findDisplay","createDisplay","displayCtrl"]},{"name":"BIS_fnc_getIDD","title":"BIS fnc getIDD","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getIDD","revid":349463,"updated":"2023-11-08T16:49:17Z","groups":["GUI"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Returns IDD of given display.","syntaxes":[{"syntax":"[config] call BIS_fnc_getIDD","params":[{"name":"config","type":"Config","description":"config path to display","type_expr":"Config"}],"returns":{"type":"Number","type_expr":"Number","description":"IDD"}}],"examples":[{"code":["private _IDD = [configFile >> \"display3DENPublishMissionSelectImage\"] call BIS_fnc_getIDD;"]}],"see_also":["configFile","findDisplay","createDisplay"]},{"name":"BIS_fnc_getIntersectionsUnderCursor","title":"BIS fnc getIntersectionsUnderCursor","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getIntersectionsUnderCursor","revid":336299,"updated":"2022-12-21T11:10:09Z","groups":["Geometry"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns intersections under cursor. For more information see lineIntersectsSurfaces.","syntaxes":[{"syntax":"[screenX, screenY, ignoreObj1, ignoreObj2, sortMode, maxResults, LOD1, LOD2] call BIS_fnc_getIntersectionsUnderCursor","params":[{"name":"screenX","type":"Number","optional":true,"default":"0","description":"cursor's X position - see screenToWorld","type_expr":"Number","text":"screenX: Number - (Optional, default 0) cursor's X position - see screenToWorld"},{"name":"screenY","type":"Number","optional":true,"default":"0","description":"cursor's Y position - see screenToWorld","type_expr":"Number","text":"screenY: Number - (Optional, default 0) cursor's Y position - see screenToWorld"},{"name":"ignoreObj1","type":"Object","optional":true,"default":"objNull","description":"first object to ignore","type_expr":"Object","text":"ignoreObj1: Object - (Optional, default objNull) first object to ignore"},{"name":"ignoreObj2","type":"Object","optional":true,"default":"objNull","description":"second object to ignore","type_expr":"Object","text":"ignoreObj2: Object - (Optional, default objNull) second object to ignore"},{"name":"sortMode","type":"Boolean","optional":true,"default":"true","description":"true: closest to furthest, false: furthest to closest","type_expr":"Boolean","text":"sortMode: Boolean - (Optional, default true) true: closest to furthest, false: furthest to closest"},{"name":"maxResults","type":"Number","optional":true,"default":"1","description":"max results to return. -1 to return every result","type_expr":"Number","text":"maxResults: Number - (Optional, default 1) max results to return. -1 to return every result"},{"name":"LOD1","type":"String","optional":true,"default":"\"VIEW\"","description":"primary LOD to look for intersection. Can be one of:\n\n- \"FIRE\"\n- \"VIEW\"\n- \"GEOM\"\n- \"IFIRE\" - (\"I\" stands for Indirect, *almost* identical to \"FIRE\")\n- \"NONE\"\n- Arma 3 v2.02 \"PHYSX\" - PhysX geometry LOD\n- Arma 3 v2.08 \"ROADWAY\" - only works from the top","type_expr":"String","since":"arma3 1.52","text":"LOD1: String - (Optional, default \"VIEW\") primary LOD to look for intersection. Can be one of:\n\n- \"FIRE\"\n- \"VIEW\"\n- \"GEOM\"\n- \"IFIRE\" - (\"I\" stands for Indirect, *almost* identical to \"FIRE\")\n- \"NONE\"\n- Arma 3 v2.02 \"PHYSX\" - PhysX geometry LOD\n- Arma 3 v2.08 \"ROADWAY\" - only works from the top"},{"name":"LOD2","type":"String","optional":true,"default":"\"FIRE\"","description":"secondary LOD to look for intersection. See *LOD1* for possible values","type_expr":"String","since":"arma3 1.52","text":"LOD2: String - (Optional, default \"FIRE\") secondary LOD to look for intersection. See *LOD1* for possible values"}],"returns":{"type_expr":"Array","description":"- intersectPosASL: PositionASL - the actual position where line intersects surface - surfaceNormal: Vector - a normal to the intersected surface - intersectObject: Object - the object the surface belongs to (could be proxy object) - objNull if terrain - parentObject: Object - the object proxy object belongs to (not always the same as intersect object) - objNull if terrain - Arma 3 v2.10 selectionNames: Array of Strings - Names of the intersected selections (bones). Returns `[]` if there is no intersection with a selection. - Arma 3 v2.10 pathToBisurf: String - path to intersected surface properties (.bisurf) file. Returns `\"\"` if surface has no special properties. Terrain surface properties begin with `#`, and the surface properties are defined in `CfgSurfaces`. For example, if it returns `#GdtVRsurface01`, properties are defined in: `configFile >> \"CfgSurfaces\" >> \"GdtVRsurface01\"`","text":"Array of intersections in format [[intersectPosASL, surfaceNormal, intersectObj, parentObject, selectionNames, pathToBisurf], ...] where:\n\n- intersectPosASL: PositionASL - the actual position where line intersects surface\n- surfaceNormal: Vector - a normal to the intersected surface\n- intersectObject: Object - the object the surface belongs to (could be proxy object) - objNull if terrain\n- parentObject: Object - the object proxy object belongs to (not always the same as intersect object) - objNull if terrain\n- Arma 3 v2.10 selectionNames: Array of Strings - Names of the intersected selections (bones). Returns `[]` if there is no intersection with a selection.\n- Arma 3 v2.10 pathToBisurf: String - path to intersected surface properties (.bisurf) file. Returns `\"\"` if surface has no special properties. Terrain surface properties begin with `#`, and the surface properties are defined in `CfgSurfaces`. For example, if it returns `#GdtVRsurface01`, properties are defined in: `configFile >> \"CfgSurfaces\" >> \"GdtVRsurface01\"`"}}],"examples":[{"code":["[0.5, 0.5, player, objNull, true, \"VIEW\"] call BIS_fnc_getIntersectionsUnderCursor;"]}],"see_also":["lineIntersectsSurfaces"]},{"name":"BIS_fnc_getLineDist","title":"BIS fnc getLineDist","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getLineDist","revid":329321,"updated":"2022-07-27T10:15:11Z","groups":["Geometry"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Return the distance between two sections of a virtual straight line.","syntaxes":[{"syntax":"[start1, length1, start2, length2] call BIS_fnc_getLineDist","params":[{"name":"start1","type":"Number","description":"segment 1 beginning. Can be negative","type_expr":"Number"},{"name":"length1","type":"Number","description":"segment 1 length. Can be negative","type_expr":"Number"},{"name":"start2","type":"Number","description":"segment 2 beginning. Can be negative","type_expr":"Number"},{"name":"length2","type":"Number","description":"segment 2 length. Can be negative","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number"}}],"examples":[{"code":["private _distance = [0,5,15,20] call BIS_fnc_getLineDist; // returns 10"]}],"see_also":["distance"]},{"name":"BIS_fnc_getMarkers","title":"BIS fnc getMarkers","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getMarkers","revid":348985,"updated":"2023-11-08T14:45:46Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Returns markers in format PREFIX_N where PREFIX_ is the provided argument and N is an integer between 1 and 128. If there are 128 markers but marker 123 is missing, then only the first 122 marker will be returned.","syntaxes":[{"syntax":"[markerPrefix] call BIS_fnc_getMarkers","params":[{"name":"markerPrefix","type":"String","description":"prefix of the markers","type_expr":"String"}],"returns":{"type":"Array","type_expr":"Array","description":"an array of markers"}}],"examples":[{"code":["[\"BIS_marker_\"] call BIS_fnc_getMarkers; // [\"BIS_marker_1\",\"BIS_marker_2\",...]"]}],"see_also":["BIS_fnc_cancelMarker","BIS_fnc_blinkMarker","BIS_fnc_rotateMarker","BIS_fnc_resizeMarker"]},{"name":"BIS_fnc_getMarkerState","title":"BIS fnc getMarkerState","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getMarkerState","revid":349025,"updated":"2023-11-08T14:47:10Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Returns the state of a marker.","syntaxes":[{"syntax":"[marker] call BIS_fnc_getMarkerState","params":[{"name":"marker","type":"String","description":"marker","type_expr":"String"}],"returns":{"type":"String","type_expr":"String","description":"returns state of the marker. \"Shown\", \"Hidden\", \"Canceled\", \"Default\", if marker does not exist, nil is returned"}}],"examples":[{"code":["private _state = [\"BIS_marker_1\"] call BIS_fnc_getMarkerState;"]}],"see_also":["BIS_fnc_blinkMarker","BIS_fnc_changeColorMarker","BIS_fnc_getMarkers","BIS_fnc_colorMarker"]},{"name":"BIS_fnc_getName","title":"BIS fnc getName","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getName","revid":378438,"updated":"2026-04-12T00:54:47Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns name of a unit. Name of unit is stored in it is namespace so it can be retrieved later, mainly for when unit dies. Name is stored in the variable **BIS_fnc_getName_name**.\n\nIf the unit is alive, this function does name and returns the result, and saves the result to the variable on the unit. If the unit is dead, the function tries to retrieve the saved name from the variable on the unit, and returns \"\" if none is saved, unless forcedWhenDead is set to true.","syntaxes":[{"syntax":"[object] call BIS_fnc_getName","params":[{"name":"object","type":"Object","description":"object whose name should be returned","type_expr":"Object"},{"name":"forcedWhenDead","type":"Boolean","optional":true,"default":"false","description":"forces the function to do name on the unit if it's dead and has no name saved in the variable. Might have inconsistent results.","type_expr":"Boolean","text":"forcedWhenDead: Boolean - (Optional, default false) forces the function to do name on the unit if it's dead and has no name saved in the variable. Might have inconsistent results."},{"name":"maxCharacters","type":"Number","optional":true,"default":"-1","description":"the name returned will be limited to this length. -1 for no limit. The name saved to the variable is not limited.","type_expr":"Number","text":"maxCharacters: Number - (Optional, default -1) the name returned will be limited to this length. -1 for no limit. The name saved to the variable is not limited."}],"returns":{"type":"String","type_expr":"String","description":"unit's name"}}],"examples":[{"code":["[player] call BIS_fnc_getName;"]}],"see_also":["name"]},{"name":"BIS_fnc_getNetMode","title":"BIS fnc getNetMode","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getNetMode","revid":327037,"updated":"2022-07-12T21:44:46Z","groups":["Multiplayer"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns the current net mode as a string.","syntaxes":[{"syntax":"call BIS_fnc_getNetMode","params":[],"returns":{"type":"String","type_expr":"String","description":"can be one of:\n- \"DedicatedServer\" - \"Server\" - \"HeadlessClient\" - \"Client\" - \"SinglePlayer\"","text":"String - can be one of:\n\n- \"DedicatedServer\"\n- \"Server\"\n- \"HeadlessClient\"\n- \"Client\"\n- \"SinglePlayer\""}}],"examples":[{"code":["private _netMode = call BIS_fnc_getNetMode;"]}]},{"name":"BIS_fnc_getObjectBBD","title":"BIS fnc getObjectBBD","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getObjectBBD","revid":327920,"updated":"2022-07-13T12:13:12Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Get object boundingBoxReal max values and store them with setVariable [\"BIS_EGSpectator_objectBBD\", [maxWidth, maxLength, maxHeight]] for later calls.","syntaxes":[{"syntax":"[object] call BIS_fnc_getObjectBBD","params":[{"name":"object","type":"Object","description":"object to measure","type_expr":"Object"}],"returns":{"type":"Array","type_expr":"Array","description":"to format [maxWidth, maxLength, maxHeight]","text":"Array to format [maxWidth, maxLength, maxHeight]"}}],"examples":[{"code":["[player] call BIS_fnc_getObjectBBD;"]},{"code":["[vehicle player] call BIS_fnc_getObjectBBD;"]}],"see_also":["boundingBox","boundingBoxReal","sizeOf"]},{"name":"BIS_fnc_getParamValue","title":"BIS fnc getParamValue","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getParamValue","revid":378105,"updated":"2026-02-14T11:08:56Z","groups":["Mission Parameters"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns the value of the named mission parameter.\nThis function is global and will return selected param value on any PC including JIP. For backward compatibility it also supports \"param1\" and \"param2\".","syntaxes":[{"syntax":"paramClass call BIS_fnc_getParamValue","params":[{"name":"paramClass","type":"String","description":"class name of one of Mission Parameters","type_expr":"String"},{"name":"defalutValue","type":"Number","optional":true,"default":"0","description":"default value to return if *paramClass does not exist*","type_expr":"Number","text":"defalutValue: Number - (Optional, default 0) default value to return if *paramClass does not exist*"}],"returns":{"type":"Number","type_expr":"Number","description":"param value"}}],"examples":[{"code":["scoreToWin = \"ScoreToWin\" call BIS_fnc_getParamValue;"]},{"code":["_viewDistance = [\"TAG_viewDistance\", 500] call BIS_fnc_getParamValue;"]},{"text":"```sqf\nif (param1 == (\"param1\" call BIS_fnc_getParamValue)) then\n{\n    hint \"Old timer\";\n};\n```","code":["if (param1 == (\"param1\" call BIS_fnc_getParamValue)) then\n{\n\thint \"Old timer\";\n};"]}],"see_also":["Mission Parameters","getMissionConfigValue","getMissionConfig","BIS_fnc_storeParamsValues"]},{"name":"BIS_fnc_getPitchBank","title":"BIS fnc getPitchBank","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getPitchBank","revid":327553,"updated":"2022-07-12T22:38:17Z","groups":["Object Manipulation"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","locality":{"argument":"global"},"description":"Returns the pitch and bank of an object, in degrees. **Yaw** can be found using the getDir command.\n**Pitch** is 0 when the object is level; 90 when pointing straight up; and -90 when pointing straight down.\n**Bank** is 0 when level; 90 when the object is rolled to the right, -90 when rolled to the left, and 180 when rolled upside down.\n\n> [!IMPORTANT]\n> The **bank** returned by this command is not fully accurate, it can be off by up to 5% or so (depending on pitch) due to an unknown bug.","syntaxes":[{"syntax":"object call BIS_fnc_getPitchBank","params":[{"name":"object","type":"Object","type_expr":"Object"}],"returns":{"type":"Array of Numbers","type_expr":"Array<Number>","description":"format [pitch, bank]"}}],"examples":[{"code":["private _pitchBank = vehicle player call BIS_fnc_getPitchBank;"]}],"see_also":["BIS_fnc_setPitchBank","vectorDir","vectorUp","setVectorDirAndUp"]},{"name":"BIS_fnc_getRespawnInventories","title":"BIS fnc getRespawnInventories","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getRespawnInventories","revid":328380,"updated":"2022-07-13T16:00:48Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.60"},"since":"arma3 1.60","arma3_since":"1.60","description":"Return respawn inventories available for the given target.","syntaxes":[{"syntax":"[target, showDisabled, returnAllInfo] call BIS_fnc_getRespawnInventories","params":[{"name":"target","type":"Namespace, Side, Group or Object","type_expr":"Namespace | Side | Group | Object"},{"name":"showDisabled","type":"Boolean","optional":true,"default":"false","description":"true to show even inventories disabled by curator","type_expr":"Boolean","text":"showDisabled: Boolean - (Optional, default false) true to show even inventories disabled by curator"},{"name":"returnAllInfo","type":"Boolean","optional":true,"default":"false","description":"true to return namespace, inventory and role limits (used in the new respawn screen), false to return only inventories","type_expr":"Boolean","text":"returnAllInfo: Boolean - (Optional, default false) true to return namespace, inventory and role limits (used in the new respawn screen), false to return only inventories"}],"returns":{"type":"Array of String","type_expr":"Array<String>"}}],"examples":[{"code":["private _respawnInfo = [player] call BIS_fnc_getRespawnInventories;"]},{"code":["private _respawnInfo = [west, true, false] call BIS_fnc_getRespawnInventories;"]}],"see_also":["Arma 3: Respawn","BIS_fnc_addRespawnInventory","BIS_fnc_removeRespawnInventory","BIS_fnc_setRespawnInventory","BIS_fnc_getRespawnMarkers","BIS_fnc_getRespawnPositions"]},{"name":"BIS_fnc_getRespawnMarkers","title":"BIS fnc getRespawnMarkers","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getRespawnMarkers","revid":349076,"updated":"2023-11-08T14:47:23Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns all respawn markers for given side.","syntaxes":[{"syntax":"[side, vehicleMarkers] call BIS_fnc_getRespawnMarkers","params":[{"name":"side","type":"Side","optional":true,"default":"`player call BIS_fnc_objectSide`","description":"side to which returned markers belong to","type_expr":"Side","text":"side: Side - (Optional, default `player call BIS_fnc_objectSide`) side to which returned markers belong to"},{"name":"vehicleMarkers","type":"Boolean","optional":true,"default":"false","description":"true to return vehicle respawn markers, false to return units respawn markers","type_expr":"Boolean","text":"vehicleMarkers: Boolean - (Optional, default false) true to return vehicle respawn markers, false to return units respawn markers"}],"returns":{"type":"Array of Strings","type_expr":"Array<String>","description":"respawn markers of given side"}}],"examples":[{"code":["[west, false] call BIS_fnc_getRespawnMarkers;"]}]},{"name":"BIS_fnc_getRespawnPositions","title":"BIS fnc getRespawnPositions","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getRespawnPositions","revid":349355,"updated":"2023-11-08T15:35:07Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Return scripted respawn positions available for the given unit.","syntaxes":[{"syntax":"input call BIS_fnc_getRespawnPositions","params":[{"name":"input","type":"Object, Group, Side or Namespace","description":"where the respawn positions are saved","type_expr":"Object | Group | Side | Namespace"}],"returns":{"type":"Array","type_expr":"Array","description":"array of respawn positions (Position, Object or String) - see BIS_fnc_addRespawnPosition)"}}],"examples":[{"code":["private _respawnPositions = missionNamespace call BIS_fnc_getRespawnPositions; // can be e.g [bis_o1, [1337, 4200, 0.01], \"myMarker\", myVehicle]"]}]},{"name":"BIS_fnc_getServerVariable","title":"BIS fnc getServerVariable","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getServerVariable","revid":349343,"updated":"2023-11-08T14:53:30Z","groups":["Variables"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Fetch a variable saved on server.\nUsed when you want to share variables only to specific clients to prevent large traffic.\nMust be run in scheduled environment because communication with server takes some time.","syntaxes":[{"syntax":"[target, varName, default] call BIS_fnc_getServerVariable","params":[{"name":"target","type":"Namespace, Object or Group","description":"variable name space","type_expr":"Namespace | Object | Group"},{"name":"varName","type":"String","description":"variable name","type_expr":"String"},{"name":"default","type":"Anything","description":"default value returned when variable is nil","type_expr":"Anything"}],"returns":{"type":"Anything","type_expr":"Anything","description":"default value or saved variable"}}],"examples":[{"code":["[missionNamespace, \"BIS_someVar\", \"defaultValue\"] call BIS_fnc_getServerVariable;"]}],"see_also":["getVariable","setVariable","allVariables"]},{"name":"BIS_fnc_getTurrets","title":"BIS fnc getTurrets","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getTurrets","revid":348930,"updated":"2023-11-08T14:44:06Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns vehicle turrets.","syntaxes":[{"syntax":"[input, outputType] call BIS_fnc_getTurrets","params":[{"name":"input","type":"Object or String","description":"object or object's class name","type_expr":"Object | String"},{"name":"outputType","type":"Config or Array","description":"output type (array of config paths or IDs)","type_expr":"Config | Array"}],"returns":{"type":"Array of configs or Array","type_expr":"Array<Config> | Array","description":"vehicle turrets"}}],"examples":[{"code":["[vehicle player]  call BIS_fnc_getTurrets;"]}],"see_also":["moveInTurret","allTurrets"]},{"name":"BIS_fnc_getUnitByUID","title":"BIS fnc getUnitByUID","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getUnitByUID","revid":327051,"updated":"2022-07-12T21:44:46Z","groups":["Multiplayer"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns player-controlled unit (if any) according to the provided player UID.","syntaxes":[{"syntax":"playerUID call BIS_fnc_getUnitByUID","params":[{"name":"playerUID","type":"String","description":"see getPlayerUID","type_expr":"String"}],"returns":{"type":"Object","type_expr":"Object","description":"the unit controlled by playerUID player","text":"Object - the unit controlled by *playerUID* player"}}],"examples":[{"code":["private _unitPlayedByUID550055 = \"550055\" call BIS_fnc_getUnitByUID;"]}],"see_also":["getPlayerUID"]},{"name":"BIS_fnc_getUnitInsignia","title":"BIS fnc getUnitInsignia","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getUnitInsignia","revid":328412,"updated":"2022-07-13T16:00:50Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"Get a unit's uniform insignia class set with BIS_fnc_setUnitInsignia.","syntaxes":[{"syntax":"[target] call BIS_fnc_getUnitInsignia","params":[{"name":"target","type":"Object","description":"object from which to return its insignia's class","type_expr":"Object"}],"returns":{"type":"String","type_expr":"String","description":"insignia classname"}}],"examples":[{"code":["private _insigniaClass = [player] call BIS_fnc_getUnitInsignia"]}],"see_also":["BIS_fnc_setUnitInsignia","Arma 3: Unit Insignia"]},{"name":"BIS_fnc_getVehicleCustomization","title":"BIS fnc getVehicleCustomization","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getVehicleCustomization","revid":363635,"updated":"2024-04-08T21:57:47Z","groups":["Vehicles"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Return vehicle customization settings.","syntaxes":[{"syntax":"[object, class] call BIS_fnc_getVehicleCustomization","params":[{"name":"object","type":"Object","type_expr":"Object"},{"name":"class","type":"String","optional":true,"default":"\"\"","description":"object class override","type_expr":"String","text":"class: String - (Optional, default \"\") object class override"}],"returns":{"type":"Array","type_expr":"Array","description":"in format: [<texture>, <animations>], for example ([[\"wasp\",1],[\"AddTread\",0,\"AddTread_Short\",1]])","text":"Array in format: [<texture>, <animations>], for example ([[\"wasp\",1],[\"AddTread\",0,\"AddTread_Short\",1]])"}}],"examples":[{"code":["[vehicle player] call BIS_fnc_getVehicleCustomization;"]}],"see_also":["Arma 3: Vehicle Customisation","BIS_fnc_initVehicle"]},{"name":"BIS_fnc_getVirtualBackpackCargo","title":"BIS fnc getVirtualBackpackCargo","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getVirtualBackpackCargo","revid":348645,"updated":"2023-11-08T13:48:23Z","groups":["Inventory"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"Get virtual backpacks from an object (e.g., ammo box). Virtual items can be selected in the Arsenal.","syntaxes":[{"syntax":"object call BIS_fnc_getVirtualBackpackCargo","params":[{"name":"object","type":"Object","type_expr":"Object"}],"returns":{"type":"Array of Strings","type_expr":"Array<String>","description":"all virtual backpacks"}}],"examples":[{"code":["BIS_ammoBox call BIS_fnc_getVirtualBackpackCargo;"]}],"see_also":["Arsenal","BIS_fnc_addVirtualBackpackCargo","BIS_fnc_addVirtualItemCargo","BIS_fnc_addVirtualMagazineCargo","BIS_fnc_addVirtualWeaponCargo","BIS_fnc_arsenal","BIS_fnc_getVirtualItemCargo","BIS_fnc_getVirtualMagazineCargo","BIS_fnc_getVirtualWeaponCargo","BIS_fnc_removeVirtualBackpackCargo","BIS_fnc_removeVirtualItemCargo","BIS_fnc_removeVirtualMagazineCargo","BIS_fnc_removeVirtualWeaponCargo"]},{"name":"BIS_fnc_getVirtualItemCargo","title":"BIS fnc getVirtualItemCargo","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getVirtualItemCargo","revid":348654,"updated":"2023-11-08T13:48:25Z","groups":["Inventory"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"Get virtual items from an object (e.g., ammo box). Virtual items can be selected in the Arsenal.","syntaxes":[{"syntax":"object call BIS_fnc_getVirtualItemCargo","params":[{"name":"object","type":"Object","type_expr":"Object"}],"returns":{"type":"Array of Strings","type_expr":"Array<String>","description":"all virtual items"}}],"examples":[{"code":["BIS_ammoBox call BIS_fnc_getVirtualItemCargo;"]}],"see_also":["Arsenal","BIS_fnc_addVirtualBackpackCargo","BIS_fnc_addVirtualItemCargo","BIS_fnc_addVirtualMagazineCargo","BIS_fnc_addVirtualWeaponCargo","BIS_fnc_arsenal","BIS_fnc_getVirtualBackpackCargo","BIS_fnc_getVirtualMagazineCargo","BIS_fnc_getVirtualWeaponCargo","BIS_fnc_removeVirtualBackpackCargo","BIS_fnc_removeVirtualItemCargo","BIS_fnc_removeVirtualMagazineCargo","BIS_fnc_removeVirtualWeaponCargo"]},{"name":"BIS_fnc_getVirtualMagazineCargo","title":"BIS fnc getVirtualMagazineCargo","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getVirtualMagazineCargo","revid":348659,"updated":"2023-11-08T13:48:27Z","groups":["Inventory"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"Get virtual magazines from an object (e.g., ammo box). Virtual items can be selected in the Arsenal.","syntaxes":[{"syntax":"object call BIS_fnc_getVirtualMagazineCargo","params":[{"name":"object","type":"Object","type_expr":"Object"}],"returns":{"type":"Array of Strings","type_expr":"Array<String>","description":"all virtual magazines"}}],"examples":[{"code":["BIS_ammoBox call BIS_fnc_getVirtualMagazineCargo;"]}],"see_also":["Arsenal","BIS_fnc_addVirtualBackpackCargo","BIS_fnc_addVirtualItemCargo","BIS_fnc_addVirtualMagazineCargo","BIS_fnc_addVirtualWeaponCargo","BIS_fnc_arsenal","BIS_fnc_getVirtualBackpackCargo","BIS_fnc_getVirtualItemCargo","BIS_fnc_getVirtualWeaponCargo","BIS_fnc_removeVirtualBackpackCargo","BIS_fnc_removeVirtualItemCargo","BIS_fnc_removeVirtualMagazineCargo","BIS_fnc_removeVirtualWeaponCargo"]},{"name":"BIS_fnc_getVirtualWeaponCargo","title":"BIS fnc getVirtualWeaponCargo","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_getVirtualWeaponCargo","revid":348647,"updated":"2023-11-08T13:48:23Z","groups":["Inventory"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"Get virtual weapons from an object (e.g., ammo box). Virtual items can be selected in the Arsenal.","syntaxes":[{"syntax":"object call BIS_fnc_getVirtualWeaponCargo","params":[{"name":"object","type":"Object","type_expr":"Object"}],"returns":{"type":"Array of Strings","type_expr":"Array<String>","description":"all virtual weapons"}}],"examples":[{"code":["BIS_ammoBox call BIS_fnc_getVirtualWeaponCargo;"]}],"see_also":["Arsenal","BIS_fnc_addVirtualBackpackCargo","BIS_fnc_addVirtualItemCargo","BIS_fnc_addVirtualMagazineCargo","BIS_fnc_arsenal","BIS_fnc_getVirtualBackpackCargo","BIS_fnc_getVirtualItemCargo","BIS_fnc_getVirtualMagazineCargo","BIS_fnc_removeVirtualBackpackCargo","BIS_fnc_removeVirtualItemCargo","BIS_fnc_removeVirtualMagazineCargo","BIS_fnc_removeVirtualWeaponCargo"]},{"name":"BIS_fnc_greatestNum","title":"BIS fnc greatestNum","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_greatestNum","revid":326905,"updated":"2022-07-12T21:44:38Z","groups":["Arrays","Math"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Returns the greatest number out of the passed set.","syntaxes":[{"syntax":"numbers call BIS_fnc_greatestNum","params":[{"name":"numbers","type":"Array","description":"a set of numbers","type_expr":"Array"}],"returns":{"type":"Number","type_expr":"Number","description":"greatest number in the set"}}],"examples":[{"code":["private _result = [7,2,1,5,10] call BIS_fnc_greatestNum; //_result = 10"]}],"see_also":["BIS_fnc_lowestNum","BIS_fnc_findExtreme","selectMin","selectMax"]},{"name":"BIS_fnc_gridToPos","title":"BIS fnc gridToPos","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_gridToPos","revid":329531,"updated":"2022-07-30T12:57:54Z","groups":["Positions"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Converts grid coordinates to world position.\n\n> [!IMPORTANT]\n> - Correct results outside of the map area are not guaranteed.\n> - Does not work on machines with no UI like Dedicated Server or Headless Client - see hasInterface.","syntaxes":[{"syntax":"gridPosition call BIS_fnc_gridToPos","params":[{"name":"gridPosition","type":"String","optional":true,"default":"`mapGridPosition position cameraOn`","description":"accepts both \"024577\" or \"De82\" format","type_expr":"String","text":"gridPosition: String - (Optional, default `mapGridPosition position cameraOn`) accepts both \"024577\" or \"De82\" format"}],"returns":{"type":"Array of Numbers","type_expr":"Array<Number>","description":"in format [[gridX, gridY], [gridWidth, gridHeight]]","text":"Array of Numbers in format [[gridX, gridY], [gridWidth, gridHeight]]"}}],"examples":[{"code":["private _realPosition = \"183221\" call BIS_fnc_gridToPos;"]},{"code":["private _realPosition = \"He11\" call BIS_fnc_gridToPos;"]}],"see_also":["mapGridPosition"]},{"name":"BIS_fnc_groupFromNetId","title":"BIS fnc groupFromNetId","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_groupFromNetId","revid":327079,"updated":"2022-07-12T21:44:48Z","groups":["Multiplayer"],"status":"ok","games":{"arma3":"1.58"},"since":"arma3 1.58","arma3_since":"1.58","description":"Extends MP-only groupFromNetId functionality to SP","syntaxes":[{"syntax":"netId call BIS_fnc_groupFromNetId","params":[{"name":"netId","type":"String","type_expr":"String"}],"returns":{"type":"Group","type_expr":"Group","description":"existing group or grpNull"}}],"examples":[{"code":["private _grp = \"0:3\" call BIS_fnc_groupFromNetId;"]}],"see_also":["netId","objectFromNetId","groupFromNetId","BIS_fnc_netId","BIS_fnc_objectFromNetId"]},{"name":"BIS_fnc_groupIndicator","title":"BIS fnc groupIndicator","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_groupIndicator","revid":327105,"updated":"2022-07-12T21:44:50Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"effect":"local"},"description":"Displays Group Indicator (to the right of the screen in Arma 3 v1.82)","syntaxes":[{"syntax":"argument call BIS_fnc_groupIndicator","params":[{"name":"argument","type":"Array","description":"**case-sensitive**, can be:\n\n- [] - displays Group Indicator\n- [\"Exit\"] - closes Group Indicator","type_expr":"Array"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[] call BIS_fnc_groupIndicator; // starts group indicator"]},{"code":["[\"Exit\"] call BIS_fnc_groupIndicator; // closes group indicator"]}],"see_also":["Description.ext"]},{"name":"BIS_fnc_groupVehicles","title":"BIS fnc groupVehicles","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_groupVehicles","revid":327945,"updated":"2022-07-13T12:50:35Z","groups":["Vehicles"],"status":"ok","games":{"arma3":"0.76"},"since":"arma3 0.76","arma3_since":"0.76","description":"Returns all vehicles a group possesses, assigned vehicles can be included.","syntaxes":[{"syntax":"[target, assignedVeh] call BIS_fnc_groupVehicles","params":[{"name":"target","type":"Object or Group","description":"the unit or group to check, if unit is given it is group is then used","type_expr":"Object | Group"},{"name":"assignedVeh","type":"Boolean","description":"if assigned vehicles should also be returned (vehicles that unit's may not be inside of but assigned to)","type_expr":"Boolean"}],"returns":{"type":"Array","type_expr":"Array","description":"list of all vehicles in control/assigned to the group, empty if group has none"}}],"examples":[{"code":["[group player, true] call BIS_fnc_groupVehicles;"]}],"see_also":["group","createVehicle"]},{"name":"BIS_fnc_GUIbackground","title":"BIS fnc GUIbackground","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_GUIbackground","revid":348790,"updated":"2023-11-08T14:33:18Z","groups":["GUI"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Creates GUI background.","syntaxes":[{"syntax":"[position] call BIS_fnc_GUIbackground","params":[{"name":"position","type":"Array","description":"in format:\n0: - Position in X\n1: - Position in Y\n2: - Width\n3: - Height","type_expr":"Array"}],"returns":{"type":"Display","type_expr":"Display"}}],"examples":[{"code":["[1,1,1,1] call BIS_fnc_GUIbackground;"]}],"see_also":["GUI Coordinates","allDisplays"]},{"name":"BIS_fnc_GUIeditor","title":"BIS fnc GUIeditor","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_GUIeditor","revid":327608,"updated":"2022-07-13T09:50:31Z","groups":["GUI"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Opens the Arma 3: User Interface Editor.","syntaxes":[{"syntax":"call BIS_fnc_GUIeditor","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_GUIeditor;"]}],"see_also":["Arma 3: User Interface Editor"]},{"name":"BIS_fnc_guiEffectTiles","title":"BIS fnc guiEffectTiles","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_guiEffectTiles","revid":349401,"updated":"2023-11-08T16:27:25Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Used in dialogs to animate background UAV tiles. See notes for a full working example.","syntaxes":[{"syntax":"[display] call BIS_fnc_guiEffectTiles","params":[{"name":"display","type":"Display","description":"display to be animated","type_expr":"Display"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[findDisplay 49] call BIS_fnc_guiEffectTiles // display 49 - pause menu"]}],"see_also":["createDialog","findDisplay","User Interface Event Handlers"],"notes":[{"user":"BrotherhoodOfHam","date":"2014-09-30T17:36:00Z","text":"This function is only used for dialogs which have background UAV tiles (See the in game pause menu for example), since this is only really found in official dialogs documentation on this function doesn't really exist.\nTo set up your own dialog for use with this function it is actually fairly simple. Use the below example as a framework:\n\n```cpp\n// base classes\nclass RscControlsGroup\n{\n    class VScrollbar\n    {\n        color[] = { 1, 1, 1, 1 };\n        width = 0.021;\n        autoScrollEnabled = 1;\n\n        colorActive[] = { 1, 1, 1, 1 };\n        colorDisabled[] = { 1, 1, 1, 0.3 };\n        thumb = \"\\A3\\ui_f\\data\\gui\\cfg\\scrollbar\\thumb_ca.paa\";\n        arrowFull = \"\\A3\\ui_f\\data\\gui\\cfg\\scrollbar\\arrowFull_ca.paa\";\n        arrowEmpty = \"\\A3\\ui_f\\data\\gui\\cfg\\scrollbar\\arrowEmpty_ca.paa\";\n        border = \"\\A3\\ui_f\\data\\gui\\cfg\\scrollbar\\border_ca.paa\";\n    };\n\n    class HScrollbar : VScrollbar\n    {\n        color[] = { 1, 1, 1, 1 };\n        height = 0.028;\n    };\n\n    class Controls {};\n\n    type = 15;\n    idc = -1;\n    x = 0;\n    y = 0;\n    w = 1;\n    h = 1;\n    shadow = 0;\n    style = 16;\n};\n\nclass RscControlsGroupNoScrollbars : RscControlsGroup\n{\n    class VScrollbar : VScrollbar\n    {\n        width = 0;\n    };\n\n    class HScrollbar : HScrollbar\n    {\n        height = 0;\n    };\n};\n\nclass RscFrame\n{\n    type = 0;\n    idc = -1;\n    style = 64;\n    shadow = 2;\n    colorBackground[] = { 0, 0, 0, 0 };\n    colorText[] = {1,1,1,1};\n    font = \"PuristaMedium\";\n    sizeEx = 0.02;\n    text = \"\";\n};\n\nclass rscText\n{\n    access = 0;\n    type = 0;\n    idc = -1;\n    colorBackground[] = { 0, 0, 0, 0 };\n    colorText[] = { 1, 1, 1, 1 };\n    text = \"\";\n    fixedWidth = 0;\n    x = 0;\n    y = 0;\n    h = 0.037;\n    w = 0.3;\n    style = 0;\n    shadow = 1;\n    colorShadow[] = { 0, 0, 0, 0.5 };\n    font = \"PuristaMedium\";\n    SizeEx = \"(((((safezoneW / safezoneH) min 1.2) / 1.2) / 25) * 1)\";\n    linespacing = 1;\n    tooltipColorText[] = { 1, 1, 1, 1 };\n    tooltipColorBox[] = { 1, 1, 1, 1 };\n    tooltipColorShade[] = { 0, 0, 0, 0.65 };\n};\n\n///////////////////////////////////////////////////////////////////////////////////////////////////////////////////\n// actual dialog\n///////////////////////////////////////////////////////////////////////////////////////////////////////////////////\n\nclass rscTileExample\n{\n    idd = 2345;\n    onLoad = \"[_this select 0] call BIS_fnc_guiEffectTiles\";\n    onUnload = \"\";\n\n    class ControlsBackground\n    {\n        class TileGroup : RscControlsGroupNoScrollbars\n        {\n            idc = 115099;\n            x = \"safezoneX\";\n            y = \"safezoneY\";\n            w = \"safezoneW\";\n            h = \"safezoneH\";\n            disableCustomColors = 1;\n\n            class Controls\n            {\n                class TileFrame : RscFrame\n                {\n                    idc = 114999;\n                    x = 0;\n                    y = 0;\n                    w = \"safezoneW\";\n                    h = \"safezoneH\";\n                    colortext[] = { 0, 0, 0, 1 };\n                };\n\n                class Tile_0_0 : RscText\n                {\n                    idc = 115000;\n                    x = \"(0 * 1/6) * safezoneW\";\n                    y = \"(0 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_0_1 : RscText\n                {\n                    idc = 115001;\n                    x = \"(0 * 1/6) * safezoneW\";\n                    y = \"(1 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_0_2 : RscText\n                {\n                    idc = 115002;\n                    x = \"(0 * 1/6) * safezoneW\";\n                    y = \"(2 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_0_3 : RscText\n                {\n                    idc = 115003;\n                    x = \"(0 * 1/6) * safezoneW\";\n                    y = \"(3 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_0_4 : RscText\n                {\n                    idc = 115004;\n                    x = \"(0 * 1/6) * safezoneW\";\n                    y = \"(4 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_0_5 : RscText\n                {\n                    idc = 115005;\n                    x = \"(0 * 1/6) * safezoneW\";\n                    y = \"(5 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_1_0 : RscText\n                {\n                    idc = 115010;\n                    x = \"(1 * 1/6) * safezoneW\";\n                    y = \"(0 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_1_1 : RscText\n                {\n                    idc = 115011;\n                    x = \"(1 * 1/6) * safezoneW\";\n                    y = \"(1 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_1_2 : RscText\n                {\n                    idc = 115012;\n                    x = \"(1 * 1/6) * safezoneW\";\n                    y = \"(2 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_1_3 : RscText\n                {\n                    idc = 115013;\n                    x = \"(1 * 1/6) * safezoneW\";\n                    y = \"(3 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_1_4 : RscText\n                {\n                    idc = 115014;\n                    x = \"(1 * 1/6) * safezoneW\";\n                    y = \"(4 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_1_5 : RscText\n                {\n                    idc = 115015;\n                    x = \"(1 * 1/6) * safezoneW\";\n                    y = \"(5 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_2_0 : RscText\n                {\n                    idc = 115020;\n                    x = \"(2 * 1/6) * safezoneW\";\n                    y = \"(0 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_2_1 : RscText\n                {\n                    idc = 115021;\n                    x = \"(2 * 1/6) * safezoneW\";\n                    y = \"(1 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_2_2 : RscText\n                {\n                    idc = 115022;\n                    x = \"(2 * 1/6) * safezoneW\";\n                    y = \"(2 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_2_3 : RscText\n                {\n                    idc = 115023;\n                    x = \"(2 * 1/6) * safezoneW\";\n                    y = \"(3 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_2_4 : RscText\n                {\n                    idc = 115024;\n                    x = \"(2 * 1/6) * safezoneW\";\n                    y = \"(4 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_2_5 : RscText\n                {\n                    idc = 115025;\n                    x = \"(2 * 1/6) * safezoneW\";\n                    y = \"(5 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_3_0 : RscText\n                {\n                    idc = 115030;\n                    x = \"(3 * 1/6) * safezoneW\";\n                    y = \"(0 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_3_1 : RscText\n                {\n                    idc = 115031;\n                    x = \"(3 * 1/6) * safezoneW\";\n                    y = \"(1 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_3_2 : RscText\n                {\n                    idc = 115032;\n                    x = \"(3 * 1/6) * safezoneW\";\n                    y = \"(2 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_3_3 : RscText\n                {\n                    idc = 115033;\n                    x = \"(3 * 1/6) * safezoneW\";\n                    y = \"(3 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_3_4 : RscText\n                {\n                    idc = 115034;\n                    x = \"(3 * 1/6) * safezoneW\";\n                    y = \"(4 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_3_5 : RscText\n                {\n                    idc = 115035;\n                    x = \"(3 * 1/6) * safezoneW\";\n                    y = \"(5 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_4_0 : RscText\n                {\n                    idc = 115040;\n                    x = \"(4 * 1/6) * safezoneW\";\n                    y = \"(0 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_4_1 : RscText\n                {\n                    idc = 115041;\n                    x = \"(4 * 1/6) * safezoneW\";\n                    y = \"(1 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_4_2 : RscText\n                {\n                    idc = 115042;\n                    x = \"(4 * 1/6) * safezoneW\";\n                    y = \"(2 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_4_3 : RscText\n                {\n                    idc = 115043;\n                    x = \"(4 * 1/6) * safezoneW\";\n                    y = \"(3 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_4_4 : RscText\n                {\n                    idc = 115044;\n                    x = \"(4 * 1/6) * safezoneW\";\n                    y = \"(4 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_4_5 : RscText\n                {\n                    idc = 115045;\n                    x = \"(4 * 1/6) * safezoneW\";\n                    y = \"(5 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_5_0 : RscText\n                {\n                    idc = 115050;\n                    x = \"(5 * 1/6) * safezoneW\";\n                    y = \"(0 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_5_1 : RscText\n                {\n                    idc = 115051;\n                    x = \"(5 * 1/6) * safezoneW\";\n                    y = \"(1 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_5_2 : RscText\n                {\n                    idc = 115052;\n                    x = \"(5 * 1/6) * safezoneW\";\n                    y = \"(2 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_5_3 : RscText\n                {\n                    idc = 115053;\n                    x = \"(5 * 1/6) * safezoneW\";\n                    y = \"(3 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_5_4 : RscText\n                {\n                    idc = 115054;\n                    x = \"(5 * 1/6) * safezoneW\";\n                    y = \"(4 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n\n                class Tile_5_5 : RscText\n                {\n                    idc = 115055;\n                    x = \"(5 * 1/6) * safezoneW\";\n                    y = \"(5 * 1/6) * safezoneH\";\n                    w = \"1/6 * safezoneW\";\n                    h = \"1/6 * safezoneH\";\n                    colorBackground[] = { 0, 0, 0, 0.1 };\n                };\n            };\n        };\n    };\n\n    class controls\n    {\n        // populate with whatever other controls you are using in the actual dialog.\n    };\n};\n```\n\nYou would then execute the dialog the normal way:\n\n```sqf\ncreateDialog \"rscTileExample\";\n```"}]},{"name":"BIS_fnc_GUIgrid","title":"BIS fnc GUIgrid","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_GUIgrid","revid":348772,"updated":"2023-11-08T14:33:15Z","groups":["GUI"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Returns grid params and stores it into uiNamespace.","syntaxes":[{"syntax":"[category, grid] call BIS_fnc_GUIgrid","params":[{"name":"category","type":"String","optional":true,"default":"\"GUI\"","description":"category name","type_expr":"String","text":"category: String - (Optional, default \"GUI\") category name"},{"name":"grid","type":"String","optional":true,"default":"\"GRID\"","description":"grid name","type_expr":"String","text":"grid: String - (Optional, default \"GRID\") grid name"}],"returns":{"type":"Array","type_expr":"Array","description":"in format [[x,y,w,h],gridW,gridH]"}}],"examples":[{"code":["call BIS_fnc_GUIgrid; //[-0.452381,0.214286,1.2,1]"]}],"see_also":["BIS_fnc_GUIgridToProfile"]},{"name":"BIS_fnc_GUIgridToProfile","title":"BIS fnc GUIgridToProfile","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_GUIgridToProfile","revid":282999,"updated":"2021-06-16T22:11:28Z","groups":["GUI"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_GUIhint","title":"BIS fnc GUIhint","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_GUIhint","revid":364353,"updated":"2024-05-06T10:37:04Z","groups":["GUI"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Creates advanced hintC dialog","syntaxes":[{"syntax":"[param0] call BIS_fnc_GUIhint","params":[{"name":"param0","type":"Array","type_expr":"Array","optional":true,"description":"[text,picture]\n         text: STRING - hint text\n         picture: STRING - picture\n    [item1,item2...] - Listbox item ARRAYs in format\n        [itemText,itemDescription,picture,icon]\n             itemText: STRING - Text displayed in listbox\n             itemDescription (Optional): STRING - text displayed after clicking on item\n             picture (Optional): STRING - picture displayed after clicking on item\n             icon (Optional): STRING - icon displayed in listbox left from text\n_this select 1 (Optional): STRING - hint header\n_this select 2 (Optional): ARRAY - [STRING,CODE,NUMBER] - text on left button (when \"\", button is hidden), code executed upon clicking and fade out delay. If only text is present, button is disabled.\n_this select 3 (Optional): ARRAY - [STRING,CODE,NUMBER] - STRING - text on right button and code executed upon clicking\n_this select 4 (Optional): ARRAY - [STRING,CODE,NUMBER] - STRING - text on middle button and code executed upon clicking\n_this select 5 (Optional): NUMBER or ARRAY - width or [width,height] of picture (in grid coordinates). Width > 17 means only picture is used.","text":"0: ARRAY in format\n    [text,picture]\n         text: STRING - hint text\n         picture: STRING - picture\n    [item1,item2...] - Listbox item ARRAYs in format\n        [itemText,itemDescription,picture,icon]\n             itemText: STRING - Text displayed in listbox\n             itemDescription (Optional): STRING - text displayed after clicking on item\n             picture (Optional): STRING - picture displayed after clicking on item\n             icon (Optional): STRING - icon displayed in listbox left from text\n_this select 1 (Optional): STRING - hint header\n_this select 2 (Optional): ARRAY - [STRING,CODE,NUMBER] - text on left button (when \"\", button is hidden), code executed upon clicking and fade out delay. If only text is present, button is disabled.\n_this select 3 (Optional): ARRAY - [STRING,CODE,NUMBER] - STRING - text on right button and code executed upon clicking\n_this select 4 (Optional): ARRAY - [STRING,CODE,NUMBER] - STRING - text on middle button and code executed upon clicking\n_this select 5 (Optional): NUMBER or ARRAY - width or [width,height] of picture (in grid coordinates). Width > 17 means only picture is used.","source":"docblock"}],"returns":{"type":"Array","type_expr":"Array","description":"[endState(,lbId)]\n     endState: NUMBER - 1 when clicked on right button, -1 when clicked on left button, 0 when escaped\n     lbId: NUMBER - selected listbox item (when listbox was used)","text":"ARRAY - [endState(,lbId)]\n     endState: NUMBER - 1 when clicked on right button, -1 when clicked on left button, 0 when escaped\n     lbId: NUMBER - selected listbox item (when listbox was used)","source":"docblock"},"inferred":true}],"see_also":["BIS_fnc_GUImessage"],"docblock":{"text":"Description:\nCreates advanced hintC dialog\n\nParameter(s):\n_this select 0: ARRAY in format\n    [text,picture]\n         text: STRING - hint text\n         picture: STRING - picture\n    [item1,item2...] - Listbox item ARRAYs in format\n        [itemText,itemDescription,picture,icon]\n             itemText: STRING - Text displayed in listbox\n             itemDescription (Optional): STRING - text displayed after clicking on item\n             picture (Optional): STRING - picture displayed after clicking on item\n             icon (Optional): STRING - icon displayed in listbox left from text\n_this select 1 (Optional): STRING - hint header\n_this select 2 (Optional): ARRAY - [STRING,CODE,NUMBER] - text on left button (when \"\", button is hidden), code executed upon clicking and fade out delay. If only text is present, button is disabled.\n_this select 3 (Optional): ARRAY - [STRING,CODE,NUMBER] - STRING - text on right button and code executed upon clicking\n_this select 4 (Optional): ARRAY - [STRING,CODE,NUMBER] - STRING - text on middle button and code executed upon clicking\n_this select 5 (Optional): NUMBER or ARRAY - width or [width,height] of picture (in grid coordinates). Width > 17 means only picture is used.\n\nReturns:\nARRAY - [endState(,lbId)]\n     endState: NUMBER - 1 when clicked on right button, -1 when clicked on left button, 0 when escaped\n     lbId: NUMBER - selected listbox item (when listbox was used)"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_guiMessage","title":"BIS fnc guiMessage","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_guiMessage","revid":379269,"updated":"2026-10-30T23:44:03Z","groups":["GUI"],"status":"ok","games":{"arma3":"0.50"},"since":"arma3 0.50","arma3_since":"0.50","locality":{"effect":"local"},"exec":"call","description":"Displays an interactive message dialog in the center of the screen.\n\n> [!IMPORTANT]\n> This function internally utilizes suspension (waitUntil to be specific) and therefore has to be executed in a scheduled environment.","syntaxes":[{"syntax":"[message, header, okButton, cancelButton, parent, useParentBox, pause] call BIS_fnc_guiMessage","params":[{"name":"message","type":"String or Structured Text","optional":true,"default":"\"\"","description":"message","type_expr":"String | Structured Text","text":"message: String or Structured Text - (Optional, default: \"\") message"},{"name":"header","type":"String","optional":true,"default":"\"\"","description":"header text","type_expr":"String","text":"header: String - (Optional, default: \"\") header text"},{"name":"okButton","type":"Boolean or String","optional":true,"default":"true","description":"Boolean - enable the \"OK\" button\n- String - custom text for the \"OK\" button","type_expr":"Boolean | String","text":"okButton: Boolean or String - (Optional, default true):\n\n- Boolean - enable the \"OK\" button\n- String - custom text for the \"OK\" button"},{"name":"cancelButton","type":"Boolean or String","optional":true,"default":"false","description":"Boolean - enable the \"Cancel\" button\n- String - custom text for the \"Cancel\" button","type_expr":"Boolean | String","text":"cancelButton: Boolean or String - (Optional, default false):\n\n- Boolean - enable the \"Cancel\" button\n- String - custom text for the \"Cancel\" button"},{"name":"parent","type":"Display","optional":true,"default":"`[] call BIS_fnc_displayMission`","description":"parent display","type_expr":"Display","text":"parent: Display - (Optional, default: `[] call BIS_fnc_displayMission`) parent display"},{"name":"useParentBox","type":"Boolean","optional":true,"default":"false","description":"try to use control inherited from \"RscMessageBox\" in parent instead of creating a new one","type_expr":"Boolean","text":"useParentBox: Boolean - (Optional, default: false) try to use control inherited from \"RscMessageBox\" in parent instead of creating a new one"},{"name":"pause","type":"Boolean","optional":true,"default":"true","description":"pause simulation while message dialog is open (no effect in multiplayer)","type_expr":"Boolean","text":"pause: Boolean - (Optional, default: true) pause simulation while message dialog is open (no effect in multiplayer)"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if the \"OK\" button was pressed, otherwise false. Returned only after the message box is closed."}}],"examples":[{"text":"Because this example uses spawn, the return value of BIS_fnc_guiMessage is lost and can not be used.\n\n```sqf\n[\"Hello World\"] spawn BIS_fnc_guiMessage;\n```","code":["[\"Hello World\"] spawn BIS_fnc_guiMessage;"]},{"text":"```sqf\nprivate _result = [\"Are you sure?\", \"Confirm\", true, true] call BIS_fnc_guiMessage;\n\nif (_result) then {\n    systemChat \"The player is sure.\";\n} else {\n    systemChat \"The player is not sure.\";\n};\n```","code":["private _result = [\"Are you sure?\", \"Confirm\", true, true] call BIS_fnc_guiMessage;\n\nif (_result) then {\n\tsystemChat \"The player is sure.\";\n} else {\n\tsystemChat \"The player is not sure.\";\n};"]}],"see_also":["BIS_fnc_GUIhint","BIS_fnc_3DENShowMessage","hintC"],"notes":[{"user":"AgentRev","date":"2014-06-24T00:43:00Z","text":"Message boxes can be force-closed with:\n\n```sqf\nuiNamespace setVariable [\"BIS_fnc_guiMessage_status\", false];\n```"},{"user":"Eden","date":"2016-01-13T15:16:00Z","text":"Calling this function can cause an game crash. When doing this you have to spawn the function or add an spawn around it so you can use the result:\n\n```sqf\n[] spawn\n{\n    private _result = [\"Are you sure?\", \"Confirm\", true, true] call BIS_fnc_guiMessage;\n    // Use _result here\n};\n```"},{"user":"Demellion","date":"2017-11-01T18:35:00Z","text":"This function only exists along with mission display (findDisplay 46). If this function is called before with *-skipIntro* parameter enabled (see Arma 3: Startup Parameters) it will result as Void."}],"categories_extra":["Introduced with Take On Helicopters version 1.00","Take On Helicopters: Functions","Take On Helicopters: New Functions"]},{"name":"BIS_fnc_GUInewsfeed","title":"BIS fnc GUInewsfeed","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_GUInewsfeed","revid":348483,"updated":"2023-11-08T13:01:28Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Load newsfeed.","syntaxes":[{"syntax":"[display] call BIS_fnc_GUInewsfeed","params":[{"name":"display","type":"Display","description":"display where newsfeed with IDC 1101 is","type_expr":"Display"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when online"}}],"examples":[{"code":["[_display] call BIS_fnc_GUInewsfeed;"]}],"see_also":["findDisplay"]},{"name":"BIS_fnc_halo","title":"BIS fnc halo","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_halo","revid":327955,"updated":"2022-07-13T13:04:47Z","groups":["Systems"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Makes a High Altitude Low Opening (HALO) parachute jump.\n\n> [!NOTE]\n> **Arma 3:** HALO feature is already implemented in Arma 3. Using this function will result in incorrect behaviour and animation.","syntaxes":[{"syntax":"[unit, altitude] call BIS_fnc_halo","params":[{"name":"unit","type":"Object","description":"the HALO-performing unit","type_expr":"Object"},{"name":"altitude","type":"Number","optional":true,"default":"0","description":"altitude added to the unit before HALO","type_expr":"Number","text":"altitude: Number - (Optional, default 0) altitude added to the unit before HALO"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[player] call BIS_fnc_halo; // instantly parachutes the player object"]},{"code":["[player, 100] call BIS_fnc_halo; // increases the altitude of player by 100 before HALO"]}],"see_also":["setUnitFreefallHeight","getUnitFreefallInfo"]},{"name":"BIS_fnc_halt","title":"BIS fnc halt","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_halt","revid":348819,"updated":"2023-11-08T14:38:18Z","groups":["Program Flow"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Halts current function and all its parents and logs an error message.","syntaxes":[{"syntax":"[param1, param2, ..., param10] call BIS_fnc_halt","params":[{"name":"param1","type":"String","description":"logged message (formatted)","type_expr":"String"},{"name":"param2","description":"param10: Anything","type_expr":"Anything"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[\"You are now supposed to be %1\", rank player] call BIS_fnc_halt;"]}]},{"name":"BIS_fnc_hasItem","title":"BIS fnc hasItem","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_hasItem","revid":328409,"updated":"2022-07-13T16:00:50Z","groups":["Inventory"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Returns true if object contains given item in inventory / cargo storage.\n\n> [!IMPORTANT]\n> This function performs a deep search of inventory / cargo storage, thus is not suitable for per-frame execution.","syntaxes":[{"syntax":"[object, item, searchCrew] call BIS_fnc_hasItem","params":[{"name":"object","type":"Object or Group","description":"unit, vehicle, container or group of units (since v1.95)","type_expr":"Object | Group"},{"name":"item","type":"String","description":"item to find","type_expr":"String"},{"name":"searchCrew","type":"Boolean","optional":true,"default":"false","description":"true to search vehicle crew as well if object is a vehicle","type_expr":"Boolean","text":"searchCrew: Boolean - (Optional, default false) true to search vehicle crew as well if object is a vehicle"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if has item"}}],"examples":[{"code":["[player, \"ItemMap\"] call BIS_fnc_hasItem;"]},{"code":["[tank, \"FirstAidKit\", true] call BIS_fnc_hasItem;"]}]},{"name":"BIS_fnc_hatchClose","title":"BIS fnc hatchClose","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_hatchClose","revid":273951,"updated":"2021-06-13T01:14:02Z","groups":["Scripts"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_hatchClose","params":[],"returns":null}]},{"name":"BIS_fnc_hatchOpen","title":"BIS fnc hatchOpen","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_hatchOpen","revid":274092,"updated":"2021-06-13T01:16:29Z","groups":["Scripts"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_hatchOpen","params":[],"returns":null}]},{"name":"BIS_fnc_healing","title":"BIS fnc healing","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_healing","revid":352134,"updated":"2024-02-01T23:25:10Z","groups":["Broken Functions","Feedback"],"status":"broken","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Healing postprocess. Supposed to give healing postprocess effects.\n\n> [!WARNING]\n> This function is unfinished, must not and **cannot** be used!","syntaxes":[{"syntax":"call BIS_fnc_healing","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_healing; // do NOT use"]}],"see_also":["BIS_fnc_healthEffects"]},{"name":"BIS_fnc_healthEffects","title":"BIS fnc healthEffects","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_healthEffects","revid":309300,"updated":"2022-05-05T12:04:16Z","groups":["Feedback"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Effects when player is hit. Parameters are sent by the HandleDamage event handler.","syntaxes":[{"syntax":"call BIS_fnc_healthEffects","params":[],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["call BIS_fnc_healthEffects;"]}],"see_also":["BIS_fnc_healing"]},{"name":"BIS_fnc_helicopterCanFly","title":"BIS fnc helicopterCanFly","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_helicopterCanFly","revid":309751,"updated":"2022-05-05T12:09:48Z","groups":["Helicopters"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_helicopterDamage","title":"BIS fnc helicopterDamage","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_helicopterDamage","revid":370866,"updated":"2025-02-21T10:43:59Z","groups":["Helicopters"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Handling EH-based helicopter damage, event handler in question being Da*mm*aged [sic].\n\n> [!NOTE]\n> Executed script is:\n>\n> ```sqf\n> helicopter execVM \"hsim\\air_h\\data\\scripts\\main_rotor_destruction.sqf\";\n> ```\n>\n> helicopter rotor status can be found via variable **HSim_mainRotorDestroyed**:\n>\n> ```sqf\n> _isRotorDestroyed = helicopter getVariable [\"HSim_mainRotorDestroyed\", false];\n> ```","syntaxes":[{"syntax":"[helicopter, selection, damage] call BIS_fnc_helicopterDamage","params":[{"name":"helicopter","type":"Object","type_expr":"Object"},{"name":"selection","type":"String","description":"name of the helicopter selection receiving damage. Must be \"main rotor\"","type_expr":"String"},{"name":"damage","type":"Number","description":"*selection'*s damage. Will only trigger effects if *damage* > 0.999","type_expr":"Number"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when done"}}],"examples":[{"code":["myHelicopter addEventHandler [\"Dammaged\", { _this call BIS_fnc_helicopterDamage; }];"]}]},{"name":"BIS_fnc_helicopterGetHitpoints","title":"BIS fnc helicopterGetHitpoints","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_helicopterGetHitpoints","revid":348648,"updated":"2023-11-08T13:48:24Z","groups":["Helicopters"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Return all hitpoints for a helicopter.","syntaxes":[{"syntax":"object call BIS_fnc_helicopterGetHitpoints","params":[{"name":"object","type":"Object","description":"helicopter","type_expr":"Object"}],"returns":{"type":"Array of Strings","type_expr":"Array<String>"}}],"examples":[{"code":["[BIS_helicopter] call BIS_fnc_helicopterGetHitpoints;"]}],"see_also":["setDamage","setDammage","getDammage","setHit","getHit","getHitIndex","setHitIndex","getHitPointDamage","setHitPointDamage"]},{"name":"BIS_fnc_helicopterSeat","title":"BIS fnc helicopterSeat","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_helicopterSeat","revid":323864,"updated":"2022-07-01T11:53:44Z","groups":["Helicopters"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Check if unit sits on right or left seat.","syntaxes":[{"syntax":"unit call BIS_fnc_helicopterSeat","params":[{"name":"unit","type":"Object","description":"unit which should be checked.","type_expr":"Object"}],"returns":{"type":"Number","type_expr":"Number","description":"- -1: Not in a vehicle - 0: left seat - 1: right seat","text":"Number:\n\n- -1: Not in a vehicle\n-  0: left seat\n-  1: right seat"}}],"examples":[{"code":["player call BIS_fnc_helicopterSeat;"]}],"see_also":["moveInDriver","crew","BIS_fnc_helicopterSeatMove"]},{"name":"BIS_fnc_helicopterSeatMove","title":"BIS fnc helicopterSeatMove","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_helicopterSeatMove","revid":327331,"updated":"2022-07-12T22:11:54Z","groups":["Helicopters"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Plays cockpit animation. **Take On Helicopters only**.","syntaxes":[{"syntax":"[unit, gesture] call BIS_fnc_helicopterSeatMove","params":[{"name":"unit","type":"Object","type_expr":"Object"},{"name":"gesture","type":"String","description":"can be one of:\n\n- \"greet\"\n- \"look\"\n- \"point\"\n- \"thumbDown\"\n- \"thumbUp\"","type_expr":"String"}],"returns":{"type":"String","type_expr":"String","description":"animation full name - \"\" if animation not found"}}],"examples":[{"code":["[instructor, \"thumbUp\"] call BIS_fnc_helicopterSeatMove;"]}],"see_also":["switchMove","BIS_fnc_helicopterSeat","BIS_fnc_helicopterType"]},{"name":"BIS_fnc_helicopterType","title":"BIS fnc helicopterType","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_helicopterType","revid":348739,"updated":"2023-11-08T14:32:10Z","groups":["Helicopters"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Returns helicopter type.","syntaxes":[{"syntax":"[object] call BIS_fnc_helicopterType","params":[{"name":"start","type":"Object","description":"helicopter to be checked.","type_expr":"Object"}],"returns":{"type":"Number","type_expr":"Number","description":"one of:\n- -1 - Unknown - 0 - Light - 1 - Medium - 2 - Heavy","text":"Number - one of:\n\n- -1 - Unknown\n-  0 - Light\n-  1 - Medium\n-  2 - Heavy"}}],"examples":[{"code":["private _helicopterType = [vehicle player] call BIS_fnc_helicopterType;"]}],"see_also":["typeOf"]},{"name":"BIS_fnc_help","title":"BIS fnc help","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_help","revid":309386,"updated":"2022-05-05T12:04:33Z","groups":["Diagnostic"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","locality":{"effect":"local"},"description":"Opens the Functions Viewer which lists all functions defined in:\n\n- Arma 2: Functions Library (Also Arma 2: Operation Arrowhead)\n- Arma 3: Functions Library\n- Take On Helicopters: Functions Library","syntaxes":[{"syntax":"parentDisplay call BIS_fnc_help","params":[{"name":"parentDisplay","type":"Display","optional":true,"default":"displayNull","type_expr":"Display","text":"parentDisplay: Display - (Optional, default displayNull)"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_help;"]}],"see_also":["Arma 3: Functions Viewer"]},{"name":"BIS_fnc_hermite","title":"BIS fnc hermite","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_hermite","revid":274035,"updated":"2021-06-13T01:15:33Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_hermite","params":[],"returns":null}]},{"name":"BIS_fnc_hermiteVector","title":"BIS fnc hermiteVector","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_hermiteVector","revid":273881,"updated":"2021-06-13T01:12:48Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_hermiteVector","params":[],"returns":null}]},{"name":"BIS_fnc_HEXtoRGB","title":"BIS fnc HEXtoRGB","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_HEXtoRGB","revid":378164,"updated":"2026-03-02T12:35:10Z","groups":["Math"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Convert RGBA hexcode color into RGBA array format.","syntaxes":[{"syntax":"[hexString] call BIS_fnc_HEXtoRGB","params":[{"name":"hexString","type":"String","description":"string representing **4 bytes** of HEX color","type_expr":"String"}],"returns":{"type":"Array format Color (RGBA)","types":["Array","Color"],"type_expr":"Color","description":"array of 4 numbers in range 0..1","text":"Array format Color (RGBA) - array of **4** numbers in range 0..1"}}],"examples":[{"code":["[\"025D00FF\"] call BIS_fnc_HEXtoRGB; // [0.007843, 0.843138, 0, 1]"]},{"text":"Usually HEX code is represented as 3 bytes without alpha, so you can add it yourself:\n\n```sqf\n_hexstring = \"025D00\";\n[_hexString + \"FF\"] call BIS_fnc_HEXtoRGB; // add alpha 4th byte\n```","code":["_hexstring = \"025D00\";\n[_hexString + \"FF\"] call BIS_fnc_HEXtoRGB; // add alpha 4th byte"]}],"see_also":["Color","BIS_fnc_colorConfigToRGBA","BIS_fnc_colorRGBAtoHTML","BIS_fnc_colorRGBtoHTML","BIS_fnc_colorRGBAtoTexture"]},{"name":"BIS_fnc_hideMarker","title":"BIS fnc hideMarker","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_hideMarker","revid":373735,"updated":"2025-06-24T12:24:32Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","locality":{"argument":"global","effect":"global"},"exec":"spawn","description":"Gradual hiding of a marker by setting its alpha to 0.","syntaxes":[{"syntax":"[marker, duration] spawn BIS_fnc_hideMarker","params":[{"name":"marker","type":"String","description":"marker name","type_expr":"String"},{"name":"duration","type":"Number","optional":true,"default":"1","description":"duration of the hiding","type_expr":"Number","text":"duration: Number - (Optional, default 1) duration of the hiding"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"BIS_marker\",2] spawn BIS_fnc_hideMarker;"]}],"see_also":["BIS_fnc_blinkMarker","BIS_fnc_colorMarker","BIS_fnc_moveMarker"]},{"name":"BIS_fnc_hideMarkerArray","title":"BIS fnc hideMarkerArray","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_hideMarkerArray","revid":348051,"updated":"2023-11-08T11:28:50Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","locality":{"argument":"global","effect":"global"},"exec":"spawn","description":"Hides a list of markers one by one.","syntaxes":[{"syntax":"[markerArray, duration] spawn BIS_fnc_hideMarkerArray","params":[{"name":"markerArray","type":"Array of Strings","description":"array of marker names","type_expr":"Array<String>"},{"name":"duration","type":"Number","optional":true,"default":"1","description":"duration in seconds until all markers are hidden. If duration is 0 markers are hidden as fast as possible","type_expr":"Number","text":"duration: Number - (Optional, default 1) duration in seconds until all markers are hidden. If duration is 0 markers are hidden as fast as possible"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[[\"BIS_marker_1\", \"BIS_marker_2\", \"BIS_marker_3\"], 5] spawn BIS_fnc_hideMarkerArray;"]}],"see_also":["BIS_fnc_blinkMarker","BIS_fnc_changeColorMarker","BIS_fnc_getMarkers","BIS_fnc_getMarkerState","BIS_fnc_colorMarker"]},{"name":"BIS_fnc_highlightControl","title":"BIS fnc highlightControl","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_highlightControl","revid":349033,"updated":"2023-11-08T14:47:13Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"Highlights given control by drawing a border around it and letting it pulsate. The effect is visible until explicitly removed.","syntaxes":[{"syntax":"[displayOrControl, thickness] call BIS_fnc_highlightControl","params":[{"name":"displayOrControl","type":"Control","description":"can be a Control or a Display. When a display is passed as parameter, the function will delete the previously created highlight control on that given display.","type_expr":"Control"},{"name":"thickness","type":"Number","optional":true,"default":"20","description":"thickness of the border","type_expr":"Number","text":"thickness: Number - (Optional, default 20) thickness of the border"}],"returns":{"type":"Control","type_expr":"Control","description":"returns the created highlight control."}}],"examples":[{"text":"```sqf\n[findDisplay 313 displayCtrl 1023] call BIS_fnc_highlightControl;    // highlights the play button in Eden Editor\n[findDisplay 313] call BIS_fnc_highlightControl;                    // removes the previously created highlight effect\n```","code":["[findDisplay 313 displayCtrl 1023] call BIS_fnc_highlightControl;\t// highlights the play button in Eden Editor\n[findDisplay 313] call BIS_fnc_highlightControl;\t\t\t\t\t// removes the previously created highlight effect"]},{"code":["[] spawn\n{\n  disableSerialization;\n  private _ctrlHighlight = [findDisplay 313 displayCtrl 1023),5] call BIS_fnc_highlightControl;\n  sleep 2;\n  ctrlDelete _ctrlHighlight;\n}; // highlights the play button in Eden Editor and removes the effect after two seconds"]}]},{"name":"BIS_fnc_holdActionAdd","title":"BIS fnc holdActionAdd","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_holdActionAdd","revid":376577,"updated":"2025-10-28T11:45:09Z","groups":["Interaction"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","locality":{"argument":"global","effect":"local"},"description":"Adds an action to an object which requires the user to hold a key to perform the action.\n\n> [!NOTE]\n> Extraction script can be found on the Biki Export Scripts page.\n\nAvailable official icons as of Arma 3 v2.10:\n\n- \"\\a3\\Missions_F_Orange\\Data\\Img\\Showcase_LawsOfWar\\action_access_fm_CA.paa\"\n- \"\\a3\\Missions_F_Orange\\Data\\Img\\Showcase_LawsOfWar\\action_end_sim_CA.paa\"\n- \"\\a3\\Missions_F_Orange\\Data\\Img\\Showcase_LawsOfWar\\action_exit_CA.paa\"\n- \"\\a3\\Missions_F_Orange\\Data\\Img\\Showcase_LawsOfWar\\action_start_sim_CA.paa\"\n- \"\\a3\\Missions_F_Orange\\Data\\Img\\Showcase_LawsOfWar\\action_view_article_CA.paa\"\n- \"\\a3\\data_f_destroyer\\data\\UI\\IGUI\\Cfg\\holdactions\\holdAction_loadVehicle_ca.paa\"\n- \"\\a3\\data_f_destroyer\\data\\UI\\IGUI\\Cfg\\holdactions\\holdAction_unloadVehicle_ca.paa\"\n- \"\\a3\\missions_f_oldman\\data\\img\\holdactions\\holdAction_box_ca.paa\"\n- \"\\a3\\missions_f_oldman\\data\\img\\holdactions\\holdAction_follow_start_ca.paa\"\n- \"\\a3\\missions_f_oldman\\data\\img\\holdactions\\holdAction_follow_stop_ca.paa\"\n- \"\\a3\\missions_f_oldman\\data\\img\\holdactions\\holdAction_talk_ca.paa\"\n- \"\\a3\\props_f_enoch\\items\\tools\\data\\tinfoil_action_ca.paa\"\n- \"\\a3\\ui_f\\data\\IGUI\\Cfg\\holdactions\\holdAction_connect_ca.paa\"\n- \"\\a3\\ui_f\\data\\IGUI\\Cfg\\holdactions\\holdAction_forceRespawn_ca.paa\"\n- \"\\a3\\ui_f\\data\\IGUI\\Cfg\\holdactions\\holdAction_hack_ca.paa\"\n- \"\\a3\\ui_f\\data\\IGUI\\Cfg\\holdactions\\holdAction_loaddevice_ca.paa\"\n- \"\\a3\\ui_f\\data\\IGUI\\Cfg\\holdactions\\holdAction_passleadership_ca.paa\"\n- \"\\a3\\ui_f\\data\\IGUI\\Cfg\\holdactions\\holdAction_requestleadership_ca.paa\"\n- \"\\a3\\ui_f\\data\\IGUI\\Cfg\\holdactions\\holdAction_reviveMedic_ca.paa\"\n- \"\\a3\\ui_f\\data\\IGUI\\Cfg\\holdactions\\holdAction_revive_ca.paa\"\n- \"\\a3\\ui_f\\data\\IGUI\\Cfg\\holdactions\\holdAction_search_ca.paa\"\n- \"\\a3\\ui_f\\data\\IGUI\\Cfg\\holdactions\\holdAction_secure_ca.paa\"\n- \"\\a3\\ui_f\\data\\IGUI\\Cfg\\holdactions\\holdAction_takeOff1_ca.paa\"\n- \"\\a3\\ui_f\\data\\IGUI\\Cfg\\holdactions\\holdAction_takeOff2_ca.paa\"\n- \"\\a3\\ui_f\\data\\IGUI\\Cfg\\holdactions\\holdAction_thumbsdown_ca.paa\"\n- \"\\a3\\ui_f\\data\\IGUI\\Cfg\\holdactions\\holdAction_thumbsup_ca.paa\"\n- \"\\a3\\ui_f\\data\\IGUI\\Cfg\\holdactions\\holdAction_unbind_ca.paa\"\n- \"\\a3\\ui_f\\data\\IGUI\\Cfg\\holdactions\\holdAction_unloaddevice_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\idle\\idle_0_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\idle\\idle_1_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\idle\\idle_2_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\idle\\idle_3_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\idle\\idle_4_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\idle\\idle_5_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\idle\\idle_6_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\idle\\idle_7_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\idle\\idle_8_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\idle\\idle_9_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\idle\\idle_10_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\idle\\idle_11_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\in\\in_0_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\in\\in_1_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\in\\in_2_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\in\\in_3_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress2\\progress_0_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress2\\progress_1_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress2\\progress_2_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress2\\progress_3_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress2\\progress_4_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress2\\progress_5_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress2\\progress_6_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress2\\progress_7_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress2\\progress_8_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress2\\progress_9_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress2\\progress_10_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress2\\progress_11_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress2\\progress_12_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress2\\progress_13_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress2\\progress_14_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress2\\progress_15_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress2\\progress_16_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress2\\progress_17_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress2\\progress_18_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress2\\progress_19_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress2\\progress_20_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress2\\progress_21_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress2\\progress_22_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress2\\progress_23_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress2\\progress_24_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress\\progress_0_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress\\progress_1_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress\\progress_2_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress\\progress_3_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress\\progress_4_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress\\progress_5_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress\\progress_6_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress\\progress_7_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress\\progress_8_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress\\progress_9_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress\\progress_10_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress\\progress_11_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress\\progress_12_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress\\progress_13_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress\\progress_14_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress\\progress_15_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress\\progress_16_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress\\progress_17_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress\\progress_18_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress\\progress_19_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress\\progress_20_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress\\progress_21_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress\\progress_22_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress\\progress_23_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\holdactions\\progress\\progress_24_ca.paa\"\n- \"\\a3\\ui_f_oldman\\data\\IGUI\\Cfg\\holdactions\\attack_ca.paa\"\n- \"\\a3\\ui_f_oldman\\data\\IGUI\\Cfg\\holdactions\\destroy_ca.paa\"\n- \"\\a3\\ui_f_oldman\\data\\IGUI\\Cfg\\holdactions\\holdAction_market_ca.paa\"\n- \"\\a3\\ui_f_oldman\\data\\IGUI\\Cfg\\holdactions\\holdAction_sleep2_ca.paa\"\n- \"\\a3\\ui_f_oldman\\data\\IGUI\\Cfg\\holdactions\\holdAction_sleep_ca.paa\"\n- \"\\a3\\ui_f_oldman\\data\\IGUI\\Cfg\\holdactions\\map_ca.paa\"\n- \"\\a3\\ui_f_oldman\\data\\IGUI\\Cfg\\holdactions\\meet_ca.paa\"\n- \"\\a3\\ui_f_oldman\\data\\IGUI\\Cfg\\holdactions\\refuel_ca.paa\"\n- \"\\a3\\ui_f_oldman\\data\\IGUI\\Cfg\\holdactions\\repair_ca.paa\"\n- \"\\a3\\ui_f_orange\\Data\\CfgOrange\\Missions\\action_aaf_ca.paa\"\n- \"\\a3\\ui_f_orange\\Data\\CfgOrange\\Missions\\action_csat_ca.paa\"\n- \"\\a3\\ui_f_orange\\Data\\CfgOrange\\Missions\\action_escape_ca.paa\"\n- \"\\a3\\ui_f_orange\\Data\\CfgOrange\\Missions\\action_fia_ca.paa\"\n- \"\\a3\\ui_f_orange\\Data\\CfgOrange\\Missions\\action_fragment_back_ca.paa\"\n- \"\\a3\\ui_f_orange\\Data\\CfgOrange\\Missions\\action_fragment_ca.paa\"\n- \"\\a3\\ui_f_orange\\Data\\CfgOrange\\Missions\\action_idap_ca.paa\"\n- \"\\a3\\ui_f_orange\\Data\\CfgOrange\\Missions\\action_nato_ca.paa\"\n- \"\\a3\\ui_f_aow\\data\\igui\\cfg\\holdactions\\holdaction_charity_ca.paa\"\n\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\takeflag_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\talk_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\unloadallvehicles_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\unloadincapacitated_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\unloadvehicle_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\vtolvectoring_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\vtolvectoringcancel_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\arrow_down_gs.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\arrow_up_gs.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\autohover_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\bandage_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\beacons_off_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\beacons_on_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\cancelhover_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\clear_empty_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\close_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\eject_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\engine_off_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\engine_on_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\flapsextend_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\flapsretract_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\gear_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\getincargo_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\getincommander_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\getindriver_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\getingunner_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\getinpilot_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\getout_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\heal_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\ico_cpt_batt_off_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\ico_cpt_batt_on_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\ico_cpt_brk_on_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\ico_cpt_col_off_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\ico_cpt_col_on_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\ico_cpt_land_off_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\ico_cpt_land_on_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\ico_cpt_start_off_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\ico_cpt_start_on_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\ico_cpt_thtl_idl_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\ico_cpt_thtl_off_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\ico_cpt_thtl_on_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\ico_off_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\ico_on_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\ladderdown_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\ladderoff_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\ladderup_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\landingautopilot_off_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\landingautopilot_on_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\loadvehicle_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\open_door_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\periscopedepth_off_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\periscopedepth_on_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\radaroff_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\radaron_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\reammo_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\refuel_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\reload_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\repair_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\returnflag_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\settimer_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\take_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\obsolete\\ui_action_arrow_up_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\obsolete\\ui_action_cancel_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\obsolete\\ui_action_cancel_manualfire_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\obsolete\\ui_action_deactivate_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\obsolete\\ui_action_enter_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\obsolete\\ui_action_exit_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\obsolete\\ui_action_fire_in_flame_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\obsolete\\ui_action_fire_put_down_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\obsolete\\ui_action_gear_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\obsolete\\ui_action_getin_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\obsolete\\ui_action_getincargo.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\obsolete\\ui_action_ladderondown_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\obsolete\\ui_action_ladderonup_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\obsolete\\ui_action_manualfire_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\obsolete\\ui_action_open_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\obsolete\\ui_action_takemagazine_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\obsolete\\ui_action_takemine_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\obsolete\\ui_action_takeweapon_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\obsolete\\ui_action_teamswitch_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\obsolete\\ui_action_turnin_ca.paa\"\n- \"\\a3\\ui_f\\data\\igui\\cfg\\actions\\obsolete\\ui_action_turnout_ca.paa\"\n- \"\\a3\\ui_f_jets\\data\\igui\\cfg\\actions\\action_attachtocatapult_ca.paa\"\n- \"\\a3\\ui_f_jets\\data\\igui\\cfg\\actions\\action_detachtocatapult_ca.paa\"\n- \"\\a3\\ui_f_jets\\data\\igui\\cfg\\actions\\action_launchfromcatapult_ca.paa\"\n\n```sqf\n0 spawn\n{\n    // EXECUTE IN EDEN EDITOR OR EDITOR PREVIEW!\n    disableSerialization;\n\n    private _display = findDisplay 313 createDisplay \"RscDisplayEmpty\";\n\n    private _edit = _display ctrlCreate [\"RscEdit\", 645];\n    _edit ctrlSetPosition [safezoneX + 50 * pixelW, safezoneY + 50 * pixelH, safezoneW - 500 * pixelW, 50 * pixelH];\n    _edit ctrlSetBackgroundColor [0,0,0,1];\n    _edit ctrlCommit 0;\n\n    private _status = _display ctrlCreate [\"RscEdit\", 1337];\n    _status ctrlSetPosition [safezoneX + safezoneW - 400 * pixelW, safezoneY + 50 * pixelH, 350 * pixelW, 50 * pixelH];\n    _status ctrlSetBackgroundColor [0,0,0,1];\n    _status ctrlCommit 0;\n    _status ctrlEnable false;\n\n    private _tv = _display ctrlCreate [\"RscTreeSearch\", -1];\n    _tv ctrlSetFont \"EtelkaMonospacePro\";\n    _tv ctrlSetFontHeight 0.05;\n    _tv ctrlSetPosition [safezoneX + 50 * pixelW, safezoneY + 125 * pixelH, safezoneW - 100 * pixelW, safeZoneH - 175 * pixelH];\n    _tv ctrlSetBackgroundColor [0,0,0,1];\n    _tv ctrlCommit 0;\n\n    _tv ctrlAddEventHandler [\"treeSelChanged\",\n    {\n        params [\"_ctrlTV\", \"_selectionPath\"];\n        copyToClipboard (_ctrlTV tvText _selectionPath);\n        playSound (\"RscDisplayCurator_ping\" + selectRandom [\"01\", \"02\", \"03\", \"04\", \"05\", \"06\", \"07\", \"08\", \"09\", \"10\"]);\n        (ctrlParent _ctrlTv) displayCtrl 1337 ctrlSetText \"Path copied to clipboard!\";\n    }];\n\n    private _counter = 0;\n    {\n        private _files = addonFiles [_x # 0, \".paa\"];\n        {\n            if (\"\\actions\" in _x || \"\\holdaction\" in _x) then\n            {\n                _counter = _counter + 1;\n                _status ctrlSetText format [\"%1 textures found.\", _counter];\n                private _index = _tv tvAdd [[], _x];\n                _tv tvSetPicture [[_index], _x];\n            };\n        } forEach _files;\n    } foreach allAddonsInfo;\n\n    _tv tvSortall [[], false];\n};\n```","syntaxes":[{"syntax":"[target, title, idleIcon, progressIcon, conditionShow, conditionProgress, codeStart, codeProgress, codeCompleted, codeInterrupted, arguments, duration, priority, removeCompleted, showUnconscious, showWindow, radius, selection, memoryPoint] call BIS_fnc_holdActionAdd","params":[{"name":"target","type":"Object","description":"object the action is attached to","type_expr":"Object"},{"name":"title","type":"String","description":"title of the action shown in the action menu.It can contain Structured Text tags, such as `<t color='#FFAA00'>text</t>`","type_expr":"String"},{"name":"idleIcon","type":"String","optional":true,"default":"\"\\A3\\Ui_f\\data\\IGUI\\Cfg\\HoldActions\\holdAction_revive_ca.paa\"","description":"path of the idle icon shown on screen","type_expr":"String","text":"idleIcon: String - (Optional, default \"\\A3\\Ui_f\\data\\IGUI\\Cfg\\HoldActions\\holdAction_revive_ca.paa\") path of the idle icon shown on screen"},{"name":"progressIcon","type":"String","optional":true,"default":"\"\\A3\\Ui_f\\data\\IGUI\\Cfg\\HoldActions\\holdAction_revive_ca.paa\"","description":"path of the progress icon shown on screen","type_expr":"String","text":"progressIcon: String - (Optional, default \"\\A3\\Ui_f\\data\\IGUI\\Cfg\\HoldActions\\holdAction_revive_ca.paa\") path of the progress icon shown on screen"},{"name":"conditionShow","type":"String","optional":true,"default":"\"true\"","description":"condition for the action to be shown.\nSpecial arguments passed to the code: `_target` (action-attached object), `_this` (caller/executing unit)","type_expr":"String","text":"conditionShow: String - (Optional, default \"true\") condition for the action to be shown.\nSpecial arguments passed to the code: `_target` (action-attached object), `_this` (caller/executing unit)"},{"name":"conditionProgress","type":"String","optional":true,"default":"\"true\"","description":"condition for the action to progress; if false is returned action progress is paused.\nSpecial arguments passed to the code: `_target`, `_caller`, `_actionId`, `_arguments`","type_expr":"String","text":"conditionProgress: String - (Optional, default \"true\") condition for the action to progress; if false is returned action progress is paused.\nSpecial arguments passed to the code: `_target`, `_caller`, `_actionId`, `_arguments`"},{"name":"codeStart","type":"Code","optional":true,"default":"`{}`","description":"code executed when action starts.\nSpecial arguments passed to the code: `_target`, `_caller`, `_actionId`, `_arguments`\nPassed arguments are:\n\n```sqf\nparams [\"_target\", \"_caller\", \"_actionId\", \"_arguments\"];\n```\n\n- target: Object - the object which the action is assigned to\n- caller: Object - the unit that activated the action\n- actionId: Number - ID of the activated action (same as ID returned by addAction)\n- arguments: Array - arguments given to the function","type_expr":"Code","text":"codeStart: Code - (Optional, default `{}`) code executed when action starts.\nSpecial arguments passed to the code: `_target`, `_caller`, `_actionId`, `_arguments`\nPassed arguments are:\n\n```sqf\nparams [\"_target\", \"_caller\", \"_actionId\", \"_arguments\"];\n```\n\n- target: Object - the object which the action is assigned to\n- caller: Object - the unit that activated the action\n- actionId: Number - ID of the activated action (same as ID returned by addAction)\n- arguments: Array - arguments given to the function"},{"name":"codeProgress","type":"Code","optional":true,"default":"`{}`","description":"code executed on every progress tick.\nSpecial arguments passed to the code: `_target`, `_caller`, `_actionId`, `_arguments`, `_frame`\nPassed arguments are:\n\n```sqf\nparams [\"_target\", \"_caller\", \"_actionId\", \"_arguments\", \"_frame\", \"_maxFrame\"];\n```\n\n- target: Object - the object which the action is assigned to\n- caller: Object - the unit that activated the action\n- actionId: Number - ID of the activated action (same as ID returned by addAction)\n- arguments: Array - arguments given to the function\n- frame: Number - current progress, goes from 1 to 24\n- maxFrame: Number - maximum progress (24)","type_expr":"Code","text":"codeProgress: Code - (Optional, default `{}`) code executed on every progress tick.\nSpecial arguments passed to the code: `_target`, `_caller`, `_actionId`, `_arguments`, `_frame`\nPassed arguments are:\n\n```sqf\nparams [\"_target\", \"_caller\", \"_actionId\", \"_arguments\", \"_frame\", \"_maxFrame\"];\n```\n\n- target: Object - the object which the action is assigned to\n- caller: Object - the unit that activated the action\n- actionId: Number - ID of the activated action (same as ID returned by addAction)\n- arguments: Array - arguments given to the function\n- frame: Number - current progress, goes from 1 to 24\n- maxFrame: Number - maximum progress (24)"},{"name":"codeCompleted","type":"Code","optional":true,"default":"`{}`","description":"code executed on completion.\nSpecial arguments passed to the code: `_target`, `_caller`, `_actionId`, `_arguments`\nPassed arguments are:\n\n```sqf\nparams [\"_target\", \"_caller\", \"_actionId\", \"_arguments\"]; // same as codeStart\n```","type_expr":"Code","text":"codeCompleted: Code - (Optional, default `{}`) code executed on completion.\nSpecial arguments passed to the code: `_target`, `_caller`, `_actionId`, `_arguments`\nPassed arguments are:\n\n```sqf\nparams [\"_target\", \"_caller\", \"_actionId\", \"_arguments\"]; // same as codeStart\n```"},{"name":"codeInterrupted","type":"Code","optional":true,"default":"`{}`","description":"code executed on interrupted.\nSpecial arguments passed to the code: `_target`, `_caller`, `_actionId`, `_arguments`\nPassed arguments are:\n\n```sqf\nparams [\"_target\", \"_caller\", \"_actionId\", \"_arguments\"]; // same as codeCompleted\n```","type_expr":"Code","text":"codeInterrupted: Code - (Optional, default `{}`) code executed on interrupted.\nSpecial arguments passed to the code: `_target`, `_caller`, `_actionId`, `_arguments`\nPassed arguments are:\n\n```sqf\nparams [\"_target\", \"_caller\", \"_actionId\", \"_arguments\"]; // same as codeCompleted\n```"},{"name":"arguments","type":"Array","optional":true,"default":"`[]`","description":"arguments passed to **codeStart**, **codeProgress**, **codeCompleted** and **codeInterrupted** (max 10) in format:\n\n```sqf\nparams [\n    \"_a0\", \"_a1\", \"_a2\", \"_a3\", \"_a4\", \"_a5\", \"_a6\", \"_a7\", \"_a8\", \"_a9\", // custom arguments\n    \"_target\", \"_title\", \"_iconIdle\", \"_iconProgress\",\n    \"_condShow\", \"_condProgress\", \"_codeStart\", \"_codeProgress\", \"_codeCompleted\", \"_codeInterrupted\",\n    \"_duration\", \"_removeCompleted\"\n];\n```","type_expr":"Array","text":"arguments: Array - (Optional, default `[]`) arguments passed to **codeStart**, **codeProgress**, **codeCompleted** and **codeInterrupted** (max 10) in format:\n\n```sqf\nparams [\n    \"_a0\", \"_a1\", \"_a2\", \"_a3\", \"_a4\", \"_a5\", \"_a6\", \"_a7\", \"_a8\", \"_a9\", // custom arguments\n    \"_target\", \"_title\", \"_iconIdle\", \"_iconProgress\",\n    \"_condShow\", \"_condProgress\", \"_codeStart\", \"_codeProgress\", \"_codeCompleted\", \"_codeInterrupted\",\n    \"_duration\", \"_removeCompleted\"\n];\n```"},{"name":"duration","type":"Number","optional":true,"default":"10","description":"action duration, i.e. how much time it takes to complete the action","type_expr":"Number","text":"duration: Number - (Optional, default 10) action duration, i.e. how much time it takes to complete the action"},{"name":"priority","type":"Number","optional":true,"default":"1000","description":"priority value; actions are arranged in descending order according to this value","type_expr":"Number","text":"priority: Number - (Optional, default 1000) priority value; actions are arranged in descending order according to this value"},{"name":"removeCompleted","type":"Boolean","optional":true,"default":"true","description":"remove on completion","type_expr":"Boolean","text":"removeCompleted: Boolean - (Optional, default true) remove on completion"},{"name":"showUnconscious","type":"Boolean","optional":true,"default":"false","description":"show in unconscious state","type_expr":"Boolean","text":"showUnconscious: Boolean - (Optional, default false) show in unconscious state"},{"name":"showWindow","type":"Boolean","optional":true,"default":"true","description":"show on screen; if false action needs to be selected from action menu to appear on screen","type_expr":"Boolean","text":"showWindow: Boolean - (Optional, default true) show on screen; if false action needs to be selected from action menu to appear on screen"},{"name":"radius","type":"Number","optional":true,"default":"15","description":"action radius","type_expr":"Number","since":"arma3 2.22","text":"radius: Number - (Optional, default 15) action radius"},{"name":"selection","type":"String","optional":true,"default":"\"\"","description":"selection to use","type_expr":"String","since":"arma3 2.22","text":"selection: String - (Optional, default \"\") selection to use"},{"name":"memoryPoint","type":"String","optional":true,"default":"\"\"","description":"memory point to use","type_expr":"String","since":"arma3 2.22","text":"memoryPoint: String - (Optional, default \"\") memory point to use"}],"returns":{"type":"Number","type_expr":"Number","description":"action ID"}}],"examples":[{"text":"```sqf\n[\n    player,\n    \"Kill\",\n    \"\", \"\",\n    \"true\", \"true\",\n    { hint \"Started!\" },\n    { systemChat str (_this select 3) },\n    { player setDamage 1 },\n    { hint \"Afraid of death?\" },\n    [], 10, nil, true, false\n] call BIS_fnc_holdActionAdd;\n```","code":["[\n\tplayer,\n\t\"Kill\",\n\t\"\", \"\",\n\t\"true\", \"true\",\n\t{ hint \"Started!\" },\n\t{ systemChat str (_this select 3) },\n\t{ player setDamage 1 },\n\t{ hint \"Afraid of death?\" },\n\t[], 10, nil, true, false\n] call BIS_fnc_holdActionAdd;"]},{"text":"```sqf\n// adds the action to every client and JIP, but also adds it when it was already removed. E.g., Laptop has already been hacked by a player\n[\n    _myLaptop,                                                        // Object the action is attached to\n    \"Hack Laptop\",                                                    // Title of the action\n    \"\\a3\\ui_f\\data\\IGUI\\Cfg\\holdactions\\holdAction_connect_ca.paa\",    // Idle icon shown on screen\n    \"\\a3\\ui_f\\data\\IGUI\\Cfg\\holdactions\\holdAction_connect_ca.paa\",    // Progress icon shown on screen\n    \"_this distance _target < 3\",                                    // Condition for the action to be shown\n    \"_caller distance _target < 3\",                                    // Condition for the action to progress\n    {},                                                                // Code executed when action starts\n    {},                                                                // Code executed on every progress tick\n    { _this call MY_fnc_hackingCompleted },                            // Code executed on completion\n    {},                                                                // Code executed on interrupted\n    [],                                                                // Arguments passed to the scripts as _this select 3\n    12,                                                                // Action duration in seconds\n    0,                                                                // Priority\n    true,                                                            // Remove on completion\n    false                                                            // Show in unconscious state\n] remoteExec [\"BIS_fnc_holdActionAdd\", 0, _myLaptop];                // MP-compatible implementation\n```","code":["// adds the action to every client and JIP, but also adds it when it was already removed. E.g., Laptop has already been hacked by a player\n[\n\t_myLaptop,\t\t\t\t\t\t\t\t\t\t\t\t\t\t// Object the action is attached to\n\t\"Hack Laptop\",\t\t\t\t\t\t\t\t\t\t\t\t\t// Title of the action\n\t\"\\a3\\ui_f\\data\\IGUI\\Cfg\\holdactions\\holdAction_connect_ca.paa\",\t// Idle icon shown on screen\n\t\"\\a3\\ui_f\\data\\IGUI\\Cfg\\holdactions\\holdAction_connect_ca.paa\",\t// Progress icon shown on screen\n\t\"_this distance _target < 3\",\t\t\t\t\t\t\t\t\t// Condition for the action to be shown\n\t\"_caller distance _target < 3\",\t\t\t\t\t\t\t\t\t// Condition for the action to progress\n\t{},\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t// Code executed when action starts\n\t{},\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t// Code executed on every progress tick\n\t{ _this call MY_fnc_hackingCompleted },\t\t\t\t\t\t\t// Code executed on completion\n\t{},\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t// Code executed on interrupted\n\t[],\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t// Arguments passed to the scripts as _this select 3\n\t12,\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t// Action duration in seconds\n\t0,\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t// Priority\n\ttrue,\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t// Remove on completion\n\tfalse\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t// Show in unconscious state\n] remoteExec [\"BIS_fnc_holdActionAdd\", 0, _myLaptop];\t\t\t\t// MP-compatible implementation"]}],"see_also":["BIS_fnc_holdActionRemove","BIS_fnc_holdKey"],"notes":[{"user":"R3vo","date":"2021-04-01T23:44:00Z","text":"A repository with icons:\n\n> « I've converted all of the icons from the Tasking Overhaul to follow the Hold Action format, as well as a few others I've made myself. They're available on [GitHub](https://github.com/Kalthramis/Arma3/tree/master/holdAction-TaskType-Icons). » – Kalthramis"}]},{"name":"BIS_fnc_holdActionRemove","title":"BIS fnc holdActionRemove","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_holdActionRemove","revid":349409,"updated":"2023-11-08T16:27:27Z","groups":["Interaction"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Removes a hold action. This does exactly the same as removeAction.","syntaxes":[{"syntax":"[target,ID] call BIS_fnc_holdActionRemove","params":[{"name":"target","type":"Object","description":"object the action is attached to","type_expr":"Object"},{"name":"ID","type":"Number","description":"action ID","type_expr":"Number"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[player,10] call BIS_fnc_holdActionRemove;"]}],"see_also":["BIS_fnc_holdActionAdd"]},{"name":"BIS_fnc_holdKey","title":"BIS fnc holdKey","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_holdKey","revid":341505,"updated":"2023-06-05T20:02:15Z","groups":["Interaction"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","exec":"spawn","description":"Function that executes code when a key has been held down for a long enough time - \"Hold X to Advance\" text is displayed when any key is pressed.\nAll other keys (but <kbd>Esc</kbd>) are deactivated until the conditions are met - only mouse controls work (character rotation and fire).","syntaxes":[{"syntax":"[display, key, time, code, control] call BIS_fnc_holdKey","params":[{"name":"display","type":"Display","optional":true,"default":"`findDisplay 12` for map display","description":"display the event is attached to. By default it is the map display","type_expr":"Display","text":"display: Display - (Optional, default `findDisplay 12` for map display) display the event is attached to. By default it is the map display"},{"name":"key","type":"Number","optional":true,"default":"57 for Space","description":"what key to press - see DIK KeyCodes","type_expr":"Number","text":"key: Number - (Optional, default 57 for <kbd>Space</kbd>) what key to press - see DIK KeyCodes"},{"name":"time","type":"Number","optional":true,"default":"3","description":"how long the key has to be held down in seconds","type_expr":"Number","text":"time: Number - (Optional, default 3) how long the key has to be held down in seconds"},{"name":"code","type":"Code","optional":true,"default":"`{}`","description":"scheduled code to be executed when key is held down for long enough","type_expr":"Code","text":"code: Code - (Optional, default `{}`) scheduled code to be executed when key is held down for long enough"},{"name":"control","type":"Control","optional":true,"default":"controlNull","description":"text control to be used in place of the default \"Press X to skip\" control.","type_expr":"Control","text":"control: Control - (Optional, default controlNull) text control to be used in place of the default \"Press X to skip\" control."}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[findDisplay 46, 36, 5, { hint \"Key 'J' pressed for 5 seconds\" }] spawn BIS_fnc_holdKey; // action is added to the mission display"]}],"see_also":["BIS_fnc_holdActionAdd","addAction","BIS_fnc_keyHold"]},{"name":"BIS_fnc_HUDLimits","title":"BIS fnc HUDLimits","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_HUDLimits","revid":327970,"updated":"2022-07-13T14:25:56Z","groups":["GUI"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Set helicopter advanced flight model HUD limits and prevents overwriting existing values. See also setHUDMovementLevels.\n\n> [!NOTE]\n> - default value is 0, which means no limits were assigned\n> - using 0 in min or max value will hide the corresponding limit\n> - same or higher priority will replace currently set priority\n> - using a negative priority will reset the values if absolute value is same or higher than current level","syntaxes":[{"syntax":"[speedLimit, altLimit, dirLimit] call BIS_fnc_HUDLimits","params":[{"name":"speedLimit","type":"Array in format [priority, min, max]:","description":"Array in format [priority, min, max]:\n\n- priority: Number\n- min: Number\n- max: Number","type_expr":"Array","text":"speedLimit: Array in format [priority, min, max]:\n\n- priority: Number\n- min: Number\n- max: Number"},{"name":"altLimit","type":"Array in format [priority, min, max]:","description":"Array in format [priority, min, max]:\n\n- priority: Number\n- min: Number\n- max: Number","type_expr":"Array","text":"altLimit: Array in format [priority, min, max]:\n\n- priority: Number\n- min: Number\n- max: Number"},{"name":"dirLimit","type":"Array in format [priority, min, max, target]:","description":"Array in format [priority, min, max, target]:\n\n- priority: Number\n- min: Number - you can set a \"negative\" value by adding 360 (e.g using 270 instead of -90)\n- max: Number\n- target: Position or Object - (Optional, default [0,0,0]) the direction relative target","type_expr":"Array","text":"dirLimit: Array in format [priority, min, max, target]:\n\n- priority: Number\n- min: Number - you can set a \"negative\" value by adding 360 (e.g using 270 instead of -90)\n- max: Number\n- target: Position or Object - (Optional, default [0,0,0]) the direction relative target"}],"returns":{"type":"Array","type_expr":"Array","description":"current value of HUDMovementLevels"}}],"examples":[{"code":["[[0,0,0], [1, 0, 50], [0,0,0]] call BIS_fnc_HUDLimits; // limits altitude on HUD to 50m max"]},{"code":["[[0,0,0], [0, 0, 0], [1,330,30, myTarget]] call BIS_fnc_HUDLimits; // limits orientation towards myTarget by ±30°"]}],"see_also":["HUDMovementLevels","setHUDMovementLevels"]},{"name":"BIS_fnc_importImageLinks","title":"BIS fnc importImageLinks","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_importImageLinks","revid":369461,"updated":"2024-09-06T08:51:22Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.08"},"since":"arma3 1.08","arma3_since":"1.08","description":"Imports CfgVehicles image links from the Community Wiki ([https://community.bistudio.com/](https://community.bistudio.com/)).\n\n1. Run the script. It will copy a text into clipboard\n1. Open your Sandbox and paste the text into edit field\n1. **Preview** the page (do not save it)\n1. Copy the resulting text and use it in your scripts\n\nResult is in the following format:\n\n```sqf\n_imagesCfgVehicles = [\n    \"papercar\",\"https://community.bistudio.com/wikidata/images/8/85/Arma3_CfgVehicles_PaperCar.jpg\",\n    \"firesectortarget\",\"\",\n    \"building\",\"\",\n    // etc\n];\n```\n\n> [!IMPORTANT]\n> Be wary that this function is **CPU-demanding** and may lock your computer for 5-10 seconds.","syntaxes":[{"syntax":"call BIS_fnc_importImageLinks","params":[],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when done"}}],"examples":[{"code":["call BIS_fnc_importImageLinks;"]}],"see_also":["Special:Upload"]},{"name":"BIS_fnc_inAngleSector","title":"BIS fnc inAngleSector","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_inAngleSector","revid":337353,"updated":"2023-01-18T17:06:32Z","groups":["Geometry"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Checks if a position lies within an angle sector.","syntaxes":[{"syntax":"[center, centerAngle, sectorWidth, position] call BIS_fnc_inAngleSector","params":[{"name":"center","type":"Array","description":"center position","type_expr":"Array","text":"center : Array - center position"},{"name":"centerAngle","type":"Number","description":"defines the center angle of the sector","type_expr":"Number","text":"centerAngle : Number - defines the center angle of the sector"},{"name":"sectorWidth","type":"Number","description":"defines the width of the sector in degrees","type_expr":"Number"},{"name":"position","type":"Array","description":"the position which should be checked","type_expr":"Array"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if the position lies within the defined sector"}}],"examples":[{"code":["[getPosWorld player, getDir player, 30, getPosWorld enemy_tank] call BIS_fnc_inAngleSector;"]}],"see_also":["BIS_fnc_isInFrontOf"]},{"name":"BIS_fnc_incapacitatedEffect","title":"BIS fnc incapacitatedEffect","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_incapacitatedEffect","revid":352197,"updated":"2024-02-01T23:26:01Z","groups":["Broken Functions","Feedback"],"status":"broken","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"A draft of incapacitated effects function.\n\n> [!WARNING]\n> Does nothing, as the whole code is commented out.","syntaxes":[{"syntax":"call BIS_fnc_incapacitatedEffect","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_incapacitatedEffect;"]}],"see_also":["BIS_fnc_damageChanged","BIS_fnc_healthEffects"]},{"name":"BIS_fnc_indicateBleeding","title":"BIS fnc indicateBleeding","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_indicateBleeding","revid":328551,"updated":"2022-07-13T17:02:20Z","groups":["Feedback"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Shows a PP effect which indicates bleeding.\n\n> [!IMPORTANT]\n> Do not use,WIP!","syntaxes":[{"syntax":"call BIS_fnc_indicateBleeding","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","description":"(BIS_applyPP7 returns true)","text":"Nothing (**BIS_applyPP7** returns true)"}}],"examples":[{"code":["call BIS_fnc_indicateBleeding;"]}],"see_also":["BIS_fnc_bloodEffect"]},{"name":"BIS_fnc_infoText","title":"BIS fnc infoText","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_infoText","revid":329329,"updated":"2022-07-27T10:15:19Z","groups":["GUI"],"status":"ok","games":{"arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2oa 1.50","arma3_since":"0.50","locality":{"effect":"local"},"exec":"spawn","description":"Display a text in the \"mission\" GUI area with some effects. Good for the beginning of a mission.","syntaxes":[{"syntax":"[string_1, string_2, string_n] spawn BIS_fnc_infoText","params":[{"name":"Array of Strings","type_expr":"Array<String>"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"Somewhere on Altis\", format [\"Year %1\", date select 0], mapGridPosition player] spawn BIS_fnc_infoText;"]}],"see_also":["BIS_fnc_dynamicText","BIS_fnc_textTiles","BIS_fnc_typeText","BIS_fnc_typeText2","BIS_fnc_EXP_camp_SITREP"]},{"name":"BIS_fnc_initAmmoBox","title":"BIS fnc initAmmoBox","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_initAmmoBox","revid":342150,"updated":"2023-07-09T12:26:49Z","groups":["Eden Editor"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"> [!IMPORTANT]\n> This function is used internally by the Eden Editor to set the inventory of vehicles.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["BIS_fnc_3DENCamera","BIS_fnc_3DENControlsHint","BIS_fnc_3DENDiagCreateList","BIS_fnc_3DENDiagFonts","BIS_fnc_3DENDiagMouseControl","BIS_fnc_3DENDrawLocations","BIS_fnc_3DENEntityMenu","BIS_fnc_3DENExportAttributes","BIS_fnc_3DENExportOldSQM","BIS_fnc_3DENExportTerrainBuilder","BIS_fnc_3DENFlashlight","BIS_fnc_3DENGrid","BIS_fnc_3DENIntel","BIS_fnc_3DENInterface","BIS_fnc_3DENListLocations","BIS_fnc_3DENModuleDescription","BIS_fnc_3DENShowMessage","BIS_fnc_3DENStatusBar","BIS_fnc_3DENToolbar","BIS_fnc_3DENTutorial","BIS_fnc_3DENVisionMode"]},{"name":"BIS_fnc_initCuratorAttribute","title":"BIS fnc initCuratorAttribute","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_initCuratorAttribute","revid":309764,"updated":"2022-05-05T12:09:49Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_initDisplay","title":"BIS fnc initDisplay","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_initDisplay","revid":379270,"updated":"2026-10-30T23:44:11Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"This function is a central part of how BI handles UIs. For a full explanation see this page.","syntaxes":[{"syntax":"parameters call BIS_fnc_initDisplay","params":[{"name":"parameters","type":"Array","description":"Array\n\n- [] - Init displays during preStart\n- [mode, params, displayClass, scriptPath, register]\n  - mode: String - Mode, can be \"onLoad\" or \"onUnload\"\n  - params: Array - Parameters passed from onLoad or onUnload UI event handler\n  - displayClass: String - Display class, usually to format \"RscDisplayXXX\"\n  - scriptPath: String - Script path from CfgScriptPaths\n  - register: Number or Boolean - Save variables associated with the display to the uiNamespace. Usually this is `false` when the function is called from a control.","type_expr":"Array","text":"parameters: Array\n\n- [] - Init displays during preStart\n- [mode, params, displayClass, scriptPath, register]\n  - mode: String - Mode, can be \"onLoad\" or \"onUnload\"\n  - params: Array - Parameters passed from onLoad or onUnload UI event handler\n  - displayClass: String - Display class, usually to format \"RscDisplayXXX\"\n  - scriptPath: String - Script path from CfgScriptPaths\n  - register: Number or Boolean - Save variables associated with the display to the uiNamespace. Usually this is `false` when the function is called from a control."}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"onLoad\", _this, \"RscDisplayAAR\", \"GUI\", true] call (uiNamespace getVariable \"BIS_fnc_initDisplay\");"]}],"see_also":["GUI Tutorial","Arma: GUI Configuration"]},{"name":"BIS_fnc_initExpo","title":"BIS fnc initExpo","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_initExpo","revid":309326,"updated":"2022-05-05T12:04:28Z","groups":["Systems"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Disable parts of the main menu during public presentation. Press <kbd>Ctrl</kbd> + <kbd>⇧ Shift</kbd> + <kbd>U</kbd> to toggle the lock.","syntaxes":[{"syntax":"call BIS_fnc_initExpo","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_initExpo;"]}]},{"name":"BIS_fnc_initInspectable","title":"BIS fnc initInspectable","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_initInspectable","revid":379271,"updated":"2026-10-30T23:44:19Z","groups":["Interaction"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Initialize inspectable object: add \"Inspect\" action to the object. When a player activates it, full-screen detail of the objects is shown.","syntaxes":[{"syntax":"[inspectable, textureInfos, fullScreenText, soundName] call BIS_fnc_initInspectable","params":[{"name":"inspectable","type":"Object","description":"object on which the action is added","type_expr":"Object"},{"name":"textureInfos","type":"String, Array or Boolean","description":"String, Array or Boolean\n\n- String - texture path\n- Array - [texture, index, aspectRatio]:\n  - texture: String - texture path\n  - index: Number - (Optional, default 0) index on which the texture will be mapped on the object using setObjectTexture. Use -1 to ignore.\n  - aspectRatio: Number - (Optional, default -1) texture aspect ratio. 0.5 means width will be 0.5 of the height. -1 means texture default.\n- Boolean - true to instantly show the *inspectable* full-screen preview (**following params are then ignored**)","type_expr":"String | Array | Boolean","text":"textureInfos: String, Array or Boolean\n\n- String - texture path\n- Array - [texture, index, aspectRatio]:\n  - texture: String - texture path\n  - index: Number - (Optional, default 0) index on which the texture will be mapped on the object using setObjectTexture. Use -1 to ignore.\n  - aspectRatio: Number - (Optional, default -1) texture aspect ratio. 0.5 means width will be 0.5 of the height. -1 means texture default.\n- Boolean - true to instantly show the *inspectable* full-screen preview (**following params are then ignored**)"},{"name":"fullScreenText","type":"String","description":"text to be shown after clicking on READ button. Ideally localized.","type_expr":"String"},{"name":"soundName","type":"String","description":"sound played when entering full-screen preview. Sould be defined in CfgSounds.","type_expr":"String"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[myLeaflet, \"#(argb,8,8,3)color(1,0,1,1)\", \"This is some Magic Pink\"] call BIS_fnc_initInspectable; // initialize"]},{"code":["[myLeaflet, true] call BIS_fnc_initInspectable; // Show preview instantly"]}],"see_also":["BIS_fnc_holdActionAdd","BIS_fnc_holdActionRemove"]},{"name":"BIS_fnc_initIntelObject","title":"BIS fnc initIntelObject","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_initIntelObject","revid":349474,"updated":"2023-11-08T16:49:19Z","groups":["Interaction"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"This function sets up an object as intel retrievable by the players by adding a \"Take Intel\" addAction to it.\nWhen a player uses the action, they will play an animation to pick the object up and the object will be deleted from the mission.\nThe player and any defined recipients will then receive a diary entry which can contain a *title*, *description* and *picture*.\nThe diary entry will also contain a marker shortcut showing where the intel was found.\n\nThis function is similar to placing an intel object as Zeus, but the Zeus interface provides some extra options like:\n\n- Which sides can interact with the action\n- The picture, title and description used in the diary entry\n\nWhen using this function from script there are several variables that need to be set up to acquire the same results (see the examples below).\nWithout this extra setup the functionality provided is minimal and only includes:\n\n- The \"Take Intel\" action on the object\n- The object can be picked up by a player from any side\n- When picked up it will have no title or description and the picture will be a default exclamation mark\n- The diary entry will only be given to the person who picked it up\n\nThere are some optional features of intel objects that can be used:\n\n- The diary entry's *description* can be further enhanced by using the supported tags found on the createDiaryRecord page.\n- There is also a scripted eventhandler called *\"IntelObjectFound\"* that can be registered on the intel object. The event provides the parameters [object, caller] where *object* is the intel object and *caller* the person who picked it up.\n- A Zeus who has the intel object registered as a curator editable object can also receive feedback that the intel has been picked up if the scripted eventhandler called *\"intelObjectFound\"* was registered on the curator module. The event provides the parameters [zeus, caller, object] where *zeus* is the curator module, *caller* the person who picked it up and *object* is the intel object.\n\nThe usage of these scripted event handlers is shown in Example 3.","syntaxes":[{"syntax":"[object] call BIS_fnc_initIntelObject","params":[{"name":"object","type":"Object","description":"object to place intel action on","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when done"}}],"examples":[{"text":"Setup an object as intel from its init attribute in the editor.\nBasic version including *picture*, *title*, *description*, *recipients* and *sides that can interact with it*:\n\n```sqf\n[this] call BIS_fnc_initIntelObject;\n\nif (isServer) then\n{\n    // Diary picture:\n    this setVariable [\n        \"RscAttributeDiaryRecord_texture\",\n        \"a3\\structures_f_epc\\Items\\Documents\\Data\\document_secret_01_co.paa\", // Path to picture\n        true\n    ];\n\n    // Diary Title and Description:\n    [\n        this,\n        \"RscAttributeDiaryRecord\",\n        [\"New Intel\", \"The enemies have a cave troll!\"] // Array in format [Title, Description]\n    ] call BIS_fnc_setServerVariable;\n\n    // Diary entry shared with (follows BIS_fnc_MP target rules):\n    this setVariable [\"recipients\", west, true];\n\n    // Sides that can interact with the intel object:\n    this setVariable [\"RscAttributeOwners\", [west], true];\n};\n```","code":["[this] call BIS_fnc_initIntelObject;\n\nif (isServer) then\n{\n\t// Diary picture:\n\tthis setVariable [\n\t\t\"RscAttributeDiaryRecord_texture\",\n\t\t\"a3\\structures_f_epc\\Items\\Documents\\Data\\document_secret_01_co.paa\", // Path to picture\n\t\ttrue\n\t];\n\n\t// Diary Title and Description:\n\t[\n\t\tthis,\n\t\t\"RscAttributeDiaryRecord\",\n\t\t[\"New Intel\", \"The enemies have a cave troll!\"] // Array in format [Title, Description]\n\t] call BIS_fnc_setServerVariable;\n\n\t// Diary entry shared with (follows BIS_fnc_MP target rules):\n\tthis setVariable [\"recipients\", west, true];\n\n\t// Sides that can interact with the intel object:\n\tthis setVariable [\"RscAttributeOwners\", [west], true];\n};"]},{"text":"To set up an object as intel from its init attribute in the editor with a custom addAction title, replace the first line of Example 1 with the following:\n\n```sqf\nif (hasInterface) then\n{\n    this addAction [\n        \"Pick up laptop\", // custom addAction title\n        { [_this, \"action\"] spawn BIS_fnc_initIntelObject },\n        [],\n        10,\n        true,\n        true,\n        \"\",\n        \"isPlayer _this && { _this distance _target < 2 } &&\n        { (side group _this) in (_target getVariable ['RscAttributeOwners', [west, east, resistance, civilian]]) }\"\n    ];\n};\n```","code":["if (hasInterface) then\n{\n\tthis addAction [\n\t\t\"Pick up laptop\", // custom addAction title\n\t\t{ [_this, \"action\"] spawn BIS_fnc_initIntelObject },\n\t\t[],\n\t\t10,\n\t\ttrue,\n\t\ttrue,\n\t\t\"\",\n\t\t\"isPlayer _this && { _this distance _target < 2 } &&\n\t\t{ (side group _this) in (_target getVariable ['RscAttributeOwners', [west, east, resistance, civilian]]) }\"\n\t];\n};"]},{"text":"Set up an object as intel from its init attribute in the editor.\nBasic version plus curator and scripted event handlers:\n\n```sqf\n[this] call BIS_fnc_initIntelObject;\n\nif (isServer) then\n{\n    // Diary picture:\n    this setVariable [\n        \"RscAttributeDiaryRecord_texture\",\n        \"a3\\structures_f_epc\\Items\\Documents\\Data\\document_secret_01_co.paa\", // Path to picture\n        true\n    ];\n\n    // Diary Title and Description:\n    [\n        this,\n        \"RscAttributeDiaryRecord\",\n        [\"New Intel\", \"The enemies have a cave troll!\"] // Array in format [Title, Description]\n    ] call BIS_fnc_setServerVariable;\n\n    // Diary entry shared with (follows BIS_fnc_MP target rules):\n    this setVariable [\"recipients\", west, true];\n\n    // Sides that can interact with the intel object:\n    this setVariable [\"RscAttributeOwners\", [west], true];\n\n    // Register intel object with Zeus as curator editable (_zeus is the curator module):\n    _zeus addCuratorEditableObjects [[this], false];\n\n    // Add Zeus scripted event:\n    [_zeus, \"IntelObjectFound\", {hint \"Intel found\"}] call BIS_fnc_addScriptedEventHandler;\n\n    // Add a scripted event that notifies all clients via systemChat when the intel is found:\n    [\n        this,\n        \"IntelObjectFound\",\n        {\n            params [\"\", \"_foundBy\"];\n            private _msg = format [\"Intel found by %1\", name _foundBy];\n            _msg remoteExec [\"systemChat\", 0];\n        }\n    ] call BIS_fnc_addScriptedEventHandler;\n};\n```\n\nAlthough both scripted event handlers supply a reference to the intel object, it is deleted from the mission almost immediately, so it could already be null when queried.","code":["[this] call BIS_fnc_initIntelObject;\n\nif (isServer) then\n{\n\t// Diary picture:\n\tthis setVariable [\n\t\t\"RscAttributeDiaryRecord_texture\",\n\t\t\"a3\\structures_f_epc\\Items\\Documents\\Data\\document_secret_01_co.paa\", // Path to picture\n\t\ttrue\n\t];\n\n\t// Diary Title and Description:\n\t[\n\t\tthis,\n\t\t\"RscAttributeDiaryRecord\",\n\t\t[\"New Intel\", \"The enemies have a cave troll!\"] // Array in format [Title, Description]\n\t] call BIS_fnc_setServerVariable;\n\n\t// Diary entry shared with (follows BIS_fnc_MP target rules):\n\tthis setVariable [\"recipients\", west, true];\n\n\t// Sides that can interact with the intel object:\n\tthis setVariable [\"RscAttributeOwners\", [west], true];\n\n\t// Register intel object with Zeus as curator editable (_zeus is the curator module):\n\t_zeus addCuratorEditableObjects [[this], false];\n\n\t// Add Zeus scripted event:\n\t[_zeus, \"IntelObjectFound\", {hint \"Intel found\"}] call BIS_fnc_addScriptedEventHandler;\n\n\t// Add a scripted event that notifies all clients via systemChat when the intel is found:\n\t[\n\t\tthis,\n\t\t\"IntelObjectFound\",\n\t\t{\n\t\t\tparams [\"\", \"_foundBy\"];\n\t\t\tprivate _msg = format [\"Intel found by %1\", name _foundBy];\n\t\t\t_msg remoteExec [\"systemChat\", 0];\n\t\t}\n\t] call BIS_fnc_addScriptedEventHandler;\n};"]}]},{"name":"BIS_fnc_initLeaflet","title":"BIS fnc initLeaflet","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_initLeaflet","revid":376288,"updated":"2025-09-29T12:43:15Z","groups":["Interaction"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Initialise interactive leaflet.","syntaxes":[{"syntax":"[mode, parameters] call BIS_fnc_initLeaflet","params":[{"name":"mode","type":"String","description":"\"init\" for scripted initialisation, other mode (\"fired\") is used when leaflets are fired as a weapon","type_expr":"String"},{"name":"parameters","type":"Array in format:","description":"Array in format:\n\n- [leaflet, texture, text]:\n  - leaflet: Object - the leaflet object itself\n  - texture: String - texture path\n  - text: String - localized text, shown when previewing the leaflet in full screen\n- [leaflet, cfgLeafletsClass]:\n  - leaflet: Object - the leaflet object itself\n  - cfgLeafletsClass: String - class name\n- [position, cfgLeafletsClass]:\n  - position: Array format Position - desired placement position (see createVehicle)\n  - cfgLeafletsClass: String - class name","type_expr":"Array","text":"parameters: Array in format:\n\n- [leaflet, texture, text]:\n  - leaflet: Object - the leaflet object itself\n  - texture: String - texture path\n  - text: String - localized text, shown when previewing the leaflet in full screen\n- [leaflet, cfgLeafletsClass]:\n  - leaflet: Object - the leaflet object itself\n  - cfgLeafletsClass: String - class name\n- [position, cfgLeafletsClass]:\n  - position: Array format Position - desired placement position (see createVehicle)\n  - cfgLeafletsClass: String - class name"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"init\", [myLeaflet, \"#(argb,8,8,3)color(1,1,0,1)\", \"Yellow pages\"]] call BIS_fnc_initLeaflet;"]},{"code":["[\"init\", [myLeaflet, \"Custom_02\"]] call BIS_fnc_initLeaflet;"]},{"code":["[\"init\", [myLeaflet, \"West\"]] call BIS_fnc_initLeaflet;"]},{"code":["[\"init\", [getPosATL player, \"Custom_02\"]] call BIS_fnc_initLeaflet;"]}],"see_also":["Arma 3: Leaflets","BIS_fnc_initInspectable"]},{"name":"BIS_fnc_initListNBoxSorting","title":"BIS fnc initListNBoxSorting","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_initListNBoxSorting","revid":349789,"updated":"2023-11-20T22:10:14Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"Automatically creates buttons and sets them up so they can be used to sort a CT_LISTNBOX. The buttons will automatically be resized to fit the column width of **ctrlFilter**.\n\nBy default, the **ctrlContent** columns are sorted by lnbText (using lnbSort). If a specific column should be sorted by lnbValue (using lnbSortByValue) instead, then something needs to be set in the data of the corresponding **ctrlFilter** column (literally *something*, the condition in the source code is `(_ctrlFilter lnbData [0, _i]) != \"\"`).\n\nRegarding **ctrlFilter**:\n\n- The position and size of this control define where the buttons for sorting are created, thus it should be placed above **ctrlContent** and its columns should have the same size as the columns of **ctrlContent**.\n- The text set in the columns is displayed as text for the buttons (the buttons are actually transparent).\n- The control can also be part of a CT_CONTROLS_GROUP. If that is the case, the buttons will be created as children of that group.\n- To keep a uniform style between vanilla and custom controls it is recommended to create a background with CT_STATIC behind **ctrlFilter** with `colorBackground[] = { 0, 0, 0, 1 };`.\n\nSee CT LISTNBOX - BIS_fnc_initListNBoxSorting Example for a full example including a config.","syntaxes":[{"syntax":"[ctrlFilter, ctrlContent, columnIndexes, idc] call BIS_fnc_initListNBoxSorting","params":[{"name":"ctrlFilter","type":"Control","description":"dummy CT_LISTNBOX control used for setting up the filter.","type_expr":"Control"},{"name":"ctrlContent","type":"Control","description":"the CT_LISTNBOX which actually contains the sortable content.","type_expr":"Control"},{"name":"columnIndexes","type":"Array of Numbers","optional":true,"default":"[]","description":"these are the column indexes of *ctrlContent* which should be sortable. An empty array means all columns are sortable.","type_expr":"Array<Number>","text":"columnIndexes: Array of Numbers - (Optional, default: []) these are the column indexes of *ctrlContent* which should be sortable. An empty array means all columns are sortable."},{"name":"idc","type":"Number","optional":true,"default":"200","description":"used to assign IDCs to the buttons created by this function. The first button has **idc**, the second button has **idc** + 1 and so on.","type_expr":"Number","text":"idc: Number - (Optional, default: 200) used to assign IDCs to the buttons created by this function. The first button has **idc**, the second button has **idc** + 1 and so on."}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true on success, otherwise false"}}],"examples":[{"code":["[_lnbFilter, _lnbContent, [0,1,2,3]] call BIS_fnc_initListNBoxSorting;"]}],"see_also":["BIS_fnc_initSliderValue"]},{"name":"BIS_fnc_initModules","title":"BIS fnc initModules","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_initModules","revid":330067,"updated":"2022-08-15T16:36:45Z","groups":["Systems"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Wait until all modules using the Arma 3: Module Framework are initialised.","syntaxes":[{"syntax":"[modules] call BIS_fnc_initModules","params":[{"name":"modules","type":"Array of Objects","description":"modules to be activated","type_expr":"Array<Object>"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"always returns true"}}],"examples":[{"code":["[module_1,module_2] call BIS_fnc_initModules;"]}],"see_also":["Modules"]},{"name":"BIS_fnc_initMultiplayer","title":"BIS fnc initMultiplayer","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_initMultiplayer","revid":309299,"updated":"2022-05-05T12:04:14Z","groups":["Multiplayer"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Multiplayer mission init, executed automatically upon mission start.\n\n> [!NOTE]\n> This is an internal function.","syntaxes":[{"syntax":"call BIS_fnc_initMultiplayer","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_initMultiplayer;"]}],"see_also":["Event Scripts"]},{"name":"BIS_fnc_initParams","title":"BIS fnc initParams","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_initParams","revid":352540,"updated":"2024-02-12T16:42:20Z","groups":["Mission Parameters"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Initialize mission params and create log in the diary.\n\nSince Arma 3 v2.18 it is possible to deactivate automatic parameter initialization in **singleplayer** by setting `BIS_fnc_initParams_skip` to true in preInit.","syntaxes":[{"syntax":"[modules] call BIS_fnc_initParams","params":[],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["call BIS_fnc_initParams;"]}],"see_also":["Mission Parameters"]},{"name":"BIS_fnc_initPlayable","title":"BIS fnc initPlayable","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_initPlayable","revid":309759,"updated":"2022-05-05T12:09:49Z","groups":["Multiplayer"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_initRespawn","title":"BIS fnc initRespawn","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_initRespawn","revid":309874,"updated":"2022-05-05T12:09:53Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_initRespawnBackpack","title":"BIS fnc initRespawnBackpack","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_initRespawnBackpack","revid":323738,"updated":"2022-07-01T11:53:37Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Init respawn backpack.\nWhover \"assembles\" it will receive a new respawn position.\nWhen backpack object has 'respawnNearbyPlayers' attribute set to 1, nearby player will receive the respawn as well.","syntaxes":[{"syntax":"call BIS_fnc_initRespawnBackpack","params":[],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"text":"call BIS_fnc_initRespawnBackpack;"}],"see_also":["Arma 3: Respawn"]},{"name":"BIS_fnc_initSliderValue","title":"BIS fnc initSliderValue","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_initSliderValue","revid":352075,"updated":"2024-02-01T23:24:42Z","groups":["Eden Editor"],"status":"ok","games":{"arma3":"1.58"},"since":"arma3 1.58","arma3_since":"1.58","description":"Initialises a slider attribute control within the Eden Editor. Can also be used outside of Eden Editor.\n\n> [!NOTE]\n> The slider and the edit control have to share the same controls group!","syntaxes":[{"syntax":"[ctrlSlider, ctrlEdit, unit, default] call BIS_fnc_initSliderValue","params":[{"name":"ctrlSlider","type":"Control","description":"slider control, usually the first control within the controls group","type_expr":"Control"},{"name":"ctrlEdit","type":"Control","description":"edit Box, usually the second control within the controls group","type_expr":"Control"},{"name":"unit","type":"String","description":"measurement unit added behind the number within the edit box (\"%\" by default)","type_expr":"String"},{"name":"default","type":"Number","description":"when present, only the value is set, functionality is not initialized","type_expr":"Number"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[_this controlsGroupCtrl 100, _this controlsGroupCtrl 101, \"m\", 50] call BIS_fnc_initSliderValue;"]},{"code":["// Execute in Eden Editor to preview the functionality\nif !(is3DEN) exitWith {};\n\nprivate _display = findDisplay 313;\nprivate _GRID_H = pixelGrid * pixelH * 0.5;\nprivate _GRID_W = pixelGrid * pixelW * 0.5;\n\n// Function only works if slider and edit control share the same group\nprivate _ctrlGroup = _display ctrlCreate [\"ctrlControlsGroupNoScrollbars\", -100];\n_ctrlGroup ctrlSetPosition [0, 0, 101 * _GRID_W, 5 * _GRID_H];\n\n// Setup the slider\nprivate _ctrlSlider = _display ctrlCreate [\"ctrlXSliderH\", -101, _ctrlGroup];\n_ctrlSlider ctrlSetPosition [0, 0, 50 * _GRID_W, 5 * _GRID_H];\n_ctrlSlider sliderSetRange [100, 2000];\n\n// Setup the edit control\nprivate _ctrlEdit = _display ctrlCreate [\"ctrlEdit\", -102, _ctrlGroup];\n_ctrlEdit ctrlSetPosition [51 * _GRID_W, 0, 25 * _GRID_W, 5 * _GRID_H];\n\n_ctrlSlider ctrlCommit 0;\n_ctrlEdit ctrlCommit 0;\n_ctrlGroup ctrlCommit 0;\n\n// Set default value\n[_ctrlSlider, _ctrlEdit, \"m\", 200] call BIS_fnc_initSliderValue;\n\n// Added eventhandlers to controls\n[_ctrlSlider, _ctrlEdit, \"m\"] call BIS_fnc_initSliderValue;"]}],"see_also":["Eden Editor: Configuring Attributes"]},{"name":"BIS_fnc_initVehicle","title":"BIS fnc initVehicle","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_initVehicle","revid":379272,"updated":"2026-10-30T23:44:27Z","groups":["Vehicles"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","locality":{"argument":"local","effect":"global"},"description":"This function changes the textures, animation sources and/or mass of a given vehicle.\nUnless explicitly mentioned , the function will restore the initial state of every animation sources of the given object (see Example 3).","syntaxes":[{"syntax":"[vehicle, variant, animations, mass] call BIS_fnc_initVehicle","params":[{"name":"vehicle","type":"Object","description":"vehicle to customize","type_expr":"Object"},{"name":"variant","type":"Boolean, Array, String or Number","optional":true,"default":"false","description":"Boolean - true to restore default texture source, false to skip texture source change\n- Array - texture sources with their probability in format `[\"textureSource1\", 0.5, \"textureSource2\", 0.5]`\n- String - variant class name - from `configFile >> \"CfgVehicles\"` or `missionConfigFile >> \"CfgVehicleTemplates\"` (see CfgVehicleTemplates)\n- Number - index of the texture source (same as the old system)","type_expr":"Boolean | Array | String | Number","text":"variant: Boolean, Array, String or Number - (Optional, default false)\n\n- Boolean - true to restore default texture source, false to skip texture source change\n- Array - texture sources with their probability in format `[\"textureSource1\", 0.5, \"textureSource2\", 0.5]`\n- String - variant class name - from `configFile >> \"CfgVehicles\"` or `missionConfigFile >> \"CfgVehicleTemplates\"` (see CfgVehicleTemplates)\n- Number - index of the texture source (same as the old system)"},{"name":"animations","type":"Boolean, Array or String","optional":true,"default":"false","description":"Boolean - true to restore init phase of every animation sources\n- Array - animation sources with their probability in format `[\"animationSource1\", 0.5, \"animationSource2\", 0.5]`\n\n  > [!IMPORTANT]\n  > If the first element is wrong, it will skip the rest of the animation sources!\n- String - variant class name - from `configFile >> \"CfgVehicles\"` or `missionConfigFile >> \"CfgVehicleTemplates\"` (see CfgVehicleTemplates)","type_expr":"Boolean | Array | String","text":"animations: Boolean, Array or String - (Optional, default false)\n\n- Boolean - true to restore init phase of every animation sources\n- Array - animation sources with their probability in format `[\"animationSource1\", 0.5, \"animationSource2\", 0.5]`\n\n  > [!IMPORTANT]\n  > If the first element is wrong, it will skip the rest of the animation sources!\n- String - variant class name - from `configFile >> \"CfgVehicles\"` or `missionConfigFile >> \"CfgVehicleTemplates\"` (see CfgVehicleTemplates)"},{"name":"mass","type":"Boolean or Number","optional":true,"default":"false","description":"Boolean - true to set the default mass, false to disable the mass change\n- Number - mass to remove/add to the vehicle","type_expr":"Boolean | Number","text":"mass: Boolean or Number - (Optional, default false)\n\n- Boolean - true to set the default mass, false to disable the mass change\n- Number - mass to remove/add to the vehicle"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"function success or not"}}],"examples":[{"code":["result = [this, \"\", []] call BIS_fnc_initVehicle;"]},{"code":["result = [this, [\"MyTextureSource1\", 0.5, \"MyTextureSource2\", 0.6], []] call BIS_fnc_initVehicle;"]},{"code":["result = [this, nil, [\"MyAnimationSource1\", 0.5, \"MyAnimationSource2\", 0.7]] call BIS_fnc_initVehicle;"]},{"code":["// randomise camo net options with 50% probability\n[vehicle player, false, [\"showcamonethull\", 0.5, \"showcamonetturret\", 0.5, \"showcamonetcannon\", 0.5, \"showslathull\", 0.5]] call BIS_fnc_initVehicle;"]},{"code":["// force show all camo net options. Use animationNames to get all available animation sources. Vehicles that don't support certain animations are simply ignored.\n[vehicle player, false, [\"showcamonethull\", 1, \"showcamonetturret\", 1, \"showcamonetcannon\", 1, \"showslathull\", 1]] call BIS_fnc_initVehicle;"]}],"see_also":["BIS_fnc_saveVehicle","BIS_fnc_loadVehicle","Arma 3: Vehicle Customisation"]},{"name":"BIS_fnc_initVehicleCrew","title":"BIS fnc initVehicleCrew","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_initVehicleCrew","revid":349419,"updated":"2023-11-08T16:27:32Z","groups":["Vehicles"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Moves units into vehicle seats. When units don't exist, it will create them in a group of vehicle's side.","syntaxes":[{"syntax":"[object, params, deleteCrew, anySeat, agents] call BIS_fnc_initVehicleCrew","params":[{"name":"object","type":"Object","type_expr":"Object"},{"name":"params","type":"Array","description":"in format:\n\n- 0: crewType: Object or String - unit or unit type (will be created)\n- 1: role: String - Can be:\n  - \"driver\"\n  - \"turret\"\n  - \"cargo\"\n- 2: index: Number or Array - Cargo index or turret path","type_expr":"Array"},{"name":"deleteCrew","type":"Boolean","optional":true,"default":"false","description":"true to delete existing crew","type_expr":"Boolean","text":"deleteCrew: Boolean - (Optional, default false) true to delete existing crew"},{"name":"anySeat","type":"Boolean","optional":true,"default":"false","description":"when desired seats are occuppied, move crew in the vehicle to any other available seat","type_expr":"Boolean","text":"anySeat: Boolean - (Optional, default false) when desired seats are occuppied, move crew in the vehicle to any other available seat"},{"name":"agents","type":"Boolean","optional":true,"default":"false","description":"create crew as agents","type_expr":"Boolean","text":"agents: Boolean - (Optional, default false) create crew as agents"}],"returns":{"type":"Array","type_expr":"Array","description":"created units"}}],"examples":[{"code":["[someVehicle, [player, \"driver\", 0], true, true] call BIS_fnc_initVehicleCrew;"]}],"see_also":["createVehicle","crew","driver"]},{"name":"BIS_fnc_initVehicleKart","title":"BIS fnc initVehicleKart","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_initVehicleKart","revid":348244,"updated":"2023-11-08T11:40:32Z","groups":["Vehicles"],"status":"ok","games":{"arma3":"1.20"},"since":"arma3 1.20","arma3_since":"1.20","description":"Customise given kart and its driver.","syntaxes":[{"syntax":"[kart,number,livery,raceTeam] call BIS_fnc_initVehicleKart","params":[{"name":"kart","type":"Object","type_expr":"Object"},{"name":"number","type":"Array","optional":true,"default":"[-1,-1]","description":"kart number from 00 to 99","type_expr":"Array","text":"number: Array - (Optional, default [-1,-1]) kart number from 00 to 99"},{"name":"livery","type":"Number","optional":true,"default":"Random","description":"kart livery. A integer from 0 to 9","type_expr":"Number","text":"livery: Number - (Optional, default *Random*) kart livery. A integer from 0 to 9"},{"name":"raceTeam","type":"Number","optional":true,"default":"Matches the livery","description":"driver uniform","type_expr":"Number","text":"raceTeam: Number - (Optional, default *Matches the livery*) driver uniform"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"always true"}}],"examples":[{"code":["[BIS_kart, [9,7], -1, -1] call BIS_fnc_initVehicleKart;"]}],"see_also":["BIS_fnc_initVehicle","Arma 3 Karts"]},{"name":"BIS_fnc_initVirtualUnit","title":"BIS fnc initVirtualUnit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_initVirtualUnit","revid":348570,"updated":"2023-11-08T13:42:08Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Initialize virtual unit. Disable it, turn the camera upwards and save its correct side.","syntaxes":[{"syntax":"[object] call BIS_fnc_initVirtualUnit","params":[{"name":"object","type":"Object","description":"object to be turned into virtual unit","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["someObject call BIS_fnc_initVirtualUnit;"]}],"see_also":["BIS_fnc_isUnitVirtual"]},{"name":"BIS_fnc_initWorldScene","title":"BIS fnc initWorldScene","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_initWorldScene","revid":274003,"updated":"2021-06-13T01:14:59Z","groups":["Scenes"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Initialize world scene","syntaxes":[{"syntax":"[] call BIS_fnc_initWorldScene","params":[{"name":"arg","type":"Array, Code","type_expr":"Array<Code>","description":"random code will be selected and called. The code should contain scene init","text":"ARRAY of CODEs - random code will be selected and called. The code should contain scene init","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Karel Moricky\n\nDescription:\n    Initialize world scene\n\nParameter(s):\n    ARRAY of CODEs - random code will be selected and called. The code should contain scene init\n\nReturns:\n    Nothing","author":"Karel Moricky"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_inString","title":"BIS fnc inString","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_inString","revid":379499,"updated":"2026-10-31T00:26:54Z","groups":["Strings"],"status":"deprecated","replaced_by":["find","in"],"games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"> [!CAUTION]\n> This information is **obsolete**. Reason: See find and in commands's alternative syntaxes that replace this function.\n\nFind a string within a string.","syntaxes":[{"syntax":"[searchTerm, searchText, caseSensitive] call BIS_fnc_inString","params":[{"name":"searchTerm","type":"String","description":"string to find","type_expr":"String"},{"name":"searchText","type":"String","description":"string to search in","type_expr":"String"},{"name":"caseSensitive","type":"Boolean","optional":true,"default":"false","description":"defines whether the search is case-sensitive (true) or not (false)","type_expr":"Boolean","text":"caseSensitive: Boolean - (Optional, default false) defines whether the search is case-sensitive (true) or not (false)"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if search term is found, false if not"}}],"examples":[{"code":["[\"rabbit\", \"I ate a rabbit today\"] call BIS_fnc_inString // will return true"]},{"code":["[\"RaBbiT\", \"I ate a rabbit today\"] call BIS_fnc_inString // will return true"]},{"code":["[\"RaBbiT\", \"I ate a rabbit today\", true] call BIS_fnc_inString // will return false because of case sensitivity"]}],"see_also":["find","BIS_fnc_filterString","splitString","joinString"]},{"name":"BIS_fnc_instructorFigure","title":"BIS fnc instructorFigure","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_instructorFigure","revid":309750,"updated":"2022-05-05T12:09:48Z","groups":["Systems"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"```\n/*******************************************************************************\n    Version:        0.1\n    Name:            Instructor Figure\n    DESCRIPTION:    www.\n    PARAMETERS:        1) function called - string, list of functions:\n                        - Init\n                        - Destroy\n                    2) parameter for the function\n                    For more information see https://wiki.bistudio.com/index.php/A3_InstructorFigure\n    RETURNED VALUE:    depends on the function called\n\n    TODO:            + PlayTopic\n                    + Fade out New Intel text\n                    + wait for TAB press\n                    + use functions for dynamic text\n                    - kbTell support\n                        - logging\n                        + rework data structure (add, remove, search)\n                        - ContainerExists function\n                    + display only if difficulty is low\n                    + disableSerialization\n                    + GetTopics should return array, not just debuglog info\n                    + deny play more than one topic in a time\n                    + Localize\n                    + check and fix return values of functions\n                    + correct debuglog information\n                    - deny addtopic during playing\n                    + safe work with BIS_GroupCommunication - dont overwrite user menus\n                    + remove INSTRUCTOR FIGURE from BIS_GroupCommunication\n                    + PlayTopicRandom - rule exceeding selection of a previous sentence\n*******************************************************************************/\n\n//Variables\n```","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_interpolate","title":"BIS fnc interpolate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_interpolate","revid":349224,"updated":"2023-11-08T14:50:50Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Interpolates scalar to target, starts fast, eases out","syntaxes":[{"syntax":"[currentValue, targetValue, delta, interpSpeed] call BIS_fnc_interpolate","params":[{"name":"currentValue","type":"Number","description":"the current value","type_expr":"Number"},{"name":"targetValue","type":"Number","description":"the target value","type_expr":"Number"},{"name":"delta","type":"Number","optional":true,"default":"0","description":"the delta time","type_expr":"Number","text":"delta: Number - (Optional, default 0) the delta time"},{"name":"interpSpeed","type":"Number","optional":true,"default":"0","description":"the interpolation speed","type_expr":"Number","text":"interpSpeed: Number - (Optional, default 0) the interpolation speed"}],"returns":{"type":"Number","type_expr":"Number","description":"the interpolated value"}}],"examples":[{"code":["private _value = [4,8,0.2,0.1] call BIS_fnc_interpolate;"]}],"see_also":["BIS_fnc_interpolateConstant","BIS_fnc_interpolateVector","BIS_fnc_interpolateVectorConstant"]},{"name":"BIS_fnc_interpolateConstant","title":"BIS fnc interpolateConstant","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_interpolateConstant","revid":349192,"updated":"2023-11-08T14:50:40Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Interpolates scalar to target linearly.","syntaxes":[{"syntax":"[currentValue, targetValue, delta, interpSpeed] call BIS_fnc_interpolateConstant","params":[{"name":"currentValue","type":"Number","description":"the current value","type_expr":"Number"},{"name":"targetValue","type":"Number","description":"the target value","type_expr":"Number"},{"name":"delta","type":"Number","optional":true,"default":"0","description":"the delta time","type_expr":"Number","text":"delta: Number - (Optional, default 0) the delta time"},{"name":"interpSpeed","type":"Number","optional":true,"default":"0","description":"the interpolation speed","type_expr":"Number","text":"interpSpeed: Number - (Optional, default 0) the interpolation speed"}],"returns":{"type":"Number","type_expr":"Number","description":"the interpolated value"}}],"examples":[{"code":["private _value = [4,8,0.2,0.1] call BIS_fnc_interpolateConstant;"]}],"see_also":["BIS_fnc_interpolate","BIS_fnc_interpolateVector","BIS_fnc_interpolateVectorConstant"]},{"name":"BIS_fnc_interpolateVector","title":"BIS fnc interpolateVector","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_interpolateVector","revid":349263,"updated":"2023-11-08T14:51:08Z","groups":["Interpolation","Vectors"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Interpolates vector to target, scaled by distance.\nStarts very fast and smoothes out.","syntaxes":[{"syntax":"[currentValue, targetValue, delta, interpSpeed] call BIS_fnc_interpolateVector","params":[{"name":"currentValue","type":"Array","description":"the current value","type_expr":"Array"},{"name":"targetValue","type":"Array","description":"the target value","type_expr":"Array"},{"name":"delta","type":"Number","optional":true,"default":"0","description":"the delta time","type_expr":"Number","text":"delta: Number - (Optional, default 0) the delta time"},{"name":"interpSpeed","type":"Number","optional":true,"default":"0","description":"the interpolation speed","type_expr":"Number","text":"interpSpeed: Number - (Optional, default 0) the interpolation speed"}],"returns":{"type":"Array","type_expr":"Array","description":"the interpolated value"}}],"examples":[{"code":["[[1,1,1], [20,20,20], 0.2, 0.1] call BIS_fnc_interpolateVector;"]}],"see_also":["BIS_fnc_interpolateConstant","BIS_fnc_interpolate","BIS_fnc_interpolateVectorConstant"]},{"name":"BIS_fnc_interpolateVectorConstant","title":"BIS fnc interpolateVectorConstant","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_interpolateVectorConstant","revid":349200,"updated":"2023-11-08T14:50:42Z","groups":["Interpolation","Vectors"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Interpolates vector to target linearly.","syntaxes":[{"syntax":"[currentValue, targetValue, delta, interpSpeed] call BIS_fnc_interpolateVectorConstant","params":[{"name":"currentValue","type":"Array","description":"the current value","type_expr":"Array"},{"name":"targetValue","type":"Array","description":"the target value","type_expr":"Array"},{"name":"delta","type":"Number","optional":true,"default":"0","description":"the delta time","type_expr":"Number","text":"delta: Number - (Optional, default 0) the delta time"},{"name":"interpSpeed","type":"Number","optional":true,"default":"0","description":"the interpolation speed","type_expr":"Number","text":"interpSpeed: Number - (Optional, default 0) the interpolation speed"}],"returns":{"type":"Array","type_expr":"Array","description":"the interpolated value"}}],"examples":[{"code":["[[1,1,1], [20,20,20], 0.2, 0.1] call BIS_fnc_interpolateVectorConstant;"]}],"see_also":["BIS_fnc_interpolateConstant","BIS_fnc_interpolate","BIS_fnc_interpolateVector"]},{"name":"BIS_fnc_interpolateWeather","title":"BIS fnc interpolateWeather","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_interpolateWeather","revid":309835,"updated":"2022-05-05T12:09:52Z","groups":["Environment"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Interpolate weather (overcast and fog) according to 2 boundry dates and their weather conditions.","syntaxes":[{"syntax":"[param0, param1, param2, param3, param4] call BIS_fnc_interpolateWeather","params":[{"name":"param0","type":"Array","type_expr":"Array","description":"_date1     [_year1,_month1,_day1,_hour1,_min1]","text":"0: array    - _date1     [_year1,_month1,_day1,_hour1,_min1]","source":"docblock"},{"name":"param1","type":"Array","type_expr":"Array","description":"_weather1    [_overcast1,_fog1]","text":"1: array    - _weather1    [_overcast1,_fog1]","source":"docblock"},{"name":"param2","type":"Array","type_expr":"Array","description":"_date2     [_year2,_month2,_day2,_hour2,_min2]","text":"2: array    - _date2     [_year2,_month2,_day2,_hour2,_min2]","source":"docblock"},{"name":"param3","type":"Array","type_expr":"Array","description":"_weather2    [_overcast2,_fog2]","text":"3: array    - _weather2    [_overcast2,_fog2]","source":"docblock"},{"name":"param4","type":"Array","type_expr":"Array","default":"current date","description":"_subjectDate     [_year,_month,_day,_hour,_min] (default: current date)","text":"4: array    - _subjectDate     [_year,_month,_day,_hour,_min] (default: current date)","source":"docblock"}],"returns":{"text":"[_interpolatedOvercast,_interpolatedFog]","source":"docblock"},"inferred":true}],"examples":[{"code":["[_overcast,_fog] = [[2035,1,5,24,00],[0.1,0.5],[2035,1,10,24,00],[0.3,0.2],[2035,1,7,24,00]] call BIS_fnc_interpolateWeather;"]}],"docblock":{"text":"Description:\nInterpolate weather (overcast and fog) according to 2 boundry dates and their weather conditions.\n\nParameter(s):\n_this select 0: array    - _date1     [_year1,_month1,_day1,_hour1,_min1]\n_this select 1: array    - _weather1    [_overcast1,_fog1]\n_this select 2: array    - _date2     [_year2,_month2,_day2,_hour2,_min2]\n_this select 3: array    - _weather2    [_overcast2,_fog2]\n_this select 4: array    - _subjectDate     [_year,_month,_day,_hour,_min] (default: current date)\n\nReturns:\n[_interpolatedOvercast,_interpolatedFog]\n\nExample:\n[_overcast,_fog] = [[2035,1,5,24,00],[0.1,0.5],[2035,1,10,24,00],[0.3,0.2],[2035,1,7,24,00]] call BIS_fnc_interpolateWeather;"},"filled_from_docblock":["description","params","syntax","returns","examples"]},{"name":"BIS_fnc_inTrigger","title":"BIS fnc inTrigger","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_inTrigger","revid":369527,"updated":"2024-09-15T18:22:20Z","groups":["Object Manipulation"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Detects whether position is within area **or** calculates distance to the nearest edge of trigger area by using optional params.\n\n> [!NOTE]\n> **Arma 3:** Since Arma 3 v1.58 inArea is available for an area check.","syntaxes":[{"syntax":"[area, position, returnDistance, includeFloorCeiling] call BIS_fnc_inTrigger","params":[{"name":"area","type":"Object, String, Location or Array","description":"Object, String, Location or Array\n\n- Object - trigger\n- String - marker\n- Location - location\n- Array - in format [center, distance] or [center, [a, b, angle, rect]] or [center, [a, b, angle, rect, height]]","type_expr":"Object | String | Location | Array","text":"area: Object, String, Location or Array\n\n- Object - trigger\n- String - marker\n- Location - location\n- Array - in format [center, distance] or [center, [a, b, angle, rect]] or [center, [a, b, angle, rect, height]]"},{"name":"position","type":"Object or Array","description":"position to check (e.g. player) or Position","type_expr":"Object | Array"},{"name":"returnDistance","type":"Boolean","optional":true,"default":"false","description":"true to return distance to nearest edge of trigger area","type_expr":"Boolean","text":"returnDistance: Boolean - (Optional, default false) true to return distance to nearest edge of trigger area"},{"name":"includeFloorCeiling","type":"Boolean","optional":true,"default":"false","description":"to include trigger area floor and ceiling in calculation when calculating distance to nearest edge","type_expr":"Boolean","text":"includeFloorCeiling: Boolean - (Optional, default false) to include trigger area floor and ceiling in calculation when calculating distance to nearest edge"}],"returns":{"types":["Boolean"],"type_expr":"Boolean | Number","description":"- Boolean - true when position is in area, false if not - Number - (when returnDistance is true) - distance from closest border: negative distance - from inside, positive distance - from outside","text":"- Boolean - true when position is in area, false if not\n- Number - (when *returnDistance* is true) - distance from closest border: negative distance - from inside, positive distance - from outside"}}],"examples":[{"code":["private _trigger = createTrigger [\"EmptyDetector\", getPosATL player];\n_trigger setTriggerArea [10, 10, 0, false];\n_inTrigger = [_trigger, player] call BIS_fnc_inTrigger; // _inTrigger = true"]}],"see_also":["createTrigger","createMarker","setTriggerArea","setMarkerSize","triggerArea","markerSize","inArea","inAreaArray","BIS_fnc_getArea"]},{"name":"BIS_fnc_inv","title":"BIS fnc inv","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_inv","revid":327932,"updated":"2022-07-13T12:32:54Z","groups":["Inventory"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Returns inventory contents of given vehicle (unit). For vehicles it returns mounted gun and its ammo, **not** cargo weapons and ammo.","syntaxes":[{"syntax":"[unit] call BIS_fnc_inv","params":[{"name":"unit","type":"Object","description":"unit or vehicle","type_expr":"Object"}],"returns":{"type":"Array of Config","type_expr":"Array<Config>","description":"weapons then magazines"}}],"examples":[{"code":["[player] call BIS_fnc_inv;"]}],"see_also":["BIS_fnc_invAdd","BIS_fnc_invRemove","BIS_fnc_invCodeToArray","BIS_fnc_invString","BIS_fnc_invSlots","BIS_fnc_invSlotsEmpty","BIS_fnc_invSlotType"]},{"name":"BIS_fnc_invAdd","title":"BIS fnc invAdd","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_invAdd","revid":349427,"updated":"2023-11-08T16:27:33Z","groups":["Inventory"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Adds item to inventory - checks if there is room for it. Checks if add was done by engine.","syntaxes":[{"syntax":"[object,class,force] call BIS_fnc_invAdd","params":[{"name":"object","type":"Object","type_expr":"Object"},{"name":"class","type":"String","description":"item class to be added","type_expr":"String"},{"name":"force","type":"Boolean","optional":true,"default":"false","description":"true to force add item, other items might be removed","type_expr":"Boolean","text":"force: Boolean - (Optional, default false) true to force add item, other items might be removed"}],"returns":{"type":"Boolean or Array","type_expr":"Boolean | Array","description":"true when successfull, Array if force is set to true and items were removed (retuns items)"}}],"examples":[{"code":["[player,\"someClass\"] call BIS_fnc_invAdd;"]}],"see_also":["BIS_fnc_invRemove","BIS_fnc_invCodeToArray","BIS_fnc_invString","BIS_fnc_invSlots","BIS_fnc_invSlotsEmpty","BIS_fnc_invSlotType"]},{"name":"BIS_fnc_invCodeToArray","title":"BIS fnc invCodeToArray","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_invCodeToArray","revid":349404,"updated":"2023-11-08T16:27:26Z","groups":["Inventory"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Converts inventory code (used in configs) to array with numbers for weapons and magazines (and their counts).","syntaxes":[{"syntax":"[configCode] call BIS_fnc_invCodeToArray","params":[{"name":"configCode","type":"Number","description":"config code, see example","type_expr":"Number"}],"returns":{"type":"Array of Numbers","type_expr":"Array<Number>","description":"items slots numbers"}}],"examples":[{"code":["[call compile getText (configfile >> \"CfgVehicles\" >> typeOf player >> \"weaponSlots\")] call BIS_fnc_invCodeToArray;//Can return [1,0,0,0,0,0,0,0]"]}],"see_also":["BIS_fnc_invRemove","BIS_fnc_invString","BIS_fnc_invSlots","BIS_fnc_invSlotsEmpty","BIS_fnc_invSlotType","BIS_fnc_invAdd"]},{"name":"BIS_fnc_inventoryExists","title":"BIS fnc inventoryExists","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_inventoryExists","revid":328426,"updated":"2022-07-13T16:00:51Z","groups":["Inventory"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Check if loadout with given name exists.","syntaxes":[{"syntax":"[source, name] call BIS_fnc_inventoryExists","params":[{"name":"source","type":"Namespace, Group or Object","optional":true,"default":"missionNamespace","description":"loadout location","type_expr":"Namespace | Group | Object","text":"source: Namespace, Group or Object - (Optional, default missionNamespace) loadout location"},{"name":"name","type":"String","optional":true,"default":"\"\"","type_expr":"String","text":"name: String - (Optional, default \"\")"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if found, false otherwise"}}],"examples":[{"code":["private _hasSuperLoadout = [missionNamespace, \"mySuperLoadout\"] call BIS_fnc_inventoryExists;"]}],"see_also":["setUnitLoadout","getUnitLoadout","BIS_fnc_saveInventory","BIS_fnc_deleteInventory","BIS_fnc_loadInventory"]},{"name":"BIS_fnc_inverseLerp","title":"BIS fnc inverseLerp","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_inverseLerp","revid":349097,"updated":"2023-11-08T14:49:33Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Inverse of BIS_fnc_lerp.","syntaxes":[{"syntax":"[currentValue, targetValue, alpha] call BIS_fnc_inverseLerp","params":[{"name":"currentValue","type":"Number","description":"start","type_expr":"Number"},{"name":"targetValue","type":"Number","description":"end","type_expr":"Number"},{"name":"alpha","type":"Number","description":"alpha","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number","description":"interpolated value"}}],"examples":[{"code":["[10,20,0.5] call BIS_fnc_inverseLerp;"]}],"see_also":["BIS_fnc_clerp","BIS_fnc_slerp","BIS_fnc_lerp","BIS_fnc_lerpVector"]},{"name":"BIS_fnc_invRemove","title":"BIS fnc invRemove","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_invRemove","revid":349422,"updated":"2023-11-08T16:27:33Z","groups":["Inventory"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Removes from inventory. Given number of items. Returns actually removed items count.","syntaxes":[{"syntax":"[object,class,count] call BIS_fnc_invRemove","params":[{"name":"object","type":"Object","type_expr":"Object"},{"name":"class","type":"String","description":"item class to be added","type_expr":"String"},{"name":"count","type":"Number","optional":true,"default":"1","description":"number of items to be removed","type_expr":"Number","text":"count: Number - (Optional, default 1) number of items to be removed"}],"returns":{"type":"Number","type_expr":"Number","description":"number of items which were removed"}}],"examples":[{"code":["[player,\"someClass\",5] call BIS_fnc_invRemove;"]}],"see_also":["BIS_fnc_invCodeToArray","BIS_fnc_invString","BIS_fnc_invSlots","BIS_fnc_invSlotsEmpty","BIS_fnc_invSlotType","BIS_fnc_invAdd"]},{"name":"BIS_fnc_invSlots","title":"BIS fnc invSlots","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_invSlots","revid":363571,"updated":"2024-04-07T08:41:24Z","groups":["Inventory"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Returns config inventory slots of given unit (total numbers of available slots in array).","syntaxes":[{"syntax":"[object] call BIS_fnc_invSlots","params":[{"name":"object","type":"Object","type_expr":"Object"}],"returns":{"type":"Array","type_expr":"Array","description":"array with total available slots of all types that are given by config"}}],"examples":[{"text":"```sqf\n[player] call BIS_fnc_invSlots;    // returns [1,1,1,8,12,1,0,12] for \"B_T_Recon_TL_F\" class\n                                // means: 1 x WeaponSlotPrimary, 1 x WeaponSlotHangun, ... , 12 x WeaponSlotInventory\n```","code":["[player] call BIS_fnc_invSlots;\t// returns [1,1,1,8,12,1,0,12] for \"B_T_Recon_TL_F\" class\n\t\t\t\t\t\t\t\t// means: 1 x WeaponSlotPrimary, 1 x WeaponSlotHangun, ... , 12 x WeaponSlotInventory"]}],"see_also":["BIS_fnc_invRemove","BIS_fnc_invCodeToArray","BIS_fnc_invString","BIS_fnc_invSlotsEmpty","BIS_fnc_invSlotType","BIS_fnc_invAdd"]},{"name":"BIS_fnc_invSlotsEmpty","title":"BIS fnc invSlotsEmpty","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_invSlotsEmpty","revid":349403,"updated":"2023-11-08T16:27:25Z","groups":["Inventory"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Returns empty inventory slots of given unit.","syntaxes":[{"syntax":"[object] call BIS_fnc_invSlotsEmpty","params":[{"name":"object","type":"Object","type_expr":"Object"}],"returns":{"type":"Array","type_expr":"Array","description":"array with empty slots"}}],"examples":[{"code":["[player] call BIS_fnc_invSlotsEmpty;//Can return [0,0,-1,-7,0,-1,0,-12]"]}],"see_also":["BIS_fnc_invRemove","BIS_fnc_invCodeToArray","BIS_fnc_invString","BIS_fnc_invSlots","BIS_fnc_invSlotType","BIS_fnc_invAdd"]},{"name":"BIS_fnc_invSlotType","title":"BIS fnc invSlotType","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_invSlotType","revid":349431,"updated":"2023-11-08T16:27:36Z","groups":["Inventory"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Returns empty inventory slots of given unit.","syntaxes":[{"syntax":"[class] call BIS_fnc_invSlotType","params":[{"name":"class","type":"String","description":"inventory item","type_expr":"String"}],"returns":{"type":"Array of Numbers","type_expr":"Array<Number>","description":"numbers representing slots taken by given item (one item can take more slots of same or different type), empty if type 0 or not found"}}],"examples":[{"code":["[currentWeapon player] call BIS_fnc_invSlotType;//Can return [1,0,0,0,0,0,0,0]"]}],"see_also":["BIS_fnc_invRemove","BIS_fnc_invCodeToArray","BIS_fnc_invString","BIS_fnc_invSlots","BIS_fnc_invSlotsEmpty","BIS_fnc_invAdd"]},{"name":"BIS_fnc_invString","title":"BIS fnc invString","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_invString","revid":349394,"updated":"2023-11-08T16:27:25Z","groups":["Inventory"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Returns inventory contents of given vehicle (unit).\n\nNote: for vehicles it returns mounted gun and its ammo, not cargo weapons and ammo.","syntaxes":[{"syntax":"[object] call BIS_fnc_invString","params":[{"name":"object","type":"Object","type_expr":"Object"}],"returns":{"type":"Array","type_expr":"Array","description":"weapons and magazines"}}],"examples":[{"code":["[player] call BIS_fnc_invString;"]}],"see_also":["BIS_fnc_invRemove","BIS_fnc_invCodeToArray","BIS_fnc_invSlots","BIS_fnc_invSlotsEmpty","BIS_fnc_invSlotType","BIS_fnc_invAdd"]},{"name":"BIS_fnc_isBuildingEnterable","title":"BIS fnc isBuildingEnterable","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_isBuildingEnterable","revid":309316,"updated":"2022-05-05T12:04:26Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Check whether a building or structure has available positions defined within model.","syntaxes":[{"syntax":"param call BIS_fnc_isBuildingEnterable","params":[{"name":"param","type":"Object","type_expr":"Object"},{"name":"param","type":"Number","type_expr":"Number"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[_building] call BIS_fnc_isBuildingEnterable;"]},{"code":["[_building, _minNumberOfPositions] call BIS_fnc_isBuildingEnterable;"]}]},{"name":"BIS_fnc_isCampaign","title":"BIS fnc isCampaign","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_isCampaign","revid":309322,"updated":"2022-05-05T12:04:27Z","groups":["Campaign","Missions"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Checks to see if a mission is being run in a campaign.","syntaxes":[{"syntax":"[] call BIS_fnc_isCampaign","params":[],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if being run in a campaign, false if not"}}],"examples":[{"code":["[] call BIS_fnc_isCampaign;"]}],"see_also":["campaignConfigFile"]},{"name":"BIS_fnc_isCurator","title":"BIS fnc isCurator","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_isCurator","revid":348562,"updated":"2023-11-08T13:42:06Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Returns if given object is curator logic. Despite the misleading name this does not check if a player has access to Zeus. It just check if the given object's simulation is of type \"curator\".","syntaxes":[{"syntax":"object call BIS_fnc_isCurator","params":[{"name":"object","type":"Object","description":"object which should be checked","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["player call BIS_fnc_isCurator;"]}],"see_also":["Arma 3: Curator"]},{"name":"BIS_fnc_isCuratorEditable","title":"BIS fnc isCuratorEditable","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_isCuratorEditable","revid":348581,"updated":"2023-11-08T13:42:14Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Return true if given object is editable by player (when he's curator).","syntaxes":[{"syntax":"[object] call BIS_fnc_isCuratorEditable","params":[{"name":"object","type":"Object","description":"object to be checked","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if editable, otherwise false"}}],"examples":[{"code":["[object_1] call BIS_fnc_isCuratorEditable;"]}],"see_also":["Arma 3: Curator"]},{"name":"BIS_fnc_isDateTimeNewer","title":"BIS fnc isDateTimeNewer","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_isDateTimeNewer","revid":323994,"updated":"2022-07-01T11:58:31Z","groups":["Environment"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Returns true if the first passed datetime is newer than the second one.","syntaxes":[{"syntax":"[date1, date2] call BIS_fnc_isDateTimeNewer","params":[{"name":"date1","type":"Array format Date","type_expr":"Date","types":["Array","Date"]},{"name":"date2","type":"Array format Date","type_expr":"Date","types":["Array","Date"]}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["private _isNewer = [[2035,5,28,13,37], [2032,5,28,13,37]] call BIS_fnc_isDateTimeNewer;"]}],"see_also":["date","BIS_fnc_compareDateTimes","BIS_fnc_calculateDateTime"]},{"name":"BIS_fnc_isDebugConsoleAllowed","title":"BIS fnc isDebugConsoleAllowed","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_isDebugConsoleAllowed","revid":349022,"updated":"2023-11-08T14:47:09Z","groups":["Missions","Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns true if debug console is allowed in current context","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Boolean","type_expr":"Boolean","description":"return true if allowed, false if not"}}],"examples":[{"code":["call BIS_fnc_isDebugConsoleAllowed;"]}],"see_also":["Arma 3: Debug Console","BIS_fnc_debugConsoleExec"]},{"name":"BIS_fnc_isDemo","title":"BIS fnc isDemo","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_isDemo","revid":327111,"updated":"2022-07-12T21:44:50Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns true when game version is demo.","syntaxes":[{"syntax":"call BIS_fnc_isDemo","params":[],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["private _isDemo = call BIS_fnc_isDemo;"]}],"see_also":["BIS_fnc_version","productVersion","requiredVersion"]},{"name":"BIS_fnc_isEqualVector","title":"BIS fnc isEqualVector","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_isEqualVector","revid":349270,"updated":"2023-11-08T14:51:09Z","groups":["Vectors"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Checks whether two vectors are equal with given tolerance.","syntaxes":[{"syntax":"[vector1, vector2, tolerance] call BIS_fnc_isEqualVector","params":[{"name":"vector1","type":"Array","description":"vector 1","type_expr":"Array"},{"name":"vector2","type":"Array","description":"vector 2","type_expr":"Array"},{"name":"tolerance","type":"Number","description":"the tolerance","type_expr":"Number"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"returns true if in tolerance, otherwise false"}}],"examples":[{"code":["[[1,1,1], [2,2,2], 1] call BIS_fnc_isEqualVector; // returns true"]}],"see_also":["isEqualTo","isEqualTypeAny"]},{"name":"BIS_fnc_isForcedCuratorInterface","title":"BIS fnc isForcedCuratorInterface","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_isForcedCuratorInterface","revid":327095,"updated":"2022-07-12T21:44:49Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Return if curator interface is forced (user cannot leave it by pressing Zeus key).","syntaxes":[{"syntax":"[] call BIS_fnc_isForcedCuratorInterface","params":[],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if forced, else false"}}],"examples":[{"code":["private _isForced = call BIS_fnc_isForcedCuratorInterface;"]}],"see_also":["Arma 3: Curator"]},{"name":"BIS_fnc_isInFrontOf","title":"BIS fnc isInFrontOf","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_isInFrontOf","revid":328436,"updated":"2022-07-13T16:00:51Z","groups":["Object Manipulation","Geometry"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Check if an object is in front of another object (in the front 180°)","syntaxes":[{"syntax":"[reference, checked, offset] call BIS_fnc_isInFrontOf","params":[{"name":"reference","type":"Object","description":"the reference object","type_expr":"Object"},{"name":"checked","type":"Object","description":"the object that has to be in front of *reference*","type_expr":"Object"},{"name":"offset","type":"Number","optional":true,"default":"0","description":"allows to check from *offset* meters in front of (positive), or behind (negative) *reference*","type_expr":"Number","text":"offset: Number - (Optional, default 0) allows to check from *offset* meters in front of (positive), or behind (negative) *reference*"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["private _isInstructorInFrontOfPlayer = [player, instructor, 0] call BIS_fnc_isInFrontOf;"]}],"see_also":["getRelDir","BIS_fnc_isInsideArea"]},{"name":"BIS_fnc_isInsideArea","title":"BIS fnc isInsideArea","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_isInsideArea","revid":349465,"updated":"2023-11-08T16:49:17Z","groups":["Geometry"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Detects whether a position is within a square area of given size about center.","syntaxes":[{"syntax":"[center, size, position] call BIS_fnc_isInsideArea","params":[{"name":"center","type":"Array","description":"center Position of area to check","type_expr":"Array"},{"name":"size","type":"Array","description":"[x,y] offsets from center","type_expr":"Array"},{"name":"position","type":"Array","description":"Position to check","type_expr":"Array"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when position is in area, false otherwise"}}],"examples":[{"code":["// Check an area, centered on the player that is 10m wide and 10m tall\n_size = [5, 5];\n_checkPos = getPos player;\n_inArea = [_checkPos, _size, _checkPos] call BIS_fnc_isInsideArea;"]}],"see_also":["createTrigger","createMarker","setTriggerArea","setMarkerSize","triggerArea","markerSize","BIS_fnc_inAngleSector"]},{"name":"BIS_fnc_isInZoom","title":"BIS fnc isInZoom","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_isInZoom","revid":349128,"updated":"2023-11-08T14:49:41Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Checks if map zoom level is in between given interval.","syntaxes":[{"syntax":"[[min, max]] call BIS_fnc_isInZoom","params":[{"name":"min","type":"Number","description":"start of interval","type_expr":"Number"},{"name":"max","type":"Number","description":"end of interval","type_expr":"Number"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"text":"```sqf\nif ([[0.001, 0.02]] call BIS_fnc_isInZoom) then\n{\n  hint \"Zoom level is in between 0.001 and 0.02\";\n};\n```","code":["if ([[0.001, 0.02]] call BIS_fnc_isInZoom) then \n{\n  hint \"Zoom level is in between 0.001 and 0.02\";\n};"]}],"see_also":["ctrlMapScale"]},{"name":"BIS_fnc_isLeapYear","title":"BIS fnc isLeapYear","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_isLeapYear","revid":326986,"updated":"2022-07-12T21:44:43Z","groups":["Math","Environment"],"status":"ok","games":{"arma3":"1.10"},"since":"arma3 1.10","arma3_since":"1.10","description":"Returns true if given year is a leap year, otherwise false.","syntaxes":[{"syntax":"year call BIS_fnc_isLeapYear","params":[{"name":"year","type":"Number","description":"a non-decimal number (a.k.a integer)","type_expr":"Number"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["private _isLeapYear = 2035 call BIS_fnc_isLeapYear;"]},{"code":["private _isLeapYear = 2036 call BIS_fnc_isLeapYear; // 2036 is a leap year"]}],"see_also":["date"]},{"name":"BIS_fnc_isLoading","title":"BIS fnc isLoading","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_isLoading","revid":338991,"updated":"2023-04-23T08:45:57Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Check if a loading screen is opened.","syntaxes":[{"syntax":"call BIS_fnc_isLoading","params":[],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["private _isLoading = call BIS_fnc_isLoading;"]}],"see_also":["BIS_fnc_startLoadingScreen","BIS_fnc_endLoadingScreen","BIS_fnc_progressLoadingScreen"]},{"name":"BIS_fnc_isLocalized","title":"BIS fnc isLocalized","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_isLocalized","revid":330064,"updated":"2022-08-15T16:33:12Z","groups":["Strings"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Checks if string is localized. Obsolete variant before isLocalized command was introduced.","syntaxes":[{"syntax":"[localizationString] call BIS_fnc_isLocalized","params":[{"name":"localizationString","type":"String","type_expr":"String"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[\"STR_someLocalizedString\"] call BIS_fnc_isLocalized;"]}],"see_also":["isLocalized","localize"]},{"name":"BIS_fnc_isPosBlacklisted","title":"BIS fnc isPosBlacklisted","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_isPosBlacklisted","revid":379273,"updated":"2026-10-30T23:44:35Z","groups":["Positions"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Function checks a blacklist and sees if the given position is in it or not.","syntaxes":[{"syntax":"[position, blacklistArea] call BIS_fnc_isPosBlacklisted","params":[{"name":"position","type":"Array format Position","type_expr":"Position","types":["Array","Position"]},{"name":"blacklistArea","type":"Array of Positions or Object","description":"Array of Positions or Object\n\n- Array of Positions - array to format [topLeft, bottomRight]\n- Object - a trigger. Check the trigger area (see inArea or BIS_fnc_inTrigger)","type_expr":"Array<Position> | Object","text":"blacklistArea: Array of Positions or Object\n\n- Array of Positions - array to format [topLeft, bottomRight]\n- Object - a trigger. Check the trigger area (see inArea or BIS_fnc_inTrigger)"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"is the position blacklisted or not"}}],"examples":[{"code":["[[50,50], [[0,0], [100,100]]] call BIS_fnc_isPosBlacklisted;"]},{"code":["[getPosATL player, myTrigger] call BIS_fnc_isPosBlacklisted;"]}],"see_also":["BIS_fnc_inTrigger","inArea","distance2D"]},{"name":"BIS_fnc_isThrowable","title":"BIS fnc isThrowable","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_isThrowable","revid":376125,"updated":"2025-09-01T08:18:13Z","groups":["Inventory"],"status":"deprecated","replaced_by":["isThrowable"],"games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Returns true if given magazine is throwable.\n\n> [!CAUTION]\n> This information is **obsolete** as of Arma 3 v2.18. Reason: see isThrowable.","syntaxes":[{"syntax":"magazine call BIS_fnc_isThrowable","params":[{"name":"magazine","type":"String","description":"magazine class name","type_expr":"String"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if throwable"}}],"examples":[{"code":["private _isThrowable = \"SmokeShellGreen\" call BIS_fnc_isThrowable;"]}],"see_also":["isThrowable","magazines","currentThrowable"]},{"name":"BIS_fnc_isUnitVirtual","title":"BIS fnc isUnitVirtual","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_isUnitVirtual","revid":348563,"updated":"2023-11-08T13:42:06Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Return if unit is virtual (used for example for Zeus players).","syntaxes":[{"syntax":"[object] call BIS_fnc_isUnitVirtual","params":[{"name":"object","type":"Object","description":"object to be turned into virtual unit","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if virtual unit"}}],"examples":[{"code":["private _isVirtual = someObject call BIS_fnc_isUnitVirtual;"]}],"see_also":["BIS_fnc_initVirtualUnit"]},{"name":"BIS_fnc_itemType","title":"BIS fnc itemType","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_itemType","revid":378153,"updated":"2026-02-26T00:02:49Z","groups":["Inventory"],"status":"ok","games":{"arma3":"1.08"},"since":"arma3 1.08","arma3_since":"1.08","description":"> [!IMPORTANT]\n> Be very careful with this function as certain mods modify the categories making this function unreliable!\n\nReturns item category and type.\n\n| Weapon / VehicleWeapon | VehicleWeapon | Item | Equipment | Magazine | Mine |\n|---|---|---|---|---|---|\n| - AssaultRifle<br>- BombLauncher<br>- Cannon<br>- GrenadeLauncher<br>- Handgun<br>- Launcher<br>- MachineGun<br>- Magazine<br>- MissileLauncher<br>- Mortar<br>- RocketLauncher<br>- Shotgun<br>- Throw<br>- Rifle<br>- SubmachineGun<br>- SniperRifle | - Horn<br>- CounterMeasuresLauncher<br>- LaserDesignator | - AccessoryMuzzle<br>- AccessoryPointer<br>- AccessorySights<br>- AccessoryBipod<br>- Binocular<br>- Compass<br>- FirstAidKit<br>- GPS<br>- LaserDesignator<br>- Map<br>- Medikit<br>- MineDetector<br>- NVGoggles<br>- Radio<br>- Toolkit<br>- UAVTerminal<br>- VehicleWeapon<br>- Unknown<br>- UnknownEquipment<br>- UnknownWeapon<br>- Watch | - Glasses<br>- Headgear<br>- Vest<br>- Uniform<br>- Backpack | - Artillery<br>- Bullet<br>- CounterMeasures<br>- Flare<br>- Grenade<br>- Laser<br>- Missile<br>- Rocket<br>- Shell<br>- ShotgunShell<br>- SmokeShell<br>- UnknownMagazine | - Mine<br>- MineBounding<br>- MineDirectional |","syntaxes":[{"syntax":"weaponClass call BIS_fnc_itemType","params":[{"name":"weaponClass","type":"String","description":"weapon's class name","type_expr":"String"}],"returns":{"type":"Array of Strings","type_expr":"Array<String>","description":"format [category, type]","text":"Array of Strings format [category, type]"}}],"examples":[{"code":["\"arifle_MX_pointer_F\" call BIS_fnc_itemType;"]}],"see_also":["currentWeapon"],"notes":[{"user":"Demellion","date":"2017-05-14T19:03:00Z","text":"More detailed description about some specific Weapons and Vehicle Weapons:\n\n| Weapon | Description |\n|---|---|\n| GrenadeLauncher | Underbarrel and HGLs. |\n| BombLauncher | Aircraft bomb throw weapons. |\n| MissileLauncher | Guided missile weapons (alike Titan series). |\n| RocketLauncher | Non-guided missile weapons (alike RPG32). |\n| Cannon | Main vehicle turret (alike tank cannon). |\n| Throw | Throw-like weapons (grenade weapon, melee weapons from mods, etc). |"}]},{"name":"BIS_fnc_jukebox","title":"BIS fnc jukebox","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_jukebox","revid":352108,"updated":"2024-02-01T23:24:56Z","groups":["Sound"],"status":"ok","games":{"arma3":"1.08"},"since":"arma3 1.08","arma3_since":"1.08","description":"Plays music, depending on the player group status.\n\n> [!NOTE]\n> If no music classes are given, the function will get them from config automatically.","syntaxes":[{"syntax":"[function, parameters] call BIS_fnc_jukebox","params":[{"name":"function","type":"String","optional":true,"default":"\"initialize\"","description":"can be one of:\n\n- \"initialize\"\n- \"terminate\"\n- \"readContainerFromConfig\"\n- \"isInitialized\"\n- \"forceBehaviour\"\n- \"status\"\n- \"randomMusic\"\n- \"selectMusic\"\n- \"playMusic\"\n- \"nearEnemies\"\n- \"hasContact\"\n- \"isContact\"\n- \"isStealth\"\n- \"isCombat\"\n- \"isSafe\"\n- \"onEachFrame\"","type_expr":"String","text":"function: String - (Optional, default \"initialize\") can be one of:\n\n- \"initialize\"\n- \"terminate\"\n- \"readContainerFromConfig\"\n- \"isInitialized\"\n- \"forceBehaviour\"\n- \"status\"\n- \"randomMusic\"\n- \"selectMusic\"\n- \"playMusic\"\n- \"nearEnemies\"\n- \"hasContact\"\n- \"isContact\"\n- \"isStealth\"\n- \"isCombat\"\n- \"isSafe\"\n- \"onEachFrame\""},{"name":"parameters","type":"Array","optional":true,"description":"**\"initialize\"**: [stealthMusics, combatMusics, safeMusics, volume, transition, radius, executionRate, noRepeat]\n  - stealthMusics: Array of Strings\n  - combatMusics: Array of Strings\n  - safeMusics: Array of Strings\n  - volume: Number\n- **\"terminate\"**: none\n- **\"readContainerFromConfig\"**: [wantedTheme]\n- **\"isInitialized\"**: none\n- **\"forceBehaviour\"**: [behaviour]\n  - behaviour: String - can be \"stealth\", \"combat\" or \"safe\". Any other value will reset the forced behaviour.\n- **\"status\"**: none\n- **\"randomMusic\"**: [container]\n  - container: Array of Strings - music list to choose from\n- **\"selectMusic\"**: none\n- **\"playMusic\"**: [musicName]\n  - musicName: String\n- **\"nearEnemies\"**: none\n- **\"hasContact\"**: none\n- **\"isContact\"**: none\n- **\"isStealth\"**: none\n- **\"isCombat\"**: none\n- **\"isSafe\"**: none\n- **\"onEachFrame\"**: none","type_expr":"Array","text":"parameters: Array - (Optional)\n\n- **\"initialize\"**: [stealthMusics, combatMusics, safeMusics, volume, transition, radius, executionRate, noRepeat]\n  - stealthMusics: Array of Strings\n  - combatMusics: Array of Strings\n  - safeMusics: Array of Strings\n  - volume: Number\n- **\"terminate\"**: none\n- **\"readContainerFromConfig\"**: [wantedTheme]\n- **\"isInitialized\"**: none\n- **\"forceBehaviour\"**: [behaviour]\n  - behaviour: String - can be \"stealth\", \"combat\" or \"safe\". Any other value will reset the forced behaviour.\n- **\"status\"**: none\n- **\"randomMusic\"**: [container]\n  - container: Array of Strings - music list to choose from\n- **\"selectMusic\"**: none\n- **\"playMusic\"**: [musicName]\n  - musicName: String\n- **\"nearEnemies\"**: none\n- **\"hasContact\"**: none\n- **\"isContact\"**: none\n- **\"isStealth\"**: none\n- **\"isCombat\"**: none\n- **\"isSafe\"**: none\n- **\"onEachFrame\"**: none"}],"returns":{"types":["Array"],"type_expr":"Array | Boolean | String | Nothing","description":"- Array for: - \"readContainerFromConfig\" - \"nearEnemies\" - a list of enemies nearby - Boolean for: - \"isInitialized\" - \"hasContact\" - \"isContact\" - \"isStealth\" - \"isCombat\" - \"isSafe\" - String for: - \"status\" - can be \"stealth\", \"combat\", \"safe\" or \"error\" - \"randomMusic\" - one of the available musics - \"selectMusic\" - Nothing for: - \"initialize\" - \"terminate\" - \"forceBehaviour\" - \"playMusic\" - \"onEachFrame\"","text":"- Array for:\n  - \"readContainerFromConfig\"\n  - \"nearEnemies\" - a list of enemies nearby\n\n- Boolean for:\n  - \"isInitialized\"\n  - \"hasContact\"\n  - \"isContact\"\n  - \"isStealth\"\n  - \"isCombat\"\n  - \"isSafe\"\n\n- String for:\n  - \"status\" - can be \"stealth\", \"combat\", \"safe\" or \"error\"\n  - \"randomMusic\" - one of the available musics\n  - \"selectMusic\"\n\n- Nothing for:\n  - \"initialize\"\n  - \"terminate\"\n  - \"forceBehaviour\"\n  - \"playMusic\"\n  - \"onEachFrame\""}}],"examples":[{"code":["[] call BIS_fnc_jukebox;"]}],"see_also":["playMusic","BIS_fnc_music"]},{"name":"BIS_fnc_kbCanSpeak","title":"BIS fnc kbCanSpeak","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_kbCanSpeak","revid":327091,"updated":"2022-07-12T21:44:49Z","groups":["Conversations"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Check if person is not locked by some conversation.","syntaxes":[{"syntax":"unit call BIS_fnc_kbCanSpeak","params":[{"name":"unit","type":"Object","description":"checked person","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"if the person can speak"}}],"examples":[{"code":["private _canPlayerTalk = player call BIS_fnc_kbCanSpeak;"]}],"see_also":["Conversations","BIS_fnc_kbTell"]},{"name":"BIS_fnc_kbCreateDummy","title":"BIS fnc kbCreateDummy","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_kbCreateDummy","revid":326868,"updated":"2022-07-12T21:35:32Z","groups":["Conversations"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Creates a dummy speaker (as a Game Logic). If given dummy variable has already been created, returns this one.","syntaxes":[{"syntax":"dummyVarName call BIS_fnc_kbCreateDummy","params":[{"name":"dummyVarName","type":"String","description":"can be anything, but if an identity from CfgIdentities the dummy will take this identity.","type_expr":"String"}],"returns":{"type":"Object","type_expr":"Object","description":"dummy speaker game logic"}}],"examples":[{"code":["private _dummySpeaker = \"BIS_dummySpeaker\" call BIS_fnc_kbCreateDummy; // _dummySpeaker == BIS_dummySpeaker now"]},{"code":["private _dummySpeaker = \"Miller\" call BIS_fnc_kbCreateDummy; // given Miller is defined in CfgIdentities"]}],"see_also":["Conversations"]},{"name":"BIS_fnc_kbIsSpeaking","title":"BIS fnc kbIsSpeaking","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_kbIsSpeaking","revid":323974,"updated":"2022-07-01T11:58:30Z","groups":["Conversations"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Check if speaker is locked for different conversation.","syntaxes":[{"syntax":"unit call BIS_fnc_kbIsSpeaking","params":[{"name":"unit","type":"Object","description":"the speaker","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["player call BIS_fnc_kbIsSpeaking;"]}],"see_also":["Conversations","BIS_fnc_kbTell","kbWasSaid"]},{"name":"BIS_fnc_kbMenu","title":"BIS fnc kbMenu","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_kbMenu","revid":309849,"updated":"2022-05-05T12:09:52Z","groups":["Conversations"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Opens conversation menu. Script terminates itself when menu selection is finished.","syntaxes":[{"syntax":"[param0] call BIS_fnc_kbMenu","params":[{"name":"param0","type":"Array, String","type_expr":"Array | String","default":"option when menu is closed without selecting anything","description":"List of responses (of type ARRAY) or Menu name\nResponses are in format:\n_response select 0: STRING or ANY - Display name when STRING, otherwise used as default option when menu is closed without selecting anything.\n_response select 1:\n    STRING - expression\n    ARRAY - BIS_fnc_kbTell params","text":"0: ARRAY or STRING - List of responses (of type ARRAY) or Menu name\nResponses are in format:\n_response select 0: STRING or ANY - Display name when STRING, otherwise used as default option when menu is closed without selecting anything.\n_response select 1:\n    STRING - expression\n    ARRAY - BIS_fnc_kbTell params","source":"docblock"}],"returns":{"type":"Number","type_expr":"Number","description":"ID of select option","text":"NUMBER - ID of select option","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nOpens conversation menu. Script terminates itself when menu selection is finished.\n\nParameter(s):\n_this select 0: ARRAY or STRING - List of responses (of type ARRAY) or Menu name\n    Responses are in format:\n    _response select 0: STRING or ANY - Display name when STRING, otherwise used as default option when menu is closed without selecting anything.\n    _response select 1:\n        STRING - expression\n        ARRAY - BIS_fnc_kbTell params\n\nReturns:\nNUMBER - ID of select option"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_kbPriority","title":"BIS fnc kbPriority","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_kbPriority","revid":309839,"updated":"2022-05-05T12:09:52Z","groups":["Conversations"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Set conversation priority. Conversations with priority not in the list won't be played","syntaxes":[{"syntax":"_this call BIS_fnc_kbPriority","params":[{"name":"_this","type":"Array, Number","type_expr":"Array | Number","description":"ARRAY - List of priorities. Empty array will just return current value.\nNUMBER\n    >0 - add priority to already existing list\n    <0 - remove priority from already existing list\n    Priority 0 cannot be tempered with","text":"ARRAY - List of priorities. Empty array will just return current value.\nNUMBER\n    >0 - add priority to already existing list\n    <0 - remove priority from already existing list\n    Priority 0 cannot be tempered with","source":"docblock"}],"returns":{"type":"Array","type_expr":"Array","description":"List of priorities","text":"ARRAY - List of priorities","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nSet conversation priority. Conversations with priority not in the list won't be played\n\nParameter(s):\n_this:\n    ARRAY - List of priorities. Empty array will just return current value.\n    NUMBER\n        >0 - add priority to already existing list\n        <0 - remove priority from already existing list\n        Priority 0 cannot be tempered with\n\nReturns:\nARRAY - List of priorities"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_kbSentence","title":"BIS fnc kbSentence","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_kbSentence","revid":309864,"updated":"2022-05-05T12:09:53Z","groups":["Conversations"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_kbSkip","title":"BIS fnc kbSkip","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_kbSkip","revid":328421,"updated":"2022-07-13T16:00:50Z","groups":["Conversations"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Skip a conversation started with BIS_fnc_kbTell. Currently played sentence will be finished.","syntaxes":[{"syntax":"[topicName, mission, wait] call BIS_fnc_kbSkip","params":[{"name":"topicName","type":"String or Object","description":"either topic name or the person currently talking","type_expr":"String | Object"},{"name":"mission","type":"String","optional":true,"default":"missionName","type_expr":"String","text":"mission: String - (Optional, default missionName)"},{"name":"wait","type":"Boolean or Array or Number","type_expr":"Boolean | Array | Number"}],"returns":{"type":"Boolean or Number","type_expr":"Boolean | Number"}}],"examples":[{"code":["[\"topic1\", \"currentMission\"] call BIS_fnc_kbSkip;"]},{"code":["[player] call BIS_fnc_kbSkip;"]}],"see_also":["BIS_fnc_kbTell","Conversations"]},{"name":"BIS_fnc_kbTell","title":"BIS fnc kbTell","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_kbTell","revid":370523,"updated":"2025-01-01T18:16:34Z","groups":["Conversations"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","locality":{"argument":"global","effect":"global"},"exec":"spawn","description":"Play given sentence/conversation. Script terminates itself when conversation is finished.\nConversation must be declared in Description.ext/CfgSentences.\n\n> [!NOTE]\n> This function can also be executed with call. Doing so will make it internally spawn since it needs to be able suspend its execution.","syntaxes":[{"syntax":"[topic, container, section, radioMode, code, speakers, soundVolume, radioProtocol] spawn BIS_fnc_kbTell","params":[{"name":"topic","type":"String","description":"topic name","type_expr":"String"},{"name":"container","type":"String","optional":true,"default":"missionName","description":"container name (CfgSentences sub-category)","type_expr":"String","text":"container: String - (Optional, default missionName) container name (CfgSentences sub-category)"},{"name":"section","type":"Array or String","optional":true,"default":"\"\"","description":"section to be played. Elements can be:\n\n- String - \"variant\" - play specific variant\n- Array\n  - [startingSentence(, endingSentence)] - play all sentences between specific start and end\n    - startingSentence and endingSentence can be in format:\n      - String - full sentence name (example: \"04_intro_team_PLA_0\")\n      - Array - [<actorID>(, <sentenceID>)] (example: [\"PLA\", 0] or just [\"PLA_0\"])\n      - Boolean - true to play random sentence, false to play first sentence\n      - default - first sentence for startingSentence, last sentence for endingSentence\n- default: play everything","type_expr":"Array | String","text":"section: Array or String - (Optional, default \"\") section to be played. Elements can be:\n\n- String - \"variant\" - play specific variant\n- Array\n  - [startingSentence(, endingSentence)] - play all sentences between specific start and end\n    - startingSentence and endingSentence can be in format:\n      - String - full sentence name (example: \"04_intro_team_PLA_0\")\n      - Array - [<actorID>(, <sentenceID>)] (example: [\"PLA\", 0] or just [\"PLA_0\"])\n      - Boolean - true to play random sentence, false to play first sentence\n      - default - first sentence for startingSentence, last sentence for endingSentence\n- default: play everything"},{"name":"radioMode","type":"Boolean, String, Object or Code","optional":true,"default":"false","description":"can be:\n\n- Boolean - true to force radio\n- String - name of radio channel (\"DIRECT\" or \"VEHICLE\")\n- Number - custom radio channel\n- Object - listener's channel\n- Code - returned value of code","type_expr":"Boolean | String | Object | Code","text":"radioMode: Boolean, String, Object or Code - (Optional, default: false) can be:\n\n- Boolean - true to force radio\n- String - name of radio channel (\"DIRECT\" or \"VEHICLE\")\n- Number - custom radio channel\n- Object - listener's channel\n- Code - returned value of code"},{"name":"code","type":"Code or Array","optional":true,"default":"`{ true }`","description":"can be:\n\n- Code - executed at the start of every sentence (arguments are same as in kbAddTopic event handler)\n- Array - code with arguments in format [code, arguments]","type_expr":"Code | Array","text":"code: Code or Array - (Optional, default `{ true }`) can be:\n\n- Code - executed at the start of every sentence (arguments are same as in kbAddTopic event handler)\n- Array - code with arguments in format [code, arguments]"},{"name":"speakers","type":"Array or Boolean","optional":true,"default":"`[]`","description":"can be:\n\n- Array - replacement units for those defined in .bikb file (in chronological order)\n- Boolean - when true, dummy logics will be created for all actor units which doesn't exist (default: false or value of 'BIS_fnc_kbTell_createDummy' variable)","type_expr":"Array | Boolean","text":"speakers: Array or Boolean - (Optional, default `[]`) can be:\n\n- Array - replacement units for those defined in .bikb file (in chronological order)\n- Boolean - when true, dummy logics will be created for all actor units which doesn't exist (default: false or value of 'BIS_fnc_kbTell_createDummy' variable)"},{"name":"soundVolume","type":"Number","optional":true,"default":"Take On Helicopters v1.00 0.2, Arma 3 v1.00 -1","description":"music and sound volumes lowering ratio during the conversation, range 0..1 (e.g 0 = no music, 0.25 = a quarter of the current volume, 1 or out of range = no change)","type_expr":"Number","text":"soundVolume: Number - (Optional, default Take On Helicopters v1.00 0.2, Arma 3 v1.00 -1) music and sound volumes lowering ratio during the conversation, range 0..1 (e.g 0 = no music, 0.25 = a quarter of the current volume, 1 or out of range = no change)"},{"name":"radioProtocol","type":"Boolean","optional":true,"default":"true","description":"true to disable radio protocol message while the conversation is playing","type_expr":"Boolean","text":"radioProtocol: Boolean - (Optional, default true) true to disable radio protocol message while the conversation is playing"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"01_Wave\", \"A_in\", nil, \"SIDE\", nil, nil, 1, false] spawn BIS_fnc_kbTell;"]}],"see_also":["Conversations","kbTell","BIS_fnc_kbCanSpeak","BIS_fnc_kbCreateDummy","BIS_fnc_kbIsSpeaking","BIS_fnc_kbMenu","BIS_fnc_kbPriority","BIS_fnc_kbSentence","BIS_fnc_kbSkip","BIS_fnc_kbTellLocal","BIS_fnc_kbTopicConfig"]},{"name":"BIS_fnc_kbTellLocal","title":"BIS fnc kbTellLocal","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_kbTellLocal","revid":376832,"updated":"2025-11-23T15:25:57Z","groups":["Conversations"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","locality":{"argument":"global","effect":"local"},"description":"Play given sentence, disable radio and/or lower sounds. Will use BIS_fnc_showSubtitle for better effects if channel is DIRECT or VEHICLE. The function calls \"BIS_fnc_kbTellLocal_played\" scripted Event Handler, if it returns [true], the radio item check in inventory will be overridden.\n\n> [!IMPORTANT]\n> This function is intended to be used by BIS_fnc_kbTell only.","syntaxes":[{"syntax":"[mode, parameters] call BIS_fnc_kbTellLocal","params":[{"name":"mode","type":"String","description":"can be either \"sentence\", \"conversationStart\" or \"conversationEnd\"","type_expr":"String"},{"name":"parameters","type":"Array","description":"depends on the mode:\n\n- \"sentence\": same parameters as kbTell (receiver, topicName etc.)\n\n- \"conversationStart\": [volumeCoef, disableRadio]\n  - volumeCoef: Number - a volume multiplier to reduce other sounds but the chat (0.1 = environment volume set to 10%)\n  - disableRadio: Boolean - should the radio chat be disabled\n\n- \"conversationEnd\": [volumeCoefUsedInStart, disableRadioUsedInStart]\n  - volumeCoefUsedInStart: Number - a volume multiplier, shouldn't be used - if < 0 or >= 1, the volume won't be restored\n  - disableRadioUsedInStart: Boolean - has the radio chat been disabled and should be restored","type_expr":"Array"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"sentence\", [player, [BIS_HQ, \"myTopic\", \"playerSentence1\"]]] call BIS_fnc_kbTellLocal;"]},{"code":["[\"conversationStart\", [0.5, true]] call BIS_fnc_kbTellLocal;"]},{"code":["[\"conversationEnd\", [0.5, true]] call BIS_fnc_kbTellLocal;"]}],"see_also":["Conversations","kbTell","BIS_fnc_kbCanSpeak","BIS_fnc_kbCreateDummy","BIS_fnc_kbIsSpeaking","BIS_fnc_kbMenu","BIS_fnc_kbPriority","BIS_fnc_kbSentence","BIS_fnc_kbSkip","BIS_fnc_kbTell","BIS_fnc_kbTopicConfig"]},{"name":"BIS_fnc_kbTopicConfig","title":"BIS fnc kbTopicConfig","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_kbTopicConfig","revid":364464,"updated":"2024-05-16T20:41:50Z","groups":["Conversations"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Reads the configs to return a matching `config >> CfgSentences >> missionName >> topic` entry.\n\n> [!NOTE]\n> Configs are checked in that order: configFile, campaignConfigFile, missionConfigFile.\n\n> [!IMPORTANT]\n> This function is intended to be used by BIS_fnc_kbTell only.","syntaxes":[{"syntax":"[missionName, topic] call BIS_fnc_kbTopicConfig","params":[{"name":"missionName","type":"String","type_expr":"String"},{"name":"topic","type":"String","type_expr":"String"}],"returns":{"type":"Config","type_expr":"Config","description":"the topic's config entry. nil on error or not found"}}],"examples":[{"code":["private _configTopic = [\"missionName\", \"topic\"] call BIS_fnc_kbTopicConfig;"]}],"see_also":["Conversations","BIS_fnc_kbTell"]},{"name":"BIS_fnc_key_compute","title":"BIS fnc key compute","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_compute","revid":279016,"updated":"2021-06-13T21:47:48Z","groups":["Key"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Computes data for a key","syntaxes":[{"syntax":"[] call BIS_fnc_key_compute","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key","text":"0: Object - The key","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nComputes data for a key\n\nParameter(s):\n_this select 0: Object - The key\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_key_computeOwnerCurve","title":"BIS fnc key computeOwnerCurve","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_computeOwnerCurve","revid":279004,"updated":"2021-06-13T21:47:40Z","groups":["Key"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Computes the curve that owns key","syntaxes":[{"syntax":"[] call BIS_fnc_key_computeOwnerCurve","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key","text":"0: Object - The key","source":"docblock"}],"returns":{"text":"Curve - The owner curve object","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nComputes the curve that owns key\n\nParameter(s):\n_this select 0: Object - The key\n\nReturns:\nCurve - The owner curve object","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_key_computeTime","title":"BIS fnc key computeTime","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_computeTime","revid":278995,"updated":"2021-06-13T21:47:32Z","groups":["Key"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Computes the time of given key","syntaxes":[{"syntax":"[] call BIS_fnc_key_computeTime","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key","text":"0: Object - The key","source":"docblock"}],"returns":{"type":"Number","type_expr":"Number","description":"The key time","text":"Float - The key time","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nComputes the time of given key\n\nParameter(s):\n_this select 0: Object - The key\n\nReturns:\nFloat - The key time","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_key_edenAreControlPointsLocked","title":"BIS fnc key edenAreControlPointsLocked","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_edenAreControlPointsLocked","revid":278983,"updated":"2021-06-13T21:47:21Z","groups":["Key3DEN"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Whether control points of given key are set to locked","syntaxes":[{"syntax":"[] call BIS_fnc_key_edenAreControlPointsLocked","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key object","text":"0: Object - The key object","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"True if control points are locked, false if not","text":"Bool - True if control points are locked, false if not","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nWhether control points of given key are set to locked\n\nParameter(s):\n_this select 0: Object - The key object\n\nReturns:\nBool - True if control points are locked, false if not","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_key_edenAttributesChanged","title":"BIS fnc key edenAttributesChanged","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_edenAttributesChanged","revid":279001,"updated":"2021-06-13T21:47:36Z","groups":["Key3DEN"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Attributes change in EDEN for a key","syntaxes":[{"syntax":"[] call BIS_fnc_key_edenAttributesChanged","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key","text":"0: Object    - The key","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nAttributes change in EDEN for a key\n\nParameter(s):\n_this select 0: Object    - The key\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_key_edenConnectionChanged","title":"BIS fnc key edenConnectionChanged","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_edenConnectionChanged","revid":279132,"updated":"2021-06-13T21:49:07Z","groups":["Key3DEN"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Attributes change in EDEN for a key","syntaxes":[{"syntax":"[] call BIS_fnc_key_edenConnectionChanged","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key","text":"0: Object    - The key","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nAttributes change in EDEN for a key\n\nParameter(s):\n_this select 0: Object    - The key\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_key_edenDragged","title":"BIS fnc key edenDragged","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_edenDragged","revid":279108,"updated":"2021-06-13T21:48:51Z","groups":["Key3DEN"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Entity is dragged in 3DEN","syntaxes":[{"syntax":"[] call BIS_fnc_key_edenDragged","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key","text":"0: Object    - The key","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nEntity is dragged in 3DEN\n\nParameter(s):\n_this select 0: Object    - The key\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_key_edenIsSelected","title":"BIS fnc key edenIsSelected","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_edenIsSelected","revid":278973,"updated":"2021-06-13T21:47:15Z","groups":["Key3DEN"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Whether given key is selected in 3den","syntaxes":[{"syntax":"[] call BIS_fnc_key_edenIsSelected","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key object","text":"0: Object    - The key object","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"True if selected, false if not","text":"Bool - True if selected, false if not","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nWhether given key is selected in 3den\n\nParameter(s):\n_this select 0: Object    - The key object\n\nReturns:\nBool - True if selected, false if not","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_key_edenRegisteredToWorld","title":"BIS fnc key edenRegisteredToWorld","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_edenRegisteredToWorld","revid":278920,"updated":"2021-06-13T21:46:38Z","groups":["Key3DEN"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Attributes change in EDEN for a key","syntaxes":[{"syntax":"[] call BIS_fnc_key_edenRegisteredToWorld","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key","text":"0: Object    - The key","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nAttributes change in EDEN for a key\n\nParameter(s):\n_this select 0: Object    - The key\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_key_edenUnregisteredFromWorld","title":"BIS fnc key edenUnregisteredFromWorld","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_edenUnregisteredFromWorld","revid":279141,"updated":"2021-06-13T21:49:15Z","groups":["Key3DEN"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Attributes change in EDEN for a key","syntaxes":[{"syntax":"[] call BIS_fnc_key_edenUnregisteredFromWorld","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key","text":"0: Object    - The key","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nAttributes change in EDEN for a key\n\nParameter(s):\n_this select 0: Object    - The key\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_key_getArriveControlPoint","title":"BIS fnc key getArriveControlPoint","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_getArriveControlPoint","revid":279103,"updated":"2021-06-13T21:48:48Z","groups":["Key"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Returns the arrive control point of a key","syntaxes":[{"syntax":"[] call BIS_fnc_key_getArriveControlPoint","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key","text":"0: Object - The key","source":"docblock"}],"returns":{"type":"Object","type_expr":"Object","description":"The control point","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nReturns the arrive control point of a key\n\nParameter(s):\n_this select 0: Object - The key\n\nReturns:\nObject - The control point","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_key_getArriveTangent","title":"BIS fnc key getArriveTangent","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_getArriveTangent","revid":279024,"updated":"2021-06-13T21:47:51Z","groups":["Key"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Returns the key arrive tangent","syntaxes":[{"syntax":"[] call BIS_fnc_key_getArriveTangent","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key","text":"0: Object - The key","source":"docblock"}],"returns":{"type":"Number","type_expr":"Number","description":"The key arrive tangent","text":"Float - The key arrive tangent","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nReturns the key arrive tangent\n\nParameter(s):\n_this select 0: Object - The key\n\nReturns:\nFloat - The key arrive tangent","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_key_getArriveTangentWeight","title":"BIS fnc key getArriveTangentWeight","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_getArriveTangentWeight","revid":279118,"updated":"2021-06-13T21:48:57Z","groups":["Key"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Returns the key arrive tangent weight","syntaxes":[{"syntax":"[] call BIS_fnc_key_getArriveTangentWeight","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key","text":"0: Object - The key","source":"docblock"}],"returns":{"type":"Number","type_expr":"Number","description":"The key arrive tangent weight","text":"Float - The key arrive tangent weight","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nReturns the key arrive tangent weight\n\nParameter(s):\n_this select 0: Object - The key\n\nReturns:\nFloat - The key arrive tangent weight","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_key_getConfigTime","title":"BIS fnc key getConfigTime","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_getConfigTime","revid":279105,"updated":"2021-06-13T21:48:49Z","groups":["Key"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Returns the time of given key","syntaxes":[{"syntax":"[] call BIS_fnc_key_getConfigTime","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key","text":"0: Object - The key","source":"docblock"}],"returns":{"type":"Number","type_expr":"Number","description":"The key time","text":"Float - The key time","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nReturns the time of given key\n\nParameter(s):\n_this select 0: Object - The key\n\nReturns:\nFloat - The key time","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_key_getFOV","title":"BIS fnc key getFOV","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_getFOV","revid":278929,"updated":"2021-06-13T21:46:44Z","groups":["Key"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Returns the FOV value of a key","syntaxes":[{"syntax":"[] call BIS_fnc_key_getFOV","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key","text":"0: Object - The key","source":"docblock"}],"returns":{"type":"Number","type_expr":"Number","description":"The fov value","text":"Float - The fov value","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nReturns the FOV value of a key\n\nParameter(s):\n_this select 0: Object - The key\n\nReturns:\nFloat - The fov value","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_key_getInterpMode","title":"BIS fnc key getInterpMode","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_getInterpMode","revid":279036,"updated":"2021-06-13T21:47:58Z","groups":["Key"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Returns the key interp mode index 0  - Linear 1  - Cubic 2  - EaseIn 3  - EaseOut 4  - EaseInOut 5  - Hermite 6  - Berp 7  - BounceIn 8  - BounceOut 9  - BounceInOut 10 - QuinticIn 11 - QuinticOut 12 - QuinticInOut 13 - ElasticIn 14 - ElasticOut 15 - ElasticInOut","syntaxes":[{"syntax":"[] call BIS_fnc_key_getInterpMode","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key","text":"0: Object - The key","source":"docblock"}],"returns":{"type":"Number","type_expr":"Number","description":"The mode as integer","text":"Integer - The mode as integer","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nReturns the key interp mode index\n 0  - Linear\n 1  - Cubic\n 2  - EaseIn\n 3  - EaseOut\n 4  - EaseInOut\n 5  - Hermite\n 6  - Berp\n 7  - BounceIn\n 8  - BounceOut\n 9  - BounceInOut\n 10 - QuinticIn\n 11 - QuinticOut\n 12 - QuinticInOut\n 13 - ElasticIn\n 14 - ElasticOut\n 15 - ElasticInOut\n\nParameter(s):\n_this select 0: Object - The key\n\nReturns:\nInteger - The mode as integer","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_key_getLeaveControlPoint","title":"BIS fnc key getLeaveControlPoint","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_getLeaveControlPoint","revid":279052,"updated":"2021-06-13T21:48:13Z","groups":["Key"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Returns the leave control point of key","syntaxes":[{"syntax":"[] call BIS_fnc_key_getLeaveControlPoint","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key","text":"0: Object - The key","source":"docblock"}],"returns":{"type":"Object","type_expr":"Object","description":"The control point","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nReturns the leave control point of key\n\nParameter(s):\n_this select 0: Object - The key\n\nReturns:\nObject - The control point","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_key_getLeaveTangent","title":"BIS fnc key getLeaveTangent","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_getLeaveTangent","revid":278944,"updated":"2021-06-13T21:46:55Z","groups":["Key"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Returns the key leave tangent","syntaxes":[{"syntax":"[] call BIS_fnc_key_getLeaveTangent","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key","text":"0: Object - The key","source":"docblock"}],"returns":{"type":"Number","type_expr":"Number","description":"The key leave tangent","text":"Float - The key leave tangent","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nReturns the key leave tangent\n\nParameter(s):\n_this select 0: Object - The key\n\nReturns:\nFloat - The key leave tangent","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_key_getLeaveTangentWeight","title":"BIS fnc key getLeaveTangentWeight","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_getLeaveTangentWeight","revid":278981,"updated":"2021-06-13T21:47:18Z","groups":["Key"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Returns the key leave tangent weight","syntaxes":[{"syntax":"[] call BIS_fnc_key_getLeaveTangentWeight","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key","text":"0: Object - The key","source":"docblock"}],"returns":{"type":"Number","type_expr":"Number","description":"The key leave tangent weight","text":"Float - The key leave tangent weight","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nReturns the key leave tangent weight\n\nParameter(s):\n_this select 0: Object - The key\n\nReturns:\nFloat - The key leave tangent weight","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_key_getOwnerCurve","title":"BIS fnc key getOwnerCurve","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_getOwnerCurve","revid":278977,"updated":"2021-06-13T21:47:16Z","groups":["Key"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Returns the curve that owns key","syntaxes":[{"syntax":"[] call BIS_fnc_key_getOwnerCurve","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key","text":"0: Object - The key","source":"docblock"}],"returns":{"text":"Curve - The owner curve object","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nReturns the curve that owns key\n\nParameter(s):\n_this select 0: Object - The key\n\nReturns:\nCurve - The owner curve object","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_key_getTime","title":"BIS fnc key getTime","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_getTime","revid":278949,"updated":"2021-06-13T21:46:58Z","groups":["Key"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Returns the time of given key","syntaxes":[{"syntax":"[] call BIS_fnc_key_getTime","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key","text":"0: Object - The key","source":"docblock"}],"returns":{"type":"Number","type_expr":"Number","description":"The key time","text":"Float - The key time","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nReturns the time of given key\n\nParameter(s):\n_this select 0: Object - The key\n\nReturns:\nFloat - The key time","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_key_getValue","title":"BIS fnc key getValue","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_getValue","revid":278937,"updated":"2021-06-13T21:46:48Z","groups":["Key"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Returns the value of given key","syntaxes":[{"syntax":"[] call BIS_fnc_key_getValue","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key","text":"0: Object - The key","source":"docblock"}],"returns":{"type":"Number","type_expr":"Number","description":"The key value","text":"Float - The key value","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nReturns the value of given key\n\nParameter(s):\n_this select 0: Object - The key\n\nReturns:\nFloat - The key value","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_key_isFloat","title":"BIS fnc key isFloat","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_isFloat","revid":279011,"updated":"2021-06-13T21:47:45Z","groups":["Key"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Returns true if this is a key with float value, false if not","syntaxes":[{"syntax":"[] call BIS_fnc_key_isFloat","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key","text":"0: Object - The key","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"True if key is of float data type, false if not","text":"Bool - True if key is of float data type, false if not","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nReturns true if this is a key with float value, false if not\n\nParameter(s):\n_this select 0: Object - The key\n\nReturns:\nBool - True if key is of float data type, false if not","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_key_isVector","title":"BIS fnc key isVector","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_isVector","revid":278938,"updated":"2021-06-13T21:46:48Z","groups":["Key"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Returns true if this is a key with vector value, false if not","syntaxes":[{"syntax":"[] call BIS_fnc_key_isVector","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key","text":"0: Object - The key","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"True if key is of vector data type, false if not","text":"Bool - True if key is of vector data type, false if not","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nReturns true if this is a key with vector value, false if not\n\nParameter(s):\n_this select 0: Object - The key\n\nReturns:\nBool - True if key is of vector data type, false if not","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_key_setArriveTangent","title":"BIS fnc key setArriveTangent","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_setArriveTangent","revid":279106,"updated":"2021-06-13T21:48:50Z","groups":["Key"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Set's the key arrive tangent","syntaxes":[{"syntax":"[] call BIS_fnc_key_setArriveTangent","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key","text":"0: Object     - The key","source":"docblock"},{"name":"param1","type":"Number","type_expr":"Number","description":"The new arrive tangent","text":"1: float    - The new arrive tangent","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nSet's the key arrive tangent\n\nParameter(s):\n_this select 0: Object     - The key\n_this select 1: float    - The new arrive tangent\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_key_setArriveTangentWeight","title":"BIS fnc key setArriveTangentWeight","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_setArriveTangentWeight","revid":278936,"updated":"2021-06-13T21:46:48Z","groups":["Key"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Set's the key arrive tangent weight","syntaxes":[{"syntax":"[] call BIS_fnc_key_setArriveTangentWeight","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key","text":"0: Object    - The key","source":"docblock"},{"name":"param1","type":"Number","type_expr":"Number","description":"The new arrive tangent weight","text":"1: Float    - The new arrive tangent weight","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nSet's the key arrive tangent weight\n\nParameter(s):\n_this select 0: Object    - The key\n_this select 1: Float    - The new arrive tangent weight\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_key_setInterpMode","title":"BIS fnc key setInterpMode","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_setInterpMode","revid":279100,"updated":"2021-06-13T21:48:44Z","groups":["Key"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Set's the interpolation mode of the key","syntaxes":[{"syntax":"[] call BIS_fnc_key_setInterpMode","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key","text":"0: Object    - The key","source":"docblock"},{"name":"param1","type":"Number","type_expr":"Number","description":"The new key interp mode","text":"1: Integer    - The new key interp mode","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nSet's the interpolation mode of the key\n\nParameter(s):\n_this select 0: Object    - The key\n_this select 1: Integer    - The new key interp mode\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_key_setLeaveTangent","title":"BIS fnc key setLeaveTangent","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_setLeaveTangent","revid":279019,"updated":"2021-06-13T21:47:49Z","groups":["Key"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Set's the key leave tangent","syntaxes":[{"syntax":"[] call BIS_fnc_key_setLeaveTangent","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key","text":"0: Object     - The key","source":"docblock"},{"name":"param1","type":"Number","type_expr":"Number","description":"The new leave tangent","text":"1: Float     - The new leave tangent","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nSet's the key leave tangent\n\nParameter(s):\n_this select 0: Object     - The key\n_this select 1: Float     - The new leave tangent\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_key_setLeaveTangentWeight","title":"BIS fnc key setLeaveTangentWeight","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_setLeaveTangentWeight","revid":278992,"updated":"2021-06-13T21:47:31Z","groups":["Key"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Set's the key leave tangent weight","syntaxes":[{"syntax":"[] call BIS_fnc_key_setLeaveTangentWeight","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key","text":"0: Object     - The key","source":"docblock"},{"name":"param1","type":"Number","type_expr":"Number","description":"The new leave tangent weight","text":"1: Float    - The new leave tangent weight","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nSet's the key leave tangent weight\n\nParameter(s):\n_this select 0: Object     - The key\n_this select 1: Float    - The new leave tangent weight\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_key_setTime","title":"BIS fnc key setTime","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_setTime","revid":279151,"updated":"2021-06-13T21:49:24Z","groups":["Key"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Set's the time of given key","syntaxes":[{"syntax":"[] call BIS_fnc_key_setTime","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key","text":"0: Object     - The key","source":"docblock"},{"name":"param1","type":"Number","type_expr":"Number","description":"The new time","text":"1: Float    - The new time","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nSet's the time of given key\n\nParameter(s):\n_this select 0: Object     - The key\n_this select 1: Float    - The new time\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_key_setValue","title":"BIS fnc key setValue","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_key_setValue","revid":279148,"updated":"2021-06-13T21:49:23Z","groups":["Key"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Set's the value of given key","syntaxes":[{"syntax":"[] call BIS_fnc_key_setValue","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The key","text":"0: Object    - The key","source":"docblock"},{"name":"param1","type":"Number","type_expr":"Number","description":"The new value","text":"1: Float    - The new value","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nSet's the value of given key\n\nParameter(s):\n_this select 0: Object    - The key\n_this select 1: Float    - The new value\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_keyCode","title":"BIS fnc keyCode","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_keyCode","revid":379500,"updated":"2026-10-31T00:27:02Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns DIK code of a given key.","syntaxes":[{"syntax":"input call BIS_fnc_keyCode","params":[{"name":"input","type":"Number, String or Boolean","description":"Number, String or Boolean\n\n- Number: Key code\n- String: Key name\n- Boolean: Return key definitions","type_expr":"Number | String | Boolean","text":"input: Number, String or Boolean\n\n- Number: Key code\n- String: Key name\n- Boolean: Return key definitions"}],"returns":{"type":"String, Number or Array","type_expr":"String | Number | Array"}}],"examples":[{"code":["13 call BIS_fnc_keyCode; // Returns \"EQUALS\""]},{"code":["\"EQUALS\" call BIS_fnc_keyCode; // returns 13"]},{"code":["true call BIS_fnc_keyCode; // returns [\"ESCAPE\",1,\"1\",2,\"2\",3,\"3\",4,\"4\",5,\"5\",6,\"6\",7,\"7\",8,\"8\",9,\"9\",10,\"0\",11,\"MINUS\",12,\"EQUALS\",13...]"]}],"see_also":["DIK KeyCodes"]},{"name":"BIS_fnc_keyframeAnimation_deltaTime","title":"BIS fnc keyframeAnimation deltaTime","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_keyframeAnimation_deltaTime","revid":273908,"updated":"2021-06-13T01:13:10Z","groups":["KeyframeAnimation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_keyframeAnimation_deltaTime","params":[],"returns":null}]},{"name":"BIS_fnc_keyframeAnimation_init","title":"BIS fnc keyframeAnimation init","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_keyframeAnimation_init","revid":273962,"updated":"2021-06-13T01:14:12Z","groups":["KeyframeAnimation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_keyframeAnimation_init","params":[],"returns":null}]},{"name":"BIS_fnc_keyHold","title":"BIS fnc keyHold","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_keyHold","revid":341362,"updated":"2023-05-24T12:59:06Z","groups":["Interaction"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"effect":"local"},"exec":"spawn","description":"Allows for hold button interactions. Hold action is started by pressing <kbd>Space</kbd>.","syntaxes":[{"syntax":"[description, duration, condition, arguments, loaded] spawn BIS_fnc_keyHold","params":[{"name":"description","type":"String","description":"description of the performed action, displayed inside the progress bar.","type_expr":"String"},{"name":"duration","type":"Number","optional":true,"default":"2","description":"action duration","type_expr":"Number","text":"duration: Number - (Optional, default 2) action duration"},{"name":"condition","type":"Code or String","optional":true,"default":"`{ true }`","description":"condition that must be met for the action to display","type_expr":"Code | String","text":"condition: Code or String - (Optional, default `{ true }`) condition that must be met for the action to display"},{"name":"arguments","type":"Array","optional":true,"default":"`[]`","description":"arguments passed to the condition","type_expr":"Array","text":"arguments: Array - (Optional, default `[]`) arguments passed to the condition"},{"name":"loaded","type":"Boolean","optional":true,"default":"false","description":"defines if function is already loaded. This is handled by the function","type_expr":"Boolean","text":"loaded: Boolean - (Optional, default false) defines if function is already loaded. This is handled by the function"}],"returns":{"types":["Script Handle"],"description":"- spawn: Script Handle - call: true if action was successful or false if it was interrupted.","text":"- spawn: Script Handle\n- call: true if action was successful or false if it was interrupted."}}],"examples":[{"code":["[\"Hold that key!\", 2, { alive player }] spawn BIS_fnc_keyHold;"]},{"text":"Function can be called in scheduled environment to return values and be used for further code execution.\n\n```sqf\n0 spawn {\n    private _success = [\"Hold that key!\", 2, { alive player }] call BIS_fnc_keyHold;\n    if (_success) then { hint \"Function executed\" } else { hint \"Function interrupted\" };\n};\n```","code":["0 spawn {\n\tprivate _success = [\"Hold that key!\", 2, { alive player }] call BIS_fnc_keyHold;\n\tif (_success) then { hint \"Function executed\" } else { hint \"Function interrupted\" };\n};"]}],"see_also":["BIS_fnc_holdActionAdd","BIS_fnc_holdKey"]},{"name":"BIS_fnc_keypointsExport","title":"BIS fnc keypointsExport","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_keypointsExport","revid":309875,"updated":"2022-05-05T12:09:53Z","groups":["Map and Markers"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_keypointsExportFromKML","title":"BIS fnc keypointsExportFromKML","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_keypointsExportFromKML","revid":309812,"updated":"2022-05-05T12:09:51Z","groups":["Map and Markers"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Imports and marks positions from KLM file.","syntaxes":[{"syntax":"_this call BIS_fnc_keypointsExportFromKML","params":[{"name":"_this","type":"String","type_expr":"String","description":"path to .kml file","text":"STRING - path to .kml file","source":"docblock"}],"returns":{"type":"String","type_expr":"String","description":"config output (also copied to clipboard)","text":"STRING - config output (also copied to clipboard)","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nImports and marks positions from KLM file.\n\nParameter(s):\n_this: STRING - path to .kml file\n\nReturns:\nSTRING - config output (also copied to clipboard)"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_KMLimport","title":"BIS fnc KMLimport","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_KMLimport","revid":352171,"updated":"2024-02-01T23:25:37Z","groups":["Map and Markers"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Read positions from a [KML file](https://en.wikipedia.org/wiki/Keyhole_Markup_Language).\n\n> [!NOTE]\n> Recommended to execute in loading screen.","syntaxes":[{"syntax":"filePath call BIS_fnc_KMLimport","params":[{"name":"filePath","type":"String","optional":true,"default":"`\"hsim\\Doc_H\\GoogleEarth\\Missions\\\" + missionName + \".kml\"`","description":"KML file path\n\n> [!NOTE]\n> **Arma 3:** Default value only works in Take On Helicopters. Do not rely on it in Arma 3.","type_expr":"String","text":"filePath: String - (Optional, default `\"hsim\\Doc_H\\GoogleEarth\\Missions\\\" + missionName + \".kml\"`) KML file path\n\n> [!NOTE]\n> **Arma 3:** Default value only works in Take On Helicopters. Do not rely on it in Arma 3."}],"returns":{"type":"Array of Arrays","type_expr":"Array<Array>","description":"in format [type, positionXYZ, folder, name, description]\n- type: Number - 0 for a point, 1 for a line, 2 for a polygon - positionXYZ: Position - format PositionAGL - folder: String - path to the value, \"\" if in the .kml root - name: String - location's name - description: String - location's description","text":"Array of Arrays in format [type, positionXYZ, folder, name, description]\n\n- type: Number - 0 for a point, 1 for a line, 2 for a polygon\n- positionXYZ: Position - format PositionAGL\n- folder: String - path to the value, \"\" if in the .kml root\n- name: String - location's name\n- description: String - location's description"}}],"examples":[{"code":["private _data = \"subDir\\myFile.kml\" call BIS_fnc_KMLimport;"]}],"see_also":["BIS_fnc_keypointsExportFromKML","BIS_fnc_dbImportXML","BIS_fnc_posDegToWorld"]},{"name":"BIS_fnc_laptopInit","title":"BIS fnc laptopInit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_laptopInit","revid":364479,"updated":"2024-05-16T20:41:56Z","groups":["Scripts"],"status":"ok","games":{"arma3":"1.72"},"since":"arma3 1.72","arma3_since":"1.72","locality":{"argument":"global","effect":"local"},"description":"Adds an Easter egg to the laptop, that is active only if the mission date is set to **2001-06-22**.\n\n> [!NOTE]\n> Best used with the Old Laptop.","syntaxes":[{"syntax":"laptop call BIS_fnc_laptopInit","params":[{"name":"laptop","type":"Object","type_expr":"Object"}],"returns":{"type":"Nothing or Number","type_expr":"Nothing | Number","description":"(action ID)","text":"Nothing or Number (action ID)"}}],"examples":[{"code":["private _actionId = _myLaptop call BIS_fnc_laptopInit;"]}],"see_also":["BIS_fnc_laptopPlayVideo"],"notes":[{"user":"Poslovitch","date":"2020-04-22T19:29:00Z","text":"On **Arma 3 1.98.146303**:\n\n- As specified in the description, if the mission's date is not set to 2001-06-22, this function won't have any effects.\n- If the mission's date is set to 2001-06-22, there is no need to call this function on Old Laptops. The hold action is already applied to them on mission start.\n- This function does not have any effects on (open variants of) modern laptops (Land_Laptop_unfolded_F, Land_Laptop_device_F, Land_Laptop_Intel_01_F, Land_Laptop_Intel_02_F, Land_Laptop_Intel_03_F), except for Rugged laptops (Land_Laptop_03_sand_F, Land_Laptop_03_black_F, Land_Laptop_03_olive_F): the hold action is available and, when completed, causes the laptops to become graphically glitched and to use the Easter Egg video as their textures."}],"categories_extra":["Easter Eggs"]},{"name":"BIS_fnc_laptopPlayVideo","title":"BIS fnc laptopPlayVideo","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_laptopPlayVideo","revid":310729,"updated":"2022-05-07T20:01:16Z","groups":["Scripts"],"status":"ok","games":{"arma3":"1.72"},"since":"arma3 1.72","arma3_since":"1.72","locality":{"argument":"global"},"description":"Plays an easter egg video on the screen of an old laptop.","syntaxes":[{"syntax":"laptop call BIS_fnc_laptopPlayVideo","params":[{"name":"laptop","type":"Object","description":"the old laptop to play the video on","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["this call BIS_fnc_laptopPlayVideo;"]}],"see_also":["BIS_fnc_laptopInit"]},{"name":"BIS_fnc_lerp","title":"BIS fnc lerp","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_lerp","revid":378113,"updated":"2026-02-17T13:29:28Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Linear floating point interpolation (see [Linear Interpolation](https://en.wikipedia.org/wiki/Linear_interpolation)).","syntaxes":[{"syntax":"[currentValue, targetValue, alpha] call BIS_fnc_lerp","params":[{"name":"currentValue","type":"Number","description":"first point (start)","type_expr":"Number"},{"name":"targetValue","type":"Number","description":"second point (end)","type_expr":"Number"},{"name":"alpha","type":"Number","description":"interpolation speed","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number","description":"interpolated value"}}],"examples":[{"code":["[1, 10, 0.5] call BIS_fnc_lerp; // returns 5.5"]}]},{"name":"BIS_fnc_lerpVector","title":"BIS fnc lerpVector","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_lerpVector","revid":348754,"updated":"2023-11-08T14:33:09Z","groups":["Vectors"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Given two different vectors A and B, think of a straight line drawn between them, *alpha* saying how far along that line is the wanted vector.","syntaxes":[{"syntax":"[currentValue, targetValue, alpha] call BIS_fnc_lerpVector","params":[{"name":"currentValue","type":"Array","description":"vector start","type_expr":"Array"},{"name":"targetValue","type":"Array","description":"vector end","type_expr":"Array"},{"name":"alpha","type":"Number","description":"alpha","type_expr":"Number"}],"returns":{"type":"Array","type_expr":"Array","description":"interpolated vector"}}],"examples":[{"code":["[[1592.74,6558.36,0], [2240.43,7459.69,0], 0.3] call BIS_fnc_lerpVector; // returns [1787.05,6828.76,0]"]}],"see_also":["BIS_fnc_clerp","BIS_fnc_slerp","BIS_fnc_lerp","BIS_fnc_inverseLerp"]},{"name":"BIS_fnc_limitAmmunition","title":"BIS fnc limitAmmunition","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_limitAmmunition","revid":349399,"updated":"2023-11-08T16:27:25Z","groups":["Inventory"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Limits the number of magazines carried by individual unit. Each container (uniform, vest and backpack) can be limited separately or left untouched.\nThe function limits the number of magazines of each unique ammo category in respective container. Items like First Aid Kit or Mine Detector are not affected by the function\n\nSet the minimum and maximum values in an array, for example [0.5,1] will set the magazine count anywhere between 50-100% of default count.","syntaxes":[{"syntax":"[unit,uniformMags,vestMags,BackpackMags] call BIS_fnc_limitAmmunition","params":[{"name":"unit","type":"Object","type_expr":"Object"},{"name":"uniformMags","type":"Array","optional":true,"default":"[0.4,0.8]","description":"amount of magazines in uniform. Array in form:\n\n- 0:minMags - Minimum amount of magazines in percent (%)\n- 1:maxMags - Maximum amount of magazines in percent (%)","type_expr":"Array","text":"uniformMags: Array - (Optional, default [0.4,0.8]) amount of magazines in uniform. Array in form:\n\n- 0:minMags - Minimum amount of magazines in percent (%)\n- 1:maxMags - Maximum amount of magazines in percent (%)"},{"name":"vestMags","type":"Array","optional":true,"default":"[0.4,0.8]","description":"amount of magazines in vest. Array in form:\n\n- 0:minMags - Minimum amount of magazines in percent (%)\n- 1:maxMags - Maximum amount of magazines in percent (%)","type_expr":"Array","text":"vestMags: Array - (Optional, default [0.4,0.8]) amount of magazines in vest. Array in form:\n\n- 0:minMags - Minimum amount of magazines in percent (%)\n- 1:maxMags - Maximum amount of magazines in percent (%)"},{"name":"backpackMags","type":"Array","optional":true,"default":"[0.4,0.8]","description":"amount of magazines in backpack. Array in form:\n\n- 0:minMags - Minimum amount of magazines in percent (%)\n- 1:maxMags - Maximum amount of magazines in percent (%)","type_expr":"Array","text":"backpackMags: Array - (Optional, default [0.4,0.8]) amount of magazines in backpack. Array in form:\n\n- 0:minMags - Minimum amount of magazines in percent (%)\n- 1:maxMags - Maximum amount of magazines in percent (%)"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["player call BIS_fnc_limitAmmunition;"]},{"code":["[player,[],[0.5,0.5],[0,1]] call BIS_fnc_limitAmmunition;"]}],"see_also":["BIS_fnc_limitWeaponItems","BIS_fnc_limitItems"]},{"name":"BIS_fnc_limitItems","title":"BIS fnc limitItems","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_limitItems","revid":347985,"updated":"2023-11-08T10:05:06Z","groups":["Inventory"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Keeps or removes unit's items (including NVGs and binocular/designator) based on probability user sets.","syntaxes":[{"syntax":"[unit, chanceNVG, chanceBino, chanceGPS, chanceMap, chanceRadio, chanceCompass, chanceWatch] call BIS_fnc_limitItems","params":[{"name":"unit","type":"Object","type_expr":"Object"},{"name":"chanceNVG","type":"Number","optional":true,"default":"50","description":"chance to keep NVGs in % (range 0..100)\n\n- 0 = NVGs are always removed\n- 100 = NVGs are always kept","type_expr":"Number","text":"chanceNVG: Number - (Optional, default 50) chance to keep NVGs in % (range 0..100)\n\n- 0 = NVGs are always removed\n- 100 = NVGs are always kept"},{"name":"chanceBino","type":"Number","optional":true,"default":"50","description":"chance to keep binoculars in %","type_expr":"Number","text":"chanceBino: Number - (Optional, default 50) chance to keep binoculars in %"},{"name":"chanceGPS","type":"Number","optional":true,"default":"50","description":"chance to keep GPS in %","type_expr":"Number","text":"chanceGPS: Number - (Optional, default 50) chance to keep GPS in %"},{"name":"chanceMap","type":"Number","optional":true,"default":"50","description":"chance to keep Map in %","type_expr":"Number","text":"chanceMap: Number - (Optional, default 50) chance to keep Map in %"},{"name":"chanceRadio","type":"Number","optional":true,"default":"50","description":"chance to keep radio in %","type_expr":"Number","text":"chanceRadio: Number - (Optional, default 50) chance to keep radio in %"},{"name":"chanceCompass","type":"Number","optional":true,"default":"50","description":"chance to keep compass in %","type_expr":"Number","text":"chanceCompass: Number - (Optional, default 50) chance to keep compass in %"},{"name":"chanceWatch","type":"Number","optional":true,"default":"50","description":"chance to keep watch in %","type_expr":"Number","text":"chanceWatch: Number - (Optional, default 50) chance to keep watch in %"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"always true"}}],"examples":[{"code":["player call BIS_fnc_limitItems;"]},{"code":["[player, 0, 15, 30, 45, 60, 75, 90] call BIS_fnc_limitItems;"]}],"see_also":["BIS_fnc_limitWeaponItems","BIS_fnc_limitAmmunition"]},{"name":"BIS_fnc_limitSupport","title":"BIS fnc limitSupport","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_limitSupport","revid":310412,"updated":"2022-05-05T18:03:14Z","groups":["Supports"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Limits support runs during a mission.","syntaxes":[{"syntax":"[module, supportType, quantity] call BIS_fnc_limitSupport","params":[{"name":"module","type":"Object","description":"the requester module","type_expr":"Object"},{"name":"supportType","type":"String","description":"can be one of:\n\n- \"Artillery\"\n- \"Transport\"\n- \"CAS_Heli\"\n- \"CAS_Bombing\"\n- \"Drop\"","type_expr":"String"},{"name":"quantity","type":"Number","description":"support run limit. -1 for unlimited support","type_expr":"Number"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when done"}}],"examples":[{"code":["[reqModule, \"Transport\", -1] call BIS_fnc_limitSupport;"]}],"see_also":["BIS_fnc_addSupportLink"]},{"name":"BIS_fnc_limitWeaponItems","title":"BIS fnc limitWeaponItems","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_limitWeaponItems","revid":348030,"updated":"2023-11-08T11:26:29Z","groups":["Inventory"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Keeps or remove unit's weapon attachments based on probability user sets. Apply for primary, secondary or handgun weapon separately.","syntaxes":[{"syntax":"[unit, mode, chanceOptics, chanceAttach, chanceMuzzle, chanceUnderbarrel] call BIS_fnc_limitWeaponItems","params":[{"name":"unit","type":"Object","description":"target unit","type_expr":"Object"},{"name":"mode","type":"Number","optional":true,"default":"0","description":"can be:\n\n- 1 = primary weapon\n- 2 = secondary weapon\n- 3 = handgun","type_expr":"Number","text":"mode: Number - (Optional, default 0) can be:\n\n- 1 = primary weapon\n- 2 = secondary weapon\n- 3 = handgun"},{"name":"chanceOptics","type":"Number or Array in format [\"itemClass\", chance]","optional":true,"default":"50","description":"chance to keep optics from 0 to 100%\n\n- if [\"itemClassname\", number] is used, the function will add that attachment if it passes the check. If not, the current attachment will be removed.","type_expr":"Number | Array","text":"chanceOptics: Number or Array in format [\"itemClass\", chance] - (Optional, default 50) chance to keep optics from 0 to 100%\n\n- if [\"itemClassname\", number] is used, the function will add that attachment if it passes the check. If not, the current attachment will be removed."},{"name":"chanceAttach","type":"Number or Array in format [\"itemClass\", chance]","optional":true,"default":"50","description":"chance to keep side attachments from 0 to 100%","type_expr":"Number | Array","text":"chanceAttach: Number or Array in format [\"itemClass\", chance] - (Optional, default 50) chance to keep side attachments from 0 to 100%"},{"name":"chanceMuzzle","type":"Number or Array in format [\"itemClass\", chance]","optional":true,"default":"50","description":"chance to keep muzzle attachment from 0 to 100%","type_expr":"Number | Array","text":"chanceMuzzle: Number or Array in format [\"itemClass\", chance] - (Optional, default 50) chance to keep muzzle attachment from 0 to 100%"},{"name":"chanceUnderbarrel","type":"Number or Array in format [\"itemClass\",chance]","optional":true,"default":"50","description":"chance to keep underbarrel attachment from 0 to 100%","type_expr":"Number | Array","text":"chanceUnderbarrel: Number or Array in format [\"itemClass\",chance] - (Optional, default 50) chance to keep underbarrel attachment from 0 to 100%"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["player call BIS_fnc_limitWeaponItems;"]},{"code":["[[player, 0, 25, 50, 75, 100]]  call BIS_fnc_limitWeaponItems;"]},{"code":["[[player, 0, [\"optic_lrps\", 100], [\"acc_pointer_ir\", 100], [\"muzzle_snds_B\", 100], [\"bipod_01_F_blk\", 100]]] call BIS_fnc_limitWeaponItems;"]}],"see_also":["BIS_fnc_limitAmmunition","BIS_fnc_limitItems"]},{"name":"BIS_fnc_linearConversion","title":"BIS fnc linearConversion","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_linearConversion","revid":341218,"updated":"2023-05-13T23:07:03Z","groups":["Math"],"status":"deprecated","replaced_by":["linearConversion"],"games":{"arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2oa 1.50","arma3_since":"0.50","description":"Linear conversion of a value from one set to another\n\n> [!NOTE]\n> This function became obsolete with the introduction of linearConversion.","syntaxes":[{"syntax":"[[minFrom, maxFrom], value, [minTo, maxTo]] call BIS_fnc_linearConversion","params":[{"name":"minFrom","type":"Number","type_expr":"Number"},{"name":"maxFrom","type":"Number","type_expr":"Number"},{"name":"value","type":"Number","type_expr":"Number"},{"name":"minTo","type":"Number","type_expr":"Number"},{"name":"maxTo","type":"Number","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number","description":"value adapted to [minTo, maxTo] range","text":"Number *value* adapted to [*minTo*, *maxTo*] range"}}],"examples":[{"code":["[[-50, 50], -50, [0, 1]] call BIS_fnc_linearConversion; // returns 0\n[[-50, 50],   0, [0, 1]] call BIS_fnc_linearConversion; // returns 0.5\n[[-50, 50], +50, [0, 1]] call BIS_fnc_linearConversion; // returns 1"]}],"see_also":["linearConversion"]},{"name":"BIS_fnc_listCuratorPlayers","title":"BIS fnc listCuratorPlayers","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_listCuratorPlayers","revid":309318,"updated":"2022-05-05T12:04:27Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Returns list of playable units with access to curator.","syntaxes":[{"syntax":"[] call BIS_fnc_listCuratorPlayers","params":[],"returns":{"type":"Array","type_expr":"Array","description":"list of players"}}],"examples":[{"code":["call BIS_fnc_listCuratorPlayers;"]}],"see_also":["Arma 3: Curator"]},{"name":"BIS_fnc_listPlayers","title":"BIS fnc listPlayers","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_listPlayers","revid":327566,"updated":"2022-07-12T22:39:16Z","groups":["Multiplayer"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Returns a list of *currently played* units, alive or dead.","syntaxes":[{"syntax":"call BIS_fnc_listPlayers","params":[],"returns":{"type":"Array of Objects","type_expr":"Array<Object>"}}],"examples":[{"code":["private _allPlayers = call BIS_fnc_listPlayers;"]}],"see_also":["isPlayer","playableUnits"]},{"name":"BIS_fnc_liveFeed","title":"BIS fnc liveFeed","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_liveFeed","revid":328590,"updated":"2022-07-13T17:02:28Z","groups":["Live Feed"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Display a live feed.","syntaxes":[{"syntax":"[source, target, receiver, effect] call BIS_fnc_liveFeed","params":[{"name":"source","type":"Object or Position","description":"live feed source","type_expr":"Object | Position"},{"name":"target","type":"Object or Position","description":"live feed target","type_expr":"Object | Position"},{"name":"receiver","type":"Object","description":"player that will see the feed - if not local, function will do nothing","type_expr":"Object"},{"name":"effect","type":"Number","optional":true,"default":"0","description":"live feed effect. Can be one of:\n\n- -1: reset\n-  0: normal\n-  1: night vision\n-  2: thermal imaging","type_expr":"Number","text":"effect: Number - (Optional, default 0) live feed effect. Can be one of:\n\n- -1: reset\n-  0: normal\n-  1: night vision\n-  2: thermal imaging"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if successful, false if not"}}],"examples":[{"code":["[myUAV, player, player, 2] call BIS_fnc_liveFeed;"]},{"text":"live feed display:\n\n```sqf\nprivate _UAVFeedDisplay = uiNamespace getVariable \"BIS_fnc_PIP_RscPIP\";\n```","code":["private _UAVFeedDisplay = uiNamespace getVariable \"BIS_fnc_PIP_RscPIP\";"]}],"see_also":["BIS_fnc_liveFeedEffects","BIS_fnc_liveFeedSetSource","BIS_fnc_liveFeedSetTarget","BIS_fnc_liveFeedTerminate"]},{"name":"BIS_fnc_liveFeedEffects","title":"BIS fnc liveFeedEffects","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_liveFeedEffects","revid":348076,"updated":"2023-11-08T11:30:43Z","groups":["Live Feed"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Add effect to the current live feed.","syntaxes":[{"syntax":"effect call BIS_fnc_liveFeedEffects","params":[{"name":"effect","type":"Number","optional":true,"default":"0","description":"live feed effect. Can be one of:\n\n- -1: reset\n-  0: normal\n-  1: night vision\n-  2: thermal imaging","type_expr":"Number","text":"effect: Number - (Optional, default 0) live feed effect. Can be one of:\n\n- -1: reset\n-  0: normal\n-  1: night vision\n-  2: thermal imaging"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if successful, false if not"}}],"examples":[{"code":["1 call BIS_fnc_liveFeedEffects;"]}],"see_also":["BIS_fnc_liveFeed","BIS_fnc_liveFeedSetSource","BIS_fnc_liveFeedSetTarget","BIS_fnc_liveFeedTerminate"]},{"name":"BIS_fnc_liveFeedModuleEffects","title":"BIS fnc liveFeedModuleEffects","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_liveFeedModuleEffects","revid":309715,"updated":"2022-05-05T12:09:47Z","groups":["Modules - Live Feed"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"```\n/*\n\n    Description:\n    Add effects to a live feed via a module.\n\n    Parameters:\n        _this: OBJECT - Live Feed - Effects module\n*/\n\n// They ran me on a dedicated server. I stopped their function.\n```","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_liveFeedModuleInit","title":"BIS fnc liveFeedModuleInit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_liveFeedModuleInit","revid":377954,"updated":"2026-01-15T11:21:41Z","groups":["Modules - Live Feed"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Display a live feed via a module.","syntaxes":[{"syntax":"_this call BIS_fnc_liveFeedModuleInit","params":[{"name":"_this","type":"Object","type_expr":"Object","description":"Live Feed - Init module","text":"OBJECT - Live Feed - Init module","source":"docblock"}],"returns":null,"inferred":true}],"docblock":{"text":"Description:\nDisplay a live feed via a module.\n\nParameters:\n    _this: OBJECT - Live Feed - Init module"},"filled_from_docblock":["description","params","syntax"]},{"name":"BIS_fnc_liveFeedModuleSetSource","title":"BIS fnc liveFeedModuleSetSource","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_liveFeedModuleSetSource","revid":378061,"updated":"2026-02-04T23:54:59Z","groups":["Modules - Live Feed"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Set a live feed's source via a module.","syntaxes":[{"syntax":"_this call BIS_fnc_liveFeedModuleSetSource","params":[{"name":"_this","type":"Object","type_expr":"Object","description":"Live Feed - Set Source module","text":"OBJECT - Live Feed - Set Source module","source":"docblock"}],"returns":null,"inferred":true}],"docblock":{"text":"Description:\nSet a live feed's source via a module.\n\nParameters:\n    _this: OBJECT - Live Feed - Set Source module"},"filled_from_docblock":["description","params","syntax"]},{"name":"BIS_fnc_liveFeedModuleSetTarget","title":"BIS fnc liveFeedModuleSetTarget","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_liveFeedModuleSetTarget","revid":309708,"updated":"2022-05-05T12:09:46Z","groups":["Modules - Live Feed"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"```\n/*\n\n    Description:\n    Set a live feed's target via a module.\n\n    Parameters:\n        _this: OBJECT - Live Feed - Set Target module\n*/\n\n// On dedicated servers, player is not you\n```","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_liveFeedSetSource","title":"BIS fnc liveFeedSetSource","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_liveFeedSetSource","revid":379274,"updated":"2026-10-30T23:44:43Z","groups":["Live Feed"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Set the source of the current live feed.","syntaxes":[{"syntax":"source call BIS_fnc_liveFeedSetSource","params":[{"name":"source","type":"Object, Position or Array","description":"Object, Position or Array\n\n- Object\n- Position\n- Array: in the format [object, [x, y, z]]","type_expr":"Object | Position | Array","text":"source: Object, Position or Array\n\n- Object\n- Position\n- Array: in the format [object, [x, y, z]]"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if successful, false if not"}}],"examples":[{"code":["[player, [0, 0.25, 1.6]] call BIS_fnc_liveFeedSetSource;"]}],"see_also":["BIS_fnc_liveFeed","BIS_fnc_liveFeedEffects","BIS_fnc_liveFeedSetTarget","BIS_fnc_liveFeedTerminate"]},{"name":"BIS_fnc_liveFeedSetTarget","title":"BIS fnc liveFeedSetTarget","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_liveFeedSetTarget","revid":324234,"updated":"2022-07-01T12:00:39Z","groups":["Live Feed"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Set the target of the current live feed.","syntaxes":[{"syntax":"target call BIS_fnc_liveFeedSetTarget","params":[{"name":"target","type":"Object or Position","type_expr":"Object | Position"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if successful, false if not."}}],"examples":[{"code":["player call BIS_fnc_liveFeedSetTarget;"]}],"see_also":["BIS_fnc_liveFeed","BIS_fnc_liveFeedEffects","BIS_fnc_liveFeedSetSource","BIS_fnc_liveFeedTerminate"]},{"name":"BIS_fnc_liveFeedTerminate","title":"BIS fnc liveFeedTerminate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_liveFeedTerminate","revid":324318,"updated":"2022-07-01T12:00:44Z","groups":["Live Feed"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Terminate a live feed.","syntaxes":[{"syntax":"call BIS_fnc_liveFeedTerminate","params":[],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if successful, false if not"}}],"examples":[{"code":["call BIS_fnc_liveFeedTerminate;"]}],"see_also":["BIS_fnc_liveFeed","BIS_fnc_liveFeedEffects","BIS_fnc_liveFeedSetSource","BIS_fnc_liveFeedSetTarget"]},{"name":"BIS_fnc_loadClass","title":"BIS fnc loadClass","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_loadClass","revid":349412,"updated":"2023-11-08T16:27:27Z","groups":["Configs"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Searches for class in mission, campaign and then in global config file.","syntaxes":[{"syntax":"[input, defaultValue] call BIS_fnc_loadClass","params":[{"name":"input","type":"Array of Strings","description":"containing config paths","type_expr":"Array<String>","text":"**input**: Array of Strings - containing config paths"},{"name":"defaultValue","type":"Config","description":"default config used if **input** cannot be found","type_expr":"Config","text":"**defaultValue**: Config - default config used if **input** cannot be found"}],"returns":{"type":"Config","type_expr":"Config"}}],"examples":[{"code":["[[\"bin\\config.bin\"], configFile >> \"Cfg3DEN\" >> \"Camera\"] call BIS_fnc_loadClass"]}],"see_also":["configFile"]},{"name":"BIS_fnc_loadEntry","title":"BIS fnc loadEntry","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_loadEntry","revid":349424,"updated":"2023-11-08T16:27:33Z","groups":["Configs"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Searches for config entry in mission, campaign and then in global config file.","syntaxes":[{"syntax":"[path,defaultConfig] call BIS_fnc_loadEntry","params":[{"name":"path","type":"Array of Strings","description":"path","type_expr":"Array<String>"},{"name":"defaultConfig","type":"Config","description":"default path used in case when the original one is not found","type_expr":"Config"}],"returns":{"type":"Array, Number or String","type_expr":"Array | Number | String"}}],"examples":[{"code":["[[\"CfgWeapons\",\"hgun_Rook40_snds_F\",\"bullet3\"], configfile >> \"CfgWeapons\" >> \"hgun_Rook40_snds_F\" >> \"baseWeapon\"] call BIS_fnc_loadEntry;"]}],"see_also":["BIS_fnc_loadClass","configFile"]},{"name":"BIS_fnc_loadFunctions","title":"BIS fnc loadFunctions","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_loadFunctions","revid":352078,"updated":"2024-02-01T23:24:43Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Compile scripts and save them into globally available functions. Defines _fnc_scriptName variable.","syntaxes":[{"syntax":"[fileDirectory, prefix, nameVars, global] call BIS_fnc_loadFunctions","params":[{"name":"fileDirectory","type":"String","description":"script path","type_expr":"String"},{"name":"prefix","type":"String","description":"variable prefix\n\n> [!NOTE]\n> `\"BIS_fnc_\"` prefix is reserved and cannot be used.","type_expr":"String"},{"name":"nameVars","type":"Array of Strings or Array of Array","description":"list of variables to be declared.\n\n- Array of Strings to format [variable, variable, …] - final variable is `prefix + variable`, loaded from `path + variable + \".sqf\"`\n- Array of Array to format [[variable, fileName], [variable, fileName], …] - final variable is `prefix + variable`, loaded from `path + fileName + \".sqf\"`","type_expr":"Array<String> | Array<Array>","text":"nameVars: Array of Strings **or** Array of Array - list of variables to be declared.\n\n- Array of Strings to format [variable, variable, …] - final variable is `prefix + variable`, loaded from `path + variable + \".sqf\"`\n- Array of Array to format [[variable, fileName], [variable, fileName], …] - final variable is `prefix + variable`, loaded from `path + fileName + \".sqf\"`"},{"name":"global","type":"Boolean","description":"true for global persistent execution on all clients","type_expr":"Boolean"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when done"}}],"examples":[{"code":["[\"scripts\\myDir\\\", \"MY_fnc_\", [\"script1\", \"script2\"], true] call BIS_fnc_loadFunctions;"]},{"code":["[\"scripts\\myDir\\\", \"MY_fnc_\", [[\"script1\", \"script1file\"], [\"script2\", \"script2file\"]], false] call BIS_fnc_loadFunctions;"]}],"see_also":["compile","compileFinal","preprocessFileLineNumbers"]},{"name":"BIS_fnc_loadInventory","title":"BIS fnc loadInventory","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_loadInventory","revid":349482,"updated":"2023-11-08T17:09:03Z","groups":["Inventory"],"status":"ok","games":{"arma3":"0.58"},"since":"arma3 0.58","arma3_since":"0.58","description":"Adds a predefined loadout (either via `CfgVehicles`, `CfgRespawnInventory`, or a custom inventory saved via BIS_fnc_saveInventory) to a specified unit.","syntaxes":[{"syntax":"param call BIS_fnc_loadInventory","params":[{"name":"Object","description":"unit to receive the loadout","type_expr":"Object"},{"name":"Config or Array","description":"can be one of:\n\n- Config: config entry of loadout found in either `CfgVehicles` or `CfgRespawnInventory`\n- Array in format [Namespace, Group or Object, String] or BIS_fnc_saveInventory's output","type_expr":"Config | Array"},{"name":"Array","optional":true,"default":"`[]`","description":"array of Strings that define what part of the loadout to ignore, e.g [\"weapons\", \"uniform\"]","type_expr":"Array","text":"Array - (Optional, default `[]`) array of Strings that define what part of the loadout to ignore, e.g [\"weapons\", \"uniform\"]"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["_loadout = [player, configFile >> \"CfgVehicles\" >> \"B_Soldier_SL_F\"] call BIS_fnc_loadInventory; // gives BLUFOR Squad Leader's loadout to player unit"]},{"text":"to save and load the inventory:\n\n```sqf\n[player, [missionNamespace, \"TAG_SavedInventory\"]] call BIS_fnc_saveInventory;    // save it\n[player, [missionNamespace, \"TAG_SavedInventory\"]] call BIS_fnc_loadInventory;    // load it\n```","code":["[player, [missionNamespace, \"TAG_SavedInventory\"]] call BIS_fnc_saveInventory;\t// save it\n[player, [missionNamespace, \"TAG_SavedInventory\"]] call BIS_fnc_loadInventory;\t// load it"]}],"see_also":["BIS_fnc_saveInventory","BIS_fnc_exportInventory","BIS_fnc_deleteInventory","setUnitLoadout"],"notes":[{"user":"Ilias38rus","date":"2020-08-02T15:21:00Z","text":"Doesn't work for backpacks in backpack, unlike setUnitLoadout."}]},{"name":"BIS_fnc_loadVehicle","title":"BIS fnc loadVehicle","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_loadVehicle","revid":363969,"updated":"2024-04-29T06:51:33Z","groups":["Vehicles"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Load vehicle appearance saved with BIS_fnc_saveVehicle.","syntaxes":[{"syntax":"[object,target] call BIS_fnc_loadVehicle","params":[{"name":"object","type":"Object","description":"vehicle","type_expr":"Object"},{"name":"target","type":"Array","description":"in format:\n\n- 0: Namespace, Group or Object - location of the previously saved appearance\n- 1: String - name of the saved appearance","type_expr":"Array"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[BIS_tank, [missionNamespace, \"BIS_someTankSave\"]] call BIS_fnc_loadVehicle;"]}],"see_also":["BIS_fnc_saveVehicle","BIS_fnc_initVehicle","Arma 3: Vehicle Customisation"]},{"name":"BIS_fnc_localize","title":"BIS fnc localize","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_localize","revid":308934,"updated":"2022-04-18T19:33:30Z","groups":["Strings"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Checks if passed string is localization key and if so, return the localized text. Else, returns the passed string itself.","syntaxes":[{"syntax":"localizationString call BIS_fnc_localize","params":[{"name":"localizationString","type":"String","type_expr":"String"}],"returns":{"type":"String","type_expr":"String","description":"the localized text behind the key or the key itself (if not localized)."}}],"examples":[{"code":["// assuming the stringtable contains a key \"STR_someString\" with the value \"Hello world\"\n\"STR_someString\" call BIS_fnc_localize; // returns \"Hello world\"\n\n// assuming the stringtable does not contain a key \"STR_anotherString\"\n\"STR_anotherString\" call BIS_fnc_localize; // returns \"STR_anotherString\""]}],"see_also":["isLocalized","localize","Stringtable.xml"],"notes":[{"user":"Vincent H.","date":"2017-12-29T00:03:00Z","text":"Unfortunately localize does not exactly do the same as BIS_fnc_localize.\nBIS_fnc_localize also checks if it the input string isLocalized while localize will return an empty string if the input parameter is not localized."}]},{"name":"BIS_fnc_locationDescription","title":"BIS fnc locationDescription","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_locationDescription","revid":329682,"updated":"2022-08-01T09:39:35Z","groups":["Map and Markers","Positions"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Return location description (e.g. \"NE of Agia Marina\")","syntaxes":[{"syntax":"position call BIS_fnc_locationDescription","params":[{"name":"position","type":"Position","optional":true,"default":"`cameraOn call BIS_fnc_position`","type_expr":"Position","text":"position: Position - (Optional, default `cameraOn call BIS_fnc_position`)"}],"returns":{"type":"String","type_expr":"String"}}],"examples":[{"code":["hint format [\"Player's position: %1\", player call BIS_fnc_locationDescription];"]}],"see_also":["BIS_fnc_position","cameraOn","getPos","getPosATL","getPosASL","getPosASLW"]},{"name":"BIS_fnc_locations","title":"BIS fnc locations","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_locations","revid":379501,"updated":"2026-10-31T00:27:10Z","groups":["Systems"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Creates or registers location logics (used in various modules, like Ambient Civilians, Ambient Civilian Vehicles or Warfare 2).\n\nUpon registering, function will set following variables into location logic's variable space:\n\n- \"class\" - unique class of location (either `BIS_loc_<configname>` or `BIS_loc_custom_<ID>`)\n- \"name\" - name of location from config or setName command. If none is defined, class is used\n- \"type\" - config type\n- \"neighbors\" - config defined neighbor locations\n\nIf you are registering currently existing object and some of variables above is already stored in it, it will **not** be replaced.","syntaxes":[{"syntax":"[types, area, debug] call BIS_fnc_locations","params":[{"name":"types","type":"String or Array of Strings","type_expr":"String | Array<String>"},{"name":"area","type":"Array in format [center, distance]","type_expr":"Array"},{"name":"debug","type":"Boolean","optional":true,"type_expr":"Boolean","text":"debug: Boolean (Optional)"}],"returns":{"type":"Array","type_expr":"Array","description":"list of registered locations"}},{"syntax":"[objects] call BIS_fnc_locations","params":[{"name":"objects","type":"Array of Objects or Locations","description":"list of specific locations to be registered","type_expr":"Array<Object | Location>"}],"returns":{"type":"Array","type_expr":"Array","description":"list of registered locations"}}],"examples":[{"code":["[\"CityCenter\", [getPosATL player, 1000]] call BIS_fnc_locations;"]},{"code":["[[\"acityc_dolina\"]] call BIS_fnc_locations;"]},{"code":["[[myLocation1, myLocation2], [], true] call BIS_fnc_locations;"]}],"see_also":["Functions Library"],"notes":[{"user":"Str","date":"2009-05-31T15:15:00Z","text":"You can also use `\"\" call BIS_fnc_locations` for quick debug of all locations on landscape"}]},{"name":"BIS_fnc_lockedDoorNoHandleOpen","title":"BIS fnc lockedDoorNoHandleOpen","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_lockedDoorNoHandleOpen","revid":274040,"updated":"2021-06-13T01:15:38Z","groups":["Scripts"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_lockedDoorNoHandleOpen","params":[],"returns":null}]},{"name":"BIS_fnc_lockedDoorOpen","title":"BIS fnc lockedDoorOpen","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_lockedDoorOpen","revid":274106,"updated":"2021-06-13T01:16:43Z","groups":["Scripts"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_lockedDoorOpen","params":[],"returns":null}]},{"name":"BIS_fnc_locWeaponInfo","title":"BIS fnc locWeaponInfo","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_locWeaponInfo","revid":329331,"updated":"2022-07-27T10:15:20Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Shows a utility tool checking length of weapon info texts.","syntaxes":[{"syntax":"call BIS_fnc_locWeaponInfo","params":[],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when done"}}],"examples":[{"code":["call BIS_fnc_locWeaponInfo;"]}],"see_also":["BIS_fnc_animViewer","BIS_fnc_configViewer","BIS_fnc_help"]},{"name":"BIS_fnc_log","title":"BIS fnc log","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_log","revid":351743,"updated":"2023-12-30T21:31:42Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"0.50"},"since":"arma3 0.50","arma3_since":"0.50","description":"Log debug message.\n\n> [!NOTE]\n> `allowFunctionsLog` has to be set to **1** in Description.ext for this function to have any effect.","syntaxes":[{"syntax":"param call BIS_fnc_log","params":[{"name":"param","type":"Anything","type_expr":"Anything"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["diag_tickTime call BIS_fnc_log;"]},{"code":["[dayTime, overcast, fog] call BIS_fnc_log;"]},{"code":["(name player) call BIS_fnc_log;"]}],"see_also":["BIS_fnc_error","BIS_fnc_logFormat","BIS_fnc_errorMsg","BIS_fnc_logFormatServer"]},{"name":"BIS_fnc_logFormat","title":"BIS fnc logFormat","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_logFormat","revid":351747,"updated":"2023-12-30T21:46:04Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Display debug message.\n\n> [!NOTE]\n> `allowFunctionsLog` has to be set to **1** in Description.ext for this function to have any effect.","syntaxes":[{"syntax":"[text, parameters] call BIS_fnc_logFormat","params":[{"name":"text","type":"String","description":"formatted message or first param","type_expr":"String","text":"**text**: String - formatted message or first param"},{"name":"parameters","type":"Anything","optional":true,"description":"additional parameters","type_expr":"Anything","text":"**parameters**: Anything - (Optional) additional parameters"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when done"}}],"examples":[{"code":["[\"My logged name: %1, My position: %2\", name player, getPos player] call BIS_fnc_logFormat;\n// RPT output:\n// 12:34:56 \"BIS_fnc_log: [BIS_fnc_debugConsoleExec] My logged name: Miller, My position: [4866.73,21947.9,0.00143433]\""]}],"see_also":["BIS_fnc_error","BIS_fnc_logFormatServer","BIS_fnc_errorMsg","BIS_fnc_log"]},{"name":"BIS_fnc_logFormatServer","title":"BIS fnc logFormatServer","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_logFormatServer","revid":351746,"updated":"2023-12-30T21:45:26Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Logs (using diag_log) a debug message (profileName, playerUID, _fnc_scriptName, provided text) to **server**'s .RPT. In singleplayer, BIS_fnc_logFormat is used.\n\n> [!NOTE]\n> `allowFunctionsLog` has to be set to **1** in Description.ext for this function to have any effect.","syntaxes":[{"syntax":"[text, argument1, argument2, ...] call BIS_fnc_logFormatServer","params":[{"name":"text","type":"String or Anything","description":"text using format standard (with %). Any non-String value will be converted (with str)","type_expr":"String | Anything"},{"name":"argument1..n","type":"Anything","description":"same as format arguments - referenced in *text* as %1, %2 etc","type_expr":"Anything"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when done"}}],"examples":[{"text":"```sqf\nprivate _currentFPS = diag_fps;\nif (_currentFPS < 10) then\n{\n    [\"Player %1 has performance issues (%2 FPS)\", name player, _currentFPS] call BIS_fnc_logFormatServer;\n};\n```","code":["private _currentFPS = diag_fps;\nif (_currentFPS < 10) then\n{\n\t[\"Player %1 has performance issues (%2 FPS)\", name player, _currentFPS] call BIS_fnc_logFormatServer;\n};"]}],"see_also":["BIS_fnc_error","BIS_fnc_logFormat","BIS_fnc_errorMsg","BIS_fnc_log"]},{"name":"BIS_fnc_lookAtArray","title":"BIS fnc lookAtArray","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_lookAtArray","revid":348199,"updated":"2023-11-08T11:40:09Z","groups":["Interaction"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Executes a code when one of the specified objects is looked at (player's cursor pointed towards it) for enough time","syntaxes":[{"syntax":"[initialize, lookAtData] call BIS_fnc_lookAtArray","params":[{"name":"initialize","type":"Boolean","description":"true to initialize, false to remove it","type_expr":"Boolean"},{"name":"lookAtData","type":"Array","description":"an array with arrays of look-up-data in form of:\n\n- 0: Object - Object to be looked at\n- 1: Number - How long player has to look at it\n- 2: Boolean - true to remove it from array when player looked at it\n- 3: Code - Code spawned when player looked long enough at the object","type_expr":"Array"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"```sqf\nprivate _lookAtArray =\n[\n    [\n        BIS_apc,                                        // name of object\n        2,                                                // time we have to look at it\n        false,                                            // do we destroy the entry after we looked at it\n        { [\"What a wonderful APC\"] call BIS_fnc_log; }    // code\n    ],\n    [\n        BIS_otherUnit,\n        2,\n        false,\n        { [\"apc looked at\"] call BIS_fnc_log; }\n    ]\n];\n[true, _lookAtArray] spawn \"BIS_fnc_lookAtArray\";\nsleep 15;\n[false] spawn \"BIS_fnc_lookAtArray\";\n```","code":["private _lookAtArray = \n[\n\t[\n\t\tBIS_apc,\t\t\t\t\t\t\t\t\t\t// name of object\n\t\t2,\t\t\t\t\t\t\t\t\t\t\t\t// time we have to look at it\n\t\tfalse,\t\t\t\t\t\t\t\t\t\t\t// do we destroy the entry after we looked at it\n\t\t{ [\"What a wonderful APC\"] call BIS_fnc_log; }\t// code\n\t],\n\t[\n\t\tBIS_otherUnit, \n\t\t2,\n\t\tfalse,\n\t\t{ [\"apc looked at\"] call BIS_fnc_log; }\n\t]\n];\n[true, _lookAtArray] spawn \"BIS_fnc_lookAtArray\";\nsleep 15;\n[false] spawn \"BIS_fnc_lookAtArray\";"]}],"see_also":["BIS_fnc_lookAtArrayEH"]},{"name":"BIS_fnc_lookAtArrayEH","title":"BIS fnc lookAtArrayEH","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_lookAtArrayEH","revid":281500,"updated":"2021-06-14T09:14:12Z","groups":["Interaction"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Event handler function for the BIS_fnc_lookAtArray function.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"-"}],"see_also":["BIS_fnc_lookAtArray"]},{"name":"BIS_fnc_loop","title":"BIS fnc loop","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_loop","revid":328958,"updated":"2022-07-18T10:58:38Z","groups":["Program Flow"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Loop stacked code/function with timing and conditional control. Code and conditions are executed in non-scheduled environment.","syntaxes":[{"syntax":"[action, parameters] call BIS_fnc_loop","params":[{"name":"action","type":"String","description":"can be one of:\n\n- \"initialize\" - Initializes game loop (not required as internal AUTO_INITIALIZE variable is set to true)\n- \"terminate\" - Terminates game loop (required as internal AUTO_TERMINATE variable is *not* set to true)\n- \"itemAdd\" - Adds an item to loop\n- \"itemRemove\" - Remove item from loop with id \"uniqueId\"\n- *\"onEachFrame\" - internally used by \"initialize\"*\n- *\"itemExecute\" - internally used by \"onEachFrame\"*","type_expr":"String"},{"name":"parameters","type":"Array","description":"used with \"itemAdd\" and \"itemRemove\" *action* (\"itemRemove\" only takes id):\n\n- id: String - loop unique id\n- code: Code or String - code to be executed\n- timer: Number - (Optional, default 0) delay between executions\n- timerType: String - (Optional, default \"seconds\") can be \"seconds\" or \"frames\"\n- conditionStart: Code - (Optional, default `{ true }`) will *wait* until the condition is met to start the code\n- conditionEnd: Code - (Optional, default `{ false }`) stops the loop as soon as the ending condition is met (after the end of *code*)\n- executeOnce: Boolean - (Optional, default false)","type_expr":"Array"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["// hints time every five seconds\n[\"itemAdd\", [\"uniqueId\", { hint str time; }, 5]] call BIS_fnc_loop;"]},{"code":["// removes stacked loop with id of uniqueId\n[\"itemRemove\", [\"uniqueId\"]] call BIS_fnc_loop;"]},{"code":["// hints time every frame after BIS_variable is assigned\n[\"itemAdd\", [\"uniqueId\", { hint str time; }, nil, nil, { !isNil { BIS_variable } }]] call BIS_fnc_loop;"]},{"code":["// hints time every five seconds after BIS_variable is assigned\n[\"itemAdd\", [\"uniqueId\", { hint str time; }, 5, \"seconds\", { !isNil { BIS_variable } }]] call BIS_fnc_loop;"]},{"code":["// hints time every frame\n[\"itemAdd\", [\"uniqueId\", { hint str time; }]] call BIS_fnc_loop;"]},{"code":["// remove item from loop with id \"uniqueId\"\n[\"itemRemove\", [\"uniqueId\"]] call BIS_fnc_loop;"]}],"see_also":["for","forEach","while"]},{"name":"BIS_fnc_lowestNum","title":"BIS fnc lowestNum","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_lowestNum","revid":326955,"updated":"2022-07-12T21:44:40Z","groups":["Arrays","Math"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Returns the lowest number out of the passed set.","syntaxes":[{"syntax":"numbers call BIS_fnc_lowestNum","params":[{"name":"numbers","type":"Array","description":"a set of numbers","type_expr":"Array"}],"returns":{"type":"Number","type_expr":"Number","description":"lowest number in the set"}}],"examples":[{"code":["private _result = [7,2,1,5,10] call BIS_fnc_lowestNum; //_result = 1"]}],"see_also":["BIS_fnc_greatestNum","BIS_fnc_findExtreme","selectMin","selectMax"]},{"name":"BIS_fnc_magazinesEntityType","title":"BIS fnc magazinesEntityType","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_magazinesEntityType","revid":363906,"updated":"2024-04-24T21:51:34Z","groups":["Weapons"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Return object's magazines as defined in config. Scans also turrets and pylons.","syntaxes":[{"syntax":"class call BIS_fnc_magazinesEntityType","params":[{"name":"class","type":"String","description":"object class","type_expr":"String"}],"returns":{"type":"Array of Strings","type_expr":"Array<String>"}}],"examples":[{"text":"```sqf\n\"O_MBT_04_cannon_F\" call BIS_fnc_magazinesEntityType;\n/*\n    returns\n    [\n        \"20Rnd_125mm_APFSDS_T_Green\",\n        \"12Rnd_125mm_HEAT_T_Green\",\n        \"12Rnd_125mm_HE_T_Green\",\n        \"1000Rnd_762x51_Belt_Green\",\n        \"1000Rnd_762x51_Belt_Green\",\n        \"500Rnd_127x99_mag_Tracer_Yellow\",\n        \"SmokeLauncherMag\"\n    ]\n*/\n```","code":["\"O_MBT_04_cannon_F\" call BIS_fnc_magazinesEntityType;\n/*\n\treturns\n\t[\n\t\t\"20Rnd_125mm_APFSDS_T_Green\",\n\t\t\"12Rnd_125mm_HEAT_T_Green\",\n\t\t\"12Rnd_125mm_HE_T_Green\",\n\t\t\"1000Rnd_762x51_Belt_Green\",\n\t\t\"1000Rnd_762x51_Belt_Green\",\n\t\t\"500Rnd_127x99_mag_Tracer_Yellow\",\n\t\t\"SmokeLauncherMag\"\n\t]\n*/"]}],"see_also":["magazines"]},{"name":"BIS_fnc_magnitude","title":"BIS fnc magnitude","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_magnitude","revid":349333,"updated":"2023-11-08T14:53:28Z","groups":["Vectors"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Returns the magnitude of an array of numbers. The vector can have any number of elements.\n\n> [!NOTE]\n> **Arma 3:** Use vectorMagnitude instead","syntaxes":[{"syntax":"vector call BIS_fnc_magnitude","params":[{"name":"vector","type":"Array","description":"vector","type_expr":"Array"}],"returns":{"type":"Array","type_expr":"Array","description":"new vector"}}],"examples":[{"code":["[5,3] call BIS_fnc_magnitude;"]}],"see_also":["BIS_fnc_crossProduct","BIS_fnc_magnitudeSqr","BIS_fnc_vectorFromXToY"]},{"name":"BIS_fnc_magnitudeSqr","title":"BIS fnc magnitudeSqr","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_magnitudeSqr","revid":349347,"updated":"2023-11-08T14:53:31Z","groups":["Vectors"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Returns the square magnitude of an array of numbers. The vector can have any number of elements.\n\n> [!NOTE]\n> **Arma 3:** Use vectorMagnitudeSqr instead","syntaxes":[{"syntax":"vector call BIS_fnc_magnitudeSqr","params":[{"name":"vector","type":"Array","description":"vector","type_expr":"Array"}],"returns":{"type":"Array","type_expr":"Array","description":"new vector"}}],"examples":[{"code":["[5,3] call BIS_fnc_magnitudeSqr;"]}],"see_also":["BIS_fnc_crossProduct","BIS_fnc_magnitude","BIS_fnc_vectorFromXToY"]},{"name":"BIS_fnc_manageCuratorAddons","title":"BIS fnc manageCuratorAddons","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_manageCuratorAddons","revid":379502,"updated":"2026-10-31T00:27:18Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Set which vision modes curator can access.","syntaxes":[{"syntax":"[curators,classes,condition,text] call BIS_fnc_manageCuratorAddons","params":[{"name":"curator","type":"Object or Array of Objects","description":"curator(s)","type_expr":"Object | Array<Object>"},{"name":"classes","type":"Array of Strings","description":"CfgPatches classes","type_expr":"Array<String>"},{"name":"classes","type":"Code","description":"unlock condition, must return true","type_expr":"Code"},{"name":"classes","type":"String","description":"notification text","type_expr":"String"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[BIS_curator,[\"A3_Air_F_Heli\"],{count allPlayers > 15},\"Helicopters unlocked!\"] call BIS_fnc_manageCuratorAddons;"]}],"see_also":["Arma 3: Curator"]},{"name":"BIS_fnc_manageCuratorChallenges","title":"BIS fnc manageCuratorChallenges","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_manageCuratorChallenges","revid":379503,"updated":"2026-10-31T00:27:26Z","groups":["CuratorChallenges"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Handle repeated curator challenges.\nWhen rewards defined in the argument are exceeded, refilling points bar fill be offered instead.","syntaxes":[{"syntax":"[curator,challenges,numChallenges,rewards,defaultRewards]] call BIS_fnc_manageCuratorChallenges","params":[{"name":"curator","type":"Object","description":"curator","type_expr":"Object"},{"name":"challenges","type":"Array","optional":true,"default":"all challenges","description":"list of supported challenges from CfgCuratorChallenges","type_expr":"Array","text":"challenges: Array - (Optional, default all challenges) list of supported challenges from CfgCuratorChallenges"},{"name":"challenges","type":"Number","optional":true,"default":"3","description":"number of added challenges","type_expr":"Number","text":"challenges: Number - (Optional, default 3) number of added challenges"},{"name":"rewards","type":"Array of arrays","optional":true,"default":"`[]`","description":"rewards and their descriptions in format:\n\n- 0: Code - Code executed\n- 1: String - Description","type_expr":"Array<Array>","text":"rewards: Array of arrays - (Optional, default `[]`) rewards and their descriptions in format:\n\n- 0: Code - Code executed\n- 1: String - Description"},{"name":"defaultRewards","type":"Array of arrays","optional":true,"default":"`[]`","description":"default reward, used when previous rewards are exausted in format:\n\n- 0: Code - Code executed\n- 1: String - Description","type_expr":"Array<Array>","text":"defaultRewards: Array of arrays - (Optional, default `[]`) default reward, used when previous rewards are exausted in format:\n\n- 0: Code - Code executed\n- 1: String - Description"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[BIS_curator, nil, 1, [[{ hint \"Message\" }, \"Description\"]]] call BIS_fnc_manageCuratorChallenges;"]}],"see_also":["Arma 3: Curator","BIS_fnc_formatCuratorChallengeObjects","BIS_fnc_finishCuratorChallenge","BIS_fnc_addCuratorChallenge"]},{"name":"BIS_fnc_mapAnimAdd","title":"BIS fnc mapAnimAdd","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_mapAnimAdd","revid":323161,"updated":"2022-07-01T10:31:36Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"local","effect":"local"},"description":"Similar to mapAnimAdd, yet it provides additional parameters to allow for a non-linear zoom and various position interpolation modes.","syntaxes":[{"syntax":"[duration, toZoom, toPosition, interpModeZoom, interpModePosition, fromZoom, fromPosition] call BIS_fnc_mapAnimAdd","params":[{"name":"duration","type":"Number","optional":true,"default":"1.0","description":"the animation duration in seconds","type_expr":"Number","text":"duration: Number - (Optional, default 1.0) the animation duration in seconds"},{"name":"toZoom","type":"Number","optional":true,"default":"0.05","description":"the zoom at the end of the animation, ranging from 0.01 (max. zoom) to 1 (zoomed out)","type_expr":"Number","text":"toZoom: Number - (Optional, default 0.05) the zoom at the end of the animation, ranging from 0.01 (max. zoom) to 1 (zoomed out)"},{"name":"toPosition","type":"Position","optional":true,"default":"[0, 0, 0]","description":"the position vector","type_expr":"Position","text":"toPosition: Position - (Optional, default [0, 0, 0]) the position vector"},{"name":"interpModeZoom","type":"Number","optional":true,"default":"12","description":"the interpolation mode for the zoom","type_expr":"Number","text":"interpModeZoom: Number - (Optional, default 12) the interpolation mode for the zoom"},{"name":"interpModePosition","type":"Number","optional":true,"default":"12","description":"the interpolation mode for the position","type_expr":"Number","text":"interpModePosition: Number - (Optional, default 12) the interpolation mode for the position"},{"name":"fromZoom","type":"Number","optional":true,"default":"current map zoom","description":"the zoom at the begnning of the animation, ranging from 0.01 (max. zoom) to 1 (zoomed out)","type_expr":"Number","text":"fromZoom: Number - (Optional, default current map zoom) the zoom at the begnning of the animation, ranging from 0.01 (max. zoom) to 1 (zoomed out)"},{"name":"fromPosition","type":"Array format Position","optional":true,"default":"current map position","description":"the position vector from which to start the animation","type_expr":"Position","types":["Array","Position"],"text":"fromPosition: Array format Position - (Optional, default current map position) the position vector from which to start the animation"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["openMap true; // the function will not work if the map is not open\n[2.0, 0.05, getPosASL player] call BIS_fnc_mapAnimAdd;"]}],"see_also":["BIS_fnc_mapAnimClear","BIS_fnc_mapAnimDone","mapAnimAdd","mapAnimClear","mapAnimCommit","mapAnimDone","ctrlMapAnimAdd","ctrlMapAnimClear","ctrlMapAnimCommit","ctrlMapAnimDone"]},{"name":"BIS_fnc_mapAnimClear","title":"BIS fnc mapAnimClear","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_mapAnimClear","revid":274012,"updated":"2021-06-13T01:15:09Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Same as mapAnimClear","syntaxes":[{"syntax":"[] call BIS_fnc_mapAnimClear","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"examples":[{"code":["[] call BIS_fnc_mapAnimClear;"]}],"docblock":{"text":"Author:\nNelson Duarte\n\nDescription:\nSame as mapAnimClear\n\nParameters:\nNothing\n\nReturns:\nNothing\n\nExamples:\n[] call BIS_fnc_mapAnimClear;","author":"Nelson Duarte"},"filled_from_docblock":["description","returns","examples"]},{"name":"BIS_fnc_mapAnimDone","title":"BIS fnc mapAnimDone","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_mapAnimDone","revid":273979,"updated":"2021-06-13T01:14:27Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Same as mapAnimAdd but with possibility for non linear zoom and position interpolation modes","syntaxes":[{"syntax":"[] call BIS_fnc_mapAnimDone","params":[],"returns":{"type":"Boolean","type_expr":"Boolean","description":"False if map animation is in progress, true if not","text":"Bool - False if map animation is in progress, true if not","source":"docblock"}}],"examples":[{"code":["[] call BIS_fnc_mapAnimDone;"]}],"docblock":{"text":"Author:\nNelson Duarte\n\nDescription:\nSame as mapAnimAdd but with possibility for non linear zoom and position interpolation modes\n\nParameters:\nNothing\n\nReturns:\nBool - False if map animation is in progress, true if not\n\nExamples:\n[] call BIS_fnc_mapAnimDone;","author":"Nelson Duarte"},"filled_from_docblock":["description","returns","examples"]},{"name":"BIS_fnc_mapGridSize","title":"BIS fnc mapGridSize","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_mapGridSize","revid":309186,"updated":"2022-05-03T18:13:13Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.92"},"since":"arma3 1.92","arma3_since":"1.92","description":"Returns the size of map grid square at current zoom level.\n\n> [!NOTE]\n> This function caches config lookup result on the first use and for the duration of the mission, making subsequent access 2-3 times faster.","syntaxes":[{"syntax":"[map] call BIS_fnc_mapGridSize","params":[{"name":"map","type":"Control","optional":true,"default":"main mission map (findDisplay 12 displayCtrl 51)","description":"map control","type_expr":"Control","text":"map: Control - (Optional, default main mission map (findDisplay 12 displayCtrl 51)) map control"}],"returns":{"type":"Number","type_expr":"Number","description":"map grid size"}}],"examples":[{"code":["private _gridSize = [] call BIS_fnc_mapGridSize;"]}],"see_also":["BIS_fnc_mapSize"]},{"name":"BIS_fnc_mapSize","title":"BIS fnc mapSize","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_mapSize","revid":325104,"updated":"2022-07-01T12:24:54Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns map size from config. Do not confuse with worldSize. The engine command calculates the map size and doesn't read it from config.","syntaxes":[{"syntax":"terrainName call BIS_fnc_mapSize","params":[{"name":"terrainName","type":"String","optional":true,"default":"worldName","description":"world name","type_expr":"String","text":"terrainName: String - (Optional, default worldName) world name"}],"returns":{"type":"Number","type_expr":"Number"}}],"examples":[{"code":["\"Altis\" call BIS_fnc_mapSize;"]},{"code":["worldName call BIS_fnc_mapSize;"]},{"code":["call BIS_fnc_mapSize;"]}],"see_also":["BIS_fnc_mapGridSize","worldSize","worldName"]},{"name":"BIS_fnc_markerCreate","title":"BIS fnc markerCreate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_markerCreate","revid":309833,"updated":"2022-05-05T12:09:52Z","groups":["Map and Markers"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Creates marker with given params. Reads config to recognize settings - use for quick debugging only.","syntaxes":[{"syntax":"_this call BIS_fnc_markerCreate","params":[{"name":"_this","type":"Array","type_expr":"Array","optional":true,"description":"STRING - one of type, color, brush or shape. If no corresponding class is found, value is used as marker text\nARRAY\n    [STRING(,ANY,ANY,...)] - marker name with optional arguments\n    [NUMBER] - marker size [a,a]\n    [NUMBER,NUMBER] - marker size [x,y]\n    [NUMBER,NUMBER,NUMBER] - marker position [x,y,z]\nOBJECT - object's position\nNUMBER - marker dir\nBOOL - marker locality (true if global)","text":"ARRAY of values\nSTRING - one of type, color, brush or shape. If no corresponding class is found, value is used as marker text\nARRAY\n    [STRING(,ANY,ANY,...)] - marker name with optional arguments\n    [NUMBER] - marker size [a,a]\n    [NUMBER,NUMBER] - marker size [x,y]\n    [NUMBER,NUMBER,NUMBER] - marker position [x,y,z]\nOBJECT - object's position\nNUMBER - marker dir\nBOOL - marker locality (true if global)","source":"docblock"}],"returns":{"type":"String","type_expr":"String","description":"created marker","text":"STRING - created marker","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nCreates marker with given params.\nReads config to recognize settings - use for quick debugging only.\n\nParameter(s):\n_this: ARRAY of values:\n    STRING - one of type, color, brush or shape. If no corresponding class is found, value is used as marker text\n    ARRAY\n        [STRING(,ANY,ANY,...)] - marker name with optional arguments\n        [NUMBER] - marker size [a,a]\n        [NUMBER,NUMBER] - marker size [x,y]\n        [NUMBER,NUMBER,NUMBER] - marker position [x,y,z]\n    OBJECT - object's position\n    NUMBER - marker dir\n    BOOL - marker locality (true if global)\n\nReturns:\nSTRING - created marker"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_markerParams","title":"BIS fnc markerParams","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_markerParams","revid":363534,"updated":"2024-04-04T00:53:26Z","groups":["Map and Markers"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Returns marker params in format compatible with BIS_fnc_markerCreate.","syntaxes":[{"syntax":"varName call BIS_fnc_markerParams","params":[{"name":"varName","type":"String","description":"variable name of the marker","type_expr":"String"}],"returns":{"type":"Array","type_expr":"Array","description":"marker parameters in format [varName, pos, size, colour, type, brush, shape, alpha, name] where:\n- varName: Array with String - variable name - pos: Array format Position - position (see setMarkerPos) - size: Array of Numbers in format [x, y] (see setMarkerSize) - colour: String - colour (see setMarkerColor) - type: String - type (see setMarkerType) - brush: String - brush (see setMarkerBrush) - shape: String - shape (see setMarkerShape) - alpha: Number - transparency (see setMarkerAlpha) - text: String - text (see setMarkerText)","text":"Array - marker parameters in format [varName, pos, size, colour, type, brush, shape, alpha, name] where:\n\n- varName: Array with String - variable name\n- pos: Array format Position - position (see setMarkerPos)\n- size: Array of Numbers in format [x, y] (see setMarkerSize)\n- colour: String - colour (see setMarkerColor)\n- type: String - type (see setMarkerType)\n- brush: String - brush (see setMarkerBrush)\n- shape: String - shape (see setMarkerShape)\n- alpha: Number - transparency (see setMarkerAlpha)\n- text: String - text (see setMarkerText)"}}],"examples":[{"code":["private _params = \"marker_1\" call BIS_fnc_markerParams;"]},{"code":["(\"marker_1\" call BIS_fnc_markerParams) params [\"_nameArray\", \"_position\", \"_size\", \"_colour\", \"_type\", \"_brush\", \"_shape\", \"_alpha\", \"_text\"];\n_position params [\"_posX\", \"_posY\"];\n_nameArray params [\"_marker\"];\n_size params [\"_a\", \"_b\"];"]}],"see_also":["BIS_fnc_markerCreate"]},{"name":"BIS_fnc_markerPath","title":"BIS fnc markerPath","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_markerPath","revid":328423,"updated":"2022-07-13T16:00:50Z","groups":["Map and Markers"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","locality":{"effect":"global"},"description":"Create marker(s) between two points.","syntaxes":[{"syntax":"[start, end, spacing, params] call BIS_fnc_markerPath","params":[{"name":"start","type":"Position, Waypoint, Object, Location or String:","description":"Position, Waypoint, Object, Location or String:\n\n- Position - position [x,y] or [x,y,z]\n- Waypoint - format [group, index]\n- Object - object's position\n- Location - location's position\n- String - marker name","type_expr":"Position | Waypoint | Object | Location | String","text":"start: Position, Waypoint, Object, Location or String:\n\n- Position - position [x,y] or [x,y,z]\n- Waypoint - format [group, index]\n- Object - object's position\n- Location - location's position\n- String - marker name"},{"name":"end","type":"same as start","text":"end: same as *start*"},{"name":"spacing","type":"Number","optional":true,"default":"1000","description":"distance between markers. When value is negative, line marker is used instead with thickness of this value","type_expr":"Number","text":"spacing: Number - (Optional, default 1000) distance between markers. When value is negative, line marker is used instead with thickness of this value"},{"name":"params","type":"Array","optional":true,"default":"[\"BIS_fnc_markerPath_marker_#\", \"mil_triangle\", \"colorgreen\"]","description":"marker params (see BIS_fnc_markerCreate for details)","type_expr":"Array","text":"params: Array - (Optional, default [\"BIS_fnc_markerPath_marker_*#*\", \"mil_triangle\", \"colorgreen\"]) marker params (see BIS_fnc_markerCreate for details)"}],"returns":{"type":"Array","type_expr":"Array","description":"list of created markers"}}],"examples":[{"code":["[\"markerStart\", \"markerEnd\"] call BIS_fnc_markerPath;"]},{"code":["[player, nearestLocation [getPos player, \"nameCity\"]] call BIS_fnc_markerPath;"]}],"see_also":["createMarker","BIS_fnc_markWaypoints"]},{"name":"BIS_fnc_markerToString","title":"BIS fnc markerToString","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_markerToString","revid":337081,"updated":"2023-01-11T10:52:08Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.92"},"since":"arma3 1.92","arma3_since":"1.92","description":"Converts existing marker to String, for example: `\"|marker_0|[3799.0110,2781.9880,0.0000]|mil_pickup|ICON|[1,1]|0|Solid|Default|1|You are here\"`","syntaxes":[{"syntax":"[markerName, delimiter] call BIS_fnc_markerToString","params":[{"name":"markerName","type":"String","description":"existing marker","type_expr":"String"},{"name":"delimiter","type":"String","optional":true,"default":"`|`","description":"a single data delimiter character","type_expr":"String","text":"delimiter: String - (Optional, default `|`) a single data delimiter character"}],"returns":{"type":"String","type_expr":"String","description":"serialized marker to be used with BIS_fnc_stringToMarker or BIS_fnc_stringToMarkerLocal"}}],"examples":[{"code":["\"marker1\" call BIS_fnc_markerToString;"]},{"code":["[\"marker1\", \":\"] call BIS_fnc_markerToString;"]}],"see_also":["BIS_fnc_stringToMarker","BIS_fnc_stringToMarkerLocal","BIS_fnc_markerToTrigger","createMarker","createMarkerLocal"],"notes":[{"user":"7erra","date":"2019-05-03T12:17:00Z","text":"The format is the following:\n\n```\n\"|MARKERNAME|markerPos|markerType|markerShape|markerSize|markerDir|markerBrush|markerColor|markerAlpha|markerText\"\n```\n\nThe delimiter for BIS_fnc_stringToMarker is the first character of the string."}]},{"name":"BIS_fnc_markerToTrigger","title":"BIS fnc markerToTrigger","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_markerToTrigger","revid":327202,"updated":"2022-07-12T22:11:45Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Makes an existing or new marker cover a trigger area.","syntaxes":[{"syntax":"[markerName, trigger, localChange] call BIS_fnc_markerToTrigger","params":[{"name":"markerName","type":"String","description":"marker name - if no marker uses the name, a marker will be created","type_expr":"String"},{"name":"trigger","type":"Object","description":"trigger that will be covered by the marker","type_expr":"Object"},{"name":"localChange","type":"Boolean","optional":true,"default":"false","description":"are changes local (local marker creation and/or local marker changes)","type_expr":"Boolean","text":"localChange: Boolean (Optional, default false) are changes local (local marker creation and/or local marker changes)"}],"returns":{"type":"String","type_expr":"String","description":"marker name or \"\" if marker couldn't be moved or created or if provided markerName is \"\"","text":"String - marker name or \"\" if marker couldn't be moved or created or if provided *markerName* is \"\""}}],"examples":[{"code":["private _createdMarker = [\"marker1\", myTrigger] call BIS_fnc_markerToTrigger;"]}],"see_also":["createMarker","createMarkerLocal","BIS_fnc_triggerToMarker"]},{"name":"BIS_fnc_markWaypoints","title":"BIS fnc markWaypoints","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_markWaypoints","revid":309789,"updated":"2022-05-05T12:09:50Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Creates a marker on each uncompleted waypoint and marks it checked after completing that WP.","syntaxes":[{"syntax":"[param0] call BIS_fnc_markWaypoints","params":[{"name":"param0","type":"Object","type_expr":"Object","optional":true,"default":"\"\"","description":"unit who will have its waypoints marked\n_this select 1 (Optional, use \"\" for default): STRING - text of hint shown after completing a waypoint, %1 is used for WP number (default \"\")\n_this select 2 (Optional, use [] for default): ARRAY of STRINGS - marker text format for [uncompleted, completed] waypoints, %1 is used for WP number (default [\"%1\", \"%1\"])\n_this select 3 (Optional, use [] for default): ARRAY of STRINGS - marker icon for [uncompleted, completed] waypoints (default [\"mil_circle\", \"mil_circle\"])\n_this select 4 (Optional, use [] for default): ARRAY of STRINGS - marker color for [uncompleted, completed] waypoints (default [\"ColorRed\", \"ColorGreen\"])\n_this select 5 (Optional, use [] for default): ARRAY of NUMBERS - marker size for [uncompleted, completed] waypoints (default [0.75, 0.75])","text":"0: OBJECT - unit who will have its waypoints marked\n_this select 1 (Optional, use \"\" for default): STRING - text of hint shown after completing a waypoint, %1 is used for WP number (default \"\")\n_this select 2 (Optional, use [] for default): ARRAY of STRINGS - marker text format for [uncompleted, completed] waypoints, %1 is used for WP number (default [\"%1\", \"%1\"])\n_this select 3 (Optional, use [] for default): ARRAY of STRINGS - marker icon for [uncompleted, completed] waypoints (default [\"mil_circle\", \"mil_circle\"])\n_this select 4 (Optional, use [] for default): ARRAY of STRINGS - marker color for [uncompleted, completed] waypoints (default [\"ColorRed\", \"ColorGreen\"])\n_this select 5 (Optional, use [] for default): ARRAY of NUMBERS - marker size for [uncompleted, completed] waypoints (default [0.75, 0.75])","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","text":"NOTHING","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nCreates a marker on each uncompleted waypoint and marks it checked after completing that WP.\nNote: \"On Activation\" WP code is used for handling the markers; if this code is overwritten during the course, it can break this functionality\n\nParameter(s):\n_this select 0: OBJECT - unit who will have its waypoints marked\n_this select 1 (Optional, use \"\" for default): STRING - text of hint shown after completing a waypoint, %1 is used for WP number (default \"\")\n_this select 2 (Optional, use [] for default): ARRAY of STRINGS - marker text format for [uncompleted, completed] waypoints, %1 is used for WP number (default [\"%1\", \"%1\"])\n_this select 3 (Optional, use [] for default): ARRAY of STRINGS - marker icon for [uncompleted, completed] waypoints (default [\"mil_circle\", \"mil_circle\"])\n_this select 4 (Optional, use [] for default): ARRAY of STRINGS - marker color for [uncompleted, completed] waypoints (default [\"ColorRed\", \"ColorGreen\"])\n_this select 5 (Optional, use [] for default): ARRAY of NUMBERS - marker size for [uncompleted, completed] waypoints (default [0.75, 0.75])\n\nReturns:\nNOTHING"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_maxDiffArray","title":"BIS fnc maxDiffArray","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_maxDiffArray","revid":327956,"updated":"2022-07-13T13:05:24Z","groups":["Arrays"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Function to return the maximum difference between all values in an array.","syntaxes":[{"syntax":"[arrayOfNumbers] call BIS_fnc_maxDiffArray","params":[{"name":"arrayOfNumbers","type":"Array","description":"numbers to be tested","type_expr":"Array"}],"returns":{"type":"Number","type_expr":"Number","description":"the biggest difference"}}],"examples":[{"code":["private _maxDiff = [[0, 5, 10, -5]] call BIS_fnc_maxDiffArray; // will return 15 (-5 to 10)"]}]},{"name":"BIS_fnc_mirrorCuratorSettings","title":"BIS fnc mirrorCuratorSettings","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_mirrorCuratorSettings","revid":379504,"updated":"2026-10-31T00:27:34Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","locality":{"server_exec":true},"description":"Mirrors settings from one curator to another.","syntaxes":[{"syntax":"[from, to, modes, shareType] call BIS_fnc_mirrorCuratorSettings","params":[{"name":"from","type":"Object or Array of Objects","description":"curators(s) from which settings are taken","type_expr":"Object | Array<Object>"},{"name":"to","type":"Object or Array of Objects","description":"curators(s) to which settings are applied to","type_expr":"Object | Array<Object>"},{"name":"modes","type":"Array of Strings","description":"copy modes, can be:\n\n- \"addons\"\n- \"objects\"\n- \"coefs\"\n\nAll three modes can be combined.","type_expr":"Array<String>"},{"name":"shareType","type":"Boolean","description":"true to share settings both ways, false to make second curator slave to the first one","type_expr":"Boolean"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"text":"```sqf\n[\n    [curator_1, curator_2],\n    [curator_3, curator_4],\n    [\"addons\", \"objects\", \"coefs\"]\n] call BIS_fnc_mirrorCuratorSettings;\n```","code":["[\n\t[curator_1, curator_2], \n\t[curator_3, curator_4], \n\t[\"addons\", \"objects\", \"coefs\"] \n] call BIS_fnc_mirrorCuratorSettings;"]}],"see_also":["Arma 3: Curator"]},{"name":"BIS_fnc_miscAnim","title":"BIS fnc miscAnim","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_miscAnim","revid":370878,"updated":"2025-02-21T10:44:03Z","groups":["Scenes"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Setting up the animations with correct positions for object - choose correct performance. For ex. fixingTowingTractor (read the description).\n\n> [!WARNING]\n> This function most likely doesn't work outside of Arma 2 and Arma 2: Operation Arrowhead.","syntaxes":[{"syntax":"[anim, person1, vehicle, person2, isOnBoard, altitude, doMove] call BIS_fnc_miscAnim","params":[{"name":"anim","type":"String","description":"**case-sensitive**, can be one of:\n\n- **\"BagFenceSittingOn1\"** - sitting on the bagfance - front\n- **\"fixingHumwee1\"** - fixing Hummwee - engine\n- **\"fixingTowingTractor\"** - fixing the right front wheel of towing tractor\n- **\"heliChecking1\"** - checking, assembling helicopter - thermal rocket silo - VENOM\n- **\"heliChecking2\"** - checking, assembling helicopter - ROTATEGUN\n- **\"heliCleaning1\"** - cleaning,checking, helicopter MH60 - cockpit outside\n- **\"heliNavi1\"** - navigating helicopter\n- **\"lyingAlongVehicle1\"** - lying near the vehicle - LEFT\n- **\"lyingAlongVehicle1b\"** - lying near the vehicle - RIGHT\n- **\"sittingOnTheChair1\"** - sitting on the foldChair (with geton from the RIGHT side)\n- **\"sittingOnTheChair1L\"** - sitting on the foldChair (with geton from the LEFT side)\n- **\"sittingOnTheChair2\"** - sitting-banded on the foldChair (with geton from the RIGHT side)\n- **\"sittingOnTheChair3a\"** - Sykes-like sitting\n- **\"sittingOnTheChair3b\"** - Rodriguez-like sitting\n- **\"tableSittingOn1\"** - sitting on the table - front\n- **\"tableSupportTalking1\"** - talking leaning on table - from front\n- **\"tableSupportTalking2\"** - talking leaning on table - from side\n- **\"twoTalking1\"** - pair talking in front of the vehicle 0 degrees\n- **\"twoTalking1a\"** - pair talking in front of the vehicle 0 degrees but pair is ROTATED\n- **\"twoTalking2\"** - pair talking in side of the vehicle 90 degrees\n- **\"twoTalking3\"** - pair talking in side of the vehicle 270 degrees","type_expr":"String"},{"name":"person1","type":"Object","description":"first actor","type_expr":"Object"},{"name":"vehicle","type":"String","description":"reference object (chair, table, vehicle etc.). Only used for certain anims","type_expr":"String"},{"name":"person2","type":"Object","optional":true,"default":"person1","description":"second actor, if any","type_expr":"Object","text":"person2: Object - (Optional, default *person1*) - second actor, if any"},{"name":"isOnBoard","type":"Boolean","optional":true,"default":"false","description":"is the unit on Arma 2 LHD (15m height)","type_expr":"Boolean","text":"isOnBoard: Boolean - (Optional, default false) is the unit on Arma 2 LHD (15m height)"},{"name":"altitude","type":"Number","optional":true,"default":"0","description":"custom altitude to use instead of 0 or 15m","type_expr":"Number","text":"altitude: Number - (Optional, default 0) custom altitude to use instead of 0 or 15m"},{"name":"doMove","type":"Anything","optional":true,"default":"false","description":"nil to setPos unit, any value to make it move via\ndoMove (true for readability)","type_expr":"Anything","text":"doMove: Anything - (Optional, default false) nil to setPos unit, any value to make it move via\ndoMove (true for readability)"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"twoTalking1\", unit1, myCar, unit2] call BIS_fnc_miscAnim;"]}],"see_also":["playMove","switchMove","playAction"]},{"name":"BIS_fnc_missileLaunchPositionFix","title":"BIS fnc missileLaunchPositionFix","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_missileLaunchPositionFix","revid":349286,"updated":"2023-11-08T14:51:15Z","groups":["Vehicles"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Workaround fix for ATGM/SAM launch positions","syntaxes":[{"syntax":"[vehicle, projectile, selection, projectileType] call BIS_fnc_missileLaunchPositionFix","params":[{"name":"vehicle","type":"Object","description":"vehicle","type_expr":"Object"},{"name":"projectile","type":"Object","description":"projectile","type_expr":"Object"},{"name":"selection","type":"Object","description":"selection to adjust the missile's position to","type_expr":"Object"},{"name":"projectileType","type":"Object","description":"type of projectile that should be adjusted","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"returns true if successful"}}],"examples":[{"code":["[_vehicle,_missile,\"missile_move\",\"MissileBase\"] call BIS_fnc_missileLaunchPositionFix;"]}],"see_also":["missileTarget","missileTargetPos"]},{"name":"BIS_fnc_missionConversations","title":"BIS fnc missionConversations","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_missionConversations","revid":309746,"updated":"2022-05-05T12:09:48Z","groups":["Conversations"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Header function of local mission conversations","syntaxes":[{"syntax":"[param0] call BIS_fnc_missionConversations","params":[{"name":"param0","type":"String","type_expr":"String","optional":true,"description":"unique mode\n1 (Optional): ANY - additional params","text":"0: STRING - unique mode\n1 (Optional): ANY - additional params","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","text":"BOOL","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nHeader function of local mission conversations\n\nParameter(s):\n    0: STRING - unique mode\n    1 (Optional): ANY - additional params\n\nReturns:\nBOOL"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_missionConversationsLocal","title":"BIS fnc missionConversationsLocal","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_missionConversationsLocal","revid":364480,"updated":"2024-05-16T20:41:56Z","groups":["Conversations","Broken Functions"],"status":"broken","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"> [!NOTE]\n> This function is blank and does nothing.","syntaxes":[{"syntax":"call BIS_fnc_missionConversationsLocal","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_missionConversationsLocal;"]}],"see_also":["Conversations","BIS_fnc_missionConversations"]},{"name":"BIS_fnc_missionFlow","title":"BIS fnc missionFlow","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_missionFlow","revid":364294,"updated":"2024-05-06T09:38:39Z","groups":["Missions"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"This function is automatically run in post-init by a CfgFunctions declaration. If the mission contains a `missionFlow.fsm` file, it will be loaded, otherwise an empty, default one will be used.","syntaxes":[{"syntax":"call BIS_fnc_missionFlow","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_missionFlow;"]}],"see_also":["FSM","Event Scripts"]},{"name":"BIS_fnc_missionHandlers","title":"BIS fnc missionHandlers","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_missionHandlers","revid":309743,"updated":"2022-05-05T12:09:48Z","groups":["Missions"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"```\n#define VAR_RELOADS    (missionname + \"_reloads_\" + str ismultiplayer)\n\n//--- Mission end type and rating\n```","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_missionRespawnType","title":"BIS fnc missionRespawnType","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_missionRespawnType","revid":327021,"updated":"2022-07-12T21:44:45Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Return respawn type defined in Description.ext. Can return as Number (e.g 1) or String (e.g \"BIRD\").","syntaxes":[{"syntax":"type call BIS_fnc_missionRespawnType","params":[{"name":"type","type":"Number or String","description":"wanted return value type","type_expr":"Number | String"}],"returns":{"type":"Number or String","type_expr":"Number | String","description":"return type depends on type","text":"Number or String - return type depends on *type*"}}],"examples":[{"code":["private _respawnAsNumber = 0 call BIS_fnc_missionRespawnType;"]},{"code":["private _respawnAsString = \"\" call BIS_fnc_missionRespawnType;"]}],"see_also":["Arma 3: Respawn"]},{"name":"BIS_fnc_missionSelector","title":"BIS fnc missionSelector","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_missionSelector","revid":349497,"updated":"2023-11-08T17:09:09Z","groups":["Systems"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","locality":{"effect":"local"},"description":"Function that draws clickable, hoverable and animated icons on the map that execute a user-defined code when pressed.","syntaxes":[{"syntax":"[area, mapCenter, missionsArray] call BIS_fnc_missionSelector","params":[{"name":"area","type":"Array of Number","optional":true,"default":"[100,100]","description":"used to determine map's zoom, format [width, height]","type_expr":"Array<Number>","text":"area: Array of Number - (Optional, default [100,100]) used to determine map's zoom, format [width, height]"},{"name":"mapCenter","type":"Position2D","optional":true,"default":"[0,0]","description":"center position where the map camera will be positioned","type_expr":"Position2D","text":"mapCenter: Position2D - (Optional, default [0,0]) center position where the map camera will be positioned"},{"name":"missionsArray","type":"Array","optional":true,"default":"`[]`","description":"list of selectable missions and their parameters, to format [pos, text, tooltip, picture, code]:\n\n- pos: Array - where the clickable marker will be placed\n- text: String - text that should be displayed next to the icon\n- tooltip: String - text to be displayed in the tooltip (on mouse over)\n- picture: String - location of the picture to be displayed in the tooltip\n- code: Code - code spawned when the icon is clicked","type_expr":"Array","text":"missionsArray: Array - (Optional, default `[]`) list of selectable missions and their parameters, to format [pos, text, tooltip, picture, code]:\n\n- pos: Array - where the clickable marker will be placed\n- text: String - text that should be displayed next to the icon\n- tooltip: String - text to be displayed in the tooltip (on mouse over)\n- picture: String - location of the picture to be displayed in the tooltip\n- code: Code - code spawned when the icon is clicked"}],"returns":{"type":"Number","type_expr":"Number","description":"index of the chosen mission"}}],"examples":[{"text":"```sqf\nprivate _area = [750, 400];\nprivate _missionsList =\n[\n    [\n        getMarkerPos \"BIS_briefMarkerINFANTRY\",\n        \"Infantry\",\n        \"Your mission is to do stuff\",\n        \"AnimBriefing\\intro_stage1a_CA.paa\",\n        { hint \"infantry mission selected\" }\n    ],\n    [\n        getMarkerPos \"BIS_briefMarkerSPECIALFORCES\",\n        \"Special Forces\",\n        \"Your mission is to do stuff but in a more special way\",\n        \"AnimBriefing\\intro_stage1a_CA.paa\",\n        { hint \"special forces mission selected\" }\n    ]\n];\n\nprivate _index = [_area, getMarkerPos \"BIS_cameraCenter\", _missionsList] call BIS_fnc_missionSelector;\nprivate _missionDetails = _missionsList select _index;\n```","code":["private _area = [750, 400];\nprivate _missionsList =\n[\n\t[\n\t\tgetMarkerPos \"BIS_briefMarkerINFANTRY\",\n\t\t\"Infantry\",\n\t\t\"Your mission is to do stuff\",\n\t\t\"AnimBriefing\\intro_stage1a_CA.paa\",\n\t\t{ hint \"infantry mission selected\" }\n\t],\n\t[\n\t\tgetMarkerPos \"BIS_briefMarkerSPECIALFORCES\",\n\t\t\"Special Forces\",\n\t\t\"Your mission is to do stuff but in a more special way\",\n\t\t\"AnimBriefing\\intro_stage1a_CA.paa\",\n\t\t{ hint \"special forces mission selected\" }\n\t]\n];\n\nprivate _index = [_area, getMarkerPos \"BIS_cameraCenter\", _missionsList] call BIS_fnc_missionSelector;\nprivate _missionDetails = _missionsList select _index;"]}],"see_also":["playMission"]},{"name":"BIS_fnc_missionTasks","title":"BIS fnc missionTasks","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_missionTasks","revid":309712,"updated":"2022-05-05T12:09:46Z","groups":["Tasks"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Header function of local mission tasks. Automatically declares following variables:\n    _taskID: STRING\n    _taskState: STRING\n    _taskExists: BOOL","syntaxes":[{"syntax":"[param0] call BIS_fnc_missionTasks","params":[{"name":"param0","type":"String","type_expr":"String","optional":true,"default":"\"BIS_fnc_missionTasksLocal\"","description":"unique mode\n1 (Optional): ANY - additional params\n2 (Optional): CODE - specific task function (default: \"BIS_fnc_missionTasksLocal\")","text":"0: STRING - unique mode\n1 (Optional): ANY - additional params\n2 (Optional): CODE - specific task function (default: \"BIS_fnc_missionTasksLocal\")","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","text":"BOOL","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nHeader function of local mission tasks.\nAutomatically declares following variables:\n    _taskID: STRING\n    _taskState: STRING\n    _taskExists: BOOL\n\nParameter(s):\n    0: STRING - unique mode\n    1 (Optional): ANY - additional params\n    2 (Optional): CODE - specific task function (default: \"BIS_fnc_missionTasksLocal\")\n\nReturns:\nBOOL"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_missionTasksLocal","title":"BIS fnc missionTasksLocal","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_missionTasksLocal","revid":364502,"updated":"2024-05-16T20:42:03Z","groups":["Tasks","Broken Functions"],"status":"broken","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"> [!NOTE]\n> This function is blank and does nothing.","syntaxes":[{"syntax":"call BIS_fnc_missionTasksLocal","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_missionTasksLocal;"]}],"see_also":["Arma 3: Task Framework","BIS_fnc_missionTasks"]},{"name":"BIS_fnc_missionTimeLeft","title":"BIS fnc missionTimeLeft","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_missionTimeLeft","revid":349227,"updated":"2023-11-08T14:50:52Z","groups":["Missions"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns time in seconds until the mission end. Remaining time can be set using estimatedTimeLeft command or using BIS_fnc_countdown.","syntaxes":[{"syntax":"call BIS_fnc_missionTimeLeft","params":[],"returns":{"type":"Number","type_expr":"Number","description":"time left"}}],"examples":[{"code":["call BIS_fnc_missionTimeLeft;"]}],"see_also":["estimatedTimeLeft","BIS_fnc_countdown"]},{"name":"BIS_fnc_moduleAI","title":"BIS fnc moduleAI","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleAI","revid":309761,"updated":"2022-05-05T12:09:49Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleAmmo","title":"BIS fnc moduleAmmo","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleAmmo","revid":309739,"updated":"2022-05-05T12:09:48Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleAnimals","title":"BIS fnc moduleAnimals","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleAnimals","revid":309843,"updated":"2022-05-05T12:09:52Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleArsenal","title":"BIS fnc moduleArsenal","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleArsenal","revid":309738,"updated":"2022-05-05T12:09:48Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleBleedTickets","title":"BIS fnc moduleBleedTickets","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleBleedTickets","revid":309871,"updated":"2022-05-05T12:09:53Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleBootcampStage","title":"BIS fnc moduleBootcampStage","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleBootcampStage","revid":309788,"updated":"2022-05-05T12:09:50Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"```\n/*\n\n    Description:\n    Change the current Stage in Bootcamp MP Guided Mode\n\n    Parameter(s):\n    http://community.bistudio.com/wiki/Arma_3_Modules\n\n    Returns:\n    NONE\n*/\n\n// Parameters\n```","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleCAS","title":"BIS fnc moduleCAS","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleCAS","revid":309723,"updated":"2022-05-05T12:09:47Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleChat","title":"BIS fnc moduleChat","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleChat","revid":328357,"updated":"2022-07-13T16:00:47Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"effect":"local"},"description":"Make a list of units use any *chat command (groupChat, vehicleChat, sideChat, commandChat, globalChat).","syntaxes":[{"syntax":"[logic, units, isActivated] call BIS_fnc_moduleChat","params":[{"name":"logic","description":"Object the logic. Possible setVariable parameters:\n\n- \"Text\": String - the text to be sent\n- \"Channel\": String - (Optional, default \"0\") a number **as a string**:\n  - \"0\": groupChat\n  - \"1\": vehicleChat\n  - \"2\": sideChat\n  - \"3\": commandChat\n  - \"4\": globalChat","type_expr":"Object","text":"logic: Object the logic. Possible setVariable parameters:\n\n- \"Text\": String - the text to be sent\n- \"Channel\": String - (Optional, default \"0\") a number **as a string**:\n  - \"0\": groupChat\n  - \"1\": vehicleChat\n  - \"2\": sideChat\n  - \"3\": commandChat\n  - \"4\": globalChat"},{"name":"units","type":"Array of Objects","description":"list of chatting units","type_expr":"Array<Object>"},{"name":"isActivated","type":"Boolean","optional":true,"default":"true","description":"if true, the module is activated and chat is send. false disables the module","type_expr":"Boolean","text":"isActivated: Boolean - (Optional, default true) if true, the module is activated and chat is send. false disables the module"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when done, even if isActivated equals false","text":"Boolean - true when done, even if *isActivated* equals false"}}],"examples":[{"code":["myLogic setVariable [\"Channel\", \"2\"];\nmyLogic setVariable [\"Text\", \"Hello everyone, this is side chat!\"];\n[myLogic, [player], true] call BIS_fnc_moduleChat;"]}],"see_also":["groupChat","vehicleChat","sideChat","commandChat","globalChat","systemChat"]},{"name":"BIS_fnc_moduleCivilianPresence","title":"BIS fnc moduleCivilianPresence","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleCivilianPresence","revid":286014,"updated":"2021-06-20T17:24:17Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"","syntaxes":[{"syntax":"[] call BIS_fnc_moduleCivilianPresence","params":[],"returns":null}],"examples":[{"code":["[\"getObjects\",[_module,\"ModuleCivilianPresenceSafeSpot_F\"]] call BIS_fnc_moduleCivilianPresence;"]}],"docblock":{"text":"Example:\n[\"getObjects\",[_module,\"ModuleCivilianPresenceSafeSpot_F\"]] call BIS_fnc_moduleCivilianPresence;"},"filled_from_docblock":["examples"]},{"name":"BIS_fnc_moduleCivilianPresenceSafeSpot","title":"BIS fnc moduleCivilianPresenceSafeSpot","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleCivilianPresenceSafeSpot","revid":273879,"updated":"2021-06-13T01:12:46Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"","syntaxes":[{"syntax":"[] call BIS_fnc_moduleCivilianPresenceSafeSpot","params":[],"returns":null}]},{"name":"BIS_fnc_moduleCivilianPresenceUnit","title":"BIS fnc moduleCivilianPresenceUnit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleCivilianPresenceUnit","revid":273928,"updated":"2021-06-13T01:13:37Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"","syntaxes":[{"syntax":"[] call BIS_fnc_moduleCivilianPresenceUnit","params":[],"returns":null}]},{"name":"BIS_fnc_moduleCombatGetIn","title":"BIS fnc moduleCombatGetIn","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleCombatGetIn","revid":309791,"updated":"2022-05-05T12:09:50Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleCountdown","title":"BIS fnc moduleCountdown","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleCountdown","revid":309832,"updated":"2022-05-05T12:09:52Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleCoverMap","title":"BIS fnc moduleCoverMap","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleCoverMap","revid":351893,"updated":"2024-01-20T08:51:29Z","groups":["Modules","Map and Markers"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"effect":"global"},"description":"Covers the map except for a defined area. This function was designed to be used by the Modules framework, but it can also be used without the module. The effect does not move with the centerObject.\n\n> [!IMPORTANT]\n> It is essential for the function to work that **centerObject** has the **objectArea** variable defined.\n>\n> ```sqf\n> centerObject setVariable [\"objectArea\", [sizeX, sizeY, rotation]]\n> ```\n>\n> - centerObject: Object - object which is used as center\n> - sizeX: Number - length in x in meters\n> - sizeY: Number - length in y in meters\n> - rotation: Number - shape's rotation in degree","syntaxes":[{"syntax":"[centerUnit, units, init] call BIS_fnc_moduleCoverMap","params":[{"name":"centerUnit","type":"Object","description":"object which is used as center","type_expr":"Object"},{"name":"units","type":"Array","description":"**Not used inside the function**","type_expr":"Array"},{"name":"init","type":"Boolean","description":"true to create cover map effect, false to remove all markers and destroy the effect","type_expr":"Boolean"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"```sqf\n// covers the whole map except an area of 1000m by 1000m\n// can be used to dynamically change size of the area during mission\ncenterObject setVariable [\"objectArea\",[1000, 1000, 0]];    // same format with triggerArea, except the function only needs first three\n[centerObject, [], true] call BIS_fnc_moduleCoverMap;\n```","code":["// covers the whole map except an area of 1000m by 1000m\n// can be used to dynamically change size of the area during mission\ncenterObject setVariable [\"objectArea\",[1000, 1000, 0]];\t// same format with triggerArea, except the function only needs first three\n[centerObject, [], true] call BIS_fnc_moduleCoverMap;"]}],"see_also":["showMap"]},{"name":"BIS_fnc_moduleCreateDiaryRecord","title":"BIS fnc moduleCreateDiaryRecord","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleCreateDiaryRecord","revid":309767,"updated":"2022-05-05T12:09:49Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleCreateProjectile","title":"BIS fnc moduleCreateProjectile","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleCreateProjectile","revid":309784,"updated":"2022-05-05T12:09:50Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleCurator","title":"BIS fnc moduleCurator","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleCurator","revid":309796,"updated":"2022-05-05T12:09:50Z","groups":["Modules - Curator"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleCuratorAddAddons","title":"BIS fnc moduleCuratorAddAddons","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleCuratorAddAddons","revid":309730,"updated":"2022-05-05T12:09:47Z","groups":["Modules - Curator"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleCuratorAddCameraArea","title":"BIS fnc moduleCuratorAddCameraArea","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleCuratorAddCameraArea","revid":309826,"updated":"2022-05-05T12:09:51Z","groups":["Modules - Curator"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleCuratorAddEditableObjects","title":"BIS fnc moduleCuratorAddEditableObjects","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleCuratorAddEditableObjects","revid":309733,"updated":"2022-05-05T12:09:47Z","groups":["Modules - Curator"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleCuratorAddEditingArea","title":"BIS fnc moduleCuratorAddEditingArea","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleCuratorAddEditingArea","revid":309737,"updated":"2022-05-05T12:09:48Z","groups":["Modules - Curator"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleCuratorAddEditingAreaPlayers","title":"BIS fnc moduleCuratorAddEditingAreaPlayers","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleCuratorAddEditingAreaPlayers","revid":309857,"updated":"2022-05-05T12:09:53Z","groups":["Modules - Curator"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleCuratorAddIcon","title":"BIS fnc moduleCuratorAddIcon","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleCuratorAddIcon","revid":309854,"updated":"2022-05-05T12:09:52Z","groups":["Modules - Curator"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleCuratorAddPoints","title":"BIS fnc moduleCuratorAddPoints","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleCuratorAddPoints","revid":309772,"updated":"2022-05-05T12:09:49Z","groups":["Modules - Curator"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleCuratorSetAttributes","title":"BIS fnc moduleCuratorSetAttributes","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleCuratorSetAttributes","revid":309765,"updated":"2022-05-05T12:09:49Z","groups":["Modules - Curator"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleCuratorSetCamera","title":"BIS fnc moduleCuratorSetCamera","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleCuratorSetCamera","revid":309888,"updated":"2022-05-05T12:09:54Z","groups":["Modules - Curator"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleCuratorSetCoefs","title":"BIS fnc moduleCuratorSetCoefs","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleCuratorSetCoefs","revid":309801,"updated":"2022-05-05T12:09:50Z","groups":["Modules - Curator"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleCuratorSetCostsDefault","title":"BIS fnc moduleCuratorSetCostsDefault","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleCuratorSetCostsDefault","revid":309823,"updated":"2022-05-05T12:09:51Z","groups":["Modules - Curator"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleCuratorSetCostsSide","title":"BIS fnc moduleCuratorSetCostsSide","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleCuratorSetCostsSide","revid":309819,"updated":"2022-05-05T12:09:51Z","groups":["Modules - Curator"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleCuratorSetCostsVehicleClass","title":"BIS fnc moduleCuratorSetCostsVehicleClass","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleCuratorSetCostsVehicleClass","revid":309760,"updated":"2022-05-05T12:09:49Z","groups":["Modules - Curator"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleCuratorSetEditingAreaType","title":"BIS fnc moduleCuratorSetEditingAreaType","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleCuratorSetEditingAreaType","revid":309704,"updated":"2022-05-05T12:09:44Z","groups":["Modules - Curator"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleCuratorSetObjectCost","title":"BIS fnc moduleCuratorSetObjectCost","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleCuratorSetObjectCost","revid":309742,"updated":"2022-05-05T12:09:48Z","groups":["Modules - Curator"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleDamage","title":"BIS fnc moduleDamage","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleDamage","revid":352163,"updated":"2024-02-01T23:25:25Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Damage given vehicles.\n\n> [!NOTE]\n> Regarding locality: if a hitpoint is defined,\n> Local argument setHitPointDamage is used. Else,\n> Global argument setDamage is used.","syntaxes":[{"syntax":"[logic, vehicles, isActivated] call BIS_fnc_moduleDamage","params":[{"name":"logic","type":"Object","description":"the logic. Possible setVariable parameter:\n\n- \"value\": Number - (Optional, default 0) wanted damage, in range 0..1\n- \"bodypart\": String - (Optional, default \"0\") setHitPointDamage hitpoint name","type_expr":"Object"},{"name":"vehicles","type":"Array of Objects","description":"list of vehicles","type_expr":"Array<Object>"},{"name":"isActivated","type":"Boolean","optional":true,"default":"true","description":"if true, the fuel is set","type_expr":"Boolean","text":"isActivated: Boolean - (Optional, default true) if true, the fuel is set"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when done, even if isActivated equals false","text":"Boolean - true when done, even if *isActivated* equals false"}}],"examples":[{"code":["[myLogic, vehicle player, true] call BIS_fnc_moduleDamage;"]}],"see_also":["setDamage","setHitPointDamage"]},{"name":"BIS_fnc_moduleDate","title":"BIS fnc moduleDate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleDate","revid":347968,"updated":"2023-11-08T09:35:12Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Used by the Date module.","syntaxes":[{"syntax":"[logic, null, activated] call BIS_fnc_moduleDate","params":[{"name":"logic","type":"Object","description":"date module","type_expr":"Object"},{"name":"null","type":"Anything","description":"not used","type_expr":"Anything"},{"name":"activated","type":"Boolean","optional":true,"default":"true","description":"if false nothing will happen","type_expr":"Boolean","text":"activated: Boolean - (Optional, default true) if false nothing will happen"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"always true"}}],"examples":[{"code":["[logic, nil, true] call BIS_fnc_moduleDate;"]}],"see_also":["Modules","Date"]},{"name":"BIS_fnc_moduleDiary","title":"BIS fnc moduleDiary","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleDiary","revid":309711,"updated":"2022-05-05T12:09:46Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleDoorOpen","title":"BIS fnc moduleDoorOpen","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleDoorOpen","revid":309894,"updated":"2022-05-05T12:09:54Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleEditTerrainObject","title":"BIS fnc moduleEditTerrainObject","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleEditTerrainObject","revid":274131,"updated":"2021-06-13T01:17:06Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Setups given terrain object.","syntaxes":[{"syntax":"[] call BIS_fnc_moduleEditTerrainObject","params":[],"returns":null}],"docblock":{"text":"Setups given terrain object."},"filled_from_docblock":["description"]},{"name":"BIS_fnc_moduleEffectsBubbles","title":"BIS fnc moduleEffectsBubbles","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleEffectsBubbles","revid":364220,"updated":"2024-05-06T09:38:11Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Creates underwater bubble effect on defined place (called usually by BIS_fnc_moduleEffectsEmitterCreator).\n\n> [!NOTE]\n> Mainly meant to be used by modules available in Eden Editor","syntaxes":[{"syntax":"[module] call BIS_fnc_moduleEffectsBubbles","params":[{"name":"module","type":"Object","description":"module","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[BIS_module] call BIS_fnc_moduleEffectsBubbles;"]}],"see_also":["Arma 3: Editor Modules","Arma 3: Module Framework","Eden Editor: System"]},{"name":"BIS_fnc_moduleEffectsEmitterCreator","title":"BIS fnc moduleEffectsEmitterCreator","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleEffectsEmitterCreator","revid":309856,"updated":"2022-05-05T12:09:53Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Module function. Creates particle emitters and calls effect function.","syntaxes":[{"syntax":"arg call BIS_fnc_moduleEffectsEmitterCreator","params":[{"name":"arg","type":"Object","types":["Object"],"optional":true,"description":"Module logic.\n_this select 1 (String) - Function name.\n_this select 2 (Number) - Optional - Number of emitters.","text":"_this select 0 (Object) - Module logic.\n_this select 1 (String) - Function name.\n_this select 2 (Number) - Optional - Number of emitters.","source":"docblock"}],"returns":{"type":"Nothing","types":["Nothing"],"text":"None.","source":"docblock"},"inferred":true}],"docblock":{"text":"File: fn_moduleEffectsEmitterCreator.sqf\n\nDescription:\nModule function. Creates particle emitters and calls effect function.\n\nParameter(s):\n_this select 0 (Object) - Module logic.\n_this select 1 (String) - Function name.\n_this select 2 (Number) - Optional - Number of emitters.\n\nReturned value:\nNone.","meta":{"file":"fn_moduleEffectsEmitterCreator.sqf"}},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_moduleEffectsFire","title":"BIS fnc moduleEffectsFire","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleEffectsFire","revid":352226,"updated":"2024-02-01T23:26:09Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Creates fire on position of module (called usually by BIS_fnc_moduleEffectsEmitterCreator).\n\n> [!NOTE]\n> Mainly meant to be used by modules available in Eden Editor","syntaxes":[{"syntax":"[module] call BIS_fnc_moduleEffectsFire","params":[{"name":"module","type":"Object","description":"module","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[BIS_module] call BIS_fnc_moduleEffectsFire;"]}],"see_also":["Modules","Eden Editor: System"]},{"name":"BIS_fnc_moduleEffectsPlankton","title":"BIS fnc moduleEffectsPlankton","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleEffectsPlankton","revid":352077,"updated":"2024-02-01T23:24:42Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Creates underwater plankton effect around player (called usually by BIS_fnc_moduleEffectsEmitterCreator).\n\n> [!NOTE]\n> Mainly meant to be used by modules available in Eden Editor","syntaxes":[{"syntax":"[module] call BIS_fnc_moduleEffectsPlankton","params":[{"name":"module","type":"Object","description":"module","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[BIS_module] call BIS_fnc_moduleEffectsPlankton;"]}],"see_also":["Modules","Eden Editor: System"]},{"name":"BIS_fnc_moduleEffectsShells","title":"BIS fnc moduleEffectsShells","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleEffectsShells","revid":352194,"updated":"2024-02-01T23:26:00Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Creates empty ammo cartridges on position of the module logic.\n\n> [!NOTE]\n> Mainly meant to be used by modules available in Eden Editor.","syntaxes":[{"syntax":"[module] call BIS_fnc_moduleEffectsShells","params":[{"name":"module","type":"Object","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[BIS_module] call BIS_fnc_moduleEffectsShells;"]}],"see_also":["Modules","Eden Editor: System"]},{"name":"BIS_fnc_moduleEffectsSmoke","title":"BIS fnc moduleEffectsSmoke","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleEffectsSmoke","revid":352193,"updated":"2024-02-01T23:25:58Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Creates smoke on position of module (called usually by BIS_fnc_moduleEffectsEmitterCreator).\n\n> [!NOTE]\n> Mainly meant to be used by modules available in Eden Editor","syntaxes":[{"syntax":"[module] call BIS_fnc_moduleEffectsSmoke","params":[{"name":"module","type":"Object","description":"module","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[BIS_module] call BIS_fnc_moduleEffectsSmoke;"]}],"see_also":["Modules","Eden Editor: System"]},{"name":"BIS_fnc_moduleEndMission","title":"BIS fnc moduleEndMission","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleEndMission","revid":309762,"updated":"2022-05-05T12:09:49Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleExecute","title":"BIS fnc moduleExecute","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleExecute","revid":309770,"updated":"2022-05-05T12:09:49Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleFDBalloonAirDestruction","title":"BIS fnc moduleFDBalloonAirDestruction","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleFDBalloonAirDestruction","revid":309814,"updated":"2022-05-05T12:09:51Z","groups":["Modules - Firing Drills"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleFDBalloonWaterDestruction","title":"BIS fnc moduleFDBalloonWaterDestruction","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleFDBalloonWaterDestruction","revid":309783,"updated":"2022-05-05T12:09:50Z","groups":["Modules - Firing Drills"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleFDCPClear","title":"BIS fnc moduleFDCPClear","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleFDCPClear","revid":309777,"updated":"2022-05-05T12:09:49Z","groups":["Modules - Firing Drills"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleFDCPIn","title":"BIS fnc moduleFDCPIn","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleFDCPIn","revid":309879,"updated":"2022-05-05T12:09:53Z","groups":["Modules - Firing Drills"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleFDCPOut","title":"BIS fnc moduleFDCPOut","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleFDCPOut","revid":309822,"updated":"2022-05-05T12:09:51Z","groups":["Modules - Firing Drills"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleFDFadeMarker","title":"BIS fnc moduleFDFadeMarker","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleFDFadeMarker","revid":328478,"updated":"2022-07-13T16:11:11Z","groups":["Modules - Firing Drills"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","exec":"spawn","description":"Gradually change the alpha of the given marker.","syntaxes":[{"syntax":"[markerName, alpha] spawn BIS_fnc_moduleFDFadeMarker","params":[{"name":"markerName","type":"String","type_expr":"String"},{"name":"alpha","type":"Number","description":"wanted marker alpha","type_expr":"Number"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when done"}}],"examples":[{"code":["[\"tankMarker\", 0.25] spawn BIS_fnc_moduleFDFadeMarker;"]},{"text":"Creates a pulsating marker:\n\n```sqf\n[] spawn\n{\n    while { alive enemyTank } do\n    {\n        [\"tankMarker\", 1] call BIS_fnc_moduleFDFadeMarker;\n        [\"tankMarker\", 0] call BIS_fnc_moduleFDFadeMarker;\n        sleep 0.05;\n    };\n    [\"tankMarker\", 0] call BIS_fnc_moduleFDFadeMarker;\n};\n```","code":["[] spawn \n{\n\twhile { alive enemyTank } do\n\t{\n\t\t[\"tankMarker\", 1] call BIS_fnc_moduleFDFadeMarker;\n\t\t[\"tankMarker\", 0] call BIS_fnc_moduleFDFadeMarker;\n\t\tsleep 0.05;\n\t};\n\t[\"tankMarker\", 0] call BIS_fnc_moduleFDFadeMarker;\n};"]}],"see_also":["markerAlpha","setMarkerAlpha"]},{"name":"BIS_fnc_moduleFDSkeetDestruction","title":"BIS fnc moduleFDSkeetDestruction","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleFDSkeetDestruction","revid":309754,"updated":"2022-05-05T12:09:48Z","groups":["Modules - Firing Drills"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleFDStatsClear","title":"BIS fnc moduleFDStatsClear","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleFDStatsClear","revid":309852,"updated":"2022-05-05T12:09:52Z","groups":["Modules - Firing Drills"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleFiringDrill","title":"BIS fnc moduleFiringDrill","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleFiringDrill","revid":309836,"updated":"2022-05-05T12:09:52Z","groups":["Modules - Firing Drills"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleFriendlyFire","title":"BIS fnc moduleFriendlyFire","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleFriendlyFire","revid":379568,"updated":"2026-10-31T13:56:44Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Handles friendly fire. This is the function of the Friendly Fire module (*ModuleFriendlyFire_F*): when the module is placed in the editor, it is called with the module logic and the units synchronised to the module are checked. It can also be called by scripts with one of the modes below.\n\"Init\" creates the global logic *BIS_FriendlyFire* and checks once per second whether the player committed friendly fire, which happens when:\n\n- the player becomes a renegade (side sideEnemy),\n- the player (or the player's vehicle or connected UAV) kills one of the checked men,\n- the player hits one of the checked vehicles whose priority is above 0, or hits it so that it can no longer move (canMove).\n\nThe mission then ends for everyone with the failed ending \"FriendlyFire\" (see BIS_fnc_endMission).\nEvery mode except \"Init\" returns false while the module is not initialised.","syntaxes":[{"syntax":"[\"Init\", [units, activated]] call BIS_fnc_moduleFriendlyFire","params":[{"name":"\"Init\"","type":"String","description":"initialises the module","type_expr":"String"},{"name":"units","type":"Array of Objects","optional":true,"default":"`[]`","description":"units and vehicles to check; the crew of a given vehicle is checked as well","type_expr":"Array<Object>","text":"units: Array of Objects - (Optional, default `[]`) units and vehicles to check; the crew of a given vehicle is checked as well"},{"name":"activated","type":"Boolean","optional":true,"default":"true","description":"not used","type_expr":"Boolean","text":"activated: Boolean - (Optional, default true) not used"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"false if the module was already initialised, otherwise true"}},{"syntax":"[\"Destroy\"] call BIS_fnc_moduleFriendlyFire","params":[{"name":"\"Destroy\"","type":"String","description":"deletes the module logic","type_expr":"String"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true"}},{"syntax":"[\"AddUnits\", [units]] call BIS_fnc_moduleFriendlyFire","params":[{"name":"\"AddUnits\"","type":"String","description":"adds units to the checked units","type_expr":"String"},{"name":"units","type":"Array of Objects","description":"units and vehicles to add (vehicle crews are not added)","type_expr":"Array<Object>"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true"}},{"syntax":"[\"RemoveUnits\", [units]] call BIS_fnc_moduleFriendlyFire","params":[{"name":"\"RemoveUnits\"","type":"String","description":"removes units from the checked units","type_expr":"String"},{"name":"units","type":"Array of Objects","description":"units to remove","type_expr":"Array<Object>"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true"}},{"syntax":"[\"ChangePriority\", [vehicle, priority]] call BIS_fnc_moduleFriendlyFire","params":[{"name":"\"ChangePriority\"","type":"String","description":"changes the priority of a checked vehicle","type_expr":"String"},{"name":"vehicle","type":"Object","description":"checked vehicle","type_expr":"Object"},{"name":"priority","type":"Number","optional":true,"default":"0","description":"if above 0, a single hit by the player counts as friendly fire","type_expr":"Number","text":"priority: Number - (Optional, default 0) if above 0, a single hit by the player counts as friendly fire"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true"}}],"examples":[{"text":"```sqf\n[\"Init\", [[BIS_vip1, BIS_vip2, BIS_vipCar]]] call BIS_fnc_moduleFriendlyFire;    // BIS_vip1, BIS_vip2, BIS_vipCar and its crew are checked\n[\"AddUnits\", [[BIS_vip3]]] call BIS_fnc_moduleFriendlyFire;                        // BIS_vip3 is checked too\n[\"ChangePriority\", [BIS_vipCar, 1]] call BIS_fnc_moduleFriendlyFire;            // one hit on BIS_vipCar is friendly fire\n[\"RemoveUnits\", [[BIS_vip1]]] call BIS_fnc_moduleFriendlyFire;                    // BIS_vip1 is no longer checked\n```","code":["[\"Init\", [[BIS_vip1, BIS_vip2, BIS_vipCar]]] call BIS_fnc_moduleFriendlyFire;\t// BIS_vip1, BIS_vip2, BIS_vipCar and its crew are checked\n[\"AddUnits\", [[BIS_vip3]]] call BIS_fnc_moduleFriendlyFire;\t\t\t\t\t\t// BIS_vip3 is checked too\n[\"ChangePriority\", [BIS_vipCar, 1]] call BIS_fnc_moduleFriendlyFire;\t\t\t// one hit on BIS_vipCar is friendly fire\n[\"RemoveUnits\", [[BIS_vip1]]] call BIS_fnc_moduleFriendlyFire;\t\t\t\t\t// BIS_vip1 is no longer checked"]},{"code":["[\"Init\", []] call BIS_fnc_moduleFriendlyFire; // only the renegade state is checked"]}],"see_also":["BIS_fnc_endMission","rating","addRating"]},{"name":"BIS_fnc_moduleFuel","title":"BIS fnc moduleFuel","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleFuel","revid":352070,"updated":"2024-02-01T23:24:40Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"local","effect":"global"},"description":"Set fuel of linked units' **vehicles**.\n\n> [!NOTE]\n> Regarding locality: unit's **vehicle** must be local to the machine, the unit itself can be remote.","syntaxes":[{"syntax":"[logic, units, isActivated] call BIS_fnc_moduleFuel","params":[{"name":"logic","type":"Object","description":"the logic. Possible setVariable parameter:\n\n- \"value\": Number - (Optional, default 0) wanted fuel level, in range 0..1","type_expr":"Object"},{"name":"units","type":"Array of Objects","description":"list of units","type_expr":"Array<Object>"},{"name":"isActivated","type":"Boolean","optional":true,"default":"true","description":"if true, the fuel is set","type_expr":"Boolean","text":"isActivated: Boolean - (Optional, default true) if true, the fuel is set"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when done, even if isActivated equals false","text":"Boolean - true when done, even if *isActivated* equals false"}}],"examples":[{"code":["[myLogic, [unit1, unit2, vehicle1], true] call BIS_fnc_moduleFuel;"]}],"see_also":["fuel","setFuel"]},{"name":"BIS_fnc_moduleGenericRadio","title":"BIS fnc moduleGenericRadio","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleGenericRadio","revid":309747,"updated":"2022-05-05T12:09:48Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleGrenade","title":"BIS fnc moduleGrenade","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleGrenade","revid":273959,"updated":"2021-06-13T01:14:09Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_moduleGrenade","params":[],"returns":null}]},{"name":"BIS_fnc_moduleGroupID","title":"BIS fnc moduleGroupID","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleGroupID","revid":309872,"updated":"2022-05-05T12:09:53Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleHandle","title":"BIS fnc moduleHandle","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleHandle","revid":309725,"updated":"2022-05-05T12:09:47Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleHealth","title":"BIS fnc moduleHealth","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleHealth","revid":309840,"updated":"2022-05-05T12:09:52Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleHideTerrainObjects","title":"BIS fnc moduleHideTerrainObjects","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleHideTerrainObjects","revid":273893,"updated":"2021-06-13T01:13:02Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"3DEN MOD: Hiddes closest terrain object.","syntaxes":[{"syntax":"[] call BIS_fnc_moduleHideTerrainObjects","params":[],"returns":null}],"docblock":{"text":"3DEN MOD: Hiddes closest terrain object."},"filled_from_docblock":["description"]},{"name":"BIS_fnc_moduleHint","title":"BIS fnc moduleHint","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleHint","revid":309795,"updated":"2022-05-05T12:09:50Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"```\n/*\n\n    Description:\n    Show a hint to all players of side\n\n    Parameter(s):\n    http://community.bistudio.com/wiki/Arma_3_Modules\n\n    Returns:\n    NONE\n*/\n\n// Parameters\n```","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleHQ","title":"BIS fnc moduleHQ","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleHQ","revid":309799,"updated":"2022-05-05T12:09:50Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Register or return side HQ speaker","syntaxes":[{"syntax":"[param0] call BIS_fnc_moduleHQ","params":[{"name":"param0","type":"Object, Side","type_expr":"Object | Side","description":"OBJECT - register the HQ\nSIDE - return HQ of the side","text":"0: OBJECT - register the HQ\nSIDE - return HQ of the side","source":"docblock"}],"returns":{"type":"Object","type_expr":"Object","description":"the HQ","text":"OBJECT - the HQ","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nRegister or return side HQ speaker\n\nParameter(s):\n    0:\n        OBJECT - register the HQ\n        SIDE - return HQ of the side\n\nReturns:\nOBJECT - the HQ"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_moduleHvtInit","title":"BIS fnc moduleHvtInit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleHvtInit","revid":274110,"updated":"2021-06-13T01:16:50Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_moduleHvtInit","params":[],"returns":null}]},{"name":"BIS_fnc_moduleHvtObjective","title":"BIS fnc moduleHvtObjective","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleHvtObjective","revid":273970,"updated":"2021-06-13T01:14:19Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","description":"","syntaxes":[{"syntax":"[] call BIS_fnc_moduleHvtObjective","params":[],"returns":null}],"docblock":{"text":", _objects"}},{"name":"BIS_fnc_moduleHvtObjectives","title":"BIS fnc moduleHvtObjectives","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleHvtObjectives","revid":274093,"updated":"2021-06-13T01:16:29Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_moduleHvtObjectives","params":[],"returns":null}]},{"name":"BIS_fnc_moduleHvtObjectivesInstance","title":"BIS fnc moduleHvtObjectivesInstance","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleHvtObjectivesInstance","revid":273990,"updated":"2021-06-13T01:14:42Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_moduleHvtObjectivesInstance","params":[],"returns":null}]},{"name":"BIS_fnc_moduleInit","title":"BIS fnc moduleInit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleInit","revid":309755,"updated":"2022-05-05T12:09:48Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleLightning","title":"BIS fnc moduleLightning","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleLightning","revid":373909,"updated":"2025-06-27T14:16:20Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","exec":"spawn","description":"Zeus lightning strike.\n\n> [!IMPORTANT]\n> Note that the *target* object will be deleted by the function (part of how Zeus modules work) if it can be edited by any curators (which is checked by the objectCurators command).","syntaxes":[{"syntax":"[target, nil, activate] call BIS_fnc_moduleLightning","params":[{"name":"target","type":"Object","description":"where the lightning bolt hits - **will** be deleted by the function!","type_expr":"Object"},{"name":"nil","type":"Nothing","description":"not used","type_expr":"Nothing"},{"name":"activate","type":"Boolean","description":"true to activate, false does nothing","type_expr":"Boolean"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"```sqf\nplayer addAction\n[\n    \"Eat that!\",\n    {\n        private _tempTarget = createSimpleObject [\"Land_HelipadEmpty_F\", getPosASL cursorTarget];\n        [_tempTarget, nil, true] spawn BIS_fnc_moduleLightning;\n        cursorTarget setDamage 1;\n    },\n    [],\n    1.5,\n    true,\n    true,\n    \"\",\n    \"!isNull cursorTarget\"\n];\n```","code":["player addAction \n[\n\t\"Eat that!\", \n\t{\n\t\tprivate _tempTarget = createSimpleObject [\"Land_HelipadEmpty_F\", getPosASL cursorTarget];\n\t\t[_tempTarget, nil, true] spawn BIS_fnc_moduleLightning;\n\t\tcursorTarget setDamage 1;\n\t},\n\t[],\n\t1.5, \n\ttrue, \n\ttrue, \n\t\"\",\n\t\"!isNull cursorTarget\"\n];"]},{"text":"```sqf\n[] spawn // Who gets hit first? ;-)\n{\n    {\n        private _tempTarget = createSimpleObject [\"Land_HelipadEmpty_F\", getPosASL _x];\n        [_tempTarget, nil, true] spawn BIS_fnc_moduleLightning;\n        sleep (1 + random 4);\n    } forEach (allPlayers call BIS_fnc_arrayShuffle);\n};\n```","code":["[] spawn // Who gets hit first? ;-)\n{\n\t{\n\t\tprivate _tempTarget = createSimpleObject [\"Land_HelipadEmpty_F\", getPosASL _x];\n\t\t[_tempTarget, nil, true] spawn BIS_fnc_moduleLightning;\n\t\tsleep (1 + random 4);\n\t} forEach (allPlayers call BIS_fnc_arrayShuffle);\n};"]}],"see_also":["Arma 3 Zeus"],"notes":[{"user":"Smith.UA","date":"2025-06-26T12:00:44Z","text":"Please note that the function makes the visual effects (lightning model and light) visible only to the client on which the function was executed.\nThe explosion sound, crater and damage will only be generated (globally) on the client where the target is local or the target curator is local to the client.\n\nIf you want to call lightning globally, you must call this function on all clients:\n\n```sqf\n// consider remoteExec limitations by CfgRemoteExec\n[target, nil, true] remoteExec [\"BIS_fnc_moduleLightning\"];\n```"}]},{"name":"BIS_fnc_moduleMine","title":"BIS fnc moduleMine","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleMine","revid":309830,"updated":"2022-05-05T12:09:52Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleMissionName","title":"BIS fnc moduleMissionName","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleMissionName","revid":309834,"updated":"2022-05-05T12:09:52Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleMode","title":"BIS fnc moduleMode","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleMode","revid":309878,"updated":"2022-05-05T12:09:53Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleModules","title":"BIS fnc moduleModules","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleModules","revid":379505,"updated":"2026-10-31T00:27:42Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Scans synchronized objects and returns synchronized modules","syntaxes":[{"syntax":"[module] call BIS_fnc_moduleModules","params":[],"returns":{"type":"Array of Objects","type_expr":"Array<Object>","description":"Modules"}}]},{"name":"BIS_fnc_moduleMPTypeDefense","title":"BIS fnc moduleMPTypeDefense","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleMPTypeDefense","revid":309838,"updated":"2022-05-05T12:09:52Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleMPTypeGameMaster","title":"BIS fnc moduleMPTypeGameMaster","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleMPTypeGameMaster","revid":309718,"updated":"2022-05-05T12:09:47Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleMPTypeGroundSupport","title":"BIS fnc moduleMPTypeGroundSupport","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleMPTypeGroundSupport","revid":309745,"updated":"2022-05-05T12:09:48Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"```\n// Debug log\n```","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleMPTypeGroundSupportBase","title":"BIS fnc moduleMPTypeGroundSupportBase","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleMPTypeGroundSupportBase","revid":309798,"updated":"2022-05-05T12:09:50Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleMPTypeSectorControl","title":"BIS fnc moduleMPTypeSectorControl","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleMPTypeSectorControl","revid":309824,"updated":"2022-05-05T12:09:51Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleMPTypeSeize","title":"BIS fnc moduleMPTypeSeize","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleMPTypeSeize","revid":309813,"updated":"2022-05-05T12:09:51Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleObjective","title":"BIS fnc moduleObjective","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleObjective","revid":309769,"updated":"2022-05-05T12:09:49Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleObjectiveFind","title":"BIS fnc moduleObjectiveFind","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleObjectiveFind","revid":309803,"updated":"2022-05-05T12:09:51Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleObjectiveGetIn","title":"BIS fnc moduleObjectiveGetIn","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleObjectiveGetIn","revid":309794,"updated":"2022-05-05T12:09:50Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleObjectiveMove","title":"BIS fnc moduleObjectiveMove","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleObjectiveMove","revid":309731,"updated":"2022-05-05T12:09:47Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleObjectiveRaceCP","title":"BIS fnc moduleObjectiveRaceCP","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleObjectiveRaceCP","revid":309779,"updated":"2022-05-05T12:09:49Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleObjectiveRaceFinish","title":"BIS fnc moduleObjectiveRaceFinish","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleObjectiveRaceFinish","revid":309722,"updated":"2022-05-05T12:09:47Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleObjectiveRaceStart","title":"BIS fnc moduleObjectiveRaceStart","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleObjectiveRaceStart","revid":309815,"updated":"2022-05-05T12:09:51Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleObjectiveSector","title":"BIS fnc moduleObjectiveSector","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleObjectiveSector","revid":309744,"updated":"2022-05-05T12:09:48Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleObjectiveTarget","title":"BIS fnc moduleObjectiveTarget","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleObjectiveTarget","revid":309728,"updated":"2022-05-05T12:09:47Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_modulePositioning","title":"BIS fnc modulePositioning","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_modulePositioning","revid":309820,"updated":"2022-05-05T12:09:51Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_modulePoster","title":"BIS fnc modulePoster","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_modulePoster","revid":309732,"updated":"2022-05-05T12:09:47Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_modulePostprocess","title":"BIS fnc modulePostprocess","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_modulePostprocess","revid":352172,"updated":"2024-02-01T23:25:38Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"> [!NOTE]\n> This function is used by the Post-Process module.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Editor Modules","Modules"]},{"name":"BIS_fnc_moduleProjectile","title":"BIS fnc moduleProjectile","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleProjectile","revid":309771,"updated":"2022-05-05T12:09:49Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_modulePunishment","title":"BIS fnc modulePunishment","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_modulePunishment","revid":309786,"updated":"2022-05-05T12:09:50Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"```\n/*\n\n    Description:\n    Make a unit play a punishment animation\n\n    Parameter(s):\n    http://community.bistudio.com/wiki/Arma_3_Modules\n\n    Returns:\n    NONE\n*/\n\n// Parameters\n```","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleRadioChannelCreate","title":"BIS fnc moduleRadioChannelCreate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleRadioChannelCreate","revid":309787,"updated":"2022-05-05T12:09:50Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleRank","title":"BIS fnc moduleRank","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleRank","revid":348277,"updated":"2023-11-08T11:40:38Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Used by the Set Rank module.","syntaxes":[{"syntax":"[logic, units, activated] call BIS_fnc_moduleRank","params":[{"name":"logic","type":"Object","description":"logic","type_expr":"Object"},{"name":"units","type":"Array","description":"units to set rank to","type_expr":"Array"},{"name":"activated","type":"Boolean","optional":true,"default":"true","description":"if false nothing will happen","type_expr":"Boolean","text":"activated: Boolean - (Optional, default true) if false nothing will happen"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"always true"}}],"examples":[{"code":["[rankLogic, [player]] call BIS_fnc_moduleRank;"]}],"see_also":["Modules"]},{"name":"BIS_fnc_moduleRating","title":"BIS fnc moduleRating","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleRating","revid":327571,"updated":"2022-07-12T22:39:18Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Function used by the Rating module.","syntaxes":[{"syntax":"[logic, units, activated] call BIS_fnc_moduleRating","params":[{"name":"logic","type":"Object","description":"a logic, but can be any object. Rating and Score are set with setVariable","type_expr":"Object"},{"name":"units","type":"Array of Objects","description":"units to add rating/score to","type_expr":"Array<Object>"},{"name":"activated","type":"Boolean","optional":true,"default":"true","description":"true to activate","type_expr":"Boolean","text":"activated: Boolean - (Optional, default true) true to activate"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when done"}}],"examples":[{"code":["[myLogic, units group player, true] call BIS_fnc_moduleRating;"]}],"see_also":["Arma 3: Editor Modules"]},{"name":"BIS_fnc_moduleRemoteControl","title":"BIS fnc moduleRemoteControl","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleRemoteControl","revid":309869,"updated":"2022-05-05T12:09:53Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleRespawnInventory","title":"BIS fnc moduleRespawnInventory","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleRespawnInventory","revid":309706,"updated":"2022-05-05T12:09:44Z","groups":["Respawn","Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Set respawn loadouts a curator can assign to players","syntaxes":[{"syntax":"[param0, param1] call BIS_fnc_moduleRespawnInventory","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"curator logic","text":"0: OBJECT - curator logic","source":"docblock"},{"name":"param1","type":"Boolean","type_expr":"Boolean","description":"true to make all loadouts availale, false to base them on units the curator can place","text":"1: BOOL - true to make all loadouts availale, false to base them on units the curator can place","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","text":"BOOL","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nSet respawn loadouts a curator can assign to players\n\nParameter(s):\n    0: OBJECT - curator logic\n    1: BOOL - true to make all loadouts availale, false to base them on units the curator can place\n\nReturns:\nBOOL"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_moduleRespawnPosition","title":"BIS fnc moduleRespawnPosition","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleRespawnPosition","revid":309873,"updated":"2022-05-05T12:09:53Z","groups":["Modules","Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleRespawnTickets","title":"BIS fnc moduleRespawnTickets","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleRespawnTickets","revid":309753,"updated":"2022-05-05T12:09:48Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleRespawnVehicle","title":"BIS fnc moduleRespawnVehicle","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleRespawnVehicle","revid":364509,"updated":"2024-05-16T20:42:07Z","groups":["Modules","Broken Functions"],"status":"broken","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Set vehicle respawn, compatible both with SP and MP.\n\n> [!NOTE]\n> Respawned abandoned vehicles do not reduce respawn tickets","syntaxes":[{"syntax":"[param0, param1, param2, param3, param4, param5, param6, param7, param8] call BIS_fnc_moduleRespawnVehicle","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"vehicle","text":"0: OBJECT - vehicle","source":"docblock"},{"name":"param1","type":"Number, Boolean","type_expr":"Number | Boolean","default":"0","description":"NUMBER - respawn delay in seconds (default is 0)\nBOOL - true to remove vehicle respawn (further params are ignored), false to check if the vehicle is marked for respawn","text":"1: NUMBER - respawn delay in seconds (default is 0)\nBOOL - true to remove vehicle respawn (further params are ignored), false to check if the vehicle is marked for respawn","source":"docblock"},{"name":"param2","type":"Number","type_expr":"Number","default":"-1, i.e., disabled","description":"how long until the vehicle is automatically respawned after its crew leaves it (default is -1, i.e., disabled)","text":"2: NUMBER - how long until the vehicle is automatically respawned after its crew leaves it (default is -1, i.e., disabled)","source":"docblock"},{"name":"param3","type":"Number","type_expr":"Number","default":"-1, i.e., unlimited","description":"number of time the vehicle can be respawned (default is -1, i.e., unlimited)","text":"3: NUMBER - number of time the vehicle can be respawned (default is -1, i.e., unlimited)","source":"docblock"},{"name":"param4","type":"Code","type_expr":"Code","description":"code executed upon respawn. Passed arguments are [<newVehicle>,<oldVehicle>]. The old vehicle is deleted only after this code is completed.","text":"4: CODE - code executed upon respawn. Passed arguments are [<newVehicle>,<oldVehicle>]. The old vehicle is deleted only after this code is completed.","source":"docblock"},{"name":"param5","type":"Position","type_expr":"Position","description":"type of respawn position:\n0 = where it started\n1 = where it was destroyed\n2 = on vehicle's side respawn marker (e.g., \"respawn_vehicle_west\")\n3 = on BLUFOR respawn marker\n4 = on OPFOR respawn marker\n5 = on Independent respawn marker\n6 = on Civilian respawn marker\n7 = on side respawn marker of unit which destroyed the vehicle","text":"5: POSITION - type of respawn position:\n0 = where it started\n1 = where it was destroyed\n2 = on vehicle's side respawn marker (e.g., \"respawn_vehicle_west\")\n3 = on BLUFOR respawn marker\n4 = on OPFOR respawn marker\n5 = on Independent respawn marker\n6 = on Civilian respawn marker\n7 = on side respawn marker of unit which destroyed the vehicle","source":"docblock"},{"name":"param6","type":"Number","type_expr":"Number","description":"position selection type (0 = random, 1 = newest, 2 = oldest)","text":"6: NUMBER - position selection type (0 = random, 1 = newest, 2 = oldest)","source":"docblock"},{"name":"param7","type":"Number","type_expr":"Number","description":"type of old vehicle deletion (0 = don't delete, 1 = delete, 2 = delete with an explosion effect)","text":"7: NUMBER - type of old vehicle deletion (0 = don't delete, 1 = delete, 2 = delete with an explosion effect)","source":"docblock"},{"name":"param8","type":"Boolean","type_expr":"Boolean","description":"true to show notifcation when the vehicle is respawned","text":"8: BOOL - true to show notifcation when the vehicle is respawned","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","text":"BOOL","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nSet vehicle respawn, compatible both with SP and MP.\n\nParameter(s):\n    0: OBJECT - vehicle\n    1:\n        NUMBER - respawn delay in seconds (default is 0)\n        BOOL - true to remove vehicle respawn (further params are ignored), false to check if the vehicle is marked for respawn\n    2: NUMBER - how long until the vehicle is automatically respawned after its crew leaves it (default is -1, i.e., disabled)\n    3: NUMBER - number of time the vehicle can be respawned (default is -1, i.e., unlimited)\n    4: CODE - code executed upon respawn. Passed arguments are [<newVehicle>,<oldVehicle>]. The old vehicle is deleted only after this code is completed.\n    5: POSITION - type of respawn position:\n        0 = where it started\n        1 = where it was destroyed\n        2 = on vehicle's side respawn marker (e.g., \"respawn_vehicle_west\")\n        3 = on BLUFOR respawn marker\n        4 = on OPFOR respawn marker\n        5 = on Independent respawn marker\n        6 = on Civilian respawn marker\n        7 = on side respawn marker of unit which destroyed the vehicle\n    6: NUMBER - position selection type (0 = random, 1 = newest, 2 = oldest)\n    7: NUMBER - type of old vehicle deletion (0 = don't delete, 1 = delete, 2 = delete with an explosion effect)\n    8: BOOL - true to show notifcation when the vehicle is respawned\n\nReturns:\nBOOL"},"filled_from_docblock":["params","syntax","returns","description"]},{"name":"BIS_fnc_moduleSaveGame","title":"BIS fnc moduleSaveGame","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleSaveGame","revid":348905,"updated":"2023-11-08T14:40:00Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Saves the game. Saving has to be enabled.","syntaxes":[{"syntax":"[nil,nil,activated] call BIS_fnc_moduleSaveGame","params":[{"name":"nil","type":"Nothing","description":"not used","type_expr":"Nothing"},{"name":"nil","type":"Nothing","description":"not used","type_expr":"Nothing"},{"name":"activated","type":"Boolean","optional":true,"default":"true","description":"when true game will be saved","type_expr":"Boolean","text":"activated: Boolean - (Optional, default true) when true game will be saved"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"always true"}}],"examples":[{"code":["call BIS_fnc_moduleSaveGame;"]}],"see_also":["saveGame","BIS_fnc_saveGame"]},{"name":"BIS_fnc_moduleSector","title":"BIS fnc moduleSector","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleSector","revid":309773,"updated":"2022-05-05T12:09:49Z","groups":["Modules"],"status":"ok","games":{"arma3":"0.76"},"since":"arma3 0.76","arma3_since":"0.76","description":"Initialize a sector module. Can be also used to get sector parameters.\n\n--- Get all sectors ---","syntaxes":[{"syntax":"[param0, param0, param0, param1, param0] call BIS_fnc_moduleSector","params":[{"name":"param0","type":"Boolean","type_expr":"Boolean","text":"0: BOOL","source":"docblock"},{"name":"param0","type":"Side","type_expr":"Side","text":"0: SIDE","source":"docblock"},{"name":"param0","type":"Object","type_expr":"Object","description":"sector module","text":"0: OBJECT - sector module","source":"docblock"},{"name":"param1","type":"Side","type_expr":"Side","text":"1: SIDE","source":"docblock"},{"name":"param0","type":"Object","type_expr":"Object","description":"sector module","text":"0: OBJECT - sector module","source":"docblock"}],"returns":{"type":"Array, Object","type_expr":"Array<Object>","text":"ARRAY of OBJECTs\n\n--- Get number of sectors held by a side ---\nNUMBER - number of sectors owned by the side\n\n--- Set sector owner ---\nBOOL\n\n--- Initialize ---\nNOTHING","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nInitialize a sector module. Can be also used to get sector parameters.\n\n--- Get all sectors ---\nParameter(s):\n    0: BOOL\n\nReturns:\nARRAY of OBJECTs\n\n--- Get number of sectors held by a side ---\nParameter(s):\n    0: SIDE\n\nReturns:\nNUMBER - number of sectors owned by the side\n\n--- Set sector owner ---\nParameter(s):\n    0: OBJECT - sector module\n    1: SIDE\n\nReturns:\nBOOL\n\n--- Initialize ---\nParameter(s):\n    0: OBJECT - sector module\n\nReturns:\nNOTHING"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_moduleSFX","title":"BIS fnc moduleSFX","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleSFX","revid":309816,"updated":"2022-05-05T12:09:51Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleShowHide","title":"BIS fnc moduleShowHide","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleShowHide","revid":309707,"updated":"2022-05-05T12:09:45Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleSimulationManager","title":"BIS fnc moduleSimulationManager","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleSimulationManager","revid":309811,"updated":"2022-05-05T12:09:51Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleSimulationManager_grab","title":"BIS fnc moduleSimulationManager grab","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleSimulationManager_grab","revid":274043,"updated":"2021-06-13T01:15:44Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_moduleSimulationManager_grab","params":[],"returns":null}]},{"name":"BIS_fnc_moduleSiteInit","title":"BIS fnc moduleSiteInit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleSiteInit","revid":274019,"updated":"2021-06-13T01:15:15Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_moduleSiteInit","params":[],"returns":null}]},{"name":"BIS_fnc_moduleSkill","title":"BIS fnc moduleSkill","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleSkill","revid":309882,"updated":"2022-05-05T12:09:54Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleSkiptime","title":"BIS fnc moduleSkiptime","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleSkiptime","revid":309717,"updated":"2022-05-05T12:09:47Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleSlingload","title":"BIS fnc moduleSlingload","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleSlingload","revid":273961,"updated":"2021-06-13T01:14:12Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.34"},"since":"arma3 1.34","arma3_since":"1.34","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_moduleSlingload","params":[],"returns":null}]},{"name":"BIS_fnc_moduleSound","title":"BIS fnc moduleSound","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleSound","revid":309848,"updated":"2022-05-05T12:09:52Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleSpawnAI","title":"BIS fnc moduleSpawnAI","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleSpawnAI","revid":273886,"updated":"2021-06-13T01:12:54Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.34"},"since":"arma3 1.34","arma3_since":"1.34","description":"DEBUG LOG FLAG","syntaxes":[{"syntax":"[] call BIS_fnc_moduleSpawnAI","params":[],"returns":null}],"docblock":{"text":"DEBUG LOG FLAG"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_moduleSpawnAIOptions","title":"BIS fnc moduleSpawnAIOptions","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleSpawnAIOptions","revid":274094,"updated":"2021-06-13T01:16:31Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.34"},"since":"arma3 1.34","arma3_since":"1.34","description":"TERMINATE ALL BUT 1ST MODULE","syntaxes":[{"syntax":"[] call BIS_fnc_moduleSpawnAIOptions","params":[],"returns":null}],"docblock":{"text":"TERMINATE ALL BUT 1ST MODULE"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_moduleSpawnAIPoint","title":"BIS fnc moduleSpawnAIPoint","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleSpawnAIPoint","revid":273921,"updated":"2021-06-13T01:13:31Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.34"},"since":"arma3 1.34","arma3_since":"1.34","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_moduleSpawnAIPoint","params":[],"returns":null}]},{"name":"BIS_fnc_moduleSpawnAISectorTactic","title":"BIS fnc moduleSpawnAISectorTactic","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleSpawnAISectorTactic","revid":274082,"updated":"2021-06-13T01:16:24Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.34"},"since":"arma3 1.34","arma3_since":"1.34","description":"RUN ONCE","syntaxes":[{"syntax":"[] call BIS_fnc_moduleSpawnAISectorTactic","params":[],"returns":null}],"docblock":{"text":"RUN ONCE"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_moduleStrategicMapImage","title":"BIS fnc moduleStrategicMapImage","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleStrategicMapImage","revid":309867,"updated":"2022-05-05T12:09:53Z","groups":["Modules - Strategic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleStrategicMapInit","title":"BIS fnc moduleStrategicMapInit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleStrategicMapInit","revid":309808,"updated":"2022-05-05T12:09:51Z","groups":["Modules - Strategic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleStrategicMapMission","title":"BIS fnc moduleStrategicMapMission","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleStrategicMapMission","revid":309825,"updated":"2022-05-05T12:09:51Z","groups":["Modules - Strategic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleStrategicMapOpen","title":"BIS fnc moduleStrategicMapOpen","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleStrategicMapOpen","revid":309861,"updated":"2022-05-05T12:09:53Z","groups":["Modules - Strategic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleStrategicMapORBAT","title":"BIS fnc moduleStrategicMapORBAT","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleStrategicMapORBAT","revid":309828,"updated":"2022-05-05T12:09:51Z","groups":["Modules - Strategic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleSupportsInitProvider","title":"BIS fnc moduleSupportsInitProvider","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleSupportsInitProvider","revid":274061,"updated":"2021-06-13T01:16:03Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_moduleSupportsInitProvider","params":[],"returns":null}]},{"name":"BIS_fnc_moduleSupportsInitProviderVirtual","title":"BIS fnc moduleSupportsInitProviderVirtual","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleSupportsInitProviderVirtual","revid":274042,"updated":"2021-06-13T01:15:41Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_moduleSupportsInitProviderVirtual","params":[],"returns":null}]},{"name":"BIS_fnc_moduleSupportsInitRequester","title":"BIS fnc moduleSupportsInitRequester","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleSupportsInitRequester","revid":273964,"updated":"2021-06-13T01:14:15Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_moduleSupportsInitRequester","params":[],"returns":null}]},{"name":"BIS_fnc_moduleTaskCreate","title":"BIS fnc moduleTaskCreate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleTaskCreate","revid":309776,"updated":"2022-05-05T12:09:49Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Create Task module function","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"Description:\nCreate Task module function"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_moduleTaskSetDescription","title":"BIS fnc moduleTaskSetDescription","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleTaskSetDescription","revid":309766,"updated":"2022-05-05T12:09:49Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Set Task Description module function","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"Description:\nSet Task Description module function"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_moduleTaskSetDestination","title":"BIS fnc moduleTaskSetDestination","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleTaskSetDestination","revid":309774,"updated":"2022-05-05T12:09:49Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Set Task Destination module function","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"Description:\nSet Task Destination module function"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_moduleTaskSetState","title":"BIS fnc moduleTaskSetState","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleTaskSetState","revid":309802,"updated":"2022-05-05T12:09:50Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Set Task State module function","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"Description:\nSet Task State module function"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_moduleTimeMultiplier","title":"BIS fnc moduleTimeMultiplier","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleTimeMultiplier","revid":274033,"updated":"2021-06-13T01:15:27Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_moduleTimeMultiplier","params":[],"returns":null}]},{"name":"BIS_fnc_moduleTimeTrial","title":"BIS fnc moduleTimeTrial","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleTimeTrial","revid":330749,"updated":"2022-11-01T15:22:38Z","groups":["Modules - Time Trials"],"status":"ok","games":{"arma3":"1.20"},"since":"arma3 1.20","arma3_since":"1.20","description":"> [!IMPORTANT]\n> Used for Time Trials, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}]},{"name":"BIS_fnc_moduleTracers","title":"BIS fnc moduleTracers","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleTracers","revid":327222,"updated":"2022-07-12T22:11:46Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Function used by the Tracers module.","syntaxes":[{"syntax":"[logic, activated] call BIS_fnc_moduleTracers","params":[{"name":"logic","type":"Object","description":"a logic, but can be any object","type_expr":"Object"},{"name":"activated","type":"Boolean","description":"true to activate","type_expr":"Boolean"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[myLogic, true] call BIS_fnc_moduleTracers;"]}],"see_also":["Arma 3: Editor Modules"]},{"name":"BIS_fnc_moduleTrident","title":"BIS fnc moduleTrident","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleTrident","revid":309865,"updated":"2022-05-05T12:09:53Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleTriggers","title":"BIS fnc moduleTriggers","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleTriggers","revid":309807,"updated":"2022-05-05T12:09:51Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleTTCPClear","title":"BIS fnc moduleTTCPClear","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleTTCPClear","revid":330745,"updated":"2022-11-01T15:22:38Z","groups":["Modules - Time Trials"],"status":"ok","games":{"arma3":"1.20"},"since":"arma3 1.20","arma3_since":"1.20","description":"> [!IMPORTANT]\n> Used for Time Trials, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}]},{"name":"BIS_fnc_moduleTTCPIn","title":"BIS fnc moduleTTCPIn","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleTTCPIn","revid":330747,"updated":"2022-11-01T15:22:38Z","groups":["Modules - Time Trials"],"status":"ok","games":{"arma3":"1.20"},"since":"arma3 1.20","arma3_since":"1.20","description":"> [!IMPORTANT]\n> Used for Time Trials, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}]},{"name":"BIS_fnc_moduleTTCPOut","title":"BIS fnc moduleTTCPOut","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleTTCPOut","revid":330744,"updated":"2022-11-01T15:22:38Z","groups":["Modules - Time Trials"],"status":"ok","games":{"arma3":"1.20"},"since":"arma3 1.20","arma3_since":"1.20","description":"> [!IMPORTANT]\n> Used for Time Trials, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}]},{"name":"BIS_fnc_moduleTTCPTrigger","title":"BIS fnc moduleTTCPTrigger","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleTTCPTrigger","revid":330743,"updated":"2022-11-01T15:22:38Z","groups":["Modules - Time Trials"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleTTCPTriggerBehind","title":"BIS fnc moduleTTCPTriggerBehind","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleTTCPTriggerBehind","revid":330746,"updated":"2022-11-01T15:22:38Z","groups":["Modules - Time Trials"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleTTStatsClear","title":"BIS fnc moduleTTStatsClear","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleTTStatsClear","revid":330748,"updated":"2022-11-01T15:22:38Z","groups":["Modules - Time Trials"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleUnits","title":"BIS fnc moduleUnits","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleUnits","revid":309842,"updated":"2022-05-05T12:09:52Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleUnlockArea","title":"BIS fnc moduleUnlockArea","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleUnlockArea","revid":309866,"updated":"2022-05-05T12:09:53Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleUnlockObject","title":"BIS fnc moduleUnlockObject","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleUnlockObject","revid":309877,"updated":"2022-05-05T12:09:53Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleVanguardFob","title":"BIS fnc moduleVanguardFob","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleVanguardFob","revid":274038,"updated":"2021-06-13T01:15:37Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"","syntaxes":[{"syntax":"[] call BIS_fnc_moduleVanguardFob","params":[],"returns":null}]},{"name":"BIS_fnc_moduleVanguardObjective","title":"BIS fnc moduleVanguardObjective","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleVanguardObjective","revid":273945,"updated":"2021-06-13T01:13:56Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"","syntaxes":[{"syntax":"[] call BIS_fnc_moduleVanguardObjective","params":[],"returns":null}]},{"name":"BIS_fnc_moduleVanguardScorePersistence","title":"BIS fnc moduleVanguardScorePersistence","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleVanguardScorePersistence","revid":274013,"updated":"2021-06-13T01:15:10Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"","syntaxes":[{"syntax":"[] call BIS_fnc_moduleVanguardScorePersistence","params":[],"returns":null}]},{"name":"BIS_fnc_moduleVolume","title":"BIS fnc moduleVolume","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleVolume","revid":309726,"updated":"2022-05-05T12:09:47Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleWeather","title":"BIS fnc moduleWeather","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleWeather","revid":309885,"updated":"2022-05-05T12:09:54Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Set overcast and fog","syntaxes":[{"syntax":"[param0] call BIS_fnc_moduleWeather","params":[{"name":"param0","type":"String","type_expr":"String","description":"mode, can be one of following\n\"enableDelay\" - enable delayed activation (i.e., weather changes are not applied manually and have to be confirmed by mission)\n    1: BOOL - true to enbale, false to disable","text":"0: STRING - mode, can be one of following\n\"enableDelay\" - enable delayed activation (i.e., weather changes are not applied manually and have to be confirmed by mission)\n    1: BOOL - true to enbale, false to disable","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","text":"Nothing\n\n        \"isDelayEnabled\"\ntrue if delayed activation is enabled, otherwise false\n\n        \"commit\" - apply weather changes\nNothing","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nSet overcast and fog\n\nParameter(s):\n    0: STRING - mode, can be one of following\n\n        \"enableDelay\" - enable delayed activation (i.e., weather changes are not applied manually and have to be confirmed by mission)\n            1: BOOL - true to enbale, false to disable\n            Returns: Nothing\n\n        \"isDelayEnabled\"\n            Returns: true if delayed activation is enabled, otherwise false\n\n        \"commit\" - apply weather changes\nReturns:\nNothing"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_moduleZoneProtection","title":"BIS fnc moduleZoneProtection","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleZoneProtection","revid":309827,"updated":"2022-05-05T12:09:51Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_moduleZoneRestriction","title":"BIS fnc moduleZoneRestriction","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moduleZoneRestriction","revid":309741,"updated":"2022-05-05T12:09:48Z","groups":["Modules"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_monthDays","title":"BIS fnc monthDays","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_monthDays","revid":328404,"updated":"2022-07-13T16:00:49Z","groups":["Math","Environment"],"status":"ok","games":{"arma3":"1.10"},"since":"arma3 1.10","arma3_since":"1.10","description":"Returns number of days in given month. Takes in account for leap year.","syntaxes":[{"syntax":"[year, month] call BIS_fnc_monthDays","params":[{"name":"year","type":"Number","description":"a non-decimal number","type_expr":"Number"},{"name":"month","type":"Number","description":"a non-decimal number in range 1..12","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number","description":"number of days in given month"}}],"examples":[{"code":["private _daysInThisMonth = [date select 0, date select 1] call BIS_fnc_monthDays;"]}],"see_also":["date","BIS_fnc_showTime","BIS_fnc_secondsToString"]},{"name":"BIS_fnc_moveAction","title":"BIS fnc moveAction","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moveAction","revid":327869,"updated":"2022-07-13T11:36:50Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Return current move action (used in playAction, playActionNow and switchAction)","syntaxes":[{"syntax":"[unit, returnConfig] call BIS_fnc_moveAction","params":[{"name":"unit","type":"Object","type_expr":"Object"},{"name":"returnConfig","type":"Boolean","optional":true,"default":"false","description":"true to return action config path, false to return the action name","type_expr":"Boolean","text":"returnConfig: Boolean - (Optional, default false) true to return action config path, false to return the action name"}],"returns":{"type":"Config or String","type_expr":"Config | String","description":"depends on returnConfig","text":"Config or String - depends on *returnConfig*"}}],"examples":[{"text":"```sqf\n_actionName        = [player, false] call BIS_fnc_moveAction;\n_actionConfig    = [player,  true] call BIS_fnc_moveAction;\n```","code":["_actionName\t\t= [player, false] call BIS_fnc_moveAction;\n_actionConfig\t= [player,  true] call BIS_fnc_moveAction;"]}],"see_also":["playAction","playActionNow","switchAction","playMove","switchMove"]},{"name":"BIS_fnc_moveIn","title":"BIS fnc moveIn","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moveIn","revid":327172,"updated":"2022-07-12T22:05:55Z","groups":["Object Manipulation"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","locality":{"argument":"local"},"description":"Moves a unit into vehicle. Compatible with assignedVehicleRole output.","syntaxes":[{"syntax":"[vehicle, unit, role] call BIS_fnc_moveIn","params":[{"name":"vehicle","type":"Object","type_expr":"Object"},{"name":"unit","type":"Object","description":"the unit to move into *vehicle* - must be local","type_expr":"Object"},{"name":"role","type":"Array","description":"wanted seat, in format [*\"role\"*] or [*\"role\"*, turretPath]. Can be one of:\n\n- \"driver\"\n- \"gunner\"\n- \"commander\"\n- \"cargo\"\n- \"turret\"\n- \"\": will load *unit* in the first available seat (using moveInAny)","type_expr":"Array"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if moved in successfully"}}],"examples":[{"code":["[myCar, player, \"cargo\"] call BIS_fnc_moveIn;"]},{"code":["[myTank, player, [\"turret\", [0]]] call BIS_fnc_moveIn;"]},{"code":["[myTank, player, [\"turret\", -1]] call BIS_fnc_moveIn; // will moveInDriver the player"]}],"see_also":["moveInDriver","moveInGunner","moveInCommander","moveInCargo","moveInTurret","moveInAny"]},{"name":"BIS_fnc_moveMarker","title":"BIS fnc moveMarker","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moveMarker","revid":351272,"updated":"2023-11-26T14:20:51Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","locality":{"argument":"global","effect":"global"},"description":"Moves marker to a new position","syntaxes":[{"syntax":"[marker, newPosition, duration, interpolationType] call BIS_fnc_moveMarker","params":[{"name":"marker","type":"String","description":"marker","type_expr":"String"},{"name":"newPosition","type":"Array","description":"new position","type_expr":"Array"},{"name":"duration","type":"Number","optional":true,"default":"5","description":"how long it takes to move the marker in seconds","type_expr":"Number","text":"duration: Number - (Optional, default 5) how long it takes to move the marker in seconds"},{"name":"interpolationType","type":"Number","optional":true,"default":"4","description":"can be one of:\n\n- 0: LINEAR\n- 1: CUBIC\n- 2: EASEIN\n- 3: EASEOUT\n- 4: EASEINOUT\n- 5: HERMITE\n- 6: BERP\n- 7: BOUNCEIN\n- 8: BOUNCEOUT\n- 9: BOUNCEINOUT\n- 10: QUINTICIN\n- 11: QUINTICOUT\n- 12: QUINTICINOUT","type_expr":"Number","text":"interpolationType: Number - (Optional, default 4) can be one of:\n\n- 0: LINEAR\n- 1: CUBIC\n- 2: EASEIN\n- 3: EASEOUT\n- 4: EASEINOUT\n- 5: HERMITE\n- 6: BERP\n- 7: BOUNCEIN\n- 8: BOUNCEOUT\n- 9: BOUNCEINOUT\n- 10: QUINTICIN\n- 11: QUINTICOUT\n- 12: QUINTICINOUT"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"BIS_marker\", [1111,2222,0]] call BIS_fnc_moveMarker;"]},{"code":["[\"BIS_marker\", getMarkerPos \"BIS_marker2\", 2, 9] call BIS_fnc_moveMarker;"]}],"see_also":["BIS_fnc_cancelMarker","BIS_fnc_blinkMarker","BIS_fnc_getMarkers","BIS_fnc_rotateMarker","BIS_fnc_resizeMarker"]},{"name":"BIS_fnc_moveToRespawnPosition","title":"BIS fnc moveToRespawnPosition","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_moveToRespawnPosition","revid":328433,"updated":"2022-07-13T16:00:51Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"local"},"description":"Move given unit to given respawn position. Units moved to height >= 30m will start on parachute. Position [0,0,0] is blacklisted. This function must be executed where unit to be moved is local.","syntaxes":[{"syntax":"[unit, position, canBeDead] call BIS_fnc_moveToRespawnPosition","params":[{"name":"unit","type":"Object","description":"unit to move","type_expr":"Object"},{"name":"position","type":"Object, Group, String or Array","description":"Object, Group, String or Array\n\n- Object or Group - Object or Group to move unit to. Move to the object position or inside an object if the object is a vehicle, or if group or unit is in vehicle and there is an empty seat\n- String - Marker to move unit to. Marker size will be used for random placement area and marker direction for unit direction\n- Array - Precise PositionAGL to move unit to. [x,y] array will be converted to [x,y,0]","type_expr":"Object | Group | String | Array","text":"position: Object, Group, String or Array\n\n- Object or Group - Object or Group to move unit to. Move to the object position or inside an object if the object is a vehicle, or if group or unit is in vehicle and there is an empty seat\n- String - Marker to move unit to. Marker size will be used for random placement area and marker direction for unit direction\n- Array - Precise PositionAGL to move unit to. [x,y] array will be converted to [x,y,0]"},{"name":"canBeDead","type":"Boolean","optional":true,"default":"true","description":"whether or not dead are allowed:\n\n- true - moved unit and/or object to which unit is moved can be dead\n- false - both moved unit and vehicle or unit at position (if any) must be alive","type_expr":"Boolean","text":"canBeDead: Boolean - (Optional, default true) whether or not dead are allowed:\n\n- true - moved unit and/or object to which unit is moved can be dead\n- false - both moved unit and vehicle or unit at position (if any) must be alive"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true: move succeeded, false: move failed"}}],"examples":[{"code":["[player, \"SpawnMarker1\"] call BIS_fnc_moveToRespawnPosition;"]}]},{"name":"BIS_fnc_MP","title":"BIS fnc MP","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_MP","revid":379275,"updated":"2026-10-30T23:44:51Z","groups":["Multiplayer"],"status":"deprecated","replaced_by":["remoteExec","remoteExecCall"],"games":{"arma3":"0.50"},"since":"arma3 0.50","arma3_since":"0.50","description":"Send function for remote execution (and executes locally if conditions are met).\n\n> [!WARNING]\n> Arma 3 v1.50 This function has been replaced by remoteExec and remoteExecCall. While BIS_fnc_MP still works (to provide backwards compatibility), it is now deprecated and should no longer be used. See Arma 3: Remote Execution for more information.","syntaxes":[{"syntax":"[params, functionName, target, isPersistent, isCall] call BIS_fnc_MP","params":[{"name":"params","type":"Anything","description":"function arguments. Variables can be local.","type_expr":"Anything","text":"**params**: Anything - function arguments. Variables can be local."},{"name":"functionName","type":"String","description":"function or scripting command name.","type_expr":"String","text":"**functionName**: String - function or scripting command name."},{"name":"target","type":"Object, String, Boolean, Number, Side, Group or Array","description":"Object, String, Boolean, Number, Side, Group or Array\n\n- Object - the function will be executed only where unit is local [default: everyone]\n- String - the function will be executed only where object or group defined by the variable with passed name is local\n- Boolean - true to execute on each machine (including the one where the function was called from), false to execute it on server only\n- Number - function will be executed only on client with the given owner ID\n- Side - function will be executed only on clients where the player is on the specified side\n- Group - function will be executed only on clients where the player is in the specified group\n- Array - array of targets of types listed above","type_expr":"Object | String | Boolean | Number | Side | Group | Array","text":"**target**: Object, String, Boolean, Number, Side, Group or Array\n\n- Object - the function will be executed only where unit is local [default: everyone]\n- String - the function will be executed only where object or group defined by the variable with passed name is local\n- Boolean - true to execute on each machine (including the one where the function was called from), false to execute it on server only\n- Number - function will be executed only on client with the given owner ID\n- Side - function will be executed only on clients where the player is on the specified side\n- Group - function will be executed only on clients where the player is in the specified group\n- Array - array of targets of types listed above"},{"name":"isPersistent","type":"Boolean","optional":true,"default":"false","description":"true for persistent call (will be called now and for every JIP client)","type_expr":"Boolean","text":"**isPersistent**: Boolean - (Optional, default false) true for persistent call (will be called now and for every JIP client)"},{"name":"isCall","type":"Boolean","optional":true,"default":"false","description":"true if function should be called on target machine, false to spawn it","type_expr":"Boolean","text":"**isCall**: Boolean - (Optional, default false) true if function should be called on target machine, false to spawn it"}],"returns":{"type":"Array","type_expr":"Array","description":"sent packet"}}],"examples":[{"code":["// logs a message for every player on the server.\n[\"Imma spamming your log!\", \"BIS_fnc_log\"] call BIS_fnc_MP;"]},{"code":["// send a hint containing \"Hello World\" to every player, including the ones who joins later using JIP.\n[\"Hello World\", \"hint\", true, true] call BIS_fnc_MP;"]},{"code":["// executes \"playerConnected.sqf\" script on server every time a player joins the game.\n[[[], \"playerConnected.sqf\"], \"BIS_fnc_execVM\", false, true] call BIS_fnc_MP;"]},{"code":["// adds action to every player including JIP. \"...\" = further optional arguments (see addAction)\n[[player], [\"My Action Title\", \"myAction.sqf\" /* etc */]], \"addAction\", true, true] call BIS_fnc_MP;"]}],"see_also":["BIS_fnc_MPexec","Arma 3 Remote Execution"],"notes":[{"user":"Fireball","date":"2013-04-02T19:02:00Z","text":"Note that the function you provide as argument is *not* transferred to the remote client or server.\n\nYou will have to use either\n\n1. functions defined in global namespace\n1. functions defined depending on where you want to execute them; in server or/and client code if you separate it using conditions on isServer or local player\n1. pre-defined BIS functions\n\nYou can also execute scripts remotely like this:\n\n```sqf\n[\"myScript.sqf\", \"BIS_fnc_execVM\", true, true] call BIS_fnc_MP;\n```\n\nOr transfer code as parameter (not recommended) like that:\n\n```sqf\n[{ hint \"Hello World!\"; }, \"BIS_fnc_spawn\", true, true] call BIS_fnc_MP;\n```"},{"user":"kylania","date":"2013-07-04T21:20:00Z","text":"> « One key note when designing a mission/script is to limit the amount of use you make of the isPersistent parameter. It is not recommended to use it often for vehicle creation, object creation, etc.\n> Each time you use the isPersistent parameter it adds to a BIS Logic which is used to sync all clients and new clients that join, excessive use of the command will make the logic build up and eventually you will cause the server to desync out because of the massive amount of data it has to send to all clients and JIP clients to try to keep them in sync.\n>\n> It is highly recommended to make as little use as possible of the isPersistent option unless you have to for network performance sake. » – [Tonic](http://forums.bistudio.com/member.php?75622-Tonic-_)"},{"user":"Killzone_Kid","date":"2013-12-10T13:37:00Z","text":"If you need to achieve a single global execution of an existing function on all PCs including your own, the syntax could not be any more simple than: [arguments, functionname] call BIS_fnc_MP; This is particularly useful with commands such as switchMove where the command effect is local.\n\nFor example to make sure animation is played on every PC, first define a global function on every PC (maybe inside init.sqf):\n\n```sqf\nswitchMoveEverywhere = compileFinal \"\n    _this select 0 switchMove (_this select 1);\n\";\n```\n\nThen execute BIS_fnc_MP on only one PC which will in return execute *switchMoveEverywhere* function everywhere:\n\n```sqf\n[\n    [\n        player,\n        \"AmovPercMstpSrasWrflDnon_AadjPpneMstpSrasWrflDleft\"\n    ],\n    \"switchMoveEverywhere\"\n] call BIS_fnc_MP;\n```"},{"user":"Waffle SS.","date":"2015-05-23T21:47:00Z","text":"Adding onto what Killzone_Kid said, a custom function isn't necessary when using only a single command.\n\n```sqf\n[\n    [player, \"AmovPercMstpSrasWrflDnon_AadjPpneMstpSrasWrflDleft\"],\n    \"switchMove\"\n] call BIS_fnc_MP;\n```"},{"user":"Warka","date":"2015-06-08T12:08:00Z","text":"From version 1.50 the function BIS_fnc_MP will use the engine based remote execution.\n\n- This will positively affect its performance, namely processing speed and amount of transferred data.\n- The syntax and functionality of BIS_fnc_MP will remain same to retain the backward compatibility.\n- To prevent abusing of the remoteExec and remoteExecCall commands the BIS_fnc_MP will use, the content authors will be able to define the operation modes as well as white-lists for commands/functions for clients and server separately.\n- White-lists defined in *CfgRemoteExecCommands* and *CfgRemoteExecFunctions* won't be supported from 1.48 as they will be replaced by the new structure more powerful and detailed structure: CfgRemoteExec."},{"user":"Waffle SS.","date":"2015-07-20T21:07:00Z","text":"Pay close attention to where and when you call BIS_fnc_MP. If you use it on the server during init, it will probably run before the player is loaded into the server, and the player behaves more like a JIP. Either waiting for the briefing to end (time > 0), or using the JIP parameter in BIS_fnc_MP are two ways of getting around this issue."}],"categories_extra":["Arma 3: Remote Execution","Introduced with Take On Helicopters version 1.00","Take On Helicopters: Functions","Take On Helicopters: New Functions"]},{"name":"BIS_fnc_MPexec","title":"BIS fnc MPexec","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_MPexec","revid":363814,"updated":"2024-04-22T18:52:30Z","groups":["Multiplayer"],"status":"deprecated","replaced_by":["remoteExec","remoteExecCall"],"games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Execute received remote execution. This function is used by BIS_fnc_MP and should not be called directly.\n\n> [!NOTE]\n> **Arma 3:** Obsolete and entirely effectless (empty file) since Arma 3 v1.52 and the introduction of remoteExec/remoteExecCall.","syntaxes":[{"syntax":"[packetName, packetValue] call BIS_fnc_MPexec","params":[{"name":"packetName","type":"String","description":"packet variable name - always \"BIS_fnc_MP_packet\" (not used in the function)","type_expr":"String"},{"name":"packetValue","type":"Array format [params, functionName, target, isSpawn, isPersistent]","description":"packet sent by BIS_fnc_MP; see its page for more details","type_expr":"Array"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if function was executed successfully"}}],"examples":[{"code":["[\"BIS_fnc_MP_packet\", [\"Hello World\", \"hint\", true, true]] call BIS_fnc_MPexec;"]}],"see_also":["BIS_fnc_MP","remoteExec","remoteExecCall"]},{"name":"BIS_fnc_multiplySquareMatrixByVector","title":"BIS fnc multiplySquareMatrixByVector","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_multiplySquareMatrixByVector","revid":273916,"updated":"2021-06-13T01:13:20Z","groups":["Vectors"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Multiplies the square matrix by a vector: A(m,m) x V(m)","syntaxes":[{"syntax":"[] call BIS_fnc_multiplySquareMatrixByVector","params":[{"name":"_matrix","type":"Array","type_expr":"Array","text":"0: ARRAY (multi-dimensional)","source":"docblock"},{"name":"_vector","type":"Array","type_expr":"Array","text":"1: ARRAY ([x,y,z] or [x,y,z,1])","source":"docblock"}],"returns":{"type":"Array","type_expr":"Array","text":"ARRAY [x,y,z]","source":"docblock"}}],"examples":[{"code":["[_transformMatrix, vectorDir player] call BIS_multiplySquareMatrixVector"]}],"docblock":{"text":"Author: Zozo\nMultiplies the square matrix by a vector: A(m,m) x V(m)\n\nArguments:\n0: _matrix ARRAY (multi-dimensional)\n1: _vector ARRAY ([x,y,z] or [x,y,z,1])\n\nReturn Value:\nARRAY [x,y,z]\n\nExample:\n[_transformMatrix, vectorDir player] call BIS_multiplySquareMatrixVector","author":"Zozo"},"filled_from_docblock":["description","params","returns","examples"]},{"name":"BIS_fnc_music","title":"BIS fnc music","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_music","revid":351904,"updated":"2024-01-23T11:34:10Z","groups":["Sound"],"status":"ok","games":{"arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2oa 1.50","arma3_since":"0.50","description":"Randomly play provided tracks defined in CfgMusic and does a 3 seconds fade out. This function takes accTime into account. See also BIS_fnc_jukebox.\n\n> [!NOTE]\n> The function stores the script handle in the `BIS_fnc_music_spawn` variable that can be used to stop the function; see Example 3 for its usage example.","syntaxes":[{"syntax":"[tracklist, delay] call BIS_fnc_music","params":[{"name":"tracklist","type":"Array of Strings","optional":true,"default":"all game musics","description":"a list of CfgMusic classes","type_expr":"Array<String>","text":"tracklist: Array of Strings - (Optional, default all game musics) a list of CfgMusic classes"},{"name":"delay","type":"Number","optional":true,"default":"3","description":"delay in seconds between tracks","type_expr":"Number","text":"delay: Number - (Optional, default 3) delay in seconds between tracks"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[[\"myMusic1\", \"myMusic2\"], 1] call BIS_fnc_music; // play the two musics in a random order"]},{"code":["[] call BIS_fnc_music; // play all game tracks randomly"]},{"code":["[] call BIS_fnc_music;\nprivate _startingPos = getPosWorld player;\nprivate _timeLimit = time + 30;\nwaitUntil { sleep 1; getPosWorld player distance _startingPos > 50 || time > _timeLimit };\nif (!isNil \"BIS_fnc_music_spawn\") then { terminate BIS_fnc_music_spawn };\nplayMusic \"\";"]}],"see_also":["playMusic","BIS_fnc_jukebox"]},{"name":"BIS_fnc_nearestHelipad","title":"BIS fnc nearestHelipad","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_nearestHelipad","revid":348117,"updated":"2023-11-08T11:32:17Z","groups":["Map and Markers"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Finds the nearest helipad of given type.","syntaxes":[{"syntax":"[position, radius, random, types] call BIS_fnc_nearestHelipad","params":[{"name":"position","type":"Array format Position","optional":true,"default":"position vehicle player","description":"center position","type_expr":"Position","types":["Array","Position"],"text":"position: Array format Position - (Optional, default position vehicle player) center position"},{"name":"radius","type":"Number","optional":true,"default":"999999","description":"radius of the area to search in meters","type_expr":"Number","text":"radius: Number - (Optional, default 999999) radius of the area to search in meters"},{"name":"random","type":"Boolean","optional":true,"default":"false","description":"if true a random helipad will be selected if multiple are found","type_expr":"Boolean","text":"random: Boolean - (Optional, default false) if true a random helipad will be selected if multiple are found"},{"name":"types","type":"Array","optional":true,"default":"[\"Heliport\"]","description":"location types to be searched for. See nearestLocations for more information\n\n> [!NOTE]\n> **Arma 3:** Default value won't work in Arma 3. Only types listed in CfgLocationTypes are supported","type_expr":"Array","text":"types: Array - (Optional, default [\"Heliport\"]) location types to be searched for. See nearestLocations for more information\n\n> [!NOTE]\n> **Arma 3:** Default value won't work in Arma 3. Only types listed in CfgLocationTypes are supported"}],"returns":{"type":"Array","type_expr":"Array","description":"in format:\n- 0: Position - Position of the selected location - 1: Object - Helipad - 2: Position - Position of the helipad","text":"Array in format:\n\n- 0: Position - Position of the selected location\n- 1: Object - Helipad\n- 2: Position - Position of the helipad"}}],"see_also":["nearestObjects"]},{"name":"BIS_fnc_nearestNum","title":"BIS fnc nearestNum","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_nearestNum","revid":328545,"updated":"2022-07-13T17:02:17Z","groups":["Arrays","Math"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Returns the provided set closest number to the target number.","syntaxes":[{"syntax":"[values, value] call BIS_fnc_nearestNum","params":[{"name":"values","type":"Array of Numbers","description":"values to choose from","type_expr":"Array<Number>"},{"name":"value","type":"Number","description":"the reference value","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number","description":"the closest value"}}],"examples":[{"code":["private _closestValueTo4 = [[1,5,10], 4] call BIS_fnc_nearestNum; // returns 5"]}],"see_also":["BIS_fnc_randomNum","random"]},{"name":"BIS_fnc_nearestPoint","title":"BIS fnc nearestPoint","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_nearestPoint","revid":328376,"updated":"2022-07-13T16:00:48Z","groups":["Geometry"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Computes nearest point in a line.","syntaxes":[{"syntax":"[start, end, point, is2D] call BIS_fnc_nearestPoint","params":[{"name":"start","type":"Position","description":"line start","type_expr":"Position"},{"name":"end","type":"Position","description":"line end","type_expr":"Position"},{"name":"point","type":"Position","description":"point to check against","type_expr":"Position"},{"name":"is2D","type":"Boolean","optional":true,"default":"false","description":"2D calculation instead of 3D","type_expr":"Boolean","text":"is2D: Boolean - (Optional, default false) 2D calculation instead of 3D"}],"returns":{"type":"Position","type_expr":"Position","description":"the line point that is closest to point","text":"Position - the line point that is closest to *point*"}}],"examples":[{"code":["private _idealLocation = [getMarkerPos \"base\", getMarkerPos \"destination\", getPos player, true] call BIS_fnc_nearestPoint;"]}],"see_also":["nearObjects","nearestObject","nearestObjects","BIS_fnc_nearestPosition","BIS_fnc_nearestNum","BIS_fnc_nearestRoad","BIS_fnc_nearestHelipad","BIS_fnc_isPosBlacklisted"]},{"name":"BIS_fnc_nearestPosition","title":"BIS fnc nearestPosition","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_nearestPosition","revid":328399,"updated":"2022-07-13T16:00:49Z","groups":["Positions"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Function to find the nearest Object or position from a list, when compared to a given reference.","syntaxes":[{"syntax":"[items, origin] call BIS_fnc_nearestPosition","params":[{"name":"items","type":"Array of Object, Location, Group, String (marker) and/or Position","description":"note that for a group, **leader's position** is used","type_expr":"Array<Object | Location | Group | String | Position>","text":"items: Array of Object, Location, Group, String (marker) **and/or** Position - note that for a group, **leader's position** is used"},{"name":"origin","type":"Object, Location, Group, String (marker) or Position","type_expr":"Object | Location | Group | String | Position"}],"returns":{"type":"Object, Location, Group, String (marker) or Position","type_expr":"Object | Location | Group | String | Position","description":"the closest from items","text":"Object, Location, Group, String (marker) or Position - the closest from *items*"}}],"examples":[{"code":["// Find the nearest marker from player\n_nearestMarker = [allMapMarkers, player] call BIS_fnc_nearestPosition;"]},{"code":["// Find the nearest marker to trigger using trigger onActivation code\n_nearestMarker = [allMapMarkers, thisTrigger] call BIS_fnc_nearestPosition;"]}],"see_also":["nearObjects","nearestObject","nearestObjects","BIS_fnc_nearestPoint","BIS_fnc_nearestNum","BIS_fnc_nearestRoad","BIS_fnc_nearestHelipad","BIS_fnc_isPosBlacklisted"]},{"name":"BIS_fnc_nearestRoad","title":"BIS fnc nearestRoad","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_nearestRoad","revid":378228,"updated":"2026-03-17T23:25:48Z","groups":["Positions"],"status":"ok","games":{"arma3":"0.76"},"since":"arma3 0.76","arma3_since":"0.76","description":"Find the nearest road segment to certain position, within given radius.","syntaxes":[{"syntax":"[centre, radius, blacklist] call BIS_fnc_nearestRoad","params":[{"name":"centre","type":"Position","type_expr":"Position"},{"name":"radius","type":"Number","optional":true,"default":"50","description":"search radius from *centre*","type_expr":"Number","text":"radius: Number - (Optional, default 50) search radius from *centre*"},{"name":"blacklist","type":"Array","optional":true,"default":"`[]`","description":"blacklisted road objects","type_expr":"Array","text":"blacklist: Array - (Optional, default `[]`) blacklisted road objects"}],"returns":{"type":"Object","type_expr":"Object","description":"nearest road object, objNull if not found"}}],"examples":[{"code":["private _nearestRoad = [getPosATL player, 500] call BIS_fnc_nearestRoad;"]},{"code":["private _nearestRoad = [getPosATL vehicle player, 50, getPosATL vehicle player nearRoads 20] call BIS_fnc_nearestRoad;"]}],"see_also":["nearRoads","isOnRoad","roadAt","roadsConnectedTo"]},{"name":"BIS_fnc_netId","title":"BIS fnc netId","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_netId","revid":327003,"updated":"2022-07-12T21:44:44Z","groups":["Multiplayer"],"status":"ok","games":{"arma3":"1.58"},"since":"arma3 1.58","arma3_since":"1.58","description":"Extends MP-only netId functionality to SP","syntaxes":[{"syntax":"objOrGrp call BIS_fnc_netId","params":[{"name":"objOrGrp","type":"Object or Group","type_expr":"Object | Group"}],"returns":{"type":"String","type_expr":"String","description":"net Id in format \"owner:id\" or \"\"."}}],"examples":[{"code":["private _objNetId = player call BIS_fnc_netId; // \"0:2\""]},{"code":["private _grpNetId = group player call BIS_fnc_netId; // \"0:3\""]}],"see_also":["netId","objectFromNetId","groupFromNetId","BIS_fnc_objectFromNetId","BIS_fnc_groupFromNetId"]},{"name":"BIS_fnc_neutralizeUnit","title":"BIS fnc neutralizeUnit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_neutralizeUnit","revid":352080,"updated":"2024-02-01T23:24:44Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Neutralize an object by intrinsic means:\n\n- soldiers are blown up by mine\n- vehicles are shelled by artillery\n- air units are hit by AA missile\n- underwater units are simply killed.\n\n> [!NOTE]\n> allowDamage will **not** prevent the unit getting killed.","syntaxes":[{"syntax":"object call BIS_fnc_neutralizeUnit","params":[{"name":"object","type":"Object","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["cursorTarget call BIS_fnc_neutralizeUnit;"]}],"see_also":["setDamage","allowDamage"]},{"name":"BIS_fnc_noFlyZone","title":"BIS fnc noFlyZone","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_noFlyZone","revid":309735,"updated":"2022-05-05T12:09:48Z","groups":["Map and Markers"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_noFlyZonesCreate","title":"BIS fnc noFlyZonesCreate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_noFlyZonesCreate","revid":309804,"updated":"2022-05-05T12:09:51Z","groups":["Map and Markers"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_noFlyZonesExport","title":"BIS fnc noFlyZonesExport","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_noFlyZonesExport","revid":309749,"updated":"2022-05-05T12:09:48Z","groups":["Map and Markers"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_numberDigits","title":"BIS fnc numberDigits","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_numberDigits","revid":379316,"updated":"2026-10-30T23:50:18Z","groups":["Arrays","Strings"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Break number into array of digits.","syntaxes":[{"syntax":"number call BIS_fnc_numberDigits","params":[{"name":"number","type":"Number","description":"number that should be broken down. A float will be **truncated**, not rounded","type_expr":"Number"}],"returns":{"type":"Array of Numbers","type_expr":"Array<Number>","description":"array of number digits","text":"Array of Numbers - array of *number* digits"}}],"examples":[{"code":["12345678 call BIS_fnc_numberDigits; // returns [1,2,3,4,5,6,7,8]"]},{"code":["123.9999 call BIS_fnc_numberDigits; // returns [1,2,3]"]}],"see_also":["BIS_fnc_numberText","BIS_fnc_cutDecimals"],"notes":[{"user":"vabene1111","date":"2018-03-20T21:25:00Z","text":"Use this function with caution: Numbers with more than 8 digits will return wrong results\n\n```sqf\n[11111111]      call BIS_fnc_numberDigits; // returns [1,1,1,1,1,1,1,1]\n[111111111]     call BIS_fnc_numberDigits; // returns [1,1,1,1,1,1,1,1,2]\n[1111111111111] call BIS_fnc_numberDigits; // returns [1,1,1,1,1,1,1,1,0,6,5,6,0]\n```"}]},{"name":"BIS_fnc_numberText","title":"BIS fnc numberText","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_numberText","revid":336883,"updated":"2023-01-04T16:43:51Z","groups":["Math","Strings"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Convert a number into string (avoiding scientific notation).","syntaxes":[{"syntax":"[number, modulo] call BIS_fnc_numberText","params":[{"name":"number","type":"Number","type_expr":"Number"},{"name":"modulo","type":"Number","optional":true,"default":"3","type_expr":"Number","text":"modulo: Number - (Optional, default 3)"}],"returns":{"type":"String","type_expr":"String"}}],"examples":[{"code":["[4096] call BIS_fnc_numberText; // \"4 096\""]},{"code":["[512, 1] call BIS_fnc_numberText; // \"5 1 2\""]},{"code":["[999999999999] call BIS_fnc_numberText; // \"909 999 995 904\""]},{"code":["[1234.5678] call BIS_fnc_numberText; // \"1 234\""]}],"problems":"It is very imprecise with larger numbers. See Example 3. It also does not work with floating point numbers.","see_also":["BIS_fnc_numberDigits","BIS_fnc_cutDecimals"]},{"name":"BIS_fnc_objectFromNetId","title":"BIS fnc objectFromNetId","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_objectFromNetId","revid":327046,"updated":"2022-07-12T21:44:46Z","groups":["Multiplayer"],"status":"ok","games":{"arma3":"1.58"},"since":"arma3 1.58","arma3_since":"1.58","description":"Extends MP-only objectFromNetId functionality to SP","syntaxes":[{"syntax":"netId call BIS_fnc_objectFromNetId","params":[{"name":"netId","type":"String","type_expr":"String"}],"returns":{"type":"Object","type_expr":"Object","description":"existing object or objNull"}}],"examples":[{"code":["private _obj = \"0:2\" call BIS_fnc_objectFromNetId;"]}],"see_also":["netId","objectFromNetId","groupFromNetId","BIS_fnc_netId","BIS_fnc_groupFromNetId"]},{"name":"BIS_fnc_objectHeight","title":"BIS fnc objectHeight","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_objectHeight","revid":348728,"updated":"2023-11-08T14:32:04Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Return object height defined by its bounding box and eventual offset fix. For the following classes an offset is used.\n\n| z-offset: -0.1 | z-offset: -0.08 |\n|---|---|\n| - \"box_east_support_f\"<br>- \"box_ind_support_f\"<br>- \"box_nato_support_f\"<br>- \"box_east_ammoord_f\"<br>- \"box_ind_ammoord_f\"<br>- \"box_nato_ammoord_f\"<br>- \"box_east_ammo_f\"<br>- \"box_ind_ammo_f\"<br>- \"box_nato_ammo_f | - \"box_east_wpslaunch_f\"<br>- \"box_ind_wpslaunch_f\"<br>- \"box_nato_wpslaunch_f\"<br>- \"box_east_wpsspecial_f\"<br>- \"box_ind_wpsspecial_f\"<br>- \"box_nato_wpsspecial_f\"<br>- \"box_ind_wps_f\"<br>- \"box_east_wps_f\"<br>- \"box_nato_wps_f\" |","syntaxes":[{"syntax":"object call BIS_fnc_objectHeight","params":[{"name":"object","type":"Object","description":"evaluated object","type_expr":"Object"}],"returns":{"type":"Number","type_expr":"Number","description":"height of the object"}}],"examples":[{"code":["player call BIS_fnc_objectHeight;"]}],"see_also":["boundingBox","sizeOf","boundingBoxReal","boundingCenter"]},{"name":"BIS_fnc_objectInventoryAnimatedClose","title":"BIS fnc objectInventoryAnimatedClose","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_objectInventoryAnimatedClose","revid":348584,"updated":"2023-11-08T13:42:15Z","groups":["Scripts"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"global","effect":"global"},"description":"Animates an object being closed, for example a drawer. The counter set by BIS_fnc_objectInventoryAnimatedOpen gets reset when this function is called.","syntaxes":[{"syntax":"[object, animationArray] call BIS_fnc_objectInventoryAnimatedClose","params":[{"name":"object","type":"Object","description":"object","type_expr":"Object"},{"name":"animationArray","type":"Array","description":"an Array in form of:\n0: String - Animation Name\n1: Number - Animation phase","type_expr":"Array"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"see_also":["BIS_fnc_objectInventoryAnimatedOpen"]},{"name":"BIS_fnc_objectInventoryAnimatedOpen","title":"BIS fnc objectInventoryAnimatedOpen","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_objectInventoryAnimatedOpen","revid":348567,"updated":"2023-11-08T13:42:07Z","groups":["Scripts"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"global","effect":"global"},"description":"Animates an object being opened, for example a drawer. It also sets a counter which prevents animation to be played multiple time if more than one player accesses that drawer.","syntaxes":[{"syntax":"[object, animationArray] call BIS_fnc_objectInventoryAnimatedOpen","params":[{"name":"object","type":"Object","description":"object","type_expr":"Object"},{"name":"animationArray","type":"Array","description":"an Array in form of:\n0: String - Animation Name\n1: Number - Animation phase","type_expr":"Array"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"see_also":["BIS_fnc_objectInventoryAnimatedClose"]},{"name":"BIS_fnc_objectsGrabber","title":"BIS fnc objectsGrabber","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_objectsGrabber","revid":330763,"updated":"2022-11-01T15:44:49Z","groups":["Object Manipulation"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Converts a set of placed objects to an object array (**as a String**) for the DynO mapper.\nFormat is the following. First, the header:\n\nThen, data:\n\n```sqf\n[\n    [\"B_UAV_01_F\",[-5.23706,-0.183594,-0.00126648],167.39,1,0,[0.605018,-0.575293],\"\",\"\",true,false],\n    [\"C_Offroad_01_F\",[-4.25903,4.62158,0.0630951],224.14,1,0,[0.812812,0.190543],\"\",\"\",true,false]\n]\n```\n\nor, if object orientation is not used:\n\n```sqf\n[\n    [\"B_UAV_01_F\",[-5.23706,-0.183594,-0.00126648],167.39,1,0,[],\"\",\"\",true,false],\n    [\"C_Offroad_01_F\",[-4.25903,4.62158,0.0630951],224.14,1,0,[],\"\",\"\",true,false]\n]\n```","syntaxes":[{"syntax":"[position, size, objectOrientation] call BIS_fnc_objectsGrabber","params":[{"name":"position","type":"Position","optional":true,"default":"[0,0]","description":"2D or 3D position, center of the \"grabbing\" area","type_expr":"Position","text":"position: Position - (Optional, default [0,0]) 2D or 3D position, center of the \"grabbing\" area"},{"name":"size","type":"Number","optional":true,"default":"50","description":"size (radius) of the \"grabbing\" area","type_expr":"Number","text":"size: Number - (Optional, default 50) size (radius) of the \"grabbing\" area"},{"name":"objectOrientation","type":"Boolean","optional":true,"default":"false","description":"capture object orientation or not. Format BIS_fnc_getPitchBank","type_expr":"Boolean","text":"objectOrientation: Boolean - (Optional, default false) capture object orientation or not. Format BIS_fnc_getPitchBank"}],"returns":{"type":"String","type_expr":"String","description":"arrays are in format [classname, relPos, azimuth, fuel, damage, pitchBankResult, vehicleVarName, initCommands, simulationEnabled, isASL]:\n- classname: String - relPos: Array - azimuth: Number - fuel: Number - damage: Number - pitchBankResult: Array - return from BIS_fnc_getPitchBank (only if objectOrientation is true) - vehicleVarName: String - initCommands: String - simulationEnabled: Boolean - isASL: Boolean","text":"String - arrays are in format [classname, relPos, azimuth, fuel, damage, pitchBankResult, vehicleVarName, initCommands, simulationEnabled, isASL]:\n\n- classname: String\n- relPos: Array\n- azimuth: Number\n- fuel: Number\n- damage: Number\n- pitchBankResult: Array - return from BIS_fnc_getPitchBank (only if *objectOrientation* is true)\n- vehicleVarName: String\n- initCommands: String\n- simulationEnabled: Boolean\n- isASL: Boolean"}}],"examples":[{"code":["[getPos player, 20, true] call BIS_fnc_objectsGrabber;"]}],"see_also":["BIS_fnc_objectsMapper","BIS_fnc_getPitchBank","BIS_fnc_setPitchBank"],"docblock":{"text":"Grab data:\nMission: TheMissionName\nWorld: Stratis\nAnchor position: [3781.59, 3289.67]\nArea size: 50\nUsing orientation of objects: yes/no"}},{"name":"BIS_fnc_objectSide","title":"BIS fnc objectSide","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_objectSide","revid":379506,"updated":"2026-10-31T00:27:50Z","groups":["Sides"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns object side as defined in config (i.e. not affected by dynamic changing like rating)","syntaxes":[{"syntax":"[target, boolean] call BIS_fnc_objectSide","params":[{"name":"target","type":"Object","description":"the object to be tested","type_expr":"Object"},{"name":"boolean","type":"Boolean","optional":true,"default":"false","description":"false to return actual object side, true to return the default config value","type_expr":"Boolean","text":"boolean: Boolean - (Optional, default false) false to return actual object side, true to return the default config value"}],"returns":{"type":"Side","type_expr":"Side"}},{"syntax":"target call BIS_fnc_objectSide","params":[{"name":"target","type":"Object","description":"the object to be tested. This syntax is equal to calling the method with false as a second parameter.","type_expr":"Object"}],"returns":{"type":"Side","type_expr":"Side"}}],"examples":[{"code":["private _realVehicleSide = [vehicle player, true] call BIS_fnc_objectSide;"]},{"code":["private _unknownSide = [objNull, false] call BIS_fnc_objectSide; // will return sideUnknown\nprivate _eastSide    = [objNull, true]  call BIS_fnc_objectSide; // will return east"]},{"code":["// same results\n_result1 = myVehicle call BIS_fnc_objectSide;\n_result2 = [myVehicle] call BIS_fnc_objectSide;\n_result3 = [myVehicle, false] call BIS_fnc_objectSide;"]}],"see_also":["side","CfgVehicles Config Reference","Side","playerSide","west","east","resistance","civilian","sideLogic","sideFriendly","sideEnemy","sideUnknown","sideEmpty","sideAmbientLife","Side Relations","BIS_fnc_sideID"],"notes":[{"user":"Tankbuster","date":"2020-04-01T17:25:00Z","text":"When using this to get the side of vehicle drivers, be aware that when the boolean parameter is true, empty vehicles will return their driver as east.\nThe same vehicle, when the boolean parameter is false, will return \"UNKNOWN\""}]},{"name":"BIS_fnc_objectsMapper","title":"BIS fnc objectsMapper","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_objectsMapper","revid":348023,"updated":"2023-11-08T11:22:59Z","groups":["Object Manipulation"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Takes an array of data about a dynamic object template and creates the objects.","syntaxes":[{"syntax":"[position, azimuth, objectsArray, badChance] call BIS_fnc_objectsMapper","params":[{"name":"position","type":"Array","optional":true,"default":"[0,0]","description":"in format Position2D","type_expr":"Array","text":"position: Array - (Optional, default [0,0]) in format Position2D"},{"name":"azimuth","type":"Number","optional":true,"default":"0","description":"the template orientation","type_expr":"Number","text":"azimuth: Number - (Optional, default 0) the template orientation"},{"name":"objectsArray","type":"Array","description":"created with BIS_fnc_objectsGrabber","type_expr":"Array"},{"name":"badChance","type":"Number","optional":true,"default":"0","description":"chances of object non-creation for each object, in range 0..1","type_expr":"Number","text":"badChance: Number - (Optional, default 0) chances of object non-creation for each object, in range 0..1"}],"returns":{"type":"Array of Objects","type_expr":"Array<Object>"}}],"examples":[{"text":"```sqf\nprivate _objectsArray = [\n    [\"B_UAV_01_F\",[-5.23706,-0.183594,-0.00126648],167.39,1,0,[],\"\",\"\",true,false],\n    [\"C_Offroad_01_F\",[-4.25903,4.62158,0.0630951],224.14,1,0,[],\"\",\"\",true,false]\n];\n[getMarkerPos \"myBase\", 0, _objectsArray, 0.5] call BIS_fnc_objectsMapper;\n```","code":["private _objectsArray = [\n\t[\"B_UAV_01_F\",[-5.23706,-0.183594,-0.00126648],167.39,1,0,[],\"\",\"\",true,false], \n\t[\"C_Offroad_01_F\",[-4.25903,4.62158,0.0630951],224.14,1,0,[],\"\",\"\",true,false]\n];\n[getMarkerPos \"myBase\", 0, _objectsArray, 0.5] call BIS_fnc_objectsMapper;"]}],"see_also":["BIS_fnc_objectsGrabber"]},{"name":"BIS_fnc_objectType","title":"BIS fnc objectType","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_objectType","revid":327120,"updated":"2022-07-12T21:44:51Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.08"},"since":"arma3 1.08","arma3_since":"1.08","description":"Return object category and type.","syntaxes":[{"syntax":"anObject call BIS_fnc_objectType","params":[{"name":"anObject","type":"String or Object","type_expr":"String | Object"}],"returns":{"type":"Array","type_expr":"Array","description":"in format [category, type]. One of:\n| Soldier | Vehicle / VehicleAutonomous | Logic | Object | |---|---|---|---| | - AT<br>- Civilian<br>- Diver<br>- Infantry<br>- Medic<br>- MG<br>- Officer<br>- Pilot<br>- Sniper<br>- SpecialForces<br>- UAVPilot | - Car<br>- Helicopter<br>- Motorcycle<br>- Plane<br>- Ship<br>- StaticWeapon<br>- Submarine<br>- TrackedAPC<br>- Tank<br>- WheeledAPC | - Logic<br>- Module | - Ammobox<br>- Animal<br>- Backpack<br>- Camera<br>- Church<br>- Effect<br>- Fire<br>- Flag<br>- Helipad<br>- House<br>- Marker<br>- Mine<br>- Parachute<br>- Seagull<br>- Sound<br>- Target<br>- Thing<br>- Trigger<br>- UnknownObject<br>- VASI<br>- Wreck |","text":"Array - in format [category, type]. One of:\n\n| Soldier | Vehicle / VehicleAutonomous | Logic | Object |\n|---|---|---|---|\n| - AT<br>- Civilian<br>- Diver<br>- Infantry<br>- Medic<br>- MG<br>- Officer<br>- Pilot<br>- Sniper<br>- SpecialForces<br>- UAVPilot | - Car<br>- Helicopter<br>- Motorcycle<br>- Plane<br>- Ship<br>- StaticWeapon<br>- Submarine<br>- TrackedAPC<br>- Tank<br>- WheeledAPC | - Logic<br>- Module | - Ammobox<br>- Animal<br>- Backpack<br>- Camera<br>- Church<br>- Effect<br>- Fire<br>- Flag<br>- Helipad<br>- House<br>- Marker<br>- Mine<br>- Parachute<br>- Seagull<br>- Sound<br>- Target<br>- Thing<br>- Trigger<br>- UnknownObject<br>- VASI<br>- Wreck |"}}],"examples":[{"code":["private _myType = player call BIS_fnc_objectType;"]},{"code":["private _myType = \"B_MRAP_01_F\" call BIS_fnc_objectType;"]}],"see_also":["typeOf","countType","isKindOf"]},{"name":"BIS_fnc_objectVar","title":"BIS fnc objectVar","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_objectVar","revid":328361,"updated":"2022-07-13T16:00:47Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Return a unique object variable. The variable is preserved after unit respawn.","syntaxes":[{"syntax":"[object, varNameRoot] call BIS_fnc_objectVar","params":[{"name":"object","type":"Object","type_expr":"Object"},{"name":"varNameRoot","type":"String","optional":true,"default":"\"bis_o\"","description":"variable name root - a number will be added behind it","type_expr":"String","text":"varNameRoot: String - (Optional, default \"bis_o\") - variable name root - a number will be added behind it"}],"returns":{"type":"String","type_expr":"String","description":"generated variable name"}}],"examples":[{"code":["hint str (player call BIS_fnc_objectVar); // \"bis_o1\"\nhint str (player == (missionNamespace getVariable \"bis_o1\")); // true"]}],"see_also":["netId","objectFromNetId","setVariable","setVehicleVarName"]},{"name":"BIS_fnc_OM_addLoadedEH","title":"BIS fnc OM addLoadedEH","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_addLoadedEH","revid":278853,"updated":"2021-06-13T21:43:53Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_allInfectedDeadCode","title":"BIS fnc OM allInfectedDeadCode","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_allInfectedDeadCode","revid":278870,"updated":"2021-06-13T21:44:09Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_AS_ShowStaticText","title":"BIS fnc OM AS ShowStaticText","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_AS_ShowStaticText","revid":278837,"updated":"2021-06-13T21:43:40Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_BuildSectorsData","title":"BIS fnc OM BuildSectorsData","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_BuildSectorsData","revid":278896,"updated":"2021-06-13T21:44:32Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_camera","title":"BIS fnc OM camera","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_camera","revid":273044,"updated":"2021-06-13T00:36:49Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"","syntaxes":[{"syntax":"","params":[],"returns":null}],"categories_extra":["Stubs"]},{"name":"BIS_fnc_OM_conversation","title":"BIS fnc OM conversation","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_conversation","revid":278869,"updated":"2021-06-13T21:44:09Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_createConversation","title":"BIS fnc OM createConversation","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_createConversation","revid":278842,"updated":"2021-06-13T21:43:46Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_credits","title":"BIS fnc OM credits","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_credits","revid":278898,"updated":"2021-06-13T21:44:35Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_Epicentrum","title":"BIS fnc OM Epicentrum","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_Epicentrum","revid":278867,"updated":"2021-06-13T21:44:08Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_EXEC","title":"BIS fnc OM EXEC","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_EXEC","revid":278882,"updated":"2021-06-13T21:44:24Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_HandleMapControls","title":"BIS fnc OM HandleMapControls","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_HandleMapControls","revid":278878,"updated":"2021-06-13T21:44:23Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_infectedGroupHandle","title":"BIS fnc OM infectedGroupHandle","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_infectedGroupHandle","revid":278848,"updated":"2021-06-13T21:43:50Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_init","title":"BIS fnc OM init","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_init","revid":278889,"updated":"2021-06-13T21:44:28Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_medicineDeliveredCode","title":"BIS fnc OM medicineDeliveredCode","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_medicineDeliveredCode","revid":278839,"updated":"2021-06-13T21:43:42Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_medicineRanOutCode","title":"BIS fnc OM medicineRanOutCode","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_medicineRanOutCode","revid":278865,"updated":"2021-06-13T21:44:05Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_Module_initSmallValueSilder","title":"BIS fnc OM Module initSmallValueSilder","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_Module_initSmallValueSilder","revid":349121,"updated":"2023-11-08T14:49:39Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"Initialize slider with edit box showing its value supporting small decimal numbers.","syntaxes":[{"syntax":"[ctrlSlider, ctrlEdit, unit, defaultValue] call BIS_fnc_OM_Module_initSmallValueSilder","params":[{"name":"ctrlSlider","type":"Control","description":"slider Control","type_expr":"Control"},{"name":"ctrlEdit","type":"Control","description":"edit Control","type_expr":"Control"},{"name":"unit","type":"String","optional":true,"default":"\"%\"","description":"measurement unit added behind the number","type_expr":"String","text":"unit: String - (Optional, default \"%\") measurement unit added behind the number"},{"name":"defaultValue","type":"Number","optional":true,"default":"nil","description":"when present, only the value is set, functionality is not initialized","type_expr":"Number","text":"defaultValue: Number - (Optional, default nil) when present, only the value is set, functionality is not initialized"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[_ctrlSlider,_ctrlEdit,\"m\",500] call BIS_fnc_OM_Module_initSmallValueSilder;//Set default value only."]},{"code":["[_ctrlSlider,_ctrlEdit,\"m\"] call BIS_fnc_OM_Module_initSmallValueSilder;//Initialize functionality."]}],"see_also":["BIS_fnc_initSliderValue"]},{"name":"BIS_fnc_OM_moduleActionQueue","title":"BIS fnc OM moduleActionQueue","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_moduleActionQueue","revid":278847,"updated":"2021-06-13T21:43:50Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_moduleAwareness","title":"BIS fnc OM moduleAwareness","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_moduleAwareness","revid":278858,"updated":"2021-06-13T21:43:58Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_moduleCheckpoint_checkAngleToObject","title":"BIS fnc OM moduleCheckpoint checkAngleToObject","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_moduleCheckpoint_checkAngleToObject","revid":278836,"updated":"2021-06-13T21:43:39Z","groups":["Checkpoint"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_moduleCheckpoint_checkDistanceFromObject","title":"BIS fnc OM moduleCheckpoint checkDistanceFromObject","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_moduleCheckpoint_checkDistanceFromObject","revid":278879,"updated":"2021-06-13T21:44:23Z","groups":["Checkpoint"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_moduleCheckpoint_handleStates","title":"BIS fnc OM moduleCheckpoint handleStates","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_moduleCheckpoint_handleStates","revid":278849,"updated":"2021-06-13T21:43:51Z","groups":["Checkpoint"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_moduleCheckpoint_intersect","title":"BIS fnc OM moduleCheckpoint intersect","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_moduleCheckpoint_intersect","revid":278910,"updated":"2021-06-13T21:44:42Z","groups":["Checkpoint"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_moduleCheckpoint_navigateVehicleToCheck","title":"BIS fnc OM moduleCheckpoint navigateVehicleToCheck","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_moduleCheckpoint_navigateVehicleToCheck","revid":278886,"updated":"2021-06-13T21:44:27Z","groups":["Checkpoint"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_moduleCheckpoint_playAnim","title":"BIS fnc OM moduleCheckpoint playAnim","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_moduleCheckpoint_playAnim","revid":278905,"updated":"2021-06-13T21:44:37Z","groups":["Checkpoint"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_moduleDepot","title":"BIS fnc OM moduleDepot","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_moduleDepot","revid":278901,"updated":"2021-06-13T21:44:36Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_moduleEconomy","title":"BIS fnc OM moduleEconomy","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_moduleEconomy","revid":278835,"updated":"2021-06-13T21:43:39Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_moduleFastTravel","title":"BIS fnc OM moduleFastTravel","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_moduleFastTravel","revid":278881,"updated":"2021-06-13T21:44:24Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_moduleMarket","title":"BIS fnc OM moduleMarket","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_moduleMarket","revid":278871,"updated":"2021-06-13T21:44:11Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_ModuleQuest_defend","title":"BIS fnc OM ModuleQuest defend","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_ModuleQuest_defend","revid":278877,"updated":"2021-06-13T21:44:18Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_ModuleQuest_destroyObject","title":"BIS fnc OM ModuleQuest destroyObject","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_ModuleQuest_destroyObject","revid":278845,"updated":"2021-06-13T21:43:49Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_moduleRadio","title":"BIS fnc OM moduleRadio","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_moduleRadio","revid":278892,"updated":"2021-06-13T21:44:30Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_moduleRandomConversation","title":"BIS fnc OM moduleRandomConversation","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_moduleRandomConversation","revid":278854,"updated":"2021-06-13T21:43:54Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_moduleReputation","title":"BIS fnc OM moduleReputation","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_moduleReputation","revid":278857,"updated":"2021-06-13T21:43:58Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_moduleRestPoint","title":"BIS fnc OM moduleRestPoint","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_moduleRestPoint","revid":278838,"updated":"2021-06-13T21:43:42Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_moduleSmartMarkers","title":"BIS fnc OM moduleSmartMarkers","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_moduleSmartMarkers","revid":278894,"updated":"2021-06-13T21:44:31Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_moduleSyndikatAgent","title":"BIS fnc OM moduleSyndikatAgent","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_moduleSyndikatAgent","revid":330470,"updated":"2022-09-18T00:21:38Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_moduleSyndikatTeam","title":"BIS fnc OM moduleSyndikatTeam","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_moduleSyndikatTeam","revid":330472,"updated":"2022-09-18T00:21:59Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_pause","title":"BIS fnc OM pause","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_pause","revid":278859,"updated":"2021-06-13T21:43:59Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_phone_addCall","title":"BIS fnc OM phone addCall","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_phone_addCall","revid":278906,"updated":"2021-06-13T21:44:38Z","groups":["Phone"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_phone_addContact","title":"BIS fnc OM phone addContact","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_phone_addContact","revid":278876,"updated":"2021-06-13T21:44:16Z","groups":["Phone"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_phone_core","title":"BIS fnc OM phone core","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_phone_core","revid":278862,"updated":"2021-06-13T21:44:01Z","groups":["Phone"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_phone_customSectionInit","title":"BIS fnc OM phone customSectionInit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_phone_customSectionInit","revid":278880,"updated":"2021-06-13T21:44:23Z","groups":["Phone"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_phone_customSectionShow","title":"BIS fnc OM phone customSectionShow","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_phone_customSectionShow","revid":278861,"updated":"2021-06-13T21:44:01Z","groups":["Phone"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_phone_customSectionWeatherShow","title":"BIS fnc OM phone customSectionWeatherShow","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_phone_customSectionWeatherShow","revid":278844,"updated":"2021-06-13T21:43:47Z","groups":["Phone"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_phone_getDiaryListIndexByName","title":"BIS fnc OM phone getDiaryListIndexByName","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_phone_getDiaryListIndexByName","revid":278883,"updated":"2021-06-13T21:44:24Z","groups":["Phone"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_phone_incomingCall","title":"BIS fnc OM phone incomingCall","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_phone_incomingCall","revid":278846,"updated":"2021-06-13T21:43:50Z","groups":["Phone"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_phone_menuHandler","title":"BIS fnc OM phone menuHandler","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_phone_menuHandler","revid":278851,"updated":"2021-06-13T21:43:53Z","groups":["Phone"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_phone_menuInit","title":"BIS fnc OM phone menuInit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_phone_menuInit","revid":278908,"updated":"2021-06-13T21:44:40Z","groups":["Phone"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_phone_removeCall","title":"BIS fnc OM phone removeCall","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_phone_removeCall","revid":278860,"updated":"2021-06-13T21:43:59Z","groups":["Phone"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_phone_SMS","title":"BIS fnc OM phone SMS","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_phone_SMS","revid":278907,"updated":"2021-06-13T21:44:38Z","groups":["Phone"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_phone_SMSSend","title":"BIS fnc OM phone SMSSend","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_phone_SMSSend","revid":278863,"updated":"2021-06-13T21:44:02Z","groups":["Phone"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_saveGame","title":"BIS fnc OM saveGame","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_saveGame","revid":309436,"updated":"2022-05-05T12:04:39Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"Saves the game - simply calls saveGame.","syntaxes":[{"syntax":"call BIS_fnc_OM_saveGame","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_OM_saveGame;"]}],"see_also":["saveGame"]},{"name":"BIS_fnc_OM_savingEnabled","title":"BIS fnc OM savingEnabled","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_savingEnabled","revid":278891,"updated":"2021-06-13T21:44:30Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_sectorGetSectors","title":"BIS fnc OM sectorGetSectors","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_sectorGetSectors","revid":338899,"updated":"2023-04-16T22:15:40Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_sellEquipment","title":"BIS fnc OM sellEquipment","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_sellEquipment","revid":278875,"updated":"2021-06-13T21:44:15Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_SentryDrone","title":"BIS fnc OM SentryDrone","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_SentryDrone","revid":278868,"updated":"2021-06-13T21:44:09Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_skip","title":"BIS fnc OM skip","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_skip","revid":278888,"updated":"2021-06-13T21:44:28Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_warnCriticalCode","title":"BIS fnc OM warnCriticalCode","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_warnCriticalCode","revid":278864,"updated":"2021-06-13T21:44:04Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OM_warnMildCode","title":"BIS fnc OM warnMildCode","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OM_warnMildCode","revid":278841,"updated":"2021-06-13T21:43:44Z","groups":["Old Man"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OMSetForecastLimit","title":"BIS fnc OMSetForecastLimit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OMSetForecastLimit","revid":278872,"updated":"2021-06-13T21:44:12Z","groups":["WeatherManager"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OMWeatherManagerCore","title":"BIS fnc OMWeatherManagerCore","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OMWeatherManagerCore","revid":278897,"updated":"2021-06-13T21:44:35Z","groups":["WeatherManager"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OMWeatherManagerMain","title":"BIS fnc OMWeatherManagerMain","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OMWeatherManagerMain","revid":278855,"updated":"2021-06-13T21:43:56Z","groups":["WeatherManager"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OMWeatherManagerRain","title":"BIS fnc OMWeatherManagerRain","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OMWeatherManagerRain","revid":278900,"updated":"2021-06-13T21:44:36Z","groups":["WeatherManager"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OMWeatherReport","title":"BIS fnc OMWeatherReport","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OMWeatherReport","revid":278850,"updated":"2021-06-13T21:43:52Z","groups":["WeatherManager"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_OMWeatherUICalc","title":"BIS fnc OMWeatherUICalc","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_OMWeatherUICalc","revid":278893,"updated":"2021-06-13T21:44:31Z","groups":["WeatherManager"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"> [!NOTE]\n> This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_onDiaryChanged","title":"BIS fnc onDiaryChanged","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_onDiaryChanged","revid":309890,"updated":"2022-05-05T12:09:54Z","groups":["Event Handlers"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Register code to be executed when diary item changes.\n\nArguments passed into code are:\n    0: DISPLAY - map display\n    1: BOOL - true if clicked on subject list, false when on record list (clicking on subject may also trigger record)\n    2: STRING - subject name\n    3: STRING - record name\n    4: ANY - passed arguments (index of onDiaryChanged code when no custom arguments were used)","syntaxes":[{"syntax":"_this call BIS_fnc_onDiaryChanged","params":[{"name":"_this","type":"Code, Array, Number","type_expr":"Code | Array | Number","description":"CODE\nARRAY - code with custom arguments in format [CODE,ARG1,ARG2,...]\nNUMBER - remove code of given index","text":"CODE\nARRAY - code with custom arguments in format [CODE,ARG1,ARG2,...]\nNUMBER - remove code of given index","source":"docblock"}],"returns":{"type":"Number","type_expr":"Number","description":"index of onDiaryChanged code","text":"NUMBER - index of onDiaryChanged code","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nRegister code to be executed when diary item changes.\n\nArguments passed into code are:\n    0: DISPLAY - map display\n    1: BOOL - true if clicked on subject list, false when on record list (clicking on subject may also trigger record)\n    2: STRING - subject name\n    3: STRING - record name\n    4: ANY - passed arguments (index of onDiaryChanged code when no custom arguments were used)\n\nParameter(s):\n_this:\n    CODE\n    ARRAY - code with custom arguments in format [CODE,ARG1,ARG2,...]\n    NUMBER - remove code of given index\n\nReturns:\nNUMBER - index of onDiaryChanged code"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_onEnd","title":"BIS fnc onEnd","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_onEnd","revid":329730,"updated":"2022-08-03T13:27:33Z","groups":["Event Handlers"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Register code to be executed after mission end.\n\n> [!NOTE]\n> **Arma 3:** Replaced by \"Ended\" mission event handler.\n> This function now exists only because of backward compatibility.","syntaxes":[{"syntax":"argument call BIS_fnc_onEnd","params":[{"name":"argument","type":"Code, Array or Number:","description":"Code, Array or Number:\n\n- Code - code to be executed\n- Array - code with arguments in format [code, arguments]\n- Number - remove code at given index","type_expr":"Code | Array | Number","text":"argument: Code, Array or Number:\n\n- Code - code to be executed\n- Array - code with arguments in format [code, arguments]\n- Number - remove code at given index"}],"returns":{"type":"Number","type_expr":"Number","description":"index of onEnd code"}}],"examples":[{"code":["private _onEndIndex = { player addRating 10000; } call BIS_fnc_onEnd;"]},{"code":["private _onEndIndex = [{ { _x addRating 10000; } forEach _this; }, units group player] call BIS_fnc_onEnd;"]}],"see_also":["Event Scripts","Arma 3: Mission Event Handlers"]},{"name":"BIS_fnc_onLoad","title":"BIS fnc onLoad","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_onLoad","revid":328472,"updated":"2022-07-13T16:11:09Z","groups":["Event Handlers"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Register code to be executed after a mission load (from a save, for example).\n\n> [!IMPORTANT]\n> Replaced by \"loaded\" mission event handler.\n> This function now exists only because of backward compatibility","syntaxes":[{"syntax":"parameter call BIS_fnc_onLoad","params":[{"name":"parameter","type":"Code or Number:","description":"Code or Number:\n\n- Code - code to be executed on mission load\n- Number - index of code to remove","type_expr":"Code | Number","text":"parameter: Code or Number:\n\n- Code - code to be executed on mission load\n- Number - index of code to remove"}],"returns":{"type":"Number","type_expr":"Number","description":"index of onLoad code"}}],"examples":[{"code":["private _codeIndex = { hint \"Welcome back!\"; } call BIS_fnc_onLoad;"]},{"code":["0 call BIS_fnc_onLoad; // removes code with index 0"]}],"see_also":["Arma 3: Mission Event Handlers","addMissionEventHandler"]},{"name":"BIS_fnc_onPlayerConnected","title":"BIS fnc onPlayerConnected","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_onPlayerConnected","revid":379590,"updated":"2026-11-04T00:04:10Z","groups":["Multiplayer","Event Handlers"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"server_exec":true},"description":"Executes code on server every time a player joins the scenario (after unit selection).","syntaxes":[{"syntax":"[code, params] call BIS_fnc_onPlayerConnected","params":[{"name":"code","type":"Code or String","description":"code or name of the function to be executed. The following parameters are passed: [player, params], where:\n\n- player: Object - the connected player unit\n- params: Anything - *params* (below)","type_expr":"Code | String"},{"name":"params","type":"Anything","description":"parameters passed to the code or function (usually an Array or HashMap)","type_expr":"Anything"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"text":"```sqf\n[\n    {\n        params [\"_player\", \"_params\"];\n        systemChat name _player;\n        systemChat _params;\n    },\n    \"Parameter\"\n] call BIS_fnc_onPlayerConnected;\n```","code":["[\n\t{\n\t\tparams [\"_player\", \"_params\"];\n\t\tsystemChat name _player;\n\t\tsystemChat _params;\n\t},\n\t\"Parameter\"\n] call BIS_fnc_onPlayerConnected;"]}],"see_also":["onPlayerConnected","BIS_fnc_addStackedEventHandler","Event Scripts"]},{"name":"BIS_fnc_openFieldManual","title":"BIS fnc openFieldManual","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_openFieldManual","revid":348478,"updated":"2023-11-08T13:00:27Z","groups":["Systems"],"status":"ok","games":{"arma3":"1.36"},"since":"arma3 1.36","arma3_since":"1.36","description":"Opens Field Manual in briefing (SP, MP Server, MP Client) and players's map or journal.\nSelects the topic and hint passed as parameters.\nCan apply a (search) filter if desired.","syntaxes":[{"syntax":"[topic, hint, display, filter] call BIS_fnc_openFieldManual","params":[{"name":"topic","type":"String","description":"class name of a topic that will be selected in the opened Field Manual (e.g. \"Damage\")","type_expr":"String"},{"name":"hint","type":"String","description":"class name of a hint that will be selected in the opened Field Manual (e.g. \"HitDamage\")","type_expr":"String"},{"name":"display","type":"Display","optional":true,"description":"desired parent Display to open the Field Manual display under","type_expr":"Display","text":"display: Display - (Optional) desired parent Display to open the Field Manual display under"},{"name":"filter","type":"String","optional":true,"description":"pre-filled search field filter in the opened Field Manual (recommended to use localized string)","type_expr":"String","text":"filter: String - (Optional) pre-filled search field filter in the opened Field Manual (recommended to use localized string)"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"Damage\", \"HitDamage\"] call BIS_fnc_openFieldManual;"]}]},{"name":"BIS_fnc_ORBATAddGroupOverlay","title":"BIS fnc ORBATAddGroupOverlay","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_ORBATAddGroupOverlay","revid":349398,"updated":"2023-11-08T16:27:25Z","groups":["Strategic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Register texture(s) to be displayed over CfgORBAT group.","syntaxes":[{"syntax":"[target, texture, colour, widthMulti, heightMulti, angle, text, shadow] call BIS_fnc_ORBATAddGroupOverlay","params":[{"name":"target","type":"Config","description":"path to group in CfgORBAT","type_expr":"Config"},{"name":"texture","type":"String","description":"texture","type_expr":"String"},{"name":"colour","type":"Array","description":"colour in format [R,G,B,A]","type_expr":"Array"},{"name":"widthMulti","type":"Number","description":"original icon width multiplier","type_expr":"Number"},{"name":"heightMulti","type":"Number","description":"original icon height multiplier","type_expr":"Number"},{"name":"angle","type":"Number","description":"angle","type_expr":"Number"},{"name":"text","type":"String","description":"text","type_expr":"String"},{"name":"shadow","type":"Boolean","description":"shadow outlining the texture","type_expr":"Boolean"}],"returns":{"type":"Number","type_expr":"Number","description":"overlay ID, used by BIS_fnc_ORBATRemoveGroupOverlay"}}],"examples":[{"code":["[configFile >> \"CfgORBAT\" >> \"BIS\" >> \"B_1_A_1\", \"\\A3\\weapons_f\\data\\UI\\icon_MG_CA.paa\", [0,0,01], 3, 3, 0, \"Some Text\", true] call BIS_fnc_ORBATAddGroupOverlay;"]}],"see_also":["ORBAT Viewer","BIS_fnc_ORBATAnimate","BIS_fnc_ORBATConfigPreview","BIS_fnc_ORBATGetGroupParams","BIS_fnc_ORBATOpen","BIS_fnc_ORBATRemoveGroupOverlay","BIS_fnc_ORBATSetGroupFade","BIS_fnc_ORBATSetGroupParams","BIS_fnc_ORBATTooltip"]},{"name":"BIS_fnc_ORBATAnimate","title":"BIS fnc ORBATAnimate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_ORBATAnimate","revid":349429,"updated":"2023-11-08T16:27:36Z","groups":["Strategic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Animates an ORBAT viewer.","syntaxes":[{"syntax":"[target, zoom, duration] spawn BIS_fnc_ORBATAnimate","params":[{"name":"target","type":"Config or Array","description":"path to group in CfgORBAT or offset position from structure center in format **[X, Y]**.\n\n- When empty, view is reset to original level where whole structure is visible","type_expr":"Config | Array"},{"name":"zoom","type":"Number","description":"zoom in range from 0 (max. zoom) to 1 (min. zoom)","type_expr":"Number"},{"name":"duration","type":"Number","description":"commit time in seconds","type_expr":"Number"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when animation is applied"}}],"examples":[{"code":["[configFile >> \"CfgORBAT\" >> \"BIS\" >> \"B_1_A_1\", 0.5, 3] spawn BIS_fnc_ORBATAnimate;"]}],"see_also":["ORBAT Viewer","BIS_fnc_ORBATAddGroupOverlay","BIS_fnc_ORBATConfigPreview","BIS_fnc_ORBATGetGroupParams","BIS_fnc_ORBATOpen","BIS_fnc_ORBATRemoveGroupOverlay","BIS_fnc_ORBATSetGroupFade","BIS_fnc_ORBATSetGroupParams","BIS_fnc_ORBATTooltip"]},{"name":"BIS_fnc_ORBATConfigPreview","title":"BIS fnc ORBATConfigPreview","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_ORBATConfigPreview","revid":327915,"updated":"2022-07-13T12:07:24Z","groups":["Strategic","Broken Functions"],"status":"broken","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Opens config viewer and shows CfgORBAT. Used to retrieve CfgOrbat data\n\n> [!WARNING]\n> This function seems to be broken Arma 3 v1.82","syntaxes":[{"syntax":"[class] call BIS_fnc_ORBATConfigPreview","params":[{"name":"class","type":"- Config","description":"Config - Path to group in CfgORBAT","type_expr":"Config","text":"class: - Config - Path to group in CfgORBAT"}],"returns":{"type":"String or Nothing","type_expr":"String | Nothing"}}],"examples":[{"code":["[configFile >> \"CfgORBAT\" >> \"BIS\" >> \"B_1_A_1\"] call BIS_fnc_ORBATConfigPreview;"]}],"see_also":["ORBAT Viewer","BIS_fnc_ORBATAddGroupOverlay","BIS_fnc_ORBATAnimate","BIS_fnc_ORBATGetGroupParams","BIS_fnc_ORBATOpen","BIS_fnc_ORBATRemoveGroupOverlay","BIS_fnc_ORBATSetGroupFade","BIS_fnc_ORBATSetGroupParams","BIS_fnc_ORBATTooltip"]},{"name":"BIS_fnc_ORBATGetGroupParams","title":"BIS fnc ORBATGetGroupParams","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_ORBATGetGroupParams","revid":349436,"updated":"2023-11-08T16:28:40Z","groups":["Strategic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns group params from CfgORBAT.","syntaxes":[{"syntax":"[path] call BIS_fnc_ORBATGetGroupParams","params":[{"name":"path","type":"Config","description":"path to group in CfgORBAT.","type_expr":"Config"}],"returns":{"type":"Array","type_expr":"Array"}}],"examples":[{"code":["[configFile >> \"CfgORBAT\" >> \"BIS\" >> \"B_1_A_1\"] call BIS_fnc_ORBATGetGroupParams;"]}],"see_also":["ORBAT Viewer","BIS_fnc_ORBATAddGroupOverlay","BIS_fnc_ORBATAnimate","BIS_fnc_ORBATConfigPreview","BIS_fnc_ORBATOpen","BIS_fnc_ORBATRemoveGroupOverlay","BIS_fnc_ORBATSetGroupFade","BIS_fnc_ORBATSetGroupParams","BIS_fnc_ORBATTooltip"]},{"name":"BIS_fnc_ORBATOpen","title":"BIS fnc ORBATOpen","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_ORBATOpen","revid":349486,"updated":"2023-11-08T17:09:04Z","groups":["Strategic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Opens the ORBAT Viewer.","syntaxes":[{"syntax":"[path, display, tags, numTiers, parameters] call BIS_fnc_ORBATOpen","params":[{"name":"path","type":"Config","description":"config path to displayed structure","type_expr":"Config"},{"name":"display","type":"Display","optional":true,"default":"`[] call BIS_fnc_displayMission`","description":"parent display","type_expr":"Display","text":"display: Display - (Optional, default `[] call BIS_fnc_displayMission`) parent display"},{"name":"tags","type":"Array of Strings","optional":true,"default":"`[]`","description":"list of tags. Searching will stop on groups which do not contain at least one of the tags","type_expr":"Array<String>","text":"tags: Array of Strings - (Optional, default `[]`) list of tags. Searching will stop on groups which do not contain at least one of the tags"},{"name":"numTiers","type":"Number","optional":true,"default":"-1 (all)","description":"Number of tiers displayed","type_expr":"Number","text":"numTiers: Number - (Optional, default -1 (all)) Number of tiers displayed"},{"name":"parameters","type":"Array of Arrays","optional":true,"default":"`[]`","description":"sub-arrays in format [config, code] where:\nconfig: Config - group class\ncode: Code - action performed upon clicking on group icon","type_expr":"Array<Array>","text":"parameters: Array of Arrays - (Optional, default `[]`) sub-arrays in format [config, code] where:\nconfig: Config - group class\ncode: Code - action performed upon clicking on group icon"}],"returns":{"type":"Display","type_expr":"Display"}}],"examples":[{"code":["[configFile >> \"CfgORBAT\" >> \"BIS\" >> \"O_Brigade\", findDisplay 46, [], 4, [\"ConfigClass_1\", { systemChat \"ConfigClass_1\" }]] call BIS_fnc_ORBATOpen;"]}],"see_also":["ORBAT Viewer","BIS_fnc_ORBATAddGroupOverlay","BIS_fnc_ORBATAnimate","BIS_fnc_ORBATConfigPreview","BIS_fnc_ORBATGetGroupParams","BIS_fnc_ORBATRemoveGroupOverlay","BIS_fnc_ORBATSetGroupFade","BIS_fnc_ORBATSetGroupParams","BIS_fnc_ORBATTooltip"]},{"name":"BIS_fnc_ORBATRemoveGroupOverlay","title":"BIS fnc ORBATRemoveGroupOverlay","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_ORBATRemoveGroupOverlay","revid":378104,"updated":"2026-02-14T10:39:28Z","groups":["Strategic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Unregister texture(s) to be displayed over CfgORBAT group.","syntaxes":[{"syntax":"[path, displayID] call BIS_fnc_ORBATRemoveGroupOverlay","params":[{"name":"path","type":"Config","description":"path to `CfgORBAT` group config","type_expr":"Config"},{"name":"displayID","type":"Number","description":"overlay ID returned by BIS_fnc_ORBATAddGroupOverlay","type_expr":"Number"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if overlay entry was removed"}}],"examples":[{"code":["[configFile >> \"CfgORBAT\" >> \"BIS\" >> \"O_Brigade\", 4] call BIS_fnc_ORBATRemoveGroupOverlay;"]}],"see_also":["ORBAT Viewer","BIS_fnc_ORBATAddGroupOverlay","BIS_fnc_ORBATAnimate","BIS_fnc_ORBATConfigPreview","BIS_fnc_ORBATGetGroupParams","BIS_fnc_ORBATOpen","BIS_fnc_ORBATSetGroupFade","BIS_fnc_ORBATSetGroupParams","BIS_fnc_ORBATTooltip"]},{"name":"BIS_fnc_ORBATSetGroupFade","title":"BIS fnc ORBATSetGroupFade","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_ORBATSetGroupFade","revid":349425,"updated":"2023-11-08T16:27:33Z","groups":["Strategic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Set fade value of CfgORBAT group and all groups below it.","syntaxes":[{"syntax":"[path, alpha, time] call BIS_fnc_ORBATSetGroupFade","params":[{"name":"path","type":"Config","description":"path to group in CfgORBAT. If only this parameter is passed, visibility settings for the group are removed.","type_expr":"Config"},{"name":"alpha","type":"Number","description":"alpha (0 = transparent, 1 = full color)","type_expr":"Number"},{"name":"time","type":"time","description":"commit time in seconds"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[configFile >> \"CfgORBAT\" >> \"BIS\" >> \"O_Brigade\", 0.5, 5] call BIS_fnc_ORBATSetGroupFade;"]}],"see_also":["ORBAT Viewer","BIS_fnc_ORBATAddGroupOverlay","BIS_fnc_ORBATAnimate","BIS_fnc_ORBATConfigPreview","BIS_fnc_ORBATGetGroupParams","BIS_fnc_ORBATOpen","BIS_fnc_ORBATRemoveGroupOverlay","BIS_fnc_ORBATSetGroupParams","BIS_fnc_ORBATTooltip"]},{"name":"BIS_fnc_ORBATSetGroupParams","title":"BIS fnc ORBATSetGroupParams","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_ORBATSetGroupParams","revid":349199,"updated":"2023-11-08T14:50:42Z","groups":["Strategic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Overrides group params from CfgORBAT. See ORBAT Viewer for a detailed explanation.","syntaxes":[{"syntax":"[target, idType, size, type, side, name, shortName, texture, textSizeCoef, insignia, textColour, commName, commRank, description, assets] call BIS_fnc_ORBATSetGroupParams","params":[{"name":"target","type":"Config","description":"path to class in CfgORBAT","type_expr":"Config"},{"name":"idType","type":"Number or String","description":"ID Type (e.g. `1` to result in \"1st\", or a specific string)","type_expr":"Number | String"},{"name":"size","type":"String","description":"size as a class from CfgChainOfCommand > Sizes (e.g., \"Platoon\")","type_expr":"String"},{"name":"type","type":"String","description":"type as a class from CfgChainOfCommand > Types (e.g., \"Infantry\")","type_expr":"String"},{"name":"side","type":"String","description":"side as a class from CfgChainOfCommand > Sides (e.g., \"West\")","type_expr":"String"},{"name":"name","type":"String","description":"name. Passed arguments are: %1 - ID, %2 - type, %3 - size)","type_expr":"String"},{"name":"shortName","type":"String","description":"short name. Passed arguments are: %1 - ID, %2 - type, %3 - size)","type_expr":"String"},{"name":"texture","type":"String","description":"texture. Can be link to a file or a class from CfgMarkers","type_expr":"String"},{"name":"textSizeCoef","type":"Number","description":"texture size coeficient. 1 is the default size","type_expr":"Number"},{"name":"insignia","type":"String","description":"insignia displayed in tooltip and in the ORBAT viewer background","type_expr":"String"},{"name":"textColour","type":"Array","description":"texture color in format RGBA","type_expr":"Array"},{"name":"commName","type":"String","description":"commander name. Can be the name directly or a class from CfgWorlds > GenericNames","type_expr":"String"},{"name":"commRank","type":"String","description":"commander rank","type_expr":"String"},{"name":"description","type":"String","description":"description shown in tooltip","type_expr":"String"},{"name":"assets","type":"Array of Arrays in format [vehicleClass, count]:","description":"Array of Arrays in format [vehicleClass, count]:\n\n- vehicleClass: String - vehicle class name\n- count: Number - quantity of vehicles","type_expr":"Array<Array>","text":"assets: Array of Arrays in format [vehicleClass, count]:\n\n- vehicleClass: String - vehicle class name\n- count: Number - quantity of vehicles"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"text":"```sqf\n[\n    configFile >> \"CfgORBAT\" >> \"BIS\" >> \"B_1_A_1\",\n    1,\n    \"Platoon\",\n    \"Infantry\",\n    \"West\",\n    \"Name: %1 %2 %3\",\n    \"Short Name: %1 %2 %3\",\n    \"b_air\",\n    3,\n    \"\\A3\\Air_F_EPB\\Heli_Light_03\\data\\UI\\Heli_Light_03_CA.paa\",\n    [0,0,0,1],\n    \"Commander Name\",\n    \"General\",\n    \"Description\",\n    [[\"B_MRAP_01_F\",5]]\n] call BIS_fnc_ORBATSetGroupParams;\n```","code":["[\n\tconfigFile >> \"CfgORBAT\" >> \"BIS\" >> \"B_1_A_1\",\n\t1,\n\t\"Platoon\",\n\t\"Infantry\",\n\t\"West\",\n\t\"Name: %1 %2 %3\",\n\t\"Short Name: %1 %2 %3\",\n\t\"b_air\",\n\t3,\n\t\"\\A3\\Air_F_EPB\\Heli_Light_03\\data\\UI\\Heli_Light_03_CA.paa\",\n\t[0,0,0,1],\n\t\"Commander Name\",\n\t\"General\",\n\t\"Description\",\n\t[[\"B_MRAP_01_F\",5]]\n] call BIS_fnc_ORBATSetGroupParams;"]}],"see_also":["ORBAT Viewer","BIS_fnc_ORBATAddGroupOverlay","BIS_fnc_ORBATAnimate","BIS_fnc_ORBATConfigPreview","BIS_fnc_ORBATGetGroupParams","BIS_fnc_ORBATOpen","BIS_fnc_ORBATRemoveGroupOverlay","BIS_fnc_ORBATSetGroupFade","BIS_fnc_ORBATTooltip"]},{"name":"BIS_fnc_ORBATTooltip","title":"BIS fnc ORBATTooltip","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_ORBATTooltip","revid":349257,"updated":"2023-11-08T14:51:05Z","groups":["Strategic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Animates an ORBAT viewer.","syntaxes":[{"syntax":"[target, control, position] call BIS_fnc_ORBATTooltip","params":[{"name":"target","type":"Config or Array","description":"path to group in CfgORBAT or group params returned by BIS_fnc_ORBATGetGroupParams","type_expr":"Config | Array"},{"name":"control","type":"Control","description":"tooltip control","type_expr":"Control"},{"name":"position","type":"Array","description":"mouse position in format **[x,y]**","type_expr":"Array"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"see_also":["ORBAT Viewer","BIS_fnc_ORBATAddGroupOverlay","BIS_fnc_ORBATAnimate","BIS_fnc_ORBATConfigPreview","BIS_fnc_ORBATGetGroupParams","BIS_fnc_ORBATOpen","BIS_fnc_ORBATRemoveGroupOverlay","BIS_fnc_ORBATSetGroupFade","BIS_fnc_ORBATSetGroupParams"]},{"name":"BIS_fnc_ordinalNumber","title":"BIS fnc ordinalNumber","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_ordinalNumber","revid":379276,"updated":"2026-10-30T23:44:59Z","groups":["Strings"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Return number as ordinal number (e.g. 1 become \"1st\")","syntaxes":[{"syntax":"[number, language, isFeminine] call BIS_fnc_ordinalNumber","params":[{"name":"number","type":"Number","type_expr":"Number"},{"name":"language","type":"String","optional":true,"default":"current game language","type_expr":"String","text":"language: String - (Optional, default current game language)"},{"name":"isFeminine","type":"Boolean","optional":true,"default":"false","type_expr":"Boolean","text":"isFeminine: Boolean - (Optional, default false)"}],"returns":{"type":"String","type_expr":"String"}}],"examples":[{"code":["private _second = [42] call BIS_fnc_ordinalNumber; // will return \"42nd\" for English-speaking players"]},{"text":"```sqf\nprivate _num1enm = [1, \"English\", false] call BIS_fnc_ordinalNumber;    // returns \"1st\"\n_num1frm = [1, \"French\",  false] call BIS_fnc_ordinalNumber;            // returns \"1er\"\n_num1frw = [1, \"French\",   true] call BIS_fnc_ordinalNumber;            // returns \"1re\"\n_num1esm = [1, \"Spanish\", false] call BIS_fnc_ordinalNumber;            // returns \"1\"\n_num1esw = [1, \"Spanish\",  true] call BIS_fnc_ordinalNumber;            // returns \"1*\" for Portuguese, Italian and Spanish\n```","code":["private _num1enm = [1, \"English\", false] call BIS_fnc_ordinalNumber;\t// returns \"1st\"\n_num1frm = [1, \"French\",  false] call BIS_fnc_ordinalNumber;\t\t\t// returns \"1er\"\n_num1frw = [1, \"French\",   true] call BIS_fnc_ordinalNumber;\t\t\t// returns \"1re\"\n_num1esm = [1, \"Spanish\", false] call BIS_fnc_ordinalNumber;\t\t\t// returns \"1\"\n_num1esw = [1, \"Spanish\",  true] call BIS_fnc_ordinalNumber;\t\t\t// returns \"1*\" for Portuguese, Italian and Spanish"]},{"text":"```sqf\nprivate _num1en = [1, \"English\"] call BIS_fnc_ordinalNumber;            // returns \"1st\"\n_num2en = [2, \"English\"] call BIS_fnc_ordinalNumber;                    // returns \"2nd\"\n_num3en = [3, \"English\"] call BIS_fnc_ordinalNumber;                    // returns \"3rd\"\n_num4en = [4, \"English\"] call BIS_fnc_ordinalNumber;                    // returns \"4th\"\n_num9en = [9, \"English\"] call BIS_fnc_ordinalNumber;                    // returns \"9th\"\n```","code":["private _num1en = [1, \"English\"] call BIS_fnc_ordinalNumber;\t\t\t// returns \"1st\"\n_num2en = [2, \"English\"] call BIS_fnc_ordinalNumber;\t\t\t\t\t// returns \"2nd\"\n_num3en = [3, \"English\"] call BIS_fnc_ordinalNumber;\t\t\t\t\t// returns \"3rd\"\n_num4en = [4, \"English\"] call BIS_fnc_ordinalNumber;\t\t\t\t\t// returns \"4th\"\n_num9en = [9, \"English\"] call BIS_fnc_ordinalNumber;\t\t\t\t\t// returns \"9th\""]},{"code":["private _second = [1, \"unknownLanguage\"] call BIS_fnc_ordinalNumber; // will return \"1.\" if language is not recognised/supported"]}],"see_also":["language"]},{"name":"BIS_fnc_overviewAuthor","title":"BIS fnc overviewAuthor","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_overviewAuthor","revid":336914,"updated":"2023-01-04T16:43:59Z","groups":["GUI"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Returns the mission author's name preceded by \"by\", e.g \"by Username\". See Description.ext - author.","syntaxes":[{"syntax":"[config, control] call BIS_fnc_overviewAuthor","params":[{"name":"config","type":"Config","optional":true,"default":"configFile","description":"where the function will look for **author** entry","type_expr":"Config","text":"config: Config - (Optional, default configFile) where the function will look for **author** entry"},{"name":"control","type":"Control","optional":true,"default":"controlNull","description":"if provided, will be filled with author's name","type_expr":"Control","text":"control: Control - (Optional, default controlNull) if provided, will be filled with author's name"}],"returns":{"type":"String","type_expr":"String"}}],"examples":[{"code":["hint format [\"%1, %2\", briefingName, call BIS_fnc_overviewAuthor];"]},{"code":["hint format [\"%1, %2\", briefingName, [missionConfigFile] call BIS_fnc_overviewAuthor];"]}],"see_also":["briefingName"]},{"name":"BIS_fnc_overviewDifficulty","title":"BIS fnc overviewDifficulty","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_overviewDifficulty","revid":309876,"updated":"2022-05-05T12:09:53Z","groups":["GUI"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_overviewMission","title":"BIS fnc overviewMission","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_overviewMission","revid":309721,"updated":"2022-05-05T12:09:47Z","groups":["GUI"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"```\n#define CONTROL_SHOW(CONTROL) \\\n    CONTROL ctrlshow true; \\\n    CONTROL ctrlsetfade 0; \\\n    CONTROL ctrlcommit 0;\n\n#define CONTROL_HIDE(CONTROL) \\\n    CONTROL ctrlshow false; \\\n    CONTROL ctrlsetfade 1; \\\n    CONTROL ctrlcommit 0;\n```","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_overviewTerrain","title":"BIS fnc overviewTerrain","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_overviewTerrain","revid":309719,"updated":"2022-05-05T12:09:47Z","groups":["GUI"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_overviewTimeTrial","title":"BIS fnc overviewTimeTrial","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_overviewTimeTrial","revid":377975,"updated":"2026-01-19T18:41:20Z","groups":["GUI"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Returns the dynamically composed overview text for Time Trial scenarios.","syntaxes":[{"syntax":"class call BIS_fnc_overviewTimeTrial","params":[{"name":"class","type":"String","description":"scenario class name","type_expr":"String"}],"returns":{"type":"String","type_expr":"String","description":"overview (structured text)"}}],"examples":[{"code":["\"BIS_someTimeTrial\" call BIS_fnc_overviewTimeTrial;"]}],"see_also":["BIS_fnc_overviewMission"]},{"name":"BIS_fnc_packStaticWeapon","title":"BIS fnc packStaticWeapon","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_packStaticWeapon","revid":352142,"updated":"2024-02-01T23:25:13Z","groups":["Weapons"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"This function will make weapon team pack a static weapon. The weapon crew will pack carried weapon (or given weapon if different) and follow leader. Requires three personnel in the team: Team Leader, Gunner and Asst. Gunner. This function is MP compatible\n\nWhen the weapon is packed, scripted EH \"StaticWeaponPacked\" is called with the following params:\n\n- [group, leader, gunner, assistant, weaponBag, tripodBag]\n\n> [!NOTE]\n> If a unit flees, all bets are off and the function will exit leaving units on their own. To guarantee weapon disassembly, make sure the group has maximum courage\n>\n> ```sqf\n> _group allowFleeing 0;\n> ```","syntaxes":[{"syntax":"[group, weapon, leaderPos] call BIS_fnc_packStaticWeapon","params":[{"name":"group","type":"Group or Object","description":"the support team group or a unit from this group","type_expr":"Group | Object"},{"name":"weapon","type":"Object","optional":true,"description":"weapon to pack. If nil, current group weapon is packed","type_expr":"Object","text":"weapon: Object - (Optional) weapon to pack. If nil, current group weapon is packed"},{"name":"leaderPos","type":"Array, String or Object","optional":true,"description":"position, object or marker to which the group leader should move after the weapon is packed. By default the group will resume on to the next assigned waypoint. If this param is provided, group will not go to the next waypoint and will move to given position instead","type_expr":"Array | String | Object","text":"leaderPos: Array, String or Object - (Optional) position, object or marker to which the group leader should move after the weapon is packed. By default the group will resume on to the next assigned waypoint. If this param is provided, group will not go to the next waypoint and will move to given position instead"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[leader1] call BIS_fnc_packStaticWeapon;"]},{"code":["group1 allowFleeing 0;\n[group1, nil, \"leaderpos_marker\"] call BIS_fnc_packStaticWeapon;"]}],"see_also":["BIS_fnc_unpackStaticWeapon","BIS_fnc_addScriptedEventHandler"],"notes":[{"user":"Killzone_Kid","date":"2017-01-06T23:23:00Z","text":"The following script will create a group consisting of a Team Leader, Gunner and Asst. Gunner and give the group 2 random MOVE waypoints.\nAfter the group reached the 1st waypoint, waypoint statement will execute BIS_fnc_unpackStaticWeapon and the group will stop and unpack static weapon, while leader is given random position to go to.\nAfter 7 seconds the BIS_fnc_packStaticWeapon is executed and the group packs and heads to 2nd waypoint.\n\n```sqf\nprivate _group = createGroup west;\nprivate _pos = player getRelPos [20, 0];\nprivate _randomDir = random 360;\nprivate _wp1 = _group addWaypoint [_pos getPos [20, _randomDir], 10];\n_wp1 setWaypointType \"MOVE\";\n_wp1 setWaypointStatements [\"true\", \"\n    group this allowFleeing 0;\n    [group this, 'StaticWeaponUnpacked', {\n        _this spawn\n        {\n            sleep 7;\n            [_this select 0] call BIS_fnc_packStaticWeapon;\n        };\n    }] call BIS_fnc_addScriptedEventHandler;\n    [\n        this,\n        this,\n        this getPos [1000, random 360],\n        this getPos [10, 0]\n    ] call BIS_fnc_unpackStaticWeapon;\n\"];\nprivate _wp2 = _group addWaypoint [_pos getPos [20, _randomDir - 180], 10];\n_wp2 setWaypointType \"MOVE\";\nprivate _leader = _group createUnit [\"B_Soldier_TL_F\", _pos, [], 0, \"NONE\"];\nprivate _gunner = _group createUnit [\"B_Support_GMG_F\", _pos, [], 0, \"NONE\"];\nprivate _assistant = _group createUnit [\"B_Support_AMG_F\", _pos, [], 0, \"NONE\"];\nunits _group doFollow _leader;\n```"}]},{"name":"BIS_fnc_param","title":"BIS fnc param","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_param","revid":349153,"updated":"2023-11-08T14:49:49Z","groups":["Arrays"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Load a script parameter. See Arma 3: Functions Library for detailed description.\n\n> [!NOTE]\n> **Arma 3:** Use param or params commands instead.","syntaxes":[{"syntax":"[input, index, defaultValue, dataTypes, requiredCount] call BIS_fnc_param","params":[{"name":"input","type":"Array","description":"list of params","type_expr":"Array"},{"name":"index","type":"Number","description":"selected index","type_expr":"Number"},{"name":"defaultValue","type":"Anything","optional":true,"default":"Nothing","description":"default param (used when param is missing or of wrong type).\nYou can overload default value by declaring variable *BIS_fnc_<functionName>_<index>* in Namespace where BIS_fnc_param is called from.\nBIS_fnc_paramIn is a variant of the function with overloading disabled.","type_expr":"Anything","text":"defaultValue: Anything - (Optional, default Nothing) default param (used when param is missing or of wrong type).\nYou can overload default value by declaring variable *BIS_fnc_<functionName>_<index>* in Namespace where BIS_fnc_param is called from.\nBIS_fnc_paramIn is a variant of the function with overloading disabled."},{"name":"dataTypes","type":"Array","optional":true,"default":"Anything","description":"list of allowed type examples (e.g. [\"\",[],0,objNull])","type_expr":"Array","text":"dataTypes: Array - (Optional, default Anything) list of allowed type examples (e.g. [\"\",[],0,objNull])"},{"name":"requiredCount","type":"Number or Array","optional":true,"description":"if value is Array, checks if it has required number of elements","type_expr":"Number | Array","text":"requiredCount: Number or Array - (Optional) if value is Array, checks if it has required number of elements"}],"returns":{"type":"Anything","type_expr":"Anything"}}],"examples":[{"text":"```sqf\n_target = [_this, 0, objNull, [objNull,[]], [2,3]] call BIS_fnc_param;\n```\n\n- if (_this select 0) is not defined, default objnull is used.\n- if (_this select 0) is defined, but is neither of type Object nor Array, error message is logged and default objNull is used.\n- if (_this select 0) and is Array, but it is count is neither 2 nor 3, error message is logged and default objNull is used.","code":["_target = [_this, 0, objNull, [objNull,[]], [2,3]] call BIS_fnc_param;"]},{"text":"```sqf\n_answer = [_this, 1, 42] call BIS_fnc_param;\n```\n\n- if (_this select 1) is not defined, default 42 is used.\n- no limit for data types or number of elements exists.","code":["_answer = [_this, 1, 42] call BIS_fnc_param;"]}],"see_also":["BIS_fnc_paramIn","param","params"],"notes":[{"user":"ffur2007slx2_5","date":"2014-09-06T21:55:00Z","text":"Arma 3 v1.28 Use BIS_fnc_paramIn to load private path from parent parameters (loaded by BIS_fnc_param)\n\n```sqf\nprivate [\"_parent\", \"_child0\", \"_child1\"];\n_parent = [_this, 0, [], [[]]] call BIS_fnc_param;\n_child0 = [_parent, 0, missionNamespace, [missionNamespace, grpNull, objNull]] call BIS_fnc_paramIn;\n_child1 = [_parent, 1, \"\", [\"\"]] call BIS_fnc_paramIn;\n```"}]},{"name":"BIS_fnc_paramCountdown","title":"BIS fnc paramCountdown","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_paramCountdown","revid":352531,"updated":"2024-02-12T16:42:17Z","groups":["Mission Parameters"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"server_exec":true},"description":"Set side mission time.","syntaxes":[{"syntax":"number call BIS_fnc_paramCountdown","params":[{"name":"number","type":"Number","description":"mission time in seconds","type_expr":"Number"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["360 call BIS_fnc_paramCountdown;"]}],"see_also":["Mission Parameters"]},{"name":"BIS_fnc_paramDaytime","title":"BIS fnc paramDaytime","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_paramDaytime","revid":352533,"updated":"2024-02-12T16:42:18Z","groups":["Mission Parameters"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"server_exec":true},"description":"Sets time of the day to the hour. Minutes will always be zero.","syntaxes":[{"syntax":"datetime call BIS_fnc_paramDaytime","params":[{"name":"datetime","type":"Number or Array","optional":true,"default":"dayTime","description":"Number - day hour. This will set the hour **in the same day** (unless 23 < *hour* < 0).\n  Float numbers are floored\n- Array - dayTime format: [year, month, day, hour, minute]","type_expr":"Number | Array","text":"datetime: Number or Array - (Optional, default dayTime):\n\n- Number - day hour. This will set the hour **in the same day** (unless 23 < *hour* < 0).\n  Float numbers are floored\n- Array - dayTime format: [year, month, day, hour, minute]"}],"returns":{"type":"Array","type_expr":"Array","description":"set date"}}],"examples":[{"code":["private _date = 12 call BIS_fnc_paramDaytime;"]},{"code":["private _date = [2001, 01, 01, 12, 00] call BIS_fnc_paramDaytime;"]},{"code":["private _date = call BIS_fnc_paramDaytime;"]}],"see_also":["dayTime","date","setDate","Mission Parameters"]},{"name":"BIS_fnc_paramGuerFriendly","title":"BIS fnc paramGuerFriendly","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_paramGuerFriendly","revid":352525,"updated":"2024-02-12T16:42:17Z","groups":["Mission Parameters"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"server_exec":true},"description":"Set relationship between Independents and remaining sides.","syntaxes":[{"syntax":"number call BIS_fnc_paramGuerFriendly","params":[{"name":"number","type":"Number","description":"side relation, can be:\n-1 - Nobody\n0 - OPFOR\n1 - BLUFOR\n2 - Everybody","type_expr":"Number"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["2 call BIS_fnc_paramGuerFriendly;"]}],"see_also":["Mission Parameters"]},{"name":"BIS_fnc_paramIn","title":"BIS fnc paramIn","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_paramIn","revid":327870,"updated":"2022-07-13T11:38:41Z","groups":["Arrays"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"See BIS_fnc_param.\nOverloading default values is disabled in this variant.\nIt's intended to be used where _this is not used as an input param.","syntaxes":[{"syntax":"See BIS_fnc_param","params":[],"returns":null}],"examples":[{"code":["private _array = [_this, 0, [], [[]]] call BIS_fnc_param;\n_item = [_array,0,true,[true]] call BIS_fnc_paramIn;"]}],"see_also":["BIS_fnc_param"],"notes":[{"user":"ffur2007slx2_5","date":"2014-09-06T23:00:00Z","text":"Arma 3 v1.28 Use BIS_fnc_paramIn to load private path from parent parameters (loaded by BIS_fnc_param)\n\n```sqf\nprivate [\"_parent\",\"_child0\",\"_child1\"];\n_parent = [_this, 0, [], [[]]] call BIS_fnc_param;\n_child0 = [_parent, 0, missionNamespace, [missionNamespace, grpNull, objNull]] call BIS_fnc_paramIn;\n_child1 = [_parent, 1, \"\", [\"\"]] call BIS_fnc_paramIn;\n```"}]},{"name":"BIS_fnc_paramRespawnTickets","title":"BIS fnc paramRespawnTickets","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_paramRespawnTickets","revid":352524,"updated":"2024-02-12T16:42:17Z","groups":["Mission Parameters"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Set side respawn tickets.","syntaxes":[{"syntax":"number call BIS_fnc_paramRespawnTickets","params":[{"name":"number","type":"Number","description":"respawn tickets","type_expr":"Number"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["360 call BIS_fnc_paramRespawnTickets;"]}],"see_also":["Mission Parameters"]},{"name":"BIS_fnc_paramReviveBleedOutDuration","title":"BIS fnc paramReviveBleedOutDuration","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_paramReviveBleedOutDuration","revid":352523,"updated":"2024-02-12T16:42:17Z","groups":["Mission Parameters"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Grabs server param into global variable. (**bis_reviveParam_bleedOutDuration**)","syntaxes":[{"syntax":"call BIS_fnc_paramReviveBleedOutDuration","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_paramReviveBleedOutDuration;"]}],"see_also":["Mission Parameters"]},{"name":"BIS_fnc_paramReviveDuration","title":"BIS fnc paramReviveDuration","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_paramReviveDuration","revid":352539,"updated":"2024-02-12T16:42:20Z","groups":["Mission Parameters"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Grabs server param into global variable. (**bis_reviveParam_duration**)","syntaxes":[{"syntax":"call BIS_fnc_paramReviveDuration","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_paramReviveDuration;"]}],"see_also":["Mission Parameters"]},{"name":"BIS_fnc_paramReviveForceRespawnDuration","title":"BIS fnc paramReviveForceRespawnDuration","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_paramReviveForceRespawnDuration","revid":352532,"updated":"2024-02-12T16:42:17Z","groups":["Mission Parameters"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Grabs server param into global variable. (**bis_reviveParam_forceRespawnDuration**)","syntaxes":[{"syntax":"call BIS_fnc_paramReviveForceRespawnDuration","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_paramReviveForceRespawnDuration;"]}],"see_also":["Mission Parameters"]},{"name":"BIS_fnc_paramReviveMedicSpeedMultiplier","title":"BIS fnc paramReviveMedicSpeedMultiplier","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_paramReviveMedicSpeedMultiplier","revid":352529,"updated":"2024-02-12T16:42:17Z","groups":["Mission Parameters"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Grabs server param into global variable. (**bis_reviveParam_medicSpeedMultiplier**)","syntaxes":[{"syntax":"call BIS_fnc_paramReviveMedicSpeedMultiplier","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_paramReviveMedicSpeedMultiplier;"]}],"see_also":["Mission Parameters"]},{"name":"BIS_fnc_paramReviveMode","title":"BIS fnc paramReviveMode","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_paramReviveMode","revid":352538,"updated":"2024-02-12T16:42:20Z","groups":["Mission Parameters"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Grabs server param into global variable. (**bis_reviveParam_mode**)","syntaxes":[{"syntax":"call BIS_fnc_paramReviveMode","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_paramReviveMode;"]}],"see_also":["Mission Parameters"]},{"name":"BIS_fnc_paramReviveRequiredItems","title":"BIS fnc paramReviveRequiredItems","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_paramReviveRequiredItems","revid":352527,"updated":"2024-02-12T16:42:17Z","groups":["Mission Parameters"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Grabs server param into global variable. (**bis_reviveParam_requiredItems**)","syntaxes":[{"syntax":"call BIS_fnc_paramReviveRequiredItems","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_paramReviveRequiredItems;"]}],"see_also":["Mission Parameters"]},{"name":"BIS_fnc_paramReviveRequiredTrait","title":"BIS fnc paramReviveRequiredTrait","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_paramReviveRequiredTrait","revid":370326,"updated":"2024-11-27T10:38:52Z","groups":["Mission Parameters"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Stores the provided value in the global `BIS_reviveParam_requiredTrait` mission variable.","syntaxes":[{"syntax":"[value] call BIS_fnc_paramReviveRequiredTrait","params":[{"name":"value","type":"Number","optional":true,"default":"-100","type_expr":"Number","text":"value: Number - (Optional, default -100)"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"```sqf\n[42] call BIS_fnc_paramReviveRequiredTrait;    // BIS_reviveParam_requiredTrait is now 42\n\"hi\" call BIS_fnc_paramReviveRequiredTrait;    // BIS_reviveParam_requiredTrait is now -100\n42 call BIS_fnc_paramReviveRequiredTrait;    // BIS_reviveParam_requiredTrait is now 42\ncall BIS_fnc_paramReviveRequiredTrait;        // BIS_reviveParam_requiredTrait is now -100\n```","code":["[42] call BIS_fnc_paramReviveRequiredTrait;\t// BIS_reviveParam_requiredTrait is now 42\n\"hi\" call BIS_fnc_paramReviveRequiredTrait;\t// BIS_reviveParam_requiredTrait is now -100\n42 call BIS_fnc_paramReviveRequiredTrait;\t// BIS_reviveParam_requiredTrait is now 42\ncall BIS_fnc_paramReviveRequiredTrait;\t\t// BIS_reviveParam_requiredTrait is now -100"]}],"see_also":["Mission Parameters"]},{"name":"BIS_fnc_paramReviveUnconsciousStateMode","title":"BIS fnc paramReviveUnconsciousStateMode","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_paramReviveUnconsciousStateMode","revid":352528,"updated":"2024-02-12T16:42:17Z","groups":["Mission Parameters"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Grabs server param into global variable. (**bis_reviveParam_unconsciousStateMode**)","syntaxes":[{"syntax":"call BIS_fnc_paramReviveUnconsciousStateMode","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_paramReviveUnconsciousStateMode;"]}],"see_also":["Mission Parameters"]},{"name":"BIS_fnc_paramTimeAcceleration","title":"BIS fnc paramTimeAcceleration","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_paramTimeAcceleration","revid":352535,"updated":"2024-02-12T16:42:19Z","groups":["Mission Parameters"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Manages setTimeMultiplier Multiplayer setting (set with paramTimeAcceleration.hpp)","syntaxes":[{"syntax":"timeMultiplier call BIS_fnc_paramTimeAcceleration","params":[{"name":"timeMultiplier","type":"Number","optional":true,"default":"timeMultiplier","type_expr":"Number","text":"timeMultiplier: Number - (Optional, default timeMultiplier)"}],"returns":{"type":"Number","type_expr":"Number","description":"the set ratio"}}],"examples":[{"code":["5 call BIS_fnc_paramTimeAcceleration;"]}],"see_also":["setTimeMultiplier","timeMultiplier"]},{"name":"BIS_fnc_paramViewDistance","title":"BIS fnc paramViewDistance","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_paramViewDistance","revid":352526,"updated":"2024-02-12T16:42:17Z","groups":["Mission Parameters"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Set view distance.","syntaxes":[{"syntax":"viewDistance call BIS_fnc_paramViewDistance","params":[{"name":"viewDistance","type":"Number","description":"wanted view distance","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number","description":"viewDistance"}}],"examples":[{"code":["7500 call BIS_fnc_paramViewDistance;"]}],"see_also":["Mission Parameters","setViewDistance","viewDistance"]},{"name":"BIS_fnc_paramWeather","title":"BIS fnc paramWeather","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_paramWeather","revid":348935,"updated":"2023-11-08T14:44:07Z","groups":["Mission Parameters"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"server_exec":true},"description":"Sets overcast using BIS_fnc_setOvercast.","syntaxes":[{"syntax":"[0] call BIS_fnc_paramWeather","params":[{"name":"Number","description":"overcast value. *Multiplied by 0.01 inside the function. Default value is **current overcast value**.*","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number","description":"overcast value (ranging from 0 to 1)."}}],"examples":[{"code":["overCastValue = [1] call BIS_fnc_paramWeather;"]}],"see_also":["BIS_fnc_setOvercast","overcast","setOvercast"]},{"name":"BIS_fnc_parseNumber","title":"BIS fnc parseNumber","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_parseNumber","revid":370223,"updated":"2024-11-11T05:36:36Z","groups":["Math","Strings"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Return number from expression","syntaxes":[{"syntax":"value call BIS_fnc_parseNumber","params":[{"name":"value","type":"Number, String, Code or Config","type_expr":"Number | String | Code | Config"}],"returns":{"type":"Number","type_expr":"Number","description":"parsed number, -1 if value is not a number"}}],"examples":[{"code":["private _result = 7.62 call BIS_fnc_parseNumber;\n_result = \"7.62\" call BIS_fnc_parseNumber;\n_result = { 7.62 } call BIS_fnc_parseNumber;"]},{"code":["\"[10,20,30]\" call BIS_fnc_parseNumber; //returns [10,20,30]"]}],"see_also":["parseNumber"]},{"name":"BIS_fnc_parseNumberSafe","title":"BIS fnc parseNumberSafe","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_parseNumberSafe","revid":348666,"updated":"2023-11-08T13:50:56Z","groups":["Arrays"],"status":"ok","games":{"arma3":"1.96"},"since":"arma3 1.96","arma3_since":"1.96","description":"Converts expression into a number. Can also convert array of expressions into an array of numbers. If expression does not return a number, 0 is returned.","syntaxes":[{"syntax":"[input] call BIS_fnc_parseNumberSafe","params":[{"name":"input","type":"Number, String, Side, Config or Array","description":"if type is array, array may contain any of the mentioned data types","type_expr":"Number | String | Side | Config | Array"}],"returns":{"type":"Number or Array of Numbers","type_expr":"Number | Array<Number>","description":"if input is an Array","text":"Number or Array of Numbers if *input* is an Array"}}],"examples":[{"text":"```sqf\n[safeZoneX, safeZoneWAbs, configFile] call BIS_fnc_parseNumberSafe;    // returns [-0.452381,1.90476,0]\n```","code":["[safeZoneX, safeZoneWAbs, configFile] call BIS_fnc_parseNumberSafe;\t// returns [-0.452381,1.90476,0]"]},{"text":"```sqf\n[\"1337\", \"2013\", date] call BIS_fnc_parseNumberSafe;                    // returns [1337,2013,[2036,1,1,6,58]]\n```","code":["[\"1337\", \"2013\", date] call BIS_fnc_parseNumberSafe;\t\t\t\t\t// returns [1337,2013,[2036,1,1,6,58]]"]},{"text":"```sqf\n[blufor, opfor, independent, civilian] call BIS_fnc_parseNumberSafe;    // returns [1,0,2,3]\n```","code":["[blufor, opfor, independent, civilian] call BIS_fnc_parseNumberSafe;\t// returns [1,0,2,3]"]}],"see_also":["parseNumber","BIS_fnc_parseNumber"]},{"name":"BIS_fnc_phoneticalWord","title":"BIS fnc phoneticalWord","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_phoneticalWord","revid":349006,"updated":"2023-11-08T14:46:14Z","groups":["Strings"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Convert number to NATO phonetical alphabet word (e.g. 2 becomes \"Bravo\") or letter of alphabet.","syntaxes":[{"syntax":"[integer, short] call BIS_fnc_phoneticalWord","params":[{"name":"integer","type":"Number","description":"any integer from 1 to 26.","type_expr":"Number"},{"name":"short","type":"Boolean","optional":true,"default":"false","description":"true for the short version, false for the long version.","type_expr":"Boolean","text":"short: Boolean - (Optional, default false) true for the short version, false for the long version."}],"returns":{"type":"String","type_expr":"String","description":"phonetical word or letter of alphabet. In case of full word the returned string is localised."}}],"examples":[{"code":["[1] call BIS_fnc_phoneticalWord; // returns \"Alpha\""]},{"code":["[1, true] call BIS_fnc_phoneticalWord; // returns \"A\""]}],"see_also":["BIS_fnc_ordinalNumber","BIS_fnc_romanNumeral"]},{"name":"BIS_fnc_PIP","title":"BIS fnc PIP","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_PIP","revid":376142,"updated":"2025-09-03T11:23:11Z","groups":["GUI"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Displays Picture in Picture.","syntaxes":[{"syntax":"[renderTarget, cameraParams, vehicle, replace] call BIS_fnc_PIP","params":[{"name":"renderTarget","type":"String","description":"render target","type_expr":"String"},{"name":"cameraParams","type":"Object or Array","description":"Object or Array\n\n- Object - existing camera\n- Array - camera params in format [position, target]:\n  - position: Array in format Position3D or attachTo [object, position]\n  - target: Object or Array in format Position3D (same as camPrepareTarget)","type_expr":"Object | Array","text":"cameraParams: Object or Array\n\n- Object - existing camera\n- Array - camera params in format [position, target]:\n  - position: Array in format Position3D or attachTo [object, position]\n  - target: Object or Array in format Position3D (same as camPrepareTarget)"},{"name":"vehicle","type":"Object","optional":true,"description":"vehicle to which action is added (to memory point \"action_screen1\")","type_expr":"Object","text":"vehicle: Object - (Optional) vehicle to which action is added (to memory point \"action_screen1\")"},{"name":"replace","type":"Boolean","optional":true,"default":"true","description":"true to replace existing PIP on same target","type_expr":"Boolean","text":"replace: Boolean - (Optional, default true) true to replace existing PIP on same target"}],"returns":{"type":"Object","type_expr":"Object","description":"camera"}}],"examples":[{"code":["[\"rendertarget0\", [[heli1, heli1 selectionPosition \"slingload0\"], cargo1], heli1, false] call BIS_fnc_PIP;"]},{"code":["[\"rendertarget0\", _myCamera] call BIS_fnc_PIP;"]},{"text":"```sqf\n[\"rendertarget0\"] call BIS_fnc_PIP;    // terminate\n[] call BIS_fnc_PIP;                // terminate \"livefeedrendertarget0\"\n```","code":["[\"rendertarget0\"] call BIS_fnc_PIP;\t// terminate\n[] call BIS_fnc_PIP;\t\t\t\t// terminate \"livefeedrendertarget0\""]}],"see_also":["isPiPEnabled"]},{"name":"BIS_fnc_planeAiEject","title":"BIS fnc planeAiEject","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_planeAiEject","revid":376187,"updated":"2025-09-13T15:54:56Z","groups":["Aircraft Functionality"],"status":"ok","games":{"arma3":"1.70"},"since":"arma3 1.70","arma3_since":"1.70","description":"- This function is designed as part of set of functions to implement semi-authenthic ejection system on fixed wing aircrfat that have such functionality enabled/configured.\n- AI behaviour handler.","syntaxes":[{"syntax":"plane call BIS_fnc_planeAiEject","params":[{"name":"plane","type":"Object","description":"living vehicle with a pilot and with ejection systems set up in its config","type_expr":"Object"}],"returns":{"type":"Nothing if plane was invalid or no ejection was needed, otherwise Script Handle","type_expr":"Nothing","description":"script handle of spawned BIS_fnc_planeEjection"}}],"examples":[{"code":["_myPlane call BIS_fnc_planeAiEject;"]}],"see_also":["BIS_fnc_planeEjection","BIS_fnc_planeEjectionFX","BIS_fnc_ejectionSeatRelease"],"docblock":{"text":"Author: Bravo Zero One development\n- John_Spartan\n\nDescription:\n- This function is designed as part of set of functions to implement semi-authenthic ejection system on fixed wing aircrfat that have such functionality enabled/configured.\n- AI behaviour handler.\n\nExucution:\n- Call the function via attached EH to the aircrfat itself.\n\n    Example:\n    class Eventhandlers : Eventhandlers\n    {\n        Hit = \"_this call BIS_fnc_planeAiEject\";\n    };\n\nRequirments:\n- Compatible aircrfat must have a config definition for all subsytems that will be invoked by ejection system (see BIS_fnc_PlaneEjection).\n\nParameter(s):\n    _this select 0: mode (Scalar)\n    0: plane/object\n\nReturns: nothing\nResult: AI pilot will be forced to eject from aircrfat upon damage treshold reached. Semi-authenthic behaviour.","author":"Bravo Zero One development, John_Spartan"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_planeEjection","title":"BIS fnc planeEjection","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_planeEjection","revid":376186,"updated":"2025-09-13T15:54:41Z","groups":["Aircraft Functionality"],"status":"ok","games":{"arma3":"1.70"},"since":"arma3 1.70","arma3_since":"1.70","exec":"spawn","description":"- This function is designed to implement semi-authenthic ejection system on fixed wing aircrfat that have such functionality enabled/configured.","syntaxes":[{"syntax":"[plane, delay] spawn BIS_fnc_planeEjection","params":[{"name":"plane","type":"Object","description":"living vehicle with a pilot and with ejection systems set up in its config","type_expr":"Object"},{"name":"delay","type":"Number","optional":true,"default":"-1","description":"delay in seconds between function execution and when the ejection actually happens. 0 or lower means no delay.","type_expr":"Number","text":"delay: Number - (Optional, default -1) delay in seconds between function execution and when the ejection actually happens. 0 or lower means no delay."}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[_plane, 2] spawn BIS_fnc_planeEjection;"]}],"see_also":["BIS_fnc_planeAiEject","BIS_fnc_planeEjectionFX","BIS_fnc_ejectionSeatRelease"],"docblock":{"text":"Author: Bravo Zero One development\n- John_Spartan\n\nDescription:\n- This function is designed to implement semi-authenthic ejection system on fixed wing aircrfat that have such functionality enabled/configured.\n\nExucution:\n- Call the function via user action added to the aircrfat itself.\n\n        class Plane_Eject_UserActionExample\n        {\n            priority = 0.05;\n            shortcut = \"Eject\";\n            displayName = \"$STR_A3_action_eject\";\n            condition = \"player in this\";\n            statement = \"[this] spawn BIS_fnc_planeEjection\";\n            position = \"pilotcontrol\";\n            radius = 10;\n            onlyforplayer = 1;\n            showWindow = 0;\n                    hideOnUse = 1;\n        };\n\nRequirments:\n- Compatible aircrfat must have a config definition for all sub-sytems that will be invoked by this function.\n    1. Old legacy ejection must be disabled in aircrfat's cfgVehicles configuration.\n    driverCanEject = 0;\n    gunnerCanEject = 0;\n    cargoCanEject = 0;\n\n    2. Aircrfat must have a set of parameters defined in CfgVehicles subClass (EjectionSystem) for ejection system. Theese parameters will affect the ejection behaviour.\n    example of cfgVehicles subclass definitions;\n\n    class EjectionSystem\n    {\n        EjectionSeatEnabled = 1;                                        //enable advanced ejection system\n        EjectionDual = 0;                                            //currently only single seat aircraft ejectiion supported (to do for latter)\n        EjectionSeatClass = \"B_Ejection_Seat_Plane_Fighter_01_F\";                                //class name of ejector seat to use (separate vehicle/object)\n        CanopyClass = \"Plane_Fighter_01_Canopy_F\";                                //class name of canopy to use (separate vehicle/object)\n        EjectionSeatHideAnim = \"ejection_seat_hide\";                                //name of the hide animation that will hide ejector seat mesh in plane\n        EjectionSeatRailAnim = \"ejection_seat_motion\";                                //name of the animation that will be played to start a smooth ejection motion out of cockpit\n        CanopyHideAnim = \"canopy_hide\";                                        //name of the hide animation that will hide canopy mesh in plane\n        EjectionSeatPos = \"pos_eject\";                                        //position memory point whwre to attach ejector seat\n        CanopyPos = \"pos_eject_canopy\";                                        //position memory point where to attach dummy canopy\n        EjectionSoundExt = \"Plane_Fighter_01_ejection_ext_sound\";                        //sound to play when ejection trigered (external)\n        EjectionSoundInt = \"Plane_Fighter_01_ejection_in_sound\";                        //sound to play when ejection trigered (in-ternal)\n        EjectionParachute = \"Steerable_Parachute_F\";                                //class name parachute used in ejection\n        EjectionSeatForce = 50;                                            //ejection seat blast force\n        CanopyForce = 30;                                            //canopy bast force\n\n    };\n\n    3. Aircrfat model must have momory points definig positions where to attach new vehicle ejector seat, new vehicle canopy.\n    4. Aircrfat model (in model cfg & class AnimationSources) must have a set of hide animations defined to hide ejector seat and canopy in model when new seaparate vehicles are spawned.\n\n    In model.cfg\n    class canopy_hide\n    {\n        type=\"hide\";\n        source=\"user\";\n        selection=\"canopy_hide\";\n        minValue = 0.0;\n        maxValue = 1.0;\n        minPhase = 0.0;\n        maxPhase = 1.0;\n        initPhase = 0;\n        hideValue = 0.001;\n    };\n\n    class ejection_seat_hide\n    {\n        type=\"hide\";\n        source=\"user\";\n        selection=\"ejection_seat\";\n        minValue = 0.0;\n        maxValue = 1.0;\n        minPhase = 0.0;\n        maxPhase = 1.0;\n        initPhase = 0;\n        hideValue = 0.001;\n    }\n\n    In cfgVehicles >> class AnimationSources\n    class canopy_hide\n    {\n        source = \"user\";\n        animPeriod = 0.001;\n        initPhase = 0;\n    };\n\n    class ejection_seat_hide\n    {\n        source = \"user\";\n        animPeriod = 0.001;\n        initPhase = 0;\n    };\n\n    5. Aircrfat model must have an animation for initial ejection stage, where new ejector seat with pilot is pushed gradualy out of cockpit (done to avaoid PhysX colisions and make this feature look good, rathre than spawnig ejetor seat above plane).\n    New ejector seat with pilot will be attached to this animation (via animated meory point).\n    Memory point EjectionSeatPos must be part of this animated selection.\n\n    In model.cfg\n    class ejection_seat_motion\n    {\n        type = \"translation\";\n        source = \"user\";\n        selection = \"ejection_seat\";\n        begin = \"tns_ejection_seat\";\n        end = \"tns_ejection_seat_e\";\n        animPeriod = 0;\n        memory = 1;\n        minValue = 0.0;\n        maxValue = 1.0;\n        offset0 = 0.0;\n        offset1 = 3.0;\n    };\n\n    In cfgVehicles >> class AnimationSources\n    class ejection_seat_motion\n    {\n        source = \"user\";\n        animPeriod = 0.25;\n        initPhase = 0;\n    };\n\n    6. Ejector seat and canopy must be created/defined as separate objects. Can be reused.\n\nParameter(s):\n    _this select 0: mode (Scalar)\n    0: plane/object\n\n    other parameters are gathered from configuration files.\n\nReturns: nothing\nResult: Pilot will be ejected from aircraft. Semi-authenthic behaviour.","author":"Bravo Zero One development, John_Spartan"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_planeEjectionFX","title":"BIS fnc planeEjectionFX","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_planeEjectionFX","revid":376189,"updated":"2025-09-13T16:49:05Z","groups":["Aircraft Functionality"],"status":"ok","games":{"arma3":"1.70"},"since":"arma3 1.70","arma3_since":"1.70","exec":"spawn","description":"- This function is designed as part of set of functions to implement semi-authenthic ejection system on fixed wing aircrfat that have such functionality enabled/configured.\n- Function created to add FX (sound/particles) for ejection feature.","syntaxes":[{"syntax":"[plane, ejectionSeat] spawn BIS_fnc_planeEjectionFX","params":[{"name":"plane","type":"Object","description":"vehicle with ejection system (plane part) set up in its config","type_expr":"Object"},{"name":"ejectionSeat","type":"Object","description":"vehicle with ejection system (seat part) set up in its config","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[_myPlane, _myEjectionSeat] spawn BIS_fnc_planeEjectionFX;"]}],"see_also":["BIS_fnc_planeEjection","BIS_fnc_planeAiEject","BIS_fnc_ejectionSeatRelease"],"docblock":{"text":"Author: Bravo Zero One development\n- John_Spartan\n\nDescription:\n- This function is designed as part of set of functions to implement semi-authenthic ejection system on fixed wing aircrfat that have such functionality enabled/configured.\n- Function created to add FX (sound/particles) for ejection feature.\n\nExucution:\n- Call from within the main ejection fnc (on demand).\n\n    Example:\n    [_plane, _ejectionSeat] spawn BIS_fnc_planeEjectionFX;\n\nRequirments:\n- Compatible ejector seat must have a hide animation for rocket motor flash and position for FX to be attached. (TO DO PARAMETARIZE)\n    Inehector seats model.cfg\n    class Animations\n    {\n\n        class Rocket_Flash_hide\n        {\n            type = \"hide\";\n            source = \"user\";\n            selection = \"rocket_flash\";\n            sourceAddress = \"mirror\";\n            minValue = -1.5;\n            maxValue = 0;\n            hideValue = 0.99;\n\n        };\n    };\n\nParameter(s):\n    _this select 0: mode (Scalar)\n    0: plane/object\n    1: ejector seat/object\n\nReturns: nothing\nResult: Set of particle FX and sound FX will be aplied to ejection feature.","author":"Bravo Zero One development, John_Spartan"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_playEndMusic","title":"BIS fnc playEndMusic","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_playEndMusic","revid":323870,"updated":"2022-07-01T11:53:44Z","groups":["Sound"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Play mission end music (when it is nearing the end)","syntaxes":[{"syntax":"play call BIS_fnc_playEndMusic","params":[{"name":"play","type":"Boolean","description":"true to play it, false to stop playing","type_expr":"Boolean"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when function is done"}}],"examples":[{"code":["true call BIS_fnc_playEndMusic;"]}],"see_also":["playMusic","BIS_fnc_endMission"]},{"name":"BIS_fnc_playerName","title":"BIS fnc playerName","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_playerName","revid":326963,"updated":"2022-07-12T21:44:41Z","groups":["Object Manipulation"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Return current profile's name. Deprecated since Arma 3, use profileName instead.","syntaxes":[{"syntax":"call BIS_fnc_playerName","params":[],"returns":{"type":"String","type_expr":"String","description":"profileName"}}],"examples":[{"code":["private _myPlayerName = call BIS_fnc_playerName;"]}],"see_also":["profileName"]},{"name":"BIS_fnc_playerSideFaction","title":"BIS fnc playerSideFaction","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_playerSideFaction","revid":311124,"updated":"2022-05-10T14:43:05Z","groups":["Sides"],"status":"ok","games":{"arma3":"1.06"},"since":"arma3 1.06","arma3_since":"1.06","description":"Return representative faction of the given side. Faction of the first detected player is used.","syntaxes":[{"syntax":"side call BIS_fnc_playerSideFaction","params":[{"name":"side","type":"Side","type_expr":"Side"}],"returns":{"type":"String","type_expr":"String","description":"CfgFactionClasses class"}}],"examples":[{"code":["west call BIS_fnc_playerSideFaction;"]}],"see_also":["side"]},{"name":"BIS_fnc_playMusic","title":"BIS fnc playMusic","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_playMusic","revid":349204,"updated":"2023-11-08T14:50:43Z","groups":["Sound"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Plays given song.","syntaxes":[{"syntax":"[class,start,volume] call BIS_fnc_playMusic","params":[{"name":"class","type":"String","description":"classname of song","type_expr":"String"},{"name":"start","type":"Number","description":"time of start in seconds - Default: 0","type_expr":"Number"},{"name":"volume","type":"Number","description":"music volume from 0 to 1 - Default: musicVolume","type_expr":"Number"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true"}}],"examples":[{"code":["[\"LeadTrack04_F\", 10, 0.5] call BIS_fnc_playMusic; // song starts at 10 seconds with 50% volume."]}],"see_also":["playMusic","musicVolume"]},{"name":"BIS_fnc_playSound","title":"BIS fnc playSound","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_playSound","revid":325115,"updated":"2022-07-01T12:28:25Z","groups":["Sound"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Plays given sound. Identical to playSound.","syntaxes":[{"syntax":"[sound, forced] call BIS_fnc_playSound","params":[{"name":"sound","type":"String","description":"sound name","type_expr":"String"},{"name":"forced","type":"Boolean","optional":true,"default":"false","type_expr":"Boolean","text":"forced: Boolean - (Optional, default false)"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"always true"}}],"examples":[{"code":["\"3DEN_visionMode\" call BIS_fnc_playSound;"]},{"code":["[\"3DEN_visionMode\", true] call BIS_fnc_playSound;"]}],"see_also":["playSound"]},{"name":"BIS_fnc_playVideo","title":"BIS fnc playVideo","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_playVideo","revid":351834,"updated":"2024-01-13T09:28:32Z","groups":["GUI"],"status":"ok","games":{"arma2oa":"1.56","tkoh":"1.00","arma3":"0.50"},"since":"arma2oa 1.56","arma3_since":"0.50","locality":{"effect":"local"},"description":"Plays in-game video with a range of options. The function can be called or spawned. If spawned, scriptDone command can be used to see if video is stopped or finished. If called in scheduled environment, the next line of code will not process until the video is stopped or finished.\nThe function also calls `\"BIS_fnc_playVideo_started\"` and `\"BIS_fnc_playVideo_stopped\"` Scripted Event Handlers in missionNamespace - see BIS_fnc_addScriptedEventHandler and Arma 3: Scripted Event Handlers.\n\n> [!NOTE]\n> - to play the video on an object, e.g an in-game screen, see Example 3\n> - the video can be stopped in a variety of ways - see Example 4\n> - see OGV File Format for format and conversion information.","syntaxes":[{"syntax":"[content, size, color, skipVarName, bgColor, keepAspect] spawn BIS_fnc_playVideo","params":[{"name":"content","type":"String","description":"full path to `.ogv` file","type_expr":"String"},{"name":"size","type":"Array of Numbers","optional":true,"default":"[safeZoneX, safeZoneY, safeZoneW, safeZoneH]","description":"screen size in format [x, y, w, h]\n\n> [!NOTE]\n> If the aspect ratio of the size parameter is not the same as the aspect ratio of the video file, black bars will be visibile. The video will not be stretched","type_expr":"Array<Number>","text":"size: Array of Numbers - (Optional, default [safeZoneX, safeZoneY, safeZoneW, safeZoneH]) screen size in format [x, y, w, h]\n\n> [!NOTE]\n> If the aspect ratio of the size parameter is not the same as the aspect ratio of the video file, black bars will be visibile. The video will not be stretched"},{"name":"color","type":"Array of Numbers","optional":true,"default":"[1,1,1,1]","description":"foreground color in format [r, g, b, a]","type_expr":"Array<Number>","text":"color: Array of Numbers - (Optional, default [1,1,1,1]) foreground color in format [r, g, b, a]"},{"name":"skipVarName","type":"String","optional":true,"default":"\"BIS_fnc_playVideo_skipVideo\"","description":"missionNamespace variable to skip the video when variable is true","type_expr":"String","text":"skipVarName: String - (Optional, default \"BIS_fnc_playVideo_skipVideo\") missionNamespace variable to skip the video when variable is true"},{"name":"bgColor","type":"Array format Color (RGBA)","optional":true,"default":"[0,0,0,1]","description":"background color in format [r, g, b, a]","type_expr":"Color","types":["Array","Color"],"text":"bgColor: Array format Color (RGBA) - (Optional, default: [0,0,0,1]) background color in format [r, g, b, a]"},{"name":"keepAspect","type":"Boolean","optional":true,"default":"true","description":"true to keep original video aspect ratio (background color will fill the void), false to stretch","type_expr":"Boolean","text":"keepAspect: Boolean - (Optional, default true) true to keep original video aspect ratio (background color will fill the void), false to stretch"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true"}}],"examples":[{"code":["private _video = [\"A3\\Missions_F_EPA\\video\\A_in_intro.ogv\"] spawn BIS_fnc_playVideo;"]},{"code":["private _video = [\"\\a3\\missions_f_exp\\video\\exp_m04_v01.ogv\"] call BIS_fnc_playVideo;"]},{"code":["_video = \"a3\\missions_f_exp\\video\\exp_m07_vout.ogv\";\n_screen = \"Land_TripodScreen_01_large_F\" createVehicle (player modelToWorld [0,10,0]);\n_screen setObjectTexture [0, _video];\n[_video, [10, 10]] call BIS_fnc_playVideo;"]},{"text":"How to stop the video:\n\n- call or spawn the function with an empty string:\n\n  ```sqf\n  [\"\"] call BIS_fnc_playVideo;\n  ```\n- call or spawn the function with another video:\n\n  ```sqf\n  [\"\\a3\\missions_f_exp\\video\\exp_m04_v02.ogv\"] call BIS_fnc_playVideo;\n  ```\n- set the variable \"BIS_fnc_playVideo_skipVideo\" to true:\n\n  ```sqf\n  missionNamespace setVariable [\"BIS_fnc_playVideo_skipVideo\", true];\n  ```\n- set the custom skip variable (*skipVarName*) to true:\n\n  ```sqf\n  missionNamespace setVariable [\"MyCustomSkipVar\", true];\n  sleep 1;\n  missionNamespace setVariable [\"MyCustomSkipVar\", nil]; // so it can be reused later\n  ```","code":["[\"\"] call BIS_fnc_playVideo;","[\"\\a3\\missions_f_exp\\video\\exp_m04_v02.ogv\"] call BIS_fnc_playVideo;","missionNamespace setVariable [\"BIS_fnc_playVideo_skipVideo\", true];","missionNamespace setVariable [\"MyCustomSkipVar\", true];\nsleep 1;\nmissionNamespace setVariable [\"MyCustomSkipVar\", nil]; // so it can be reused later"]}],"see_also":["Functions Library"],"notes":[{"user":"Dedmen","date":"2019-11-11T18:31:00Z","text":"Example ffmpeg command to encode a ogv video which can be played back.\n\n```sqf\nffmpeg -i input.mp4 -c:v libtheora -q:v 7 -c:a libvorbis -q:a 4 intro.ogv\n```\n\nSee OGV File Format."}]},{"name":"BIS_fnc_posDegToUTM","title":"BIS fnc posDegToUTM","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_posDegToUTM","revid":338004,"updated":"2023-02-23T21:11:10Z","groups":["Map and Markers"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Generate a [UTM Zone](https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system#UTM_zone), Easting and Northing from lat and long fields.\nIt uses [NAD83 constants](https://en.wikipedia.org/wiki/North_American_Datum).","syntaxes":[{"syntax":"[longitude, latitude, zone] call BIS_fnc_posDegToUTM","params":[{"name":"longitude","type":"Number","type_expr":"Number"},{"name":"latitude","type":"Number","type_expr":"Number"},{"name":"zone","type":"Number","optional":true,"default":"`31 + floor (_longitude / 6)`","type_expr":"Number","text":"zone: Number - (Optional, default `31 + floor (_longitude / 6)`)"}],"returns":{"type":"Array of Numbers","type_expr":"Array<Number>","description":"format [easting, northing, zone]"}}],"examples":[{"code":["private _utmZone = [47.63959,-122.127249] call BIS_fnc_posDegToUTM;"]}],"see_also":["BIS_fnc_posDegToWorld","BIS_fnc_posUTMToDeg"]},{"name":"BIS_fnc_posDegToWorld","title":"BIS fnc posDegToWorld","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_posDegToWorld","revid":328506,"updated":"2022-07-13T16:23:48Z","groups":["Map and Markers"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Convert latitude/longtitude coordinates into game world position.\nWorld config **must** contain following settings to convert the position correctly:\n\n```cpp\n// Required for scripting\nmapSize = 61440;    // Can differ from mapArea size, as ingame world can be resized\nmapZone = 10;        // UTM zone\nmapArea[] = {        // lon/lat coordinates (not in UTM to assure .kml precision)\n    -122.754367782585,47.3272454065969,    // Bottom Left\n    -121.930117859276,47.8753494907418    // Top Right\n};\n```","syntaxes":[{"syntax":"[longitude, latitude, world] call BIS_fnc_posDegToWorld","params":[{"name":"longitude","type":"Number","type_expr":"Number"},{"name":"latitude","type":"Number","type_expr":"Number"},{"name":"world","type":"String","optional":true,"default":"worldName","type_expr":"String","text":"world: String - (Optional, default worldName)"}],"returns":{"type":"Array of Numbers","type_expr":"Array<Number>","description":"format [easting, northing, zone]"}}],"examples":[{"code":["[47.63959,-122.127249] call BIS_fnc_posDegToWorld;"]}],"see_also":["BIS_fnc_posDegToUTM","BIS_fnc_posUTMToDeg"]},{"name":"BIS_fnc_position","title":"BIS fnc position","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_position","revid":379277,"updated":"2026-10-30T23:45:07Z","groups":["Positions"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Returns PositionAGL, unless passed argument is Array, then the same array is returned. When position is Object and alternative position is stored in `\"BIS_fnc_position_forced\"` variable on this object, the stored position is used rather than actual object position. This function is a pretty safe way to get the position of an entity.","syntaxes":[{"syntax":"argument call BIS_fnc_position","params":[{"name":"argument","type":"Array, Object, Group, Location or String","description":"Array, Object, Group, Location or String\n\n- Array - Position in format `[x, y]` or `[x, y ,z]`\n- Object - Object\n- Group - Group, group leader position is used\n- Location - Location\n- String - Marker or variable name containing object\n\n> [!NOTE]\n> To get the position of an Eden Entity use `_entity get3DENAttribute \"Position\" select 0;`.","type_expr":"Array | Object | Group | Location | String","text":"argument: Array, Object, Group, Location or String\n\n- Array - Position in format `[x, y]` or `[x, y ,z]`\n- Object - Object\n- Group - Group, group leader position is used\n- Location - Location\n- String - Marker or variable name containing object\n\n> [!NOTE]\n> To get the position of an Eden Entity use `_entity get3DENAttribute \"Position\" select 0;`."}],"returns":{"type":"Array","type_expr":"Array","description":"position in format `[x, y]` or `[x, y ,z]`"}}],"examples":[{"code":["private _pos = player call BIS_fnc_position;"]}],"see_also":["Position"]},{"name":"BIS_fnc_posToGrid","title":"BIS fnc posToGrid","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_posToGrid","revid":327012,"updated":"2022-07-12T21:44:44Z","groups":["Positions"],"status":"deprecated","replaced_by":["mapGridPosition"],"games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Converts array position to map grid position.\n\n> [!CAUTION]\n> This information is **obsolete** as of Arma 2 v1.04. Reason: This function is replaced by mapGridPosition.","syntaxes":[{"syntax":"element call BIS_fnc_posToGrid","params":[{"name":"element","type":"Object, Array in format Position or String marker name","type_expr":"Object | Position | String","types":["Object","Array","Position","String"]}],"returns":{"type":"Array of Strings","type_expr":"Array<String>","description":"format [\"X\", \"Y\"]"}}],"examples":[{"code":["player call BIS_fnc_posToGrid; // [\"046\", \"049\"]"]}],"see_also":["BIS_fnc_gridToPos","mapGridPosition"]},{"name":"BIS_fnc_posUTMToDeg","title":"BIS fnc posUTMToDeg","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_posUTMToDeg","revid":338003,"updated":"2023-02-23T21:11:10Z","groups":["Map and Markers"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Generate Lat and Long fields from [UTM Zone](https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system#UTM_zone), Easting and Northing.\nIt uses [NAD83 constants](https://en.wikipedia.org/wiki/North_American_Datum).","syntaxes":[{"syntax":"[easting, northing, zone, hemisphere] call BIS_fnc_posUTMToDeg","params":[{"name":"easting","type":"Number","type_expr":"Number"},{"name":"northing","type":"Number","type_expr":"Number"},{"name":"zone","type":"Number","type_expr":"Number"},{"name":"hemisphere","type":"String","optional":true,"default":"\"N\"","description":"\"N\" for northern hemisphere, \"S\" for southern hemisphere","type_expr":"String","text":"hemisphere: String - (Optional, default \"N\") \"N\" for northern hemisphere, \"S\" for southern hemisphere"}],"returns":{"type":"Array of Numbers","type_expr":"Array<Number>","description":"format [longitude, latitude]"}}],"examples":[{"code":["[5273702, 560561, 10] call BIS_fnc_posUTMToDeg;"]}],"see_also":["BIS_fnc_posDegToUTM","BIS_fnc_posDegToWorld"]},{"name":"BIS_fnc_pow","title":"BIS fnc pow","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_pow","revid":327747,"updated":"2022-07-13T11:01:20Z","groups":["Math"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Return value1 raised to the power of value2. Identical to a ^ b.\n\n> [!IMPORTANT]\n> Use a ^ b as it is 5 times faster.","syntaxes":[{"syntax":"[value1, value2] call BIS_fnc_pow","params":[{"name":"value1","type":"Number","type_expr":"Number"},{"name":"value2","type":"Number","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number","description":"value1 raised to the power of value2","text":"Number - *value1* raised to the power of *value2*"}}],"examples":[{"code":["[2, 10] call BIS_fnc_pow; // returns 2^10 = 1024"]}],"see_also":["Operators","a ^ b"]},{"name":"BIS_fnc_preload","title":"BIS fnc preload","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_preload","revid":309413,"updated":"2022-05-05T12:04:36Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Start automatic loading screen upon mission start.\nOn client, it will finish only when server is finished.","syntaxes":[{"syntax":"call BIS_fnc_preload","params":[],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["call BIS_fnc_preload;"]}]},{"name":"BIS_fnc_prepareAO","title":"BIS fnc prepareAO","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_prepareAO","revid":325093,"updated":"2022-07-01T12:24:49Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Spawns random patrols and/or vehicles in trigger areas with proper names. Side selected in the triggers \"Activation\" listbox will determine the side of the spawned asset(s).\n\nTrigger **names** (a.k.a \"Trigger text\", **not** \"Variable Name\") defines the kind of spawn. Supported trigger names are:\n\n- **GEN_infantry**: spawns random infantry patrol with sentry waypoints (**NOTE:** only circular triggers are supported, min. axis should be 500m)\n- **GEN_patrolVeh**: spawns a random vehicle. If a civilian unit is synchronized with the trigger, its waypoint will be used by the spawned vehicle\n  You can specify the vehicle type by typing one of the following into the trigger's \"On Act.\" field:\n  - car\n  - apc\n  - tank\n- **GEN_ammo**: spawns a random number of ammoboxes. You can get and idea of the shape this composition will have by making this trigger rectangular with dimensions 5m x 1m. You can also specify the amount of crates spawned by using min. and max. Timeout values (supported range is 1 to 6 crates).\n- **GEN_civilCar**: spawns a random empty civil car","syntaxes":[{"syntax":"density call BIS_fnc_prepareAO","params":[{"name":"density","type":"Number","optional":true,"default":"1","description":"enemy presence density index used for random footpatrols","type_expr":"Number","text":"density: Number - (Optional, default 1) enemy presence density index used for random footpatrols"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["0.75 call BIS_fnc_prepareAO;"]},{"code":["call BIS_fnc_prepareAO;"]}],"see_also":["BIS_fnc_spawnGroup","createUnit"]},{"name":"BIS_fnc_priorityQueue_GetHighestPriority","title":"BIS fnc priorityQueue GetHighestPriority","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_priorityQueue_GetHighestPriority","revid":274107,"updated":"2021-06-13T01:16:43Z","groups":["Priority Queue"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Get the highest priority in the queue","syntaxes":[{"syntax":"[] call BIS_fnc_priorityQueue_GetHighestPriority","params":[{"name":"_handle","type":"Number","type_expr":"Number","description":"Queue handle (get it with BIS_fnc_PriorityQueue_Init)","text":"INT - Queue handle (get it with BIS_fnc_PriorityQueue_Init)","source":"docblock"}],"returns":{"type":"Number","type_expr":"Number","description":"the priority","text":"_priority:SCALAR - the priority","source":"docblock"}}],"examples":[{"code":["_myItem = [_priorityQueue_1] call BIS_fnc_PriorityQueue_PopItem;"]}],"docblock":{"text":"Author: Zozo\n\nDescription:\nGet the highest priority in the queue\n\nParameters:\n_handle:INT - Queue handle (get it with BIS_fnc_PriorityQueue_Init)\n\nReturns:\n_priority:SCALAR - the priority\n\nSyntax:\n_item:ANY = [_handle] call BIS_fnc_PriorityQueue_GetHighestPriority;\n\nExample:\n_myItem = [_priorityQueue_1] call BIS_fnc_PriorityQueue_PopItem;","author":"Zozo"},"filled_from_docblock":["description","params","returns","examples"]},{"name":"BIS_fnc_priorityQueue_GetLowestPriority","title":"BIS fnc priorityQueue GetLowestPriority","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_priorityQueue_GetLowestPriority","revid":273939,"updated":"2021-06-13T01:13:47Z","groups":["Priority Queue"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Get the highest priority in the queue","syntaxes":[{"syntax":"[] call BIS_fnc_priorityQueue_GetLowestPriority","params":[{"name":"_handle","type":"Number","type_expr":"Number","description":"Queue handle (get it with BIS_fnc_PriorityQueue_Init)","text":"INT - Queue handle (get it with BIS_fnc_PriorityQueue_Init)","source":"docblock"}],"returns":{"type":"Number","type_expr":"Number","description":"the priority","text":"_priority:SCALAR - the priority","source":"docblock"}}],"examples":[{"code":["_myItem = [_priorityQueue_1] call BIS_fnc_PriorityQueue_PopItem;"]}],"docblock":{"text":"Author: Zozo\n\nDescription:\nGet the highest priority in the queue\n\nParameters:\n_handle:INT - Queue handle (get it with BIS_fnc_PriorityQueue_Init)\n\nReturns:\n_priority:SCALAR - the priority\n\nSyntax:\n_item:ANY = [_handle] call BIS_fnc_PriorityQueue_GetHighestPriority;\n\nExample:\n_myItem = [_priorityQueue_1] call BIS_fnc_PriorityQueue_PopItem;","author":"Zozo"},"filled_from_docblock":["description","params","returns","examples"]},{"name":"BIS_fnc_priorityQueue_Init","title":"BIS fnc priorityQueue Init","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_priorityQueue_Init","revid":274279,"updated":"2021-06-13T01:19:56Z","groups":["Priority Queue"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"/*\n\nInitialize the Priority Queue data structure. The Priority Queue is sorted on inserting. Bigger numbers are set on higher indexes.","syntaxes":[{"syntax":"[] call BIS_fnc_priorityQueue_Init","params":[{"name":"_maxSize","type":"Number","type_expr":"Number","optional":true,"description":"sets the Queue MAX SIZE (otherwise it is set to the constant defined in the .inc file)","text":"INT - OPTIONAL, sets the Queue MAX SIZE (otherwise it is set to the constant defined in the .inc file)","source":"docblock"}],"returns":{"text":"_handle: Handle to the Queue (essential for manipulation with the Queue)","source":"docblock"}}],"examples":[{"code":["_priorityQueue_1 = [10] call BIS_fnc_PriorityQueue_Init;"]}],"docblock":{"text":"/*\n    Author: Zozo\n\n    Description:\n    Initialize the Priority Queue data structure.\n    The Priority Queue is sorted on inserting. Bigger numbers are set on higher indexes.\n\n    Parameters:\n    _maxSize:INT - OPTIONAL, sets the Queue MAX SIZE (otherwise it is set to the constant defined in the .inc file)\n\n    Returns:\n    _handle: Handle to the Queue (essential for manipulation with the Queue)\n\n    Syntax:\n    _handle:INT = [_maxSize] call BIS_fnc_PriorityQueue_Init;\n\n    Example:\n    _priorityQueue_1 = [10] call BIS_fnc_PriorityQueue_Init;","author":"Zozo"},"filled_from_docblock":["description","params","returns","examples"]},{"name":"BIS_fnc_priorityQueue_IsEmpty","title":"BIS fnc priorityQueue IsEmpty","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_priorityQueue_IsEmpty","revid":274407,"updated":"2021-06-13T01:22:08Z","groups":["Priority Queue"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"/*\n\nChecks if the Queue is empty","syntaxes":[{"syntax":"[] call BIS_fnc_priorityQueue_IsEmpty","params":[{"name":"_handle","type":"Number","type_expr":"Number","description":"Queue handle (get it with BIS_fnc_PriorityQueue_Init)","text":"INT - Queue handle (get it with BIS_fnc_PriorityQueue_Init)","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if the Queue is empty","text":"_empty:BOOL - true if the Queue is empty","source":"docblock"}}],"examples":[{"code":["_isTheQueueEmpty = [_priorityQueue_1] call BIS_fnc_PriorityQueue_IsEmpty;"]}],"docblock":{"text":"/*\n    Author: Zozo\n\n    Description:\n    Checks if the Queue is empty\n\n    Parameters:\n    _handle:INT - Queue handle (get it with BIS_fnc_PriorityQueue_Init)\n\n    Returns:\n    _empty:BOOL - true if the Queue is empty\n\n    Syntax:\n    _empty:BOOL = [_handle] call BIS_fnc_PriorityQueue_IsEmpty;\n\n    Example:\n    _isTheQueueEmpty = [_priorityQueue_1] call BIS_fnc_PriorityQueue_IsEmpty;","author":"Zozo"},"filled_from_docblock":["description","params","returns","examples"]},{"name":"BIS_fnc_priorityQueue_IsFull","title":"BIS fnc priorityQueue IsFull","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_priorityQueue_IsFull","revid":274362,"updated":"2021-06-13T01:21:26Z","groups":["Priority Queue"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Checks if the Queue is full","syntaxes":[{"syntax":"[] call BIS_fnc_priorityQueue_IsFull","params":[{"name":"_handle","type":"Number","type_expr":"Number","description":"Queue handle (get it with BIS_fnc_PriorityQueue_Init)","text":"INT - Queue handle (get it with BIS_fnc_PriorityQueue_Init)","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if the Queue is full","text":"_full:BOOL - true if the Queue is full","source":"docblock"}}],"examples":[{"code":["_isTheQueueFull = [_priorityQueue_1] call BIS_fnc_PriorityQueue_IsFull;"]}],"docblock":{"text":"Author: Zozo\n\nDescription:\nChecks if the Queue is full\n\nParameters:\n_handle:INT - Queue handle (get it with BIS_fnc_PriorityQueue_Init)\n\nReturns:\n_full:BOOL - true if the Queue is full\n\nSyntax:\n_full:BOOL = [_handle] call BIS_fnc_PriorityQueue_IsFull;\n\nExample:\n_isTheQueueFull = [_priorityQueue_1] call BIS_fnc_PriorityQueue_IsFull;","author":"Zozo"},"filled_from_docblock":["description","params","returns","examples"]},{"name":"BIS_fnc_priorityQueue_PopItem","title":"BIS fnc priorityQueue PopItem","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_priorityQueue_PopItem","revid":274273,"updated":"2021-06-13T01:19:49Z","groups":["Priority Queue"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"/*\n\nPops the item with the highest priority from the Queue (item with highest index). The item is removed from the Queue. Complexity: O(1)","syntaxes":[{"syntax":"[] call BIS_fnc_priorityQueue_PopItem","params":[{"name":"_handle","type":"Number","type_expr":"Number","description":"Queue handle (get it with BIS_fnc_PriorityQueue_Init)\n_keep:BOOL - if true, the item is not removed from the Queue","text":"INT - Queue handle (get it with BIS_fnc_PriorityQueue_Init)\n_keep:BOOL - if true, the item is not removed from the Queue","source":"docblock"}],"returns":{"type":"Anything","type_expr":"Anything","description":"the item stored in the Queue","text":"_item:ANY - the item stored in the Queue","source":"docblock"}}],"examples":[{"code":["_myItem = [_priorityQueue_1] call BIS_fnc_PriorityQueue_PopItem;"]}],"docblock":{"text":"/*\n    Author: Zozo\n\n    Description:\n    Pops the item with the highest priority from the Queue (item with highest index).\n    The item is removed from the Queue.\n    Complexity: O(1)\n\n    Parameters:\n    _handle:INT - Queue handle (get it with BIS_fnc_PriorityQueue_Init)\n    _keep:BOOL - if true, the item is not removed from the Queue\n\n    Returns:\n    _item:ANY - the item stored in the Queue\n\n    Syntax:\n    _item:ANY = [_handle] call BIS_fnc_PriorityQueue_PopItem;\n\n    Example:\n    _myItem = [_priorityQueue_1] call BIS_fnc_PriorityQueue_PopItem;","author":"Zozo"},"filled_from_docblock":["description","params","returns","examples"]},{"name":"BIS_fnc_priorityQueue_PushItem","title":"BIS fnc priorityQueue PushItem","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_priorityQueue_PushItem","revid":274278,"updated":"2021-06-13T01:19:56Z","groups":["Priority Queue"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"/*\n\nInserts item with a defined priority to the Queue The Priority Queue is sorted on inserting. Bigger numbers are set on higher indexes. Complexity: O(n)","syntaxes":[{"syntax":"[] call BIS_fnc_priorityQueue_PushItem","params":[{"name":"_handle","type":"Number","type_expr":"Number","description":"Queue handle (get it with BIS_fnc_PriorityQueue_Init)\n_item:ANY - item, can be whatever\n_priority:INT - the priority the item is inserted with","text":"INT - Queue handle (get it with BIS_fnc_PriorityQueue_Init)\n_item:ANY - item, can be whatever\n_priority:INT - the priority the item is inserted with","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if item was inserted into the Queue, otherwise false","text":"_success:BOOL - true if item was inserted into the Queue, otherwise false","source":"docblock"}}],"examples":[{"code":["_s = [_priorityQueue_1, \"myItem\", 5] call BIS_fnc_PriorityQueue_InsertItem;"]}],"docblock":{"text":"/*\n    Author: Zozo\n\n    Description:\n    Inserts item with a defined priority to the Queue\n    The Priority Queue is sorted on inserting. Bigger numbers are set on higher indexes.\n    Complexity: O(n)\n\n    Parameters:\n    _handle:INT - Queue handle (get it with BIS_fnc_PriorityQueue_Init)\n    _item:ANY - item, can be whatever\n    _priority:INT - the priority the item is inserted with\n\n    Returns:\n    _success:BOOL - true if item was inserted into the Queue, otherwise false\n\n    Syntax:\n    _success:BOOL = [_handle, _item, _priority] call BIS_fnc_PriorityQueue_InsertItem;\n\n    Example:\n    _s = [_priorityQueue_1, \"myItem\", 5] call BIS_fnc_PriorityQueue_InsertItem;","author":"Zozo"},"filled_from_docblock":["description","params","returns","examples"]},{"name":"BIS_fnc_progressLoadingScreen","title":"BIS fnc progressLoadingScreen","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_progressLoadingScreen","revid":369453,"updated":"2024-09-06T08:44:48Z","groups":["GUI"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Progress scripted loading screen. The value will be preserved even when a new screen is opened.\n\n> [!NOTE]\n> **Arma 3:** The loading screen can be force-ended with the ENDLOAD cheat code.","syntaxes":[{"syntax":"[progress] call BIS_fnc_progressLoadingScreen","params":[{"name":"progress","type":"Number","description":"progress in range from 0 to 1","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number","description":"progress"}}],"examples":[{"code":["private _IDD = _prog = [0.75] call BIS_fnc_progressLoadingScreen;"]}],"see_also":["Loading Screens","BIS_fnc_displayLoading"]},{"name":"BIS_fnc_pulsate","title":"BIS fnc pulsate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_pulsate","revid":349285,"updated":"2023-11-08T14:51:14Z","groups":["Math"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Pulsates a value from 0 to 1.","syntaxes":[{"syntax":"[frequency] call BIS_fnc_pulsate","params":[{"name":"frequency","type":"Number","description":"the frequency in Hz, 1 / _frequency = 0.1 second is the period","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number"}}],"examples":[{"code":["200 call BIS_fnc_pulsate; // 0.113001"]}]},{"name":"BIS_fnc_quinticIn","title":"BIS fnc quinticIn","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_quinticIn","revid":274393,"updated":"2021-06-13T01:21:57Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_quinticIn","params":[],"returns":null}]},{"name":"BIS_fnc_quinticInOut","title":"BIS fnc quinticInOut","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_quinticInOut","revid":274401,"updated":"2021-06-13T01:22:04Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_quinticInOut","params":[],"returns":null}]},{"name":"BIS_fnc_quinticInOutVector","title":"BIS fnc quinticInOutVector","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_quinticInOutVector","revid":274378,"updated":"2021-06-13T01:21:42Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_quinticInOutVector","params":[],"returns":null}]},{"name":"BIS_fnc_quinticInVector","title":"BIS fnc quinticInVector","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_quinticInVector","revid":274371,"updated":"2021-06-13T01:21:33Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_quinticInVector","params":[],"returns":null}]},{"name":"BIS_fnc_quinticOut","title":"BIS fnc quinticOut","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_quinticOut","revid":274443,"updated":"2021-06-13T01:22:42Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_quinticOut","params":[],"returns":null}]},{"name":"BIS_fnc_quinticOutVector","title":"BIS fnc quinticOutVector","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_quinticOutVector","revid":274426,"updated":"2021-06-13T01:22:24Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_quinticOutVector","params":[],"returns":null}]},{"name":"BIS_fnc_quotations","title":"BIS fnc quotations","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_quotations","revid":364623,"updated":"2024-05-22T23:28:47Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Display a quotation video.","syntaxes":[{"syntax":"[videoPath, nonEnglishSubtitle] call BIS_fnc_quotations","params":[{"name":"videoPath","type":"String","description":"path to video.\n\n- `a3\\data_f_argo\\video\\preview_argo.ogv`\n- `a3\\data_f_curator\\video\\preview_curator.ogv`\n- `a3\\data_f_exp\\video\\preview_expansion.ogv`\n- `a3\\data_f_heli\\video\\preview_heli.ogv`\n- `a3\\data_f_jets\\video\\preview_jets.ogv`\n- `a3\\data_f_kart\\video\\preview_kart.ogv`\n- `a3\\data_f_mark\\video\\preview_mark.ogv`\n- `a3\\data_f_orange\\video\\preview_orange.ogv`\n- `a3\\data_f_tank\\video\\preview_tank.ogv`\n- `a3\\map_altis_scenes_f\\video\\previewvideo.ogv`\n- `a3\\map_malden_scenes_f\\video\\previewvideo.ogv`\n- `a3\\map_stratis_scenes_f\\video\\previewvideo.ogv`\n- `a3\\map_tanoa_scenes_f\\video\\previewvideo.ogv`\n- `a3\\map_vr_scenes_f\\video\\previewvideo.ogv`\n- `a3\\missions_f\\video\\helicopters.ogv`\n- `a3\\missions_f\\video\\infantry.ogv`\n- `a3\\missions_f\\video\\scuba.ogv`\n- `a3\\missions_f\\video\\supports.ogv`\n- `a3\\missions_f\\video\\vehicles.ogv`\n- `a3\\missions_f_beta\\video\\combined_arms.ogv`\n- `a3\\missions_f_beta\\video\\commanding.ogv`\n- `a3\\missions_f_beta\\video\\defend.ogv`\n- `a3\\missions_f_beta\\video\\night.ogv`\n- `a3\\missions_f_beta\\video\\supports.ogv`\n- `a3\\missions_f_bootcamp\\video\\boot_m05_sometime_later.ogv`\n- `a3\\missions_f_bootcamp\\video\\vr_boot.ogv`\n- `a3\\missions_f_bootcamp\\video\\vr_generictransition_1.ogv`\n- `a3\\missions_f_bootcamp\\video\\vr_generictransition_2.ogv`\n- `a3\\missions_f_bootcamp\\video\\vr_generictransition_3.ogv`\n- `a3\\missions_f_curator\\data\\video\\showcase_curator.ogv`\n- `a3\\missions_f_epa\\video\\a_hub_quotation.ogv`\n- `a3\\missions_f_epa\\video\\a_in2_quotation.ogv`\n- `a3\\missions_f_epa\\video\\a_in2_two_hours_later.ogv`\n- `a3\\missions_f_epa\\video\\a_in_intro.ogv`\n- `a3\\missions_f_epa\\video\\a_in_quotation.ogv`\n- `a3\\missions_f_epa\\video\\a_m01_quotation.ogv`\n- `a3\\missions_f_epa\\video\\a_m02_quotation.ogv`\n- `a3\\missions_f_epa\\video\\a_m03_quotation.ogv`\n- `a3\\missions_f_epa\\video\\a_m04_quotation.ogv`\n- `a3\\missions_f_epa\\video\\a_m05_quotation.ogv`\n- `a3\\missions_f_epa\\video\\a_out_quotation.ogv`\n- `a3\\missions_f_epa\\video\\a_out_some_time_later.ogv`\n- `a3\\missions_f_epa\\video\\a_out_to_be_continued.ogv`\n- `a3\\missions_f_epa\\video\\b_hub01_10_days_later.ogv`\n- `a3\\missions_f_epa\\video\\b_hub01_few_hours_later.ogv`\n- `a3\\missions_f_epa\\video\\b_hub01_quotation.ogv`\n- `a3\\missions_f_epa\\video\\b_in2_12_hours_later.ogv`\n- `a3\\missions_f_epa\\video\\b_in_quotation.ogv`\n- `a3\\missions_f_epa\\video\\b_m01_quotation.ogv`\n- `a3\\missions_f_epa\\video\\b_m02_1_quotation.ogv`\n- `a3\\missions_f_epa\\video\\b_m03_quotation.ogv`\n- `a3\\missions_f_epa\\video\\b_m05_quotation.ogv`\n- `a3\\missions_f_epa\\video\\b_m06_quotation.ogv`\n- `a3\\missions_f_epa\\video\\b_out2_quotation.ogv`\n- `a3\\missions_f_epa\\video\\b_out2_sometime_later.ogv`\n- `a3\\missions_f_epa\\video\\c_ea_quotation.ogv`\n- `a3\\missions_f_epa\\video\\c_eb_quotation.ogv`\n- `a3\\missions_f_epa\\video\\c_in1_quotation.ogv`\n- `a3\\missions_f_epa\\video\\c_in2_quotation.ogv`\n- `a3\\missions_f_epa\\video\\c_m01_quotation.ogv`\n- `a3\\missions_f_epa\\video\\c_m02_quotation.ogv`\n- `a3\\missions_f_epa\\video\\c_out1_quotation.ogv`\n- `a3\\missions_f_epa\\video\\c_out2_sometime_later.ogv`\n- `a3\\missions_f_epa\\video\\fixed_wings.ogv`\n- `a3\\missions_f_exp\\video\\endgame.ogv`\n- `a3\\missions_f_exp\\video\\exp_m01_v01.ogv`\n- `a3\\missions_f_exp\\video\\exp_m01_vbohemia.ogv`\n- `a3\\missions_f_exp\\video\\exp_m01_vlogo.ogv`\n- `a3\\missions_f_exp\\video\\exp_m02_vin.ogv`\n- `a3\\missions_f_exp\\video\\exp_m02_vtimeline.ogv`\n- `a3\\missions_f_exp\\video\\exp_m02_vtitlecard.ogv`\n- `a3\\missions_f_exp\\video\\exp_m03_vin.ogv`\n- `a3\\missions_f_exp\\video\\exp_m03_vtimeline.ogv`\n- `a3\\missions_f_exp\\video\\exp_m03_vtitlecard.ogv`\n- `a3\\missions_f_exp\\video\\exp_m04_v01.ogv`\n- `a3\\missions_f_exp\\video\\exp_m04_v02.ogv`\n- `a3\\missions_f_exp\\video\\exp_m04_v03.ogv`\n- `a3\\missions_f_exp\\video\\exp_m04_vin.ogv`\n- `a3\\missions_f_exp\\video\\exp_m04_vtimeline.ogv`\n- `a3\\missions_f_exp\\video\\exp_m04_vtitlecard.ogv`\n- `a3\\missions_f_exp\\video\\exp_m05_vin.ogv`\n- `a3\\missions_f_exp\\video\\exp_m05_vtimeline.ogv`\n- `a3\\missions_f_exp\\video\\exp_m05_vtitlecard.ogv`\n- `a3\\missions_f_exp\\video\\exp_m06_v01.ogv`\n- `a3\\missions_f_exp\\video\\exp_m06_vin.ogv`\n- `a3\\missions_f_exp\\video\\exp_m06_vintel.ogv`\n- `a3\\missions_f_exp\\video\\exp_m06_vtitlecard.ogv`\n- `a3\\missions_f_exp\\video\\exp_m07_vin.ogv`\n- `a3\\missions_f_exp\\video\\exp_m07_vout.ogv`\n- `a3\\missions_f_exp\\video\\exp_m07_vtitlecard.ogv`\n- `a3\\missions_f_exp\\video\\vtol.ogv`\n- `a3\\missions_f_gamma\\video\\arma.ogv`\n- `a3\\missions_f_gamma\\video\\drones.ogv`\n- `a3\\missions_f_gamma\\video\\faction_blufor.ogv`\n- `a3\\missions_f_gamma\\video\\faction_independent.ogv`\n- `a3\\missions_f_gamma\\video\\faction_opfor.ogv`\n- `a3\\missions_f_gamma\\video\\gunships.ogv`\n- `a3\\missions_f_gamma\\video\\tanks.ogv`\n- `a3\\missions_f_heli\\video\\slingloading.ogv`\n- `a3\\missions_f_jets\\video\\showcase_jets_intro_01.ogv`\n- `a3\\missions_f_mark\\video\\ffv.ogv`\n- `a3\\missions_f_mark\\video\\marksman.ogv`\n- `a3\\missions_f_orange\\video\\faction_idap.ogv`\n- `a3\\missions_f_orange\\video\\laws_of_war.ogv`\n- `a3\\missions_f_orange\\video\\laws_of_war_establishing_shot.ogv`\n- `a3\\missions_f_tank\\video\\tanks_destroyers.ogv`\n- `a3\\props_f_argo\\items\\electronics\\data\\oldlaptop_video.ogv`\n- `a3\\ui_f\\video\\preview_dlcbundle.ogv`\n- `a3\\ui_f\\video\\preview_dlcbundle2.ogv`\n- `a3\\ui_f\\video\\spotlight3.ogv`\n- `a3\\ui_f\\video\\spotlight_1_apex.ogv`\n- `a3\\ui_f\\video\\spotlight_1_bootcamp.ogv`\n- `a3\\ui_f\\video\\spotlight_1_eastwind.ogv`\n- `a3\\ui_f\\video\\spotlight_1_old_man.ogv`\n- `a3\\ui_f\\video\\spotlight_2.ogv`\n- `a3\\ui_f_oldman\\video\\spotlight_a.ogv`\n- `a3\\ui_f_oldman\\video\\spotlight_fd14.ogv`\n- `a3\\ui_f_orange\\video\\spotlight_a.ogv`\n- `a3\\ui_f_orange\\video\\spotlight_b.ogv`\n- `a3\\ui_f_orange\\video\\spotlight_c.ogv`\n- `a3\\ui_f_tank\\video\\spotlight_a.ogv`\n- `a3\\ui_f_tank\\video\\spotlight_b.ogv`","type_expr":"String"},{"name":"nonEnglishSubtitle","type":"String","description":"string, localised or not, used for subtitles that is only shown if the game's language is not English","type_expr":"String"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"a3\\missions_f_mark\\video\\ffv.ogv\"] spawn BIS_fnc_quotations;"]}],"see_also":["BIS_fnc_playVideo"]},{"name":"BIS_fnc_radialRed","title":"BIS fnc radialRed","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_radialRed","revid":328484,"updated":"2022-07-13T16:11:13Z","groups":["Feedback"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Red radial postprocess (hit damage, fire damage). Parameters are the same as the first four of HandleDamage EH.","syntaxes":[{"syntax":"[victim, bodyPart, damage, shooter] call BIS_fnc_radialRed","params":[{"name":"victim","type":"Object","description":"unit who gets damage","type_expr":"Object"},{"name":"bodyPart","type":"String","description":"body part which gets damage","type_expr":"String"},{"name":"damage","type":"Number","description":"received damage amount","type_expr":"Number"},{"name":"shooter","type":"Object","optional":true,"default":"objNull","description":"requested only if *bodyPart* is not empty string","type_expr":"Object","text":"shooter: Object - (Optional, default objNull) requested only if *bodyPart* is not empty string"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["player addEventHandler [\"HandleDamage\", { _this call BIS_fnc_radialRed; }];"]}],"see_also":["Arma 3: Event Handlers","BIS_fnc_radialRedOut"]},{"name":"BIS_fnc_radialRedOut","title":"BIS fnc radialRedOut","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_radialRedOut","revid":309775,"updated":"2022-05-05T12:09:49Z","groups":["Feedback"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Removes red radial postprocess (fire damage) created by BIS_fnc_radialRed.","syntaxes":[{"syntax":"call BIS_fnc_radialRedOut","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_radialRedOut;"]}],"see_also":["BIS_fnc_radialRed"]},{"name":"BIS_fnc_radioChannelIDToChannelNum","title":"BIS fnc radioChannelIDToChannelNum","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_radioChannelIDToChannelNum","revid":376821,"updated":"2025-11-21T22:05:44Z","groups":["Radio"],"status":"ok","games":{"arma3":"2.22"},"since":"arma3 2.22","arma3_since":"2.22","description":"Converts radio channel id, used in radioChannelAdd, radioChannelSetLabel, etc to chat channel number, used in currentChannel, enableChannel, etc.","syntaxes":[{"syntax":"radioChannelID call BIS_fnc_radioChannelIDToChannelNum","params":[{"name":"radioChannelID","type":"Number","description":"radio channel id (1..50)","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number","description":"channel number (6..15, 26..65)"}}],"examples":[{"code":["11 call BIS_fnc_radioChannelIDToChannelNum; //26"]}],"see_also":["BIS_fnc_channelNumToRadioChannelID","radioChannelCreate","currentChannel"]},{"name":"BIS_fnc_radioSetChannel","title":"BIS fnc radioSetChannel","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_radioSetChannel","revid":309881,"updated":"2022-05-05T12:09:54Z","groups":["Radio"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Set a specific or random music channel.","syntaxes":[{"syntax":"[channel, next, override] call BIS_fnc_radioSetChannel","params":[{"name":"channel","type":"String","type_expr":"String","description":"(String)","text":"0: (String)","source":"docblock"},{"name":"next","type":"Boolean","type_expr":"Boolean","description":"(Bool)","text":"1: (Bool)","source":"docblock"},{"name":"override","type":"Boolean","type_expr":"Boolean","description":"(Bool)","text":"2: (Bool)","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","text":"Bool","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nSet a specific or random music channel.\n\nParameter(s):\n_this select 0: channel (String)\n_this select 1: next (Bool)\n_this select 2: override (Bool)\n\nReturns:\nBool"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_radioSetPlaylist","title":"BIS fnc radioSetPlaylist","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_radioSetPlaylist","revid":327542,"updated":"2022-07-12T22:38:04Z","groups":["Radio"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Set a random music playlist for the current set channel (default \"Rock\"). Musics with \"genre\" set in CfgMusic are selected and shuffled.","syntaxes":[{"syntax":"call BIS_fnc_radioSetPlaylist","params":[],"returns":{"type":"Array of Strings","type_expr":"Array<String>","description":"created music playlist"}}],"examples":[{"code":["call BIS_fnc_radioSetPlaylist;"]}],"see_also":["BIS_fnc_radioSetChannel","BIS_fnc_radioSetTrack"]},{"name":"BIS_fnc_radioSetTrack","title":"BIS fnc radioSetTrack","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_radioSetTrack","revid":309831,"updated":"2022-05-05T12:09:52Z","groups":["Radio"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Set a specific or random music track.","syntaxes":[{"syntax":"[track, override, param2] call BIS_fnc_radioSetTrack","params":[{"name":"track","type":"String","type_expr":"String","description":"(String)","text":"0: (String)","source":"docblock"},{"name":"override","type":"Boolean","type_expr":"Boolean","description":"(Bool)","text":"1: (Bool)","source":"docblock"},{"name":"param2","type":"Boolean","type_expr":"Boolean","text":"2: Bool (first track? -> start randomly within the track)","source":"docblock"}],"returns":{"type":"Array, Number","types":["Array","Number"],"type_expr":"Array","text":"Array (duration (s): Scalar, start time (s): Scalar)","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nSet a specific or random music track.\n\nParameter(s):\n_this select 0: track (String)\n_this select 1: override (Bool)\n_this select 2: Bool (first track? -> start randomly within the track)\n\nReturns:\nArray (duration (s): Scalar, start time (s): Scalar)"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_randomIndex","title":"BIS fnc randomIndex","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_randomIndex","revid":327174,"updated":"2022-07-12T22:07:07Z","groups":["Arrays"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Return a random integer representing an index in the passed array.","syntaxes":[{"syntax":"array call BIS_fnc_randomIndex","params":[{"name":"array","type":"Array of Anything","type_expr":"Array<Anything>"}],"returns":{"type":"Number","type_expr":"Number"}}],"examples":[{"code":["[\"a\", 0, objNull] call BIS_fnc_randomIndex; // returns 0, 1 or 2"]}],"see_also":["floor","count","random","selectRandom"]},{"name":"BIS_fnc_randomInt","title":"BIS fnc randomInt","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_randomInt","revid":327175,"updated":"2022-07-12T22:07:31Z","groups":["Math"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Returns a random integer between the two passed numbers (inclusive). The order of parameters doesn't matter: it can be `[min, max]` or `[max, min]`.","syntaxes":[{"syntax":"[min, max] call BIS_fnc_randomInt","params":[{"name":"min","type":"Number","description":"minimum value, included","type_expr":"Number"},{"name":"max","type":"Number","description":"maximum value, included","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number"}}],"examples":[{"code":["[1, 3] call BIS_fnc_randomInt; // will return 1, 2 or 3"]}],"see_also":["BIS_fnc_randomNum","BIS_fnc_arithmeticMean","BIS_fnc_geometricMean","BIS_fnc_nearestNum","BIS_fnc_sortNum","BIS_fnc_roundNum"]},{"name":"BIS_fnc_randomNum","title":"BIS fnc randomNum","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_randomNum","revid":338225,"updated":"2023-02-24T13:01:16Z","groups":["Math"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Returns a random (float) number between the two passed numbers. The order of parameters doesn't matter: it can be `[min, max]` or `[max, min]`.","syntaxes":[{"syntax":"[min, max] call BIS_fnc_randomNum","params":[{"name":"min","type":"Number","description":"minimum value, inclusive","type_expr":"Number"},{"name":"max","type":"Number","description":"maximum value, exclusive","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number"}}],"examples":[{"code":["[1, 3] call BIS_fnc_randomNum; // return a number between 1 and 3, including 1"]}],"see_also":["BIS_fnc_randomInt","BIS_fnc_arithmeticMean","BIS_fnc_geometricMean","BIS_fnc_nearestNum","BIS_fnc_sortNum","BIS_fnc_roundNum"]},{"name":"BIS_fnc_randomPos","title":"BIS fnc randomPos","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_randomPos","revid":349485,"updated":"2023-11-08T17:09:03Z","groups":["Positions"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Selects random position according to given params within given area","syntaxes":[{"syntax":"[whitelist, blacklist, code] call BIS_fnc_randomPos","params":[{"name":"whitelist","type":"Array","description":"whitelisted areas. If not given, whole map is used. Areas can be:\n\n- Object - trigger\n- String - marker\n- Array - in format [center, radius] or [center, [a, b, angle, rect]]\n- Location - location","type_expr":"Array"},{"name":"blacklist","type":"Array","optional":true,"default":"`[]`","description":"blacklisted areas. If not given, water is blacklisted. Areas can be:\n\n- Object - trigger\n- String - marker name or special tags names: \"water\" - exclude water, \"ground\" - exclude land\n- Array - in format [center, radius] or [center, [a, b, angle, rect]]\n- Location - location","type_expr":"Array","text":"blacklist: Array - (Optional, default `[]`) blacklisted areas. If not given, water is blacklisted. Areas can be:\n\n- Object - trigger\n- String - marker name or special tags names: \"water\" - exclude water, \"ground\" - exclude land\n- Array - in format [center, radius] or [center, [a, b, angle, rect]]\n- Location - location"},{"name":"code","type":"Code","optional":true,"default":"`{ true }`","description":"custom condition which should return true for current position candidate passed in _this variable to be accepted. If not specified all candidates are accepted","type_expr":"Code","text":"code: Code - (Optional, default `{ true }`) custom condition which should return true for current position candidate passed in _this variable to be accepted. If not specified all candidates are accepted"}],"returns":{"type":"Array","type_expr":"Array","description":"position candidate in format [x,y,z] or [0,0] if position cannot be found"}}],"examples":[{"code":["private _randomPosMapNoWater = [] call BIS_fnc_randomPos;"]},{"code":["private _randomPosMapNoWater = [nil, [\"water\"]] call BIS_fnc_randomPos;"]},{"code":["private _randomPosMapNoLand = [nil, [\"ground\"]] call BIS_fnc_randomPos;"]},{"code":["private _randomPosMap = [nil, []] call BIS_fnc_randomPos;"]},{"code":["private _randomPosAroundPlayer = [[[position player, 50]], []] call BIS_fnc_randomPos;"]}],"see_also":["BIS_fnc_randomPosTrigger","BIS_fnc_getArea","BIS_fnc_findSafePos"],"notes":[{"user":"Tankbuster","date":"2020-03-30T21:33:00Z","text":"The code parameter here can be quite powerful.\nIf using Example 5 above, adding code as below will make the returned positions always be on a road.\n\n```sqf\nprivate _randomRoadPosAroundPlayer = [[[position player, 50]], [], { isOnRoad _this }] call BIS_fnc_randomPos;\n```"}]},{"name":"BIS_fnc_randomPosIntersection","title":"BIS fnc randomPosIntersection","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_randomPosIntersection","revid":349156,"updated":"2023-11-08T14:49:50Z","groups":["Positions","Geometry"],"status":"ok","games":{"arma3":"1.82"},"since":"arma3 1.82","arma3_since":"1.82","description":"Returns random 2D position inside the intersection of two circles. [-1,-1] is returned if the circles do not intersect.","syntaxes":[{"syntax":"[firstCircle, secondCircle, positioning1, positioning2] call BIS_fnc_randomPosIntersection","params":[{"name":"firstCircle","type":"Object, String or Array","description":"first circle. Can be a trigger, a marker or an array in form\n\n- 0: Array - circleCenter\n  - 0: Number - coordinate X\n  - 1: Number - coordinate Y\n- 1: Number - radius","type_expr":"Object | String | Array"},{"name":"secondCircle","type":"Object, String or Array","description":"second circle. Same as above.","type_expr":"Object | String | Array"},{"name":"positioning1","type":"Number","optional":true,"default":"-1","description":"if a value between 0 and 1 is passed (0 and 1 included), then a gaussian distribution is used. This will influence the random position along the axis which connects the two circles' centers. A lower value means the position will be close to the first circle","type_expr":"Number","text":"positioning1: Number - (Optional, default -1) if a value between 0 and 1 is passed (0 and 1 included), then a gaussian distribution is used. This will influence the random position along the axis which connects the two circles' centers. A lower value means the position will be close to the first circle"},{"name":"positioning2","type":"Number","optional":true,"default":"-1","description":"if a value between 0 and 1 is passed (0 and 1 included), then a gaussian distribution is used. This will influence the random position along the axis perpendicular to the axis which connects the two circles' centers","type_expr":"Number","text":"positioning2: Number - (Optional, default -1) if a value between 0 and 1 is passed (0 and 1 included), then a gaussian distribution is used. This will influence the random position along the axis perpendicular to the axis which connects the two circles' centers"}],"returns":{"type":"Array","type_expr":"Array","description":"2D Position"}}],"examples":[{"code":["[trigger1, trigger2, 0.75, 0.75] call BIS_fnc_randomPosIntersection;"]}]},{"name":"BIS_fnc_randomPosTrigger","title":"BIS fnc randomPosTrigger","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_randomPosTrigger","revid":379507,"updated":"2026-10-31T00:27:58Z","groups":["Map and Markers"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Selects random position within trigger, marker, location area or area defined by array","syntaxes":[{"syntax":"param call BIS_fnc_randomPosTrigger","params":[{"name":"param","type":"Object, String, Location or Array","description":"Object, String, Location or Array\n\n- Object - trigger\n- String - marker\n- Location - location\n- Array - array in format [center, distance] or [center, [a, b, angle, rect]] or [center, [a, b, angle, rect, height]]\n\n> [!NOTE]\n> Be aware that the `height` value is ignored.","type_expr":"Object | String | Location | Array","text":"param: Object, String, Location or Array\n\n- Object - trigger\n- String - marker\n- Location - location\n- Array - array in format [center, distance] or [center, [a, b, angle, rect]] or [center, [a, b, angle, rect, height]]\n\n> [!NOTE]\n> Be aware that the `height` value is ignored."}],"returns":{"type":"Array","type_expr":"Array","description":"random position in format [x,y,z]"}}],"examples":[{"code":["marker1 call BIS_fnc_randomPosTrigger;"]}],"see_also":["BIS_fnc_findSafePos"]},{"name":"BIS_fnc_rankParams","title":"BIS fnc rankParams","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_rankParams","revid":328370,"updated":"2022-07-13T16:00:47Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Return information about military rank.\n\n1: STRING - requited data, can be one of following:\n\"displayName\" - full localized name (e.g. \"Major\")\n\"displayNameShort\" - short localized name (e.g. \"Maj.\")\n\"classname\" - system name (e.g. \"MAJOR\")\n\"texture\" - path to rank insignia","syntaxes":[{"syntax":"[source, infoType] call BIS_fnc_rankParams","params":[{"name":"source","type":"Number, String or Object","description":"can be one of:\n\n- Number - rank ID\n- String - rank system name (e.g. \"PRIVATE\", \"CORPORAL\", …)\n- Object - person whose rank is checked","type_expr":"Number | String | Object"},{"name":"infoType","type":"String","description":"can be one of:\n\n- \"displayName\" - full localized name (e.g. \"Major\")\n- \"displayNameShort\" - short localized name (e.g. \"Maj.\")\n- \"classname\" - system name (e.g. \"MAJOR\")\n- \"texture\" - path to rank insignia","type_expr":"String"}],"returns":{"type":"String","type_expr":"String"}}],"examples":[{"code":["private _shortRank = [player, \"displayNameShort\"] call BIS_fnc_rankParams;"]}],"see_also":["rank","setUnitRank"]},{"name":"BIS_fnc_recompile","title":"BIS fnc recompile","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_recompile","revid":379508,"updated":"2026-10-31T00:28:06Z","groups":["Diagnostic"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Can be used to recompile functions.\n\n> [!NOTE]\n> As a security measure, functions are by default protected against rewriting during the mission. This restriction does **not** apply to:\n>\n> - missions previewed from the editor\n> - missions with the following attribute in Description.ext:\n>\n>   ```cpp\n>   allowFunctionsRecompile = 1;\n>   ```","syntaxes":[{"syntax":"[mode] call BIS_fnc_recompile","params":[{"name":"mode","type":"String or Number","optional":true,"default":"0","description":"String - name of the function to be recompiled\n- Number - can be:\n  - 0 - Autodetect what compile type should be used\n  - 1 - Forced recompile of all the things\n  - 2 - Create only uiNamespace variables (used in UI)\n  - 3 - Create missionNamespace variables and initialize mission\n  - 4 - Create only missionNamespace variables\n  - 5 - Recompile all functions, and initialize mission (used for editor preview with function recompile)","type_expr":"String | Number","text":"mode: String or Number - (Optional, default 0)\n\n- String - name of the function to be recompiled\n- Number - can be:\n  - 0 - Autodetect what compile type should be used\n  - 1 - Forced recompile of all the things\n  - 2 - Create only uiNamespace variables (used in UI)\n  - 3 - Create missionNamespace variables and initialize mission\n  - 4 - Create only missionNamespace variables\n  - 5 - Recompile all functions, and initialize mission (used for editor preview with function recompile)"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[] call BIS_fnc_recompile;"]},{"code":["[3] call BIS_fnc_recompile;"]},{"code":["[\"BIS_fnc_spawnVehicle\"] call BIS_fnc_recompile;"]}],"see_also":["compile","compileFinal"]},{"name":"BIS_fnc_reenableRevive","title":"BIS fnc reenableRevive","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_reenableRevive","revid":348219,"updated":"2023-11-08T11:40:22Z","groups":["Revive"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","description":"Enable revive on given unit. Revive system needs to be initialized and running.","syntaxes":[{"syntax":"[player] call BIS_fnc_reenableRevive","params":[{"name":"player","type":"Object","description":"affected player","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[BIS_unit] call BIS_fnc_reenableRevive;"]}],"see_also":["Arma 3: Revive","BIS_fnc_disableRevive","BIS_fnc_reviveAllowed","BIS_fnc_reviveBleedOut","BIS_fnc_reviveDamageReset","BIS_fnc_reviveDebug","BIS_fnc_reviveEhDammaged","BIS_fnc_reviveEhHandleDamage","BIS_fnc_reviveEhHandleHeal","BIS_fnc_reviveEhKilled","BIS_fnc_reviveEhRespawn","BIS_fnc_reviveEnabled","BIS_fnc_reviveGet3dIcons","BIS_fnc_reviveGetActionIcon","BIS_fnc_reviveIconControl","BIS_fnc_reviveInit","BIS_fnc_reviveIsValid","BIS_fnc_reviveIsValidSecure","BIS_fnc_reviveOnBeingRevived","BIS_fnc_reviveOnForcingRespawn","BIS_fnc_reviveOnState","BIS_fnc_reviveOnStateJIP","BIS_fnc_reviveSecureUnit"]},{"name":"BIS_fnc_refreshCommMenu","title":"BIS fnc refreshCommMenu","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_refreshCommMenu","revid":323711,"updated":"2022-07-01T11:53:36Z","groups":["Communication Menu"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Refresh the communication menu variable.","syntaxes":[{"syntax":"call BIS_fnc_refreshCommMenu","params":[],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if successful"}}],"examples":[{"code":["call BIS_fnc_refreshCommMenu;"]}],"see_also":["BIS_fnc_commsMenuToggleVisibility","BIS_fnc_commsMenuCreate"]},{"name":"BIS_fnc_registerCuratorObject","title":"BIS fnc registerCuratorObject","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_registerCuratorObject","revid":376684,"updated":"2025-11-04T22:53:26Z","groups":["Curator"],"status":"deprecated","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Get individual cost of an object.\n\n> [!IMPORTANT]\n> This function is obsolete.","syntaxes":[{"syntax":"[class, status, cost] call BIS_fnc_registerCuratorObject","params":[{"name":"class","type":"String","description":"object class","type_expr":"String"},{"name":"status","type":"Boolean","description":"true to show status","type_expr":"Boolean"},{"name":"cost","type":"Number","description":"default cost","type_expr":"Number"}],"returns":{"type":"Array","type_expr":"Array","description":"in format:\n1. show 1. cost 1. cost","text":"Array in format:\n\n1. show\n1. cost\n1. cost"}}],"examples":[{"code":["[\"someClass\", true, 5] call BIS_fnc_registerCuratorObject;"]}],"see_also":["Arma 3: Curator"]},{"name":"BIS_fnc_relativeDirTo","title":"BIS fnc relativeDirTo","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_relativeDirTo","revid":327966,"updated":"2022-07-13T13:59:46Z","groups":["Geometry"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Returns the relative direction from object 1 to object/position 2. Return value is always in between 0 and 360.\n\n> [!NOTE]\n> **Arma 3:** Use getRelDir instead.","syntaxes":[{"syntax":"[from, to] call BIS_fnc_relativeDirTo","params":[{"name":"from","type":"Object","type_expr":"Object"},{"name":"to","type":"Object or Array format Position","type_expr":"Object | Position","types":["Object","Array","Position"]}],"returns":{"type":"Number","type_expr":"Number"}}],"examples":[{"code":["[[0,0,0], player] call BIS_fnc_relativeDirTo;"]}],"see_also":["getPos","getRelDir","direction"]},{"name":"BIS_fnc_relPos","title":"BIS fnc relPos","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_relPos","revid":327958,"updated":"2022-07-13T13:07:01Z","groups":["Positions","Geometry"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Returns a position that is a specified distance and compass direction from the passed position or object.\n\n> [!NOTE]\n> **Arma 3:** In Arma 3 use getPos' alternative syntax instead.","syntaxes":[{"syntax":"[origin, distance, direction] call BIS_fnc_relPos","params":[{"name":"origin","type":"Object or Position","description":"object or position which should be used as initial point.","type_expr":"Object | Position"},{"name":"distance","type":"Number","description":"distance from initial point","type_expr":"Number"},{"name":"direction","type":"Number","description":"direction from the intial position","type_expr":"Number"}],"returns":{"type":"Position","type_expr":"Position"}}],"examples":[{"code":["[[0,0,0], 1000, 50] call BIS_fnc_relPos; // [766.044,642.788,0]"]}],"see_also":["getPos"],"notes":[{"user":"Lawman Actual","date":"2016-01-07T19:26:00Z","text":"The function appears to work in two dimensions, and as such can be used to find the position of a target relative to the player if bearing and distance are known.\n\nHowever, if there is a significant change in elevation between yourself and the target, the distance registered on a rangefinder (which is measuring in a 3-dimensional straight line) will always be larger than the two-dimensional value required for BIS_fnc_relPos and as such air-strikes and ordnance called in using such a function can miss by several hundred metres in extreme cases.\n\nCurrently searching for a method which incorporates the azimuth of the rangefinder in calculation."}]},{"name":"BIS_fnc_relPosObject","title":"BIS fnc relPosObject","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_relPosObject","revid":327211,"updated":"2022-07-12T22:11:45Z","groups":["Positions","Geometry"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Place an object relative to another object, like a *setRelPos* command.","syntaxes":[{"syntax":"[parent, child, relPos, direction] call BIS_fnc_relPosObject","params":[{"name":"parent","type":"Object","description":"the parent object","type_expr":"Object"},{"name":"child","type":"Object","description":"the child object","type_expr":"Object"},{"name":"relPos","type":"Position","description":"*child* position relative to *parent*","type_expr":"Position"},{"name":"direction","type":"Number","optional":true,"default":"0","description":"direction of the child object","type_expr":"Number","text":"direction: Number - (Optional, default 0) direction of the child object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[BIS_briefingTable, BIS_map, [0, -0.58, 0.857], 98] call BIS_fnc_relPosObject;"]}],"see_also":["getRelPos","getPos"]},{"name":"BIS_fnc_relScaledDist","title":"BIS fnc relScaledDist","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_relScaledDist","revid":349415,"updated":"2023-11-08T16:27:30Z","groups":["Geometry"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Exponentially inflated rational number between 0 and 1, with 1 being center and 0 being edge of the trigger. This function can be used to check where in a trigger area an object is. Is it near the border of the trigger area the number will go against 0.","syntaxes":[{"syntax":"[referenceObject, relativeObject] call BIS_fnc_relScaledDist","params":[{"name":"referenceObject","type":"Object","type_expr":"Object"},{"name":"relativeObject","type":"Object","type_expr":"Object"}],"returns":{"type":"Number","type_expr":"Number"}}],"examples":[{"code":["[myTrigger, player] call BIS_fnc_relScaledDist;"]}],"see_also":["distance","distanceSqr"]},{"name":"BIS_fnc_removeAllScriptedEventHandlers","title":"BIS fnc removeAllScriptedEventHandlers","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_removeAllScriptedEventHandlers","revid":327917,"updated":"2022-07-13T12:09:31Z","groups":["Event Handlers"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Removes all scripted event handler with given name.\nAdditionally \"ScriptedEventHandlerRemoved\" scripted EH is called for every removed event handler.\n\n> [!NOTE]\n> For a list of available scripted event handlers, see Arma 3: Scripted Event Handlers.","syntaxes":[{"syntax":"[namespace, name] call BIS_fnc_removeAllScriptedEventHandlers","params":[{"name":"namespace","type":"Namespace, Object, Group, Location, Boolean, Control or Display","description":"namespace in which handler is saved","type_expr":"Namespace | Object | Group | Location | Boolean | Control | Display"},{"name":"name","type":"String","description":"handler name","type_expr":"String"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"false if never existed, true otherwise"}}],"examples":[{"code":["[missionNamespace, \"event\"] call BIS_fnc_removeAllScriptedEventHandlers;"]}],"see_also":["BIS_fnc_callScriptedEventHandler","BIS_fnc_addScriptedEventHandler","BIS_fnc_removeScriptedEventHandler"]},{"name":"BIS_fnc_removeCommMenuItem","title":"BIS fnc removeCommMenuItem","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_removeCommMenuItem","revid":327871,"updated":"2022-07-13T11:39:50Z","groups":["Communication Menu"],"status":"ok","games":{"arma3":"0.50"},"since":"arma3 0.50","arma3_since":"0.50","locality":{"effect":"local"},"description":"Remove an item from the communication menu.","syntaxes":[{"syntax":"[owner,itemID] call BIS_fnc_removeCommMenuItem","params":[{"name":"owner","type":"Object","description":"object to which the item belongs to","type_expr":"Object","text":"**owner**: Object - object to which the item belongs to"},{"name":"itemID","type":"Number","description":"item ID returned by BIS_fnc_addCommMenuItem command","type_expr":"Number","text":"**itemID**: Number - item ID returned by BIS_fnc_addCommMenuItem command"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when the item was removed"}}],"examples":[{"code":["[player, 2] call BIS_fnc_removeCommMenuItem;"]},{"code":["private _supportHeli = [player, \"Support_Request_CAS_Heli\"] call BIS_fnc_addCommMenuItem;\n[player, _supportHeli] call BIS_fnc_removeCommMenuItem;"]}],"see_also":["BIS_fnc_addCommMenuItem","Arma 3: Communication Menu"]},{"name":"BIS_fnc_removeCuratorIcon","title":"BIS fnc removeCuratorIcon","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_removeCuratorIcon","revid":348760,"updated":"2023-11-08T14:33:12Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Remove icon displayed in curator interface.","syntaxes":[{"syntax":"[object, id] call BIS_fnc_removeCuratorIcon","params":[{"name":"object","type":"Object","description":"curator module","type_expr":"Object"},{"name":"id","type":"Array","description":"icon ID returned by BIS_fnc_addCuratorIcon function","type_expr":"Array"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when removed"}}],"examples":[{"code":["[curatorModule, 5] call BIS_fnc_removeCuratorIcon;"]}],"see_also":["Arma 3: Curator","BIS_fnc_addCuratorIcon"]},{"name":"BIS_fnc_removeDestroyedCuratorEditableObjects","title":"BIS fnc removeDestroyedCuratorEditableObjects","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_removeDestroyedCuratorEditableObjects","revid":348994,"updated":"2023-11-08T14:45:49Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Make destroyed curator objects non-editable.","syntaxes":[{"syntax":"[object, parentClasses] call BIS_fnc_removeDestroyedCuratorEditableObjects","params":[{"name":"object","type":"Object","description":"curator module or objects to be removed after death","type_expr":"Object"},{"name":"parentClasses","type":"Array of Strings","description":"parent classes of objects to be removed (e.g., \"Man\")","type_expr":"Array<String>"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[curatorModule, [\"Man\"]] call BIS_fnc_removeDestroyedCuratorEditableObjects;"]}],"see_also":["Arma 3: Curator"]},{"name":"BIS_fnc_removeFromPairs","title":"BIS fnc removeFromPairs","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_removeFromPairs","revid":363590,"updated":"2024-04-07T18:25:56Z","groups":["Arrays"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Removes an item from pair array, modifying or not the original array.","syntaxes":[{"syntax":"[array, key, copyArray] call BIS_fnc_removeFromPairs","params":[{"name":"array","type":"Array","description":"array to search through","type_expr":"Array"},{"name":"key","type":"String","description":"key to search for","type_expr":"String"},{"name":"copyArray","type":"Boolean","optional":true,"default":"false","description":"true to copy the array and return it, false to modify the original array","type_expr":"Boolean","text":"copyArray: Boolean - (Optional, default false) true to copy the array and return it, false to modify the original array"}],"returns":{"type":"Array","type_expr":"Array","description":"resulting modified array or a copy"}}],"examples":[{"text":"```sqf\nprivate _pairs = [[[\"apple\", 3], [\"pear\", 2]], \"pear\"];\n[_pairs, \"pear\", true]    call BIS_fnc_removeFromPairs; // returns [[\"apple\", 3]] - _pairs is not modified\n[_pairs, \"pear\"]        call BIS_fnc_removeFromPairs; // returns [[\"apple\", 3]] - _pairs is now [[\"apple\", 3]]\n```","code":["private _pairs = [[[\"apple\", 3], [\"pear\", 2]], \"pear\"];\n[_pairs, \"pear\", true]\tcall BIS_fnc_removeFromPairs; // returns [[\"apple\", 3]] - _pairs is not modified\n[_pairs, \"pear\"]\t\tcall BIS_fnc_removeFromPairs; // returns [[\"apple\", 3]] - _pairs is now [[\"apple\", 3]]"]}],"see_also":["find","findIf","BIS_fnc_findInPairs","BIS_fnc_getFromPairs","BIS_fnc_addToPairs","BIS_fnc_setToPairs"]},{"name":"BIS_fnc_removeIndex","title":"BIS fnc removeIndex","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_removeIndex","revid":323162,"updated":"2022-07-01T10:34:55Z","groups":["Arrays"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Takes an array, and returns a new array with the specified index(es) removed.\nThis takes the array passed in the first parameter, and returns an array that has the index number in the second parameter removed.\nIf a third parameter is passed, then a range of indexes will be removed.\nAlternatively, an array of indices to remove can be passed in the second parameter.\n\n> [!NOTE]\n> **Arma 3:** Use deleteAt or deleteRange instead.","syntaxes":[{"syntax":"[array, startIndex, endIndex] call BIS_fnc_removeIndex","params":[{"name":"array","type":"Array","type_expr":"Array"},{"name":"startIndex","type":"Number","description":"start index to be removed, if Parameter 3 is not provided, only this index is removed","type_expr":"Number"},{"name":"endIndex","type":"Number","optional":true,"default":"Nothing","description":"end index, if provided the indexs from startIndex to endIndex will be removed","type_expr":"Number","text":"endIndex: Number - (Optional, default Nothing) - end index, if provided the indexs from startIndex to endIndex will be removed"}],"returns":{"type":"Array","type_expr":"Array","description":"new array with new values"}},{"syntax":"[array, indices] call BIS_fnc_removeIndex","params":[{"name":"array","type":"Array","type_expr":"Array"},{"name":"indices","type":"Array of Numbers","description":"indices to be removed","type_expr":"Array<Number>"}],"returns":{"type":"Array","type_expr":"Array","description":"new array with new values"}}],"examples":[{"code":["private _array = [0,1,2,3,4];\n[array, 0] call BIS_fnc_removeIndex; // returns [1,2,3,4]"]},{"code":["private _array = [0,1,2,3,4];\n[_array, 0, 4] call BIS_fnc_removeIndex; // returns []"]},{"code":["private _array = [0,1,2,3,4];\n[_array, [0,4]] call BIS_fnc_removeIndex; // returns [1,2,3]"]}],"see_also":["deleteAt","deleteRange"]},{"name":"BIS_fnc_removeNestedElement","title":"BIS fnc removeNestedElement","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_removeNestedElement","revid":327527,"updated":"2022-07-12T22:34:05Z","groups":["Arrays"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Function to remove an item in a nested array. Modifies the array by reference.","syntaxes":[{"syntax":"[array, itemToRemove] call BIS_fnc_removeNestedElement","params":[{"name":"array","type":"Array","type_expr":"Array"},{"name":"itemToRemove","type":"Anything","type_expr":"Anything"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true on success, false on failure"}}],"examples":[{"code":["private _array = [[1, 2], [3, 3, 4]];\nprivate _success = [_array, 3] call BIS_fnc_removeNestedElement; // _array is now [[1, 2], [4]]"]}],"see_also":["BIS_fnc_findNestedElement","BIS_fnc_findAllNestedElements","BIS_fnc_returnNestedElement","BIS_fnc_setNestedElement"]},{"name":"BIS_fnc_removeRespawnInventory","title":"BIS fnc removeRespawnInventory","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_removeRespawnInventory","revid":327903,"updated":"2022-07-13T11:42:18Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.60"},"since":"arma3 1.60","arma3_since":"1.60","locality":{"effect":"global"},"description":"Remove a respawn inventory added by BIS_fnc_addRespawnInventory.","syntaxes":[{"syntax":"[target, id] call BIS_fnc_removeRespawnInventory","params":[{"name":"target","type":"Namespace, Side, Group or Object","type_expr":"Namespace | Side | Group | Object"},{"name":"id","type":"Number","type_expr":"Number"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[west, 1] call BIS_fnc_removeRespawnInventory;"]},{"code":["private _myRespawnInventory = [missionNamespace,\"ATSniper\"] call BIS_fnc_addRespawnInventory;\n_myRespawnInventory call BIS_fnc_removeRespawnInventory;"]}],"see_also":["Arma 3: Respawn","BIS_fnc_addRespawnInventory","BIS_fnc_getRespawnInventories","BIS_fnc_setRespawnInventory"],"notes":[{"user":"Krzmbrzl00","date":"2016-07-01T17:29:00Z","text":"To remove all inventories that are currently available you can use the following:\n\n```sqf\n{\n    [missionNamespace, _x] call BIS_fnc_removeRespawnInventory;\n} forEach ([missionNamespace, true] call BIS_fnc_getRespawnInventories;\n```\n\nIf all available inventories are removed, the default inventory for the current unit (as it would be placed in the editor) will be added automatically."}]},{"name":"BIS_fnc_removeRespawnPosition","title":"BIS fnc removeRespawnPosition","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_removeRespawnPosition","revid":327904,"updated":"2022-07-13T11:43:10Z","groups":["Respawn"],"status":"ok","games":{"arma3":"0.50"},"since":"arma3 0.50","arma3_since":"0.50","locality":{"effect":"global"},"description":"Remove a respawn position added by BIS_fnc_addRespawnPosition.","syntaxes":[{"syntax":"[target, id] call BIS_fnc_removeRespawnPosition","params":[{"name":"target","type":"Namespace, Side, Group or Object","type_expr":"Namespace | Side | Group | Object","text":"**target**: Namespace, Side, Group or Object"},{"name":"id","type":"Number","type_expr":"Number","text":"**id**: Number"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[west, 1] call BIS_fnc_removeRespawnPosition;"]},{"code":["myRespawn = [missionNamespace,\"arena\"] call BIS_fnc_addRespawnPosition;\nmyRespawn call BIS_fnc_removeRespawnPosition;"]}],"see_also":["BIS_fnc_addRespawnPosition","Arma 3: Respawn"]},{"name":"BIS_fnc_removeScriptedEventHandler","title":"BIS fnc removeScriptedEventHandler","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_removeScriptedEventHandler","revid":327930,"updated":"2022-07-13T12:30:39Z","groups":["Event Handlers"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Removes scripted event handler with given name and id.\nAdditionally \"ScriptedEventHandlerRemoved\" scripted EH is called.\n\n> [!NOTE]\n> For a list of available scripted event handlers, see Arma 3: Scripted Event Handlers.","syntaxes":[{"syntax":"[namespace, name, id] call BIS_fnc_removeScriptedEventHandler","params":[{"name":"namespace","type":"Namespace, Object, Group, Location, Boolean, Control or Display","description":"namespace in which handler is saved","type_expr":"Namespace | Object | Group | Location | Boolean | Control | Display"},{"name":"name","type":"String","description":"handler name","type_expr":"String"},{"name":"id","type":"Number","description":"EH id","type_expr":"Number"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if removed, false if didn't exist"}}],"examples":[{"code":["[missionNamespace, \"event\", 2] call BIS_fnc_removeScriptedEventHandler;"]}],"see_also":["BIS_fnc_callScriptedEventHandler","BIS_fnc_addScriptedEventHandler","BIS_fnc_removeAllScriptedEventHandlers"]},{"name":"BIS_fnc_removeStackedEventHandler","title":"BIS fnc removeStackedEventHandler","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_removeStackedEventHandler","revid":327366,"updated":"2022-07-12T22:11:56Z","groups":["Event Handlers"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Removes a stacked event handler with specified custom id.","syntaxes":[{"syntax":"[id, event] call BIS_fnc_removeStackedEventHandler","params":[{"name":"key","type":"String","description":"custom id, a unique identifier, also returned by BIS_fnc_addStackedEventHandler","type_expr":"String"},{"name":"event","type":"String","description":"event handler name, see BIS_fnc_addStackedEventHandler fr supported event handlers","type_expr":"String"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true on success, false on failure"}}],"examples":[{"code":["[\"someId\", \"onEachFrame\"] call BIS_fnc_removeStackedEventHandler;"]}],"see_also":["BIS_fnc_addStackedEventHandler"]},{"name":"BIS_fnc_removeSupportLink","title":"BIS fnc removeSupportLink","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_removeSupportLink","revid":349028,"updated":"2023-11-08T14:47:10Z","groups":["Supports"],"status":"ok","games":{"arma3":"0.76"},"since":"arma3 0.76","arma3_since":"0.76","description":"Removes support types during a mission.","syntaxes":[{"syntax":"[requester, provider] call BIS_fnc_removeSupportLink","params":[{"name":"requester","type":"Object","description":"requester module","type_expr":"Object"},{"name":"provider","type":"Object","description":"provider module","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[requesterMod, providerMod] call BIS_fnc_removeSupportLink;"]}],"see_also":["BIS_fnc_addSupportLink"]},{"name":"BIS_fnc_removeVirtualBackpackCargo","title":"BIS fnc removeVirtualBackpackCargo","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_removeVirtualBackpackCargo","revid":349434,"updated":"2023-11-08T16:27:36Z","groups":["Inventory"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"Remove virtual backpacks from an object (e.g., ammo box). Virtual items can be selected in the Arsenal.","syntaxes":[{"syntax":"[object,backpackClasses,removeGlobally] call BIS_fnc_removeVirtualBackpackCargo","params":[{"name":"object","type":"Object","description":"object from which items will be removed","type_expr":"Object"},{"name":"backpackClasses","type":"Boolean, String or Array of Strings","description":"backpack classes","type_expr":"Boolean | String | Array<String>"},{"name":"removeGlobally","type":"Boolean","optional":true,"default":"false","description":"true to remove items globally","type_expr":"Boolean","text":"removeGlobally: Boolean - (Optional, default false) true to remove items globally"}],"returns":{"type":"Array of arrays","type_expr":"Array<Array>","description":"all virtual items in objects's space in format:\n- 0: Array - Items - 1: Array - Weapons - 2: Array - Magazines - 3: Array - Backpacks","text":"Array of arrays - all virtual items in objects's space in format:\n\n- 0: Array - Items\n- 1: Array - Weapons\n- 2: Array - Magazines\n- 3: Array - Backpacks"}}],"examples":[{"code":["[BIS_ammoBox, [\"class_1\",\"class_2\"], true] call BIS_fnc_removeVirtualBackpackCargo;"]}],"see_also":["Arsenal","BIS_fnc_addVirtualBackpackCargo","BIS_fnc_addVirtualItemCargo","BIS_fnc_addVirtualMagazineCargo","BIS_fnc_addVirtualWeaponCargo","BIS_fnc_arsenal","BIS_fnc_getVirtualBackpackCargo","BIS_fnc_getVirtualItemCargo","BIS_fnc_getVirtualMagazineCargo","BIS_fnc_getVirtualWeaponCargo","BIS_fnc_removeVirtualItemCargo","BIS_fnc_removeVirtualMagazineCargo","BIS_fnc_removeVirtualWeaponCargo"]},{"name":"BIS_fnc_removeVirtualItemCargo","title":"BIS fnc removeVirtualItemCargo","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_removeVirtualItemCargo","revid":349420,"updated":"2023-11-08T16:27:32Z","groups":["Inventory"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"Remove virtual items from an object (e.g., ammo box). Virtual items can be selected in the Arsenal.","syntaxes":[{"syntax":"[object,itemClasses,removeGlobally] call BIS_fnc_removeVirtualItemCargo","params":[{"name":"object","type":"Object","description":"object from which items will be removed","type_expr":"Object"},{"name":"itemClasses","type":"Boolean, String or Array of Strings","description":"item classes","type_expr":"Boolean | String | Array<String>"},{"name":"removeGlobally","type":"Boolean","optional":true,"default":"false","description":"true to remove items globally","type_expr":"Boolean","text":"removeGlobally: Boolean - (Optional, default false) true to remove items globally"}],"returns":{"type":"Array of arrays","type_expr":"Array<Array>","description":"all virtual items in objects's space in format:\n- 0: Array - Items - 1: Array - Weapons - 2: Array - Magazines - 3: Array - Backpacks","text":"Array of arrays - all virtual items in objects's space in format:\n\n- 0: Array - Items\n- 1: Array - Weapons\n- 2: Array - Magazines\n- 3: Array - Backpacks"}}],"examples":[{"code":["[BIS_ammoBox, [\"class_1\",\"class_2\"], true] call BIS_fnc_removeVirtualItemCargo;"]}],"see_also":["Arsenal","BIS_fnc_addVirtualBackpackCargo","BIS_fnc_addVirtualItemCargo","BIS_fnc_addVirtualMagazineCargo","BIS_fnc_addVirtualWeaponCargo","BIS_fnc_arsenal","BIS_fnc_getVirtualBackpackCargo","BIS_fnc_getVirtualItemCargo","BIS_fnc_getVirtualMagazineCargo","BIS_fnc_getVirtualWeaponCargo","BIS_fnc_removeVirtualBackpackCargo","BIS_fnc_removeVirtualMagazineCargo","BIS_fnc_removeVirtualWeaponCargo"]},{"name":"BIS_fnc_removeVirtualMagazineCargo","title":"BIS fnc removeVirtualMagazineCargo","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_removeVirtualMagazineCargo","revid":363530,"updated":"2024-04-03T23:02:44Z","groups":["Inventory"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"Remove virtual magazines from an object (e.g., ammo box). Virtual items can be selected in the Arsenal.","syntaxes":[{"syntax":"[object, magClasses, removeGlobally] call BIS_fnc_removeVirtualMagazineCargo","params":[{"name":"object","type":"Object","description":"object from which items will be removed","type_expr":"Object"},{"name":"magClasses","type":"Boolean, String or Array of Strings","description":"magazine classes","type_expr":"Boolean | String | Array<String>"},{"name":"removeGlobally","type":"Boolean","optional":true,"default":"false","description":"true to remove items globally","type_expr":"Boolean","text":"removeGlobally: Boolean - (Optional, default false) true to remove items globally"}],"returns":{"type_expr":"Array<Array>","text":"Array of Arrays of all virtual items in objects's space in format [items, weapons, magazines, backpacks]"}}],"examples":[{"code":["[BIS_ammoBox, [\"class_1\", \"class_2\"], true] call BIS_fnc_removeVirtualMagazineCargo;"]}],"see_also":["Arsenal","BIS_fnc_addVirtualBackpackCargo","BIS_fnc_addVirtualItemCargo","BIS_fnc_addVirtualMagazineCargo","BIS_fnc_addVirtualWeaponCargo","BIS_fnc_arsenal","BIS_fnc_getVirtualBackpackCargo","BIS_fnc_getVirtualItemCargo","BIS_fnc_getVirtualMagazineCargo","BIS_fnc_getVirtualWeaponCargo","BIS_fnc_removeVirtualBackpackCargo","BIS_fnc_removeVirtualItemCargo","BIS_fnc_removeVirtualWeaponCargo"]},{"name":"BIS_fnc_removeVirtualWeaponCargo","title":"BIS fnc removeVirtualWeaponCargo","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_removeVirtualWeaponCargo","revid":349397,"updated":"2023-11-08T16:27:25Z","groups":["Inventory"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"Remove virtual weapons from an object (e.g., ammo box). Virtual items can be selected in the Arsenal.","syntaxes":[{"syntax":"[object,weaponClasses,removeGlobally] call BIS_fnc_removeVirtualWeaponCargo","params":[{"name":"object","type":"Object","description":"object from which items will be removed","type_expr":"Object"},{"name":"weaponClasses","type":"Boolean, String or Array of Strings","description":"weapon classes","type_expr":"Boolean | String | Array<String>"},{"name":"removeGlobally","type":"Boolean","optional":true,"default":"false","description":"true to remove items globally","type_expr":"Boolean","text":"removeGlobally: Boolean - (Optional, default false) true to remove items globally"}],"returns":{"type":"Array of arrays","type_expr":"Array<Array>","description":"all virtual items in objects's space in format:\n- 0: Array - Items - 1: Array - Weapons - 2: Array - Magazines - 3: Array - Backpacks","text":"Array of arrays - all virtual items in objects's space in format:\n\n- 0: Array - Items\n- 1: Array - Weapons\n- 2: Array - Magazines\n- 3: Array - Backpacks"}}],"examples":[{"code":["[BIS_ammoBox, [\"class_1\",\"class_2\"], true] call BIS_fnc_removeVirtualWeaponCargo;"]}],"see_also":["Arsenal","BIS_fnc_addVirtualBackpackCargo","BIS_fnc_addVirtualItemCargo","BIS_fnc_addVirtualMagazineCargo","BIS_fnc_addVirtualWeaponCargo","BIS_fnc_arsenal","BIS_fnc_getVirtualBackpackCargo","BIS_fnc_getVirtualItemCargo","BIS_fnc_getVirtualMagazineCargo","BIS_fnc_getVirtualWeaponCargo","BIS_fnc_removeVirtualBackpackCargo","BIS_fnc_removeVirtualItemCargo","BIS_fnc_removeVirtualMagazineCargo"]},{"name":"BIS_fnc_replaceWithSimpleObject","title":"BIS fnc replaceWithSimpleObject","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_replaceWithSimpleObject","revid":364329,"updated":"2024-05-06T09:38:48Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Replaces a normal object with a Simple Object.\nObject must not contain any crew and must be placed on the ground.\n\n> [!NOTE]\n> - Useful if you do not have access to simple object adjustment data - e.g. in case of unsupported/discontinued asset.\n> - All official assets have the adjustment data defined in config.","syntaxes":[{"syntax":"[object] call BIS_fnc_replaceWithSimpleObject","params":[{"name":"object","type":"Object","description":"the object that will be replaced by a simple object","type_expr":"Object"}],"returns":{"type":"Object","type_expr":"Object","description":"the created Simple Object"}}],"examples":[{"code":["[tank] call BIS_fnc_replaceWithSimpleObject;"]}],"problems":"Use with caution as this technique is not very clean - it should not be used for many objects and definitely **not** in MP games.","see_also":["createSimpleObject","BIS_fnc_adjustSimpleObject","BIS_fnc_createSimpleObject","BIS_fnc_simpleObjectData"]},{"name":"BIS_fnc_resizeMarker","title":"BIS fnc resizeMarker","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_resizeMarker","revid":351261,"updated":"2023-11-26T08:03:52Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","locality":{"argument":"global","effect":"global"},"exec":"spawn","description":"Resize marker. Use either absolute values or proportional values.","syntaxes":[{"syntax":"[marker, size, duration] spawn BIS_fnc_resizeMarker","params":[{"name":"marker","type":"String","description":"marker","type_expr":"String"},{"name":"size","type":"Array","optional":true,"default":"[1,1]","description":"array in form of:\n0: Number - Size x\n1: Number - Size y","type_expr":"Array","text":"size: Array - (Optional, default [1,1]) array in form of:\n0: Number - Size x\n1: Number - Size y"},{"name":"duration","type":"Number","optional":true,"default":"1","description":"duration of the transition","type_expr":"Number","text":"duration: Number - (Optional, default 1) duration of the transition"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"BIS_marker\",[2,2],3] spawn BIS_fnc_resizeMarker;"]}],"see_also":["BIS_fnc_blinkMarker","BIS_fnc_changeColorMarker","BIS_fnc_getMarkers","BIS_fnc_getMarkerState","BIS_fnc_colorMarker"]},{"name":"BIS_fnc_respawnBackpack","title":"BIS fnc respawnBackpack","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_respawnBackpack","revid":352012,"updated":"2024-02-01T23:24:05Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.96"},"since":"arma3 1.96","arma3_since":"1.96","description":"Handles respawn camps functionality. Whoever \"assembles\" a camp from backpack it will receive a new respawn position. When backpack object has 'respawnNearbyPlayers' attribute set to 1, nearby players will receive the respawn position as well.\n\n> [!IMPORTANT]\n> Only for use with respawn camp event handlers!","syntaxes":[{"syntax":"[] call BIS_fnc_respawnBackpack","params":[{"name":"mode","type":"String","description":"mode","type_expr":"String"},{"name":"arguments","type":"Array","description":"mode arguments","type_expr":"Array"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"-"}]},{"name":"BIS_fnc_respawnBase","title":"BIS fnc respawnBase","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_respawnBase","revid":352060,"updated":"2024-02-01T23:24:36Z","groups":["Respawn","Broken Functions"],"status":"broken","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"> [!NOTE]\n> This function contains no code.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Respawn"]},{"name":"BIS_fnc_respawnConfirm","title":"BIS fnc respawnConfirm","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_respawnConfirm","revid":348120,"updated":"2023-11-08T11:32:18Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","exec":"spawn","description":"Shows a message box which the user needs to accept in order to respawn.","syntaxes":[{"syntax":"[respawnDelay] spawn BIS_fnc_respawnConfirm","params":[{"name":"respawnDelay","type":"Number","optional":true,"default":"3","description":"respawn delay","type_expr":"Number","text":"respawnDelay: Number - (Optional, default 3) respawn delay"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[3] spawn BIS_fnc_respawnConfirm;"]}],"see_also":["Arma 3: Respawn"]},{"name":"BIS_fnc_respawnCounter","title":"BIS fnc respawnCounter","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_respawnCounter","revid":349173,"updated":"2023-11-08T14:50:37Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Set or execute respawn counter params.","syntaxes":[{"syntax":"[text,colour] call BIS_fnc_respawnCounter","params":[{"name":"text","type":"String","description":"text displayed below the respawn counter","type_expr":"String"},{"name":"colour","type":"Number","optional":true,"default":"0","description":"can be:\n0 = default\n1 = warning\n2 = error","type_expr":"Number","text":"colour: Number - (Optional, default 0) can be:\n0 = default\n1 = warning\n2 = error"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[\"Some text\", 2] call BIS_fnc_respawnCounter;"]}]},{"name":"BIS_fnc_respawnEndMission","title":"BIS fnc respawnEndMission","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_respawnEndMission","revid":363227,"updated":"2024-03-26T10:50:29Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"End a mission if all players are dead *and* there are no more respawn tickets (if any).\n\n- **Standard syntax** is for when Respawn is \"NONE\", \"BIRD\", \"GROUP\" or \"SIDE\"\n- **Alternative syntax** is for when Respawn is \"INSTANT\" or \"BASE\"\n\n> [!IMPORTANT]\n> Only works in Multiplayer!","syntaxes":[{"syntax":"call BIS_fnc_respawnEndMission","params":[{"name":"unit","type":"Object","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing","description":"the script doesn't end"}},{"syntax":"unit call BIS_fnc_respawnEndMission","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_respawnEndMission;"]},{"code":["player call BIS_fnc_respawnEndMission;"]}],"see_also":["BIS_fnc_endMission","BIS_fnc_respawnTickets","BIS_fnc_missionRespawnType","playableUnits","isMultiplayer"]},{"name":"BIS_fnc_respawnGroup","title":"BIS fnc respawnGroup","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_respawnGroup","revid":328614,"updated":"2022-07-13T17:04:09Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","exec":"spawn","description":"Camera script used by the \"group respawn\" template - when the player dies and gets transferred to the new group member.","syntaxes":[{"syntax":"[oldUnit, newUnit] call BIS_fnc_respawnGroup","params":[{"name":"oldUnit","type":"Object","type_expr":"Object"},{"name":"newUnit","type":"Object","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["// in onPlayerRespawn.sqf\nparams [\"_newUnit\", \"_oldUnit\", \"_respawn\", \"_respawnDelay\"];\n[_oldUnit, _newUnit] spawn BIS_fnc_respawnGroup;"]}],"see_also":["BIS_fnc_respawnMenuInventory","BIS_fnc_respawnMenuPosition","BIS_fnc_respawnMenuSpectator","BIS_fnc_respawnSeagull","BIS_fnc_respawnSide","BIS_fnc_respawnSpectator","BIS_fnc_respawnWave"]},{"name":"BIS_fnc_respawnInstant","title":"BIS fnc respawnInstant","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_respawnInstant","revid":352211,"updated":"2024-02-01T23:26:04Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"> [!NOTE]\n> This file contains no code.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}]},{"name":"BIS_fnc_respawnManager","title":"BIS fnc respawnManager","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_respawnManager","revid":379569,"updated":"2026-10-31T13:57:22Z","groups":["Respawn"],"status":"ok","games":{"arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2oa 1.50","arma3_since":"0.50","description":"Respawn manager with checkpoints. Checkpoints are markers named \"BIS_checkpointnr1\", \"BIS_checkpointnr2\", ... (numbered without gaps); at least one must exist when the manager is initialised.\n\"Init\" creates the global logic *BIS_RespawnManager* that holds the manager's data and adds \"Killed\" and \"Respawn\" event handlers to the given units:\n\n- when a unit dies, the checkpoint nearest to it is stored for it;\n- when it respawns, the new unit gets the old unit's weapons and magazines. If a vehicle named *<unitName>_Vehicle* exists, it is respawned, moved to a safe position near the stored checkpoint (see BIS_fnc_findSafePos) and its crew is restored.\n\nEvery mode except \"Init\" returns false while the manager is not initialised. The function is meant to be called by mission scripts; no Arma 3 script calls it.\n\n> [!IMPORTANT]\n> - This is legacy Arma 2 code: the event handlers are added through the Arma 2 Multiplayer Framework function *RE*, which is not part of Arma 3's Functions Library.\n> - Parameters are passed on by format and compile: units must therefore have a variable name.","syntaxes":[{"syntax":"[\"Init\", [respawners, safePositions], markerVisibility] call BIS_fnc_respawnManager","params":[{"name":"\"Init\"","type":"String","description":"initialises the manager","type_expr":"String"},{"name":"respawners","type":"Array of Objects","description":"respawning units","type_expr":"Array<Object>"},{"name":"safePositions","type":"Array of Positions","description":"one position per unit, used when no safe position is found for its vehicle; when empty, [8179.12, 1881.57, 0] is used for every unit","type_expr":"Array<Position>"},{"name":"markerVisibility","type":"String","optional":true,"default":"\"\"","description":"\"\", \"true\" or \"false\"; every value currently results in checkpoint marker type \"EMPTY\"","type_expr":"String","text":"markerVisibility: String - (Optional, default \"\") \"\", \"true\" or \"false\"; every value currently results in checkpoint marker type \"EMPTY\""}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"false if the manager was already initialised, otherwise true"}},{"syntax":"[\"Destroy\"] call BIS_fnc_respawnManager","params":[{"name":"\"Destroy\"","type":"String","description":"deletes the manager logic","type_expr":"String"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true"}},{"syntax":"[\"AddCheckpoint\", position, markerName] call BIS_fnc_respawnManager","params":[{"name":"\"AddCheckpoint\"","type":"String","description":"creates a checkpoint marker and adds it to the list","type_expr":"String"},{"name":"position","type":"Array format Position","description":"checkpoint position","type_expr":"Position","types":["Array","Position"]},{"name":"markerName","type":"String","optional":true,"default":"\"\"","description":"marker name; if empty, the next free \"BIS_checkpointnr*N*\" name is used","type_expr":"String","text":"markerName: String - (Optional, default \"\") marker name; if empty, the next free \"BIS_checkpointnr*N*\" name is used"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true"}},{"syntax":"[\"RemoveCheckpoint\", markerName] call BIS_fnc_respawnManager","params":[{"name":"\"RemoveCheckpoint\"","type":"String","description":"removes a checkpoint from the list and deletes its marker","type_expr":"String"},{"name":"markerName","type":"String","description":"checkpoint marker name","type_expr":"String"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if removed, false if the marker is not a checkpoint or it is the last one"}},{"syntax":"[\"GetNearestCheckpoint\", unit] call BIS_fnc_respawnManager","params":[{"name":"\"GetNearestCheckpoint\"","type":"String","description":"returns the checkpoint stored for a unit","type_expr":"String"},{"name":"unit","type":"Object","description":"one of the respawning units","type_expr":"Object"}],"returns":{"type":"String","type_expr":"String","description":"marker name of the checkpoint stored for the unit, or the first checkpoint if none is stored"}}],"examples":[{"code":["// markers \"BIS_checkpointnr1\", \"BIS_checkpointnr2\" are placed in the mission\n[\"Init\", [[BIS_player1, BIS_player2], []]] call BIS_fnc_respawnManager;\n[\"AddCheckpoint\", getMarkerPos \"BIS_village\", \"BIS_checkpointVillage\"] call BIS_fnc_respawnManager;\n[\"RemoveCheckpoint\", \"BIS_checkpointnr1\"] call BIS_fnc_respawnManager;"]}],"see_also":["Arma 3: Respawn","BIS_fnc_addRespawnPosition","BIS_fnc_findSafePos"]},{"name":"BIS_fnc_respawnMenuInventory","title":"BIS fnc respawnMenuInventory","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_respawnMenuInventory","revid":348990,"updated":"2023-11-08T14:45:47Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Handles respawn inventory menu.","syntaxes":[{"syntax":"[player, respawnDelay, revive] call BIS_fnc_respawnMenuInventory","params":[{"name":"player","type":"Object","description":"player unit","type_expr":"Object"},{"name":"respawnDelay","type":"Number","optional":true,"default":"3","description":"respawn delay","type_expr":"Number","text":"respawnDelay: Number - (Optional, default 3) respawn delay"},{"name":"revive","type":"Boolean","optional":true,"default":"false","description":"if unit was revived","type_expr":"Boolean","text":"revive: Boolean - (Optional, default false) if unit was revived"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[player,5] call BIS_fnc_respawnMenuInventory;"]}],"see_also":["Arma 3: Respawn"]},{"name":"BIS_fnc_respawnMenuPosition","title":"BIS fnc respawnMenuPosition","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_respawnMenuPosition","revid":376730,"updated":"2025-11-15T04:51:27Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Shows respawn menu. Closes it if the player is alive.","syntaxes":[{"syntax":"[player, respawnDelay, revive] call BIS_fnc_respawnMenuPosition","params":[{"name":"player","type":"Object","description":"player unit","type_expr":"Object"},{"name":"respawnDelay","type":"Number","optional":true,"default":"3","description":"respawn delay","type_expr":"Number","text":"respawnDelay: Number - (Optional, default 3) respawn delay"},{"name":"revive","type":"Boolean","optional":true,"default":"false","description":"if unit was revived","type_expr":"Boolean","text":"revive: Boolean - (Optional, default false) if unit was revived"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[player,5] call BIS_fnc_respawnMenuPosition;"]}],"see_also":["Arma 3: Respawn"],"notes":[{"user":"Ilias38rus","date":"2021-01-15T18:14:00Z","text":"Use `setPlayerRespawnTime 0;` to respawn on selected position (certain gets selected by default), or position of death, if there is no the RP-s."}]},{"name":"BIS_fnc_respawnMenuSpectator","title":"BIS fnc respawnMenuSpectator","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_respawnMenuSpectator","revid":348949,"updated":"2023-11-08T14:45:38Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Handles the spectator mode.","syntaxes":[{"syntax":"[player, respawnDelay] call BIS_fnc_respawnMenuSpectator","params":[{"name":"player","type":"Object","description":"player unit","type_expr":"Object"},{"name":"respawnDelay","type":"Number","optional":true,"default":"3","description":"respawn delay","type_expr":"Number","text":"respawnDelay: Number - (Optional, default 3) respawn delay"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[player,5] call BIS_fnc_respawnMenuSpectator;"]}],"see_also":["Arma 3: Respawn"]},{"name":"BIS_fnc_respawnNone","title":"BIS fnc respawnNone","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_respawnNone","revid":348557,"updated":"2023-11-08T13:39:18Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","exec":"spawn","description":"Create a death screen.","syntaxes":[{"syntax":"[killed, killer] spawn BIS_fnc_respawnNone","params":[{"name":"killed","type":"Object","description":"killed unit (player)","type_expr":"Object"},{"name":"killer","type":"Object","description":"any unit","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[player, someUnit] spawn BIS_fnc_respawnNone;"]}]},{"name":"BIS_fnc_respawnRounds","title":"BIS fnc respawnRounds","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_respawnRounds","revid":309851,"updated":"2022-05-05T12:09:52Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Disable respawn until players of only one side (including its allies) remains, then respawn everyone at once. When \"Rounds\" respawn is used by only one side, wait until all its players are dead.","syntaxes":[{"syntax":"arg call BIS_fnc_respawnRounds","params":[{"name":"arg","type":"Boolean","type_expr":"Boolean","description":"true to force round end\nSIDE - use any side to return side affected by round system (based on description.ext respawnTemplates settings)\nARRAY - empty array to return if a round is still on (players of more than one involved faction are alive)","text":"BOOL - true to force round end\nSIDE - use any side to return side affected by round system (based on description.ext respawnTemplates settings)\nARRAY - empty array to return if a round is still on (players of more than one involved faction are alive)","source":"docblock"}],"returns":null,"inferred":true}],"docblock":{"text":"Description:\nDisable respawn until players of only one side (including its allies) remains, then respawn everyone at once.\nWhen \"Rounds\" respawn is used by only one side, wait until all its players are dead.\n\nParameter(s):\n    BOOL - true to force round end\n    SIDE - use any side to return side affected by round system (based on description.ext respawnTemplates settings)\n    ARRAY - empty array to return if a round is still on (players of more than one involved faction are alive)"},"filled_from_docblock":["description","params","syntax"]},{"name":"BIS_fnc_respawnSeagull","title":"BIS fnc respawnSeagull","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_respawnSeagull","revid":309740,"updated":"2022-05-05T12:09:48Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_respawnSide","title":"BIS fnc respawnSide","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_respawnSide","revid":309736,"updated":"2022-05-05T12:09:48Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_respawnSpectator","title":"BIS fnc respawnSpectator","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_respawnSpectator","revid":309792,"updated":"2022-05-05T12:09:50Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_respawnTickets","title":"BIS fnc respawnTickets","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_respawnTickets","revid":379278,"updated":"2026-10-30T23:45:15Z","groups":["Respawn"],"status":"ok","games":{"arma3":"0.74"},"since":"arma3 0.74","arma3_since":"0.74","locality":{"effect":"global"},"description":"Manage respawn tickets used by Tickets respawn template.\n\nWhen player dies, number of tickets is decreased by 1. The most local tickets are always used. Example: When you first add tickets to player's side, they will be affected. If you later define tickets also to player's group, they will completely replace the side tickets.\n\nWhen player runs out of the tickets, his respawn is disabled. If you use also *EndMission* respawn template, the mission will automatically end once tickets in all name spaces are exhausted.","syntaxes":[{"syntax":"[target, tickets, dynamicTarget] call BIS_fnc_respawnTickets","params":[{"name":"target","type":"Namespace, Side, Group or Object","description":"receiver of the respawn tickets:\n\n- Namespace - use missionNamespace to set/get global tickets available for everyone\n- Side\n- Group\n- Object","type_expr":"Namespace | Side | Group | Object","text":"**target**: Namespace, Side, Group or Object - receiver of the respawn tickets:\n\n- Namespace - use missionNamespace to set/get global tickets available for everyone\n- Side\n- Group\n- Object"},{"name":"tickets","type":"Number","description":"added respawn tickets. When missing or set to 0, number of tickets won't be affected, which means you can use the function to simply get amount of tickets.","type_expr":"Number","text":"**tickets**: Number - added respawn tickets. When missing or set to 0, number of tickets won't be affected, which means you can use the function to simply get amount of tickets."},{"name":"dynamicTarget","type":"Boolean","description":"when true, set/get tickets based on the target. **target** must be an Object.","type_expr":"Boolean","text":"**dynamicTarget**: Boolean - when true, set/get tickets based on the target. **target** must be an Object."}],"returns":{"type":"Number","type_expr":"Number","description":"remaining tickets after adjustment"}},{"syntax":"[] call BIS_fnc_respawnTickets","params":[],"returns":{"type":"Number","type_expr":"Number","description":"remaining tickets in all name spaces"}}],"examples":[{"text":"Add 5 tickets for BLUFOR:\n\n```sqf\n[west, 5] call BIS_fnc_respawnTickets;\n```","code":["[west, 5] call BIS_fnc_respawnTickets;"]},{"text":"Return number of global tickets:\n\n```sqf\n_globalTickets = [missionNamespace] call BIS_fnc_respawnTickets;\n```","code":["_globalTickets = [missionNamespace] call BIS_fnc_respawnTickets;"]},{"text":"Return number of player's tickets:\n\n```sqf\n_playerTickets = [player, nil, true] call BIS_fnc_respawnTickets;\n```","code":["_playerTickets = [player, nil, true] call BIS_fnc_respawnTickets;"]}],"see_also":["Arma 3: Respawn","BIS_fnc_addRespawnPosition","BIS_fnc_removeRespawnPosition"]},{"name":"BIS_fnc_respawnTimePenalty","title":"BIS fnc respawnTimePenalty","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_respawnTimePenalty","revid":309868,"updated":"2022-05-05T12:09:53Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Set or execute respawn time penalty","syntaxes":[{"syntax":"[param0, param1, param2] call BIS_fnc_respawnTimePenalty","params":[{"name":"param0","type":"Code","type_expr":"Code","description":"penalty condition","text":"0: CODE - penalty condition","source":"docblock"},{"name":"param1","type":"Number","type_expr":"Number","description":"penalty delay","text":"1: NUMBER - penalty delay","source":"docblock"},{"name":"param2","type":"Structured Text","type_expr":"Structured Text","description":"text displayed when penalty is in effect","text":"2: TEXT - text displayed when penalty is in effect","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","text":"BOOL","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nSet or execute respawn time penalty\n\nParameter(s):\n    0: CODE - penalty condition\n    1: NUMBER - penalty delay\n    2: TEXT - text displayed when penalty is in effect\n\nReturns:\nBOOL"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_respawnWave","title":"BIS fnc respawnWave","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_respawnWave","revid":309752,"updated":"2022-05-05T12:09:48Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_respect","title":"BIS fnc respect","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_respect","revid":379570,"updated":"2026-10-31T13:59:21Z","groups":["Sides"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"RESpect - The Effective Calculation Process. Manages \"respect\" values: an Array of Numbers in range -1..1, one per faction in the order returned by BIS_fnc_getFactions, stored in the public \"respect\" variable of a unit or of a town logic.\n\"ADD\" and \"KILLED\" work with town logics as used by Ambient Civilians (the unit's \"ALICE_twn\" variable, the town's \"neighbors\" variable). No Arma 3 script calls this function.\n\nAn unknown mode shows an error with hintC and returns -1.","syntaxes":[{"syntax":"[\"SET\", unit] call BIS_fnc_respect","params":[{"name":"\"SET\"","type":"String","description":"creates default respect values (**case-sensitive**)","type_expr":"String"},{"name":"unit","type":"Object","optional":true,"description":"unit whose faction gets respect 1; the result is also stored in its \"respect\" variable","type_expr":"Object","text":"unit: Object - (Optional) unit whose faction gets respect 1; the result is also stored in its \"respect\" variable"}],"returns":{"type":"Array of Numbers","type_expr":"Array<Number>","description":"0 for every faction, 1 for the faction of unit","text":"Array of Numbers - 0 for every faction, 1 for the faction of *unit*"}},{"syntax":"[\"ADD\", unit, range] call BIS_fnc_respect","params":[{"name":"\"ADD\"","type":"String","description":"gives a unit the respect values of its town (**case-sensitive**)","type_expr":"String"},{"name":"unit","type":"Object","description":"unit whose \"ALICE_twn\" variable holds its town logic","type_expr":"Object"},{"name":"range","type":"Number","description":"each town value is changed by a random amount between -range/2 and +range/2","type_expr":"Number"}],"returns":{"type":"Array of Numbers","type_expr":"Array<Number>","description":"unit's new respect values"}},{"syntax":"[\"MODIFY\", unit, faction, formula] call BIS_fnc_respect","params":[{"name":"\"MODIFY\"","type":"String","description":"changes one respect value (**case-sensitive**)","type_expr":"String"},{"name":"unit","type":"Object","description":"unit or town logic whose respect is changed; if it has no respect yet, \"SET\" is applied first","type_expr":"Object"},{"name":"faction","type":"String, Number or Object","description":"faction class name, faction index, or any object to use *unit*'s own faction","type_expr":"String | Number | Object"},{"name":"formula","type":"String or Number","description":"code computing the new value, the current value being available as *_r* (e.g. \"_r / 2\"); a Number sets the value directly","type_expr":"String | Number"}],"returns":{"type":"Number","type_expr":"Number","description":"new respect value, clamped to -1..1. If unit has Code in its \"respect_handler\" variable, it is spawned with [unit, factionIndex, oldValue, newValue].","text":"Number - new respect value, clamped to -1..1. If *unit* has Code in its \"respect_handler\" variable, it is spawned with [unit, factionIndex, oldValue, newValue]."}},{"syntax":"[\"KILLED\", killer, town, changeNeighbors, coefficient] call BIS_fnc_respect","params":[{"name":"\"KILLED\"","type":"String","description":"lowers a town's respect after a civilian was killed (**case-sensitive**)","type_expr":"String"},{"name":"killer","type":"Object","description":"the killer; for every faction, the town value is lowered by the killer's respect for that faction multiplied by *coefficient*","type_expr":"Object"},{"name":"town","type":"Object","description":"town logic","type_expr":"Object"},{"name":"changeNeighbors","type":"Boolean","optional":true,"default":"false","description":"if true and the town has a \"neighbors\" variable, the killer's respect for its own faction is multiplied by 0.9 and every neighbouring town is processed with half the coefficient","type_expr":"Boolean","text":"changeNeighbors: Boolean - (Optional, default false) if true and the town has a \"neighbors\" variable, the killer's respect for its own faction is multiplied by 0.9 and every neighbouring town is processed with half the coefficient"},{"name":"coefficient","type":"Number","optional":true,"default":"`2 + random 4`","description":"change coefficient","type_expr":"Number","text":"coefficient: Number - (Optional, default `2 + random 4`) change coefficient"}],"returns":{"type":"Array of Numbers","type_expr":"Array<Number>","description":"town's new respect values"}}],"examples":[{"text":"```sqf\n[\"SET\", player] call BIS_fnc_respect;                    // the player respects their own faction only\n[\"MODIFY\", player, \"OPF_F\", \"_r - 0.5\"] call BIS_fnc_respect;    // lowers the player's respect for CSAT by 0.5\n[\"MODIFY\", player, \"IND_F\", 0.25] call BIS_fnc_respect;        // sets the player's respect for AAF to 0.25\n```","code":["[\"SET\", player] call BIS_fnc_respect;\t\t\t\t\t// the player respects their own faction only\n[\"MODIFY\", player, \"OPF_F\", \"_r - 0.5\"] call BIS_fnc_respect;\t// lowers the player's respect for CSAT by 0.5\n[\"MODIFY\", player, \"IND_F\", 0.25] call BIS_fnc_respect;\t\t// sets the player's respect for AAF to 0.25"]}],"see_also":["BIS_fnc_getFactions","addRating","Ambient Civilians"]},{"name":"BIS_fnc_returnChildren","title":"BIS fnc returnChildren","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_returnChildren","revid":376418,"updated":"2025-10-11T23:07:20Z","groups":["Configs"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns all subclasses within given class.","syntaxes":[{"syntax":"[config, depth, lastTier] call BIS_fnc_returnChildren","params":[{"name":"config","type":"Config","description":"class which is searched","type_expr":"Config"},{"name":"depth","type":"Number","optional":true,"default":"0","description":"depth, (0 = return only subclasses, 1 = return subclasses of subclasses, and so on...","type_expr":"Number","text":"depth: Number - (Optional, default 0) depth, (0 = return only subclasses, 1 = return subclasses of subclasses, and so on..."},{"name":"allTiers","type":"Boolean","optional":true,"default":"true","description":"false to return only the last one, true to return all","type_expr":"Boolean","text":"allTiers: Boolean - (Optional, default true) false to return only the last one, true to return all"}],"returns":{"type":"Array","type_expr":"Array","description":"of Configs"}}],"examples":[{"code":["[configFile >> \"CfgFunctions\", 2] call BIS_fnc_returnChildren; // returns config paths of all functions"]}],"see_also":["BIS_fnc_returnParents","configClasses"]},{"name":"BIS_fnc_returnConfigEntry","title":"BIS fnc returnConfigEntry","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_returnConfigEntry","revid":349149,"updated":"2023-11-08T14:49:48Z","groups":["Configs"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Explores parent classes in the run-time config for the value of a config entry.","syntaxes":[{"syntax":"[config,attribute,defaultValue] call BIS_fnc_returnConfigEntry","params":[{"name":"config","type":"Config","description":"starting config","type_expr":"Config"},{"name":"attribute","type":"String","description":"config attribute to be returned","type_expr":"String"},{"name":"defaultValue","type":"Anything","optional":true,"default":"Nothing","description":"value to be returned if attribute is not existent","type_expr":"Anything","text":"defaultValue: Anything - (Optional, default Nothing) value to be returned if attribute is not existent"}],"returns":{"type":"Array, String or Number","type_expr":"Array | String | Number","description":"attribute value"}}],"examples":[{"code":["[configfile >> \"Cfg3DEN\" >> \"Attributes\" >> \"ActivationType\",\"idc\"] call BIS_fnc_returnConfigEntry;"]}],"see_also":["configFile","BIS_fnc_getCfg","BIS_fnc_getCfgData"]},{"name":"BIS_fnc_returnGroupComposition","title":"BIS fnc returnGroupComposition","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_returnGroupComposition","revid":309758,"updated":"2022-05-05T12:09:49Z","groups":["Object Manipulation"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"```\n/*\n    File: returnGroupComp.sqf\n\n    Description:\n    Function which returns a logical group composition based on a number of parameters.\n\n    Parameter(s):\n    _this select 0: side (Side).\n    _this select 1: number of characters (Number).\n    _this select 2: (optional) type (String):\n        - \"riflesquad\": (default) standard rifle squad.\n        - \"sniper\": sniper team.\n\n    Returns:\n    Array of Strings - object types.\n\n    TODO: use CfgGroups instead?\n*/\n\n//Validate parameter count\n```","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_returnNestedElement","title":"BIS fnc returnNestedElement","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_returnNestedElement","revid":327552,"updated":"2022-07-12T22:38:17Z","groups":["Arrays"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Function to return an item at a path in an array.","syntaxes":[{"syntax":"[array, path] call BIS_fnc_returnNestedElement","params":[{"name":"array","type":"Array","type_expr":"Array"},{"name":"path","type":"Array of Numbers","type_expr":"Array<Number>"}],"returns":{"type":"Anything","type_expr":"Anything","description":"nil if path is incorrect"}}],"examples":[{"code":["private _array = [[1, 2], [3, 4]];\n_value = [_array, [0, 1]] call BIS_fnc_returnNestedElement; // returns 2"]}],"see_also":["BIS_fnc_findNestedElement","BIS_fnc_findAllNestedElements","BIS_fnc_removeNestedElement","BIS_fnc_setNestedElement"]},{"name":"BIS_fnc_returnParents","title":"BIS fnc returnParents","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_returnParents","revid":376400,"updated":"2025-10-10T20:44:01Z","groups":["Configs"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Returns list of all parent classes.","syntaxes":[{"syntax":"[config, onlyClassNames] call BIS_fnc_returnParents","params":[{"name":"config","type":"Config","description":"starting config class","type_expr":"Config"},{"name":"onlyClassNames","type":"Boolean","optional":true,"default":"false","description":"true to return only class names","type_expr":"Boolean","text":"onlyClassNames: Boolean - (Optional, default false) true to return only class names"}],"returns":{"type":"Array","type_expr":"Array","description":"list of all classes (including starting one)"}}],"examples":[{"code":["[configFile >> \"CfgVehicles\" >> \"Land_FirePlace_F\", true] call BIS_fnc_returnParents;\n//Returns [\"Land_FirePlace_F\",\"House_F\",\"House\",\"HouseBase\",\"NonStrategic\",\"Building\",\"Static\",\"All\"]"]}],"see_also":["configFile","configHierarchy","BIS_fnc_returnChildren"]},{"name":"BIS_fnc_returnVehicleTurrets","title":"BIS fnc returnVehicleTurrets","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_returnVehicleTurrets","revid":327908,"updated":"2022-07-13T11:48:06Z","groups":["Vehicles"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Return the path to all turrets and sub-turrets in a vehicle.\n\n> [!NOTE]\n> **Arma 3:** Does not seem to work in Arma 3. Use allTurrets and BIS_fnc_allTurrets instead.","syntaxes":[{"syntax":"[configEntry] call BIS_fnc_returnVehicleTurrets","params":[{"name":"configEntry","type":"Config","description":"vehicle config entry","type_expr":"Config"}],"returns":{"type":"Array","type_expr":"Array","description":"turret paths ([0], [0, 1] format)"}}],"examples":[{"code":["[configFile >> \"CfgVehicles\" >> \"B_MBT_01_TUSK_F\"] call BIS_fnc_returnVehicleTurrets;"]}],"see_also":["allTurrets","BIS_fnc_allTurrets"]},{"name":"BIS_fnc_reviveAllowed","title":"BIS fnc reviveAllowed","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_reviveAllowed","revid":349060,"updated":"2023-11-08T14:47:19Z","groups":["Revive"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","description":"Returns true if unit is in general able to revive someone.","syntaxes":[{"syntax":"[medic, unit] call BIS_fnc_reviveAllowed","params":[{"name":"medic","type":"Object","description":"unit performing revive","type_expr":"Object"},{"name":"unit","type":"Array","description":"unit that will be revived","type_expr":"Array"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"returns true if possible, false is not"}}],"examples":[{"code":["private _canRevive = [medic,target] call BIS_fnc_reviveAllowed;"]}],"see_also":["Arma 3: Revive","BIS_fnc_disableRevive","BIS_fnc_reenableRevive","BIS_fnc_reviveBleedOut","BIS_fnc_reviveDamageReset","BIS_fnc_reviveDebug","BIS_fnc_reviveEhDammaged","BIS_fnc_reviveEhHandleDamage","BIS_fnc_reviveEhHandleHeal","BIS_fnc_reviveEhKilled","BIS_fnc_reviveEhRespawn","BIS_fnc_reviveEnabled","BIS_fnc_reviveGet3dIcons","BIS_fnc_reviveGetActionIcon","BIS_fnc_reviveIconControl","BIS_fnc_reviveInit","BIS_fnc_reviveIsValid","BIS_fnc_reviveIsValidSecure","BIS_fnc_reviveOnBeingRevived","BIS_fnc_reviveOnForcingRespawn","BIS_fnc_reviveOnState","BIS_fnc_reviveOnStateJIP","BIS_fnc_reviveSecureUnit"]},{"name":"BIS_fnc_reviveBleedOut","title":"BIS fnc reviveBleedOut","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_reviveBleedOut","revid":349293,"updated":"2023-11-08T14:52:16Z","groups":["Revive"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","description":"Make a unit bleed out over time while incapacitated.","syntaxes":[{"syntax":"[player] call BIS_fnc_reviveBleedOut","params":[{"name":"player","type":"Object","description":"unit that is bleeding out","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"returns true if successful, false is not"}}],"examples":[{"code":["[BIS_unit] call BIS_fnc_reviveBleedOut;"]}],"see_also":["Arma 3: Revive","BIS_fnc_disableRevive","BIS_fnc_reenableRevive","BIS_fnc_reviveAllowed","BIS_fnc_reviveDamageReset","BIS_fnc_reviveDebug","BIS_fnc_reviveEhDammaged","BIS_fnc_reviveEhHandleDamage","BIS_fnc_reviveEhHandleHeal","BIS_fnc_reviveEhKilled","BIS_fnc_reviveEhRespawn","BIS_fnc_reviveEnabled","BIS_fnc_reviveGet3dIcons","BIS_fnc_reviveGetActionIcon","BIS_fnc_reviveIconControl","BIS_fnc_reviveInit","BIS_fnc_reviveIsValid","BIS_fnc_reviveIsValidSecure","BIS_fnc_reviveOnBeingRevived","BIS_fnc_reviveOnForcingRespawn","BIS_fnc_reviveOnState","BIS_fnc_reviveOnStateJIP","BIS_fnc_reviveSecureUnit"]},{"name":"BIS_fnc_reviveDamageReset","title":"BIS fnc reviveDamageReset","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_reviveDamageReset","revid":363940,"updated":"2024-04-26T21:33:55Z","groups":["Revive"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","locality":{"argument":"local","effect":"local"},"description":"Resets player's damage data and received damage.","syntaxes":[{"syntax":"[player] call BIS_fnc_reviveDamageReset","params":[{"name":"player","type":"Object","description":"player","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[player] call BIS_fnc_reviveDamageReset;"]}],"multiplayer":"Works only locally for player.","see_also":["Arma 3: Revive","BIS_fnc_disableRevive","BIS_fnc_reenableRevive","BIS_fnc_reviveAllowed","BIS_fnc_reviveBleedOut","BIS_fnc_reviveDebug","BIS_fnc_reviveEhDammaged","BIS_fnc_reviveEhHandleDamage","BIS_fnc_reviveEhHandleHeal","BIS_fnc_reviveEhKilled","BIS_fnc_reviveEhRespawn","BIS_fnc_reviveEnabled","BIS_fnc_reviveGet3dIcons","BIS_fnc_reviveGetActionIcon","BIS_fnc_reviveIconControl","BIS_fnc_reviveInit","BIS_fnc_reviveIsValid","BIS_fnc_reviveIsValidSecure","BIS_fnc_reviveOnBeingRevived","BIS_fnc_reviveOnForcingRespawn","BIS_fnc_reviveOnState","BIS_fnc_reviveOnStateJIP","BIS_fnc_reviveSecureUnit"]},{"name":"BIS_fnc_reviveDebug","title":"BIS fnc reviveDebug","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_reviveDebug","revid":348868,"updated":"2023-11-08T14:39:14Z","groups":["Revive"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","description":"Debug script for revive system.","syntaxes":[{"syntax":"[mode] call BIS_fnc_reviveDebug","params":[{"name":"mode","type":"Number","description":"mode, can be:\n\n- 0 - Stop\n- 1 - Start","type_expr":"Number"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[1] call BIS_fnc_reviveDebug;"]}],"see_also":["Arma 3: Revive","BIS_fnc_disableRevive","BIS_fnc_reenableRevive","BIS_fnc_reviveAllowed","BIS_fnc_reviveBleedOut","BIS_fnc_reviveDamageReset","BIS_fnc_reviveEhDammaged","BIS_fnc_reviveEhHandleDamage","BIS_fnc_reviveEhHandleHeal","BIS_fnc_reviveEhKilled","BIS_fnc_reviveEhRespawn","BIS_fnc_reviveEnabled","BIS_fnc_reviveGet3dIcons","BIS_fnc_reviveGetActionIcon","BIS_fnc_reviveIconControl","BIS_fnc_reviveInit","BIS_fnc_reviveIsValid","BIS_fnc_reviveIsValidSecure","BIS_fnc_reviveOnBeingRevived","BIS_fnc_reviveOnForcingRespawn","BIS_fnc_reviveOnState","BIS_fnc_reviveOnStateJIP","BIS_fnc_reviveSecureUnit"]},{"name":"BIS_fnc_reviveEhDammaged","title":"BIS fnc reviveEhDammaged","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_reviveEhDammaged","revid":274419,"updated":"2021-06-13T01:22:20Z","groups":["Revive"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","description":"unit: Object - Object the event handler is assigned to hitSelection: String - Name of the selection where the unit was damaged damage: Number - Resulting level of damage hitPartIndex: Number - hit index of the hit selection hitPoint: String - hit point Cfg name shooter: Object - shooter reference (to get instigator use getShotParents on projectile) projectile: Object - the projectile that caused damage","syntaxes":[{"syntax":"[] call BIS_fnc_reviveEhDammaged","params":[],"returns":null}],"docblock":{"text":"unit: Object - Object the event handler is assigned to\nhitSelection: String - Name of the selection where the unit was damaged\ndamage: Number - Resulting level of damage\nhitPartIndex: Number - hit index of the hit selection\nhitPoint: String - hit point Cfg name\nshooter: Object - shooter reference (to get instigator use getShotParents on projectile)\nprojectile: Object - the projectile that caused damage"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_reviveEhHandleDamage","title":"BIS fnc reviveEhHandleDamage","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_reviveEhHandleDamage","revid":328507,"updated":"2022-07-13T16:24:16Z","groups":["Revive"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","description":"Should be excuted by HandleDamage event handler. See example. Handles damage calculation.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"```sqf\nBIS_unit addEventHandler [\"HandleDamage\",\n{\n    _this call BIS_fnc_reviveEhHandleDamage;\n}];\n```","code":["BIS_unit addEventHandler [\"HandleDamage\", \n{\n\t_this call BIS_fnc_reviveEhHandleDamage;\n}];"]}],"see_also":["Arma 3: Revive","BIS_fnc_disableRevive","BIS_fnc_reenableRevive","BIS_fnc_reviveAllowed","BIS_fnc_reviveBleedOut","BIS_fnc_reviveDamageReset","BIS_fnc_reviveDebug","BIS_fnc_reviveEhDammaged","BIS_fnc_reviveEhHandleHeal","BIS_fnc_reviveEhKilled","BIS_fnc_reviveEhRespawn","BIS_fnc_reviveEnabled","BIS_fnc_reviveGet3dIcons","BIS_fnc_reviveGetActionIcon","BIS_fnc_reviveIconControl","BIS_fnc_reviveInit","BIS_fnc_reviveIsValid","BIS_fnc_reviveIsValidSecure","BIS_fnc_reviveOnBeingRevived","BIS_fnc_reviveOnForcingRespawn","BIS_fnc_reviveOnState","BIS_fnc_reviveOnStateJIP","BIS_fnc_reviveSecureUnit"]},{"name":"BIS_fnc_reviveEhHandleHeal","title":"BIS fnc reviveEhHandleHeal","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_reviveEhHandleHeal","revid":349306,"updated":"2023-11-08T14:52:21Z","groups":["Revive"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","description":"Handles healing of unit. Unit gets fully healed after 10 seconds if current damage is smaller than initial damage, e.g. a medic healed the unit.","syntaxes":[{"syntax":"[unit] call BIS_fnc_reviveEhHandleHeal","params":[{"name":"unit","type":"Object","description":"unit to be healed","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"if revive is enabled for given unit it always returns false, if revive is disabled it returns Nothing"}}],"examples":[{"code":["[BIS_unit] call BIS_fnc_reviveEhHandleHeal;"]}],"see_also":["Arma 3: Revive","BIS_fnc_disableRevive","BIS_fnc_reenableRevive","BIS_fnc_reviveAllowed","BIS_fnc_reviveBleedOut","BIS_fnc_reviveDamageReset","BIS_fnc_reviveDebug","BIS_fnc_reviveEhDammaged","BIS_fnc_reviveEhHandleDamage","BIS_fnc_reviveEhKilled","BIS_fnc_reviveEhRespawn","BIS_fnc_reviveEnabled","BIS_fnc_reviveGet3dIcons","BIS_fnc_reviveGetActionIcon","BIS_fnc_reviveIconControl","BIS_fnc_reviveInit","BIS_fnc_reviveIsValid","BIS_fnc_reviveIsValidSecure","BIS_fnc_reviveOnBeingRevived","BIS_fnc_reviveOnForcingRespawn","BIS_fnc_reviveOnState","BIS_fnc_reviveOnStateJIP","BIS_fnc_reviveSecureUnit"]},{"name":"BIS_fnc_reviveEhKilled","title":"BIS fnc reviveEhKilled","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_reviveEhKilled","revid":328476,"updated":"2022-07-13T16:11:11Z","groups":["Revive"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","description":"Should be called from Killed event handler. Handles what happens if unit dies if revive system is enabled.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"```sqf\nBIS_unit addEventHandler [\"Killed\",\n{\n _this call BIS_fnc_reviveEhKilled;\n}];\n```","code":["BIS_unit addEventHandler [\"Killed\", \n{\n _this call BIS_fnc_reviveEhKilled;\n}];"]}],"see_also":["Arma 3: Revive","BIS_fnc_disableRevive","BIS_fnc_reenableRevive","BIS_fnc_reviveAllowed","BIS_fnc_reviveBleedOut","BIS_fnc_reviveDamageReset","BIS_fnc_reviveDebug","BIS_fnc_reviveEhDammaged","BIS_fnc_reviveEhHandleDamage","BIS_fnc_reviveEhHandleHeal","BIS_fnc_reviveEhRespawn","BIS_fnc_reviveEnabled","BIS_fnc_reviveGet3dIcons","BIS_fnc_reviveGetActionIcon","BIS_fnc_reviveIconControl","BIS_fnc_reviveInit","BIS_fnc_reviveIsValid","BIS_fnc_reviveIsValidSecure","BIS_fnc_reviveOnBeingRevived","BIS_fnc_reviveOnForcingRespawn","BIS_fnc_reviveOnState","BIS_fnc_reviveOnStateJIP","BIS_fnc_reviveSecureUnit"]},{"name":"BIS_fnc_reviveEhRespawn","title":"BIS fnc reviveEhRespawn","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_reviveEhRespawn","revid":349292,"updated":"2023-11-08T14:52:16Z","groups":["Revive"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","description":"Sets unit's state to respawned. Should probably only be called on respawn event.","syntaxes":[{"syntax":"[unit] call BIS_fnc_reviveEhRespawn","params":[{"name":"unit","type":"Object","description":"unit","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true"}}],"examples":[{"code":["BIS_unit call BIS_fnc_reviveEhRespawn;"]}],"see_also":["Arma 3: Revive","BIS_fnc_disableRevive","BIS_fnc_reenableRevive","BIS_fnc_reviveAllowed","BIS_fnc_reviveBleedOut","BIS_fnc_reviveDamageReset","BIS_fnc_reviveDebug","BIS_fnc_reviveEhDammaged","BIS_fnc_reviveEhHandleDamage","BIS_fnc_reviveEhHandleHeal","BIS_fnc_reviveEhKilled","BIS_fnc_reviveEnabled","BIS_fnc_reviveGet3dIcons","BIS_fnc_reviveGetActionIcon","BIS_fnc_reviveIconControl","BIS_fnc_reviveInit","BIS_fnc_reviveIsValid","BIS_fnc_reviveIsValidSecure","BIS_fnc_reviveOnBeingRevived","BIS_fnc_reviveOnForcingRespawn","BIS_fnc_reviveOnState","BIS_fnc_reviveOnStateJIP","BIS_fnc_reviveSecureUnit"]},{"name":"BIS_fnc_reviveEnabled","title":"BIS fnc reviveEnabled","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_reviveEnabled","revid":349303,"updated":"2023-11-08T14:52:19Z","groups":["Revive"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","description":"Returns is revive is enabled or not for the unit.","syntaxes":[{"syntax":"[unit] call BIS_fnc_reviveEhRespawn","params":[{"name":"unit","type":"Object","description":"unit that is checked","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if enabled, false if not"}}],"examples":[{"code":["private _reviveEnabled = [BIS_unit] call BIS_fnc_reviveEnabled;"]}],"see_also":["Arma 3: Revive","BIS_fnc_disableRevive","BIS_fnc_reenableRevive","BIS_fnc_reviveAllowed","BIS_fnc_reviveBleedOut","BIS_fnc_reviveDamageReset","BIS_fnc_reviveDebug","BIS_fnc_reviveEhDammaged","BIS_fnc_reviveEhHandleDamage","BIS_fnc_reviveEhHandleHeal","BIS_fnc_reviveEhKilled","BIS_fnc_reviveEnabled","BIS_fnc_reviveGet3dIcons","BIS_fnc_reviveGetActionIcon","BIS_fnc_reviveIconControl","BIS_fnc_reviveInit","BIS_fnc_reviveIsValid","BIS_fnc_reviveIsValidSecure","BIS_fnc_reviveOnBeingRevived","BIS_fnc_reviveOnForcingRespawn","BIS_fnc_reviveOnState","BIS_fnc_reviveOnStateJIP","BIS_fnc_reviveSecureUnit"]},{"name":"BIS_fnc_reviveGet3dIcons","title":"BIS fnc reviveGet3dIcons","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_reviveGet3dIcons","revid":349325,"updated":"2023-11-08T14:52:30Z","groups":["Revive"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","description":"Returns structured text that can be displayed in 'Hold Action' tech as animated unconscious state icon.","syntaxes":[{"syntax":"[unit] call BIS_fnc_reviveGet3dIcons","params":[{"name":"unit","type":"Object","description":"unconscious unit","type_expr":"Object"}],"returns":{"type":"Structured Text","type_expr":"Structured Text","description":"structured text with animated unconscious state 'Hold Action' icon."}}],"examples":[{"code":["private _structuredText = [BIS_unit] call BIS_fnc_reviveGet3dIcons;"]}],"see_also":["Arma 3: Revive","BIS_fnc_disableRevive","BIS_fnc_reenableRevive","BIS_fnc_reviveAllowed","BIS_fnc_reviveBleedOut","BIS_fnc_reviveDamageReset","BIS_fnc_reviveDebug","BIS_fnc_reviveEhDammaged","BIS_fnc_reviveEhHandleDamage","BIS_fnc_reviveEhHandleHeal","BIS_fnc_reviveEhKilled","BIS_fnc_reviveEhRespawn","BIS_fnc_reviveEnabled","BIS_fnc_reviveGetActionIcon","BIS_fnc_reviveIconControl","BIS_fnc_reviveInit","BIS_fnc_reviveIsValid","BIS_fnc_reviveIsValidSecure","BIS_fnc_reviveOnBeingRevived","BIS_fnc_reviveOnForcingRespawn","BIS_fnc_reviveOnState","BIS_fnc_reviveOnStateJIP","BIS_fnc_reviveSecureUnit"]},{"name":"BIS_fnc_reviveGetActionIcon","title":"BIS fnc reviveGetActionIcon","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_reviveGetActionIcon","revid":349324,"updated":"2023-11-08T14:52:30Z","groups":["Revive"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","description":"Returns structured text that can be displayed in 'Hold Action' tech as animated unconscious state icon.","syntaxes":[{"syntax":"[unit] call BIS_fnc_reviveGetActionIcon","params":[{"name":"unit","type":"Object","description":"unconscious unit","type_expr":"Object"}],"returns":{"type":"Structured Text","type_expr":"Structured Text","description":"structured text with animated unconscious state 'Hold Action' icon."}}],"examples":[{"code":["private _structuredText = [BIS_unit] call BIS_fnc_reviveGetActionIcon;"]}],"see_also":["Arma 3: Revive","BIS_fnc_disableRevive","BIS_fnc_reenableRevive","BIS_fnc_reviveAllowed","BIS_fnc_reviveBleedOut","BIS_fnc_reviveDamageReset","BIS_fnc_reviveDebug","BIS_fnc_reviveEhDammaged","BIS_fnc_reviveEhHandleDamage","BIS_fnc_reviveEhHandleHeal","BIS_fnc_reviveEhKilled","BIS_fnc_reviveEhRespawn","BIS_fnc_reviveEnabled","BIS_fnc_reviveGet3dIcons","BIS_fnc_reviveIconControl","BIS_fnc_reviveInit","BIS_fnc_reviveIsValid","BIS_fnc_reviveIsValidSecure","BIS_fnc_reviveOnBeingRevived","BIS_fnc_reviveOnForcingRespawn","BIS_fnc_reviveOnState","BIS_fnc_reviveOnStateJIP","BIS_fnc_reviveSecureUnit"]},{"name":"BIS_fnc_reviveIconControl","title":"BIS fnc reviveIconControl","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_reviveIconControl","revid":348857,"updated":"2023-11-08T14:39:13Z","groups":["Revive"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","description":"Manage the adding, removing, and effects applied to 3D icons used for visualizing incapacitated units.","syntaxes":[{"syntax":"[mode, unitVar] call BIS_fnc_reviveIconControl","params":[{"name":"mode","type":"String","description":"mode","type_expr":"String"},{"name":"unitVar","type":"String","optional":true,"default":"\"\"","description":"unit variable","type_expr":"String","text":"unitVar: String - (Optional, default \"\") unit variable"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if successful, false if not"}}],"see_also":["Arma 3: Revive","BIS_fnc_disableRevive","BIS_fnc_reenableRevive","BIS_fnc_reviveAllowed","BIS_fnc_reviveBleedOut","BIS_fnc_reviveDamageReset","BIS_fnc_reviveDebug","BIS_fnc_reviveEhDammaged","BIS_fnc_reviveEhHandleDamage","BIS_fnc_reviveEhHandleHeal","BIS_fnc_reviveEhKilled","BIS_fnc_reviveEhRespawn","BIS_fnc_reviveEnabled","BIS_fnc_reviveGet3dIcons","BIS_fnc_reviveGetActionIcon","BIS_fnc_reviveInit","BIS_fnc_reviveIsValid","BIS_fnc_reviveIsValidSecure","BIS_fnc_reviveOnBeingRevived","BIS_fnc_reviveOnForcingRespawn","BIS_fnc_reviveOnState","BIS_fnc_reviveOnStateJIP","BIS_fnc_reviveSecureUnit"]},{"name":"BIS_fnc_reviveInit","title":"BIS fnc reviveInit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_reviveInit","revid":349046,"updated":"2023-11-08T14:47:16Z","groups":["Revive"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","description":"Initialize the Revive system on all machines.","syntaxes":[{"syntax":"","params":[],"returns":{"type":"Boolean","type_expr":"Boolean","description":"returns true if successful, otherwise false"}}],"examples":[{"code":["call BIS_fnc_reviveInit;"]}],"see_also":["Arma 3: Revive","BIS_fnc_disableRevive","BIS_fnc_reenableRevive","BIS_fnc_reviveAllowed","BIS_fnc_reviveBleedOut","BIS_fnc_reviveDamageReset","BIS_fnc_reviveDebug","BIS_fnc_reviveEhDammaged","BIS_fnc_reviveEhHandleDamage","BIS_fnc_reviveEhHandleHeal","BIS_fnc_reviveEhKilled","BIS_fnc_reviveEhRespawn","BIS_fnc_reviveEnabled","BIS_fnc_reviveGet3dIcons","BIS_fnc_reviveGetActionIcon","BIS_fnc_reviveIconControl","BIS_fnc_reviveIsValid","BIS_fnc_reviveIsValidSecure","BIS_fnc_reviveOnBeingRevived","BIS_fnc_reviveOnForcingRespawn","BIS_fnc_reviveOnState","BIS_fnc_reviveOnStateJIP","BIS_fnc_reviveSecureUnit"]},{"name":"BIS_fnc_reviveIsValid","title":"BIS fnc reviveIsValid","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_reviveIsValid","revid":349328,"updated":"2023-11-08T14:52:31Z","groups":["Revive"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","description":"Check if player can perform revive action on given unit.","syntaxes":[{"syntax":"[unit] call BIS_fnc_reviveIsValid","params":[{"name":"unit","type":"Object","description":"unit to be checked","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[BIS_player] call BIS_fnc_reviveIsValid;"]}],"see_also":["Arma 3: Revive","BIS_fnc_reenableRevive","BIS_fnc_reviveAllowed","BIS_fnc_reviveBleedOut","BIS_fnc_reviveDamageReset","BIS_fnc_reviveDebug","BIS_fnc_reviveEhDammaged","BIS_fnc_reviveEhHandleDamage","BIS_fnc_reviveEhHandleHeal","BIS_fnc_reviveEhKilled","BIS_fnc_reviveEhRespawn","BIS_fnc_reviveEnabled","BIS_fnc_reviveGet3dIcons","BIS_fnc_reviveGetActionIcon","BIS_fnc_reviveIconControl","BIS_fnc_reviveInit","BIS_fnc_reviveIsValidSecure","BIS_fnc_reviveOnBeingRevived","BIS_fnc_reviveOnForcingRespawn","BIS_fnc_reviveOnState","BIS_fnc_reviveOnStateJIP","BIS_fnc_reviveSecureUnit"]},{"name":"BIS_fnc_reviveIsValidSecure","title":"BIS fnc reviveIsValidSecure","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_reviveIsValidSecure","revid":349307,"updated":"2023-11-08T14:52:21Z","groups":["Revive"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","description":"Check if player can perform secure action on given unit.","syntaxes":[{"syntax":"[unit] call BIS_fnc_reviveIsValidSecure","params":[{"name":"unit","type":"Object","description":"unit to be checked","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[BIS_player] call BIS_fnc_reviveIsValidSecure;"]}],"see_also":["Arma 3: Revive","BIS_fnc_reenableRevive","BIS_fnc_reviveAllowed","BIS_fnc_reviveBleedOut","BIS_fnc_reviveDamageReset","BIS_fnc_reviveDebug","BIS_fnc_reviveEhDammaged","BIS_fnc_reviveEhHandleDamage","BIS_fnc_reviveEhHandleHeal","BIS_fnc_reviveEhKilled","BIS_fnc_reviveEhRespawn","BIS_fnc_reviveEnabled","BIS_fnc_reviveGet3dIcons","BIS_fnc_reviveGetActionIcon","BIS_fnc_reviveIconControl","BIS_fnc_reviveInit","BIS_fnc_reviveIsValid","BIS_fnc_reviveOnBeingRevived","BIS_fnc_reviveOnForcingRespawn","BIS_fnc_reviveOnState","BIS_fnc_reviveOnStateJIP","BIS_fnc_reviveSecureUnit"]},{"name":"BIS_fnc_reviveOnBeingRevived","title":"BIS fnc reviveOnBeingRevived","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_reviveOnBeingRevived","revid":349314,"updated":"2023-11-08T14:52:25Z","groups":["Revive"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","description":"Used to execute specific code locally on every client whenever \"being revived\" flag changes.","syntaxes":[{"syntax":"[nil, flagState, unit] call BIS_fnc_reviveOnBeingRevived","params":[{"name":"nil","type":"Nothing","description":"*This parameter has not been implemented*","type_expr":"Nothing"},{"name":"flagState","type":"Boolean","optional":true,"default":"false","description":"flag state - true or false","type_expr":"Boolean","text":"flagState: Boolean - (Optional, default false) flag state - true or false"},{"name":"unit","type":"Object","description":"unit to set the flag for","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"returns true or Nothing if state didn't change"}}],"examples":[{"code":["[nil, true, squadLeader] call BIS_fnc_reviveOnBeingRevived;"]}],"see_also":["Arma 3: Revive","BIS_fnc_reenableRevive","BIS_fnc_reviveAllowed","BIS_fnc_reviveBleedOut","BIS_fnc_reviveDamageReset","BIS_fnc_reviveDebug","BIS_fnc_reviveEhDammaged","BIS_fnc_reviveEhHandleDamage","BIS_fnc_reviveEhHandleHeal","BIS_fnc_reviveEhKilled","BIS_fnc_reviveEhRespawn","BIS_fnc_reviveEnabled","BIS_fnc_reviveGet3dIcons","BIS_fnc_reviveGetActionIcon","BIS_fnc_reviveIconControl","BIS_fnc_reviveInit","BIS_fnc_reviveIsValid","BIS_fnc_reviveIsValidSecure","BIS_fnc_reviveOnForcingRespawn","BIS_fnc_reviveOnState","BIS_fnc_reviveOnStateJIP","BIS_fnc_reviveSecureUnit"]},{"name":"BIS_fnc_reviveOnForcingRespawn","title":"BIS fnc reviveOnForcingRespawn","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_reviveOnForcingRespawn","revid":274406,"updated":"2021-06-13T01:22:07Z","groups":["Revive"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","description":"Used to execute specific code localy on every client whenever 'forcing respawn' flag changes.","syntaxes":[{"syntax":"[] call BIS_fnc_reviveOnForcingRespawn","params":[{"name":"param0","type":"String","type_expr":"String","description":"Variable that carries the 'being revived' flag over the network, defined by macro VAR_TRANSFER_FORCING_RESPAWN.","text":"0: STRING - Variable that carries the 'being revived' flag over the network, defined by macro VAR_TRANSFER_FORCING_RESPAWN.","source":"docblock"},{"name":"param1","type":"Boolean","type_expr":"Boolean","description":"Flag state - true or false.","text":"1: BOOL - Flag state - true or false.","source":"docblock"},{"name":"param2","type":"Object","type_expr":"Object","description":"Unit to set the flag for.","text":"2: OBJECT - Unit to set the flag for.","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","text":"True if successful, false if not.","source":"docblock"}}],"docblock":{"text":"Author: Jiri Wainar\n\nDescription:\nUsed to execute specific code localy on every client whenever 'forcing respawn' flag changes.\n\nParameters:\n    _this select 0: STRING - Variable that carries the 'being revived' flag over the network, defined by macro VAR_TRANSFER_FORCING_RESPAWN.\n    _this select 1: BOOL - Flag state - true or false.\n    _this select 2: OBJECT - Unit to set the flag for.\n\nReturns:\nTrue if successful, false if not.","author":"Jiri Wainar"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_reviveOnState","title":"BIS fnc reviveOnState","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_reviveOnState","revid":328509,"updated":"2022-07-13T16:26:08Z","groups":["Revive"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","description":"Used to execute specific code localy on every client whenever unit's state changes.","syntaxes":[{"syntax":"[] call BIS_fnc_reviveOnState","params":[{"name":"param0","type":"String","type_expr":"String","description":"Variable that carries the state value over the network, defined by macro VAR_TRANSFER_STATE.","text":"0: STRING - Variable that carries the state value over the network, defined by macro VAR_TRANSFER_STATE.","source":"docblock"},{"name":"param1","type":"Number","type_expr":"Number","description":"State.","text":"1: SCALAR - State.","source":"docblock"},{"name":"param2","type":"Object","type_expr":"Object","description":"Unit to set the status for.","text":"2: OBJECT - Unit to set the status for.","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","text":"True if successful, false if not.\n\nStates:\n    #define STATE_RESPAWNED            0\n    #define STATE_REVIVED            1\n    #define STATE_INCAPACITATED        2\n    #define STATE_DEAD                3","source":"docblock"}}],"examples":[{"code":["{ [objNull, 1, _x] call BIS_fnc_reviveOnState; } forEach (curatorSelected select 0);"]}],"docblock":{"text":"Author: Jiri Wainar\n\nDescription:\nUsed to execute specific code localy on every client whenever unit's state changes.\n\nParameters:\n    _this select 0: STRING - Variable that carries the state value over the network, defined by macro VAR_TRANSFER_STATE.\n    _this select 1: SCALAR - State.\n    _this select 2: OBJECT - Unit to set the status for.\n\nReturns:\nTrue if successful, false if not.\n\nStates:\n    #define STATE_RESPAWNED            0\n    #define STATE_REVIVED            1\n    #define STATE_INCAPACITATED        2\n    #define STATE_DEAD                3","author":"Jiri Wainar"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_reviveOnStateJIP","title":"BIS fnc reviveOnStateJIP","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_reviveOnStateJIP","revid":274408,"updated":"2021-06-13T01:22:08Z","groups":["Revive"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","description":"Used to execute state specific code localy on client that is JIPping.","syntaxes":[{"syntax":"[] call BIS_fnc_reviveOnStateJIP","params":[{"name":"param0","type":"String","type_expr":"String","description":"Variable that carries the state value over the network, defined by macro VAR_TRANSFER_STATE.","text":"0: STRING - Variable that carries the state value over the network, defined by macro VAR_TRANSFER_STATE.","source":"docblock"},{"name":"param1","type":"Number","type_expr":"Number","description":"State.","text":"1: SCALAR - State.","source":"docblock"},{"name":"param2","type":"Object","type_expr":"Object","description":"Unit to set the status for.","text":"2: OBJECT - Unit to set the status for.","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","text":"True if successful, false if not.\n\nStates:\n    #define STATE_RESPAWNED            0\n    #define STATE_REVIVED            1\n    #define STATE_INCAPACITATED        2\n    #define STATE_DEAD                3","source":"docblock"}}],"docblock":{"text":"Author: Jiri Wainar\n\nDescription:\nUsed to execute state specific code localy on client that is JIPping.\n\nParameters:\n    _this select 0: STRING - Variable that carries the state value over the network, defined by macro VAR_TRANSFER_STATE.\n    _this select 1: SCALAR - State.\n    _this select 2: OBJECT - Unit to set the status for.\n\nReturns:\nTrue if successful, false if not.\n\nStates:\n    #define STATE_RESPAWNED            0\n    #define STATE_REVIVED            1\n    #define STATE_INCAPACITATED        2\n    #define STATE_DEAD                3","author":"Jiri Wainar"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_reviveSecureUnit","title":"BIS fnc reviveSecureUnit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_reviveSecureUnit","revid":349321,"updated":"2023-11-08T14:52:29Z","groups":["Revive"],"status":"ok","games":{"arma3":"1.42"},"since":"arma3 1.42","arma3_since":"1.42","description":"Make player secured (killed without execution penalties) by _source unit.","syntaxes":[{"syntax":"[unit, source] call BIS_fnc_reviveSecureUnit","params":[{"name":"unit","type":"Object","description":"unit to be checked","type_expr":"Object"},{"name":"source","type":"Object","description":"reviving unit","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[player_1,player2] call BIS_fnc_reviveSecureUnit;"]}],"see_also":["Arma 3: Revive","BIS_fnc_reenableRevive","BIS_fnc_reviveAllowed","BIS_fnc_reviveBleedOut","BIS_fnc_reviveDamageReset","BIS_fnc_reviveDebug","BIS_fnc_reviveEhDammaged","BIS_fnc_reviveEhHandleDamage","BIS_fnc_reviveEhHandleHeal","BIS_fnc_reviveEhKilled","BIS_fnc_reviveEhRespawn","BIS_fnc_reviveEnabled","BIS_fnc_reviveGet3dIcons","BIS_fnc_reviveGetActionIcon","BIS_fnc_reviveIconControl","BIS_fnc_reviveInit","BIS_fnc_reviveIsValid","BIS_fnc_reviveIsValidSecure","BIS_fnc_reviveOnBeingRevived","BIS_fnc_reviveOnForcingRespawn","BIS_fnc_reviveOnState","BIS_fnc_reviveOnStateJIP"]},{"name":"BIS_fnc_richCurve_compute","title":"BIS fnc richCurve compute","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_compute","revid":278934,"updated":"2021-06-13T21:46:48Z","groups":["RichCurve"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Computes curve data","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_compute","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object     - The curve","source":"docblock"},{"name":"param1","type":"Boolean","type_expr":"Boolean","description":"Whether this is a forced computation (from on attributes changed and not from on drag)","text":"1: Bool     - Whether this is a forced computation (from on attributes changed and not from on drag)","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nComputes curve data\n\nParameter(s):\n_this select 0: Object     - The curve\n_this select 1: Bool     - Whether this is a forced computation (from on attributes changed and not from on drag)\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_computeCurveArcLength","title":"BIS fnc richCurve computeCurveArcLength","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_computeCurveArcLength","revid":363953,"updated":"2024-04-27T20:37:33Z","groups":["RichCurve"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Computes curve arc length","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_computeCurveArcLength","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object     - The curve","source":"docblock"}],"returns":{"type":"Number","type_expr":"Number","description":"The curve arc length","text":"Float - The curve arc length","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nComputes curve arc length\n\nParameter(s):\n_this select 0: Object     - The curve\n\nReturns:\nFloat - The curve arc length","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_computeKeys","title":"BIS fnc richCurve computeKeys","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_computeKeys","revid":278952,"updated":"2021-06-13T21:47:00Z","groups":["RichCurve"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Get's keys assigned to given curve","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_computeKeys","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object     - The curve","source":"docblock"},{"name":"param1","type":"Boolean","type_expr":"Boolean","description":"Whether or not to sort the keys by time","text":"1: Bool    - Whether or not to sort the keys by time","source":"docblock"}],"returns":{"type":"Array","type_expr":"Array","description":"List of assigned keys","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nGet's keys assigned to given curve\n\nParameter(s):\n_this select 0: Object     - The curve\n_this select 1: Bool    - Whether or not to sort the keys by time\n\nReturns:\nArray - List of assigned keys","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_computeOwnerTimeline","title":"BIS fnc richCurve computeOwnerTimeline","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_computeOwnerTimeline","revid":279070,"updated":"2021-06-13T21:48:24Z","groups":["RichCurve"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Stores owner timeline","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_computeOwnerTimeline","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object - The curve","source":"docblock"}],"returns":{"type":"Object","type_expr":"Object","description":"The owner timeline object","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nStores owner timeline\n\nParameter(s):\n_this select 0: Object - The curve\n\nReturns:\nObject - The owner timeline object","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_computeSimulatedObjects","title":"BIS fnc richCurve computeSimulatedObjects","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_computeSimulatedObjects","revid":279050,"updated":"2021-06-13T21:48:09Z","groups":["RichCurve"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Get's all simulated objects","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_computeSimulatedObjects","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object - The curve","source":"docblock"}],"returns":{"type":"Array","type_expr":"Array","description":"List of objects simulated by given curve","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nGet's all simulated objects\n\nParameter(s):\n_this select 0: Object - The curve\n\nReturns:\nArray - List of objects simulated by given curve","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_edenAttributesChanged","title":"BIS fnc richCurve edenAttributesChanged","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_edenAttributesChanged","revid":279124,"updated":"2021-06-13T21:48:59Z","groups":["Curve3DEN"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"3DEN attributes of a curve change","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_edenAttributesChanged","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object - The curve","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\n3DEN attributes of a curve change\n\nParameter(s):\n_this select 0: Object - The curve\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_edenBakeCurve3D","title":"BIS fnc richCurve edenBakeCurve3D","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_edenBakeCurve3D","revid":279110,"updated":"2021-06-13T21:48:53Z","groups":["Curve3DEN"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Bakes a curve to a set of points","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_edenBakeCurve3D","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object  - The curve","source":"docblock"},{"name":"param1","type":"Number","type_expr":"Number","description":"The amount of segments for curve baking (higher numbers mean more detail but also a lot more cpu time)","text":"1: Integer - The amount of segments for curve baking (higher numbers mean more detail but also a lot more cpu time)","source":"docblock"}],"returns":{"type":"Array","type_expr":"Array","description":"All the baked curve points","text":"ARRAY - All the baked curve points","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nBakes a curve to a set of points\n\nParameter(s):\n_this select 0: Object  - The curve\n_this select 1: Integer - The amount of segments for curve baking (higher numbers mean more detail but also a lot more cpu time)\n\nReturns:\nARRAY - All the baked curve points","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_edenComputeNearestSegment","title":"BIS fnc richCurve edenComputeNearestSegment","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_edenComputeNearestSegment","revid":279007,"updated":"2021-06-13T21:47:42Z","groups":["Curve3DEN"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Computes the nearest baked segment from given 3D position","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_edenComputeNearestSegment","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object - The curve","source":"docblock"}],"returns":{"type":"Array","type_expr":"Array","description":"The start and end vectors of segment","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nComputes the nearest baked segment from given 3D position\n\nParameter(s):\n_this select 0: Object - The curve\n\nReturns:\nArray - The start and end vectors of segment","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_edenConnectionChanged","title":"BIS fnc richCurve edenConnectionChanged","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_edenConnectionChanged","revid":279047,"updated":"2021-06-13T21:48:07Z","groups":["Curve3DEN"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"3DEN connection of a curve change","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_edenConnectionChanged","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object - The curve","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\n3DEN connection of a curve change\n\nParameter(s):\n_this select 0: Object - The curve\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_edenDragged","title":"BIS fnc richCurve edenDragged","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_edenDragged","revid":279142,"updated":"2021-06-13T21:49:15Z","groups":["Curve3DEN"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Entity is dragged in 3DEN","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_edenDragged","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object    - The curve","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nEntity is dragged in 3DEN\n\nParameter(s):\n_this select 0: Object    - The curve\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_edenDrawControlPoints3D","title":"BIS fnc richCurve edenDrawControlPoints3D","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_edenDrawControlPoints3D","revid":379571,"updated":"2026-10-31T14:00:14Z","groups":["Curve3DEN"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Draws the control points (keys) of a rich curve in the Eden Editor 3D view. For every key of the curve it draws three 2 m long lines from the key's position, showing the key's orientation: its direction (green), its up vector (blue) and the cross product of both (light red). If 3D icons are visible in Eden (see get3DENIconsVisible), the key's index is also written 4 m below the key, in green for a selected key and in white otherwise.\n\nThe drawing lasts one frame only, so the function has to be called every frame. It is used internally by BIS_fnc_richCurve_edenTick, which calls it while the left Ctrl key is held down in Eden.\n\n> [!NOTE]\n> The colour parameter described in the function's header is not used: the colours are fixed.","syntaxes":[{"syntax":"[curve] call BIS_fnc_richCurve_edenDrawControlPoints3D","params":[{"name":"curve","type":"Object","description":"the curve whose keys are drawn","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"```sqf\n// as done by BIS_fnc_richCurve_edenTick on every frame\nif (missionNamespace getVariable [\"BIS_keyframe_controlPressed\", false]) then\n{\n    [_curve] call BIS_fnc_richCurve_edenDrawControlPoints3D;\n};\n```","code":["// as done by BIS_fnc_richCurve_edenTick on every frame\nif (missionNamespace getVariable [\"BIS_keyframe_controlPressed\", false]) then\n{\n\t[_curve] call BIS_fnc_richCurve_edenDrawControlPoints3D;\n};"]}],"see_also":["BIS_fnc_richCurve_edenTick","BIS_fnc_richCurve_edenDrawCurve3D","BIS_fnc_richCurve_getKeys","BIS_fnc_key_edenIsSelected"]},{"name":"BIS_fnc_richCurve_edenDrawCurve3D","title":"BIS fnc richCurve edenDrawCurve3D","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_edenDrawCurve3D","revid":279101,"updated":"2021-06-13T21:48:46Z","groups":["Curve3DEN"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Draws a location curve in 3D","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_edenDrawCurve3D","params":[{"name":"param0","type":"Array","type_expr":"Array","description":"The baked curve","text":"0: Array    - The baked curve","source":"docblock"},{"name":"param1","type":"Array","type_expr":"Array","description":"The color of the curve rendering","text":"1: Array    - The color of the curve rendering","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nDraws a location curve in 3D\n\nParameter(s):\n_this select 0: Array    - The baked curve\n_this select 1: Array    - The color of the curve rendering\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_edenIsSelected","title":"BIS fnc richCurve edenIsSelected","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_edenIsSelected","revid":279043,"updated":"2021-06-13T21:48:05Z","groups":["Curve3DEN"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Whether given curve is selected in 3den","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_edenIsSelected","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve object","text":"0: Object    - The curve object","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"True if selected, false if not","text":"Bool - True if selected, false if not","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nWhether given curve is selected in 3den\n\nParameter(s):\n_this select 0: Object    - The curve object\n\nReturns:\nBool - True if selected, false if not","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_edenMarkStateDirty","title":"BIS fnc richCurve edenMarkStateDirty","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_edenMarkStateDirty","revid":278924,"updated":"2021-06-13T21:46:41Z","groups":["Curve3DEN"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Marks a curve state as dirty, so it knows it needs to recalculate For example, moving a key in EDEN","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_edenMarkStateDirty","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The Curve","text":"0: Object    - The Curve","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nMarks a curve state as dirty, so it knows it needs to recalculate\nFor example, moving a key in EDEN\n\nParameter(s):\n_this select 0: Object    - The Curve\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_edenTick","title":"BIS fnc richCurve edenTick","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_edenTick","revid":278916,"updated":"2021-06-13T21:46:37Z","groups":["Curve3DEN"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_edenTick","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object - The curve","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\n3DEN 3D drawing\n\nParameter(s):\n_this select 0: Object - The curve\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["params","returns"]},{"name":"BIS_fnc_richCurve_getCurveLength","title":"BIS fnc richCurve getCurveLength","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_getCurveLength","revid":279013,"updated":"2021-06-13T21:47:47Z","groups":["RichCurve"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Calculates distance between all keys, returning the total length","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_getCurveLength","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object     - The curve","source":"docblock"}],"returns":{"type":"Number","type_expr":"Number","description":"The curve length","text":"Float - The curve length","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nCalculates distance between all keys, returning the total length\n\nParameter(s):\n_this select 0: Object     - The curve\n\nReturns:\nFloat - The curve length","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_getCurvePoints","title":"BIS fnc richCurve getCurvePoints","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_getCurvePoints","revid":278967,"updated":"2021-06-13T21:47:07Z","groups":["RichCurve"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Returns the computed curve points","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_getCurvePoints","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object     - The curve","source":"docblock"}],"returns":{"type":"Array","type_expr":"Array","description":"The curve points (array of 3D vectors)","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nReturns the computed curve points\n\nParameter(s):\n_this select 0: Object     - The curve\n\nReturns:\nArray - The curve points (array of 3D vectors)","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_getCurveValueFloat","title":"BIS fnc richCurve getCurveValueFloat","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_getCurveValueFloat","revid":279094,"updated":"2021-06-13T21:48:39Z","groups":["RichCurve"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Get's curve value at given time","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_getCurveValueFloat","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object     - The curve","source":"docblock"},{"name":"param1","type":"Number","type_expr":"Number","description":"The time","text":"1: Float     - The time","source":"docblock"},{"name":"param2","type":"Number","type_expr":"Number","description":"Value type","text":"2: Integer    - Value type","source":"docblock"}],"returns":{"type":"Number","type_expr":"Number","description":"The value at given time","text":"float - The value at given time","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nGet's curve value at given time\n\nParameter(s):\n_this select 0: Object     - The curve\n_this select 1: Float     - The time\n_this select 2: Integer    - Value type\n\nReturns:\nfloat - The value at given time","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_getCurveValueVector","title":"BIS fnc richCurve getCurveValueVector","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_getCurveValueVector","revid":279029,"updated":"2021-06-13T21:47:55Z","groups":["RichCurve"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Get's curve value at given time","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_getCurveValueVector","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object     - The curve","source":"docblock"},{"name":"param1","type":"Number","type_expr":"Number","description":"The time","text":"1: Float     - The time","source":"docblock"},{"name":"param2","type":"Number","type_expr":"Number","description":"Value type","text":"2: Integer    - Value type","source":"docblock"}],"returns":{"type":"Array","type_expr":"Array","description":"The vector value at given time","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nGet's curve value at given time\n\nParameter(s):\n_this select 0: Object     - The curve\n_this select 1: Float     - The time\n_this select 2: Integer    - Value type\n\nReturns:\nArray - The vector value at given time","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_getFirstKey","title":"BIS fnc richCurve getFirstKey","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_getFirstKey","revid":279104,"updated":"2021-06-13T21:48:49Z","groups":["RichCurve"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Get's the first key on given curve","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_getFirstKey","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object - The curve","source":"docblock"}],"returns":{"type":"Object","type_expr":"Object","description":"The first key of given curve","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nGet's the first key on given curve\n\nParameter(s):\n_this select 0: Object - The curve\n\nReturns:\nObject - The first key of given curve","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_getKeyFromIndex","title":"BIS fnc richCurve getKeyFromIndex","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_getKeyFromIndex","revid":279137,"updated":"2021-06-13T21:49:13Z","groups":["RichCurve"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Get's the key in given index of given curve","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_getKeyFromIndex","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object - The curve","source":"docblock"},{"name":"param1","type":"Number","type_expr":"Number","description":"The key index","text":"1: Integer - The key index","source":"docblock"}],"returns":{"type":"Object","type_expr":"Object","description":"The key at given index","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nGet's the key in given index of given curve\n\nParameter(s):\n_this select 0: Object - The curve\n_this select 1: Integer - The key index\n\nReturns:\nObject - The key at given index","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_getKeyIndex","title":"BIS fnc richCurve getKeyIndex","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_getKeyIndex","revid":279144,"updated":"2021-06-13T21:49:18Z","groups":["RichCurve"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Get's the index of given key in given curve","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_getKeyIndex","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object - The curve","source":"docblock"},{"name":"param1","type":"Object","type_expr":"Object","description":"The key","text":"1: Object - The key","source":"docblock"}],"returns":{"type":"Number","type_expr":"Number","description":"The index of the given key in given curve","text":"Integer - The index of the given key in given curve","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nGet's the index of given key in given curve\n\nParameter(s):\n_this select 0: Object - The curve\n_this select 1: Object - The key\n\nReturns:\nInteger - The index of the given key in given curve","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_getKeys","title":"BIS fnc richCurve getKeys","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_getKeys","revid":278970,"updated":"2021-06-13T21:47:12Z","groups":["RichCurve"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Get's keys assigned to given curve","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_getKeys","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object - The curve","source":"docblock"}],"returns":{"type":"Array","type_expr":"Array","description":"List of assigned keys","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nGet's keys assigned to given curve\n\nParameter(s):\n_this select 0: Object - The curve\n\nReturns:\nArray - List of assigned keys","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_getKeysAtTime","title":"BIS fnc richCurve getKeysAtTime","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_getKeysAtTime","revid":279120,"updated":"2021-06-13T21:48:58Z","groups":["RichCurve"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Get's keys (prev / next) at given time","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_getKeysAtTime","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object     - The curve","source":"docblock"},{"name":"param1","type":"Number","type_expr":"Number","description":"The time","text":"1: Float    - The time","source":"docblock"}],"returns":{"type":"Array","type_expr":"Array","description":"Previous and next keys","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nGet's keys (prev / next) at given time\n\nParameter(s):\n_this select 0: Object     - The curve\n_this select 1: Float    - The time\n\nReturns:\nArray - Previous and next keys","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_getKeyTime","title":"BIS fnc richCurve getKeyTime","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_getKeyTime","revid":279034,"updated":"2021-06-13T21:47:57Z","groups":["RichCurve"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Returns given key time in alpha","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_getKeyTime","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object - The curve","source":"docblock"}],"returns":{"type":"Number","type_expr":"Number","description":"The time in alpha of given key (from 0 to 1)","text":"Float - The time in alpha of given key (from 0 to 1)","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nReturns given key time in alpha\n\nParameter(s):\n_this select 0: Object - The curve\n\nReturns:\nFloat - The time in alpha of given key (from 0 to 1)","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_getLastKey","title":"BIS fnc richCurve getLastKey","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_getLastKey","revid":279150,"updated":"2021-06-13T21:49:24Z","groups":["RichCurve"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Get's the last key on given curve","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_getLastKey","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object - The curve","source":"docblock"}],"returns":{"type":"Object","type_expr":"Object","description":"The last key of given curve","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nGet's the last key on given curve\n\nParameter(s):\n_this select 0: Object - The curve\n\nReturns:\nObject - The last key of given curve","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_getLookAtPosition","title":"BIS fnc richCurve getLookAtPosition","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_getLookAtPosition","revid":279129,"updated":"2021-06-13T21:49:03Z","groups":["RichCurve"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Returns the look at position of this curve, [0.0, 0.0, 0.0] if not set","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_getLookAtPosition","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object - The curve","source":"docblock"}],"returns":{"type":"Array","type_expr":"Array","description":"Target position, [0.0, 0.0, 0.0] if not set","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nReturns the look at position of this curve, [0.0, 0.0, 0.0] if not set\n\nParameter(s):\n_this select 0: Object - The curve\n\nReturns:\nArray - Target position, [0.0, 0.0, 0.0] if not set","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_getNextKey","title":"BIS fnc richCurve getNextKey","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_getNextKey","revid":279121,"updated":"2021-06-13T21:48:58Z","groups":["RichCurve"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Get's the next key from given key, null if none exists","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_getNextKey","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object - The curve","source":"docblock"},{"name":"param1","type":"Object","type_expr":"Object","description":"The key","text":"1: Object - The key","source":"docblock"}],"returns":{"type":"Object","type_expr":"Object","description":"The next key","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nGet's the next key from given key, null if none exists\n\nParameter(s):\n_this select 0: Object - The curve\n_this select 1: Object - The key\n\nReturns:\nObject - The next key","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_getOrientationMode","title":"BIS fnc richCurve getOrientationMode","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_getOrientationMode","revid":278963,"updated":"2021-06-13T21:47:06Z","groups":["RichCurve"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Returns orientation mode for objects animated by this curve","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_getOrientationMode","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object - The curve","source":"docblock"}],"returns":{"type":"Number","type_expr":"Number","description":"The mode (0 = None, 1 = Look At, 2 = Movement Direction)","text":"Integer - The mode (0 = None, 1 = Look At, 2 = Movement Direction)","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nReturns orientation mode for objects animated by this curve\n\nParameter(s):\n_this select 0: Object - The curve\n\nReturns:\nInteger - The mode (0 = None, 1 = Look At, 2 = Movement Direction)","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_getOwnerTimeline","title":"BIS fnc richCurve getOwnerTimeline","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_getOwnerTimeline","revid":279010,"updated":"2021-06-13T21:47:44Z","groups":["RichCurve"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Returns a curve's simulated objects","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_getOwnerTimeline","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object - The curve","source":"docblock"}],"returns":{"type":"Object","type_expr":"Object","description":"The owner timeline object","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nReturns a curve's simulated objects\n\nParameter(s):\n_this select 0: Object - The curve\n\nReturns:\nObject - The owner timeline object","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_getPreviousKey","title":"BIS fnc richCurve getPreviousKey","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_getPreviousKey","revid":279157,"updated":"2021-06-13T21:49:29Z","groups":["RichCurve"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Get's the previous key from given key, null if none exists","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_getPreviousKey","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object - The curve","source":"docblock"},{"name":"param1","type":"Object","type_expr":"Object","description":"The key","text":"1: Object - The key","source":"docblock"}],"returns":{"type":"Object","type_expr":"Object","description":"The previous key","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nGet's the previous key from given key, null if none exists\n\nParameter(s):\n_this select 0: Object - The curve\n_this select 1: Object - The key\n\nReturns:\nObject - The previous key","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_getSimulatedObjects","title":"BIS fnc richCurve getSimulatedObjects","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_getSimulatedObjects","revid":278985,"updated":"2021-06-13T21:47:23Z","groups":["RichCurve"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Returns a curve's simulated objects","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_getSimulatedObjects","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object - The curve","source":"docblock"}],"returns":{"type":"Array","type_expr":"Array","description":"List of objects simulated by given curve","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nReturns a curve's simulated objects\n\nParameter(s):\n_this select 0: Object - The curve\n\nReturns:\nArray - List of objects simulated by given curve","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_getTimeRange","title":"BIS fnc richCurve getTimeRange","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_getTimeRange","revid":279038,"updated":"2021-06-13T21:48:00Z","groups":["RichCurve"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Returns min / max time range of given curve","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_getTimeRange","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object - The curve","source":"docblock"}],"returns":{"type":"Array","type_expr":"Array","description":"Min / Max time range","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nReturns min / max time range of given curve\n\nParameter(s):\n_this select 0: Object - The curve\n\nReturns:\nArray - Min / Max time range","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_isTimeInSeconds","title":"BIS fnc richCurve isTimeInSeconds","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_isTimeInSeconds","revid":278960,"updated":"2021-06-13T21:47:04Z","groups":["RichCurve"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Whether the time of the keys belonging to this curve are in seconds","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_isTimeInSeconds","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object - The curve","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"True if in seconds, false if in alpha","text":"Bool - True if in seconds, false if in alpha","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nWhether the time of the keys belonging to this curve are in seconds\n\nParameter(s):\n_this select 0: Object - The curve\n\nReturns:\nBool - True if in seconds, false if in alpha","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_numKeys","title":"BIS fnc richCurve numKeys","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_numKeys","revid":279143,"updated":"2021-06-13T21:49:17Z","groups":["RichCurve"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Returns number of keys registered with given curve","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_numKeys","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object - The curve","source":"docblock"}],"returns":{"type":"Number","type_expr":"Number","description":"Number of keys assigned to this curve","text":"Integer - Number of keys assigned to this curve","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nReturns number of keys registered with given curve\n\nParameter(s):\n_this select 0: Object - The curve\n\nReturns:\nInteger - Number of keys assigned to this curve","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_reset","title":"BIS fnc richCurve reset","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_reset","revid":279107,"updated":"2021-06-13T21:48:50Z","groups":["RichCurve"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Clears all curves (and deletes them)","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_reset","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object - The curve","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nClears all curves (and deletes them)\n\nParameter(s):\n_this select 0: Object - The curve\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_resetKeysEventState","title":"BIS fnc richCurve resetKeysEventState","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_resetKeysEventState","revid":278968,"updated":"2021-06-13T21:47:08Z","groups":["RichCurve"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Reset's flag on all keys about handled events","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_resetKeysEventState","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object - The curve","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nReset's flag on all keys about handled events\n\nParameter(s):\n_this select 0: Object - The curve\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_setKeys","title":"BIS fnc richCurve setKeys","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_setKeys","revid":278927,"updated":"2021-06-13T21:46:43Z","groups":["RichCurve"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Set's keys assigned to given curve","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_setKeys","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object - The curve","source":"docblock"},{"name":"param1","type":"Array","type_expr":"Array","description":"The keys","text":"1: Array - The keys","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nSet's keys assigned to given curve\n\nParameter(s):\n_this select 0: Object - The curve\n_this select 1: Array - The keys\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_richCurve_setOrientationMode","title":"BIS fnc richCurve setOrientationMode","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_richCurve_setOrientationMode","revid":279061,"updated":"2021-06-13T21:48:20Z","groups":["RichCurve"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Set's the curve's orientation mode","syntaxes":[{"syntax":"[] call BIS_fnc_richCurve_setOrientationMode","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The curve","text":"0: Object     - The curve","source":"docblock"},{"name":"param1","type":"Number","type_expr":"Number","description":"The orientation mode (0 = None / 1 = Animation / 2 = Look At / 3 = Movement Direction)","text":"1: Integer - The orientation mode (0 = None / 1 = Animation / 2 = Look At / 3 = Movement Direction)","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nSet's the curve's orientation mode\n\nParameter(s):\n_this select 0: Object     - The curve\n_this select 1: Integer - The orientation mode (0 = None / 1 = Animation / 2 = Look At / 3 = Movement Direction)\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_romanNumeral","title":"BIS fnc romanNumeral","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_romanNumeral","revid":340860,"updated":"2023-05-12T16:49:46Z","groups":["Strings","Math"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Convert integer to roman numerals (e.g. 42 becomes \"XLII\").","syntaxes":[{"syntax":"integer call BIS_fnc_romanNumeral","params":[{"name":"integer","type":"Number, String, Code or Config, same as BIS_fnc_parseNumber (used in this function)","description":"any **integer** between 1 and 3999","type_expr":"Number | String | Code | Config"}],"returns":{"type":"String","type_expr":"String","description":"roman numerals"}}],"examples":[{"text":"```sqf\n1 call BIS_fnc_romanNumeral;        // returns \"I\"\n2035 call BIS_fnc_romanNumeral;    // returns \"MMXXXV\"\n3999 call BIS_fnc_romanNumeral;    // returns \"MMMCMXCIX\"\n```","code":["1 call BIS_fnc_romanNumeral;\t\t// returns \"I\"\n2035 call BIS_fnc_romanNumeral;\t// returns \"MMXXXV\"\n3999 call BIS_fnc_romanNumeral;\t// returns \"MMMCMXCIX\""]}],"see_also":["BIS_fnc_ordinalNumber","BIS_fnc_phoneticalWord"],"notes":[{"user":"Lou Montana","date":"2019-10-01T01:46:00Z","text":"A Roman numeral is read like this:\n\n|  |  |  |  |  |  |  |  |\n|---|---|---|---|---|---|---|---|\n| Numeral | I | V | X | L | C | D | M |\n| Value | 1 | 5 | 10 | 50 | 100 | 500 | 1000 |\n\n- It is read from left to right from the biggest numeral to the lowest*, adding up:\n  * not entirely true, see subtractions below\n  - `DCLVII` = `D` → `C` → `L` → `V` → `I` → `I` = 500 + 100 + 50 + 5 + 1 + 1 = 657\n- A subtraction is done by writing **one** smaller numeral before a big one:\n  - 9 could be written `VIIII`, or `IX`: 1 and 10, meaning 10 - 1 = 9 / but `IIX` for 8 does not exist, only `VIII`\n- The same numeral can be put together multiple times, but *usually* (there is no standard, but the shorter version is usually preferred) up to the point where it can be subtracted from the numeral above the used one (subtraction still done with only **one** numeral):\n  - `IIII` = `IV`, `CCCC` = `CD`\n\nNow let's see if you can translate this one: `MCMLXXXV`. Tip: where it all started ;-) `MCMLXXXII` for the purists!\nTo learn more: **[Roman numerals on wikipedia](https://en.wikipedia.org/wiki/Roman_numerals)**"}]},{"name":"BIS_fnc_rotateMarker","title":"BIS fnc rotateMarker","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_rotateMarker","revid":348885,"updated":"2023-11-08T14:39:49Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","locality":{"argument":"global","effect":"global"},"exec":"spawn","description":"Rotating a marker to new azimuth, using shortest turn, clockwise or anticlockwise movement.","syntaxes":[{"syntax":"[marker, newAzimuth, absoluteOrRelativ, shortestTurn, duraton] spawn BIS_fnc_rotateMarker","params":[{"name":"marker","type":"String","description":"marker to rotate","type_expr":"String"},{"name":"newAzimuth","type":"Number","description":"new azimuth","type_expr":"Number"},{"name":"absoluteOrRelativ","type":"Boolean","optional":true,"default":"true","description":"defines if the azimuth is absolute true or relative false","type_expr":"Boolean","text":"absoluteOrRelativ: Boolean - (Optional, default true) defines if the azimuth is absolute true or relative false"},{"name":"shortestTurn","type":"Number","optional":true,"default":"0","description":"0 - shortest turn (default, if used with relative dir, counter clockwise is used)\n1 - force clockwise\n2 - force counter clockwise","type_expr":"Number","text":"shortestTurn: Number - (Optional, default 0) 0 - shortest turn (default, if used with relative dir, counter clockwise is used)\n1 - force clockwise\n2 - force counter clockwise"},{"name":"duraton","type":"Number","optional":true,"default":"2","description":"duration for the complete rotation in seconds","type_expr":"Number","text":"duraton: Number - (Optional, default 2) duration for the complete rotation in seconds"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"BIS_marker\",90] spawn BIS_fnc_rotateMarker;"]},{"code":["[\"BIS_marker\",90,false,2,5] spawn BIS_fnc_rotateMarker;"]}],"see_also":["BIS_fnc_blinkMarker","BIS_fnc_resizeMarker","BIS_fnc_moveMarker"]},{"name":"BIS_fnc_rotateVector2D","title":"BIS fnc rotateVector2D","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_rotateVector2D","revid":348898,"updated":"2023-11-08T14:39:55Z","groups":["Vectors"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"This function returns a 2D vector rotated a specified number of degrees around the origin.","syntaxes":[{"syntax":"[vector2D, angle] call BIS_fnc_rotateVector2D","params":[{"name":"vector2D","type":"Array","description":"2D vector","type_expr":"Array"},{"name":"angle","type":"Number","description":"angle in degree","type_expr":"Number"}],"returns":{"type":"Array","type_expr":"Array","description":"new vector"}}],"examples":[{"code":["[[5,3], 60] call BIS_fnc_rotateVector2D;//Returns[-0.0980766,5.83013]"]}],"see_also":["BIS_fnc_crossProduct","BIS_fnc_magnitudeSqr","BIS_fnc_vectorFromXToY"],"notes":[{"user":"AgentRev","date":"2015-01-21T14:15:00Z","text":"Be careful when using this function in conjunction with getDir or BIS_fnc_dirTo, which return a clockwise angle, while the rotation is done counterclockwise as per trigonometric conventions.\nTo counter this, simply negate their output:\n\n```sqf\n[[0,1,0], -(getDir _object)] call BIS_fnc_rotateVector2D;\n[[0,1,0], -([_unit, _vehicle] call BIS_fnc_dirTo)] call BIS_fnc_rotateVector2D;\n```"}]},{"name":"BIS_fnc_rotateVector3D","title":"BIS fnc rotateVector3D","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_rotateVector3D","revid":338142,"updated":"2023-02-23T23:47:39Z","groups":["Vectors"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Rotates the vector around the given axis by the given angle","syntaxes":[{"syntax":"[vector, angle, axis] call BIS_fnc_rotateVector3D","params":[{"name":"vector","type":"Array in format Vector3D","type_expr":"Vector3D","types":["Array","Vector3D"]},{"name":"angle","type":"Number","description":"given angle (taken in the opposite direction to the one defined by the [right hand rule](https://en.wikipedia.org/wiki/Right-hand_rule))","type_expr":"Number"},{"name":"axis","type":"Number","description":"rotation axis:\n\n- 0 - **X** axis\n- 1 - **Y** axis\n- 2 - **Z** axis","type_expr":"Number"}],"returns":{"type":"Array","type_expr":"Array","description":"rotated vector in format Vector3D"}}],"examples":[{"code":["[vectorDir player, 90, 2] call BIS_fnc_rotateVector3D;"]}],"see_also":["BIS_fnc_transformVectorDirAndUp","BIS_fnc_rotateVector2D"]},{"name":"BIS_fnc_roundDir","title":"BIS fnc roundDir","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_roundDir","revid":327918,"updated":"2022-07-13T12:12:29Z","groups":["Math"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Round direction to nearest set rounding; used for determining cardinal direction.","syntaxes":[{"syntax":"[rawDirection, rounding] call BIS_fnc_roundDir","params":[{"name":"rawDirection","type":"Number","description":"direction to round","type_expr":"Number"},{"name":"rounding","type":"Number","optional":true,"default":"90","description":"rounding value. With 90° possible return values are 0, 90, 180 and 270","type_expr":"Number","text":"rounding: Number - (Optional, default 90) - rounding value. With 90° possible return values are 0, 90, 180 and 270"}],"returns":{"type":"Number","type_expr":"Number","description":"rounded direction, depending on input. Can be negative or over 360","text":"Number - rounded direction, depending on input. **Can be negative or over 360**"}}],"examples":[{"code":["player setDir ([getDir player, 45] call BIS_fnc_roundDir);"]},{"code":["[204.2, 10] call BIS_fnc_roundDir; // will return 200"]},{"code":["[271, 180] call BIS_fnc_roundDir; // will return 360"]},{"code":["70 call BIS_fnc_roundDir; // will return 90"]}],"see_also":["setDir","getRelDir","round"]},{"name":"BIS_fnc_roundNum","title":"BIS fnc roundNum","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_roundNum","revid":379279,"updated":"2026-10-30T23:45:23Z","groups":["Math"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Round a number to the provided factor.","syntaxes":[{"syntax":"[number, factor, secondary factor] call BIS_fnc_roundNum","params":[{"name":"number","type":"Number","description":"number that should be rounded.","type_expr":"Number"},{"name":"factor","type":"Number","description":"factor","type_expr":"Number"},{"name":"secondary factor","type":"Number","optional":true,"description":"Secondary factor, used when number / primary factor is smaller than 10 (scalar).","type_expr":"Number","text":"secondary factor: Number - (Optional) Secondary factor, used when number / primary factor is smaller than 10 (scalar)."}],"returns":{"type":"Number","type_expr":"Number","description":"rounded number"}}],"examples":[{"code":["[10.254,2,3] call BIS_fnc_roundNum;//Returns 9"]},{"code":["[10.254,1,3] call BIS_fnc_roundNum;//Returns 10"]}],"see_also":["BIS_fnc_randomInt","BIS_fnc_geometricMean","BIS_fnc_arithmeticMean","BIS_fnc_nearestNum","BIS_fnc_sortNum"]},{"name":"BIS_fnc_rscLayer","title":"BIS fnc rscLayer","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_rscLayer","revid":348814,"updated":"2023-11-08T14:38:17Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Register RSC layer and returns a **unique** ID.","syntaxes":[{"syntax":"[layerName] call BIS_fnc_rscLayer","params":[{"name":"layerName","type":"String","description":"layer name. Parent function name is used automatically when param is nil.","type_expr":"String"}],"returns":{"type":"Number","type_expr":"Number","description":"layer ID"}}],"examples":[{"code":["private _id = [\"myLayerName\"] call BIS_fnc_rscLayer;"]}],"see_also":["allCutLayers","titleRsc","cutText","cutObj","cutFadeOut","setTitleEffect"]},{"name":"BIS_fnc_runLater","title":"BIS fnc runLater","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_runLater","revid":349313,"updated":"2023-11-08T14:52:25Z","groups":["Program Flow"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Stack code/function that should be run later, after some time/frames or/and custom condition. Internally calls BIS_fnc_loop.","syntaxes":[{"syntax":"[id, code, timer, timerType, condition] call BIS_fnc_runLater","params":[{"name":"id","type":"String","description":"unique Id","type_expr":"String"},{"name":"code","type":"Code or String","description":"code/function that is executed later","type_expr":"Code | String"},{"name":"timer","type":"Number","description":"the timer value (can be in seconds or frames)","type_expr":"Number"},{"name":"timerType","type":"String","description":"can be \"seconds\" or \"frames\"","type_expr":"String"},{"name":"condition","type":"Code","description":"the custom condition, code is only executed if timer is validated and condition is met","type_expr":"Code"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["// Hints current game time in the next frame after 5 seconds have passed\n[\"uniqueId\", { hint str time; }, 5] call BIS_fnc_runLater;"]},{"code":["// Hints current game time in the next frame after 120 frames have passed\n[\"uniqueId\", { hint str time; }, 120, \"frames\"] call BIS_fnc_runLater;"]},{"code":["// Hints current game time in the next frame after BIS_variable is assigned\n[\"uniqueId\", { hint str time; }, nil, nil, { !isNil { BIS_variable } }] call BIS_fnc_runLater;"]},{"code":["// Hints current game time in the next frame after 5 seconds have passed and BIS_variable is assigned\n[\"uniqueId\", { hint str time; }, 5, \"seconds\", { !isNil { BIS_variable } }] call BIS_fnc_runLater;"]},{"code":["// Hints current game time in the next frame\n[\"uniqueId\", { hint str time; }] call BIS_fnc_runLater;"]}],"see_also":["BIS_fnc_CPWaitUntil","waitUntil","BIS_fnc_loop"]},{"name":"BIS_fnc_sandstorm","title":"BIS fnc sandstorm","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_sandstorm","revid":329203,"updated":"2022-07-25T15:55:35Z","groups":["Environment"],"status":"ok","games":{"arma2oa":"1.56","tkoh":"1.00","arma3":"0.50"},"since":"arma2oa 1.56","arma3_since":"0.50","locality":{"argument":"global","effect":"local"},"description":"Creates particle sandstorm round given object.\n\n> [!NOTE]\n> **Arma 3:** The *newspapers* parameter is disabled in Arma 3.","syntaxes":[{"syntax":"[object, interval, brightness, newspapers] call BIS_fnc_sandstorm","params":[{"name":"position","type":"Object","description":"sandstorm center (should usually be player)","type_expr":"Object"},{"name":"interval","type":"Number","optional":true,"default":"0.07","description":"particle refresh time; a lower number makes the sandstorm more dense","type_expr":"Number","text":"interval: Number - (Optional, default 0.07) particle refresh time; a lower number makes the sandstorm more dense"},{"name":"brightness","type":"Number","optional":true,"default":"1","description":"brightness coeficient; 1 is bright, 0 is dark","type_expr":"Number","text":"brightness: Number - (Optional, default 1) brightness coeficient; 1 is bright, 0 is dark"},{"name":"newspapers","type":"Boolean","optional":true,"default":"true","description":"true if flying newspapers should be present","type_expr":"Boolean","text":"newspapers: Boolean - (Optional, default true) true if flying newspapers should be present"}],"returns":{"type":"Array of created particle effect","type_expr":"Array"}}],"examples":[{"code":["[player, 0.04, 0.8, false] call BIS_fnc_sandstorm;"]}],"see_also":["Functions Library"]},{"name":"BIS_fnc_saveGame","title":"BIS fnc saveGame","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_saveGame","revid":349308,"updated":"2023-11-08T14:52:21Z","groups":["Missions"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Evaluates the current battlefield situation and saves the game when appropriate.","syntaxes":[{"syntax":"[objects] call BIS_fnc_saveGame","params":[{"name":"objects","type":"Array","description":"units to check","type_expr":"Array"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if saved"}}],"examples":[{"code":["[unit_1, unit_2] call BIS_fnc_saveGame;"]}],"see_also":["saveGame","loadGame"]},{"name":"BIS_fnc_saveInventory","title":"BIS fnc saveInventory","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_saveInventory","revid":378580,"updated":"2026-05-10T21:43:21Z","groups":["Inventory"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Save unit's loadout.","syntaxes":[{"syntax":"[unit, input, params, delete] call BIS_fnc_saveInventory","params":[{"name":"unit","type":"Object","description":"unit whose inventory should be saved","type_expr":"Object"},{"name":"input","type":"Array format [target, loadoutName]:","description":"Array format [target, loadoutName]:\n\n- target: Namespace, Group or Object - target where the loadout is stored\n- loadoutName: String - loadout name","type_expr":"Array","text":"input: Array format [target, loadoutName]:\n\n- target: Namespace, Group or Object - target where the loadout is stored\n- loadoutName: String - loadout name"},{"name":"params","type":"Array","optional":true,"default":"[]","description":"custom parameters stored with the loadout","type_expr":"Array","text":"params: Array - (Optional, default []) custom parameters stored with the loadout"},{"name":"delete","type":"Boolean","optional":true,"default":"false","description":"whether or not to delete the loadout","type_expr":"Boolean","text":"delete: Boolean - (Optional, default false) whether or not to delete the loadout"}],"returns":{"type":"Array","type_expr":"Array","description":"saved value"}}],"examples":[{"code":["[player, [missionNamespace, \"BIS_inv\"], [], true] call BIS_fnc_saveInventory;"]}],"see_also":["BIS_fnc_loadInventory","BIS_fnc_exportInventory","BIS_fnc_deleteInventory","getUnitLoadout"],"notes":[{"user":"Ilias38rus","date":"2020-08-02T15:22:00Z","text":"Doesn't work for backpacks in backpack, unlike getUnitLoadout."}]},{"name":"BIS_fnc_saveVehicle","title":"BIS fnc saveVehicle","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_saveVehicle","revid":363632,"updated":"2024-04-08T21:57:02Z","groups":["Vehicles"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Save vehicle's params (textures, animations, crew).","syntaxes":[{"syntax":"[object,target,params,delete] call BIS_fnc_saveVehicle","params":[{"name":"object","type":"Object","description":"vehicle","type_expr":"Object"},{"name":"target","type":"Array","description":"in format:\n\n- 0: Namespace, Group or Object - Where the save will be saved\n- 1: String - Name of the save","type_expr":"Array"},{"name":"params","type":"Array","optional":true,"default":"`[]`","description":"additional parameters to be saved","type_expr":"Array","text":"params: Array - (Optional, default `[]`) additional parameters to be saved"},{"name":"delete","type":"Boolean","optional":true,"default":"false","description":"true to delete the save","type_expr":"Boolean","text":"delete: Boolean - (Optional, default false) true to delete the save"}],"returns":{"type":"Array","type_expr":"Array","description":"saved value"}}],"examples":[{"code":["[BIS_tank, [missionNamespace, \"BIS_someTankSave\"], [\"SomeRandomParam\"], false] call BIS_fnc_saveVehicle;"]}],"see_also":["BIS_fnc_initVehicle","BIS_fnc_loadVehicle","Arma 3: Vehicle Customisation"]},{"name":"BIS_fnc_sayMessage","title":"BIS fnc sayMessage","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_sayMessage","revid":328363,"updated":"2022-07-13T16:00:47Z","groups":["Sound"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"global","effect":"local"},"description":"Make a speaker say a message.","syntaxes":[{"syntax":"[speaker, message, channel] call BIS_fnc_sayMessage","params":[{"name":"speaker","type":"Object or Side","type_expr":"Object | Side"},{"name":"message","type":"String","description":"must be defined in either CfgSounds or CfgRadio","type_expr":"String"},{"name":"channel","type":"String or Number","optional":true,"default":"\"side\"","description":"can be \"say3D\", \"direct\", \"group\", \"vehicle\", \"side\", \"command\", \"global\", or custom channel ID","type_expr":"String | Number","text":"channel: String or Number - (Optional, default \"side\") can be \"say3D\", \"direct\", \"group\", \"vehicle\", \"side\", \"command\", \"global\", or custom channel ID"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when done"}}],"examples":[{"code":["[leader player, \"to_c01_m01_brief_001_br_briefing_a_CENTAUR_0\", \"say3D\"] call BIS_fnc_sayMessage;"]}],"see_also":["say","say3D","directSay","groupRadio","vehicleRadio","sideRadio","commandRadio","globalRadio","customRadio"]},{"name":"BIS_fnc_scaleAndTranslate","title":"BIS fnc scaleAndTranslate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_scaleAndTranslate","revid":364739,"updated":"2024-06-04T21:40:23Z","groups":["Systems"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Translates, scales (with pivot) and fades a picture control over time.","syntaxes":[{"syntax":"[picture, scaleFactor, pivot, translation, durationOrSpeed, isDuration, fade] call BIS_fnc_scaleAndTranslate","params":[{"name":"picture","type":"Control","description":"picture that has to be modified","type_expr":"Control"},{"name":"scaleFactor","type":"Number","optional":true,"default":"1","description":"how much the picture has to be scaled (> 1 makes it bigger, 1 keeps it the same, < 1 makes it smaller)","type_expr":"Number","text":"scaleFactor: Number - (Optional, default 1) how much the picture has to be scaled (> 1 makes it bigger, 1 keeps it the same, < 1 makes it smaller)"},{"name":"pivot","type":"String","optional":true,"default":"\"center\"","description":"select the pivot's position (i.e. center of the scaling process); can be one of:\n\n- \"topLeft\"\n- \"topCenter\"\n- \"topRight\"\n- \"centerLeft\"\n- \"center\"\n- \"centerRight\"\n- \"bottomLeft\"\n- \"bottomCenter\"\n- \"bottomRight\"","type_expr":"String","text":"pivot: String - (Optional, default \"center\") select the pivot's position (i.e. center of the scaling process); can be one of:\n\n- \"topLeft\"\n- \"topCenter\"\n- \"topRight\"\n- \"centerLeft\"\n- \"center\"\n- \"centerRight\"\n- \"bottomLeft\"\n- \"bottomCenter\"\n- \"bottomRight\""},{"name":"translation","type":"Array format [x, y]","optional":true,"default":"[0, 0]","description":"how much the picture has to be moved","type_expr":"Array","text":"translation: Array format [x, y] - (Optional, default [0, 0]) how much the picture has to be moved"},{"name":"durationOrSpeed","type":"Number","optional":true,"default":"2","description":"either the duration of the animation(default) or the speed of the translation, depending on what the next parameter is set to","type_expr":"Number","text":"durationOrSpeed: Number - (Optional, default 2) either the duration of the animation(default) or the speed of the translation, depending on what the next parameter is set to"},{"name":"isDuration","type":"Boolean","optional":true,"default":"true","description":"if true, *durationOrSpeed* is considered duration; if false it is considered speed","type_expr":"Boolean","text":"isDuration: Boolean - (Optional, default true) if true, *durationOrSpeed* is considered duration; if false it is considered speed"},{"name":"fade","type":"Number","optional":true,"default":"0","description":"transparency of the image at the end of the animation (in range 0..1: 0 = visible, 1 = invisible)","type_expr":"Number","text":"fade: Number - (Optional, default 0) transparency of the image at the end of the animation (in range 0..1: 0 = visible, 1 = invisible)"}],"returns":{"type":"Number","type_expr":"Number","description":"duration of the animation; useful for determining how much sleep time is needed between animations"}}],"examples":[{"code":["[_controlFront, 0.8, \"topLeft\"] call BIS_fnc_scaleAndTranslate;\nprivate _t = [_controlFront, 1, \"bottomRight\", [0.1, 0.1], 0.5, false] call BIS_fnc_scaleAndTranslate;\nsleep (_t * 2);\n[_controlFront, 0.8, \"topRight\", [0.5, 0.3]] call BIS_fnc_scaleAndTranslate;"]}],"see_also":["ctrlSetPosition","ctrlSetFade","ctrlCommit"]},{"name":"BIS_fnc_sceneAreaClearance","title":"BIS fnc sceneAreaClearance","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_sceneAreaClearance","revid":379317,"updated":"2026-10-30T23:50:26Z","groups":["Scenes"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Removes object clutter within a set trigger, for use within cutscenes.","syntaxes":[{"syntax":"[trigger, objects, destination] spawn BIS_fnc_sceneAreaClearance","params":[{"name":"trigger","type":"Object","description":"trigger to use as center point","type_expr":"Object"},{"name":"objects","type":"Array","optional":true,"default":"`[]`","description":"list of objects that will be kept during cutscene","type_expr":"Array","text":"objects: Array - (Optional, default `[]`) list of objects that will be kept during cutscene"},{"name":"destination","type":"Array in format Position","optional":true,"default":"[-5000, 10000, 0]","description":"where to move all unwanted objects","type_expr":"Position","types":["Array","Position"],"text":"destination: Array in format Position - (Optional, default [-5000, 10000, 0]) where to move all unwanted objects"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[triggerArea1] spawn BIS_fnc_sceneAreaClearance;"]}],"notes":[{"user":"Tryteyker-","date":"2014-10-02T16:29:00Z","text":"In regards to the 'safe position' where the objects get moved, this is how the function handles it (with default values present):\n\n```sqf\nprivate _savepos = [_unwantedObjectsTempPosition, 0, 100, 20, 0, 60 * (pi / 180), 0] call BIS_fnc_findSafePos;\nif ((_savepos distance (getArray (configFile >> \"CfgWorlds\" >> worldName >> \"centerPosition\"))) == 0) then\n{\n    _savepos = _unwantedObjectsTempPosition;\n};\n_x setPos _savepos;\n```"}]},{"name":"BIS_fnc_sceneCheckWeapons","title":"BIS fnc sceneCheckWeapons","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_sceneCheckWeapons","revid":347989,"updated":"2023-11-08T10:17:48Z","groups":["Scenes"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Checks if participants have not missing weapon or have not it selected before scene\nFunction works as a toggle:\n\n- 1st run of script: running in SETUP mode - sets correct weapons for scene\n- 2nd run of script: running in RESTORE mode - restore origin weapons(delete weapons after scene if character hadn't any)","syntaxes":[{"syntax":"[participants] call BIS_fnc_sceneCheckWeapons","params":[{"name":"participants","type":"Array of Arrays","optional":true,"default":"`[[BIS_Cooper, \"primary\"],[BIS_Ohara, \"primary\"],[BIS_Rodriguez, \"primary\"],[BIS_Sykes, \"primary\"],[BIS_Miles, \"primary\"]]`","description":"an array of arrays in format:\n0: Object - Unit to check\n1: String - Weapon type (primary, pistol)","type_expr":"Array<Array>","text":"participants: Array of Arrays - (Optional, default `[[BIS_Cooper, \"primary\"],[BIS_Ohara, \"primary\"],[BIS_Rodriguez, \"primary\"],[BIS_Sykes, \"primary\"],[BIS_Miles, \"primary\"]]`) an array of arrays in format:\n0: Object - Unit to check\n1: String - Weapon type (primary, pistol)"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"```sqf\n[\n    [BIS_Cooper, \"primary\"],\n    [BIS_Ohara, \"primary\"],\n    [BIS_Rodriguez, \"primary\"],\n    [BIS_Sykes, \"primary\"],\n    [BIS_Miles, \"primary\"]\n] call BIS_fnc_sceneCheckWeapons;\n```","code":["[\n\t[BIS_Cooper, \"primary\"],\n\t[BIS_Ohara, \"primary\"],\n\t[BIS_Rodriguez, \"primary\"],\n\t[BIS_Sykes, \"primary\"],\n\t[BIS_Miles, \"primary\"]\n] call BIS_fnc_sceneCheckWeapons;"]}],"see_also":["BIS_fnc_sceneSetObjects","BIS_fnc_objectsGrabber","BIS_fnc_objectsMapper"]},{"name":"BIS_fnc_sceneCreateSceneTrigger","title":"BIS fnc sceneCreateSceneTrigger","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_sceneCreateSceneTrigger","revid":328523,"updated":"2022-07-13T16:41:13Z","groups":["Scenes"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Create trigger for scene which can interrupt scene with name passed during creating the trigger. Scene name is saved in format **BIS_SceneIntDetector%1** where %1 is sceneName.","syntaxes":[{"syntax":"[sceneName, side, timeout, triggerSize, triggerPosition] call BIS_fnc_sceneCreateSceneTrigger","params":[{"name":"sceneName","type":"String","description":"name of scene to associate with","type_expr":"String"},{"name":"side","type":"Side","description":"for which side create trigger - which presence then interrupt the scene","type_expr":"Side"},{"name":"timeout","type":"Number","description":"timeout of interrupt","type_expr":"Number"},{"name":"triggerSize","type":"Number","description":"size of the trigger","type_expr":"Number"},{"name":"triggerPosition","type":"Array","description":"where to create the trigger","type_expr":"Array"},{"name":"deleteTrigger","type":"Boolean","description":"if true, trigger will be deleted","type_expr":"Boolean"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"BIS_scene\", west, 5, 500, [1337,1337,0], false] call BIS_fnc_sceneCreateSceneTrigger;"]}],"see_also":["BIS_fnc_sceneCreateSoundEntities","BIS_fnc_sceneRotate","BIS_fnc_sceneSetBehaviour","BIS_fnc_sceneGetObjects","BIS_fnc_sceneIntruderDetector"]},{"name":"BIS_fnc_sceneCreateSoundEntities","title":"BIS fnc sceneCreateSoundEntities","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_sceneCreateSoundEntities","revid":309748,"updated":"2022-05-05T12:09:48Z","groups":["Scenes"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"```\n/*******************************************************************************\n *    version:     1.0\n *    name:        create sound entities\n *    description:    creates sound entities(logic objects) and attaches to\n *            an objects passed as parameter\n *            After scene end it will detach and delete all created\n *            sound entities (if scene was executed from scenes\n *            controller.\n *\n *    paramater:    objects - ARRAY of OBJECTS in format without \"BIS_\"\n *            prefix. For example, if you have BIS_Cooper in mission\n *            than parameter will be [Cooper]. Then you can use\n *            created sound entities as BIS_ZvukCooper say \"something\"\n *\n *    return value:    nothing\n *\n```","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_sceneGetObjects","title":"BIS fnc sceneGetObjects","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_sceneGetObjects","revid":370889,"updated":"2025-02-21T10:44:04Z","groups":["Broken Functions","Scenes"],"status":"broken","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"> [!WARNING]\n> This function is broken (at least in Arma 3) as it has a typo, displaying an error on each use! (typo **line 63**, `[centrum]` instead of `[_centrum]`).\n\nThis function gets objects (but centre object) positions and direction relative to the choosen object and copies the result to the clipboard via copyToClipboard.\nResult is to format:\n\n```sqf\n[\n    // 11 elements for one object\n    _nameOfObject, _objectClass, _objectToGet, _computedAngle, _distance, _newDir, _vectorUp, _vectorDir, _animation, _elevASL, _elev,\n    _nameOfObject, _objectClass, _objectToGet, _computedAngle, _distance, _newDir, _vectorUp, _vectorDir, _animation, _elevASL, _elev,\n    // ...\n]\n```\n\n> [!IMPORTANT]\n> Please note that the clipboard result is a one-level array, meaning that all parameters are defined one after the other!","syntaxes":[{"syntax":"[centre, radius, type] call BIS_fnc_sceneGetObjects","params":[{"name":"centre","type":"Object or String","description":"object or marker name - **NOT** a Position","type_expr":"Object | String"},{"name":"radius","type":"Number","optional":true,"default":"20","type_expr":"Number","text":"radius: Number - (Optional, default 20)"},{"name":"type","type":"String","optional":true,"default":"\"All\"","description":"objects type (see nearestObjects)","type_expr":"String","text":"type: String - (Optional, default \"All\") - objects type (see nearestObjects)"}],"returns":{"type":"Script Handle","type_expr":"Script Handle"}}],"examples":[{"code":["[player, 20, \"Car\"] call BIS_fnc_sceneGetObjects;"]}],"see_also":["BIS_fnc_sceneSetObjects","BIS_fnc_objectsGrabber","BIS_fnc_objectsMapper"]},{"name":"BIS_fnc_sceneGetParticipants","title":"BIS fnc sceneGetParticipants","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_sceneGetParticipants","revid":328385,"updated":"2022-07-13T16:00:48Z","groups":["Scenes"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"gets members of unit's group who are in unit's range.","syntaxes":[{"syntax":"[unit, maxDistance] call BIS_fnc_sceneGetParticipants","params":[{"name":"unit","type":"Object","description":"if nil is passed, player is used - nil must then **not** be used on a dedicated server","type_expr":"Object"},{"name":"maxDistance","type":"Number","description":"if nil is passed, 30 is used.","type_expr":"Number"}],"returns":{"type":"Array of units in unit's group within maxDistance from unit","type_expr":"Array","text":"Array of units in *unit'*s group within *maxDistance* from *unit*"}}],"examples":[{"code":["[player, 20] call BIS_fnc_sceneGetParticipants;"]}]},{"name":"BIS_fnc_sceneGetPositionByAngle","title":"BIS fnc sceneGetPositionByAngle","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_sceneGetPositionByAngle","revid":309729,"updated":"2022-05-05T12:09:47Z","groups":["Scenes"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"```\n/*******************************************************************************\n *\n *    version:     1.0\n *    name:        sceneGetPositionByAngle\n *    description:    returns new calculated position of object from angle and distance from specified object\n *    parameters:    described below\n *    return value:    array of new coordinates [x, y]\n *\n```","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_sceneIntruderDetector","title":"BIS fnc sceneIntruderDetector","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_sceneIntruderDetector","revid":348144,"updated":"2023-11-08T11:32:40Z","groups":["Scenes"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Checks if there are intruders during scene. All intruders during scene will be disabled if they\n\n```\n  will get into the detector trigger. Checking is deactivated by passing\n```\n\n```sqf\nBIS_sceneIntruderDetectorLogic setVariable [\"_detectInProgress\", false];\n```","syntaxes":[{"syntax":"[sceneCenter, triggerSize] call BIS_fnc_sceneIntruderDetector","params":[{"name":"sceneCenter","type":"Array","optional":true,"default":"position player","description":"center position of scene","type_expr":"Array","text":"sceneCenter: Array - (Optional, default position player) center position of scene"},{"name":"triggerSize","type":"Array","optional":true,"default":"[60,60]","description":"trigger size as array in format:\n0: Number - Size A\n1: Number - Size B","type_expr":"Array","text":"triggerSize: Array - (Optional, default [60,60]) trigger size as array in format:\n0: Number - Size A\n1: Number - Size B"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[[1337,1337,0],[42,42]] call BIS_fnc_sceneCreateSceneTrigger;"]}],"see_also":["BIS_fnc_sceneCreateSoundEntities","BIS_fnc_sceneRotate","BIS_fnc_sceneSetBehaviour","BIS_fnc_sceneGetObjects"]},{"name":"BIS_fnc_sceneMiscStuff","title":"BIS fnc sceneMiscStuff","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_sceneMiscStuff","revid":379572,"updated":"2026-10-31T14:00:56Z","groups":["Scenes"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","exec":"spawn","description":"Prepares the player's surroundings for a scripted scene (cutscene) and restores them afterwards. The function:\n\n1. fades out the music, clears the radio, disables sentences and waits until the camera at the player's position is preloaded (at most 6 seconds)\n1. creates the game logic `BIS_sceneLogic` (broadcast with publicVariable) through which the scene is controlled\n1. fades the screen to black (unless *skipInitBlackout*) and shows a loading screen (unless *skipLoadingScreen*)\n1. hides the watch, compass, GPS and HUD, keeps the time acceleration at 1 and forces the player's first person view during the whole scene\n1. waits for the scene script to set `BIS_sceneLogic`'s variable \"_doTheBlackIN\" to true, then closes the loading screen, fades in and starts BIS_fnc_sceneIntruderDetector (around the player)\n1. waits for the scene script to set `BIS_sceneLogic`'s variable \"_doTheEndOfScene\" to true, then stops the intruder detection\n1. unless *skipFinalBlackout*, fades to black, sets \"_endDone\" to true, shows a loading screen and waits for \"_doTheBlackIN\" to be true again\n1. restores the HUD elements and time acceleration, fades in (unless *skipFinalBlackout*) and deletes `BIS_sceneLogic`\n\nThe function itself returns after the initial fade out; the rest runs in a spawned script.\n\nIf `BIS_debugScene` is true, no blackouts are done and a manual camera is created at *cameraPositions* instead.\n\n> [!IMPORTANT]\n> - The function uses `RE` with `rFADEMUSIC` and `rTITLECUT` from the Multiplayer Framework, which must be initialised.\n> - The global variable `BIS_debugScene` is read without a default value and must be defined as a Boolean.\n> - No other function or script in Arma 3's functions library calls this function.","syntaxes":[{"syntax":"[cameraPositions, skipInitBlackout, skipFinalBlackout, skipWeaponCheck, skipLoadingScreen, excludedObjects] spawn BIS_fnc_sceneMiscStuff","params":[{"name":"cameraPositions","type":"Array","optional":true,"description":"format [cameraTarget, cameraPosition], both Positions; only used when `BIS_debugScene` is true","type_expr":"Array","text":"cameraPositions: Array - (Optional) format [cameraTarget, cameraPosition], both Positions; only used when `BIS_debugScene` is true"},{"name":"skipInitBlackout","type":"Boolean","optional":true,"default":"false","description":"true to skip the initial fade out","type_expr":"Boolean","text":"skipInitBlackout: Boolean - (Optional, default false) true to skip the initial fade out"},{"name":"skipFinalBlackout","type":"Boolean","optional":true,"default":"false","description":"true to skip the fade out and fade in at the end of the scene","type_expr":"Boolean","text":"skipFinalBlackout: Boolean - (Optional, default false) true to skip the fade out and fade in at the end of the scene"},{"name":"skipWeaponCheck","type":"Boolean","optional":true,"default":"false","description":"stored on `BIS_sceneLogic` as \"_noUseCheckTheWeapons\"; it has no effect, as the weapon check code is commented out. It is forced to true if the player's group has fewer than 4 units","type_expr":"Boolean","text":"skipWeaponCheck: Boolean - (Optional, default false) stored on `BIS_sceneLogic` as \"_noUseCheckTheWeapons\"; it has no effect, as the weapon check code is commented out. It is forced to true if the player's group has fewer than 4 units"},{"name":"skipLoadingScreen","type":"Boolean","optional":true,"default":"false","description":"true to not show a loading screen during the blackouts","type_expr":"Boolean","text":"skipLoadingScreen: Boolean - (Optional, default false) true to not show a loading screen during the blackouts"},{"name":"excludedObjects","type":"Array of Objects","optional":true,"default":"[]","description":"objects ignored by BIS_fnc_sceneIntruderDetector","type_expr":"Array<Object>","text":"excludedObjects: Array of Objects - (Optional, default []) objects ignored by BIS_fnc_sceneIntruderDetector"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["BIS_debugScene = false;\n[[getPosATL sceneTarget, getPosATL sceneCamera], false, true] spawn BIS_fnc_sceneMiscStuff;\nwaitUntil { !isNil \"BIS_sceneLogic\" };\n\n// ... set up the scene while the screen is black ...\nBIS_sceneLogic setVariable [\"_doTheBlackIN\", true];\n\n// ... the scene plays ...\nBIS_sceneLogic setVariable [\"_doTheEndOfScene\", true];"]}],"see_also":["BIS_fnc_sceneIntruderDetector","BIS_fnc_sceneCheckWeapons"]},{"name":"BIS_fnc_sceneRotate","title":"BIS fnc sceneRotate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_sceneRotate","revid":348200,"updated":"2023-11-08T11:40:10Z","groups":["Scenes"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Compute new object coordinates from given center and angle from MOTION BUILDER","syntaxes":[{"syntax":"[center, centerAngle, angle, iniPosition] call BIS_fnc_sceneRotate","params":[{"name":"center","type":"Array","description":"center position from MOTION BUILDER","type_expr":"Array"},{"name":"centerAngle","type":"Number","description":"rotation of center from MOTION BUILDER","type_expr":"Number"},{"name":"angle","type":"Number","description":"rotation","type_expr":"Number"},{"name":"iniPosition","type":"Array","description":"inital position","type_expr":"Array"}],"returns":{"type":"Array","type_expr":"Array","description":"array in format [[PositionX,PositionY,PositionZ], Rotation]"}}],"examples":[{"code":["[[1337,1337,0], 42, 120, [200,200,0]] call BIS_fnc_sceneRotate; // returns [[1337.15,1334.18,0],-258]"]}],"see_also":["BIS_fnc_sceneCreateSoundEntities","BIS_fnc_sceneSetBehaviour","BIS_fnc_sceneGetObjects"]},{"name":"BIS_fnc_sceneSetAnimationsForGroup","title":"BIS fnc sceneSetAnimationsForGroup","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_sceneSetAnimationsForGroup","revid":378968,"updated":"2026-09-10T15:09:13Z","groups":["Scenes"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Plays a range of animations for a specific set of units, intended for use during cutscenes.","syntaxes":[{"syntax":"param call BIS_fnc_sceneSetAnimationsForGroup","params":[{"name":"Array","description":"units that should play animations","type_expr":"Array"},{"name":"Array of String","description":"array of animation names to play","type_expr":"Array<String>"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"returns true if all animations started."}}],"examples":[{"code":["_setAnims = [group player, [\"AmovPercMstpSrasWrflDnon\"]] call BIS_fnc_sceneSetAnimationsForGroup;"]}]},{"name":"BIS_fnc_sceneSetBehaviour","title":"BIS fnc sceneSetBehaviour","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_sceneSetBehaviour","revid":349150,"updated":"2023-11-08T14:49:48Z","groups":["Scenes"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Enables / disables a specific set of AI units, usable for cutscenes.","syntaxes":[{"syntax":"param call BIS_fnc_sceneSetBehaviour","params":[{"name":"String","description":"string to toggle AI (\"enableAI\",\"disableAI\")","type_expr":"String"},{"name":"Array","description":"AI units that should be affected by function.","type_expr":"Array"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"disableAI\", [unit1, player, unit2, unit3]] call BIS_fnc_sceneSetBehaviour;"]}],"see_also":["disableAI","enableAI","enableSimulation"]},{"name":"BIS_fnc_sceneSetObjects","title":"BIS fnc sceneSetObjects","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_sceneSetObjects","revid":324235,"updated":"2022-07-01T12:00:40Z","groups":["Broken Functions","Scenes"],"status":"broken","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"This function sets objects positions and direction relative to the chosen object.\n\n> [!WARNING]\n> Same as its GET counterpart (at least in Arma 3), this function does not work as intended as it does not set objects' direction properly. All objects will be created with a zero azimuth.","syntaxes":[{"syntax":"[centre, objectsArray, applyOffset, stopped] call BIS_fnc_sceneSetObjects","params":[{"name":"centre","type":"Object or String","description":"object or marker name - **NOT** a Position","type_expr":"Object | String"},{"name":"objectsArray","type":"Array","description":"see BIS_fnc_sceneGetObjects for format information","type_expr":"Array"},{"name":"applyOffset","type":"Boolean","description":"true to apply height offset","type_expr":"Boolean"},{"name":"stopped","type":"Anything","description":"if provided and if `BIS_debugModules` is defined, units will be stopped","type_expr":"Anything"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[player, _arrayOfObjects, false] call BIS_fnc_sceneSetObjects;"]}],"see_also":["BIS_fnc_sceneGetObjects","BIS_fnc_objectsGrabber","BIS_fnc_objectsMapper"]},{"name":"BIS_fnc_sceneSetPosFormation","title":"BIS fnc sceneSetPosFormation","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_sceneSetPosFormation","revid":348694,"updated":"2023-11-08T14:29:24Z","groups":["Scenes"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","exec":"spawn","description":"Adjusts units into a pre-determined formation, using a few variables. Part of S.C.E.N.E.S function group.","syntaxes":[{"syntax":"param spawn BIS_fnc_sceneSetPosFormation","params":[{"name":"Array","description":"array of units involved","type_expr":"Array"},{"name":"Object","description":"scene initiator","type_expr":"Object"},{"name":"Object","description":"talking partner of scene initiator","type_expr":"Object"},{"name":"String","description":"formation in which to place units. Possible values: \"LINE\", \"CIRCLE\", \"HALFCIRCLE","type_expr":"String"},{"name":"Number","description":"true / false in format Number (0 = false, 1 = true), determines debug mode (showing markers).","type_expr":"Number"},{"name":"Number","optional":true,"default":"0","description":"determines angle offset","type_expr":"Number","text":"Number - (Optional, default 0) - determines angle offset"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[units group player, bluforCommander, player, \"HALFCIRCLE\", 0] spawn BIS_fnc_sceneSetPosFormation;"]}]},{"name":"BIS_fnc_scriptedMove","title":"BIS fnc scriptedMove","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_scriptedMove","revid":347664,"updated":"2023-10-08T19:35:39Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"2.10"},"since":"arma3 2.10","arma3_since":"2.10","locality":{"argument":"global","effect":"global"},"description":"Forces a unit to turn towards and walk to provided destination(s). Will not work on player. When Group is used as argument, the function will be automatically executed for each unit in the group.\n\n> [!NOTE]\n> When using *endAnim*, make sure it is able to break *walkAnim* (not all animations are compatible). When code is executed, it receives the following params: [unit, waypoints, currentIndex, userArgs].","syntaxes":[{"syntax":"[unitOrGroup, waypoints, code, walkAnim, completionRadius, endAnim] call BIS_fnc_scriptedMove","params":[{"name":"unitOrGroup","type":"Object or Group","description":"unit or group of units of the class \"Man\"","type_expr":"Object | Group"},{"name":"waypoints","type":"Array of Positions in format [pos1, pos2, ...] or [[pos1, completionRadius1, turnSpeedCoef1], [pos2, completionRadius2, turnSpeedCoef2], ...]","type_expr":"Array<Position>"},{"name":"code","type":"Code or Array","optional":true,"default":"`{}`","description":"code to run after each waypoint completion. Format {code} or [[params], {code}]","type_expr":"Code | Array","text":"code: Code or Array - (Optional, default `{}`) code to run after each waypoint completion. Format {code} or [[params], {code}]"},{"name":"walkAnim","type":"String","optional":true,"default":"\"AmovPercMwlkSnonWnonDf\"","description":"walking animation to be played in a loop","type_expr":"String","text":"walkAnim: String - (Optional, default \"AmovPercMwlkSnonWnonDf\") walking animation to be played in a loop"},{"name":"completionRadius","type":"Number","optional":true,"default":"0.5","description":"how far from waypoint center to consider waypoint completion. Global value. The completionRadius given with individual waypoint position overrides global value","type_expr":"Number","text":"completionRadius: Number - (Optional, default 0.5) how far from waypoint center to consider waypoint completion. Global value. The completionRadius given with individual waypoint position overrides global value"},{"name":"turnSpeedCoef","type":"Number","optional":true,"default":"1.0","description":"how quickly the unit turns towards next waypoint (fast 0.1 ... 10 slow). The turnSpeedCoef given with individual waypoint position overrides global value","type_expr":"Number","text":"turnSpeedCoef: Number - (Optional, default 1.0) how quickly the unit turns towards next waypoint (fast 0.1 ... 10 slow). The turnSpeedCoef given with individual waypoint position overrides global value"},{"name":"endAnim","type":"Number","optional":true,"default":"animationState of the unit prior to function execution","description":"when unit reaches last point, this is the animation to be played immediately. Use \"\" to let last walkAnim run in full","type_expr":"Number","text":"endAnim: Number - (Optional, default animationState of the unit prior to function execution) when unit reaches last point, this is the animation to be played immediately. Use \"\" to let last walkAnim run in full"}],"returns":{"type":"Script Handle or String or Nothing","type_expr":"Script Handle | String | Nothing","description":"depends on execution (local/remote/error);"}}],"examples":[{"code":["[myUnit, [getMarkerPos \"wp1\", getMarkerPos \"wp2\", getMarkerPos \"wp3\"]] call BIS_fnc_scriptedMove;"]}],"see_also":["move","setDriveOnPath","BIS_fnc_unitCapture"]},{"name":"BIS_fnc_scriptedWaypointType","title":"BIS fnc scriptedWaypointType","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_scriptedWaypointType","revid":349365,"updated":"2023-11-08T15:35:11Z","groups":["Waypoints"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Return CfgWaypoints type of scripted waypoint.\nReturns empty string/config when waypoint is not scripted\nReturns \"Custom\"/CfgWaypoints root when waypoint is using custom script.","syntaxes":[{"syntax":"[waypoint,type] call BIS_fnc_scriptedWaypointType","params":[{"name":"waypoint","type":"Array","description":"waypoint in question","type_expr":"Array"},{"name":"type","type":"String or Config","optional":true,"default":"configFile","description":"type of returned value, can by any string and any config","type_expr":"String | Config","text":"type: String or Config - (Optional, default configFile) type of returned value, can by any string and any config"}],"returns":{"type":"String or Config","type_expr":"String | Config","description":"string in format (\"category/class\") or config in format (CfgWaypoints path)"}}],"examples":[{"code":["[BIS_scripted_WP_01,\"returnString\"] call BIS_fnc_scriptedWaypointType;"]}],"see_also":["Waypoints","Custom Waypoints"]},{"name":"BIS_fnc_secondsToString","title":"BIS fnc secondsToString","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_secondsToString","revid":328375,"updated":"2022-07-13T16:00:48Z","groups":["Strings"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Convert seconds to formatted string.","syntaxes":[{"syntax":"[totalSeconds, format, returnArray] call BIS_fnc_secondsToString","params":[{"name":"totalSeconds","type":"Number","description":"time in seconds (see time)","type_expr":"Number"},{"name":"format","type":"String","optional":true,"default":"\"HH:MM:SS\"","description":"can be one of:\n\n- \"HH\"\n- \"HH:MM\"\n- \"HH:MM:SS\"\n- \"HH:MM:SS.MS\"\n- \"MM\"\n- \"MM:SS\"\n- \"MM:SS.MS\"\n- \"SS.MS\"\n\n*HH = Hours, MM = Minutes, SS = Seconds, MS = Milliseconds*","type_expr":"String","text":"format: String - (Optional, default \"HH:MM:SS\") can be one of:\n\n- \"HH\"\n- \"HH:MM\"\n- \"HH:MM:SS\"\n- \"HH:MM:SS.MS\"\n- \"MM\"\n- \"MM:SS\"\n- \"MM:SS.MS\"\n- \"SS.MS\"\n\n*HH = Hours, MM = Minutes, SS = Seconds, MS = Milliseconds*"},{"name":"returnArray","type":"Boolean","optional":true,"default":"false","type_expr":"Boolean","text":"returnArray: Boolean - (Optional, default false)"}],"returns":{"type":"String or Array of Strings","type_expr":"String | Array<String>","description":"if returnArray is set to true","text":"String or Array of Strings if *returnArray* is set to true"}}],"examples":[{"code":["hint format [\"Hi, it is currently %1.\", [time, \"HH:MM\"] call BIS_fnc_secondsToString];"]}],"see_also":["time","BIS_fnc_showTime","BIS_fnc_timeToString"]},{"name":"BIS_fnc_selectCrew","title":"BIS fnc selectCrew","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_selectCrew","revid":328398,"updated":"2022-07-13T16:00:49Z","groups":["Object Manipulation"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Return an appropriate crew type for a certain vehicle.\n\n> [!IMPORTANT]\n> This function should work properly in Arma 3, but be aware that if \"crew\" config entry is not defined in vehicle config then specific Arma 2 class names will be used as default values (*\"USMC_Soldier_Crew\"*, *\"US_Soldier_Crew_EP1\"*, *\"RU_Soldier_Crew\"*, *\"TK_Soldier_Crew_EP1\"*)","syntaxes":[{"syntax":"[side, configEntry] call BIS_fnc_selectCrew","params":[{"name":"side","type":"Side","description":"only supports west (blufor) and east (opfor) for default value (if \"crew\" entry is not found)","type_expr":"Side"},{"name":"configEntry","type":"Config","description":"the vehicle config path","type_expr":"Config"}],"returns":{"type":"String","type_expr":"String","description":"crew type, empty if crew type not found"}}],"examples":[{"code":["private _crewType = [blufor, configFile >> \"CfgVehicles\" >> \"B_MRAP_01_F\"] call BIS_fnc_selectCrew;"]}],"see_also":["crew","createVehicleCrew"]},{"name":"BIS_fnc_selectDiarySubject","title":"BIS fnc selectDiarySubject","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_selectDiarySubject","revid":348504,"updated":"2023-11-08T13:01:33Z","groups":["Briefing"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Selects a diary subject.\n\n> [!NOTE]\n> This was a temporary replacement for selectDiarySubject scripting command which **had been broken** until v2.04.","syntaxes":[{"syntax":"[diaryName] call BIS_fnc_selectDiarySubject","params":[{"name":"diaryName","type":"String","description":"diary subject name","type_expr":"String"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if the subject was found and selected"}}],"examples":[{"code":["[\"someSubject\"] call BIS_fnc_selectDiarySubject;"]}],"see_also":["processDiaryLink","createDiaryLink","createDiarySubject","diarySubjectExists","selectDiarySubject"]},{"name":"BIS_fnc_selectRandom","title":"BIS fnc selectRandom","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_selectRandom","revid":348921,"updated":"2023-11-08T14:44:05Z","groups":["Arrays"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","locality":{"effect":"local"},"description":"Selects one of the arguments at random.\n\n> [!NOTE]\n> **Arma 3:** Use selectRandom instead.","syntaxes":[{"syntax":"values call BIS_fnc_selectRandom","params":[{"name":"values","type":"Array","description":"array of values of which one will be selected at random","type_expr":"Array"}],"returns":{"type":"Anything","type_expr":"Anything","description":"one of the values you passed, chosen at random"}}],"examples":[{"code":["private _bestShooter = [_rento, _ben, _trit] call BIS_fnc_selectRandom; // returns one of the variables\n_bestSeries = [[\"halo1\",\"halo2\"],[\"ofp\",\"arma2\"]] call BIS_fnc_selectRandom; // returns one of the arrays"]}],"see_also":["selectRandom"]},{"name":"BIS_fnc_selectRandomWeighted","title":"BIS fnc selectRandomWeighted","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_selectRandomWeighted","revid":327996,"updated":"2022-07-13T15:41:47Z","groups":["Arrays"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Selects a random item from an array, taking into account item weight.\n\n> [!NOTE]\n> - The weights do not have to total to 1\n> - The length of weights and items arrays may not match, in which case the shortest array is used for length\n\n> [!NOTE]\n> **Arma 3:** See selectRandomWeighted for an engine solution.","syntaxes":[{"syntax":"itemsAndWeights call BIS_fnc_selectRandomWeighted","params":[{"name":"itemsAndWeights","type":"Array","description":"array of items and weights [item, weight, item, weight...]","type_expr":"Array"}],"returns":{"type":"Anything","type_expr":"Anything"}},{"syntax":"[items, weights] call BIS_fnc_selectRandomWeighted","params":[{"name":"items","type":"Array","description":"items array of Anything","type_expr":"Array"},{"name":"weights","type":"Array","description":"weights array of Numbers","type_expr":"Array"}],"returns":{"type":"Anything","type_expr":"Anything"}}],"examples":[{"code":["[\"apples\",.3,\"pears\",.2,\"bananas\",.4,\"diamonds\",.1,\"unicorns\",.00001] call BIS_fnc_selectRandomWeighted;"]},{"code":["[[\"apples\",\"pears\",\"bananas\",\"diamonds\"], [0.3,0.2,0.4,0.1]] call BIS_fnc_selectRandomWeighted;"]}],"see_also":["selectRandomWeighted"]},{"name":"BIS_fnc_selectRespawnTemplate","title":"BIS fnc selectRespawnTemplate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_selectRespawnTemplate","revid":336927,"updated":"2023-01-04T16:44:02Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Select respawn template from CfgRespawnTemplates and execute its script / function. Internal use.","syntaxes":[{"syntax":"[mode, arguments] call BIS_fnc_selectRespawnTemplate","params":[{"name":"mode","type":"String","description":"**case-sensitive**, can be one of:\n\n- \"playerKilledScript\"\n- \"playerRespawnScript\"\n- \"playerRespawnSeagullScript\"\n- \"playerResurrectScript\"\n- \"playerRespawnOtherUnitScript\"\n- \"initRespawn\"\n- \"initRespawnStart\"\n- \"initRespawnEnd\"","type_expr":"String"},{"name":"arguments","type":"Array","type_expr":"Array"}],"returns":{"type":"Array of Script Handles","type_expr":"Array<Script Handle>"}}],"examples":[{"code":["[\"playerKilledScript\", []] call BIS_fnc_selectRespawnTemplate;"]}]},{"name":"BIS_fnc_setCuratorAttributes","title":"BIS fnc setCuratorAttributes","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_setCuratorAttributes","revid":309855,"updated":"2022-05-05T12:09:52Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Set which attributes are available for given entity  or entity type.","syntaxes":[{"syntax":"[param0, param1, param2] call BIS_fnc_setCuratorAttributes","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"curator","text":"0: OBJECT - curator","source":"docblock"},{"name":"param1","type":"String, Object, Group","type_expr":"String | Object | Group","description":"STRING - general setting for all entities of the given type, can be  \"object\", \"player\", \"group', \"waypoint\" or \"marker\"\nOBJECT - setting for specific object, overrides general settings\nGROUP - setting for specific group, overrides general settings","text":"1: STRING - general setting for all entities of the given type, can be  \"object\", \"player\", \"group', \"waypoint\" or \"marker\"\nOBJECT - setting for specific object, overrides general settings\nGROUP - setting for specific group, overrides general settings","source":"docblock"},{"name":"param2","type":"Array, String","type_expr":"Array<String>","description":"attributes\nobject:\n    Skill\n    UnitPos\n    Rank\n    Damage\n    Fuel\n    Lock\n    RespawnVehicle\n    RespawnPosition\n    Exec\ngroup:\n    GroupID\n    Behaviour\n    Formation\nwaypoint:\n    Behaviour\n    Formation\nmarker:\n    MarkerText\n    MarkerColor","text":"2: ARRAY of STRINGs - attributes\nobject:\n    Skill\n    UnitPos\n    Rank\n    Damage\n    Fuel\n    Lock\n    RespawnVehicle\n    RespawnPosition\n    Exec\ngroup:\n    GroupID\n    Behaviour\n    Formation\nwaypoint:\n    Behaviour\n    Formation\nmarker:\n    MarkerText\n    MarkerColor","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","text":"BOOL","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nSet which attributes are available for given entity  or entity type.\n\nParameter(s):\n    0: OBJECT - curator\n    1:\n        STRING - general setting for all entities of the given type, can be  \"object\", \"player\", \"group', \"waypoint\" or \"marker\"\n        OBJECT - setting for specific object, overrides general settings\n        GROUP - setting for specific group, overrides general settings\n    2: ARRAY of STRINGs - attributes\n        object:\n            Skill\n            UnitPos\n            Rank\n            Damage\n            Fuel\n            Lock\n            RespawnVehicle\n            RespawnPosition\n            Exec\n        group:\n            GroupID\n            Behaviour\n            Formation\n        waypoint:\n            Behaviour\n            Formation\n        marker:\n            MarkerText\n            MarkerColor\n\nReturns:\nBOOL"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_setCuratorCamera","title":"BIS fnc setCuratorCamera","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_setCuratorCamera","revid":348106,"updated":"2023-11-08T11:31:58Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","exec":"spawn","description":"Move curator camera to a position and direction. Finished when animation ends.","syntaxes":[{"syntax":"[camPos, targetPos, time] spawn BIS_fnc_setCuratorCamera","params":[{"name":"camPos","type":"Position","optional":true,"default":"getPosATL curatorCamera","description":"position, for supported types see BIS_fnc_position","type_expr":"Position","text":"camPos: Position - (Optional, default getPosATL curatorCamera) position, for supported types see BIS_fnc_position"},{"name":"targetPos","type":"Array format Vector3D, Position or Object","optional":true,"default":"vectorDir curatorCamera","description":"vector dir or target object/position","type_expr":"Vector3D | Position | Object","types":["Array","Vector3D","Position","Object"],"text":"targetPos: Array format Vector3D, Position or Object - (Optional, default vectorDir curatorCamera) vector dir or target object/position"},{"name":"time","type":"Number or Boolean","optional":true,"default":"0","description":"commit time or true to calculate time automatically","type_expr":"Number | Boolean","text":"time: Number or Boolean - (Optional, default 0) commit time or true to calculate time automatically"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when done","text":"Boolean true when done"}}],"examples":[{"code":["[nil, player, 5] spawn BIS_fnc_setCuratorCamera;"]}],"see_also":["Arma 3: Curator","curatorCamera"]},{"name":"BIS_fnc_setCuratorVisionModes","title":"BIS fnc setCuratorVisionModes","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_setCuratorVisionModes","revid":378130,"updated":"2026-02-22T20:24:30Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Set which vision modes curator can access.","syntaxes":[{"syntax":"[curator, mode] call BIS_fnc_setCuratorVisionModes","params":[{"name":"curator","type":"Object","type_expr":"Object"},{"name":"mode","type":"Array of Numbers","description":"vision modes, can be:\n\n- -2 - Night vision mode\n- -1 - Normal mode\n- 0, 1, ... - Thermal vision mode - see setCamUseTi for detailed information","type_expr":"Array<Number>"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[BIS_curator, [-1, -2]] call BIS_fnc_setCuratorVisionModes;"]}],"see_also":["Arma 3: Curator","curatorCamera","setCamUseTi"]},{"name":"BIS_fnc_setCustomSoundController","title":"BIS fnc setCustomSoundController","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_setCustomSoundController","revid":281410,"updated":"2021-06-14T09:12:46Z","groups":["Sound","Contact"],"status":"ok","games":{"arma3":"1.96"},"since":"arma3 1.96","arma3_since":"1.96","description":"","syntaxes":[{"syntax":"call BIS_fnc_setCustomSoundController","params":[],"returns":null}],"docblock":{"text":"BIS_fnc_setCustomSoundController\n\na: reyhard"}},{"name":"BIS_fnc_setDate","title":"BIS fnc setDate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_setDate","revid":341320,"updated":"2023-05-21T15:53:15Z","groups":["Environment"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Instantly set date and share it across network with optional transition effect.","syntaxes":[{"syntax":"[value, global, transition] call BIS_fnc_setDate","params":[{"name":"value","type":"Number or Array in format Date","description":"Number or Array in format Date\n\n- Number - hours to skip. To show exactly *30 minutes later* put `30 / 60`; `0.5` will show `29 minutes later`\n- Array in format Date - date","type_expr":"Number | Date","types":["Number","Array","Date"],"text":"value: Number or Array in format Date\n\n- Number - hours to skip. To show exactly *30 minutes later* put `30 / 60`; `0.5` will show `29 minutes later`\n- Array in format Date - date"},{"name":"global","type":"Boolean","optional":true,"default":"true","description":"true for global execution","type_expr":"Boolean","text":"global: Boolean - (Optional, default true) true for global execution"},{"name":"transition","type":"Boolean","optional":true,"default":"false","description":"true to show a transition effect instead of an immediate skip","type_expr":"Boolean","text":"transition: Boolean (Optional, default false) true to show a transition effect instead of an immediate skip"}],"returns":{"type":"Date","type_expr":"Date","description":"the new date"}}],"examples":[{"code":["[[2035, 12, 31, 23, 59], true, true] call BIS_fnc_setDate;"]},{"code":["[4, true, true] call BIS_fnc_setDate; // skip 4 hours. Same as image in description"]},{"code":["[30 / 60, true, true] call BIS_fnc_setDate; // skip 30 minutes and show a \"30 minutes later\" message"]}],"see_also":["date","setDate","skipTime"]},{"name":"BIS_fnc_setFog","title":"BIS fnc setFog","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_setFog","revid":336201,"updated":"2022-12-14T14:12:44Z","groups":["Environment"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"server_exec":true},"description":"Instantly set weather conditions and share it across network.","syntaxes":[{"syntax":"[strength, density, altitude] call BIS_fnc_setFog","params":[{"name":"strength","type":"Number","description":"fog strength from 0 to 1","type_expr":"Number"},{"name":"density","type":"Number","description":"fog density from 0 to 1","type_expr":"Number"},{"name":"altitude","type":"Number","description":"fog base altitude in metres.","type_expr":"Number"}],"returns":{"type":"Array","type_expr":"Array","description":"array with set values"}}],"examples":[{"code":["[1,1,100] call BIS_fnc_setFog; // returns [1,1,100]"]}],"see_also":["setFog","fog"]},{"name":"BIS_fnc_setHeight","title":"BIS fnc setHeight","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_setHeight","revid":349594,"updated":"2023-11-13T22:41:43Z","groups":["Object Manipulation"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Set an object's altitude.","syntaxes":[{"syntax":"[target, height, position, mode] call BIS_fnc_setHeight","params":[{"name":"target","type":"Object","description":"affected object","type_expr":"Object"},{"name":"height","type":"Number","optional":true,"default":"0","description":"height to set","type_expr":"Number","text":"height: Number - (Optional, default 0) height to set"},{"name":"position","type":"Position","optional":true,"default":"`position target`","description":"position to place the target with calculated height","type_expr":"Position","text":"position: Position - (Optional, default `position target`) position to place the target with calculated height"},{"name":"mode","type":"String","optional":true,"default":"\"ROADWAY\"","description":"can be:\n\n- \"ROADWAY\": uses setPos\n- \"ASL\": uses setPosASL\n- \"ATL\": uses setPosATL","type_expr":"String","text":"mode: String - (Optional, default \"ROADWAY\") can be:\n\n- \"ROADWAY\": uses setPos\n- \"ASL\": uses setPosASL\n- \"ATL\": uses setPosATL"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when done"}},{"syntax":"[height, mode] call BIS_fnc_setHeight","note":"> [!IMPORTANT]\n> This syntax uses `this` and is therefore meant to be used in init fields. Not to be used in MP.","params":[{"name":"height","type":"Number","optional":true,"default":"0","description":"height to set","type_expr":"Number","text":"height: Number - (Optional, default 0) height to set"},{"name":"mode","type":"String","optional":true,"default":"\"ROADWAY\"","description":"can be:\n\n- \"ROADWAY\": uses setPos\n- \"ASL\": uses setPosASL\n- \"ATL\": uses setPosATL","type_expr":"String","text":"mode: String - (Optional, default \"ROADWAY\") can be:\n\n- \"ROADWAY\": uses setPos\n- \"ASL\": uses setPosASL\n- \"ATL\": uses setPosATL"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when done"}}],"examples":[{"code":["// will place player's vehicle on \"myHeightMarker\", 50m above terrain\n[vehicle player, 50, getMarkerPos \"myHeightMarker\", \"ATL\"] call BIS_fnc_setHeight;"]},{"code":["// will set the \"this\" object 50m above sea level at its position\n// use where \"this\" has a value like in an init field\n[50, \"ASL\"] call BIS_fnc_setHeight;"]}],"see_also":["setPos","setPosASL","setPosATL"]},{"name":"BIS_fnc_setHitPointDamage","title":"BIS fnc setHitPointDamage","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_setHitPointDamage","revid":329658,"updated":"2022-08-01T00:59:26Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.68"},"since":"arma3 1.68","arma3_since":"1.68","description":"Sets damage to HitPoint with dependency or not.","syntaxes":[{"syntax":"[object, hitPoint, damage, useDependency] call BIS_fnc_setHitPointDamage","params":[{"name":"object","type":"Object","description":"entity to which damage applies","type_expr":"Object"},{"name":"hitPoint","type":"String","description":"hitPoint to which damage applies","type_expr":"String"},{"name":"damage","type":"Number","description":"amount of damage to apply","type_expr":"Number"},{"name":"useDependency","type":"Boolean","optional":true,"default":"true","description":"true - distribute damage to dependent HitPoints as well\n- false - apply damage to given HitPoint only","type_expr":"Boolean","text":"useDependency: Boolean - (Optional, default true)\n\n- true - distribute damage to dependent HitPoints as well\n- false - apply damage to given HitPoint only"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[player, \"HitFace\", 0.9] call BIS_fnc_setHitPointDamage;"]}],"see_also":["setHitPointDamage"]},{"name":"BIS_fnc_setIDCStreamFriendly","title":"BIS fnc setIDCStreamFriendly","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_setIDCStreamFriendly","revid":349413,"updated":"2023-11-08T16:27:27Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Shows or hides UI control according to state of the Stream Friendly UI switch in Game Options.","syntaxes":[{"syntax":"[target,IDC] call BIS_fnc_setIDCStreamFriendly","params":[{"name":"target","type":"Display or Control","type_expr":"Display | Control"},{"name":"IDC","type":"Number","optional":true,"default":"-1","description":"control IDC when the first parameter is a display","type_expr":"Number","text":"IDC: Number - (Optional, default -1) control IDC when the first parameter is a display"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when visible, false when hidden"}}],"examples":[{"code":["[(findDisplay 1337) displayCtrl 42] call BIS_fnc_setIDCStreamFriendly;"]},{"code":["[findDisplay 1337, 42] call BIS_fnc_setIDCStreamFriendly;"]}],"see_also":["findDisplay","displayCtrl"]},{"name":"BIS_fnc_setIdentity","title":"BIS fnc setIdentity","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_setIdentity","revid":373727,"updated":"2025-06-23T13:18:19Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"global","effect":"global"},"description":"Sets the unit's identity.\n\n> [!NOTE]\n> - When executed on server, the identity will be JIP compatible.\n> - Before Arma 3 v1.92, this function was Server execution.","syntaxes":[{"syntax":"[object, face, speaker, pitch, callsign, name, glasses] call BIS_fnc_setIdentity","params":[{"name":"object","type":"Object","type_expr":"Object"},{"name":"face","type":"String","optional":true,"default":"\"\"","description":"face from CfgFaces","type_expr":"String","text":"face: String - (Optional, default \"\") face from CfgFaces"},{"name":"speaker","type":"String","optional":true,"default":"\"\"","description":"speaker from CfgVoice","type_expr":"String","text":"speaker: String - (Optional, default \"\") speaker from CfgVoice"},{"name":"pitch","type":"String","optional":true,"default":"-1","description":"speaker pitch (1 is normal pitch, 2 = chipmunk, 0.5 = Darth Vader, etc)","type_expr":"String","text":"pitch: String - (Optional, default -1) speaker pitch (1 is normal pitch, 2 = chipmunk, 0.5 = Darth Vader, etc)"},{"name":"callsign","type":"String","optional":true,"default":"\"\"","description":"callsign","type_expr":"String","text":"callsign: String - (Optional, default \"\") callsign"},{"name":"name","type":"String","optional":true,"default":"\"\"","description":"unit name","type_expr":"String","since":"arma3 1.92","text":"name: String - (Optional, default \"\") unit name"},{"name":"glasses","type":"String","optional":true,"default":"nil","description":"glasses from CfgGlasses - use \"\" to remove glasses","type_expr":"String","since":"arma3 1.92","text":"glasses: String - (Optional, default nil) glasses from CfgGlasses - use \"\" to remove glasses"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[player, \"Kerry\", \"Male01ENGB\", 1.05, \"Big Daddy\"] call BIS_fnc_setIdentity;"]},{"code":["[bob, nil, nil, 1.6, nil, \"Miki Maus\", \"G_Shades_Black\"] call BIS_fnc_setIdentity;"]}],"see_also":["BIS_fnc_setUnitInsignia","setFace","setIdentity","setSpeaker","face"]},{"name":"BIS_fnc_setMissionStatusSlot","title":"BIS fnc setMissionStatusSlot","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_setMissionStatusSlot","revid":349123,"updated":"2023-11-08T14:49:39Z","groups":["Missions"],"status":"ok","games":{"arma3":"1.32"},"since":"arma3 1.32","arma3_since":"1.32","description":"Set a slot for mission status with sectors, respawn tickets, etc.","syntaxes":[{"syntax":"[id, text, texture, color, fade, position, barHeight] call BIS_fnc_setMissionStatusSlot","params":[{"name":"id","type":"Number","description":"slot ID. Use -1 to assign it automatically","type_expr":"Number"},{"name":"text","type":"String","description":"text","type_expr":"String"},{"name":"texture","type":"String","description":"icon path","type_expr":"String"},{"name":"color","type":"Array","description":"color in RGBA format","type_expr":"Array"},{"name":"fade","type":"Number","description":"slot fade, 0 is fully visible, 0 hidden","type_expr":"Number"},{"name":"position","type":"Array in Position format","description":"position top which camera moves after clicking on the slot","type_expr":"Array"},{"name":"barHeight","type":"Number","description":"slot progress bar height in range <0;1>","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number","description":"slot ID"}}],"see_also":["BIS_fnc_showMissionStatus"]},{"name":"BIS_fnc_setNestedElement","title":"BIS fnc setNestedElement","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_setNestedElement","revid":324401,"updated":"2022-07-01T12:00:57Z","groups":["Arrays"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Function to set an item in a nested array using a path. Modifies the array by reference.","syntaxes":[{"syntax":"[array, path, value] call BIS_fnc_setNestedElement","params":[{"name":"array","type":"Array","type_expr":"Array"},{"name":"path","type":"Array of Numbers","type_expr":"Array<Number>"},{"name":"value","type":"Anything","type_expr":"Anything"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true on success, false on failure"}}],"examples":[{"code":["private _array = [[1, 2], [3, 4]];\n_bool = [_array, [0, 0], 0] call BIS_fnc_setNestedElement; // _array is now [[0, 2], [3, 4]]"]}],"see_also":["BIS_fnc_findNestedElement","BIS_fnc_findAllNestedElements","BIS_fnc_removeNestedElement","BIS_fnc_returnNestedElement"]},{"name":"BIS_fnc_setObjectRotation","title":"BIS fnc setObjectRotation","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_setObjectRotation","revid":349342,"updated":"2023-11-08T14:53:30Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Set object rotation.","syntaxes":[{"syntax":"[object, rotation] call BIS_fnc_setObjectRotation","params":[{"name":"object","type":"Object","description":"object to manipulate","type_expr":"Object"},{"name":"rotation","type":"Array","description":"vector in format:\n\n1. Yaw\n1. Pitch\n1. Roll","type_expr":"Array"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[cursorObject, [100,100,100]] call BIS_fnc_setObjectRotation;"]}],"see_also":["vectorDir","vectorUp","setVectorDir","setVectorDirAndUp","vectorDiff","vectorAdd","vectorMultiply","vectorCrossProduct","vectorDistance","vectorMagnitudeSqr","vectorDistanceSqr","vectorCos","vectorMagnitude","vectorDotProduct","vectorNormalized","vectorFromTo"]},{"name":"BIS_fnc_setObjectShotParents","title":"BIS fnc setObjectShotParents","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_setObjectShotParents","revid":309709,"updated":"2022-05-05T12:09:46Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_setObjectTexture","title":"BIS fnc setObjectTexture","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_setObjectTexture","revid":327743,"updated":"2022-07-13T10:47:08Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"global","effect":"local"},"description":"Set object textures.","syntaxes":[{"syntax":"[object, textures] call BIS_fnc_setObjectTexture","params":[{"name":"object","type":"Object","type_expr":"Object"},{"name":"textures","type":"String or Array of Strings","type_expr":"String | Array<String>"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when done"}}],"examples":[{"code":["[player, \"#(rgb,8,8,3)color(0,0,1,1)\"] call BIS_fnc_setObjectTexture;"]},{"text":"```sqf\n[\n    vehicle player,\n    [\n        \"#(rgb,8,8,3)color(1,0,0,1)\",\n        \"#(rgb,8,8,3)color(0,1,0,1)\",\n        \"#(rgb,8,8,3)color(0,0,1,1)\"\n    ]\n] call BIS_fnc_setObjectTexture;\n```\n\nidentical to:\n\n```sqf\nvehicle player setObjectTexture [0, \"#(rgb,8,8,3)color(1,0,0,1)\"];\nvehicle player setObjectTexture [1, \"#(rgb,8,8,3)color(0,1,0,1)\"];\nvehicle player setObjectTexture [2, \"#(rgb,8,8,3)color(0,0,1,1)\"];\n```","code":["[\n\tvehicle player,\n\t[\n\t\t\"#(rgb,8,8,3)color(1,0,0,1)\",\n\t\t\"#(rgb,8,8,3)color(0,1,0,1)\",\n\t\t\"#(rgb,8,8,3)color(0,0,1,1)\"\n\t]\n] call BIS_fnc_setObjectTexture;","vehicle player setObjectTexture [0, \"#(rgb,8,8,3)color(1,0,0,1)\"];\nvehicle player setObjectTexture [1, \"#(rgb,8,8,3)color(0,1,0,1)\"];\nvehicle player setObjectTexture [2, \"#(rgb,8,8,3)color(0,0,1,1)\"];"]}],"see_also":["getObjectTextures","setObjectTexture","setObjectTextureGlobal"]},{"name":"BIS_fnc_setOvercast","title":"BIS fnc setOvercast","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_setOvercast","revid":323950,"updated":"2022-07-01T11:58:29Z","groups":["Environment"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Instantly set weather conditions and share it across network. Must be executed in scheduled environment.","syntaxes":[{"syntax":"[value] call BIS_fnc_setOvercast","params":[{"name":"value","type":"Number","description":"value ranging from 0 (sunny) to 1 (stormy).","type_expr":"Number"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[0.5] call BIS_fnc_setOvercast;"]}],"see_also":["setOvercast","overcast"]},{"name":"BIS_fnc_setPitchBank","title":"BIS fnc setPitchBank","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_setPitchBank","revid":328367,"updated":"2022-07-13T16:00:47Z","groups":["Object Manipulation"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Rotate an object, giving it the specified pitch and bank, in degrees.\n**Pitch** is 0 when the object is level; 90 when pointing straight up; and -90 when pointing straight down.\n**Bank** is 0 when level; 90 when the object is rolled to the right, -90 when rolled to the left, and 180 when rolled upside down.\nNote that the object's **yaw** can be set with the setDir command, which should be issued before using this function, if required.\nThe pitch/bank can be leveled out (set to 0) by using the setDir command.","syntaxes":[{"syntax":"[object, pitch, bank] call BIS_fnc_setPitchBank","params":[{"name":"object","type":"Object","type_expr":"Object"},{"name":"pitch","type":"Number","type_expr":"Number"},{"name":"bank","type":"Number","type_expr":"Number"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[player, 45, -45] call BIS_fnc_setPitchBank;"]}],"see_also":["BIS_fnc_getPitchBank","vectorDir","vectorUp","setVectorDirAndUp"],"notes":[{"user":"ffur2007slx2_5","date":"2014-08-04T13:35:00Z","text":"> [!NOTE]\n> See also BIS_fnc_setObjectRotation.\n\n(A3 1.24) attachTo limits BIS_fnc_setPitchBank, here’s an alternative function to break that limitation (code originated from bapedibupa):\n\n```sqf\n_obj attachTo [_logic,[0,0,2]];\n[_obj,[120,-78,37]] call fnc_SetPitchBankYaw; // pitch: 120, bank: -78, yaw: 37\n```\n\n```sqf\nfnc_SetPitchBankYaw = {\n    private [\"_object\",\"_rotations\",\"_aroundX\",\"_aroundY\",\"_aroundZ\",\"_dirX\",\"_dirY\",\"_dirZ\",\"_upX\",\"_upY\",\"_upZ\",\"_dir\",\"_up\",\"_dirXTemp\",\n    \"_upXTemp\"];\n    _object = _this select 0;\n    _rotations = _this select 1;\n    _aroundX = _rotations select 0;\n    _aroundY = _rotations select 1;\n    _aroundZ = (360 - (_rotations select 2)) - 360;\n    _dirX = 0;\n    _dirY = 1;\n    _dirZ = 0;\n    _upX = 0;\n    _upY = 0;\n    _upZ = 1;\n    if (_aroundX != 0) then {\n        _dirY = cos _aroundX;\n        _dirZ = sin _aroundX;\n        _upY = -sin _aroundX;\n        _upZ = cos _aroundX;\n    };\n    if (_aroundY != 0) then {\n        _dirX = _dirZ * sin _aroundY;\n        _dirZ = _dirZ * cos _aroundY;\n        _upX = _upZ * sin _aroundY;\n        _upZ = _upZ * cos _aroundY;\n    };\n    if (_aroundZ != 0) then {\n        _dirXTemp = _dirX;\n        _dirX = (_dirXTemp* cos _aroundZ) - (_dirY * sin _aroundZ);\n        _dirY = (_dirY * cos _aroundZ) + (_dirXTemp * sin _aroundZ);\n        _upXTemp = _upX;\n        _upX = (_upXTemp * cos _aroundZ) - (_upY * sin _aroundZ);\n        _upY = (_upY * cos _aroundZ) + (_upXTemp * sin _aroundZ);\n    };\n    _dir = [_dirX,_dirY,_dirZ];\n    _up = [_upX,_upY,_upZ];\n    _object setVectorDirAndUp [_dir,_up];\n};\n```"}]},{"name":"BIS_fnc_setPPeffectTemplate","title":"BIS fnc setPPeffectTemplate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_setPPeffectTemplate","revid":327498,"updated":"2022-07-12T22:24:27Z","groups":["Systems"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Apply post-process effects according to template from CfgPostprocessTemplates.","syntaxes":[{"syntax":"[template, transition, global] call BIS_fnc_setPPeffectTemplate","params":[{"name":"template","type":"String","optional":true,"default":"\"Default\"","description":"the template name. An invalid value will fall back to \"Default\".\nAvailable game templates are:\n\n- \"Default\"\n- \"BlackAndWhite\"\n- \"Mediterranean\"\n- \"EastWind\"\n- \"RealIsBrown\"","type_expr":"String","text":"template: String - (Optional, default \"Default\") the template name. An invalid value will fall back to \"Default\".\nAvailable game templates are:\n\n- \"Default\"\n- \"BlackAndWhite\"\n- \"Mediterranean\"\n- \"EastWind\"\n- \"RealIsBrown\""},{"name":"transition","type":"Number","optional":true,"default":"0","description":"time to apply the post-process","type_expr":"Number","text":"transition: Number - (Optional, default 0) time to apply the post-process"},{"name":"global","type":"Boolean","optional":true,"default":"isMultiplayer","description":"should the post-process be broadcast over the network","type_expr":"Boolean","text":"global: Boolean - (Optional, default isMultiplayer) should the post-process be broadcast over the network"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when done"}}],"examples":[{"code":["[\"Mediterranean\", 3, false] call BIS_fnc_setPPeffectTemplate;"]},{"code":["\"RealIsBrown\" call BIS_fnc_setPPeffectTemplate;"]},{"code":["\"MyPurplePP\" call BIS_fnc_setPPeffectTemplate; // can use a template defined in Description.ext"]}],"see_also":["Post Process Effects","ppEffectCreate","ppEffectForceInNVG","ppEffectEnable","ppEffectEnabled","ppEffectDestroy","ppEffectCommit","ppEffectCommitted","ppEffectAdjust"]},{"name":"BIS_fnc_setRain","title":"BIS fnc setRain","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_setRain","revid":370247,"updated":"2024-11-14T17:13:01Z","groups":["Environment"],"status":"ok","games":{"arma3":"2.10"},"since":"arma3 2.10","arma3_since":"2.10","locality":{"effect":"global","server_exec":true},"description":"A helper function for setting rainParams in multiplayer. The call to the function could be placed in init.sqf to sync rainParams between all clients and JIP. Alternatively execute on server.","syntaxes":[{"syntax":"rainParams call BIS_fnc_setRain","params":[{"name":"rainParams","type":"Array or Config","description":"custom RainParticles params, see rainParams. Use empty array [] or configNull to reset to default values","type_expr":"Array | Config"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"text":"```sqf\n0 setOvercast 1;\n0 setRain 1;\n0 setFog 0.1;        // snow affects visibility at distance\nsetHumidity 0.9;    // don't want to see dust clouds\nenableEnvironment [false, true];    // don't want to see snakes and butterflies either\nforceWeatherChange;\n[\n    \"a3\\data_f\\snowflake4_ca.paa\",    // rainDropTexture - 4 means it has 4 flakes in it. Other available textures: snowflake8_ca.paa, snowflake16_ca.paa\n    4,                // texDropCount - 4 because we are using texture with 4 flakes. Change to 8 or 16 in accordance with other textures used\n    0.01,            // minRainDensity\n    25,                // effectRadius\n    0.05,            // windCoef\n    2.5,            // dropSpeed\n    0.5,            // rndSpeed\n    0.5,            // rndDir\n    0.07,            // dropWidth\n    0.07,            // dropHeight\n    [1, 1, 1, 0.5],    // dropColor\n    0.0,            // lumSunFront\n    0.2,            // lumSunBack\n    0.5,            // refractCoef\n    0.5,            // refractSaturation\n    true,            // snow\n    false            // dropColorStrong\n]\ncall BIS_fnc_setRain;\n```","code":["0 setOvercast 1;\n0 setRain 1;\n0 setFog 0.1;\t\t// snow affects visibility at distance\nsetHumidity 0.9;\t// don't want to see dust clouds\nenableEnvironment [false, true];\t// don't want to see snakes and butterflies either\nforceWeatherChange;\n[\n\t\"a3\\data_f\\snowflake4_ca.paa\",\t// rainDropTexture - 4 means it has 4 flakes in it. Other available textures: snowflake8_ca.paa, snowflake16_ca.paa\n\t4,\t\t\t\t// texDropCount - 4 because we are using texture with 4 flakes. Change to 8 or 16 in accordance with other textures used\n\t0.01,\t\t\t// minRainDensity\n\t25,\t\t\t\t// effectRadius\n\t0.05,\t\t\t// windCoef\n\t2.5,\t\t\t// dropSpeed\n\t0.5,\t\t\t// rndSpeed\n\t0.5,\t\t\t// rndDir\n\t0.07,\t\t\t// dropWidth\n\t0.07,\t\t\t// dropHeight\n\t[1, 1, 1, 0.5],\t// dropColor\n\t0.0,\t\t\t// lumSunFront\n\t0.2,\t\t\t// lumSunBack\n\t0.5,\t\t\t// refractCoef\n\t0.5,\t\t\t// refractSaturation\n\ttrue,\t\t\t// snow\n\tfalse\t\t\t// dropColorStrong\n]\ncall BIS_fnc_setRain;"]}],"see_also":["rainParams","setRain"]},{"name":"BIS_fnc_setRank","title":"BIS fnc setRank","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_setRank","revid":349416,"updated":"2023-11-08T16:27:30Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Set rank of vehicle crew.","syntaxes":[{"syntax":"[target, rank] call BIS_fnc_setRank","params":[{"name":"target","type":"Object","description":"the vehicle whose crew's rank should be adjusted","type_expr":"Object"},{"name":"rank","type":"String or Number","description":"rank name or rank ID, can be:\n0 - \"Private\"\n1 - \"Corporal\"\n2 - \"Sergeant\"\n3 - \"Lieutenant\"\n4 - \"Captain\"\n5 - \"Major\"\n6 - \"Colonel\"","type_expr":"String | Number"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[vehicle player, \"Captain\"] call BIS_fnc_setRank;"]}],"see_also":["rank","setRank"]},{"name":"BIS_fnc_setRespawnDelay","title":"BIS fnc setRespawnDelay","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_setRespawnDelay","revid":309860,"updated":"2022-05-05T12:09:53Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Increase the respawn time based on a condition","syntaxes":[{"syntax":"[param0, param1, param2] call BIS_fnc_setRespawnDelay","params":[{"name":"param0","type":"Code","type_expr":"Code","description":"Condition, must return BOOL","text":"0: CODE - Condition, must return BOOL","source":"docblock"},{"name":"param1","type":"Number","type_expr":"Number","description":"delay in seconds which is applied when the condition is true","text":"1: NUMBER - delay in seconds which is applied when the condition is true","source":"docblock"},{"name":"param2","type":"String","type_expr":"String","description":"description displayed when the delay is in effect","text":"2: STRING - description displayed when the delay is in effect","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","text":"NOTHING","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nIncrease the respawn time based on a condition\n\nParameter(s):\n    0: CODE - Condition, must return BOOL\n    1: NUMBER - delay in seconds which is applied when the condition is true\n    2: STRING - description displayed when the delay is in effect\n\nReturns:\nNOTHING"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_setRespawnInventory","title":"BIS fnc setRespawnInventory","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_setRespawnInventory","revid":349247,"updated":"2023-11-08T14:51:00Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.60"},"since":"arma3 1.60","arma3_since":"1.60","description":"Set respawn loadouts.","syntaxes":[{"syntax":"[target, inventory] call BIS_fnc_setRespawnInventory","params":[{"name":"target","type":"Namespace, Side, Group or Object","description":"target where respawn inventories should be saved","type_expr":"Namespace | Side | Group | Object"},{"name":"inventory","type":"Array of Strings","description":"classes from CfgInventory or CfgVehicles","type_expr":"Array<String>"}],"returns":{"type":"Array","type_expr":"Array","description":"in format [target, id] used in BIS_fnc_removeRespawnInventory"}}],"examples":[{"code":["[player, [\"B_T_Recon_TL_F\"]] call BIS_fnc_setRespawnInventory;"]}],"see_also":["Arma 3: Respawn","BIS_fnc_addRespawnInventory","BIS_fnc_removeRespawnInventory","BIS_fnc_getRespawnInventories"]},{"name":"BIS_fnc_setServerVariable","title":"BIS fnc setServerVariable","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_setServerVariable","revid":327933,"updated":"2022-07-13T12:34:00Z","groups":["Variables"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Set variable stored only on server. Clients can the download it using BIS_fnc_getServerVariable. Used when you want to share variables only to specific clients to prevent large traffic.","syntaxes":[{"syntax":"[namespace, varName, value] call BIS_fnc_setServerVariable","params":[{"name":"namespace","type":"Namespace, Object or Group","optional":true,"default":"missionNamespace","type_expr":"Namespace | Object | Group","text":"namespace: Namespace, Object or Group - (Optional, default missionNamespace)"},{"name":"varName","type":"String","description":"variable name","type_expr":"String"},{"name":"value","type":"Anything","description":"variable value","type_expr":"Anything"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when done"}}],"examples":[{"code":["[nil, \"playerHealth\", damage player] call BIS_fnc_setServerVariable;"]},{"code":["[player, \"playerHealth\", damage player] call BIS_fnc_setServerVariable;"]}],"see_also":["BIS_fnc_getServerVariable","publicVariableServer","publicVariableClient"]},{"name":"BIS_fnc_setTask","title":"BIS fnc setTask","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_setTask","revid":352179,"updated":"2024-02-01T23:25:46Z","groups":["Tasks"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"global","effect":"global"},"description":"Set task parameters.\n\nCreate the task when it doesn't exist.\n\n> [!NOTE]\n> See Arma 3: Task Framework for more information.","syntaxes":[{"syntax":"[taskId, target, description, (destination, state, priority, showNotification, isGlobal, type, visibleIn3D)] call BIS_fnc_setTask","params":[{"name":"taskId","description":"String - Task ID\n\nArray - In the format of [task ID, parent task ID]","type_expr":"String | Array","text":"**taskId**:\n\nString - Task ID\n\nArray - In the format of [task ID, parent task ID]"},{"name":"target","description":"Task owner(s)\n\nBoolean - true to set task of all playable units\n\nObject - set task of a specific object\n\nGroup - set tasks of all objects in the group\n\nSide - set tasks of all objects of the given side\n\nArray - collection of above types","type_expr":"Boolean | Object | Group | Side | Array","text":"**target**: Task owner(s)\n\nBoolean - true to set task of all playable units\n\nObject - set task of a specific object\n\nGroup - set tasks of all objects in the group\n\nSide - set tasks of all objects of the given side\n\nArray - collection of above types"},{"name":"description","description":"Array - Task description in the format [\"description\", \"title\", \"marker\"]\n\nString - CfgTaskDescriptions class name, if empty string is used then CfgTaskDescriptions is searched for a class matching the tasks TaskID","type_expr":"Array | String","text":"**description**:\n\nArray - Task description in the format [\"description\", \"title\", \"marker\"]\n\nString - CfgTaskDescriptions class name, if empty string is used then CfgTaskDescriptions is searched for a class matching the tasks TaskID"},{"name":"destination","optional":true,"description":"Task destination\n\nObject\n\nArray - either position in format [x,y,z], or [object,precision] as used by setSimpleTaskTarget command","type_expr":"Object | Array","text":"**destination** (Optional): Task destination\n\nObject\n\nArray - either position in format [x,y,z], or [object,precision] as used by setSimpleTaskTarget command"},{"name":"state","optional":true,"description":"Task state\n\nString - can be one of following:\n\n\"CREATED\"\n\n\"ASSIGNED\"\n\n\"AUTOASSIGNED\" (\"ASSIGNED\" when no task is assigned yet, otherwise \"CREATED\")\n\n\"SUCCEEDED\"\n\n\"FAILED\"\n\n\"CANCELED\"\n\nBoolean - true to set the task as current","type_expr":"String | Boolean","text":"**state** (Optional): Task state\n\nString - can be one of following:\n\n\"CREATED\"\n\n\"ASSIGNED\"\n\n\"AUTOASSIGNED\" (\"ASSIGNED\" when no task is assigned yet, otherwise \"CREATED\")\n\n\"SUCCEEDED\"\n\n\"FAILED\"\n\n\"CANCELED\"\n\nBoolean - true to set the task as current"},{"name":"priority","type":"Number","optional":true,"description":"priority. When a current task is completed, system select a next one with the larges priority >= 0","type_expr":"Number","text":"**priority** (Optional): Number - priority. When a current task is completed, system select a next one with the larges priority >= 0"},{"name":"showNotification","type":"Boolean","optional":true,"description":"true to show notification (default), false to disable it","type_expr":"Boolean","text":"**showNotification** (Optional): Boolean - true to show notification (default), false to disable it"},{"name":"isGlobal","type":"Boolean","optional":true,"description":"true to set task globally (default), false to set it only locally","type_expr":"Boolean","text":"**isGlobal** (Optional): Boolean - true to set task globally (default), false to set it only locally"},{"name":"type","type":"String","optional":true,"description":"task type from CfgTaskTypes, if not defined, type \"\" is being used","type_expr":"String","text":"**type** (Optional): String - task type from CfgTaskTypes, if not defined, type \"\" is being used"},{"name":"visibleIn3D","type":"Boolean","optional":true,"default":"false","description":"true to make task always visible in 3D","type_expr":"Boolean","text":"**visibleIn3D** (Optional): Boolean - true to make task always visible in 3D (default: false)"}],"returns":{"type":"String","type_expr":"String","description":"task ID"}}],"examples":[{"code":["[\"Task_01\", true, [\"Protect the respawn point.\",\"Respawn Point West\",\"respawn_west\"], [MHQ,false], \"ASSIGNED\", 5, true, true, \"Defend\", true] call BIS_fnc_setTask;"]}],"see_also":["Arma 3: Task Framework"]},{"name":"BIS_fnc_setTaskLocal","title":"BIS fnc setTaskLocal","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_setTaskLocal","revid":286852,"updated":"2021-06-27T09:51:20Z","groups":["Tasks"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"> [!IMPORTANT]\n> Local task management executed by BIS_fnc_setTask. Not to be called independently!","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Task Framework"]},{"name":"BIS_fnc_setToPairs","title":"BIS fnc setToPairs","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_setToPairs","revid":349084,"updated":"2023-11-08T14:47:24Z","groups":["Arrays"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Works similar to the BIS_fnc_addToPairs but it doesn't try to add values. It just overwrites the volue if the key already exists.","syntaxes":[{"syntax":"[array, key, newValue] call BIS_fnc_setToPairs","params":[{"name":"array","type":"Array","description":"array to search through","type_expr":"Array"},{"name":"key","type":"String","description":"key to search for","type_expr":"String"},{"name":"newValue","type":"Anything","optional":true,"default":"1","description":"new value set if match was found","type_expr":"Anything","text":"newValue: Anything - (Optional, default 1) new value set if match was found"}],"returns":{"type":"Array","type_expr":"Array","description":"resulting modified array"}}],"examples":[{"code":["[[[\"apple\",3],[\"pear\",2]],\"pear\",10] call BIS_fnc_setToPairs; // Returns [[\"apple\",3],[\"pear\",10]]"]}],"see_also":["find","findIf","BIS_fnc_findInPairs","BIS_fnc_getFromPairs","BIS_fnc_addToPairs","BIS_fnc_removeFromPairs"]},{"name":"BIS_fnc_setUnitInsignia","title":"BIS fnc setUnitInsignia","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_setUnitInsignia","revid":378918,"updated":"2026-08-14T14:54:01Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","locality":{"argument":"global","effect":"global"},"description":"Sets unit insignia (e.g., shoulder insignia on soldiers). See Arma 3: Unit Insignia for more details and a list of official insignias.","syntaxes":[{"syntax":"[target, className] call BIS_fnc_setUnitInsignia","params":[{"name":"target","type":"Object","description":"unit to which the insignia is going to be attached","type_expr":"Object"},{"name":"class","type":"String","description":"CfgUnitInsignia class name to use. Use an empty string to remove the current insignia.","type_expr":"String"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"returns true if successful."}}],"examples":[{"text":"Place insignia:\n\n```sqf\n[player, \"111thID\"] call BIS_fnc_setUnitInsignia;\n```","code":["[player, \"111thID\"] call BIS_fnc_setUnitInsignia;"]},{"text":"Remove insignia:\n\n```sqf\n[player, \"\"] call BIS_fnc_setUnitInsignia;\n```","code":["[player, \"\"] call BIS_fnc_setUnitInsignia;"]}],"see_also":["BIS_fnc_getUnitInsignia","Arma 3: Unit Insignia"],"notes":[{"user":"Pierre MGI","date":"2016-08-09T05:26:00Z","text":"In Arma 3: Unit Insignia, you can read:\n\n> « You can add a new insignia in Config.cpp and Description.ext. »\n\nIf it is possible to add a cfgUnitInsignia class in a description.ext, please note that the path of the texture differs for server and client in MP environment.\nConfig.cpp (addon) is more reliable. Description.ext, in this case, should be used for SP mission only.\nThis function calls setObjectTextureGlobal, which is a broken command in MP (see feedback tracker) August 2016."},{"user":"Leopard20","date":"2021-06-21T21:51:00Z","text":"To set the insignia after respawn, add this code to initPlayerLocal.sqf\n\n```sqf\nparams [\"_player\"];\n_player addMPEventHandler [\"MPRespawn\", {\n    params [\"_unit\", \"_corpse\"];\n    private _insignia = [_corpse] call BIS_fnc_getUnitInsignia;\n    [_unit, _insignia] spawn {\n        params [\"_unit\", \"_insignia\"];\n        sleep 1;\n        isNil {\n            _unit setVariable [\"BIS_fnc_setUnitInsignia_class\", nil]; // you can also do [_unit, \"\"] call BIS_fnc_setUnitInsignia, but this way is faster (plus no network traffic)\n            [_unit, _insignia] call BIS_fnc_setUnitInsignia;\n        };\n    };\n}];\n```\n\nNotice that the previous insignia has been **cleared** first to make the change happen (possibly a bug as of Arma 3 v2.05)"}]},{"name":"BIS_fnc_setVehicleMass","title":"BIS fnc setVehicleMass","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_setVehicleMass","revid":327965,"updated":"2022-07-13T13:59:07Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"local","effect":"global"},"description":"Set mass relative to the default vehicle mass (default mass being vehicle mass on first execution of this function).","syntaxes":[{"syntax":"[vehicle, animationInformation, massDifference] call BIS_fnc_setVehicleMass","params":[{"name":"vehicle","type":"Object","type_expr":"Object"},{"name":"animationInformation","type":"Boolean or Array","optional":true,"default":"`[]`","description":"Boolean - true to take current animations mass in consideration, false to set \"raw\" mass\n- Array - animation sources and phases to format [\"animationSource1\", 1, \"animationSource2\", 0, ...]","type_expr":"Boolean | Array","text":"animationInformation: Boolean or Array - (Optional, default `[]`)\n\n- Boolean - true to take current animations mass in consideration, false to set \"raw\" mass\n- Array - animation sources and phases to format [\"animationSource1\", 1, \"animationSource2\", 0, ...]"},{"name":"massDifference","type":"Number","optional":true,"default":"0","description":"value to add to the mass (can be negative)","type_expr":"Number","text":"massDifference: Number - (Optional, default 0) value to add to the mass (can be negative)"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"success state"}}],"examples":[{"text":"```sqf\n// default behaviour, change the mass according to the current phase of the animation sources\nresult = [this]            call BIS_fnc_setVehicleMass;\nresult = [this, [], 0]    call BIS_fnc_setVehicleMass;\n```","code":["// default behaviour, change the mass according to the current phase of the animation sources\nresult = [this]\t\t\tcall BIS_fnc_setVehicleMass;\nresult = [this, [], 0]\tcall BIS_fnc_setVehicleMass;"]},{"code":["// doesn't care about the current phase of animations, it will change the mass for the given sources\nresult = [this, [\"source1\", 1, \"source2\", 0]] call BIS_fnc_initVehicle;"]},{"code":["// will do the same as the first example, then subtract 150 to the mass\nresult = [this, [], -150] call BIS_fnc_initVehicle;"]}],"see_also":["setMass","setCenterOfMass"]},{"name":"BIS_fnc_shakeCuratorCamera","title":"BIS fnc shakeCuratorCamera","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_shakeCuratorCamera","revid":349507,"updated":"2023-11-08T17:09:13Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","exec":"spawn","description":"Shake curator camera.","syntaxes":[{"syntax":"[strength,duration,area] spawn BIS_fnc_shakeCuratorCamera","params":[{"name":"strength","type":"Number","optional":true,"default":"0.01","description":"shaking strength","type_expr":"Number","text":"strength: Number - (Optional, default 0.01) shaking strength"},{"name":"duration","type":"Number","optional":true,"default":"0.7","description":"duration in seconds","type_expr":"Number","text":"duration: Number - (Optional, default 0.7) duration in seconds"},{"name":"area","type":"Array","optional":true,"default":"`[]`","description":"shake only when camera is in given distance from center. In format:\n0: Position - Center\n1: Number - Radius","type_expr":"Array","text":"area: Array - (Optional, default `[]`) shake only when camera is in given distance from center. In format:\n0: Position - Center\n1: Number - Radius"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[] spawn BIS_fnc_shakeCuratorCamera;"]},{"code":["[0.1, 5, [BIS_explosion_center,500]] spawn BIS_fnc_shakeCuratorCamera;"]}],"see_also":["Arma 3: Curator"]},{"name":"BIS_fnc_shakeGauges","title":"BIS fnc shakeGauges","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_shakeGauges","revid":309818,"updated":"2022-05-05T12:09:51Z","groups":["GUI"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Shake analogue gauges","syntaxes":[{"syntax":"arg call BIS_fnc_shakeGauges","params":[{"name":"arg","type":"Number","types":["Number"],"optional":true,"description":"shake limit (max distance gauges can move on screen from original position)\n_this select 1 (Optional): NUMBER - number of repeats\n_this select 2 (Optional): NUMBER - delay between every position change\n_this select 3 (Optional): ARRAY - list of IDCs","text":"_this select 0 (Optional): NUMBER - shake limit (max distance gauges can move on screen from original position)\n_this select 1 (Optional): NUMBER - number of repeats\n_this select 2 (Optional): NUMBER - delay between every position change\n_this select 3 (Optional): ARRAY - list of IDCs","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","text":"NOTHING","source":"docblock"},"inferred":true}],"docblock":{"text":"Description:\nShake analogue gauges\n\nParameter(s):\n_this select 0 (Optional): NUMBER - shake limit (max distance gauges can move on screen from original position)\n_this select 1 (Optional): NUMBER - number of repeats\n_this select 2 (Optional): NUMBER - delay between every position change\n_this select 3 (Optional): ARRAY - list of IDCs\n\nReturns:\nNOTHING"},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_shakeMap","title":"BIS fnc shakeMap","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_shakeMap","revid":348853,"updated":"2023-11-08T14:39:12Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"\"Camera shake\" function for the map. Shakes the map for a given amount of time with a given amount of force around the given camera center. Exits if map is not open.","syntaxes":[{"syntax":"[duration, magnitude, center] call BIS_fnc_shakeMap","params":[{"name":"duration","type":"Number","description":"duration of the effect","type_expr":"Number"},{"name":"magnitude","type":"Number","description":"magnitude of the shaking force","type_expr":"Number"},{"name":"center","type":"Array","description":"center position of the effect","type_expr":"Array"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[2,20,getMarkerPos \"BIS_markerExtraction0\"] call BIS_fnc_shakeMap;"]},{"code":["[2,20,getPos player] call BIS_fnc_shakeMap;"]}],"see_also":["BIS_fnc_shakeMapEH"]},{"name":"BIS_fnc_shakeMapEH","title":"BIS fnc shakeMapEH","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_shakeMapEH","revid":379573,"updated":"2026-10-31T14:01:25Z","groups":["Map and Markers","Event Handlers"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Event handler function of BIS_fnc_shakeMap. BIS_fnc_shakeMap adds it as a \"Draw\" event handler to the main map control (display 12, control 51), so it runs every frame the map is drawn.\nWhile the shake lasts, it moves the map view to a random point within *magnitude* metres of the shake center on both axes; the movement fades out during the last quarter of the duration. When the duration has elapsed, it removes the event handler whose ID is stored in the *BIS_shakeMapEventId* variable of missionNamespace.\nIt is meant for internal use; use BIS_fnc_shakeMap to shake the map.","syntaxes":[{"syntax":"[duration, magnitude, center, startTime] call BIS_fnc_shakeMapEH","params":[{"name":"duration","type":"Number","optional":true,"default":"2","description":"duration of the shake in seconds","type_expr":"Number","text":"duration: Number - (Optional, default 2) duration of the shake in seconds"},{"name":"magnitude","type":"Number","optional":true,"default":"20","description":"maximum offset of the map view, in metres","type_expr":"Number","text":"magnitude: Number - (Optional, default 20) maximum offset of the map view, in metres"},{"name":"center","type":"Array format Position","optional":true,"default":"[0,0,0]","description":"position around which the map shakes","type_expr":"Position","types":["Array","Position"],"text":"center: Array format Position - (Optional, default [0,0,0]) position around which the map shakes"},{"name":"startTime","type":"Number","optional":true,"default":"0","description":"time at which the shake started","type_expr":"Number","text":"startTime: Number - (Optional, default 0) time at which the shake started"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"How BIS_fnc_shakeMap adds the handler:\n\n```sqf\nprivate _map = findDisplay 12 displayCtrl 51;\nprivate _code = format [\"[%1, %2, %3, %4] call BIS_fnc_shakeMapEH\", 2, 20, getPosWorld player, time];\nBIS_shakeMapEventId = _map ctrlAddEventHandler [\"Draw\", _code];\n```","code":["private _map = findDisplay 12 displayCtrl 51;\nprivate _code = format [\"[%1, %2, %3, %4] call BIS_fnc_shakeMapEH\", 2, 20, getPosWorld player, time];\nBIS_shakeMapEventId = _map ctrlAddEventHandler [\"Draw\", _code];"]}],"see_also":["BIS_fnc_shakeMap","ctrlMapAnimAdd","ctrlAddEventHandler"]},{"name":"BIS_fnc_sharedObjectives","title":"BIS fnc sharedObjectives","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_sharedObjectives","revid":286847,"updated":"2021-06-27T09:49:38Z","groups":["Tasks"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"> [!IMPORTANT]\n> Meant to be run by the Arma 3: Task Framework in MP scenarions in postInit. Do not run it on its own!","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Task Framework"]},{"name":"BIS_fnc_showAANArticle","title":"BIS fnc showAANArticle","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showAANArticle","revid":349535,"updated":"2023-11-08T17:16:42Z","groups":["GUI","Interaction"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Show an AAN article.","syntaxes":[{"syntax":"[arrayOfArrays, display, fade] call BIS_fnc_showAANArticle","params":[{"name":"arrayOfArrays","type":"array of arrays; each subarray defines part of an article, can be:","description":"array of arrays; each subarray defines part of an article, can be:\n\n- Article title: [\"title\", <text:string>]\n- Article author and date: [\"meta\", [<author:string>, <date:array Y,M,D,H,M>, <timezoneName:string>]]\n- Paragraph: [\"text\",<text:string>]\n- Bold paragraph: [\"textbold\",<text:string>]\n- Locked paragraph: [\"textlocked\",[<text:string>,<prompt:string>]] - *Locked paragraph with subscriber prompt. There should be no paragraph after it.*\n- Image with description: [\"image\", [<path:string>, <description:string>, <source:string>]] - *The image should have 2:1 ratio.*\n- Link to another \"fake\" article displayed on left: [\"box\",[<path:string>, <description:string>]] - *The image should have 2:1 ratio.*\n- Author's bio: [\"author\",[<path:string>, <description:string>]] - *The image should have 1:1 ratio.*\n- Draft notification: [\"draft\",[<text:string>, <color:arrayRGB>]] - *Text and color are optional, default notification will be shown when they're undefined.*","type_expr":"Array<Array>","text":"arrayOfArrays: array of arrays; each subarray defines part of an article, can be:\n\n- Article title: [\"title\", <text:string>]\n- Article author and date: [\"meta\", [<author:string>, <date:array Y,M,D,H,M>, <timezoneName:string>]]\n- Paragraph: [\"text\",<text:string>]\n- Bold paragraph: [\"textbold\",<text:string>]\n- Locked paragraph: [\"textlocked\",[<text:string>,<prompt:string>]] - *Locked paragraph with subscriber prompt. There should be no paragraph after it.*\n- Image with description: [\"image\", [<path:string>, <description:string>, <source:string>]] - *The image should have 2:1 ratio.*\n- Link to another \"fake\" article displayed on left: [\"box\",[<path:string>, <description:string>]] - *The image should have 2:1 ratio.*\n- Author's bio: [\"author\",[<path:string>, <description:string>]] - *The image should have 1:1 ratio.*\n- Draft notification: [\"draft\",[<text:string>, <color:arrayRGB>]] - *Text and color are optional, default notification will be shown when they're undefined.*"},{"name":"display","type":"Display","description":"a display to make the AAN article a child of it","type_expr":"Display"},{"name":"fade","type":"Boolean","optional":true,"default":"false","description":"true to fade from black","type_expr":"Boolean","text":"fade: Boolean - (Optional, default false) true to fade from black"}],"returns":{"type":"Display","type_expr":"Display","description":"the AAN article display"}}],"examples":[{"text":"```sqf\n[\n    [\n        [\"title\",\"My Title\"],\n        [\"meta\",[\"Katherine Bishop\",[2035,2,24,11,38],\"CET\"]],\n        [\"textbold\",\"This is a bold text\"],\n        [\"image\",[\"\\a3\\Missions_F_Orange\\Data\\Img\\orange_overview_ca.paa\",\"Some image description\"]],\n        [\"box\",[\"\\a3\\Missions_F_Orange\\Data\\Img\\Faction_IDAP_overview_CA.paa\",\"You won't believe how playing Showcase Laws of War can change your life!\"]],\n        [\"text\",\"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi tincidunt pretium ultricies. Etiam ac ornare est, quis posuere nisl. Mauris facilisis lectus eu turpis maximus consequat. Donec ut metus nec risus tristique mattis. Ut posuere rutrum tellus, ut molestie orci mattis id. Cras ultrices euismod diam, in venenatis nunc commodo eget. Interdum et malesuada fames ac ante ipsum primis in faucibus. Morbi congue dolor rutrum lectus euismod, ac faucibus magna molestie. Aliquam in libero sit amet eros sagittis tristique. Nam pellentesque dignissim aliquam.\"],\n        [\"textlocked\",[\"Sed non est risus. Nulla condimentum at leo sed bibendum. Phasellus laoreet sit amet leo tincidunt consequat. Curabitur nec hendrerit purus. Nam massa nisi, mattis in aliquet consectetur, ornare eget nibh. Nunc dignissim, nibh sit amet ultrices tincidunt, mi nulla fermentum quam, non condimentum dolor eros vulputate massa.\",\"SUBSCRIBE PLZ\"]],\n        [\"author\",[\"\\a3\\Missions_F_Orange\\Data\\Img\\avatar_journalist_ca.paa\",\"Katherine Bishop is a journalist\"]]\n    ]\n] call BIS_fnc_showAANArticle;\n```","code":["[\n\t[\n\t\t[\"title\",\"My Title\"], \n\t\t[\"meta\",[\"Katherine Bishop\",[2035,2,24,11,38],\"CET\"]], \n\t\t[\"textbold\",\"This is a bold text\"], \n\t\t[\"image\",[\"\\a3\\Missions_F_Orange\\Data\\Img\\orange_overview_ca.paa\",\"Some image description\"]], \n\t\t[\"box\",[\"\\a3\\Missions_F_Orange\\Data\\Img\\Faction_IDAP_overview_CA.paa\",\"You won't believe how playing Showcase Laws of War can change your life!\"]], \n\t\t[\"text\",\"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi tincidunt pretium ultricies. Etiam ac ornare est, quis posuere nisl. Mauris facilisis lectus eu turpis maximus consequat. Donec ut metus nec risus tristique mattis. Ut posuere rutrum tellus, ut molestie orci mattis id. Cras ultrices euismod diam, in venenatis nunc commodo eget. Interdum et malesuada fames ac ante ipsum primis in faucibus. Morbi congue dolor rutrum lectus euismod, ac faucibus magna molestie. Aliquam in libero sit amet eros sagittis tristique. Nam pellentesque dignissim aliquam.\"], \n\t\t[\"textlocked\",[\"Sed non est risus. Nulla condimentum at leo sed bibendum. Phasellus laoreet sit amet leo tincidunt consequat. Curabitur nec hendrerit purus. Nam massa nisi, mattis in aliquet consectetur, ornare eget nibh. Nunc dignissim, nibh sit amet ultrices tincidunt, mi nulla fermentum quam, non condimentum dolor eros vulputate massa.\",\"SUBSCRIBE PLZ\"]], \n\t\t[\"author\",[\"\\a3\\Missions_F_Orange\\Data\\Img\\avatar_journalist_ca.paa\",\"Katherine Bishop is a journalist\"]] \n\t]\n] call BIS_fnc_showAANArticle;"]}],"see_also":["BIS_fnc_AAN"],"notes":[{"user":"Freddo3000","date":"2021-06-12T23:42:00Z","text":"Can be added to diary records using an `<expression>` tag, with a clickable link leading to the article.\n\n```sqf\nTAG_fnc_myArticle = {\n    [\n        [\n            [\"title\", \"My Article\"],\n            [\"text\", \"Flavour text\"]\n        ]\n    ] call BIS_fnc_showAANArticle\n};\n\nplayer createDiaryRecord [\"diary\", [\"articles\", \"<execute expression='[] call TAG_fnc_myArticle'>My Article 1</execute>\"]];\n```"}]},{"name":"BIS_fnc_showCuratorAttributes","title":"BIS fnc showCuratorAttributes","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showCuratorAttributes","revid":309307,"updated":"2022-05-05T12:04:23Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Show attributes window of an entity. When no attributes are available, no window is opened.","syntaxes":[{"syntax":"[target] call BIS_fnc_showCuratorAttributes","params":[{"name":"target","type":"Object, Group, Array (Waypoint) or String","description":"entity whose attributes should be shown","type_expr":"Object | Group | Array | String"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if windows was opened"}}],"examples":[{"code":["[BIS_vehicle] call BIS_fnc_showCuratorAttributes;"]}],"see_also":["Arma 3: Curator"]},{"name":"BIS_fnc_showCuratorFeedbackMessage","title":"BIS fnc showCuratorFeedbackMessage","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showCuratorFeedbackMessage","revid":338635,"updated":"2023-03-25T13:54:12Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Show feedback message when illegal operation is attempted in curator interface.\n\n|  |  |\n|---|---|\n| **Interface**<br>- **000**: Cannot exit Zeus interface<br>- **003**: Cannot move camera outside the camera area<br>**Placing**<br>- **101**: Placing objects is not available<br>- **102**: Insufficient resources<br>- **103**: Selected position is not in an editing area<br>**Placing waypoints**<br>- **201**: Placing waypoints is not available<br>- **206**: No objects, groups or waypoints selected<br>**Editing**<br>- **301**: Editing entities is not available<br>- **303**: Selected position is not inside editing area<br>- **304**: One of the selected entities is not in an editing area<br>- **307**: Players cannot be edited<br>- **308**: The vehicle is full | **Deleting**<br>- **401**: Deleting entities is not available<br>- **404**: One of the selected objects is not in an editing area<br>- **405**: One of selected vehicles has non-editable crew in it<br>- **407**: Players cannot be deleted<br>**Destroying**<br>- **501**: Destroying entities is not available<br>- **504**: One of the selected objects is not in an editing area<br>- **505**: One of the selected vehicles has non-editable crew in it<br>- **506**: No objects selected<br>- **507**: Players cannot be destroyed<br>**Syncing**<br>- **609**: At least one AI unit has to be present in synchronization<br>- **610**: Cannot change player side (typo: *\"changle\"*) |","syntaxes":[{"syntax":"[curator, messageInfo] call BIS_fnc_showCuratorFeedbackMessage","params":[{"name":"curator","type":"Object","description":"*not used*","type_expr":"Object"},{"name":"messageInfo","type":"Number or String","description":"error ID, or text message to be displayed","type_expr":"Number | String"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when done"}}],"examples":[{"code":["[objNull, 404] call BIS_fnc_showCuratorFeedbackMessage;"]},{"code":["[objNull, \"You can't do that!\"] call BIS_fnc_showCuratorFeedbackMessage;"]}],"see_also":["BIS_fnc_curatorHint"]},{"name":"BIS_fnc_showMarker","title":"BIS fnc showMarker","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showMarker","revid":348848,"updated":"2023-11-08T14:39:11Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","locality":{"effect":"global"},"exec":"spawn","description":"Gradual revealing of a marker by setting its alpha to its original alpha or to a user-specified alpha.","syntaxes":[{"syntax":"[marker, duration, finalAlpha] spawn BIS_fnc_showMarker","params":[{"name":"marker","type":"String","description":"marker name","type_expr":"String"},{"name":"duration","type":"Number","optional":true,"default":"1","description":"duration of revealing","type_expr":"Number","text":"duration: Number - (Optional, default 1) duration of revealing"},{"name":"finalAlpha","type":"Number","optional":true,"default":"1","description":"final alpha while showing is finished","type_expr":"Number","text":"finalAlpha: Number - (Optional, default 1) final alpha while showing is finished"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"BIS_marker\",2] spawn BIS_fnc_showMarker;"]}],"see_also":["BIS_fnc_blinkMarker","BIS_fnc_colorMarker","BIS_fnc_moveMarker"]},{"name":"BIS_fnc_showMarkerArray","title":"BIS fnc showMarkerArray","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showMarkerArray","revid":327997,"updated":"2022-07-13T15:43:02Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","locality":{"argument":"global","effect":"global"},"exec":"spawn","description":"Unhide the markers sequentially.","syntaxes":[{"syntax":"[marker, duration, hideAfter] spawn BIS_fnc_showMarkerArray","params":[{"name":"marker","type":"Array","description":"Array of Strings markers","type_expr":"Array"},{"name":"duration","type":"Number","optional":true,"default":"1","description":"duration","type_expr":"Number","text":"duration: Number - (Optional, default 1) duration"},{"name":"hideAfter","type":"Boolean","optional":true,"default":"true","description":"true to keep markers displayed, false to hide them again afterward","type_expr":"Boolean","text":"hideAfter: Boolean - (Optional, default true) true to keep markers displayed, false to hide them again afterward"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[[\"marker_1\",\"marker_2\",\"marker_n\"], 3, false] spawn BIS_fnc_showMarkers;"]}],"see_also":["BIS_fnc_blinkMarker","BIS_fnc_colorMarker","BIS_fnc_moveMarker","BIS_fnc_showMarker"]},{"name":"BIS_fnc_showMarkers","title":"BIS fnc showMarkers","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showMarkers","revid":327538,"updated":"2022-07-12T22:38:03Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Show or hide given markers using fade effect.","syntaxes":[{"syntax":"[action, markers] call BIS_fnc_showMarkers","params":[{"name":"action","type":"String","description":"can be \"show\" or \"hide\". Any other value will be ignored.","type_expr":"String"},{"name":"markers","type":"Array of Strings","description":"markers to show/hide","type_expr":"Array<String>"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"hide\", [\"respawn_west\", \"respawn_east\"]] call BIS_fnc_showMarkers;"]}]},{"name":"BIS_fnc_showMissionStatus","title":"BIS fnc showMissionStatus","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showMissionStatus","revid":309845,"updated":"2022-05-05T12:09:52Z","groups":["Missions"],"status":"ok","games":{"arma3":"1.32"},"since":"arma3 1.32","arma3_since":"1.32","locality":{"effect":"local"},"description":"Show mission status with sectors, respawn tickets, etc.","syntaxes":[{"syntax":"[] call BIS_fnc_showMissionStatus","params":[],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["call BIS_fnc_showMissionStatus;"]}],"see_also":["BIS_fnc_rscLayer"]},{"name":"BIS_fnc_showNotification","title":"BIS fnc showNotification","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showNotification","revid":351692,"updated":"2023-12-26T15:55:29Z","groups":["GUI"],"status":"ok","games":{"arma3":"0.50"},"since":"arma3 0.50","arma3_since":"0.50","locality":{"effect":"local"},"description":"Show a config-defined notification.","syntaxes":[{"syntax":"[template, arguments] call BIS_fnc_showNotification","params":[{"name":"template","type":"String","description":"notification class name from CfgNotifications","type_expr":"String","text":"**template**: String - notification class name from CfgNotifications"},{"name":"arguments","type":"Array","optional":true,"default":"`[]`","description":"additional format arguments to fill notification's fields (`title`, `description`, `iconPicture`, `iconText`, `soundRadio`)","type_expr":"Array","text":"**arguments**: Array - (Optional, default `[]`) additional format arguments to fill notification's fields (`title`, `description`, `iconPicture`, `iconText`, `soundRadio`)"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[\"TaskSucceeded\", [\"\", \"Disable the nuke\"]] call BIS_fnc_showNotification;"]},{"code":["[\"ScoreAdded\", [\"Disabled the nuke without triggering an alarm.\", 5]] call BIS_fnc_showNotification;"]}],"see_also":["Arma 3: Notification"]},{"name":"BIS_fnc_showRespawnMenu","title":"BIS fnc showRespawnMenu","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showRespawnMenu","revid":348955,"updated":"2023-11-08T14:45:39Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Triggers the respawn screen in the given mode","syntaxes":[{"syntax":"","params":[{"name":"mode","type":"String","description":"possible modes are \"open\", \"map\", \"spectate\" and \"close\"","type_expr":"String"}],"returns":null}],"examples":[{"code":["[\"open\"] call BIS_fnc_showRespawnMenu; // spawn does work as well"]}],"see_also":["Arma 3: Respawn"]},{"name":"BIS_fnc_showRespawnMenuDisableItem","title":"BIS fnc showRespawnMenuDisableItem","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showRespawnMenuDisableItem","revid":349083,"updated":"2023-11-08T14:47:24Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.60"},"since":"arma3 1.60","arma3_since":"1.60","locality":{"effect":"global"},"description":"Disables respawn loadout, role or position for Arma 3: Respawn.\n\n- Only role or only loadout can be limited at one moment, if there is limit for both, then only role uses limit.\n- If the limit definition for role is called multiple times with different numbers, then the highest number is used.\n- If disabling a position then respawnReference must be supplied","syntaxes":[{"syntax":"[mode, uiControl, listboxItem, message, respawnReference] call BIS_fnc_showRespawnMenuDisableItem","params":[{"name":"mode","type":"String","description":"available options are *disable*, *enable* and *state*","type_expr":"String","text":"**mode**: String - available options are *disable*, *enable* and *state*"},{"name":"uiControl","type":"Control","description":"list in which item should be disabled/enabled\n\n- BIS_RscRespawnControlsMap_ctrlLocList\n- BIS_RscRespawnControlsMap_ctrlRoleList\n- BIS_RscRespawnControlsMap_ctrlComboLoadout","type_expr":"Control","text":"**uiControl**: Control - list in which item should be disabled/enabled\n\n- BIS_RscRespawnControlsMap_ctrlLocList\n- BIS_RscRespawnControlsMap_ctrlRoleList\n- BIS_RscRespawnControlsMap_ctrlComboLoadout"},{"name":"listboxItem","type":"Number or String","description":"index or name of item in the respawn loadout/role/position listbox","type_expr":"Number | String","text":"**listboxItem**: Number or String - index or name of item in the respawn loadout/role/position listbox"},{"name":"message","type":"String","description":"message shown when disabled item is selected, use \"\" for default message","type_expr":"String","text":"**message**: String - message shown when disabled item is selected, use \"\" for default message"},{"name":"respawnReference","type":"String","description":"reference to respawn position either Marker name or Object var name","type_expr":"String","text":"**respawnReference**: String - reference to respawn position either Marker name or Object var name"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"```sqf\n[\n    \"disable\",\n    uiNamespace getVariable \"BIS_RscRespawnControlsMap_ctrlLocList\",\n    2,\n    \"Restricted for this part of mission!\",\n    myRespawnModule call BIS_fnc_objectVar\n] call BIS_fnc_showRespawnMenuDisableItem;\n```","code":["[\n\t\"disable\",\n\tuiNamespace getVariable \"BIS_RscRespawnControlsMap_ctrlLocList\",\n\t2,\n\t\"Restricted for this part of mission!\",\n\tmyRespawnModule call BIS_fnc_objectVar\n] call BIS_fnc_showRespawnMenuDisableItem;"]}],"see_also":["BIS_fnc_addRespawnInventory","BIS_fnc_addRespawnPosition","Arma 3: Respawn"]},{"name":"BIS_fnc_showRespawnMenuDisableItemCheck","title":"BIS fnc showRespawnMenuDisableItemCheck","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showRespawnMenuDisableItemCheck","revid":309800,"updated":"2022-05-05T12:09:50Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_showRespawnMenuDisableItemDraw","title":"BIS fnc showRespawnMenuDisableItemDraw","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showRespawnMenuDisableItemDraw","revid":309790,"updated":"2022-05-05T12:09:50Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_showRespawnMenuHeader","title":"BIS fnc showRespawnMenuHeader","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showRespawnMenuHeader","revid":309883,"updated":"2022-05-05T12:09:54Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_showRespawnMenuInventory","title":"BIS fnc showRespawnMenuInventory","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showRespawnMenuInventory","revid":309727,"updated":"2022-05-05T12:09:47Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_showRespawnMenuInventoryDetails","title":"BIS fnc showRespawnMenuInventoryDetails","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showRespawnMenuInventoryDetails","revid":309720,"updated":"2022-05-05T12:09:47Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_showRespawnMenuInventoryItems","title":"BIS fnc showRespawnMenuInventoryItems","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showRespawnMenuInventoryItems","revid":309862,"updated":"2022-05-05T12:09:53Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_showRespawnMenuInventoryLimit","title":"BIS fnc showRespawnMenuInventoryLimit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showRespawnMenuInventoryLimit","revid":309863,"updated":"2022-05-05T12:09:53Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_showRespawnMenuInventoryLimitRefresh","title":"BIS fnc showRespawnMenuInventoryLimitRefresh","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showRespawnMenuInventoryLimitRefresh","revid":309895,"updated":"2022-05-05T12:09:54Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_showRespawnMenuInventoryLimitRespawn","title":"BIS fnc showRespawnMenuInventoryLimitRespawn","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showRespawnMenuInventoryLimitRespawn","revid":309846,"updated":"2022-05-05T12:09:52Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_showRespawnMenuInventoryList","title":"BIS fnc showRespawnMenuInventoryList","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showRespawnMenuInventoryList","revid":309810,"updated":"2022-05-05T12:09:51Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_showRespawnMenuInventoryLoadout","title":"BIS fnc showRespawnMenuInventoryLoadout","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showRespawnMenuInventoryLoadout","revid":309891,"updated":"2022-05-05T12:09:54Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_showRespawnMenuInventoryMetadata","title":"BIS fnc showRespawnMenuInventoryMetadata","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showRespawnMenuInventoryMetadata","revid":379509,"updated":"2026-10-31T00:28:14Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Gets or sets inventory menu loadout metadata for class CfgRespawnInventory","syntaxes":[{"syntax":"[\"get\", 0] call BIS_fnc_showRespawnMenuInventoryMetadata","params":[{"name":"String","description":"mode:\n\n- \"set\"\n- \"get\"\n- \"delete\"","type_expr":"String"},{"name":"Number","description":"List box selection for: \"BIS_RscRespawnControlsMap_ctrlRoleList\"","type_expr":"Number"}],"returns":{"type":"Array of Arrays","type_expr":"Array<Array>","description":"- 0: Array - Array containing role data: <(String)DisplayName, (Config)Config, (String)Icon Path> - 1: Array - Array containing loadout data: <(String)Classname, (String)DisplayName, (Config)Config>","text":"Array of Arrays:\n\n- 0: Array - Array containing role data: <(String)DisplayName, (Config)Config, (String)Icon Path>\n- 1: Array - Array containing loadout data: <(String)Classname, (String)DisplayName, (Config)Config>"}}]},{"name":"BIS_fnc_showRespawnMenuPosition","title":"BIS fnc showRespawnMenuPosition","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showRespawnMenuPosition","revid":309710,"updated":"2022-05-05T12:09:46Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_showRespawnMenuPositionList","title":"BIS fnc showRespawnMenuPositionList","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showRespawnMenuPositionList","revid":309884,"updated":"2022-05-05T12:09:54Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_showRespawnMenuPositionMap","title":"BIS fnc showRespawnMenuPositionMap","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showRespawnMenuPositionMap","revid":309829,"updated":"2022-05-05T12:09:51Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_showRespawnMenuPositionMapDraw","title":"BIS fnc showRespawnMenuPositionMapDraw","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showRespawnMenuPositionMapDraw","revid":278822,"updated":"2021-06-13T21:40:35Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"> [!IMPORTANT]\n> Internal function used by the Arma 3: Respawn system.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Respawn"]},{"name":"BIS_fnc_showRespawnMenuPositionMapHandle","title":"BIS fnc showRespawnMenuPositionMapHandle","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showRespawnMenuPositionMapHandle","revid":309714,"updated":"2022-05-05T12:09:47Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_showRespawnMenuPositionMetadata","title":"BIS fnc showRespawnMenuPositionMetadata","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showRespawnMenuPositionMetadata","revid":278712,"updated":"2021-06-13T21:38:59Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"> [!IMPORTANT]\n> Internal function used by the Arma 3: Respawn system.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Respawn"]},{"name":"BIS_fnc_showRespawnMenuPositionName","title":"BIS fnc showRespawnMenuPositionName","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showRespawnMenuPositionName","revid":278659,"updated":"2021-06-13T21:38:20Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"> [!IMPORTANT]\n> Internal function used by the Arma 3: Respawn system.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Respawn"]},{"name":"BIS_fnc_showRespawnMenuPositionRefresh","title":"BIS fnc showRespawnMenuPositionRefresh","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showRespawnMenuPositionRefresh","revid":309887,"updated":"2022-05-05T12:09:54Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_showSubtitle","title":"BIS fnc showSubtitle","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showSubtitle","revid":336362,"updated":"2022-12-29T09:02:33Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","exec":"spawn","description":"Displays a subtitle at the bottom of the screen.\n\n> [!NOTE]\n> If you want to play more subtitles, or want them to be played at a certain time, it might be easier to use BIS_fnc_EXP_camp_playSubtitles.","syntaxes":[{"syntax":"[name, subtitle] spawn BIS_fnc_showSubtitle","params":[{"name":"name","type":"String","description":"name of the speaker","type_expr":"String"},{"name":"subtitle","type":"String","description":"subtitle to display","type_expr":"String"}],"returns":{"type":"Script Handle","type_expr":"Script Handle","description":"script controlling the displayed subtitle."}}],"examples":[{"code":["[\"CROSSROAD\", \"Mission is a go, I repeat, mission is a go, Crossroad, out.\"] spawn BIS_fnc_showSubtitle;"]}],"see_also":["Conversations","BIS_fnc_EXP_camp_playSubtitles"]},{"name":"BIS_fnc_showTime","title":"BIS fnc showTime","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showTime","revid":347907,"updated":"2023-11-02T11:38:15Z","groups":["Environment"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","exec":"spawn","description":"Shows time gap between two dates.","syntaxes":[{"syntax":"[startDate, endDate] spawn BIS_fnc_showTime","params":[{"name":"startDate","type":"Array in date format","type_expr":"Array"},{"name":"endDate","type":"Array in date format","type_expr":"Array"}],"returns":{"type":"Resource Layer"}}],"examples":[{"code":["private _dayStart = date;\n_dayStart set [3, 0]; // set hours to 0\n_dayStart set [4, 0]; // set minutes to 0\n_now = date;\n[_dayStart, _now] spawn BIS_fnc_showTime;"]}],"see_also":["date","BIS_fnc_secondsToString"]},{"name":"BIS_fnc_showUnitInfo","title":"BIS fnc showUnitInfo","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showUnitInfo","revid":327452,"updated":"2022-07-12T22:12:10Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Hides or shows **weapon** information. Also hides *grenades* information.","syntaxes":[{"syntax":"[showUnitInfo] call BIS_fnc_showUnitInfo","params":[{"name":"showUnitInfo","type":"Boolean","description":"true to show weapon information, false to hide it","type_expr":"Boolean"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["false call BIS_fnc_showUnitInfo; // hides weapon information"]}],"see_also":["showHUD","shownHUD"]},{"name":"BIS_fnc_showWelcomeScreen","title":"BIS fnc showWelcomeScreen","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_showWelcomeScreen","revid":348588,"updated":"2023-11-08T13:42:42Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Show welcome screen. Used in the main menu (works fine in Eden Editor).","syntaxes":[{"syntax":"[display, forceLatest] call BIS_fnc_showWelcomeScreen","params":[{"name":"display","type":"Display","description":"parent display where welcome screen is to be shown","type_expr":"Display"},{"name":"forceLatest","type":"Boolean","optional":true,"default":"false","description":"show latest welcome screen automatically","type_expr":"Boolean","text":"forceLatest: Boolean - (Optional, default false) show latest welcome screen automatically"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when screen is opened"}}],"examples":[{"code":["[findDisplay 313, true] call BIS_fnc_showWelcomeScreen;"]}]},{"name":"BIS_fnc_shutdown","title":"BIS fnc shutdown","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_shutdown","revid":309424,"updated":"2022-05-05T12:04:37Z","groups":["Diagnostic"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Shut downs the game.\n\n> [!NOTE]\n> **Arma 3:** this function will only close the game once back to the main menu.","syntaxes":[{"syntax":"call BIS_fnc_shutdown","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_shutdown;"]}]},{"name":"BIS_fnc_sideColor","title":"BIS fnc sideColor","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_sideColor","revid":353604,"updated":"2024-03-19T17:37:26Z","groups":["Sides"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns colour of define side either as Array in format RGBA or the name of the colour as String","syntaxes":[{"syntax":"[side, returnString] call BIS_fnc_sideColor","params":[{"name":"side","type":"Side","type_expr":"Side"},{"name":"returnString","type":"Boolean","optional":true,"default":"false","description":"wanted output:\n\n- false: [R, G ,B, A]\n- true: \"ColourName\"","type_expr":"Boolean","text":"returnString: Boolean - (Optional, default false) wanted output:\n\n- false: [R, G ,B, A]\n- true: \"ColourName\""}],"returns":{"type":"or String or Array format Color (RGBA)","types":["String","Array","Color"]}}],"examples":[{"code":["[blufor, false] call BIS_fnc_sideColor; // returns [0,0.3,0.6,1]"]},{"code":["[blufor, true] call BIS_fnc_sideColor; // returns \"ColorWEST\""]}],"see_also":["side","Arma 3: CfgMarkerColors"]},{"name":"BIS_fnc_sideID","title":"BIS fnc sideID","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_sideID","revid":341625,"updated":"2023-06-12T19:02:21Z","groups":["Sides"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Return config side number.\n\n- 0 = opfor (east)\n- 1 = blufor (west)\n- 2 = independent (resistance)\n- 3 = civilian\n- 4 = sideUnknown\n- 5 = sideEnemy\n- 6 = sideFriendly\n- 7 = sideLogic\n- 8 = sideEmpty\n- 9 = sideAmbientLife","syntaxes":[{"syntax":"testedSide call BIS_fnc_sideID","params":[{"name":"testedSide","type":"Side","description":"the tested side (west, east, etc.)","type_expr":"Side"}],"returns":{"type":"Number","type_expr":"Number"}}],"examples":[{"code":["west call BIS_fnc_sideID; // returns 1"]},{"code":["hint format [\"Your side (%1) ID is %2\", playerSide, playerSide call BIS_fnc_sideID];"]}],"see_also":["BIS_fnc_sideType","side","countSide","CfgVehicles Config Reference","Side","playerSide","west","east","resistance","civilian","sideLogic","sideFriendly","sideEnemy","sideUnknown","sideEmpty","sideAmbientLife","Side Relations"]},{"name":"BIS_fnc_sideIsEnemy","title":"BIS fnc sideIsEnemy","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_sideIsEnemy","revid":349213,"updated":"2023-11-08T14:50:48Z","groups":["Sides"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"Determines if side B is enemy to side A the way the game engine does it. The relationship table can be found here: Side Relations.","syntaxes":[{"syntax":"[sideA, sideB] call BIS_fnc_sideIsEnemy","params":[{"name":"sideA","type":"Side","type_expr":"Side"},{"name":"sideB","type":"Side","type_expr":"Side"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if side B is enemy to side A."}}],"examples":[{"code":["private _isEnemy = [west, east] call BIS_fnc_sideIsEnemy; //Checks if EAST is enemy to WEST."]}],"see_also":["getFriend","setFriend","BIS_fnc_sideIsFriendly","Side Relations"]},{"name":"BIS_fnc_sideIsFriendly","title":"BIS fnc sideIsFriendly","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_sideIsFriendly","revid":349197,"updated":"2023-11-08T14:50:41Z","groups":["Sides"],"status":"ok","games":{"arma3":"1.56"},"since":"arma3 1.56","arma3_since":"1.56","description":"Determines if side B is friendly to side A the way the game engine does it. The relationship table can be found here: Side Relations.","syntaxes":[{"syntax":"[sideA, sideB] call BIS_fnc_sideIsFriendly","params":[{"name":"sideA","type":"Side","type_expr":"Side"},{"name":"sideB","type":"Side","type_expr":"Side"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if side B is friendly to side A."}}],"examples":[{"code":["private _isFriendly = [west, east] call BIS_fnc_sideIsFriendly; //Checks if EAST is friendly to WEST."]}],"see_also":["getFriend","setFriend","BIS_fnc_sideIsEnemy","Side Relations"]},{"name":"BIS_fnc_sideName","title":"BIS fnc sideName","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_sideName","revid":341639,"updated":"2023-06-12T19:02:55Z","groups":["Sides"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns localized side name.\n\n- 0 / opfor (east) = \"OPFOR\"\n- 1 / blufor (west) = \"BLUFOR\"\n- 2 / independent (resistance) = \"Independent\"\n- 3 / civilian = \"Civilian\"\n- 4 / sideUnknown = \"Unknown\"\n- 5 / sideEnemy = \"Enemy\"\n- 6 / sideFriendly = \"Friendly\"\n- 7 / sideLogic = \"Game Logic\"\n- 8 / sideEmpty = \"Empty\"\n- 9 / sideAmbientLife = \"Ambient life\"","syntaxes":[{"syntax":"[input] call BIS_fnc_sideName","params":[{"name":"input","type":"Side or Number","description":"either side or side ID","type_expr":"Side | Number"}],"returns":{"type":"String","type_expr":"String"}}],"examples":[{"code":["[2] call BIS_fnc_sideName;"]},{"code":["[independent] call BIS_fnc_sideName;"]}],"see_also":["side","countSide","Side","playerSide","Side Relations"]},{"name":"BIS_fnc_sideNameUnlocalized","title":"BIS fnc sideNameUnlocalized","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_sideNameUnlocalized","revid":349297,"updated":"2023-11-08T14:52:17Z","groups":["Sides"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns unlocalized side name.","syntaxes":[{"syntax":"input call BIS_fnc_sideNameUnlocalized","params":[{"name":"input","type":"Number or Side","description":"side ID or side","type_expr":"Number | Side"}],"returns":{"type":"String","type_expr":"String","description":"unlocalized name"}}],"examples":[{"code":["west call BIS_fnc_sideNameUnlocalized;//Returns \"WEST\""]},{"code":["0 call BIS_fnc_sideNameUnlocalized;//Returns \"EAST\""]}],"see_also":["side"]},{"name":"BIS_fnc_sideType","title":"BIS fnc sideType","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_sideType","revid":379510,"updated":"2026-10-31T00:28:22Z","groups":["Sides"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns side type based on side ID. See BIS_fnc_sideID for more information.","syntaxes":[{"syntax":"sideID call BIS_fnc_sideType","params":[{"name":"sideID","type":"Number","description":"Side ID.","type_expr":"Number"}],"returns":{"type":"Side","type_expr":"Side","description":"side based on side ID"}}],"examples":[{"code":["0 call BIS_fnc_sideType; // returns EAST"]}],"see_also":["Side","BIS_fnc_sideID","side","countSide","CfgVehicles Config Reference","playerSide","west","east","resistance","civilian","sideLogic","sideFriendly","sideEnemy","sideUnknown","sideEmpty","sideAmbientLife","Side Relations"]},{"name":"BIS_fnc_simpleMoveMarker","title":"BIS fnc simpleMoveMarker","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_simpleMoveMarker","revid":376118,"updated":"2025-08-31T21:15:35Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","locality":{"argument":"global","effect":"global"},"description":"Move the provided marker to a new position. Simple version of BIS_fnc_moveMarker.","syntaxes":[{"syntax":"[marker, newPosition, duration] call BIS_fnc_simpleMoveMarker","params":[{"name":"marker","type":"String","description":"marker to move","type_expr":"String"},{"name":"newPosition","type":"Array","description":"new position, 2D or 3D","type_expr":"Array"},{"name":"duration","type":"Number","optional":true,"default":"5","description":"how long it takes to move the marker in seconds","type_expr":"Number","text":"duration: Number - (Optional, default 5) how long it takes to move the marker in seconds"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"BIS_marker\", [1111,2222, 0]] call BIS_fnc_moveMarker;"]},{"code":["[\"BIS_marker\", getMarkerPos \"BIS_marker2\", 2] call BIS_fnc_simpleMoveMarker;"]}],"see_also":["BIS_fnc_cancelMarker","BIS_fnc_blinkMarker","BIS_fnc_getMarkers","BIS_fnc_rotateMarker","BIS_fnc_resizeMarker","BIS_fnc_moveMarker"]},{"name":"BIS_fnc_simpleObjectData","title":"BIS fnc simpleObjectData","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_simpleObjectData","revid":348543,"updated":"2023-11-08T13:06:09Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.62"},"since":"arma3 1.62","arma3_since":"1.62","description":"Get complete data needed for simple object creation.","syntaxes":[{"syntax":"[classname] call BIS_fnc_simpleObjectData","params":[{"name":"classname","type":"Object or String:","description":"Object or String:\n\n- Object - existing object or simple object that will be scanned; if it is a simple object '_reversed' attribute cannot be retrieved\n- String - Can be either:\n  - Classname of the object; data are retrieved from the config definition.\n  - Path to the p3d; verifies and fixes model path format and returns it in an array (index 1).\n    It has very limited functionality in this mode as no data can actually be retrieved from model path.","type_expr":"Object | String","text":"classname: Object or String:\n\n- Object - existing object or simple object that will be scanned; if it is a simple object '_reversed' attribute cannot be retrieved\n- String - Can be either:\n  - Classname of the object; data are retrieved from the config definition.\n  - Path to the p3d; verifies and fixes model path format and returns it in an array (index 1).\n    It has very limited functionality in this mode as no data can actually be retrieved from model path."}],"returns":{"type":"Array","type_expr":"Array","description":"in format [class, model, reversed, verticalOffset, animationAdjustments, selectionsToHide, verticalOffsetWorld, textures, randomizeAnims, randomizeTexs]:\n- class: String - (Default \"\") class name from CfgVehicles - model: String - (Default \"\") path to the vehicle p3d mode - reversed: Number - (Default 0) reverse value, to fix orientation. 0: no change, 1: reverse - verticalOffset: Array - (Default 0) vertical offset - animationAdjustments: Array - (Default []) animation to animate, every element has this format: [_animationName:string, _animationState:scalar] - hiddenSelections: Array - (Default []) all listed selection will be hidden - verticalOffsetWorld: Number - vertical offset in World coordinates; similar to ASL but refers to object at [0, 0, 0], not its land contacts - textures: Array - textures currently applied to the object - randomizeAnims: Boolean - (Default false) true if vehicle supports randomization through animations - randomizeTexs: Boolean - (Default false) true if vehicle supports randomization of textures > [!NOTE] > Return values can directly be used with BIS_fnc_adjustSimpleObject.","text":"Array in format [class, model, reversed, verticalOffset, animationAdjustments, selectionsToHide, verticalOffsetWorld, textures, randomizeAnims, randomizeTexs]:\n\n- class: String - (Default \"\") class name from CfgVehicles\n- model: String - (Default \"\") path to the vehicle p3d mode\n- reversed: Number - (Default 0) reverse value, to fix orientation. 0: no change, 1: reverse\n- verticalOffset: Array - (Default 0) vertical offset\n- animationAdjustments: Array - (Default []) animation to animate, every element has this format: [_animationName:string, _animationState:scalar]\n- hiddenSelections: Array - (Default []) all listed selection will be hidden\n- verticalOffsetWorld: Number - vertical offset in World coordinates; similar to ASL but refers to object at [0, 0, 0], not its land contacts\n- textures: Array - textures currently applied to the object\n- randomizeAnims: Boolean - (Default false) true if vehicle supports randomization through animations\n- randomizeTexs: Boolean - (Default false) true if vehicle supports randomization of textures\n\n> [!NOTE]\n> Return values can directly be used with BIS_fnc_adjustSimpleObject."}}],"examples":[{"text":"```sqf\n[\"B_Boat_Armed_01_minigun_F\"] call BIS_fnc_simpleObjectData;\n/*\n    [\n        \"B_Boat_Armed_01_minigun_F\",\n        \"A3\\Boat_F\\Boat_Armed_01\\Boat_Armed_01_minigun_F.p3d\",\n        1,\n        3.323,\n        [\n            [\"damagehide\", 0],\n            [\"turret_shake\", 0],\n            [\"turret_shake_aside\", 0],\n            [\"magazine_hide\", 0],\n            [\"mainturret\", 0],\n            [\"damagehideotocvez\", 0],\n            [\"maingun\", 0.09],\n            [\"damagehideotochlaven\", 0],\n            [\"rearturret\", -3.16],\n            [\"reargun\", 0.09],\n            [\"muzzleflash\", 0],\n            [\"zaslehrot\", 79],\n            [\"zasleh2rot\", 600],\n            [\"fuel\", 1],\n            [\"mph\", 0],\n            [\"rpm\", 0],\n            [\"amps_random\", 0],\n            [\"oil_random\", 0],\n            [\"trim_random\", 0],\n            [\"tmp_random\", 0],\n            [\"volt_random\", 0],\n            [\"drivingwheel\", 0],\n            [\"ammobelt_hide\", 0],\n            [\"bullet001_2_hide\", 0.33],\n            [\"bullet002_2_hide\", 0.33],\n            [\"bullet003_2_hide\", 0.33],\n            [\"bullet004_2_hide\", 0.33],\n            [\"bullet005_2_hide\", 0.33],\n            [\"bullet006_2_hide\", 0.33],\n            [\"positionlights\", 0],\n            [\"gun_revolving\", 0.33],\n            [\"muzzleflash2\", 0],\n            [\"reargunner\", 0.09]\n        ],\n        [\"zasleh\", \"p svetlo\", \"zadni svetlo\", \"brzdove svetlo\", \"clan\", \"podsvit pristroju\", \"poskozeni\"],\n        -0.148,\n        [\n            \"\\A3\\boat_f\\Boat_Armed_01\\data\\Boat_Armed_01_ext_co.paa\",\n            \"\\A3\\boat_f\\Boat_Armed_01\\data\\Boat_Armed_01_int_co.paa\",\n            \"\\A3\\boat_f\\Boat_Armed_01\\data\\Boat_Armed_01_crows_blufor_co.paa\"\n        ],\n        false,\n        false\n    ]\n*/\n```","code":["[\"B_Boat_Armed_01_minigun_F\"] call BIS_fnc_simpleObjectData;\n/*\n\t[\n\t\t\"B_Boat_Armed_01_minigun_F\",\n\t\t\"A3\\Boat_F\\Boat_Armed_01\\Boat_Armed_01_minigun_F.p3d\",\n\t\t1,\n\t\t3.323,\n\t\t[\n\t\t\t[\"damagehide\", 0],\n\t\t\t[\"turret_shake\", 0],\n\t\t\t[\"turret_shake_aside\", 0],\n\t\t\t[\"magazine_hide\", 0],\n\t\t\t[\"mainturret\", 0],\n\t\t\t[\"damagehideotocvez\", 0],\n\t\t\t[\"maingun\", 0.09],\n\t\t\t[\"damagehideotochlaven\", 0],\n\t\t\t[\"rearturret\", -3.16],\n\t\t\t[\"reargun\", 0.09],\n\t\t\t[\"muzzleflash\", 0],\n\t\t\t[\"zaslehrot\", 79],\n\t\t\t[\"zasleh2rot\", 600],\n\t\t\t[\"fuel\", 1],\n\t\t\t[\"mph\", 0],\n\t\t\t[\"rpm\", 0],\n\t\t\t[\"amps_random\", 0],\n\t\t\t[\"oil_random\", 0],\n\t\t\t[\"trim_random\", 0],\n\t\t\t[\"tmp_random\", 0],\n\t\t\t[\"volt_random\", 0],\n\t\t\t[\"drivingwheel\", 0],\n\t\t\t[\"ammobelt_hide\", 0],\n\t\t\t[\"bullet001_2_hide\", 0.33],\n\t\t\t[\"bullet002_2_hide\", 0.33],\n\t\t\t[\"bullet003_2_hide\", 0.33],\n\t\t\t[\"bullet004_2_hide\", 0.33],\n\t\t\t[\"bullet005_2_hide\", 0.33],\n\t\t\t[\"bullet006_2_hide\", 0.33],\n\t\t\t[\"positionlights\", 0],\n\t\t\t[\"gun_revolving\", 0.33],\n\t\t\t[\"muzzleflash2\", 0],\n\t\t\t[\"reargunner\", 0.09]\n\t\t],\n\t\t[\"zasleh\", \"p svetlo\", \"zadni svetlo\", \"brzdove svetlo\", \"clan\", \"podsvit pristroju\", \"poskozeni\"],\n\t\t-0.148,\n\t\t[\n\t\t\t\"\\A3\\boat_f\\Boat_Armed_01\\data\\Boat_Armed_01_ext_co.paa\",\n\t\t\t\"\\A3\\boat_f\\Boat_Armed_01\\data\\Boat_Armed_01_int_co.paa\",\n\t\t\t\"\\A3\\boat_f\\Boat_Armed_01\\data\\Boat_Armed_01_crows_blufor_co.paa\"\n\t\t],\n\t\tfalse,\n\t\tfalse\n\t]\n*/"]},{"code":["[BIS_boat] call BIS_fnc_simpleObjectData;"]}],"see_also":["createSimpleObject","BIS_fnc_adjustSimpleObject","BIS_fnc_createSimpleObject"]},{"name":"BIS_fnc_singleMissionConfig","title":"BIS fnc singleMissionConfig","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_singleMissionConfig","revid":379206,"updated":"2026-10-30T21:12:23Z","groups":["Missions"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Returns config of current single mission.","syntaxes":[{"syntax":"call BIS_fnc_singleMissionConfig","params":[],"returns":{"type":"Config or Nothing","type_expr":"Config | Nothing","description":"returns Config if mission was found, otherwise Nothing"}}],"examples":[{"code":["private _config = call BIS_fnc_singleMissionConfig;"]}],"see_also":["missionName","briefingName","BIS_fnc_singleMissionKeys","BIS_fnc_singleMissionName"]},{"name":"BIS_fnc_singleMissionKeys","title":"BIS fnc singleMissionKeys","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_singleMissionKeys","revid":348810,"updated":"2023-11-08T14:38:17Z","groups":["Missions"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Activate mission related keys.","syntaxes":[{"syntax":"call BIS_fnc_singleMissionKeys","params":[],"returns":{"type":"Array","type_expr":"Array","description":"list of activated keys"}}],"examples":[{"code":["private _activatedKeys = call BIS_fnc_singleMissionKeys;"]}],"see_also":["missionName","briefingName"]},{"name":"BIS_fnc_singleMissionName","title":"BIS fnc singleMissionName","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_singleMissionName","revid":327143,"updated":"2022-07-12T21:45:23Z","groups":["Missions"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Returns name of currently selected single mission.","syntaxes":[{"syntax":"call BIS_fnc_singleMissionName","params":[],"returns":{"type":"String","type_expr":"String","description":"the mission name"}}],"examples":[{"code":["private _missionName = call BIS_fnc_singleMissionName;"]}],"see_also":["missionName","briefingName"]},{"name":"BIS_fnc_singleWingSlideDoorClose","title":"BIS fnc singleWingSlideDoorClose","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_singleWingSlideDoorClose","revid":274323,"updated":"2021-06-13T01:20:33Z","groups":["Scripts"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_singleWingSlideDoorClose","params":[],"returns":null}]},{"name":"BIS_fnc_singleWingSlideDoorOpen","title":"BIS fnc singleWingSlideDoorOpen","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_singleWingSlideDoorOpen","revid":274414,"updated":"2021-06-13T01:22:13Z","groups":["Scripts"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_singleWingSlideDoorOpen","params":[],"returns":null}]},{"name":"BIS_fnc_skirmishTrigger","title":"BIS fnc skirmishTrigger","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_skirmishTrigger","revid":309889,"updated":"2022-05-05T12:09:54Z","groups":["Systems"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"An internally used .fsm.","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_slerp","title":"BIS fnc slerp","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_slerp","revid":349205,"updated":"2023-11-08T14:50:44Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Spherical lerp, for correct lerping of normalized direction vectors","syntaxes":[{"syntax":"[currentValue, targetValue, alpha] call BIS_fnc_slerp","params":[{"name":"currentValue","type":"Array","description":"the current value","type_expr":"Array"},{"name":"targetValue","type":"Array","description":"the target value","type_expr":"Array"},{"name":"alpha","type":"Number","description":"the alpha","type_expr":"Number"}],"returns":{"type":"Array","type_expr":"Array","description":"interpolated value"}}],"see_also":["BIS_fnc_clerp","BIS_fnc_lerp","BIS_fnc_lerpVector","BIS_fnc_inverseLerp"]},{"name":"BIS_fnc_smoothStep","title":"BIS fnc smoothStep","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_smoothStep","revid":329343,"updated":"2022-07-27T10:50:10Z","groups":["Interpolation"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Interpolates between 0 and 1 with smoothing at the limits. Formula is `n2 × (3 - 2n)`.","syntaxes":[{"syntax":"number call BIS_fnc_smoothStep","params":[{"name":"number","type":"Number","description":"a number in range 0..1. A value not in range will be floored to 0 or ceiled to 1","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number","description":"interpolation result"}}],"examples":[{"code":["private _smoothedStep = 0.75 call BIS_fnc_smoothStep;"]},{"code":["[0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1.0] apply { _x call BIS_fnc_smoothStep; };\n// returns [0, 0.028, 0.104, 0.216, 0.352, 0.5, 0.648, 0.784, 0.896, 0.972, 1]"]}],"see_also":["BIS_fnc_lerp"]},{"name":"BIS_fnc_sortAlphabetically","title":"BIS fnc sortAlphabetically","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_sortAlphabetically","revid":348643,"updated":"2023-11-08T13:48:23Z","groups":["Arrays","Strings"],"status":"ok","games":{"arma3":"1.10"},"since":"arma3 1.10","arma3_since":"1.10","description":"Alphabetically sort an array of strings without modifying the original. See also sort.","syntaxes":[{"syntax":"arrayOfStrings call BIS_fnc_sortAlphabetically","params":[{"name":"arrayOfStrings","type":"Array of Strings","type_expr":"Array<String>"}],"returns":{"type":"Array of Strings","type_expr":"Array<String>","description":"sorted alphabetically.","text":"Array of Strings sorted alphabetically."}}],"examples":[{"code":["private _sortedNames = [\"John\", \"Jane\", \"Julia\", \"Geronimo\"] call BIS_fnc_sortAlphabetically; // will return [\"Geronimo\", \"Jane\", \"John\", \"Julia\"]"]}],"see_also":["BIS_fnc_sortBy","BIS_fnc_sortNum","sort"]},{"name":"BIS_fnc_sortBy","title":"BIS fnc sortBy","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_sortBy","revid":327964,"updated":"2022-07-13T13:57:43Z","groups":["Arrays"],"status":"ok","games":{"arma3":"0.58"},"since":"arma3 0.58","arma3_since":"0.58","description":"Sorts an array according to given algorithm. See sort for simple sorts.","syntaxes":[{"syntax":"[array, parameters, algorithm, direction, filter] call BIS_fnc_sortBy","params":[{"name":"array","type":"Array","description":"any unsorted array. Can contain any types","type_expr":"Array"},{"name":"parameters","type":"Array","description":"Array\n\n- used in the eval algorithm\n- input params are referenced in the sorting algorithm by _input0..9\n- a maximum of 10 input params is supported (0-9)","type_expr":"Array","text":"parameters: Array\n\n- used in the eval algorithm\n- input params are referenced in the sorting algorithm by _input0..9\n- a maximum of 10 input params is supported (0-9)"},{"name":"algorithm","type":"Code","optional":true,"default":"`{ _x }`","description":"needs to return String, Number or Array - see sort\n- _x refers to array item","type_expr":"Code","text":"algorithm: Code - (Optional, default `{ _x }`)\n\n- needs to return String, Number or Array - see sort\n- _x refers to array item"},{"name":"direction","type":"String","optional":true,"default":"\"ASCEND\"","description":"case-insensitive\n\n- \"ASCEND\" for ascending sorting\n- \"DESCEND\" (or anything else) for descending sorting","type_expr":"String","text":"direction: String - (Optional, default \"ASCEND\") case-insensitive\n\n- \"ASCEND\" for ascending sorting\n- \"DESCEND\" (or anything else) for descending sorting"},{"name":"filter","type":"Code","optional":true,"default":"`{ true }`","description":"code that needs to evaluate true for the array item to be sorted, otherwise item is removed","type_expr":"Code","text":"filter: Code - (Optional, default `{ true }`) code that needs to evaluate true for the array item to be sorted, otherwise item is removed"}],"returns":{"type":"Array","type_expr":"Array","description":"sorted array"}}],"examples":[{"code":["// sort numbers from lowest to highest\n_sortedNumbers = [[1,-80,0,480,15,-40], [], {_x}, \"ASCEND\"] call BIS_fnc_sortBy;"]},{"code":["// sort helicopters by distance from player\n_closestHelicopters = [[_heli1,_heli2,_heli3], [], { player distance _x }, \"ASCEND\"] call BIS_fnc_sortBy;"]},{"code":["// sort enemy by distance from friendly unit (referenced by local variable), the furthest first\n_furtherstEnemy = [[_enemy1,_enemy2,_enemy3], [_friendly], { _input0 distance _x }, \"DESCEND\", { canMove _x }] call BIS_fnc_sortBy;"]}],"see_also":["BIS_fnc_sortAlphabetically","BIS_fnc_sortNum","sort"]},{"name":"BIS_fnc_sortNum","title":"BIS fnc sortNum","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_sortNum","revid":323144,"updated":"2022-06-30T17:02:30Z","groups":["Arrays"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Sorts an array of numbers from lowest (left) to highest (right). The passed array is modified by reference.\nThis function uses the quick sort algorithm.\n\n> [!NOTE]\n> **Arma 3:** If you do not need the return value, use sort instead.","syntaxes":[{"syntax":"array call BIS_fnc_sortNum","params":[{"name":"array","type":"Array of Numbers","type_expr":"Array<Number>"}],"returns":{"type":"Array","type_expr":"Array","description":"sorted array"}}],"examples":[{"code":["[5,9,987,6,97,8,6] call BIS_fnc_sortNum; // returns [5,6,6,8,9,97,987]"]}],"see_also":["sort","BIS_fnc_randomInt","BIS_fnc_geometricMean","BIS_fnc_arithmeticMean","BIS_fnc_nearestNum","BIS_fnc_roundNum"]},{"name":"BIS_fnc_spawn","title":"BIS fnc spawn","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_spawn","revid":327596,"updated":"2022-07-13T09:48:17Z","groups":["Program Flow"],"status":"ok","games":{"arma3":"0.56"},"since":"arma3 0.56","arma3_since":"0.56","exec":"spawn","description":"Execute given code with or without parameter.\n\n> [!NOTE]\n> **Arma 3:** Since Arma 3 v1.50, use remoteExec/remoteExecCall instead.","syntaxes":[{"syntax":"[params, code] spawn BIS_fnc_spawn","params":[{"name":"params","type":"Anything","description":"function arguments","type_expr":"Anything"},{"name":"code","type":"Code","description":"function code","type_expr":"Code"}],"returns":{"type":"Nothing","type_expr":"Nothing"}},{"syntax":"code spawn BIS_fnc_spawn","params":[{"name":"code","type":"Code","type_expr":"Code"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"Show a message for the current player:\n\n```sqf\n[[\"Hello\"],  { hint (_this select 0) }] spawn BIS_fnc_spawn;\n```","code":["[[\"Hello\"],  { hint (_this select 0) }] spawn BIS_fnc_spawn;"]},{"text":"Show a message to all connected players:\n\n```sqf\n[[[\"Hello\"], { hint (_this select 0) }], \"BIS_fnc_spawn\", true, false, false] call BIS_fnc_MP; // obsolete, use remoteExec\n\n[\"Hello\", { hint (_this select 0) }] remoteExec [\"BIS_fnc_spawn\"];    // since the introduction of remoteExec\n[\"Hello\", { hint (_this select 0) }] remoteExec [\"spawn\"];            // BIS_fnc_spawn is obsolete\n[\"Hello\"] remoteExec [\"hint\"];                                        // best solution here\n```","code":["[[[\"Hello\"], { hint (_this select 0) }], \"BIS_fnc_spawn\", true, false, false] call BIS_fnc_MP; // obsolete, use remoteExec\n\n[\"Hello\", { hint (_this select 0) }] remoteExec [\"BIS_fnc_spawn\"];\t// since the introduction of remoteExec\n[\"Hello\", { hint (_this select 0) }] remoteExec [\"spawn\"];\t\t\t// BIS_fnc_spawn is obsolete\n[\"Hello\"] remoteExec [\"hint\"];\t\t\t\t\t\t\t\t\t\t// best solution here"]},{"code":["{ hint \"Hello\" } spawn BIS_fnc_spawn;"]}],"see_also":["remoteExec","remoteExecCall","BIS_fnc_execFSM","BIS_fnc_execRemote","BIS_fnc_execVM","BIS_fnc_call"]},{"name":"BIS_fnc_spawnCrew","title":"BIS fnc spawnCrew","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_spawnCrew","revid":348006,"updated":"2023-11-08T11:22:26Z","groups":["Object Manipulation"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Function to fill all crew positions in a vehicle, including turrets.\nIn dummy mode no objects are created and the returned array contains only ones; this mode can be used to count the actual crew of an existing vehicle or vehicle type (see also crew, fullCrew).","syntaxes":[{"syntax":"[vehicle, group, dummyMode, dummyType, crewType]] call BIS_fnc_spawnCrew","params":[{"name":"vehicle","type":"Object","description":"vehicle","type_expr":"Object"},{"name":"group","type":"Group","description":"crew's group","type_expr":"Group"},{"name":"dummyMode","type":"Boolean","optional":true,"default":"false","description":"true to enable dummy mode","type_expr":"Boolean","text":"dummyMode: Boolean - (Optional, default false) true to enable dummy mode"},{"name":"dummyType","type":"String","optional":true,"default":"\"\"","description":"dummy type","type_expr":"String","text":"dummyType: String - (Optional, default \"\") dummy type"},{"name":"crewType","type":"String","optional":true,"default":"\"\"","description":"crew type","type_expr":"String","text":"crewType: String - (Optional, default \"\") crew type"}],"returns":{"type":"Array or Number","type_expr":"Array | Number","description":"created crew objects or crew count"}}],"examples":[{"code":["[BIS_vehicle, group player] call BIS_fnc_spawnCrew;"]}],"see_also":["crew","fullCrew"],"notes":[{"user":"Tankbuster","date":"2015-02-24T21:52:00Z","text":"This makes FFV units but no cargo crew."}]},{"name":"BIS_fnc_spawnEnemy","title":"BIS fnc spawnEnemy","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_spawnEnemy","revid":337523,"updated":"2023-02-03T22:19:23Z","groups":["Object Manipulation"],"status":"ok","games":{"arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2oa 1.50","arma3_since":"0.50","exec":"spawn","description":"Constantly spawns enemies around a player according to array of enemy classes. The units will try to hunt down the player.","syntaxes":[{"syntax":"[aPlayer, target, side, classes, maxEnemies, delay, code] spawn BIS_fnc_spawnEnemy","params":[{"name":"aPlayer","type":"Object","description":"a unit that is a player","type_expr":"Object"},{"name":"target","type":"Object","description":"reference object (enemies will be spawned on same direction in respect to the player)","type_expr":"Object"},{"name":"side","type":"Side","description":"side of the spawned enemies","type_expr":"Side"},{"name":"classes","type":"Array of Strings","description":"list of enemy classes (units will form a group together)\n\n> [!IMPORTANT]\n> Classes must be of the defined *side*, otherwise they will attack each other.","type_expr":"Array<String>"},{"name":"maxEnemies","type":"Number","optional":true,"default":"10","description":"maximum number of enemies at once","type_expr":"Number","text":"maxEnemies: Number - (Optional, default 10) maximum number of enemies at once"},{"name":"delay","type":"Number","optional":true,"default":"30","description":"time between spawn waves","type_expr":"Number","text":"delay: Number - (Optional, default 30) time between spawn waves"},{"name":"code","type":"Code","optional":true,"default":"{}","description":"code to execute on each unit (referenced by _this)","type_expr":"Code","text":"code: Code - (Optional, default {}) - code to execute on each unit (referenced by _this)"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[player, player, opfor, [\"O_Soldier_F\"]] spawn BIS_fnc_spawnEnemy;"]}],"see_also":["BIS_fnc_spawnGroup","BIS_fnc_stalk"]},{"name":"BIS_fnc_spawnGroup","title":"BIS fnc spawnGroup","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_spawnGroup","revid":379280,"updated":"2026-10-30T23:45:30Z","groups":["Object Manipulation"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Function which handles the spawning of a dynamic group of characters. The composition of the group can be passed to the function.\nAlternatively, a number can be passed and the function will spawn that amount of characters with a random type.\n\n> [!NOTE]\n> **Before Arma 3** a side's Center must have been created before a group may be spawned either by using createCenter or an editor placed (0% Probability of Presence is fine) unit of the appropriate side.","syntaxes":[{"syntax":"[position, side, toSpawn, relPositions, ranks, skillRange, ammoRange, randomControls, azimuth, precisePos, maxVehicles] call BIS_fnc_spawnGroup","params":[{"name":"position","type":"Array format Position","description":"group's starting position","type_expr":"Position","types":["Array","Position"]},{"name":"side","type":"Side","description":"group's side","type_expr":"Side"},{"name":"toSpawn","type":"Array, Number or Config","description":"Array, Number or Config\n\n- Array - list of character types (**only** viable option for the civilian side as no civilian groups are defined in config)\n- Number - amount of characters to spawn\n- Config - CfgGroups entry","type_expr":"Array | Number | Config","text":"toSpawn: Array, Number or Config\n\n- Array - list of character types (**only** viable option for the civilian side as no civilian groups are defined in config)\n- Number - amount of characters to spawn\n- Config - CfgGroups entry"},{"name":"relPositions","type":"Array of Positions","optional":true,"default":"`[]`","description":"a list of relative positions","type_expr":"Array<Position>","text":"relPositions: Array of Positions (Optional, default `[]`) a list of relative positions"},{"name":"ranks","type":"Array of Strings/Numbers","optional":true,"default":"`[]`","description":"ranks (see BIS_fnc_setRank) - **must** be same size as *toSpawn*'s array","type_expr":"Array<String> | Number","text":"ranks: Array of Strings/Numbers - (Optional, default `[]`) ranks (see BIS_fnc_setRank) - **must** be same size as *toSpawn*'s array"},{"name":"skillRange","type":"Array of Numbers","optional":true,"default":"`[]`","description":"skill range format [min, max]","type_expr":"Array<Number>","text":"skillRange: Array of Numbers - (Optional, default `[]`) skill range format [min, max]"},{"name":"ammoRange","type":"Array of Numbers","optional":true,"default":"`[]`","description":"ammunition range (0..1) format [min, max]","type_expr":"Array<Number>","text":"ammoRange: Array of Numbers - (Optional, default `[]`) ammunition range (0..1) format [min, max]"},{"name":"randomControls","type":"Array of Numbers","optional":true,"default":"[-1, 1]","description":"to format [minUnits, chance]:\n\n- minUnits: Number - (Optional, default -1) amount of mandatory units\n- chance: Number - (Optional, default -1) spawn chance for remaining units in range 0..1","type_expr":"Array<Number>","text":"randomControls: Array of Numbers - (Optional, default [-1, 1]) to format [minUnits, chance]:\n\n- minUnits: Number - (Optional, default -1) amount of mandatory units\n- chance: Number - (Optional, default -1) spawn chance for remaining units in range 0..1"},{"name":"azimuth","type":"Number","optional":true,"default":"0","description":"azimuth/direction","type_expr":"Number","text":"azimuth: Number - (Optional, default 0) azimuth/direction"},{"name":"precisePos","type":"Boolean","optional":true,"default":"true","description":"forces precise position placement","type_expr":"Boolean","text":"precisePos: Boolean - (Optional, default true) forces precise position placement"},{"name":"maxVehicles","type":"Number","optional":true,"default":"10e10","description":"vehicle number limit","type_expr":"Number","text":"maxVehicles: Number - (Optional, default 10e10) vehicle number limit"}],"returns":{"type":"Group","type_expr":"Group"}}],"examples":[{"text":"Spawn five random EAST units at aPosition:\n\n```sqf\n[getPosATL aPosition, east, 5] call BIS_fnc_spawnGroup;\n```","code":["[getPosATL aPosition, east, 5] call BIS_fnc_spawnGroup;"]},{"text":"Spawn a Stryker MGS Platoon at marker \"tankSpawn\":\n\n```sqf\n[getMarkerPos \"tankSpawn\", side player, (configFile >> \"CfgGroups\" >> \"West\" >> \"BIS_US\" >> \"Armored\" >> \"US_MGSPlatoon\")] call BIS_fnc_spawnGroup;\n```","code":["[getMarkerPos \"tankSpawn\", side player, (configFile >> \"CfgGroups\" >> \"West\" >> \"BIS_US\" >> \"Armored\" >> \"US_MGSPlatoon\")] call BIS_fnc_spawnGroup;"]},{"text":"Spawn a TK Militia Medic and Soldier at aPos facing south:\n\n```sqf\n[getPos aPos, east, [\"TK_INS_Bonesetter_EP1\", \"TK_INS_Soldier_2_EP1\"],[],[],[],[],[],180] call BIS_fnc_spawnGroup;\n```","code":["[getPos aPos, east, [\"TK_INS_Bonesetter_EP1\", \"TK_INS_Soldier_2_EP1\"],[],[],[],[],[],180] call BIS_fnc_spawnGroup;"]}],"see_also":["Arma 2: CfgVehicles","Arma 3: Assets"],"notes":[{"user":"Snake Plissken","date":"2016-08-23T02:42:00Z","text":"Sides are as follow:\n\n- west/blufor = BLUFOR\n- east/opfor = OPFOR\n- resistance/independent = INDEPENDENT\n- civilian = CIVILIAN.\n\nTo spawn one BLUFOR group (\"MARK1\" is the name given to a map marker):\n\n```sqf\nGroup_Name_Here = [getMarkerPos \"MARK1\", WEST, [\"B_G_Soldier_A_F\", \"B_G_Soldier_F\", \"B_G_Soldier_AR_F\", \"B_G_Soldier_LAT_F\"]] call BIS_fnc_spawnGroup;\n```\n\nOr a random group OPFOR of seven units\n\n```sqf\nGroup_Name_Here = [getMarkerPos \"MARK1\", EAST, 7] call BIS_fnc_spawnGroup;\n```\n\nan independent group:\n\n```sqf\nGroup_Name_Here = [getMarkerPos \"MARK1\", INDEPENDENT, [\"I_G_Soldier_A_F\", \"I_G_Soldier_F\", \"I_G_Soldier_AR_F\", \"I_G_Soldier_LAT_F\"]] call BIS_fnc_spawnGroup;\n```"},{"user":"Cheitan","date":"2017-08-02T19:06:00Z","text":"When using this function for making a dynamic AI spawn, pay attention to the fact that none of the created groups will be marked for auto-deletion when the group become empty (all members dead). It means that it can be very easy to hit the 144 (288 for A3) max groups per side limitation, implying that no more AI or group can be created afterwards. To avoid this issue on Arma 3, don't forget to use deleteGroupWhenEmpty command in your script."}]},{"name":"BIS_fnc_spawnObjects","title":"BIS fnc spawnObjects","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_spawnObjects","revid":378126,"updated":"2026-02-21T14:35:37Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Create a stack of objects at given position or on top of given object (eg. table).","syntaxes":[{"syntax":"[position, className, count, offsetMatrix, offsetDir, dirNoise, enableSimulation] call BIS_fnc_spawnObjects","params":[{"name":"position","type":"Array format PositionASL, or Array as [referenceObject, placement]","description":"Array format PositionASL, or Array as [referenceObject, placement]\n\n- referenceObject: Object\n- placement: String - can be:\n  - \"BOTTOM\" = at the bottom of the object\n  - \"TOP\" = top of the objects boundingbox\n  - \"GROUND\" = sitting just on the ground\n  - \"ROADWAY\" = sitting just on the ground","type_expr":"PositionASL | Array","types":["Array","PositionASL"],"text":"position: Array format PositionASL, or Array as [referenceObject, placement]\n\n- referenceObject: Object\n- placement: String - can be:\n  - \"BOTTOM\" = at the bottom of the object\n  - \"TOP\" = top of the objects boundingbox\n  - \"GROUND\" = sitting just on the ground\n  - \"ROADWAY\" = sitting just on the ground"},{"name":"className","type":"String","description":"class of the object(s) to spawn; all will use the same class","type_expr":"String"},{"name":"count","type":"Number","optional":true,"default":"1","description":"how many objects will be spawned","type_expr":"Number","text":"count: Number - (Optional, default: 1) how many objects will be spawned"},{"name":"offsetMatrix","type":"Array","optional":true,"default":"[0, 0, 0]","description":"starting spawning position offset","type_expr":"Array","text":"offsetMatrix: Array - (Optional, default: [0, 0, 0]) starting spawning position offset"},{"name":"offsetDir","type":"Number","optional":true,"default":"0","description":"starting spawning direction offset","type_expr":"Number","text":"offsetDir: Number - (Optional, default: 0) starting spawning direction offset"},{"name":"dirNoise","type":"Code","optional":true,"default":"{ 0 }","description":"spawned object direction delta from the starting direction, defined as code returning dir delta value","type_expr":"Code","text":"dirNoise: Code - (Optional, default: { 0 }) spawned object direction delta from the starting direction, defined as code returning dir delta value"},{"name":"enableSimulation","type":"Boolean","optional":true,"default":"false","description":"shall the simulation of the spawned objects be enabled or not","type_expr":"Boolean","text":"enableSimulation: Boolean - (Optional, default: false) shall the simulation of the spawned objects be enabled or not"}],"returns":{"type":"Array of created Objects","type_expr":"Array"}}],"examples":[{"code":["private _randomPos = [(random 0.2) -0.1, (random 0.2) -0.1, 0];\n_objects = [[_table, \"TOP\"], \"Box_NATO_Wps_F\", 3, _randomPos, (random 20) - 10] call BIS_fnc_spawnObjects;"]}],"see_also":["createVehicle","createSimpleObject","enableSimulation"]},{"name":"BIS_fnc_spawnOrdered","title":"BIS fnc spawnOrdered","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_spawnOrdered","revid":349081,"updated":"2023-11-08T14:47:23Z","groups":["Program Flow"],"status":"ok","games":{"arma3":"1.96"},"since":"arma3 1.96","arma3_since":"1.96","description":"Spawns given function and executes it in the order it was called in case multiple calls are made. If mutex name is not specified, function name is used.","syntaxes":[{"syntax":"[params, functionName, mutexName] call BIS_fnc_spawnOrdered","params":[{"name":"params","type":"Anything","description":"function parameters","type_expr":"Anything"},{"name":"functionName","type":"String","description":"function name in current namespace","type_expr":"String"},{"name":"mutexName","type":"String","optional":true,"default":"functionName","description":"this is a reference to group of spawns. It's saved in the missionNamespace variable **BIS_fnc_spawnOrdered_mutexName**","type_expr":"String","text":"mutexName: String - (Optional, default functionName) this is a reference to group of spawns. It's saved in the missionNamespace variable **BIS_fnc_spawnOrdered_mutexName**"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"returns false if function name is empty, otherwise true"}}],"examples":[{"code":["myFnc = { diag_log [_this, canSuspend] };\nfor \"_i\" from 0 to 1000 do { [_i, \"myFnc\"] call BIS_fnc_spawnOrdered };"]}],"see_also":["spawn"]},{"name":"BIS_fnc_spawnVehicle","title":"BIS fnc spawnVehicle","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_spawnVehicle","revid":370876,"updated":"2025-02-21T10:44:01Z","groups":["Vehicles"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Function to spawn a certain vehicle type with all crew (including turrets). The vehicle can either become part of an existing group or create a new group.\n\n> [!IMPORTANT]\n> Before **Arma 3** (Arma 2, Take On Helicopters):\n>\n> - a Functions Module **must** be placed in order to use this function\n> - a side's center has to exist (by already having a unit of said side on the map)/be created via createCenter or the vehicle will spawn empty.","syntaxes":[{"syntax":"[position, direction, type, sideOrGroup] call BIS_fnc_spawnVehicle","params":[{"name":"position","type":"Array format Position","description":"desired position","type_expr":"Position","types":["Array","Position"]},{"name":"direction","type":"Number","description":"desired azimuth/direction","type_expr":"Number"},{"name":"type","type":"String","description":"type of the vehicle","type_expr":"String"},{"name":"sideOrGroup","type":"Side or Group","description":"side or existing group","type_expr":"Side | Group"}],"returns":{"type":"Array","type_expr":"Array","description":"format [createdVehicle, crew, group]:\n- createdVehicle: Object - the created vehicle - crew: Array of Objects - the vehicle's crew members - group: Group - created or passed group","text":"Array format [createdVehicle, crew, group]:\n\n- createdVehicle: Object - the created vehicle\n- crew: Array of Objects - the vehicle's crew members\n- group: Group - created or passed group"}}],"examples":[{"code":["[getPos player, 180, \"BMP3\", east] call BIS_fnc_spawnVehicle;"]},{"code":["private _result = [getPos player, 180, \"BMP3\", east] call BIS_fnc_spawnVehicle;\n\nprivate _vehicle = _result select 0;\n_result params [\"_vehicle\", \"_crew\", \"_group\"];"]}],"see_also":["respawnVehicle","createVehicle","createUnit","crew"]},{"name":"BIS_fnc_splitString","title":"BIS fnc splitString","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_splitString","revid":323143,"updated":"2022-06-30T17:01:12Z","groups":["Strings"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Splits given string according to given separator(s).\n\n> [!NOTE]\n> **Arma 3:** See splitString.","syntaxes":[{"syntax":"[stringToSplit, separators, byWord] call BIS_fnc_splitString","params":[{"name":"stringToSplit","type":"String","type_expr":"String"},{"name":"separators","type":"String","optional":true,"default":"\"\"","description":"by default each letter is a separator. If *byWord* is set to true, the separator will be treated as whole word","type_expr":"String","text":"separators: String - (Optional, default \"\") by default each letter is a separator. If *byWord* is set to true, the separator will be treated as whole word"},{"name":"byWord","type":"Boolean","optional":true,"default":"false","description":"by default uses splitString behaviour e.g. each letter is a separator. If set to true, the separator will be treated as whole word","type_expr":"Boolean","text":"byWord: Boolean - (Optional, default false) by default uses splitString behaviour e.g. each letter is a separator. If set to true, the separator will be treated as whole word"}],"returns":{"type":"Array of Strings","type_expr":"Array<String>"}}],"examples":[{"code":["[\"this is a test\", \" \"] call BIS_fnc_splitString; // returns [\"this\", \"is\", \"a\", \"test\"]"]},{"code":["[\"this is a test\", \"st\"] call BIS_fnc_splitString; // returns [\"hi\",\" i\",\" a \",\"e\"]"]},{"code":["[\"this is a test\", \"is\"] call BIS_fnc_splitString; // returns [\"th\",\" \",\" a te\",\"t\"]"]},{"code":["[\"this is a test\", \"is\", true] call BIS_fnc_splitString; // returns [\"th\",\" \",\" a test\"]"]}],"see_also":["splitString","toArray","toString"]},{"name":"BIS_fnc_spotter","title":"BIS fnc spotter","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_spotter","revid":341832,"updated":"2023-06-28T09:26:11Z","groups":["Object Manipulation","Combat"],"status":"ok","games":{"arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2oa 1.50","arma3_since":"0.50","exec":"spawn","description":"Make spotter report target distance to sniper. Will only stop if one of the two units dies.","syntaxes":[{"syntax":"[sniper, spotter] spawn BIS_fnc_spotter","params":[{"name":"sniper","type":"Object","description":"sniper unit","type_expr":"Object"},{"name":"spotter","type":"Object","description":"spotter unit","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[player, spotter] spawn BIS_fnc_spotter;"]}]},{"name":"BIS_fnc_stalk","title":"BIS fnc stalk","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_stalk","revid":327438,"updated":"2022-07-12T22:12:09Z","groups":["Object Manipulation","Combat"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","exec":"spawn","description":"Continuously set WP of one group to a different group to hunt it. It does not change the group's behaviour.\nScript terminates if one of the groups is eliminated or if the optional condition is activated.","syntaxes":[{"syntax":"[stalker, stalked, refresh, radius, endCondition, endDestination] spawn BIS_fnc_stalk","params":[{"name":"stalker","type":"Group","description":"the group that will move towards the other","type_expr":"Group"},{"name":"stalked","type":"Group","description":"the group that will be followed","type_expr":"Group"},{"name":"refresh","type":"Number","optional":true,"default":"10, minimum 5","description":"time between waypoint updates","type_expr":"Number","text":"refresh: Number - (Optional, default 10, minimum 5) time between waypoint updates"},{"name":"radius","type":"Number","optional":true,"default":"0, minimum 0","description":"waypoint \"precision\"","type_expr":"Number","text":"radius: Number - (Optional, default 0, minimum 0) waypoint \"precision\""},{"name":"endCondition","type":"Code","optional":true,"default":"{false}","description":"condition that if true stops *stalker* to follow *stalked*","type_expr":"Code","text":"endCondition: Code - (Optional, default {false}) condition that if true stops *stalker* to follow *stalked*"},{"name":"endDestination","type":"String or Position or Object or Number","optional":true,"default":"0","description":"destination *stalker* will go after *endCondition* is met (or *stalked* is killed)\n\n- String - destination marker name\n- Position - destination\n- Object - destination\n- Number\n  - 0: return to original group waypoints\n  - 1: search around their current stalking position, in a 50m radius\n  - 2: return to the original position before stalking","type_expr":"String | Position | Object | Number","text":"endDestination: String or Position or Object or Number - (Optional, default 0) destination *stalker* will go after *endCondition* is met (or *stalked* is killed)\n\n- String - destination marker name\n- Position - destination\n- Object - destination\n- Number\n  - 0: return to original group waypoints\n  - 1: search around their current stalking position, in a 50m radius\n  - 2: return to the original position before stalking"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when done"}}],"examples":[{"code":["private _stalking = [BIS_grpStalkers, BIS_grpPlayer] spawn BIS_fnc_stalk;"]},{"code":["private _stalking = [grp1, group player, nil, nil, { player distance BIS_Heli < 100 }, \"BIS_mrkRetreatMarker\"] spawn BIS_fnc_stalk;"]},{"code":["private _stalking = [BIS_grpStalkers, BIS_grpPlayer, 20, 10, { BIS_Return }, 1] spawn BIS_fnc_stalk;"]},{"code":["private _stalking = [BIS_grpStalkers, BIS_grpPlayer, 5, 0, { dayTime > 20 }, [3600,600,0]] spawn BIS_fnc_stalk;"]}],"see_also":["BIS_fnc_spawnGroup"]},{"name":"BIS_fnc_startLoadingScreen","title":"BIS fnc startLoadingScreen","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_startLoadingScreen","revid":369455,"updated":"2024-09-06T08:44:52Z","groups":["Systems"],"status":"ok","games":{"arma3":"0.58"},"since":"arma3 0.58","arma3_since":"0.58","description":"Register a loading screen. Start the loading when it is the first one registered.\n\n> [!NOTE]\n> **Arma 3:** The loading screen can be force-ended with the ENDLOAD cheat code.","syntaxes":[{"syntax":"[screenId, layout] call BIS_fnc_startLoadingScreen","params":[{"name":"screenId","type":"String","description":"screen ID, will be used in BIS_fnc_endLoadingScreen","type_expr":"String"},{"name":"layout","type":"String","description":"loading text. *has no effect in Arma 3*","type_expr":"String"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when registered"}}],"examples":[{"code":["[\"myLoadingScreen\", \"Loading… wait for my splendid™ mission!\"] call BIS_fnc_startLoadingScreen;\nuiSleep 3;\n\"myLoadingScreen\" call BIS_fnc_endLoadingScreen;"]}],"see_also":["BIS_fnc_endLoadingScreen","startLoadingScreen","endLoadingScreen"]},{"name":"BIS_fnc_storeParamsValues","title":"BIS fnc storeParamsValues","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_storeParamsValues","revid":352537,"updated":"2024-02-12T16:42:20Z","groups":["Mission Parameters"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"server_exec":true},"description":"Parses mission params and stores them into public variable **\"BIS_fnc_storeParamsValues_data\"**. Use BIS_fnc_getParamValue to retrieve params values from the variable.","syntaxes":[{"syntax":"call BIS_fnc_storeParamsValues","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_storeParamsValues;"]}],"see_also":["Mission Parameters"]},{"name":"BIS_fnc_strategicMapAnimate","title":"BIS fnc strategicMapAnimate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_strategicMapAnimate","revid":349417,"updated":"2023-11-08T16:27:30Z","groups":["Strategic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Animates a Strategic Map.","syntaxes":[{"syntax":"[target,time] spawn BIS_fnc_strategicMapAnimate","params":[{"name":"target","type":"Config or Position","description":"either config path to target group, or absolute position in format [x,y,z] or [x,y]","type_expr":"Config | Position"},{"name":"time","type":"Number","description":"commit time in seconds","type_expr":"Number"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when animation is applied"}}],"examples":[{"code":["[configFile >> \"CfgORBAT\" >> \"BIS\" >> \"B_1_A_1_2\", 5] spawn BIS_fnc_strategicMapAnimate;"]}],"see_also":["ORBAT Viewer","BIS_fnc_ORBATAddGroupOverlay","BIS_fnc_ORBATAnimate","BIS_fnc_ORBATConfigPreview","BIS_fnc_ORBATGetGroupParams","BIS_fnc_ORBATOpen","BIS_fnc_ORBATRemoveGroupOverlay","BIS_fnc_ORBATSetGroupFade","BIS_fnc_ORBATSetGroupParams","BIS_fnc_ORBATTooltip","BIS_fnc_strategicMapMouseButtonClick"]},{"name":"BIS_fnc_strategicMapMouseButtonClick","title":"BIS fnc strategicMapMouseButtonClick","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_strategicMapMouseButtonClick","revid":324833,"updated":"2022-07-01T12:03:12Z","groups":["Strategic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Internal function used by BIS_fnc_strategicMapOpen.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["ORBAT Viewer","BIS_fnc_ORBATAddGroupOverlay","BIS_fnc_ORBATAnimate","BIS_fnc_ORBATConfigPreview","BIS_fnc_ORBATGetGroupParams","BIS_fnc_ORBATOpen","BIS_fnc_ORBATRemoveGroupOverlay","BIS_fnc_ORBATSetGroupFade","BIS_fnc_ORBATSetGroupParams","BIS_fnc_ORBATTooltip","BIS_fnc_strategicMapAnimate"]},{"name":"BIS_fnc_strategicMapOpen","title":"BIS fnc strategicMapOpen","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_strategicMapOpen","revid":376191,"updated":"2025-09-14T12:29:08Z","groups":["Strategic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Creates a strategic map.","syntaxes":[{"syntax":"[display, pos, missions, ORBATs, markers, images, weather, night, scale, simulation, label, missionName, missionIcon] call BIS_fnc_strategicMapOpen","params":[{"name":"display","type":"Display","description":"parent display. When empty, mission display is used.","type_expr":"Display"},{"name":"pos","type":"Array format Position","description":"default view position in format [x,y,y] or [x,y]","type_expr":"Position","types":["Array","Position"]},{"name":"missions","type":"Array","description":"list of missions, each Array in format:\n\n- 0: Position - 2D or 3D position of mission\n- 1: Code - Expression executed when user clicks on mission icon\n- 2: String - Mission name\n- 3: String - Short description\n- 4: String - Name of mission's player\n- 5: String - Path to overview image\n- 6: Number - size multiplier for overview image\n- 7: Array - parameters for on-click action. Can be accessed in code with `_this # 9`","type_expr":"Array"},{"name":"ORBATs","type":"Array","description":"list of ORBAT, each Array in format:\n\n- 0: Array format Position - 2D or 3D position\n- 1: Config - preview CfgORBAT group\n- 2: Config - topmost displayed CfgORBAT group\n- 3: Array of Strings - list of allowed tags\n- 4: String - name of mission's player\n- 5: Number - maximum number of displayed tiers","type_expr":"Array"},{"name":"markers","type":"Array of Strings","description":"list of markers revealed in strategic map (will be hidden when map is closed)","type_expr":"Array<String>"},{"name":"images","type":"Array","description":"list of custom images, each Array in format:\n\n- 0: String - texture path\n- 1: Array format Color (RGBA)\n- 2: Array format Position - image position\n- 3: Number - image width in meters\n- 4: Number - image height in meters\n- 5: Number - image angle in degrees\n- 6: String - text displayed next to the image\n- 7: Boolean - true to show shadow","type_expr":"Array"},{"name":"weather","type":"Number","description":"overcast, from 0 - 1, where 1 means cloudy weather","type_expr":"Number"},{"name":"night","type":"Boolean","description":"true for night version of strategic map (darker with blue tone)","type_expr":"Boolean"},{"name":"scale","type":"Number","description":"default map scale coeficient (1 is automatic scale)","type_expr":"Number"},{"name":"simulation","type":"Boolean]","optional":true,"default":"false true to enable simulation while the map is opened","type_expr":"Boolean","text":"simulation: Boolean] - (Optional, default false true to enable simulation while the map is opened"},{"name":"label","type":"String","optional":true,"default":"\"Select a mission\"","description":"bottom bar action label text","type_expr":"String","text":"label: String - (Optional, default \"Select a mission\") bottom bar action label text"},{"name":"missionName","type":"Boolean","optional":true,"default":"true","description":"true to show icon label as a mission name","type_expr":"Boolean","text":"missionName: Boolean - (Optional, default true) true to show icon label as a mission name"},{"name":"missionIcon","type":"String","optional":true,"default":"\"\\A3\\Ui_f\\data\\Map\\GroupIcons\\badge_rotate_%1_gs.paa\"","description":"path to mission icon texture\n\n- %1 - Animation frame from 0-6 (optional)\n- %2 - Index from 1-9 (optional)","type_expr":"String","text":"missionIcon: String - (Optional, default \"\\A3\\Ui_f\\data\\Map\\GroupIcons\\badge_rotate_%1_gs.paa\") path to mission icon texture\n\n- %1 - Animation frame from 0-6 (optional)\n- %2 - Index from 1-9 (optional)"}],"returns":{"type":"Display","type_expr":"Display","description":"rscDisplayStrategicMap"}}],"examples":[{"text":"```sqf\n[\n    findDisplay 46,\n    [2000,2000,0],\n    [\n        [\n            [2000,2000,0],\n            {systemChat format [\"%1\",name ((_this # 9) # 0)]},\n            \"1st Mission\",\n            \"This is mission one\",\n            \"Name of mission's player\",\n            \"\\A3\\Data_F_Exp\\Logos\\arma3_exp_icon_ca.paa\",\n            1.5,\n            [player]\n        ],\n        [\n            [1000,1000,0],\n            {systemChat format [\"%1\",name ((_this # 9) # 0)]},\n            \"2nd Mission\",\n            \"This is mission two\",\n            \"Name of mission's player\",\n            \"\\A3\\Data_F_Argo\\Logos\\arma3_argo_logoTitle_ca.paa\",\n            1.5,\n            [player]\n        ]\n    ],\n    [\n        [\n            [3000,3000,0],\n            configFile >> \"CfgORBAT\" >> \"BIS\" >> \"B_1_A_1_2\",\n            configFile >> \"CfgORBAT\" >> \"BIS\" >> \"B_1\",\n            [],\n            10\n        ]\n    ],\n    [\n        \"marker_1\",\n        \"marker_2\"\n    ],\n    [\n        [\n            \"\\A3\\Ui_f\\data\\Logos\\arma3_white_ca.paa\",\n            [0,0,0,1],\n            [4000,4000,0],\n            8,\n            8,\n            0,\n            \"Arma 3 Logo\",\n            true\n        ]\n    ],\n    0,\n    false,\n    1,\n    true,\n    \"Strategic Map Example\",\n    false,\n    \"\\A3\\Ui_f\\data\\Logos\\arma3_white_ca.paa\"\n] call BIS_fnc_strategicMapOpen;\n```","code":["[\n\tfindDisplay 46,\n\t[2000,2000,0],\n\t[\n\t\t[\n\t\t\t[2000,2000,0],\n\t\t\t{systemChat format [\"%1\",name ((_this # 9) # 0)]},\n\t\t\t\"1st Mission\",\n\t\t\t\"This is mission one\",\n\t\t\t\"Name of mission's player\",\n\t\t\t\"\\A3\\Data_F_Exp\\Logos\\arma3_exp_icon_ca.paa\",\n\t\t\t1.5,\n\t\t\t[player]\n\t\t],\n\t\t[\n\t\t\t[1000,1000,0],\n\t\t\t{systemChat format [\"%1\",name ((_this # 9) # 0)]},\n\t\t\t\"2nd Mission\",\n\t\t\t\"This is mission two\",\n\t\t\t\"Name of mission's player\",\n\t\t\t\"\\A3\\Data_F_Argo\\Logos\\arma3_argo_logoTitle_ca.paa\",\n\t\t\t1.5,\n\t\t\t[player]\n\t\t]\n\t],\n\t[\n\t\t[\n\t\t\t[3000,3000,0],\n\t\t\tconfigFile >> \"CfgORBAT\" >> \"BIS\" >> \"B_1_A_1_2\",\n\t\t\tconfigFile >> \"CfgORBAT\" >> \"BIS\" >> \"B_1\",\n\t\t\t[],\n\t\t\t10\n\t\t]\n\t],\n\t[\n\t\t\"marker_1\",\n\t\t\"marker_2\"\n\t],\n\t[\n\t\t[\n\t\t\t\"\\A3\\Ui_f\\data\\Logos\\arma3_white_ca.paa\",\n\t\t\t[0,0,0,1],\n\t\t\t[4000,4000,0],\n\t\t\t8,\n\t\t\t8,\n\t\t\t0,\n\t\t\t\"Arma 3 Logo\",\n\t\t\ttrue\n\t\t]\n\t],\n\t0,\n\tfalse,\n\t1,\n\ttrue,\n\t\"Strategic Map Example\",\n\tfalse,\n\t\"\\A3\\Ui_f\\data\\Logos\\arma3_white_ca.paa\"\n] call BIS_fnc_strategicMapOpen;"]}],"see_also":["ORBAT Viewer","BIS_fnc_ORBATAddGroupOverlay","BIS_fnc_ORBATAnimate","BIS_fnc_ORBATConfigPreview","BIS_fnc_ORBATGetGroupParams","BIS_fnc_ORBATOpen","BIS_fnc_ORBATRemoveGroupOverlay","BIS_fnc_ORBATSetGroupFade","BIS_fnc_ORBATSetGroupParams","BIS_fnc_ORBATTooltip","BIS_fnc_strategicMapMouseButtonClick","BIS_fnc_strategicMapAnimate"],"notes":[{"user":"ansin11","date":"2021-03-31T15:29:00Z","text":"In order to use an image from the mission folder, the full path to the image has to be provided:\n\n```sqf\n\"images\\MyImage.jpg\" // Does not work\n([str missionConfigFile, 0, -15] call BIS_fnc_trimString) + \"images\\MyImage.jpg\" // works\n\n// edit: since Arma 3 v1.96 getMissionPath is available\ngetMissionPath \"images\\MyImage.jpg\" // works\n```"},{"user":"Hamster2k","date":"2025-09-11T14:34:57Z","text":"If you want to show the strategic map at the start of the mission by attaching it to the mission display (findDisplay 46;), the mission display needs to be initialized first. You can wait for initialization like this:\n\n```sqf\nwaitUntil { !isNull findDisplay 46 };\n```"},{"user":"Hamster2k","date":"2025-09-12T19:13:07Z","text":"If you are using 3D positions for the positions in your _missions array, be aware that the clickable size of the mission on the map gets reduced the further away from 0 your z coordinate is, becoming unclickable at some point. Use a 2D position like this to avoid that issue:\n\n```sqf\nprivate _position = getPosWorld mission1;\n_position2d = [_position select 0, _position select 1];\n_missions pushBack [\n    _position2d,\n    { /*mission code*/ },\n    \"My mission\",\n    \"My mission description\"\n];\n```"}]},{"name":"BIS_fnc_stringToMarker","title":"BIS fnc stringToMarker","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_stringToMarker","revid":337167,"updated":"2023-01-11T10:52:58Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.92"},"since":"arma3 1.92","arma3_since":"1.92","locality":{"effect":"global"},"description":"Converts serialized data from BIS_fnc_markerToString into a global map marker","syntaxes":[{"syntax":"data call BIS_fnc_stringToMarker","params":[{"name":"data","type":"String","description":"serialized data","type_expr":"String"}],"returns":{"type":"String","type_expr":"String","description":"created global marker"}}],"examples":[{"code":["\"|marker_0|[3799.0110,2781.9880,0.0000]|mil_pickup|ICON|[1,1]|0|Solid|Default|1|You are here\" call BIS_fnc_stringToMarker;"]}],"see_also":["BIS_fnc_markerToString","BIS_fnc_stringToMarkerLocal","BIS_fnc_triggerToMarker","createMarker","createMarkerLocal"],"notes":[{"user":"7erra","date":"2019-05-03T12:16:00Z","text":"The format is the following:\n\n```\n\"|MARKERNAME|markerPos|markerType|markerShape|markerSize|markerDir|markerBrush|markerColor|markerAlpha|markerText\"\n```\n\nThe delimiter for BIS_fnc_stringToMarker is the first character of the string."}]},{"name":"BIS_fnc_stringToMarkerLocal","title":"BIS fnc stringToMarkerLocal","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_stringToMarkerLocal","revid":378264,"updated":"2026-03-26T17:30:17Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.92"},"since":"arma3 1.92","arma3_since":"1.92","locality":{"effect":"local"},"description":"Converts serialized data from BIS_fnc_markerToString into a local map marker.","syntaxes":[{"syntax":"data call BIS_fnc_stringToMarkerLocal","params":[{"name":"data","type":"String","description":"serialized data","type_expr":"String"}],"returns":{"type":"String","type_expr":"String","description":"created local marker"}}],"examples":[{"code":["\"|marker_0|[3799.0110,2781.9880,0.0000]|mil_pickup|ICON|[1,1]|0|Solid|Default|1|You are here\" call BIS_fnc_stringToMarkerLocal;"]}],"see_also":["BIS_fnc_markerToString","BIS_fnc_stringToMarker","BIS_fnc_triggerToMarker","createMarker","createMarkerLocal"],"notes":[{"user":"7erra","date":"2019-05-03T12:17:00Z","text":"The format is the following:\n\n```\n\"|MARKERNAME|markerPos|markerType|markerShape|markerSize|markerDir|markerBrush|markerColor|markerAlpha|markerText\"\n```\n\nThe delimiter for BIS_fnc_stringToMarker is the first character of the string."}]},{"name":"BIS_fnc_subClasses","title":"BIS fnc subClasses","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_subClasses","revid":309886,"updated":"2022-05-05T12:09:54Z","groups":["Configs"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*Same function as BIS_fnc_returnChildren*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_subSelect","title":"BIS fnc subSelect","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_subSelect","revid":327163,"updated":"2022-07-12T22:02:05Z","groups":["Arrays"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Returns a sub-selection of the passed array.","syntaxes":[{"syntax":"[array, start, endOrLength] call BIS_fnc_subSelect","params":[{"name":"array","type":"Array array to select sub array from","type_expr":"Array"},{"name":"start","description":"Number index of array to begin sub-array. **If negative**, index is counted from the end of array","type_expr":"Number","text":"start: Number index of array to begin sub-array. **If negative**, index is counted from the end of array"},{"name":"endOrLength","type":"Number","description":"index of array to end the sub-array. If ommitted, remainder of the array will be selected. **If negative**, it specifies the length of the sub-array (in absolute form)","type_expr":"Number"}],"returns":{"type":"Array","type_expr":"Array"}}],"examples":[{"text":"```sqf\nprivate _array = [\"a\", \"b\", true, 3, 8];\n[_array, 2] call BIS_fnc_subSelect;            // returns [true,3,8]\n```","code":["private _array = [\"a\", \"b\", true, 3, 8];\n[_array, 2] call BIS_fnc_subSelect;\t\t\t// returns [true,3,8]"]},{"text":"```sqf\n[_array, -2] call BIS_fnc_subSelect;            // returns [3,8]\n```","code":["[_array, -2] call BIS_fnc_subSelect;\t\t\t// returns [3,8]"]},{"text":"```sqf\n[_array, 1, 3] call BIS_fnc_subSelect;            // returns [\"b\",true,3]\n```","code":["[_array, 1, 3] call BIS_fnc_subSelect;\t\t\t// returns [\"b\",true,3]"]},{"text":"```sqf\n[_array, 1, -2] call BIS_fnc_subSelect;        // returns [\"b\",true]\n```","code":["[_array, 1, -2] call BIS_fnc_subSelect;\t\t// returns [\"b\",true]"]}],"see_also":["select","count","selectRandom","BIS_fnc_arrayShuffle","BIS_fnc_randomIndex"]},{"name":"BIS_fnc_sunriseSunsetTime","title":"BIS fnc sunriseSunsetTime","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_sunriseSunsetTime","revid":327149,"updated":"2022-07-12T21:45:23Z","groups":["Environment"],"status":"ok","games":{"arma3":"1.58"},"since":"arma3 1.58","arma3_since":"1.58","description":"Calculate sunrise and sunset time.","syntaxes":[{"syntax":"date call BIS_fnc_sunriseSunsetTime","params":[{"name":"date","type":"Array","description":"date in format Date","type_expr":"Array"}],"returns":{"type":"Array of Number","type_expr":"Array<Number>","description":"[sunriseTime, sunsetTime]. Returns special values when the world position is behind the polar cicle: [0,-1] - polar summer (i.e., no sunset), [-1,0] - polar winter (i.e., no sunrise)."}}],"examples":[{"code":["private _sunriseSunsetTime = date call BIS_fnc_sunriseSunsetTime; // get sunrise/sunset time for the current date"]}],"see_also":["sunOrMoon"]},{"name":"BIS_fnc_supplydrop","title":"BIS fnc supplydrop","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_supplydrop","revid":348919,"updated":"2023-11-08T14:44:05Z","groups":["Supports"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","exec":"spawn","description":"Script for para-drop of objects. Spawns waitUntil that handles ground hit (detaching of object from parachute). Used by supplydrop service.","syntaxes":[{"syntax":"[airUnit,class] spawn BIS_fnc_supplydrop","params":[{"name":"airUnit","type":"Object","description":"air Unit","type_expr":"Object"},{"name":"class","type":"String","description":"object class which is dropped, two default values are available:\n\n- \"reammobox\": Drops and ammobox appropriate to airUnit's side\n- \"land\": Drops a car appropriate to airUnit's side","type_expr":"String"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[BIS_airDropVeh, \"reammobox\"] spawn BIS_fnc_supplydrop;"]}],"see_also":["BIS_fnc_supplydropService"]},{"name":"BIS_fnc_supplydropService","title":"BIS fnc supplydropService","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_supplydropService","revid":364335,"updated":"2024-05-06T09:49:36Z","groups":["Supports"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Supply drop service - controls approach and departure of transporting air vehicle and actual cargo drop. Used by Supply drop support request.","syntaxes":[{"syntax":"[param1, param2, param4, param5] call BIS_fnc_supplydropService","params":[{"name":"param1","type":"Object","type_expr":"Object","description":"<object> unit allowed to use the transport system","text":"1: <object> unit allowed to use the transport system","source":"docblock"},{"name":"param2","type":"Object","type_expr":"Object","description":"<object> vehicle providing transport","text":"2: <object> vehicle providing transport","source":"docblock"},{"name":"param4","type":"Array","type_expr":"Array","optional":true,"description":"<array> positions to be cosen by player; accepted strings are \"pickup\" and \"unload\", the second position is defined by the next paramter (OPTIONAL)","text":"4: <array> positions to be cosen by player; accepted strings are \"pickup\" and \"unload\", the second position is defined by the next paramter (OPTIONAL)","source":"docblock"},{"name":"param5","type":"Position","type_expr":"Position","description":"<position> (NEEDED ONLY IF PARAMETER #4 IS USED)","text":"5: <position> (NEEDED ONLY IF PARAMETER #4 IS USED)","source":"docblock"}],"returns":{"text":"N/A","source":"docblock"},"inferred":true}],"docblock":{"text":"File: supplydropService.sqf\n\nDescription:\nSupply drop service - controls approach and departure of transporting air vehicle and actual cargo drop. Used by Supply drop support request.\n\nParameter(s):\n1: <object> unit allowed to use the transport system\n2: <object> vehicle providing transport\n4: <array> positions to be cosen by player; accepted strings are \"pickup\" and \"unload\", the second position is defined by the next paramter (OPTIONAL)\n5: <position> (NEEDED ONLY IF PARAMETER #4 IS USED)\n\nReturns:\nN/A","meta":{"file":"supplydropService.sqf"}},"filled_from_docblock":["description","params","syntax","returns"]},{"name":"BIS_fnc_swapVars","title":"BIS fnc swapVars","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_swapVars","revid":328403,"updated":"2022-07-13T16:00:49Z","groups":["Variables"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Swaps the values of two variables **passed as String**.\nNothing is returned as this function modifies the variables directly.","syntaxes":[{"syntax":"[variableName1, variableName2] call BIS_fnc_swapVars","params":[{"name":"variableName1","type":"String","type_expr":"String"},{"name":"variableName2","type":"String","type_expr":"String"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["private _a = 1;\n_b = 2;\n[\"_a\", \"_b\"] call BIS_fnc_swapVars;\n_a == 2; // true\n_b == 1; // true"]}]},{"name":"BIS_fnc_switchLamp","title":"BIS fnc switchLamp","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_switchLamp","revid":348593,"updated":"2023-11-08T13:44:37Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.64"},"since":"arma3 1.64","arma3_since":"1.64","locality":{"effect":"local"},"description":"Switch streetlamp on/off.","syntaxes":[{"syntax":"[object, state] call BIS_fnc_switchLamp","params":[{"name":"object","type":"Object","description":"street Lamp","type_expr":"Object"},{"name":"state","type":"Boolean","description":"true to turn lamp on, false to turn it off","type_expr":"Boolean"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["// switches all lamps off in a radius of 200m\nprivate _lampsIn200m = nearestObjects [player, [\"Lamps_base_F\", \"PowerLines_base_F\", \"PowerLines_Small_base_F\"], 200];\n{ [_x, false] call BIS_fnc_switchLamp; } forEach _lampsIn200m;"]},{"text":"```sqf\n// simulates a damaged street light\naLamp spawn {\n    params [\n        [\"_lamp\", objNull, [objNull]]\n    ];\n    while { player distance _lamp < 200 } do\n    {\n        [_lamp, selectRandom [true, false]] call BIS_fnc_switchLamp;\n        sleep 0.1 + random 0.5;\n    };\n};\n```","code":["// simulates a damaged street light\naLamp spawn {\n\tparams [\n\t\t[\"_lamp\", objNull, [objNull]]\n\t];\n\twhile { player distance _lamp < 200 } do\n\t{\n\t\t[_lamp, selectRandom [true, false]] call BIS_fnc_switchLamp;\n\t\tsleep 0.1 + random 0.5;\n\t};\n};"]}],"see_also":["switchLight"]},{"name":"BIS_fnc_synchronizedObjects","title":"BIS fnc synchronizedObjects","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_synchronizedObjects","revid":379511,"updated":"2026-10-31T00:28:30Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Get all objects of given type directly synchronised to the given object. Works in Eden Editor too.","syntaxes":[{"syntax":"[object, filter, preciseMatch] call BIS_fnc_synchronizedObjects","params":[{"name":"object","type":"Object","description":"parent object","type_expr":"Object"},{"name":"filter","type":"String or Array of Strings","description":"class name filter; 1 or more class name of objects in which we are interested","type_expr":"String | Array<String>"},{"name":"preciseMatch","type":"Boolean","optional":true,"default":"true","description":"if true only precise class names are considered, if false inheritance is considered","type_expr":"Boolean","text":"preciseMatch: Boolean - (Optional, default true) if true only precise class names are considered, if false inheritance is considered"}],"returns":{"type":"Array of synchronised objects","type_expr":"Array"}}],"examples":[{"code":["[BIS_Poliakko, \"LocationArea_F\"] call BIS_fnc_synchronizedObjects;"]}],"see_also":["BIS_fnc_allSynchronizedObjects"]},{"name":"BIS_fnc_synchronizedObjectsQueue","title":"BIS fnc synchronizedObjectsQueue","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_synchronizedObjectsQueue","revid":286024,"updated":"2021-06-20T17:24:26Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Return sequence of all synchronized objects forming either line or circle.","syntaxes":[{"syntax":"[] call BIS_fnc_synchronizedObjectsQueue","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"starting object","text":"0: OBJECT - starting object","source":"docblock"},{"name":"param1","type":"String, Array","type_expr":"String | Array<String>","optional":true,"description":"object types that are considered","text":"1: STRING or ARRAY of STRINGs (Optional) - object types that are considered","source":"docblock"},{"name":"param2","type":"Boolean","type_expr":"Boolean","optional":true,"description":"class filter uses exact match\ntrue (default): objects need to match exectly one of the filter classes\nfalse: exact match is not required, objects can inherit from one of the listed classes","text":"2: BOOL (Optional) - class filter uses exact match\ntrue (default): objects need to match exectly one of the filter classes\nfalse: exact match is not required, objects can inherit from one of the listed classes","source":"docblock"},{"name":"param3","type":"Number","type_expr":"Number","optional":true,"description":"expected connection shape\n0 (default): none, can be either line or circle\n1: line expected\n2: circle expected","text":"3: NUMBER (Optional) - expected connection shape\n0 (default): none, can be either line or circle\n1: line expected\n2: circle expected","source":"docblock"}],"returns":{"type":"Array, Object","type_expr":"Array<Object> | Array","text":"ARRAY of OBJECTs or empty ARRAY if error is encountered\n\nErrors:\n     There are more then 2 objects matching class filter connected.\n     Circle is required but closing connection is not detected.","source":"docblock"}}],"examples":[{"code":["[_start,[\"ModuleToWAreaVertex_F\",\"ModuleToWAreaOptions_F\"],true,0] call BIS_fnc_synchronizedObjectsQueue;"]}],"docblock":{"text":"Author: Jiri Wainar\n\nDescription:\nReturn sequence of all synchronized objects forming either line or circle.\n\nParameter(s):\n    0: OBJECT - starting object\n    1: STRING or ARRAY of STRINGs (Optional) - object types that are considered\n    2: BOOL (Optional) - class filter uses exact match\n        true (default): objects need to match exectly one of the filter classes\n        false: exact match is not required, objects can inherit from one of the listed classes\n    3: NUMBER (Optional) - expected connection shape\n        0 (default): none, can be either line or circle\n        1: line expected\n        2: circle expected\n\nReturns:\nARRAY of OBJECTs or empty ARRAY if error is encountered\n\nErrors:\n     There are more then 2 objects matching class filter connected.\n     Circle is required but closing connection is not detected.\n\nExample:\n[_start,[\"ModuleToWAreaVertex_F\",\"ModuleToWAreaOptions_F\"],true,0] call BIS_fnc_synchronizedObjectsQueue;","author":"Jiri Wainar"},"filled_from_docblock":["description","params","returns","examples"]},{"name":"BIS_fnc_target","title":"BIS fnc target","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_target","revid":337301,"updated":"2023-01-13T10:27:53Z","groups":["Interaction"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Handles the shooting targets in the Bootcamp DLC, statistics, animation, etc. (targets such as `TargetBootcampHuman_f`)\n\n**Action/Parameter Table**\n\n| Action (String) | Parameters (Array) arguments |\n|---|---|\n| **initialize**<br>Initializes the target and sets it to the \"up\" position | - target: Object - Target object of type \"TargetBootcamp_base_F\" |\n| **terminate**<br>Doesn't do anything | N/A |\n| **animate**<br>Animate the object to the given position (\"up\" or \"down\") | - target: Object - Target object of type \"TargetBootcamp_base_F\"<br>- position: String - \"up\" or \"down\" (default) |\n| **getAnimationPhase**<br>**Return Value:** Number - 0 (up) or 1 (down) depending on current state | - target: Object - Target object of type \"TargetBootcamp_base_F\" |\n| **getAnimationPhaseString**<br>**Return Value:** String - \"up\" or \"down\" depending on current state | - target: Object - Target object of type \"TargetBootcamp_base_F\" |\n| **getAnimatedSelection**<br>**Return Value:** String - the name of the \"animatedSelection\" from object config | - target: Object - Target object of type \"TargetBootcamp_base_F\" |\n| **hit**<br>Handles the hit event to animate the target down and up again | - target: Object - Target object of type \"TargetBootcamp_base_F\"<br>- unit: Object - Unit which shot the target<br>- damage: Number - Amount of damage done to the target |\n| **hitPart**<br>Handles the hit event and stores the data | - partsList: Array - Contains list of all parts which got hit (see HitPart EH format) to format [target, shooter]:<br>  - target: Object - Target object of type 'TargetBootcamp_base_F'<br>  - shooter: Object - Unit which shot the target |\n| **getShooterDataIndex**<br>**Return Value:** Number - index from Shooter Data for specific unit | - target: Object - Target object of type \"TargetBootcamp_base_F\"<br>- uid: String - Player UID of unit who shot the target |\n| **getShooterData**<br>**Return Value:** Array - all data from Shooter Data for specific unit<br>Format: `[[\"uid\", \"\"], [\"name\", \"\"], [\"shots\", [[[\"time\", 0], [\"distance\", 0], [\"weapon\", \"\"], [\"direct\", 0]]]]]` | - target: Object - Target object of type \"TargetBootcamp_base_F\"<br>- uid: String - Player UID of unit who shot the target |\n| **setShooterData**<br>Set Shooter Data for specific unit | - target: Object - Target object of type \"TargetBootcamp_base_F\"<br>- uid: String - Player UID of unit who shot the target<br>- data: Array - Shooter Data |\n| **getShotsData**<br>**Return Value:** Array - Shots Data for specific unit | - target: Object - Target object of type \"TargetBootcamp_base_F\"<br>- uid: String - Player UID of unit who shot the target |\n| **getShotsDataFromTargets**<br>**Return Value:** Number - total amount of shots hit | - targets: Array of Object - List of target objects of type \"TargetBootcamp_base_F\"<br>- uid: String - Player UID of unit who shot the target |\n| **getShotsDataWithFilter**<br>**Return Value:** Array - Shot Data after custom filter | - target: Object - Target object of type \"TargetBootcamp_base_F\"<br>- uid: String - Player UID of unit who shot the target<br>- filter: String - One of \"time\", \"distance\", \"weapon\" or \"direct\"<br>- code: Code - Custom code to validate the shot. _this is the value of filtered data |\n| **setShotsData**<br>Set Shots Data for specific unit | - target: Object - Target object of type \"TargetBootcamp_base_F\"<br>- uid: String - Player UID of unit who shot the target<br>- data: Array - Shots Data |\n| **getShootersData**<br>**Return Value:** Array - full Shooters Data | - target: Object - Target object of type \"TargetBootcamp_base_F\" |\n| **setShootersData**<br>Set full Shooters Data | - target: Object - Target object of type \"TargetBootcamp_base_F\"<br>- data: Array - Shooter Data |\n| **resetShootersData**<br>Remove all data from Shooters Data array | - target: Object - Target object of type \"TargetBootcamp_base_F\" |\n| **getShooterTemplate**<br>**Return Value:** Array - template for Shooter Data | - target: Object - Target object of type \"TargetBootcamp_base_F\"<br>- uid: String - Player UID of unit who shot the target |\n| **getShotTemplate**<br>**Return Value:** Array - template for Shot Data (see HitPart EH format) | - target: Object - Target object of type \"TargetBootcamp_base_F\"<br>- shooter: Object - Unit who shot the target<br>- projectile: Object - (\"_bullet\" not used)<br>- position: Array format Position - (\"_position\" not used)<br>- velocity: Array - (\"_velocity\" not used)<br>- selection: Array - (\"_selection\" not used)<br>- ammo: Array - (\"_ammo\" not used)<br>- vector: Array - (\"_direction\" not used)<br>- radius: Array - (\"_radius\" not used)<br>- surfaceType: String - (\"_surface\" not used)<br>- isDirect: Boolean - true if object was directly hit, false if it was hit by indirect/splash damage. |\n| **getShooterByUid**<br>**Return Value:** Object - corresponding shooter unit | - uid: String - Player UID of unit who shot the target |\n| **uiOpen**<br>Opens the Target Board display | - target: Object - Target object of type \"TargetBootcamp_base_F\" |\n| **uiOpenToAll**<br>Opens the Target Board display for all connected players | - target: Object - Target object of type \"TargetBootcamp_base_F\" |\n| **uiOnLoad**<br>Triggered when display is opened (internal) | - display: Display |\n| **uiFillTable**<br>Triggered when display is opened, fills UI with Shooters Data (internal) | - target: Object - Target object of type \"TargetBootcamp_base_F\"<br>- control: Control - \"_listBox\" |\n| **uiFillTableRow**<br>Triggered when display is opened, fills UI with Shooter Data (internal) | - target: Object - Target object of type \"TargetBootcamp_base_F\"<br>- control: Control - \"_listBox\"<br>- data: Array - Shooter Data |","syntaxes":[{"syntax":"[action, parameters] call BIS_fnc_target","params":[{"name":"action","type":"String","type_expr":"String"},{"name":"parameters","type":"Array","type_expr":"Array"}],"returns":{"type":"See above table"}}],"examples":[{"code":["// open the Score Board\n[\"uiOpen\", [myTarget]] call BIS_fnc_target;"]},{"code":["// open the Score Board for all players in MP\n[\"uiOpenToAll\", [myTarget]] call BIS_fnc_target;"]},{"code":["// clear all data from Score Board\n[\"resetShootersData\", [myTarget]] call BIS_fnc_target;"]}],"see_also":["doTarget"]},{"name":"BIS_fnc_taskAlwaysVisible","title":"BIS fnc taskAlwaysVisible","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_taskAlwaysVisible","revid":352047,"updated":"2024-02-01T23:24:30Z","groups":["Tasks"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"global"},"description":"Returns true if task is forced to be always visible (default: false).\n\n> [!NOTE]\n> See Arma 3: Task Framework for more information.","syntaxes":[{"syntax":"taskID call BIS_fnc_taskAlwaysVisible","params":[{"name":"taskID","type":"String","description":"ID of the task","type_expr":"String"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"returns true if forced visible, otherwise false"}}],"examples":[{"code":["private _isForcedVisible = \"task_1\" call BIS_fnc_taskAlwaysVisible;"]}],"see_also":["Arma 3: Task Framework"]},{"name":"BIS_fnc_taskAttack","title":"BIS fnc taskAttack","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_taskAttack","revid":327472,"updated":"2022-07-12T22:12:11Z","groups":["Tasks"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"This function adds a Seek and Destroy waypoint on defined position to the group and set its behaviour to \"AWARE\". If the group has other waypoints, the waypoint will be added at the end of the list.","syntaxes":[{"syntax":"[group, position] call BIS_fnc_taskAttack","params":[{"name":"group","type":"Group","type_expr":"Group"},{"name":"position","type":"Position","type_expr":"Position"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[opforGroup, getPosATL player] call BIS_fnc_taskAttack;"]}],"see_also":["addWaypoint","Waypoints","behaviour","BIS_fnc_taskDefend","BIS_fnc_taskPatrol"]},{"name":"BIS_fnc_taskChildren","title":"BIS fnc taskChildren","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_taskChildren","revid":353700,"updated":"2024-03-21T17:10:39Z","groups":["Tasks"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"global","effect":"global"},"description":"Return a task's sub-tasks.\n\n> [!NOTE]\n> See Arma 3: Task Framework for more information.","syntaxes":[{"syntax":"taskID call BIS_fnc_taskChildren","params":[{"name":"taskID","type":"String","description":"ID of the task","type_expr":"String"}],"returns":{"type":"Array or Object","type_expr":"Array | Object","description":"array with sub tasks or objNull if parent task ID does not exist"}}],"examples":[{"code":["\"task_1\" call BIS_fnc_taskChildren;"]}],"see_also":["Arma 3: Task Framework"]},{"name":"BIS_fnc_taskCompleted","title":"BIS fnc taskCompleted","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_taskCompleted","revid":352054,"updated":"2024-02-01T23:24:34Z","groups":["Tasks"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"global","effect":"global"},"description":"Checks if task is completed.\n\n> [!NOTE]\n> See Arma 3: Task Framework for more information.","syntaxes":[{"syntax":"taskID call BIS_fnc_taskCompleted","params":[{"name":"taskID","type":"String","description":"ID or name of the task","type_expr":"String"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"returns true if task state is either \"SUCCEEDED\", \"FAILED\" or \"CANCELED\". Returns false for all other states and if task does not exist"}}],"examples":[{"code":["private _completed = \"task_1\" call BIS_fnc_taskCompleted;"]}],"see_also":["Arma 3: Task Framework"]},{"name":"BIS_fnc_taskCreate","title":"BIS fnc taskCreate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_taskCreate","revid":379281,"updated":"2026-10-30T23:45:37Z","groups":["Tasks"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"global","effect":"global"},"description":"Create a task.","syntaxes":[{"syntax":"[owner, taskID, description, destination, state, priority, showNotification, type, visibleIn3D] call BIS_fnc_taskCreate","params":[{"name":"owner","type":"Boolean, Object, Group, Side or Array","description":"Task owner(s)\n\n- Boolean - true to set task of all playable units\n- Object - set task of a specific object\n- Group - set tasks of all objects in the group\n- Side - set tasks of all objects of the given side\n- Array - collection of above types","type_expr":"Boolean | Object | Group | Side | Array","text":"**owner**: Boolean, Object, Group, Side or Array - Task owner(s)\n\n- Boolean - true to set task of all playable units\n- Object - set task of a specific object\n- Group - set tasks of all objects in the group\n- Side - set tasks of all objects of the given side\n- Array - collection of above types"},{"name":"taskID","type":"String or Array","description":"String or Array\n\n- String - Task ID\n- Array - In the format of [task ID, parent task ID]","type_expr":"String | Array","text":"**taskID**: String or Array\n\n- String - Task ID\n- Array - In the format of [task ID, parent task ID]"},{"name":"description","type":"Array or String","description":"Array or String\n\n- Array - Task description in the format [\"description\", \"title\", \"marker\"] - \"marker\" is depreciated, functionally does nothing\n  - Description and Title can also be a format array [ \"Text\", var1, var2, ... ] where Text will be localized and then formatted per client, see Example 4\n- String - CfgTaskDescriptions class name, if empty string is used then CfgTaskDescriptions is searched for a class matching the tasks TaskID","type_expr":"Array | String","text":"**description**: Array or String\n\n- Array - Task description in the format [\"description\", \"title\", \"marker\"] - \"marker\" is depreciated, functionally does nothing\n  - Description and Title can also be a format array [ \"Text\", var1, var2, ... ] where Text will be localized and then formatted per client, see Example 4\n- String - CfgTaskDescriptions class name, if empty string is used then CfgTaskDescriptions is searched for a class matching the tasks TaskID"},{"name":"destination","optional":true,"description":"Task destination\n\n- Object - Use objNull to set no position\n- Array - can be one of:\n  - format Position\n  - [target, precision] (as used by setSimpleTaskTarget)\n    - target: Object\n    - precision: Boolean - false to use *owner*'s knowledge of *target*, true to force display even if *target* is unknown to *owner*","type_expr":"Object | Array","text":"**destination** (Optional): Task destination\n\n- Object - Use objNull to set no position\n- Array - can be one of:\n  - format Position\n  - [target, precision] (as used by setSimpleTaskTarget)\n    - target: Object\n    - precision: Boolean - false to use *owner*'s knowledge of *target*, true to force display even if *target* is unknown to *owner*"},{"name":"state","type":"String, Boolean or Number","optional":true,"default":"\"CREATED\"","description":"task state. Can be:\n\n- String - can be one of following:\n  - \"CREATED\"\n  - \"ASSIGNED\"\n  - \"AUTOASSIGNED\" (\"ASSIGNED\" when no task is assigned yet, otherwise \"CREATED\")\n  - \"SUCCEEDED\"\n  - \"FAILED\"\n  - \"CANCELED\"\n- Boolean - true to set the task as current\n- Number\n  - 0 or less for false\n  - > 0 as true","type_expr":"String | Boolean | Number","text":"**state**: String, Boolean or Number - (Optional, default \"CREATED\") task state. Can be:\n\n- String - can be one of following:\n  - \"CREATED\"\n  - \"ASSIGNED\"\n  - \"AUTOASSIGNED\" (\"ASSIGNED\" when no task is assigned yet, otherwise \"CREATED\")\n  - \"SUCCEEDED\"\n  - \"FAILED\"\n  - \"CANCELED\"\n- Boolean - true to set the task as current\n- Number\n  - 0 or less for false\n  - > 0 as true"},{"name":"priority","type":"Number","optional":true,"description":"priority. When the current task is completed, the system selects the one with the largest priority >= 0. To avoid auto assignment of that task, give it a priority of -1.","type_expr":"Number","text":"**priority**: Number - (Optional) priority. When the current task is completed, the system selects the one with the largest priority >= 0. To avoid auto assignment of that task, give it a priority of -1."},{"name":"showNotification","type":"Boolean","optional":true,"default":"true","description":"true to show notification, false to disable it","type_expr":"Boolean","text":"**showNotification**: Boolean - (Optional, default true) true to show notification, false to disable it"},{"name":"type","type":"String","optional":true,"default":"\"\"","description":"vanilla or custom task type; if not defined, empty (no) type is used","type_expr":"String","text":"**type**: String - (Optional, default \"\") vanilla or custom task type; if not defined, empty (no) type is used"},{"name":"visibleIn3D","type":"Boolean","optional":true,"default":"false","description":"true to make task always visible in 3D","type_expr":"Boolean","text":"**visibleIn3D**: Boolean - (Optional, default false) true to make task always visible in 3D"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[civilian, \"task1\", [\"Do this and you get a cookie\", \"Earn Cookie\", \"cookiemarker\"], [0,0,0], \"ASSIGNED\", 2, true] call BIS_fnc_taskCreate;"]},{"code":["[west, \"parentTask\", [\"This is the parent task.\", \"Parent task\", \"cookiemarker2\"], objNull, 1, 3, true] call BIS_fnc_taskCreate;\n[west, [\"subTask\", \"parentTask\"], [\"This is the subTask.\", \"subTask\", \"cookiemarker2\"], objNull, 1, 3, true] call BIS_fnc_taskCreate;"]},{"text":"in Description.ext\n\n```cpp\nclass CfgTaskTypes\n{\n    class my_CfgTaskType\n    {\n        displayname = \"Tank\";\n        icon = \"Tank_MCO.paa\";\n        icon3D = \"Tank_MCO.paa\";\n    };\n};\n```\n\nSQF:\n\n```sqf\n[east, [\"taskType_\"], [\"Setting taskType\", \"The simple way\", \"marker2\"], objNull, 1, 3, true, \"my_CfgTaskType\"] call BIS_fnc_taskCreate; // task with a custom icon\n```","code":["[east, [\"taskType_\"], [\"Setting taskType\", \"The simple way\", \"marker2\"], objNull, 1, 3, true, \"my_CfgTaskType\"] call BIS_fnc_taskCreate; // task with a custom icon"]},{"text":"in Stringtable.xml\n\n```xml\n<Key ID=\"STR_CITY_TASK\">\n    <English>Clear %1 of enemies</English>\n    <!-- more languages -->\n</Key>\n```\n\nSQF:\n\n```sqf\n[\n    _side,\n    _taskID,\n    [\n        // format array, string to be localised, parameters for format %1, %2 ...\n        [ \"STR_CITY_TASK\", _cityName ],\n        [ \"STR_CITY_TASK\", _cityName ],\n        \"\"\n    ]\n] call BIS_fnc_taskCreate;\n```","code":["[\n\t_side,\n\t_taskID,\n\t[\n\t\t// format array, string to be localised, parameters for format %1, %2 ...\n\t\t[ \"STR_CITY_TASK\", _cityName ],\n\t\t[ \"STR_CITY_TASK\", _cityName ],\n\t\t\"\"\n\t]\n] call BIS_fnc_taskCreate;"]}],"see_also":["Arma 3: Task Framework"],"notes":[{"user":"Lou Montana","date":"2018-02-02T13:15:00Z","text":"You can define a CfgTaskDescriptions part in description.ext, such as:\n\n```cpp\nclass CfgTaskDescriptions\n{\n    class myTask\n    {\n        title = \"$STR_MyTaskTitle\";\n        description = \"$STR_MyTaskDescription\";\n    };\n};\n```\n\nThis should allow tasks to be localised for every player in MP **if created locally**.\nYou can use \"myTask\" as *description* (3rd) parameter.\n\n> [!IMPORTANT]\n> For a proper localisation everywhere, see Hypoxic125's note below."},{"user":"Hypoxic125","date":"2022-11-13T04:13:19Z","text":"Example of Correct Localization Setup Using CfgTaskDescriptions\n\n```cpp\nclass CfgTaskDescriptions\n{\n    class hyp_infiltrate\n    {\n        title = \"STR_HYP_TASKS_INFILTRATE_TITLE\";\n        description = \"STR_HYP_TASKS_INFILTRATE_DESCRIPTION\";\n        // requires stringtable key - NOT localized string\n        // note the lack of \"$\" before the stringtable key - if \"$\" is included, languages will be incorrect\n    };\n};\n```\n\n```sqf\n// Server Execution\n[east, \"infiltrate\", \"hyp_infiltrate\", objNull, \"ASSIGNED\", -1, true, \"MOVE\", false] call BIS_fnc_taskCreate;\n```"}]},{"name":"BIS_fnc_taskCurrent","title":"BIS fnc taskCurrent","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_taskCurrent","revid":352232,"updated":"2024-02-01T23:26:09Z","groups":["Tasks"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"global","effect":"global"},"description":"Returns unit's current task.\n\n> [!NOTE]\n> See Arma 3: Task Framework for more information.","syntaxes":[{"syntax":"unit call BIS_fnc_taskCurrent","params":[{"name":"unit","type":"Object","description":"unit to be checked","type_expr":"Object"}],"returns":{"type":"String","type_expr":"String","description":"task ID"}}],"examples":[{"code":["private _currentTask = player call BIS_fnc_taskCurrent;"]}],"see_also":["Arma 3: Task Framework"]},{"name":"BIS_fnc_taskDefend","title":"BIS fnc taskDefend","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_taskDefend","revid":325114,"updated":"2022-07-01T12:28:08Z","groups":["Tasks"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Group will man nearby static defenses within a 100 metre radius of the defense position and guard the position. Some units will man weapons, others will patrol and the remainder will sit on the ground.","syntaxes":[{"syntax":"[group, position] call BIS_fnc_taskDefend","params":[{"name":"group","type":"Group","type_expr":"Group"},{"name":"position","type":"Array in format Position","type_expr":"Position","types":["Array","Position"]}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[group player, getPosATL leader player] call BIS_fnc_taskDefend;"]}],"see_also":["Functions Library","BIS_fnc_taskAttack","BIS_fnc_taskPatrol"],"notes":[{"user":"Preacher","date":"2009-12-20T12:00:00Z","text":"The easiest way to use this function is to create a group, then add the following code to the group leader's init field:\n\n```sqf\n[group this, getPosATL this] call BIS_fnc_taskDefend;\n```"},{"user":"McHide","date":"2009-12-09T01:59:00Z","text":"The **more correct way** is to:\n\n1. Place function module on map (Arma 2 only)\n1. Make one waypoint for group and put this code in Waypoints On.Act. field\n\n   ```sqf\n   [group this, getPosATL this] call BIS_fnc_taskDefend;\n   ```\n   - You can use triggers for this function too, but your groups must be named\n\n     ```sqf\n     { [_x, getPosATL leader _x] call BIS_fnc_taskDefend } forEach [grpName1, grpName2];\n     ```"}]},{"name":"BIS_fnc_taskDescription","title":"BIS fnc taskDescription","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_taskDescription","revid":352119,"updated":"2024-02-01T23:25:02Z","groups":["Tasks"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"global","effect":"global"},"description":"Return a task's description.\n\n> [!NOTE]\n> See Arma 3: Task Framework for more information.","syntaxes":[{"syntax":"taskName call BIS_fnc_taskDescription","params":[{"name":"taskName","type":"String","type_expr":"String"}],"returns":{"type":"Array","type_expr":"Array","description":"task's description in the format [\"description\", \"title\", \"marker\"]"}}],"examples":[{"code":["\"BIS_task_01\" call BIS_fnc_taskDescription;"]}],"see_also":["Arma 3: Task Framework"]},{"name":"BIS_fnc_taskDestination","title":"BIS fnc taskDestination","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_taskDestination","revid":352150,"updated":"2024-02-01T23:25:18Z","groups":["Tasks"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"global","effect":"global"},"description":"Return a task's destination.\n\n> [!NOTE]\n> See Arma 3: Task Framework for more information.","syntaxes":[{"syntax":"taskName call BIS_fnc_taskDestination","params":[{"name":"taskName","type":"String","type_expr":"String"}],"returns":{"type":"Object or Array","type_expr":"Object | Array","description":"either position in format [x,y,z], or [object,precision] as used by setSimpleTaskTarget command. Returns just objNull if task was not found"}}],"examples":[{"code":["\"BIS_task_01\" call BIS_fnc_taskDestination;"]}],"see_also":["Arma 3: Task Framework"]},{"name":"BIS_fnc_taskExists","title":"BIS fnc taskExists","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_taskExists","revid":352030,"updated":"2024-02-01T23:24:28Z","groups":["Tasks"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"global","effect":"global"},"description":"Return true if a task exists.\n\n> [!NOTE]\n> See Arma 3: Task Framework for more information.","syntaxes":[{"syntax":"[taskName] call BIS_fnc_taskExists","params":[{"name":"taskName","type":"String","description":"task name","type_expr":"String"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if it exists"}}],"examples":[{"code":["private _exists = [\"MyTask\"] call BIS_fnc_taskExists;"]}],"see_also":["Arma 3: Task Framework"]},{"name":"BIS_fnc_taskHandler","title":"BIS fnc taskHandler","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_taskHandler","revid":379574,"updated":"2026-10-31T14:02:31Z","groups":["Tasks"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Task handler: automatically sets a unit's current task. Whenever the unit receives a new task or a task is completed, the uncompleted task with the highest priority (lowest number) becomes current; among tasks of equal priority, the one with the nearest destination is chosen.\nThe function is meant to be called by mission scripts; no Arma 3 script calls it. It must be called where the unit is local:\n\n- the handler (*A3\\functions_f\\misc\\fn_taskHandler.fsm*) is started only if the unit or a member of its group is a player, and only once per group;\n- it ends when the unit dies or when its \"BIS_taskHandler_stop\" variable is set to true, and is restarted for the new unit after respawn;\n- if AI tasks are enabled (*BIS_missionScope* variable \"BIS_useAITasks\" is true or an array containing the unit), *A3\\functions_f\\misc\\fn_AITasks.fsm* is started for the unit as well; on the server it is started for a non-local unit once the unit becomes local (e.g. after its player disconnects).\n\n> [!IMPORTANT]\n> This is legacy Arma 2 code: it only handles tasks created through the Arma 2 Multiplayer Framework (stored in *BIS_missionScope*) and sets the current task through the framework function *RE*, which is not part of Arma 3's Functions Library. For Arma 3 tasks see Arma 3: Task Framework.","syntaxes":[{"syntax":"[unit, taskPriorities] call BIS_fnc_taskHandler","params":[{"name":"unit","type":"Object","description":"unit whose tasks are handled","type_expr":"Object"},{"name":"taskPriorities","type":"Array of Arrays in format [taskLink, priority]:","description":"Array of Arrays in format [taskLink, priority]:\n\n- taskLink: String - link (variable name) of a task created through the Multiplayer Framework\n- priority: Number - task priority; a lower number means a higher priority","type_expr":"Array<Array>","text":"taskPriorities: Array of Arrays in format [taskLink, priority]:\n\n- taskLink: String - link (variable name) of a task created through the Multiplayer Framework\n- priority: Number - task priority; a lower number means a higher priority"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"```sqf\n[\n    BIS_cooper,\n    [\n        [\"objShaftoe\", 1],\n        [\"objEscortLagushina\", 1],\n        [\"objRescueCrew\", 2],\n        [\"objGorka\", 3],\n        [\"objFindBase\", 4]\n    ]\n] call BIS_fnc_taskHandler;\n```","code":["[\n\tBIS_cooper,\n\t[\n\t\t[\"objShaftoe\", 1],\n\t\t[\"objEscortLagushina\", 1],\n\t\t[\"objRescueCrew\", 2],\n\t\t[\"objGorka\", 3],\n\t\t[\"objFindBase\", 4]\n\t]\n] call BIS_fnc_taskHandler;"]},{"text":"Stop the handler for a unit:\n\n```sqf\nBIS_cooper setVariable [\"BIS_taskHandler_stop\", true];\n```","code":["BIS_cooper setVariable [\"BIS_taskHandler_stop\", true];"]}],"see_also":["currentTask","setCurrentTask","simpleTasks","Arma 3: Task Framework"]},{"name":"BIS_fnc_taskHint","title":"BIS fnc taskHint","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_taskHint","revid":352105,"updated":"2024-02-01T23:24:54Z","groups":["Tasks"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Shows a task hint.\n\n> [!NOTE]\n> See Arma 3: Task Framework for more information.","syntaxes":[{"syntax":"[taskName, taskState] call BIS_fnc_taskHint","params":[{"name":"taskName","type":"String","type_expr":"String"},{"name":"taskState","type":"String","description":"can be:\n\n- \"CREATED\"\n- \"ASSIGNED\"\n- \"SUCCEEDED\"\n- \"FAILED\"\n- \"CANCELED\"","type_expr":"String"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[\"BIS_task_01\",\"CANCELED\"] call BIS_fnc_taskHint;"]}],"see_also":["Arma 3: Task Framework"]},{"name":"BIS_fnc_taskParent","title":"BIS fnc taskParent","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_taskParent","revid":352072,"updated":"2024-02-01T23:24:41Z","groups":["Tasks"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"global","effect":"global"},"description":"Return a sub-task's parent task.\n\n> [!NOTE]\n> See Arma 3: Task Framework for more information.","syntaxes":[{"syntax":"taskName call BIS_fnc_taskParent","params":[{"name":"taskName","type":"String","type_expr":"String"}],"returns":{"type":"String","type_expr":"String","description":"parent task"}}],"examples":[{"code":["\"BIS_task_01\" call BIS_fnc_taskParent;"]}],"see_also":["Arma 3: Task Framework"]},{"name":"BIS_fnc_taskPatrol","title":"BIS fnc taskPatrol","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_taskPatrol","revid":379512,"updated":"2026-10-31T00:28:37Z","groups":["Tasks"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Create a random patrol of several waypoints around a given position.\n\n> [!NOTE]\n> In Arma 2, the Functions Module is required.","syntaxes":[{"syntax":"[group, position, distance, blacklist] call BIS_fnc_taskPatrol","params":[{"name":"group","type":"Group","description":"the group to patrol","type_expr":"Group"},{"name":"position","type":"Position","description":"the position on which to base the patrol","type_expr":"Position"},{"name":"distance","type":"Number","description":"maximum distance between waypoints in meters","type_expr":"Number"},{"name":"blacklist","type":"Array","optional":true,"description":"blacklist of areas","type_expr":"Array","text":"blacklist: Array - (Optional) blacklist of areas"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[group _unit, getPos _unit, 1000] call BIS_fnc_taskPatrol;"]}],"see_also":["Functions Library","BIS_fnc_taskAttack","BIS_fnc_taskDefend"]},{"name":"BIS_fnc_taskReal","title":"BIS fnc taskReal","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_taskReal","revid":348603,"updated":"2023-11-08T13:45:16Z","groups":["Tasks"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"global"},"description":"Find the actual task associated with a task name assigned to a unit.\n\n> [!NOTE]\n> See Arma 3: Task Framework for more information.","syntaxes":[{"syntax":"[taskName, owner] call BIS_fnc_taskReal","params":[{"name":"taskName","type":"String","type_expr":"String"},{"name":"owner","type":"Object","description":"task owner","type_expr":"Object"}],"returns":{"type":"Task","type_expr":"Task","description":"task"}}],"examples":[{"code":["[\"testTask\", player] call BIS_fnc_taskReal; // returns \"Task testTask (id 0)\""]}],"see_also":["Arma 3: Task Framework"]},{"name":"BIS_fnc_taskSetAlwaysVisible","title":"BIS fnc taskSetAlwaysVisible","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_taskSetAlwaysVisible","revid":376121,"updated":"2025-08-31T21:33:19Z","groups":["Tasks"],"status":"ok","games":{"arma3":"1.58"},"since":"arma3 1.58","arma3_since":"1.58","locality":{"argument":"global","effect":"global"},"description":"Flags task to be or not to be always visible.\n\n> [!NOTE]\n> See Arma 3: Task Framework for more information.","syntaxes":[{"syntax":"[taskID, alwaysVisible] call BIS_fnc_taskSetAlwaysVisible","params":[{"name":"taskID","type":"String","description":"task ID","type_expr":"String"},{"name":"alwaysVisible","type":"Boolean","description":"true for always visible false if not","type_expr":"Boolean"}],"returns":{"type":"String","type_expr":"String","description":"task ID."}}],"examples":[{"code":["[\"BIS_Task_01\", true] call BIS_fnc_taskSetAlwaysVisible;"]}],"see_also":["Arma 3: Task Framework"]},{"name":"BIS_fnc_taskSetCurrent","title":"BIS fnc taskSetCurrent","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_taskSetCurrent","revid":352102,"updated":"2024-02-01T23:24:52Z","groups":["Tasks"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"global","effect":"global"},"description":"Set a task to current. Identical to assigning a task.\n\n> [!NOTE]\n> See Arma 3: Task Framework.","syntaxes":[{"syntax":"taskName call BIS_fnc_taskSetCurrent","params":[{"name":"taskName","type":"String","type_expr":"String"},{"name":"showNotification","type":"Boolean","optional":true,"default":"true","description":"true to show notification, false to disable it","type_expr":"Boolean","text":"showNotification: Boolean - (Optional, default true) true to show notification, false to disable it"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["\"BIS_task_01\" call BIS_fnc_taskSetCurrent;"]},{"code":["[\"BIS_task_01\", false] call BIS_fnc_taskSetCurrent; //Assign without notificiation"]}],"see_also":["Arma 3: Task Framework"]},{"name":"BIS_fnc_taskSetDescription","title":"BIS fnc taskSetDescription","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_taskSetDescription","revid":378936,"updated":"2026-08-22T22:39:56Z","groups":["Tasks"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"global","effect":"global"},"description":"Set a task description.\n\n> [!NOTE]\n> See Arma 3: Task Framework for more information.","syntaxes":[{"syntax":"[taskId, [taskDescription, taskTitle, taskMarker]] call BIS_fnc_taskSetDescription","params":[{"name":"taskId","type":"String","type_expr":"String"},{"name":"taskDescription","type":"String","type_expr":"String"},{"name":"taskTitle","type":"String","type_expr":"String"},{"name":"taskMarker","type":"String","type_expr":"String"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"text":"```sqf\n[\n    \"tsk_destroyAA\",\n    [\n        \"You should plant Satchels under those Shilkas! Good luck.\",\n        \"Destroy the Shilkas\",\n        \"Shilkas\"\n    ]\n] call BIS_fnc_taskSetDescription;\n```","code":["[\n\t\"tsk_destroyAA\",\n\t[\n\t\t\"You should plant Satchels under those Shilkas! Good luck.\",\n\t\t\"Destroy the Shilkas\",\n\t\t\"Shilkas\"\n\t]\n] call BIS_fnc_taskSetDescription;"]}],"see_also":["Arma 3: Task Framework"],"notes":[{"user":"Honger","date":"2026-08-22T22:39:56Z","text":"Note that some structured text markups seem to be ignored like colour, verticality etc."}]},{"name":"BIS_fnc_taskSetDestination","title":"BIS fnc taskSetDestination","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_taskSetDestination","revid":347338,"updated":"2023-09-11T00:28:50Z","groups":["Tasks"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"global","effect":"global"},"description":"Set a task's destination.\n\n> [!NOTE]\n> See Arma 3: Task Framework for more information.","syntaxes":[{"syntax":"[taskName, destination] call BIS_fnc_taskSetDestination","params":[{"name":"taskName","type":"String","type_expr":"String"},{"name":"destination","type":"Object, Array, Position or String","description":"task destination:\n\n- Object - task will be displayed on the object if player knows about it, otherwise it will be on estimated position or even hidden\n- Array format [object, forceRealPosition]:\n  - object: Object - same as above\n  - forceRealPosition: Boolean - whether or not the task will be on exact object position even if the player does not know about the object\n- Position - task will be on given positon\n- String - marker name. Task will be at markers current position (Won't update if marker was moved)","type_expr":"Object | Array | Position | String"}],"returns":{"type":"String","type_expr":"String","description":"task ID"}}],"examples":[{"code":["[\"BIS_task_01\", [1337, 1337, 0]] call BIS_fnc_taskSetDestination;"]}],"see_also":["Arma 3: Task Framework"]},{"name":"BIS_fnc_taskSetState","title":"BIS fnc taskSetState","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_taskSetState","revid":364616,"updated":"2024-05-22T11:37:48Z","groups":["Tasks"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"global","effect":"global"},"description":"Set a task's state.\n\n> [!NOTE]\n> See Arma 3: Task Framework for more information.","syntaxes":[{"syntax":"[taskName, taskState, showHint] call BIS_fnc_taskSetState","params":[{"name":"taskName","type":"String","type_expr":"String"},{"name":"taskState","type":"String","description":"can be:\n\n- \"CREATED\"\n- \"ASSIGNED\"\n- \"SUCCEEDED\"\n- \"FAILED\"\n- \"CANCELED\"","type_expr":"String"},{"name":"showHint","type":"Boolean","optional":true,"default":"true","description":"true to show a hint","type_expr":"Boolean","text":"showHint: Boolean - (Optional, default true) true to show a hint"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[\"BIS_task_01\",\"CANCELED\"] call BIS_fnc_taskSetState;"]}],"see_also":["Arma 3: Task Framework"],"notes":[{"user":"Whiztler","date":"2024-05-22T11:37:48Z","text":"Mind the spelling of the TaskState parameter string \"CANCELED\". The parameter will not work with the TaskState correctly spelled \"CANCELLED\"."}]},{"name":"BIS_fnc_taskSetType","title":"BIS fnc taskSetType","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_taskSetType","revid":369828,"updated":"2024-10-15T15:21:35Z","groups":["Tasks"],"status":"ok","games":{"arma3":"1.58"},"since":"arma3 1.58","arma3_since":"1.58","locality":{"argument":"global","effect":"global"},"description":"Sets task type to given task.\n\n> [!NOTE]\n> See Arma 3: Task Framework for more information.","syntaxes":[{"syntax":"[id, type] call BIS_fnc_taskSetType","params":[{"name":"id","type":"String","description":"task ID","type_expr":"String"},{"name":"type","type":"String","description":"vanilla or custom task type; if not defined, empty (no) type is used","type_expr":"String"}],"returns":{"type":"String","type_expr":"String","description":"task ID."}}],"examples":[{"code":["[\"BIS_Task_01\",\"attack\"] call BIS_fnc_taskSetType;"]}],"see_also":["Arma 3: Task Framework"]},{"name":"BIS_fnc_taskState","title":"BIS fnc taskState","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_taskState","revid":352114,"updated":"2024-02-01T23:25:00Z","groups":["Tasks"],"status":"ok","games":{"arma3":"0.76"},"since":"arma3 0.76","arma3_since":"0.76","locality":{"argument":"global"},"description":"Returns task's state.\n\n> [!NOTE]\n> See Arma 3: Task Framework for more information.","syntaxes":[{"syntax":"taskID call BIS_fnc_taskState","params":[{"name":"taskID","type":"String","description":"ID of the task","type_expr":"String"}],"returns":{"type":"String","type_expr":"String","description":"state of the task. Can be:\n- \"AUTOASSIGNED\" - \"ASSIGNED\" - \"CREATED\" - \"SUCCEEDED\" - \"FAILED\" - \"CANCELED\"","text":"String - state of the task. Can be:\n\n- \"AUTOASSIGNED\"\n- \"ASSIGNED\"\n- \"CREATED\"\n- \"SUCCEEDED\"\n- \"FAILED\"\n- \"CANCELED\""}}],"examples":[{"code":["\"task_1\" call BIS_fnc_taskState;"]},{"code":["[\"task_1\"] call BIS_fnc_taskState;"]}],"see_also":["Arma 3: Task Framework"]},{"name":"BIS_fnc_tasksUnit","title":"BIS fnc tasksUnit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_tasksUnit","revid":352094,"updated":"2024-02-01T23:24:49Z","groups":["Tasks"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"argument":"global"},"description":"Grab all tasks currently created for a given unit.\n\n> [!NOTE]\n> See Arma 3: Task Framework for more information.","syntaxes":[{"syntax":"target call BIS_fnc_tasksUnit","params":[{"name":"target","type":"Object","type_expr":"Object"}],"returns":{"type":"Array","type_expr":"Array","description":"array with task names"}}],"examples":[{"code":["player call BIS_fnc_tasksUnit;"]}],"see_also":["Arma 3: Task Framework"]},{"name":"BIS_fnc_taskType","title":"BIS fnc taskType","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_taskType","revid":352026,"updated":"2024-02-01T23:24:23Z","groups":["Tasks"],"status":"ok","games":{"arma3":"1.58"},"since":"arma3 1.58","arma3_since":"1.58","locality":{"argument":"global"},"description":"Returns type of given task.\n\n> [!NOTE]\n> See Arma 3: Task Framework for more information.","syntaxes":[{"syntax":"taskID call BIS_fnc_taskType","params":[{"name":"taskID","type":"String","description":"task ID","type_expr":"String"}],"returns":{"type":"String","type_expr":"String","description":"task type or type 'Default' if not defined."}}],"examples":[{"code":["[\"BIS_Task_01\"] call BIS_fnc_taskType;"]}],"see_also":["Arma 3: Task Framework"]},{"name":"BIS_fnc_taskTypeIcon","title":"BIS fnc taskTypeIcon","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_taskTypeIcon","revid":352033,"updated":"2024-02-01T23:24:28Z","groups":["Tasks"],"status":"ok","games":{"arma3":"1.58"},"since":"arma3 1.58","arma3_since":"1.58","description":"Returns path to the icon texture associated with given task type.\n\n> [!NOTE]\n> See Arma 3: Task Framework for more information.","syntaxes":[{"syntax":"[type, default] call BIS_fnc_taskTypeIcon","params":[{"name":"type","type":"String","description":"task type","type_expr":"String"},{"name":"default","type":"Config","description":"config path to get default path from, if **type** does not exist","type_expr":"Config"}],"returns":{"type":"String","type_expr":"String","description":"path to the task type texture."}}],"examples":[{"code":["[\"attack\",configFile >> \"CfgTaskTypes\" >> \"Run\" >> \"icon\"] call BIS_fnc_taskTypeIcon;"]}],"see_also":["Arma 3: Task Framework"]},{"name":"BIS_fnc_taskVar","title":"BIS fnc taskVar","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_taskVar","revid":352089,"updated":"2024-02-01T23:24:47Z","groups":["Tasks"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns task's variable name.\n\n> [!NOTE]\n> See Arma 3: Task Framework for more information.","syntaxes":[{"syntax":"taskID call BIS_fnc_taskVar","params":[{"name":"taskID","type":"String","description":"ID of the task","type_expr":"String"}],"returns":{"type":"String","type_expr":"String","description":"returns \"@test\" for a task with the variable name \"test\".","text":"String - returns **\"@test\"** for a task with the variable name **\"test\"**."}}],"examples":[{"code":["\"task_1\" call BIS_fnc_taskVar;"]}],"see_also":["Arma 3: Task Framework"]},{"name":"BIS_fnc_teamColor","title":"BIS fnc teamColor","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_teamColor","revid":377980,"updated":"2026-01-19T20:38:21Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Convert number to color team name or color.","syntaxes":[{"syntax":"[teamId, getColour] call BIS_fnc_teamColor","params":[{"name":"teamId","type":"Number","description":"in range 1..5","type_expr":"Number"},{"name":"getColour","type":"Boolean","optional":true,"default":"false","description":"true to get Color (RGBA), false to get the *localised* team name","type_expr":"Boolean","text":"getColour: Boolean - (Optional, default false) true to get Color (RGBA), false to get the *localised* team name"}],"returns":{"type":"Color (RGBA) or String","type_expr":"Color | String","description":"color format [r, g, b, a] or localised team name"}}],"examples":[{"code":["_colour = [2, true] call BIS_fnc_teamColor;"]},{"code":["_teamName = [2] call BIS_fnc_teamColor;\nhint format [\"%1 is %2\", 2, _teamName];"]}],"see_also":["BIS_fnc_colorConfigToRGBA","BIS_fnc_colorRGBAtoHTML"]},{"name":"BIS_fnc_terrainGradAngle","title":"BIS fnc terrainGradAngle","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_terrainGradAngle","revid":328359,"updated":"2022-07-13T16:00:47Z","groups":["Geometry"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns the gradient angle (in radians) of the terrain at a specified position and a compass direction.\nIt is an angle of the slope of a tangent plane to the terrain at the specified position in the specified direction.","syntaxes":[{"syntax":"","params":[{"name":"object","type":"Object or Position","type_expr":"Object | Position"},{"name":"direction","type":"Number","description":"direction where should be gradient calculated (compass direction)","type_expr":"Number"},{"name":"delta","type":"Number","description":"which stepsize should be used","type_expr":"Number"}],"returns":{"type":"Number","type_expr":"Number","description":"gradient angle in radians"}}],"examples":[{"code":["private _radGrad = [getPos player, getDir player] call BIS_fnc_terrainGradAngle;"]}],"see_also":["getDir","surfaceNormal"]},{"name":"BIS_fnc_textTiles","title":"BIS fnc textTiles","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_textTiles","revid":379282,"updated":"2026-10-30T23:45:46Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"effect":"local"},"exec":"spawn","description":"Shows an animated text with background tiles.","syntaxes":[{"syntax":"[content, position, tileSize, duration, fadeInOutTime, tileTransparency] spawn BIS_fnc_textTiles","params":[{"name":"content","type":"String or Structured Text","description":"String or Structured Text\n\n- String - path to texure\n- Structured Text - formatted text","type_expr":"String | Structured Text","text":"content: String or Structured Text\n\n- String - path to texure\n- Structured Text - formatted text"},{"name":"position","type":"Boolean or Array","optional":true,"default":"[0, 0, 1, 1]","description":"Boolean - true to use *mission area* set in the layout options, false for full screen\n- Array - screen space coordinates in format [x, y, w, h]","type_expr":"Boolean | Array","text":"position: Boolean or Array - (Optional, default [0, 0, 1, 1])\n\n- Boolean - true to use *mission area* set in the layout options, false for full screen\n- Array - screen space coordinates in format [x, y, w, h]"},{"name":"tileSize","type":"Number or Array","optional":true,"default":"10 ([10,10])","description":"Number - tile size in screen space coordinates. Tile will be square\n- Array - tile size in screen space coordinates in format [w, h]","type_expr":"Number | Array","text":"tileSize: Number or Array - (Optional, default 10 ([10,10]))\n\n- Number - tile size in screen space coordinates. Tile will be square\n- Array - tile size in screen space coordinates in format [w, h]"},{"name":"duration","type":"Number","optional":true,"default":"5","description":"duration in seconds","type_expr":"Number","text":"duration: Number - (Optional, default 5) duration in seconds"},{"name":"fadeInOutTime","type":"Number or Array","optional":true,"default":"0","description":"duration of the fade effect in seconds\n\n- Array - format [fadeIn, fadeOut]\n- Number - duration of the fadeIn/Out effect","type_expr":"Number | Array","text":"fadeInOutTime: Number or Array - (Optional, default 0) duration of the fade effect in seconds\n\n- Array - format [fadeIn, fadeOut]\n- Number - duration of the fadeIn/Out effect"},{"name":"tileTransparency","type":"Number","optional":true,"default":"0.3","description":"transparency or alpha value of the tiles. 0 means invisible and 1 fully visible","type_expr":"Number","text":"tileTransparency: Number - (Optional, default 0.3) transparency or alpha value of the tiles. 0 means invisible and 1 fully visible"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"returns always true"}}],"examples":[{"code":["[parseText \"<t font='PuristaBold' size='1.6'>MyMission</t><br />by Username\", true, nil, 7, 0.7, 0] spawn BIS_fnc_textTiles;"]},{"code":["[\"path\\to\\image.paa\"] spawn BIS_fnc_textTiles;"]}],"see_also":["BIS_fnc_dynamicText","BIS_fnc_infoText","BIS_fnc_typeText","BIS_fnc_typeText2","BIS_fnc_EXP_camp_SITREP"]},{"name":"BIS_fnc_textureMarker","title":"BIS fnc textureMarker","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_textureMarker","revid":327439,"updated":"2022-07-12T22:12:09Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Checks whether texture is defined in CfgMarkers and if so, returns the marker texture.","syntaxes":[{"syntax":"[wantedMarker] call BIS_fnc_textureMarker","params":[{"name":"wantedMarker","type":"String","description":"marker type","type_expr":"String"}],"returns":{"type":"String","type_expr":"String","description":"icon texture path, or wantedMarker if not found","text":"String - icon texture path, or *wantedMarker* if not found"}}],"examples":[{"code":["private _notWhiteFlag = [\"flag_France\"] call BIS_fnc_textureMarker;"]}],"see_also":["BIS_fnc_textureVehicleIcon"]},{"name":"BIS_fnc_textureVehicleIcon","title":"BIS fnc textureVehicleIcon","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_textureVehicleIcon","revid":327466,"updated":"2022-07-12T22:12:10Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Checks whether icon is defined in CfgVehicleIcons and if so, returns the icon.","syntaxes":[{"syntax":"[wantedIcon] call BIS_fnc_textureVehicleIcon","params":[{"name":"wantedIcon","type":"String","type_expr":"String"}],"returns":{"type":"String","type_expr":"String","description":"icon texture path, or wantedIcon if not found","text":"String - icon texture path, or *wantedIcon* if not found"}}],"examples":[{"code":["private _mediTexture = [\"iconManMedic\"] call BIS_fnc_textureVehicleIcon;"]}],"see_also":["BIS_fnc_textureMarker"]},{"name":"BIS_fnc_threat","title":"BIS fnc threat","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_threat","revid":349272,"updated":"2023-11-08T14:51:10Z","groups":["Combat"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Calculates threat values of given unit.","syntaxes":[{"syntax":"[unit] call BIS_fnc_threat","params":[{"name":"unit","type":"Object","description":"given unit","type_expr":"Object"}],"returns":{"type":"Number","type_expr":"Number","description":"threat level in range from 0 to 3"}}],"examples":[{"code":["private _threatLevel = [player] call BIS_fnc_threat;"]}],"see_also":["nearTargets","targetsQuery","reveal","side"]},{"name":"BIS_fnc_timeline_cleanup","title":"BIS fnc timeline cleanup","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_cleanup","revid":310493,"updated":"2022-05-06T11:02:10Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Destroys timeline and all related objects.","syntaxes":[{"syntax":"[timeline] call BIS_fnc_timeline_cleanup","params":[{"name":"timeline","type":"Object","description":"the timeline object","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[timeline] call BIS_fnc_timeline_cleanup;"]}],"see_also":["BIS_fnc_timeline_deleted"]},{"name":"BIS_fnc_timeline_deleted","title":"BIS fnc timeline deleted","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_deleted","revid":363751,"updated":"2024-04-17T20:02:48Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Deletes given timeline and updates.\n\n```sqf\nmissionNamespace getVariable \"Timelines\";\n```","syntaxes":[{"syntax":"[timeline] call BIS_fnc_timeline_deleted","params":[{"name":"timeline","type":"Object","description":"the timeline object","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[timeline] call BIS_fnc_timeline_deleted;"]}],"see_also":["BIS_fnc_timeline_cleanup"]},{"name":"BIS_fnc_timeline_edenAttributesChanged","title":"BIS fnc timeline edenAttributesChanged","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_edenAttributesChanged","revid":279236,"updated":"2021-06-13T22:15:13Z","groups":["Timeline3DEN"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Attributes change in EDEN for a timeline","syntaxes":[{"syntax":"[] call BIS_fnc_timeline_edenAttributesChanged","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The timeline","text":"0: Object    - The timeline","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nAttributes change in EDEN for a timeline\n\nParameter(s):\n_this select 0: Object    - The timeline\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_timeline_edenConnectionChanged","title":"BIS fnc timeline edenConnectionChanged","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_edenConnectionChanged","revid":279374,"updated":"2021-06-13T22:17:39Z","groups":["Timeline3DEN"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"3DEN connections of a timeline is changed","syntaxes":[{"syntax":"[] call BIS_fnc_timeline_edenConnectionChanged","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The timeline","text":"0: Object    - The timeline","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\n3DEN connections of a timeline is changed\n\nParameter(s):\n_this select 0: Object    - The timeline\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_timeline_edenDeleted","title":"BIS fnc timeline edenDeleted","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_edenDeleted","revid":279282,"updated":"2021-06-13T22:16:02Z","groups":["Timeline3DEN"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Timeline is deleted","syntaxes":[{"syntax":"[] call BIS_fnc_timeline_edenDeleted","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The destroyed timeline","text":"0: Object - The destroyed timeline","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nTimeline is deleted\n\nParameter(s):\n_this select 0: Object - The destroyed timeline\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_timeline_edenDragged","title":"BIS fnc timeline edenDragged","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_edenDragged","revid":279405,"updated":"2021-06-13T22:18:38Z","groups":["Timeline3DEN"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Entity is dragged in 3DEN","syntaxes":[{"syntax":"[] call BIS_fnc_timeline_edenDragged","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The timeline","text":"0: Object    - The timeline","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nEntity is dragged in 3DEN\n\nParameter(s):\n_this select 0: Object    - The timeline\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_timeline_edenInit","title":"BIS fnc timeline edenInit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_edenInit","revid":279391,"updated":"2021-06-13T22:18:24Z","groups":["Timeline3DEN"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Time line is initialized in 3den","syntaxes":[{"syntax":"[] call BIS_fnc_timeline_edenInit","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The timeline","text":"0: Object    - The timeline","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nTime line is initialized in 3den\n\nParameter(s):\n_this select 0: Object    - The timeline\n\nReturns:\nNothing","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_timeline_edenIsSelected","title":"BIS fnc timeline edenIsSelected","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_edenIsSelected","revid":279362,"updated":"2021-06-13T22:17:25Z","groups":["Timeline3DEN"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Whether this timeline is selected in 3den","syntaxes":[{"syntax":"[] call BIS_fnc_timeline_edenIsSelected","params":[{"name":"param0","type":"Object","type_expr":"Object","description":"The timeline","text":"0: Object    - The timeline","source":"docblock"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"True if selected, false if not","text":"Bool - True if selected, false if not","source":"docblock"}}],"docblock":{"text":"Author: Nelson Duarte <@Nelson_G_Duarte>\n\nDescription:\nWhether this timeline is selected in 3den\n\nParameter(s):\n_this select 0: Object    - The timeline\n\nReturns:\nBool - True if selected, false if not","author":"Nelson Duarte <@Nelson_G_Duarte>"},"filled_from_docblock":["description","params","returns"]},{"name":"BIS_fnc_timeline_finish","title":"BIS fnc timeline finish","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_finish","revid":310486,"updated":"2022-05-06T11:01:59Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Called when timeline finishes playing (reaches it is end).","syntaxes":[{"syntax":"[timeline] call BIS_fnc_timeline_finish","params":[{"name":"timeline","type":"Object","description":"the timeline object","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[timeline] call BIS_fnc_timeline_finish;"]}],"see_also":["BIS_fnc_timeline_deleted","BIS_fnc_timeline_cleanup","BIS_fnc_timeline_getAlpha","BIS_fnc_timeline_getCurrentTime","BIS_fnc_timeline_getInterpMode","BIS_fnc_timeline_getLength","BIS_fnc_timeline_getPlayFromStart","BIS_fnc_timeline_getPlayRate","BIS_fnc_timeline_getPlayTime","BIS_fnc_timeline_getPosition","BIS_fnc_timeline_getSimulatedCurves","BIS_fnc_timeline_getStopTime","BIS_fnc_timeline_getTimeLeft","BIS_fnc_timeline_init","BIS_fnc_timeline_isFinished","BIS_fnc_timeline_isLooping","BIS_fnc_timeline_isPaused","BIS_fnc_timeline_isPlaying","BIS_fnc_timeline_play","BIS_fnc_timeline_setInterpMode","BIS_fnc_timeline_setLength","BIS_fnc_timeline_setLoop","BIS_fnc_timeline_setPause","BIS_fnc_timeline_setPlayRate","BIS_fnc_timeline_setPosition","BIS_fnc_timeline_simulateCurves","BIS_fnc_timeline_stop","BIS_fnc_timeline_tick","BIS_fnc_timeline_setReverse","BIS_fnc_timeline_isReverse"]},{"name":"BIS_fnc_timeline_getAlpha","title":"BIS fnc timeline getAlpha","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_getAlpha","revid":348336,"updated":"2023-11-08T12:59:45Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Get's current alpha in given timeline.","syntaxes":[{"syntax":"[timeline] call BIS_fnc_timeline_getAlpha","params":[{"name":"timeline","type":"Object","description":"the timeline object","type_expr":"Object"}],"returns":{"type":"Number","type_expr":"Number","description":"current Alpha value"}}],"examples":[{"code":["private _alpha = [timeline] call BIS_fnc_timeline_getAlpha;"]}],"see_also":["BIS_fnc_timeline_deleted","BIS_fnc_timeline_cleanup","BIS_fnc_timeline_finish","BIS_fnc_timeline_getCurrentTime","BIS_fnc_timeline_getInterpMode","BIS_fnc_timeline_getLength","BIS_fnc_timeline_getPlayFromStart","BIS_fnc_timeline_getPlayRate","BIS_fnc_timeline_getPlayTime","BIS_fnc_timeline_getPosition","BIS_fnc_timeline_getSimulatedCurves","BIS_fnc_timeline_getStopTime","BIS_fnc_timeline_getTimeLeft","BIS_fnc_timeline_init","BIS_fnc_timeline_isFinished","BIS_fnc_timeline_isLooping","BIS_fnc_timeline_isPaused","BIS_fnc_timeline_isPlaying","BIS_fnc_timeline_play","BIS_fnc_timeline_setInterpMode","BIS_fnc_timeline_setLength","BIS_fnc_timeline_setLoop","BIS_fnc_timeline_setPause","BIS_fnc_timeline_setPlayRate","BIS_fnc_timeline_setPosition","BIS_fnc_timeline_simulateCurves","BIS_fnc_timeline_stop","BIS_fnc_timeline_tick","BIS_fnc_timeline_setReverse","BIS_fnc_timeline_isReverse"]},{"name":"BIS_fnc_timeline_getCurrentTime","title":"BIS fnc timeline getCurrentTime","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_getCurrentTime","revid":348473,"updated":"2023-11-08T13:00:26Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"The current time of this timeline.","syntaxes":[{"syntax":"[timeline] call BIS_fnc_timeline_getCurrentTime","params":[{"name":"timeline","type":"Object","description":"the timeline object","type_expr":"Object"}],"returns":{"type":"Number","type_expr":"Number","description":"current time value"}}],"examples":[{"code":["private _time = [timeline] call BIS_fnc_timeline_getCurrentTime;"]}],"see_also":["BIS_fnc_timeline_deleted","BIS_fnc_timeline_cleanup","BIS_fnc_timeline_finish","BIS_fnc_timeline_getAlpha","BIS_fnc_timeline_getInterpMode","BIS_fnc_timeline_getLength","BIS_fnc_timeline_getPlayFromStart","BIS_fnc_timeline_getPlayRate","BIS_fnc_timeline_getPlayTime","BIS_fnc_timeline_getPosition","BIS_fnc_timeline_getSimulatedCurves","BIS_fnc_timeline_getStopTime","BIS_fnc_timeline_getTimeLeft","BIS_fnc_timeline_init","BIS_fnc_timeline_isFinished","BIS_fnc_timeline_isLooping","BIS_fnc_timeline_isPaused","BIS_fnc_timeline_isPlaying","BIS_fnc_timeline_play","BIS_fnc_timeline_setInterpMode","BIS_fnc_timeline_setLength","BIS_fnc_timeline_setLoop","BIS_fnc_timeline_setPause","BIS_fnc_timeline_setPlayRate","BIS_fnc_timeline_setPosition","BIS_fnc_timeline_simulateCurves","BIS_fnc_timeline_stop","BIS_fnc_timeline_tick","BIS_fnc_timeline_setReverse","BIS_fnc_timeline_isReverse"]},{"name":"BIS_fnc_timeline_getInterpMode","title":"BIS fnc timeline getInterpMode","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_getInterpMode","revid":348440,"updated":"2023-11-08T13:00:14Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Returns the timeline interp mode index.","syntaxes":[{"syntax":"[timeline] call BIS_fnc_timeline_getInterpMode","params":[{"name":"timeline","type":"Object","description":"the timeline object","type_expr":"Object"}],"returns":{"type":"Number","type_expr":"Number","description":"can return:\n- 0 - Linear - 1 - Cubic - 2 - EaseIn - 3 - EaseOut - 4 - EaseInOut - 5 - Hermite - 6 - Berp - 7 - BounceIn - 8 - BounceOut - 9 - BounceInOut - 10 - QuinticIn - 11 - QuinticOut - 12 - QuinticInOut - 13 - ElasticIn - 14 - ElasticOut - 15 - ElasticInOut","text":"Number - can return:\n\n- 0 - Linear\n- 1 - Cubic\n- 2 - EaseIn\n- 3 - EaseOut\n- 4 - EaseInOut\n- 5 - Hermite\n- 6 - Berp\n- 7 - BounceIn\n- 8 - BounceOut\n- 9 - BounceInOut\n- 10 - QuinticIn\n- 11 - QuinticOut\n- 12 - QuinticInOut\n- 13 - ElasticIn\n- 14 - ElasticOut\n- 15 - ElasticInOut"}}],"examples":[{"code":["private _interpolationMode = [timeline] call BIS_fnc_timeline_getInterpMode;"]}],"see_also":["BIS_fnc_timeline_deleted","BIS_fnc_timeline_cleanup","BIS_fnc_timeline_finish","BIS_fnc_timeline_getAlpha","BIS_fnc_timeline_getCurrentTime","BIS_fnc_timeline_getLength","BIS_fnc_timeline_getPlayFromStart","BIS_fnc_timeline_getPlayRate","BIS_fnc_timeline_getPlayTime","BIS_fnc_timeline_getPosition","BIS_fnc_timeline_getSimulatedCurves","BIS_fnc_timeline_getStopTime","BIS_fnc_timeline_getTimeLeft","BIS_fnc_timeline_init","BIS_fnc_timeline_isFinished","BIS_fnc_timeline_isLooping","BIS_fnc_timeline_isPaused","BIS_fnc_timeline_isPlaying","BIS_fnc_timeline_play","BIS_fnc_timeline_setInterpMode","BIS_fnc_timeline_setLength","BIS_fnc_timeline_setLoop","BIS_fnc_timeline_setPause","BIS_fnc_timeline_setPlayRate","BIS_fnc_timeline_setPosition","BIS_fnc_timeline_simulateCurves","BIS_fnc_timeline_stop","BIS_fnc_timeline_tick","BIS_fnc_timeline_setReverse","BIS_fnc_timeline_isReverse"]},{"name":"BIS_fnc_timeline_getLength","title":"BIS fnc timeline getLength","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_getLength","revid":348425,"updated":"2023-11-08T13:00:09Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"The time left of given timeline.","syntaxes":[{"syntax":"[timeline] call BIS_fnc_timeline_getLength","params":[{"name":"timeline","type":"Object","description":"the timeline object","type_expr":"Object"}],"returns":{"type":"Number","type_expr":"Number","description":"can return: * 0 - Linear"}}],"examples":[{"code":["private _timeLeft = [timeline] call BIS_fnc_timeline_getLength;"]}],"see_also":["BIS_fnc_timeline_deleted","BIS_fnc_timeline_cleanup","BIS_fnc_timeline_finish","BIS_fnc_timeline_getAlpha","BIS_fnc_timeline_getCurrentTime","BIS_fnc_timeline_getInterpMode","BIS_fnc_timeline_getPlayFromStart","BIS_fnc_timeline_getPlayRate","BIS_fnc_timeline_getPlayTime","BIS_fnc_timeline_getPosition","BIS_fnc_timeline_getSimulatedCurves","BIS_fnc_timeline_getStopTime","BIS_fnc_timeline_getTimeLeft","BIS_fnc_timeline_init","BIS_fnc_timeline_isFinished","BIS_fnc_timeline_isLooping","BIS_fnc_timeline_isPaused","BIS_fnc_timeline_isPlaying","BIS_fnc_timeline_play","BIS_fnc_timeline_setInterpMode","BIS_fnc_timeline_setLength","BIS_fnc_timeline_setLoop","BIS_fnc_timeline_setPause","BIS_fnc_timeline_setPlayRate","BIS_fnc_timeline_setPosition","BIS_fnc_timeline_simulateCurves","BIS_fnc_timeline_stop","BIS_fnc_timeline_tick","BIS_fnc_timeline_setReverse","BIS_fnc_timeline_isReverse"]},{"name":"BIS_fnc_timeline_getPlayFromStart","title":"BIS fnc timeline getPlayFromStart","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_getPlayFromStart","revid":349057,"updated":"2023-11-08T14:47:19Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Whether timeline is flagged as play from start on scenario begin.","syntaxes":[{"syntax":"[timeline] call BIS_fnc_timeline_getPlayFromStart","params":[{"name":"timeline","type":"Object","description":"the timeline object","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"returns true if timeline should play from start, otherwise false"}}],"examples":[{"code":["private _playFromStart = [timeline] call BIS_fnc_timeline_getPlayFromStart;"]}],"see_also":["BIS_fnc_timeline_deleted","BIS_fnc_timeline_cleanup","BIS_fnc_timeline_finish","BIS_fnc_timeline_getAlpha","BIS_fnc_timeline_getCurrentTime","BIS_fnc_timeline_getInterpMode","BIS_fnc_timeline_getLength","BIS_fnc_timeline_getPlayRate","BIS_fnc_timeline_getPlayTime","BIS_fnc_timeline_getPosition","BIS_fnc_timeline_getSimulatedCurves","BIS_fnc_timeline_getStopTime","BIS_fnc_timeline_getTimeLeft","BIS_fnc_timeline_init","BIS_fnc_timeline_isFinished","BIS_fnc_timeline_isLooping","BIS_fnc_timeline_isPaused","BIS_fnc_timeline_isPlaying","BIS_fnc_timeline_play","BIS_fnc_timeline_setInterpMode","BIS_fnc_timeline_setLength","BIS_fnc_timeline_setLoop","BIS_fnc_timeline_setPause","BIS_fnc_timeline_setPlayRate","BIS_fnc_timeline_setPosition","BIS_fnc_timeline_simulateCurves","BIS_fnc_timeline_stop","BIS_fnc_timeline_tick","BIS_fnc_timeline_setReverse","BIS_fnc_timeline_isReverse"]},{"name":"BIS_fnc_timeline_getPlayRate","title":"BIS fnc timeline getPlayRate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_getPlayRate","revid":349036,"updated":"2023-11-08T14:47:13Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Returns the play rate of this timeline.","syntaxes":[{"syntax":"[timeline] call BIS_fnc_timeline_getPlayRate","params":[{"name":"timeline","type":"Object","description":"the timeline object","type_expr":"Object"}],"returns":{"type":"Number","type_expr":"Number","description":"returns play rate"}}],"examples":[{"code":["private _playRate = [timeline] call BIS_fnc_timeline_getPlayRate;"]}],"see_also":["BIS_fnc_timeline_deleted","BIS_fnc_timeline_cleanup","BIS_fnc_timeline_finish","BIS_fnc_timeline_getAlpha","BIS_fnc_timeline_getCurrentTime","BIS_fnc_timeline_getInterpMode","BIS_fnc_timeline_getLength","BIS_fnc_timeline_getPlayFromStart","BIS_fnc_timeline_getPlayTime","BIS_fnc_timeline_getPosition","BIS_fnc_timeline_getSimulatedCurves","BIS_fnc_timeline_getStopTime","BIS_fnc_timeline_getTimeLeft","BIS_fnc_timeline_init","BIS_fnc_timeline_isFinished","BIS_fnc_timeline_isLooping","BIS_fnc_timeline_isPaused","BIS_fnc_timeline_isPlaying","BIS_fnc_timeline_play","BIS_fnc_timeline_setInterpMode","BIS_fnc_timeline_setLength","BIS_fnc_timeline_setLoop","BIS_fnc_timeline_setPause","BIS_fnc_timeline_setPlayRate","BIS_fnc_timeline_setPosition","BIS_fnc_timeline_simulateCurves","BIS_fnc_timeline_stop","BIS_fnc_timeline_tick","BIS_fnc_timeline_setReverse","BIS_fnc_timeline_isReverse"]},{"name":"BIS_fnc_timeline_getPlayTime","title":"BIS fnc timeline getPlayTime","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_getPlayTime","revid":349012,"updated":"2023-11-08T14:47:06Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"The time at which timeline started playing.","syntaxes":[{"syntax":"[timeline] call BIS_fnc_timeline_getPlayTime","params":[{"name":"timeline","type":"Object","description":"the timeline object","type_expr":"Object"}],"returns":{"type":"Number","type_expr":"Number","description":"returns start time"}}],"examples":[{"code":["private _startTime = [timeline] call BIS_fnc_timeline_getPlayTime;"]}],"see_also":["BIS_fnc_timeline_deleted","BIS_fnc_timeline_cleanup","BIS_fnc_timeline_finish","BIS_fnc_timeline_getAlpha","BIS_fnc_timeline_getCurrentTime","BIS_fnc_timeline_getInterpMode","BIS_fnc_timeline_getLength","BIS_fnc_timeline_getPlayFromStart","BIS_fnc_timeline_getPlayRate","BIS_fnc_timeline_getPosition","BIS_fnc_timeline_getSimulatedCurves","BIS_fnc_timeline_getStopTime","BIS_fnc_timeline_getTimeLeft","BIS_fnc_timeline_init","BIS_fnc_timeline_isFinished","BIS_fnc_timeline_isLooping","BIS_fnc_timeline_isPaused","BIS_fnc_timeline_isPlaying","BIS_fnc_timeline_play","BIS_fnc_timeline_setInterpMode","BIS_fnc_timeline_setLength","BIS_fnc_timeline_setLoop","BIS_fnc_timeline_setPause","BIS_fnc_timeline_setPlayRate","BIS_fnc_timeline_setPosition","BIS_fnc_timeline_simulateCurves","BIS_fnc_timeline_stop","BIS_fnc_timeline_tick","BIS_fnc_timeline_setReverse","BIS_fnc_timeline_isReverse"]},{"name":"BIS_fnc_timeline_getPosition","title":"BIS fnc timeline getPosition","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_getPosition","revid":349077,"updated":"2023-11-08T14:47:23Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Returns the position of given timeline.","syntaxes":[{"syntax":"[timeline] call BIS_fnc_timeline_getPosition","params":[{"name":"timeline","type":"Object","description":"the timeline object","type_expr":"Object"}],"returns":{"type":"Number","type_expr":"Number","description":"returns position of given timeline"}}],"examples":[{"code":["private _position = [timeline] call BIS_fnc_timeline_getPosition;"]}],"see_also":["BIS_fnc_timeline_deleted","BIS_fnc_timeline_cleanup","BIS_fnc_timeline_finish","BIS_fnc_timeline_getAlpha","BIS_fnc_timeline_getCurrentTime","BIS_fnc_timeline_getInterpMode","BIS_fnc_timeline_getLength","BIS_fnc_timeline_getPlayFromStart","BIS_fnc_timeline_getPlayRate","BIS_fnc_timeline_getPlayTime","BIS_fnc_timeline_getSimulatedCurves","BIS_fnc_timeline_getStopTime","BIS_fnc_timeline_getTimeLeft","BIS_fnc_timeline_init","BIS_fnc_timeline_isFinished","BIS_fnc_timeline_isLooping","BIS_fnc_timeline_isPaused","BIS_fnc_timeline_isPlaying","BIS_fnc_timeline_play","BIS_fnc_timeline_setInterpMode","BIS_fnc_timeline_setLength","BIS_fnc_timeline_setLoop","BIS_fnc_timeline_setPause","BIS_fnc_timeline_setPlayRate","BIS_fnc_timeline_setPosition","BIS_fnc_timeline_simulateCurves","BIS_fnc_timeline_stop","BIS_fnc_timeline_tick","BIS_fnc_timeline_setReverse","BIS_fnc_timeline_isReverse"]},{"name":"BIS_fnc_timeline_getSimulatedCurves","title":"BIS fnc timeline getSimulatedCurves","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_getSimulatedCurves","revid":349075,"updated":"2023-11-08T14:47:23Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Returns the simulated curves of a timeline.","syntaxes":[{"syntax":"[timeline] call BIS_fnc_timeline_getSimulatedCurves","params":[{"name":"timeline","type":"Object","description":"the timeline object","type_expr":"Object"}],"returns":{"type":"Array","type_expr":"Array","description":"returns a list of vurves that are simulated by this timeline"}}],"examples":[{"code":["private _curves = [timeline] call BIS_fnc_timeline_getSimulatedCurves;"]}],"see_also":["BIS_fnc_timeline_deleted","BIS_fnc_timeline_cleanup","BIS_fnc_timeline_finish","BIS_fnc_timeline_getAlpha","BIS_fnc_timeline_getCurrentTime","BIS_fnc_timeline_getInterpMode","BIS_fnc_timeline_getLength","BIS_fnc_timeline_getPlayFromStart","BIS_fnc_timeline_getPlayRate","BIS_fnc_timeline_getPlayTime","BIS_fnc_timeline_getPosition","BIS_fnc_timeline_getStopTime","BIS_fnc_timeline_getTimeLeft","BIS_fnc_timeline_init","BIS_fnc_timeline_isFinished","BIS_fnc_timeline_isLooping","BIS_fnc_timeline_isPaused","BIS_fnc_timeline_isPlaying","BIS_fnc_timeline_play","BIS_fnc_timeline_setInterpMode","BIS_fnc_timeline_setLength","BIS_fnc_timeline_setLoop","BIS_fnc_timeline_setPause","BIS_fnc_timeline_setPlayRate","BIS_fnc_timeline_setPosition","BIS_fnc_timeline_simulateCurves","BIS_fnc_timeline_stop","BIS_fnc_timeline_tick","BIS_fnc_timeline_setReverse","BIS_fnc_timeline_isReverse"]},{"name":"BIS_fnc_timeline_getStopTime","title":"BIS fnc timeline getStopTime","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_getStopTime","revid":349087,"updated":"2023-11-08T14:47:26Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"The time at which timeline stopped playing","syntaxes":[{"syntax":"[timeline] call BIS_fnc_timeline_getStopTime","params":[{"name":"timeline","type":"Object","description":"the timeline object","type_expr":"Object"}],"returns":{"type":"Number","type_expr":"Number","description":"returns the time at which timeline stopped playing"}}],"examples":[{"code":["private _timeStopped = [timeline] call BIS_fnc_timeline_getStopTime;"]}],"see_also":["BIS_fnc_timeline_deleted","BIS_fnc_timeline_cleanup","BIS_fnc_timeline_finish","BIS_fnc_timeline_getAlpha","BIS_fnc_timeline_getCurrentTime","BIS_fnc_timeline_getInterpMode","BIS_fnc_timeline_getLength","BIS_fnc_timeline_getPlayFromStart","BIS_fnc_timeline_getPlayRate","BIS_fnc_timeline_getPlayTime","BIS_fnc_timeline_getPosition","BIS_fnc_timeline_getSimulatedCurves","BIS_fnc_timeline_getTimeLeft","BIS_fnc_timeline_init","BIS_fnc_timeline_isFinished","BIS_fnc_timeline_isLooping","BIS_fnc_timeline_isPaused","BIS_fnc_timeline_isPlaying","BIS_fnc_timeline_play","BIS_fnc_timeline_setInterpMode","BIS_fnc_timeline_setLength","BIS_fnc_timeline_setLoop","BIS_fnc_timeline_setPause","BIS_fnc_timeline_setPlayRate","BIS_fnc_timeline_setPosition","BIS_fnc_timeline_simulateCurves","BIS_fnc_timeline_stop","BIS_fnc_timeline_tick","BIS_fnc_timeline_setReverse","BIS_fnc_timeline_isReverse"]},{"name":"BIS_fnc_timeline_getTimeLeft","title":"BIS fnc timeline getTimeLeft","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_getTimeLeft","revid":349090,"updated":"2023-11-08T14:47:26Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"The time left of given timeline.","syntaxes":[{"syntax":"[timeline] call BIS_fnc_timeline_getTimeLeft","params":[{"name":"timeline","type":"Object","description":"the timeline object","type_expr":"Object"}],"returns":{"type":"Number","type_expr":"Number","description":"returns time left"}}],"examples":[{"code":["private _timeLeft = [timeline] call BIS_fnc_timeline_getTimeLeft;"]}],"see_also":["BIS_fnc_timeline_deleted","BIS_fnc_timeline_cleanup","BIS_fnc_timeline_finish","BIS_fnc_timeline_getAlpha","BIS_fnc_timeline_getCurrentTime","BIS_fnc_timeline_getInterpMode","BIS_fnc_timeline_getLength","BIS_fnc_timeline_getPlayFromStart","BIS_fnc_timeline_getPlayRate","BIS_fnc_timeline_getPlayTime","BIS_fnc_timeline_getPosition","BIS_fnc_timeline_getSimulatedCurves","BIS_fnc_timeline_getStopTime","BIS_fnc_timeline_init","BIS_fnc_timeline_isFinished","BIS_fnc_timeline_isLooping","BIS_fnc_timeline_isPaused","BIS_fnc_timeline_isPlaying","BIS_fnc_timeline_play","BIS_fnc_timeline_setInterpMode","BIS_fnc_timeline_setLength","BIS_fnc_timeline_setLoop","BIS_fnc_timeline_setPause","BIS_fnc_timeline_setPlayRate","BIS_fnc_timeline_setPosition","BIS_fnc_timeline_simulateCurves","BIS_fnc_timeline_stop","BIS_fnc_timeline_tick","BIS_fnc_timeline_setReverse","BIS_fnc_timeline_isReverse"]},{"name":"BIS_fnc_timeline_init","title":"BIS fnc timeline init","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_init","revid":348102,"updated":"2023-11-08T11:31:57Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Initialized a timeline.","syntaxes":[{"syntax":"[timeline, initPosition, length, playRate, loop] call BIS_fnc_timeline_init","params":[{"name":"timeline","type":"Object","description":"the timeline object","type_expr":"Object"},{"name":"initPosition","type":"Number","optional":true,"default":"`_timeline getVariable [\"Pos\", 0.0]`","description":"initial position","type_expr":"Number","text":"initPosition: Number - (Optional, default `_timeline getVariable [\"Pos\", 0.0]`) initial position"},{"name":"length","type":"Number","optional":true,"default":"`_timeline getVariable [\"Length\", 10.0]`","description":"length","type_expr":"Number","text":"length: Number - (Optional, default `_timeline getVariable [\"Length\", 10.0]`) length"},{"name":"playRate","type":"Number","optional":true,"default":"`_timeline getVariable [\"PlayRate\", 1.0]`","description":"play rate","type_expr":"Number","text":"playRate: Number - (Optional, default `_timeline getVariable [\"PlayRate\", 1.0]`) play rate"},{"name":"loop","type":"Boolean","optional":true,"default":"`_timeline getVariable [\"Loop\", false]`","description":"true - loop enabled, false - loop disabled","type_expr":"Boolean","text":"loop: Boolean - (Optional, default `_timeline getVariable [\"Loop\", false]`) true - loop enabled, false - loop disabled"},{"name":"reverse","type":"Boolean","optional":true,"default":"`_timeline getVariable [\"Reverse\", false]`","description":"true - reverse, false - Do not reverse","type_expr":"Boolean","text":"reverse: Boolean - (Optional, default `_timeline getVariable [\"Reverse\", false]`) true - reverse, false - Do not reverse"},{"name":"playOnStart","type":"Boolean","optional":true,"default":"`_timeline getVariable [\"PlayFromStart\", false]`","description":"true - play at scenario start, false - Do not play at scenario start","type_expr":"Boolean","text":"playOnStart: Boolean - (Optional, default `_timeline getVariable [\"PlayFromStart\", false]`) true - play at scenario start, false - Do not play at scenario start"},{"name":"destroyWhenFinished","type":"Boolean","optional":true,"default":"`_timeline getVariable [\"DestroyWhenFinished\", false]`","description":"true - Destroy when done, false - Do not destroy when done","type_expr":"Boolean","text":"destroyWhenFinished: Boolean - (Optional, default `_timeline getVariable [\"DestroyWhenFinished\", false]`) true - Destroy when done, false - Do not destroy when done"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[timeline] call BIS_fnc_timeline_init;"]}],"see_also":["BIS_fnc_timeline_deleted","BIS_fnc_timeline_cleanup","BIS_fnc_timeline_finish"]},{"name":"BIS_fnc_timeline_isFinished","title":"BIS fnc timeline isFinished","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_isFinished","revid":349021,"updated":"2023-11-08T14:47:09Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Returns whether given timeline has finished.","syntaxes":[{"syntax":"[timeline] call BIS_fnc_timeline_isFinished","params":[{"name":"timeline","type":"Object","description":"the timeline object","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"returns true if finished, otherwise false"}}],"examples":[{"code":["private _isFinished = [timeline] call BIS_fnc_timeline_isFinished;"]}],"see_also":["BIS_fnc_timeline_deleted","BIS_fnc_timeline_cleanup","BIS_fnc_timeline_finish","BIS_fnc_timeline_getAlpha","BIS_fnc_timeline_getCurrentTime","BIS_fnc_timeline_getInterpMode","BIS_fnc_timeline_getLength","BIS_fnc_timeline_getPlayFromStart","BIS_fnc_timeline_getPlayRate","BIS_fnc_timeline_getPlayTime","BIS_fnc_timeline_getPosition","BIS_fnc_timeline_getSimulatedCurves","BIS_fnc_timeline_getStopTime","BIS_fnc_timeline_getTimeLeft","BIS_fnc_timeline_init","BIS_fnc_timeline_isLooping","BIS_fnc_timeline_isPaused","BIS_fnc_timeline_isPlaying","BIS_fnc_timeline_play","BIS_fnc_timeline_setInterpMode","BIS_fnc_timeline_setLength","BIS_fnc_timeline_setLoop","BIS_fnc_timeline_setPause","BIS_fnc_timeline_setPlayRate","BIS_fnc_timeline_setPosition","BIS_fnc_timeline_simulateCurves","BIS_fnc_timeline_stop","BIS_fnc_timeline_tick","BIS_fnc_timeline_setReverse","BIS_fnc_timeline_isReverse"]},{"name":"BIS_fnc_timeline_isLooping","title":"BIS fnc timeline isLooping","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_isLooping","revid":349014,"updated":"2023-11-08T14:47:06Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Returns whether given timeline is in loop mode.","syntaxes":[{"syntax":"[timeline] call BIS_fnc_timeline_isLooping","params":[{"name":"timeline","type":"Object","description":"the timeline object","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"returns true if looping, otherwise false"}}],"examples":[{"code":["private _isLooping = [timeline] call BIS_fnc_timeline_isLooping;"]}],"see_also":["BIS_fnc_timeline_deleted","BIS_fnc_timeline_cleanup","BIS_fnc_timeline_finish","BIS_fnc_timeline_getAlpha","BIS_fnc_timeline_getCurrentTime","BIS_fnc_timeline_getInterpMode","BIS_fnc_timeline_getLength","BIS_fnc_timeline_getPlayFromStart","BIS_fnc_timeline_getPlayRate","BIS_fnc_timeline_getPlayTime","BIS_fnc_timeline_getPosition","BIS_fnc_timeline_getSimulatedCurves","BIS_fnc_timeline_getStopTime","BIS_fnc_timeline_getTimeLeft","BIS_fnc_timeline_init","BIS_fnc_timeline_isFinished","BIS_fnc_timeline_isPaused","BIS_fnc_timeline_isPlaying","BIS_fnc_timeline_play","BIS_fnc_timeline_setInterpMode","BIS_fnc_timeline_setLength","BIS_fnc_timeline_setLoop","BIS_fnc_timeline_setPause","BIS_fnc_timeline_setPlayRate","BIS_fnc_timeline_setPosition","BIS_fnc_timeline_simulateCurves","BIS_fnc_timeline_stop","BIS_fnc_timeline_tick","BIS_fnc_timeline_setReverse","BIS_fnc_timeline_isReverse"]},{"name":"BIS_fnc_timeline_isPaused","title":"BIS fnc timeline isPaused","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_isPaused","revid":349074,"updated":"2023-11-08T14:47:22Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Returns whether given timeline is paused.","syntaxes":[{"syntax":"[timeline] call BIS_fnc_timeline_isPaused","params":[{"name":"timeline","type":"Object","description":"the timeline object","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"returns true if paused, otherwise false"}}],"examples":[{"code":["private _isPaused = [timeline] call BIS_fnc_timeline_isPaused;"]}],"see_also":["BIS_fnc_timeline_deleted","BIS_fnc_timeline_cleanup","BIS_fnc_timeline_finish","BIS_fnc_timeline_getAlpha","BIS_fnc_timeline_getCurrentTime","BIS_fnc_timeline_getInterpMode","BIS_fnc_timeline_getLength","BIS_fnc_timeline_getPlayFromStart","BIS_fnc_timeline_getPlayRate","BIS_fnc_timeline_getPlayTime","BIS_fnc_timeline_getPosition","BIS_fnc_timeline_getSimulatedCurves","BIS_fnc_timeline_getStopTime","BIS_fnc_timeline_getTimeLeft","BIS_fnc_timeline_init","BIS_fnc_timeline_isFinished","BIS_fnc_timeline_isLooping","BIS_fnc_timeline_isPlaying","BIS_fnc_timeline_play","BIS_fnc_timeline_setInterpMode","BIS_fnc_timeline_setLength","BIS_fnc_timeline_setLoop","BIS_fnc_timeline_setPause","BIS_fnc_timeline_setPlayRate","BIS_fnc_timeline_setPosition","BIS_fnc_timeline_simulateCurves","BIS_fnc_timeline_stop","BIS_fnc_timeline_tick","BIS_fnc_timeline_setReverse","BIS_fnc_timeline_isReverse"]},{"name":"BIS_fnc_timeline_isPlaying","title":"BIS fnc timeline isPlaying","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_isPlaying","revid":349035,"updated":"2023-11-08T14:47:13Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Whether given timeline is playing (can be paused at same time!)","syntaxes":[{"syntax":"[timeline] call BIS_fnc_timeline_isPlaying","params":[{"name":"timeline","type":"Object","description":"the timeline object","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"returns true if playing, otherwise false"}}],"examples":[{"code":["private _isPlaying = [timeline] call BIS_fnc_timeline_isPlaying;"]}],"see_also":["BIS_fnc_timeline_deleted","BIS_fnc_timeline_cleanup","BIS_fnc_timeline_finish","BIS_fnc_timeline_getAlpha","BIS_fnc_timeline_getCurrentTime","BIS_fnc_timeline_getInterpMode","BIS_fnc_timeline_getLength","BIS_fnc_timeline_getPlayFromStart","BIS_fnc_timeline_getPlayRate","BIS_fnc_timeline_getPlayTime","BIS_fnc_timeline_getPosition","BIS_fnc_timeline_getSimulatedCurves","BIS_fnc_timeline_getStopTime","BIS_fnc_timeline_getTimeLeft","BIS_fnc_timeline_init","BIS_fnc_timeline_isFinished","BIS_fnc_timeline_isLooping","BIS_fnc_timeline_isPaused","BIS_fnc_timeline_play","BIS_fnc_timeline_setInterpMode","BIS_fnc_timeline_setLength","BIS_fnc_timeline_setLoop","BIS_fnc_timeline_setPause","BIS_fnc_timeline_setPlayRate","BIS_fnc_timeline_setPosition","BIS_fnc_timeline_simulateCurves","BIS_fnc_timeline_stop","BIS_fnc_timeline_tick","BIS_fnc_timeline_setReverse","BIS_fnc_timeline_isReverse"]},{"name":"BIS_fnc_timeline_isReverse","title":"BIS fnc timeline isReverse","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_isReverse","revid":349013,"updated":"2023-11-08T14:47:06Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Whether given timeline is in reverse mode","syntaxes":[{"syntax":"[timeline] call BIS_fnc_timeline_isReverse","params":[{"name":"timeline","type":"Object","description":"the timeline object","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"returns true if timeline is reversed, otherwise false"}}],"examples":[{"code":["private _isReverse = [timeline] call BIS_fnc_timeline_isReverse;"]}],"see_also":["BIS_fnc_timeline_deleted","BIS_fnc_timeline_cleanup","BIS_fnc_timeline_finish","BIS_fnc_timeline_getAlpha","BIS_fnc_timeline_getCurrentTime","BIS_fnc_timeline_getInterpMode","BIS_fnc_timeline_getLength","BIS_fnc_timeline_getPlayFromStart","BIS_fnc_timeline_getPlayRate","BIS_fnc_timeline_getPlayTime","BIS_fnc_timeline_getPosition","BIS_fnc_timeline_getSimulatedCurves","BIS_fnc_timeline_getStopTime","BIS_fnc_timeline_getTimeLeft","BIS_fnc_timeline_init","BIS_fnc_timeline_isFinished","BIS_fnc_timeline_isLooping","BIS_fnc_timeline_isPaused","BIS_fnc_timeline_isPlaying","BIS_fnc_timeline_play","BIS_fnc_timeline_setInterpMode","BIS_fnc_timeline_setLength","BIS_fnc_timeline_setLoop","BIS_fnc_timeline_setPause","BIS_fnc_timeline_setPlayRate","BIS_fnc_timeline_setPosition","BIS_fnc_timeline_simulateCurves","BIS_fnc_timeline_stop","BIS_fnc_timeline_tick","BIS_fnc_timeline_setReverse"]},{"name":"BIS_fnc_timeline_play","title":"BIS fnc timeline play","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_play","revid":310481,"updated":"2022-05-06T11:01:58Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Play given timeline if currently not playing. If we are playing and paused, we unpause.","syntaxes":[{"syntax":"[timeline] call BIS_fnc_timeline_play","params":[{"name":"timeline","type":"Object","description":"the timeline object","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[timeline] call BIS_fnc_timeline_play;"]}],"see_also":["BIS_fnc_timeline_deleted","BIS_fnc_timeline_cleanup","BIS_fnc_timeline_finish","BIS_fnc_timeline_getAlpha","BIS_fnc_timeline_getCurrentTime","BIS_fnc_timeline_getInterpMode","BIS_fnc_timeline_getLength","BIS_fnc_timeline_getPlayFromStart","BIS_fnc_timeline_getPlayRate","BIS_fnc_timeline_getPlayTime","BIS_fnc_timeline_getPosition","BIS_fnc_timeline_getSimulatedCurves","BIS_fnc_timeline_getStopTime","BIS_fnc_timeline_getTimeLeft","BIS_fnc_timeline_init","BIS_fnc_timeline_isFinished","BIS_fnc_timeline_isLooping","BIS_fnc_timeline_isPaused","BIS_fnc_timeline_isPlaying","BIS_fnc_timeline_setInterpMode","BIS_fnc_timeline_setLength","BIS_fnc_timeline_setLoop","BIS_fnc_timeline_setPause","BIS_fnc_timeline_setPlayRate","BIS_fnc_timeline_setPosition","BIS_fnc_timeline_simulateCurves","BIS_fnc_timeline_stop","BIS_fnc_timeline_tick","BIS_fnc_timeline_setReverse","BIS_fnc_timeline_isReverse"]},{"name":"BIS_fnc_timeline_setInterpMode","title":"BIS fnc timeline setInterpMode","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_setInterpMode","revid":348070,"updated":"2023-11-08T11:29:53Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Set's the interpolation mode of the timeline.","syntaxes":[{"syntax":"[timeline, mode] call BIS_fnc_timeline_setInterpMode","params":[{"name":"timeline","type":"Object","description":"the timeline object","type_expr":"Object"},{"name":"mode","type":"Number","optional":true,"default":"0","description":"interpolation mode, see BIS_fnc_timeline_getInterpMode's return value for possible values","type_expr":"Number","text":"mode: Number - (Optional, default 0) interpolation mode, see BIS_fnc_timeline_getInterpMode's return value for possible values"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[timeline,15] call BIS_fnc_timeline_setInterpMode;"]}],"see_also":["BIS_fnc_timeline_deleted","BIS_fnc_timeline_cleanup","BIS_fnc_timeline_finish","BIS_fnc_timeline_getAlpha","BIS_fnc_timeline_getCurrentTime","BIS_fnc_timeline_getInterpMode","BIS_fnc_timeline_getLength","BIS_fnc_timeline_getPlayFromStart","BIS_fnc_timeline_getPlayRate","BIS_fnc_timeline_getPlayTime","BIS_fnc_timeline_getPosition","BIS_fnc_timeline_getSimulatedCurves","BIS_fnc_timeline_getStopTime","BIS_fnc_timeline_getTimeLeft","BIS_fnc_timeline_init","BIS_fnc_timeline_isFinished","BIS_fnc_timeline_isLooping","BIS_fnc_timeline_isPaused","BIS_fnc_timeline_isPlaying","BIS_fnc_timeline_play","BIS_fnc_timeline_setLength","BIS_fnc_timeline_setLoop","BIS_fnc_timeline_setPause","BIS_fnc_timeline_setPlayRate","BIS_fnc_timeline_setPosition","BIS_fnc_timeline_simulateCurves","BIS_fnc_timeline_stop","BIS_fnc_timeline_tick","BIS_fnc_timeline_setReverse","BIS_fnc_timeline_isReverse"]},{"name":"BIS_fnc_timeline_setLength","title":"BIS fnc timeline setLength","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_setLength","revid":348093,"updated":"2023-11-08T11:31:32Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Set's the length of this timeline in seconds.","syntaxes":[{"syntax":"[timeline, length] call BIS_fnc_timeline_setLength","params":[{"name":"timeline","type":"Object","description":"the timeline object","type_expr":"Object"},{"name":"length","type":"Number","optional":true,"default":"10","description":"new length","type_expr":"Number","text":"length: Number - (Optional, default 10) new length"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[timeline,5.5] call BIS_fnc_timeline_setLength;"]}],"see_also":["BIS_fnc_timeline_deleted","BIS_fnc_timeline_cleanup","BIS_fnc_timeline_finish","BIS_fnc_timeline_getAlpha","BIS_fnc_timeline_getCurrentTime","BIS_fnc_timeline_getInterpMode","BIS_fnc_timeline_getLength","BIS_fnc_timeline_getPlayFromStart","BIS_fnc_timeline_getPlayRate","BIS_fnc_timeline_getPlayTime","BIS_fnc_timeline_getPosition","BIS_fnc_timeline_getSimulatedCurves","BIS_fnc_timeline_getStopTime","BIS_fnc_timeline_getTimeLeft","BIS_fnc_timeline_init","BIS_fnc_timeline_isFinished","BIS_fnc_timeline_isLooping","BIS_fnc_timeline_isPaused","BIS_fnc_timeline_isPlaying","BIS_fnc_timeline_play","BIS_fnc_timeline_setInterpMode","BIS_fnc_timeline_setLoop","BIS_fnc_timeline_setPause","BIS_fnc_timeline_setPlayRate","BIS_fnc_timeline_setPosition","BIS_fnc_timeline_simulateCurves","BIS_fnc_timeline_stop","BIS_fnc_timeline_tick","BIS_fnc_timeline_setReverse","BIS_fnc_timeline_isReverse"]},{"name":"BIS_fnc_timeline_setLoop","title":"BIS fnc timeline setLoop","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_setLoop","revid":310501,"updated":"2022-05-06T11:02:18Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Set's this timeline playback loop mode","syntaxes":[{"syntax":"[timeline, loop] call BIS_fnc_timeline_setLoop","params":[{"name":"timeline","type":"Object","description":"the timeline object","type_expr":"Object"},{"name":"loop","type":"Boolean","optional":true,"default":"true","description":"true to enable loop, false to disable","type_expr":"Boolean","text":"loop: Boolean - (Optional, default true) true to enable loop, false to disable"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[timeline] call BIS_fnc_timeline_setLoop;"]}],"see_also":["BIS_fnc_timeline_deleted","BIS_fnc_timeline_cleanup","BIS_fnc_timeline_finish","BIS_fnc_timeline_getAlpha","BIS_fnc_timeline_getCurrentTime","BIS_fnc_timeline_getInterpMode","BIS_fnc_timeline_getLength","BIS_fnc_timeline_getPlayFromStart","BIS_fnc_timeline_getPlayRate","BIS_fnc_timeline_getPlayTime","BIS_fnc_timeline_getPosition","BIS_fnc_timeline_getSimulatedCurves","BIS_fnc_timeline_getStopTime","BIS_fnc_timeline_getTimeLeft","BIS_fnc_timeline_init","BIS_fnc_timeline_isFinished","BIS_fnc_timeline_isLooping","BIS_fnc_timeline_isPaused","BIS_fnc_timeline_isPlaying","BIS_fnc_timeline_play","BIS_fnc_timeline_setInterpMode","BIS_fnc_timeline_setLength","BIS_fnc_timeline_setPause","BIS_fnc_timeline_setPlayRate","BIS_fnc_timeline_setPosition","BIS_fnc_timeline_simulateCurves","BIS_fnc_timeline_stop","BIS_fnc_timeline_tick","BIS_fnc_timeline_setReverse","BIS_fnc_timeline_isReverse"]},{"name":"BIS_fnc_timeline_setPause","title":"BIS fnc timeline setPause","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_setPause","revid":310487,"updated":"2022-05-06T11:02:01Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Pauses or unpauses timeline.","syntaxes":[{"syntax":"[timeline, pause] call BIS_fnc_timeline_setPause","params":[{"name":"timeline","type":"Object","description":"the timeline object","type_expr":"Object"},{"name":"pause","type":"Boolean","optional":true,"default":"true","description":"true to pause, false to unpause","type_expr":"Boolean","text":"pause: Boolean - (Optional, default true) true to pause, false to unpause"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[timeline] call BIS_fnc_timeline_setPause;"]}],"see_also":["BIS_fnc_timeline_deleted","BIS_fnc_timeline_cleanup","BIS_fnc_timeline_finish","BIS_fnc_timeline_getAlpha","BIS_fnc_timeline_getCurrentTime","BIS_fnc_timeline_getInterpMode","BIS_fnc_timeline_getLength","BIS_fnc_timeline_getPlayFromStart","BIS_fnc_timeline_getPlayRate","BIS_fnc_timeline_getPlayTime","BIS_fnc_timeline_getPosition","BIS_fnc_timeline_getSimulatedCurves","BIS_fnc_timeline_getStopTime","BIS_fnc_timeline_getTimeLeft","BIS_fnc_timeline_init","BIS_fnc_timeline_isFinished","BIS_fnc_timeline_isLooping","BIS_fnc_timeline_isPaused","BIS_fnc_timeline_isPlaying","BIS_fnc_timeline_play","BIS_fnc_timeline_setInterpMode","BIS_fnc_timeline_setLength","BIS_fnc_timeline_setLoop","BIS_fnc_timeline_setPlayRate","BIS_fnc_timeline_setPosition","BIS_fnc_timeline_simulateCurves","BIS_fnc_timeline_stop","BIS_fnc_timeline_tick","BIS_fnc_timeline_setReverse","BIS_fnc_timeline_isReverse"]},{"name":"BIS_fnc_timeline_setPlayRate","title":"BIS fnc timeline setPlayRate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_setPlayRate","revid":348110,"updated":"2023-11-08T11:32:00Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Sets playrate of timeline.","syntaxes":[{"syntax":"[timeline, rate] call BIS_fnc_timeline_setPlayRate","params":[{"name":"timeline","type":"Object","description":"the timeline object","type_expr":"Object"},{"name":"rate","type":"Boolean","optional":true,"default":"1","description":"play rate","type_expr":"Boolean","text":"rate: Boolean - (Optional, default 1) play rate"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[timeline,2] call BIS_fnc_timeline_setPlayRate;"]}],"see_also":["BIS_fnc_timeline_deleted","BIS_fnc_timeline_cleanup","BIS_fnc_timeline_finish","BIS_fnc_timeline_getAlpha","BIS_fnc_timeline_getCurrentTime","BIS_fnc_timeline_getInterpMode","BIS_fnc_timeline_getLength","BIS_fnc_timeline_getPlayFromStart","BIS_fnc_timeline_getPlayRate","BIS_fnc_timeline_getPlayTime","BIS_fnc_timeline_getPosition","BIS_fnc_timeline_getSimulatedCurves","BIS_fnc_timeline_getStopTime","BIS_fnc_timeline_getTimeLeft","BIS_fnc_timeline_init","BIS_fnc_timeline_isFinished","BIS_fnc_timeline_isLooping","BIS_fnc_timeline_isPaused","BIS_fnc_timeline_isPlaying","BIS_fnc_timeline_play","BIS_fnc_timeline_setInterpMode","BIS_fnc_timeline_setLength","BIS_fnc_timeline_setLoop","BIS_fnc_timeline_setPause","BIS_fnc_timeline_setPosition","BIS_fnc_timeline_simulateCurves","BIS_fnc_timeline_stop","BIS_fnc_timeline_tick","BIS_fnc_timeline_setReverse","BIS_fnc_timeline_isReverse"]},{"name":"BIS_fnc_timeline_setPosition","title":"BIS fnc timeline setPosition","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_setPosition","revid":348107,"updated":"2023-11-08T11:31:59Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Sets position of timeline.","syntaxes":[{"syntax":"[timeline, position] call BIS_fnc_timeline_setPosition","params":[{"name":"timeline","type":"Object","description":"the timeline object","type_expr":"Object"},{"name":"position","type":"Boolean","optional":true,"default":"0","description":"position","type_expr":"Boolean","text":"position: Boolean - (Optional, default 0) position"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[timeline,2] call BIS_fnc_timeline_setPosition;"]}],"see_also":["BIS_fnc_timeline_deleted","BIS_fnc_timeline_cleanup","BIS_fnc_timeline_finish","BIS_fnc_timeline_getAlpha","BIS_fnc_timeline_getCurrentTime","BIS_fnc_timeline_getInterpMode","BIS_fnc_timeline_getLength","BIS_fnc_timeline_getPlayFromStart","BIS_fnc_timeline_getPlayRate","BIS_fnc_timeline_getPlayTime","BIS_fnc_timeline_getPosition","BIS_fnc_timeline_getSimulatedCurves","BIS_fnc_timeline_getStopTime","BIS_fnc_timeline_getTimeLeft","BIS_fnc_timeline_init","BIS_fnc_timeline_isFinished","BIS_fnc_timeline_isLooping","BIS_fnc_timeline_isPaused","BIS_fnc_timeline_isPlaying","BIS_fnc_timeline_play","BIS_fnc_timeline_setInterpMode","BIS_fnc_timeline_setLength","BIS_fnc_timeline_setLoop","BIS_fnc_timeline_setPause","BIS_fnc_timeline_setPlayRate","BIS_fnc_timeline_simulateCurves","BIS_fnc_timeline_stop","BIS_fnc_timeline_tick","BIS_fnc_timeline_setReverse","BIS_fnc_timeline_isReverse"]},{"name":"BIS_fnc_timeline_setReverse","title":"BIS fnc timeline setReverse","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_setReverse","revid":310700,"updated":"2022-05-06T11:18:29Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Change direction of timeline.","syntaxes":[{"syntax":"[timeline, reverse] call BIS_fnc_timeline_setReverse","params":[{"name":"timeline","type":"Object","description":"the timeline object","type_expr":"Object"},{"name":"reverse","type":"Boolean","optional":true,"default":"true","description":"true to reverse timeline, false to not reverse it","type_expr":"Boolean","text":"reverse: Boolean - (Optional, default true) true to reverse timeline, false to not reverse it"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[timeline, false] call BIS_fnc_timeline_setReverse;"]}],"see_also":["BIS_fnc_timeline_deleted","BIS_fnc_timeline_cleanup","BIS_fnc_timeline_finish","BIS_fnc_timeline_getAlpha","BIS_fnc_timeline_getCurrentTime","BIS_fnc_timeline_getInterpMode","BIS_fnc_timeline_getLength","BIS_fnc_timeline_getPlayFromStart","BIS_fnc_timeline_getPlayRate","BIS_fnc_timeline_getPlayTime","BIS_fnc_timeline_getPosition","BIS_fnc_timeline_getSimulatedCurves","BIS_fnc_timeline_getStopTime","BIS_fnc_timeline_getTimeLeft","BIS_fnc_timeline_init","BIS_fnc_timeline_isFinished","BIS_fnc_timeline_isLooping","BIS_fnc_timeline_isPaused","BIS_fnc_timeline_isPlaying","BIS_fnc_timeline_play","BIS_fnc_timeline_setInterpMode","BIS_fnc_timeline_setLength","BIS_fnc_timeline_setLoop","BIS_fnc_timeline_setPause","BIS_fnc_timeline_setPlayRate","BIS_fnc_timeline_setPosition","BIS_fnc_timeline_simulateCurves","BIS_fnc_timeline_stop","BIS_fnc_timeline_tick","BIS_fnc_timeline_isReverse"]},{"name":"BIS_fnc_timeline_simulateCurves","title":"BIS fnc timeline simulateCurves","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_simulateCurves","revid":379575,"updated":"2026-10-31T14:03:49Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Moves the objects animated by a timeline to the given point of the timeline. For every curve of the timeline (see BIS_fnc_timeline_getSimulatedCurves) the function:\n\n- modifies *alpha* according to the timeline's interpolation mode (see BIS_fnc_timeline_setInterpMode): linear, cubic, ease in/out, hermite, berp, bounce or quintic\n- evaluates the curve at the resulting alpha and moves all its simulated objects (BIS_fnc_richCurve_getSimulatedObjects) there with setPosASL\n- rotates the objects with setVectorDirAndUp according to the curve's orientation mode (see BIS_fnc_richCurve_setOrientationMode): orientation stored in the keys, looking at the curve's look-at position, or following the direction of movement; the rotation is smoothed over *deltaTime*\n- sets the field of view of simulated cameras (objects of kind \"Camera_F\") with BIS_fnc_camera_setFOV\n\nIn the Eden Editor, it also refreshes the curve's 3D drawing (BIS_fnc_richCurve_edenTick) and, if 3D icons are visible, draws an icon at the current position. Outside of Eden, once the curve reaches a key, the code stored in the key's \"Event\" variable is executed and the key's \"reached\" scripted event handler is called; each key does so only once (until the timeline loops).\n\nThe function is used internally by BIS_fnc_timeline_tick, which calls it every frame while the timeline is playing and not paused.","syntaxes":[{"syntax":"[timeline, alpha, deltaTime] call BIS_fnc_timeline_simulateCurves","params":[{"name":"timeline","type":"Object","description":"the timeline","type_expr":"Object"},{"name":"alpha","type":"Number","optional":true,"default":"0","description":"current position of the timeline, normalised to the range 0..1","type_expr":"Number","text":"alpha: Number - (Optional, default 0) current position of the timeline, normalised to the range 0..1"},{"name":"deltaTime","type":"Number","optional":true,"default":"0","description":"time since the last frame, in seconds; used to smooth the orientation","type_expr":"Number","text":"deltaTime: Number - (Optional, default 0) time since the last frame, in seconds; used to smooth the orientation"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[myTimeline, 0.5, 0] call BIS_fnc_timeline_simulateCurves; // moves the timeline's objects to the middle of the timeline"]}],"see_also":["BIS_fnc_timeline_tick","BIS_fnc_timeline_play","BIS_fnc_timeline_getSimulatedCurves","BIS_fnc_timeline_setInterpMode","BIS_fnc_richCurve_setOrientationMode"]},{"name":"BIS_fnc_timeline_stop","title":"BIS fnc timeline stop","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_stop","revid":310495,"updated":"2022-05-06T11:02:11Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Stops a timeline.","syntaxes":[{"syntax":"[timeline] call BIS_fnc_timeline_stop","params":[{"name":"timeline","type":"Object","description":"the timeline object","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[timeline] call BIS_fnc_timeline_stop;"]}],"see_also":["BIS_fnc_timeline_deleted","BIS_fnc_timeline_cleanup","BIS_fnc_timeline_finish","BIS_fnc_timeline_getAlpha","BIS_fnc_timeline_getCurrentTime","BIS_fnc_timeline_getInterpMode","BIS_fnc_timeline_getLength","BIS_fnc_timeline_getPlayFromStart","BIS_fnc_timeline_getPlayRate","BIS_fnc_timeline_getPlayTime","BIS_fnc_timeline_getPosition","BIS_fnc_timeline_getSimulatedCurves","BIS_fnc_timeline_getStopTime","BIS_fnc_timeline_getTimeLeft","BIS_fnc_timeline_init","BIS_fnc_timeline_isFinished","BIS_fnc_timeline_isLooping","BIS_fnc_timeline_isPaused","BIS_fnc_timeline_isPlaying","BIS_fnc_timeline_play","BIS_fnc_timeline_setInterpMode","BIS_fnc_timeline_setLength","BIS_fnc_timeline_setLoop","BIS_fnc_timeline_setPause","BIS_fnc_timeline_setPlayRate","BIS_fnc_timeline_setPosition","BIS_fnc_timeline_simulateCurves","BIS_fnc_timeline_tick","BIS_fnc_timeline_setReverse","BIS_fnc_timeline_isReverse"]},{"name":"BIS_fnc_timeline_tick","title":"BIS fnc timeline tick","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeline_tick","revid":310494,"updated":"2022-05-06T11:02:11Z","groups":["Timeline"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Ticks a timeline.","syntaxes":[{"syntax":"[timeline] call BIS_fnc_timeline_tick","params":[{"name":"timeline","type":"Object","description":"the timeline object","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[timeline] call BIS_fnc_timeline_tick;"]}],"see_also":["BIS_fnc_timeline_deleted","BIS_fnc_timeline_cleanup","BIS_fnc_timeline_finish","BIS_fnc_timeline_getAlpha","BIS_fnc_timeline_getCurrentTime","BIS_fnc_timeline_getInterpMode","BIS_fnc_timeline_getLength","BIS_fnc_timeline_getPlayFromStart","BIS_fnc_timeline_getPlayRate","BIS_fnc_timeline_getPlayTime","BIS_fnc_timeline_getPosition","BIS_fnc_timeline_getSimulatedCurves","BIS_fnc_timeline_getStopTime","BIS_fnc_timeline_getTimeLeft","BIS_fnc_timeline_init","BIS_fnc_timeline_isFinished","BIS_fnc_timeline_isLooping","BIS_fnc_timeline_isPaused","BIS_fnc_timeline_isPlaying","BIS_fnc_timeline_play","BIS_fnc_timeline_setInterpMode","BIS_fnc_timeline_setLength","BIS_fnc_timeline_setLoop","BIS_fnc_timeline_setPause","BIS_fnc_timeline_setPlayRate","BIS_fnc_timeline_setPosition","BIS_fnc_timeline_simulateCurves","BIS_fnc_timeline_stop","BIS_fnc_timeline_setReverse","BIS_fnc_timeline_isReverse"]},{"name":"BIS_fnc_timeToString","title":"BIS fnc timeToString","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_timeToString","revid":327131,"updated":"2022-07-12T21:45:21Z","groups":["Strings"],"status":"ok","games":{"arma3":"0.50"},"since":"arma3 0.50","arma3_since":"0.50","locality":{"argument":"local","effect":"local"},"description":"This function returns a 24-hour time as a string (or array) from a decimal.","syntaxes":[{"syntax":"[time, format] call BIS_fnc_timeToString","params":[{"name":"time","type":"Number","description":"time to convert (format dayTime)","type_expr":"Number"},{"name":"format","type":"String","optional":true,"default":"\"HH:MM:SS\"","description":"one of the following:\n\n- \"HH\" - Hour\n- \"HH:MM\" - Hour:Minute\n- \"HH:MM:SS\" - Hour:Minute:Seconds\n- \"HH:MM:SS:MM\" - Hour:Minute:Seconds:Milliseconds\n- \"ARRAY\" - [Hour, Minute, Seconds, Milliseconds]","type_expr":"String","text":"format: String - (Optional, default \"HH:MM:SS\") one of the following:\n\n- \"HH\" - Hour\n- \"HH:MM\" - Hour:Minute\n- \"HH:MM:SS\" - Hour:Minute:Seconds\n- \"HH:MM:SS:MM\" - Hour:Minute:Seconds:Milliseconds\n- \"ARRAY\" - [Hour, Minute, Seconds, Milliseconds]"}],"returns":{"type":"String or Array","type_expr":"String | Array"}}],"examples":[{"code":["private _time = 7.36;\n[_time] call BIS_fnc_timeToString; // 07:21:36"]},{"code":["private _time = 7.36;\n[_time, \"HH:MM\"] call BIS_fnc_timeToString; // 07:21"]}],"see_also":["time","dayTime","BIS_fnc_secondsToString"]},{"name":"BIS_fnc_titlecard","title":"BIS fnc titlecard","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_titlecard","revid":348972,"updated":"2023-11-08T14:45:44Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Display a mission-specific titlecard before the mission begins. Only works the first time it is called.","syntaxes":[{"syntax":"[path, subtitle] call BIS_fnc_titlecard","params":[{"name":"path","type":"String","description":"path to video","type_expr":"String"},{"name":"subtitle","type":"String","optional":true,"default":"\"\"","description":"subtitle displayed","type_expr":"String","text":"subtitle: String - (Optional, default \"\") subtitle displayed"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[\"\\a3\\missions_f_epb\\video\\b_out2_quotation.ogv\", \"your translation\"] call BIS_fnc_titlecard;"]}],"see_also":["allCutLayers","titleRsc","cutText","cutObj","cutFadeOut","setTitleEffect"]},{"name":"BIS_fnc_titleText","title":"BIS fnc titleText","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_titleText","revid":349598,"updated":"2023-11-14T13:35:38Z","groups":["GUI"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","description":"Display given string as structured text.\n\n> [!NOTE]\n> **Arma 3:** In Arma 3 this function displays a bottom-left message, limited to two lines of approximately 53 characters each.","syntaxes":[{"syntax":"message call BIS_fnc_titleText","params":[{"name":"message","type":"String","description":"Structured Text formatting supported","type_expr":"String"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when done"}}],"examples":[{"code":["\"Stratis, 2035-07-14 0130<br />A dark night ahead…\" call BIS_fnc_titleText;"]}],"see_also":["BIS_fnc_dynamicText","BIS_fnc_typeText","BIS_fnc_typeText2"]},{"name":"BIS_fnc_toggleCuratorVisionMode","title":"BIS fnc toggleCuratorVisionMode","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_toggleCuratorVisionMode","revid":348439,"updated":"2023-11-08T13:00:14Z","groups":["Curator"],"status":"ok","games":{"arma3":"1.16"},"since":"arma3 1.16","arma3_since":"1.16","description":"Toggle curator vision mode.","syntaxes":[{"syntax":"[curator, mode] call BIS_fnc_toggleCuratorVisionMode","params":[{"name":"curator","type":"Object","description":"curator","type_expr":"Object"},{"name":"mode","type":"Number","optional":true,"default":"1","description":"mode index","type_expr":"Number","text":"mode: Number - (Optional, default 1) mode index"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[Curator, -2] call BIS_fnc_toggleCuratorVisionMode;"]}],"see_also":["BIS_fnc_curatorVisionModes","Arma 3: Curator"]},{"name":"BIS_fnc_toUpperDisplayTexts","title":"BIS fnc toUpperDisplayTexts","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_toUpperDisplayTexts","revid":348378,"updated":"2023-11-08T12:59:58Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Converts text of selected classes in one display to upper-case except classes with name **PlayersName**. Also searches inside CT_CONTROLS_GROUPs.","syntaxes":[{"syntax":"[displayClass, controlClasses, blacklist] call BIS_fnc_toUpperDisplayTexts","params":[{"name":"displayClass","type":"String","description":"class name of the display to manipulate","type_expr":"String"},{"name":"controlClasses","type":"Array of Strings","description":"class names of parents of controls you want to turn upper case (e. g. [\"RscText\", \"RscTitle\"])","type_expr":"Array<String>"},{"name":"blacklist","type":"Array of Strings","optional":true,"default":"[]","description":"Class names of controls you don't want to turn upper case (e. g. [\"CA_VehicleAuthor\"])","type_expr":"Array<String>","text":"blacklist: Array of Strings - (Optional: Default []) Class names of controls you don't want to turn upper case (e. g. [\"CA_VehicleAuthor\"])"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"RscDisplayOptionsAudio\", [\"RscText\"]] call BIS_fnc_toUpperDisplayTexts;"]}],"see_also":["BIS_fnc_displayName"]},{"name":"BIS_fnc_traceBullets","title":"BIS fnc traceBullets","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_traceBullets","revid":329387,"updated":"2022-07-27T13:25:25Z","groups":["Diagnostic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Visualise unit's bullet trajectories. Can only be used on one shooter in a single instance.\nIf you want to change the unit, first set `BIS_tracedShooter = nil` *then* execute the script again.","syntaxes":[{"syntax":"[unit, number] call BIS_fnc_traceBullets","params":[{"name":"unit","type":"Object","type_expr":"Object"},{"name":"number","type":"Number","optional":true,"default":"20","description":"maximum displayed trajectories","type_expr":"Number","text":"number: Number - (Optional, default 20) maximum displayed trajectories"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[player] spawn BIS_fnc_traceBullets;"]},{"code":["[player, 50] spawn BIS_fnc_traceBullets;"]},{"code":["[player, 0] spawn BIS_fnc_traceBullets; // remove bullet tracing"]}],"see_also":["drawLine3D"],"notes":[{"user":"Benargee","date":"2015-03-26T23:25:00Z","text":"Shooting bullets over water will show wavy lines that move with motion of the waves. This is probably due to using the wrong getPos variants when drawing 3D lines."}]},{"name":"BIS_fnc_trackMissionTime","title":"BIS fnc trackMissionTime","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_trackMissionTime","revid":328347,"updated":"2022-07-13T16:00:46Z","groups":["Missions"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Tracks mission time by storing time in profileNamespace.","syntaxes":[{"syntax":"[save, delete] call BIS_fnc_trackMissionTime","params":[{"name":"save","type":"Boolean","optional":true,"default":"true","type_expr":"Boolean","text":"save: Boolean (Optional, default true)"},{"name":"delete","type":"Boolean","optional":true,"default":"false","type_expr":"Boolean","text":"delete: Boolean (Optional, default false)"}],"returns":{"type":"Number","type_expr":"Number","description":"time result"}}],"examples":[{"code":["[true, true] call BIS_fnc_trackMissionTime; // Delete saved mission time"]},{"code":["[true] call BIS_fnc_trackMissionTime; // Save mission time"]}],"see_also":["time","serverTime","systemTime"]},{"name":"BIS_fnc_transformVectorDirAndUp","title":"BIS fnc transformVectorDirAndUp","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_transformVectorDirAndUp","revid":352125,"updated":"2024-02-01T23:25:06Z","groups":["Vectors"],"status":"ok","games":{"arma3":"1.98"},"since":"arma3 1.98","arma3_since":"1.98","description":"Rotates both vectorDir and vectorUp on 3 axes: z (yaw), x (pitch) and y (roll). Positive angle direction is according to the [right hand rule](https://en.wikipedia.org/wiki/Right-hand_rule).\n\n> [!NOTE]\n> The vectors are rotated first on **z** axis then on **x** axis then on **y** axis. For example standard [[0,1,0],[0,0,1]] pair rotated 90 degrees on every axis will result in [[0,0,1],[0,-1,0]]","syntaxes":[{"syntax":"[vectorDirAndUp, yaw, pitch, roll] call BIS_fnc_transformVectorDirAndUp","params":[{"name":"vectorDirAndUp","type":"Array in format [vectorDir, vectorUp] -","optional":true,"default":"[[0,1,0],[0,0,1]]","type_expr":"Array","text":"vectorDirAndUp: Array in format [vectorDir, vectorUp] -(Optional, default [[0,1,0],[0,0,1]])"},{"name":"yaw","type":"Number","optional":true,"default":"0","description":"yaw angle","type_expr":"Number","text":"yaw: Number - (Optional, default 0) yaw angle"},{"name":"pitch","type":"Number","optional":true,"default":"0","description":"pitch angle","type_expr":"Number","text":"pitch: Number - (Optional, default 0) pitch angle"},{"name":"roll","type":"Number","optional":true,"default":"0","description":"roll angle","type_expr":"Number","text":"roll: Number - (Optional, default 0) roll angle"}],"returns":{"type":"Array","type_expr":"Array","description":"in format [vectorDir, vectorUp]","text":"Array in format [vectorDir, vectorUp]"}}],"examples":[{"code":["private _vDirUp = [[vectorDirVisual uav, vectorUpVisual uav], 0, 0, 90] call BIS_fnc_transformVectorDirAndUp;"]},{"text":"Create UAV object and make it pitch with mouse up/down and roll with mouse left/right:\n\n```sqf\nuav = \"B_UAV_05_F\" createVehicle [0,0,0];\nuav attachTo [player, [0,30,10]];\nfindDisplay 46 displayAddEventHandler [\"MouseMoving\",\n{\n    uav setVectorDirAndUp\n    (\n        [\n            [vectorDirVisual uav, vectorUpVisual uav],\n            getDirVisual uav,\n            _this select 2,\n            _this select 1\n        ]\n        call BIS_fnc_transformVectorDirAndUp\n    );\n}];\n```","code":["uav = \"B_UAV_05_F\" createVehicle [0,0,0];\nuav attachTo [player, [0,30,10]];\nfindDisplay 46 displayAddEventHandler [\"MouseMoving\", \n{\n\tuav setVectorDirAndUp\n\t(\n\t\t[\n\t\t\t[vectorDirVisual uav, vectorUpVisual uav],\n\t\t\tgetDirVisual uav,\n\t\t\t_this select 2,\n\t\t\t_this select 1\n\t\t]\n\t\tcall BIS_fnc_transformVectorDirAndUp\n\t);\n}];"]}],"see_also":["vectorDir","vectorUp","setVectorDirAndUp"]},{"name":"BIS_fnc_transportService","title":"BIS fnc transportService","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_transportService","revid":327739,"updated":"2022-07-13T10:40:56Z","groups":["Supports"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Transportation system","syntaxes":[{"syntax":"[caller, vehicle, position, mainScope, secopScope] call BIS_fnc_transportService","params":[{"name":"param1","type":"Object","type_expr":"Object","description":"<object> unit allowed to use the transport system","text":"1: <object> unit allowed to use the transport system","source":"docblock"},{"name":"param2","type":"Object","type_expr":"Object","description":"<object> vehicle providing transport","text":"2: <object> vehicle providing transport","source":"docblock"},{"name":"param3","type":"Array","type_expr":"Array","optional":true,"description":"<array> positions to be chosen by player; accepted strings are \"pickup\" and \"unload\", the second position is defined by the next paramter (OPTIONAL)","text":"3: <array> positions to be chosen by player; accepted strings are \"pickup\" and \"unload\", the second position is defined by the next paramter (OPTIONAL)","source":"docblock"},{"name":"param4","type":"Position","type_expr":"Position","description":"<position> (NEEDED ONLY IF PARAMETER #3 IS USED)","text":"4: <position> (NEEDED ONLY IF PARAMETER #3 IS USED)","source":"docblock"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"notes":[{"user":"Lou Montana","date":"2018-04-28T00:21:00Z","text":"*caller* can only be player due to Arma 2 design: FSM overrides by `_clicker = player` instead of `_clicker = _this select 0`).\nParameters displayed are incorrect, these are:\n\n```sqf\n_caller        = _this select 0;\n_veh        = _this select 1;\n_passedPos    = _this select 2;\n_mainScope    = _this select 3;\n_secopScope    = _this select 4;\n\nif (count _this > 5) then\n{\n    _supportType = _this select 5;\n};\n```"}],"docblock":{"text":"File: transportService.sqf\n\nDescription:\nTransportation system\n\nParameter(s):\n1: <object> unit allowed to use the transport system\n2: <object> vehicle providing transport\n3: <array> positions to be chosen by player; accepted strings are \"pickup\" and \"unload\", the second position is defined by the next paramter (OPTIONAL)\n4: <position> (NEEDED ONLY IF PARAMETER #3 IS USED)\n\nReturns:\nN/A","meta":{"file":"transportService.sqf"}},"filled_from_docblock":["description","params"]},{"name":"BIS_fnc_tridentClient","title":"BIS fnc tridentClient","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_tridentClient","revid":275370,"updated":"2021-06-13T03:26:28Z","groups":["Sides"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"","params":[],"returns":null}]},{"name":"BIS_fnc_tridentExecute","title":"BIS fnc tridentExecute","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_tridentExecute","revid":348481,"updated":"2023-11-08T13:00:28Z","groups":["Sides"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Execute a code based on Trident relationship.","syntaxes":[{"syntax":"[side_1, side_2, codeFriendly, codeEnemy] call BIS_fnc_tridentExecute","params":[{"name":"side_1","type":"Side","type_expr":"Side"},{"name":"side_2","type":"Side","type_expr":"Side"},{"name":"codeFriendly","type":"Code","description":"code executed when sides are friendly. Arguments passed to the code are:\n\n- 0: Side - Side with higher score (when the score is even, side from param 0 is used)\n- 1: Side - Side with lower score (when the score is even, side from param 1 is used)\n- 2: Boolean - true when the sides are allied","type_expr":"Code"},{"name":"codeEnemy","type":"Code","description":"code executed when sides are enemy","type_expr":"Code"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when the sides are allied"}}],"examples":[{"code":["[west, east, { params [\"_higherScore\", \"_lowerScore\", \"_areAllied\"] }] call BIS_fnc_tridentExecute;"]}],"see_also":["BIS_fnc_tridentGetRelationship","BIS_fnc_tridentHandleDamage","BIS_fnc_tridentSetRelationship"]},{"name":"BIS_fnc_tridentGetRelationship","title":"BIS fnc tridentGetRelationship","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_tridentGetRelationship","revid":349070,"updated":"2023-11-08T14:47:22Z","groups":["Sides"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Gets the relationship of competing Trident sides. The value slowly decreases towards 0.","syntaxes":[{"syntax":"[sideA, sideB] call BIS_fnc_tridentGetRelationship","params":[{"name":"sideA","type":"Side","type_expr":"Side"},{"name":"sideB","type":"Side","type_expr":"Side"}],"returns":{"type":"Number","type_expr":"Number","description":"relationship value"}}],"examples":[{"code":["[west, east] call BIS_fnc_tridentGetRelationship;"]}],"see_also":["BIS_fnc_tridentSetRelationship","BIS_fnc_tridentHandleDamage","BIS_fnc_tridentExecute"]},{"name":"BIS_fnc_tridentHandleDamage","title":"BIS fnc tridentHandleDamage","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_tridentHandleDamage","revid":325064,"updated":"2022-07-01T12:23:56Z","groups":["Sides"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Register a unit as Trident unit.\nWhen competing sides are still friendly and the unit is killed by the competing side,\nthe killer won't be punsihed by negative score. Instead, Trident relationship will decrease.","syntaxes":[{"syntax":"object call BIS_fnc_tridentHandleDamage","params":[{"name":"object","type":"Object","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true if event handler managing the functionality was added, false when it existed already"}}],"examples":[{"code":["BIS_tridentObject call BIS_fnc_tridentHandleDamage;"]}],"see_also":["BIS_fnc_tridentSetRelationship","BIS_fnc_tridentGetRelationship","BIS_fnc_tridentExecute"]},{"name":"BIS_fnc_tridentSetRelationship","title":"BIS fnc tridentSetRelationship","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_tridentSetRelationship","revid":348465,"updated":"2023-11-08T13:00:19Z","groups":["Sides"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Set relationship of competing Trident sides.\nWhen the value reaches threshold, side relationship will change.\nThe value slowly decreases towards 0.","syntaxes":[{"syntax":"[side1, side2, value, absolute] call BIS_fnc_tridentSetRelationship","params":[{"name":"side1","type":"Side","type_expr":"Side"},{"name":"side2","type":"Side","type_expr":"Side"},{"name":"value","type":"Number","description":"changed value","type_expr":"Number"},{"name":"absolute","type":"Boolean","description":"true to add the value, false to set the value","type_expr":"Boolean"}],"returns":{"type":"Number","type_expr":"Number","description":"relationship value after changes"}}],"examples":[{"code":["[west, east, 0.5, true] call BIS_fnc_tridentSetRelationship;"]}],"see_also":["BIS_fnc_tridentGetRelationship","BIS_fnc_tridentHandleDamage","BIS_fnc_tridentExecute"]},{"name":"BIS_fnc_triggerToMarker","title":"BIS fnc triggerToMarker","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_triggerToMarker","revid":328350,"updated":"2022-07-13T16:00:46Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"effect":"local"},"description":"Makes an existing or new trigger cover a marker area.","syntaxes":[{"syntax":"[trigger, markerName] call BIS_fnc_triggerToMarker","params":[{"name":"trigger","type":"Object","description":"trigger that will be used to cover the marker. objNull to create a new trigger","type_expr":"Object"},{"name":"markerName","type":"String","type_expr":"String"}],"returns":{"type":"Object","type_expr":"Object","description":"the (created) trigger. objNull if marker is not rectangular or elliptical."}}],"examples":[{"code":["private _createdTrigger = [objNull, myAreaTrigger] call BIS_fnc_triggerToMarker;"]}],"see_also":["BIS_fnc_markerToTrigger"]},{"name":"BIS_fnc_trimString","title":"BIS fnc trimString","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_trimString","revid":340879,"updated":"2023-05-13T21:38:38Z","groups":["Strings"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Get a substring out of the string.\n\n> [!NOTE]\n> **Arma 3:** Use select instead.","syntaxes":[{"syntax":"[someText, beginning, length] call BIS_fnc_trimString","params":[{"name":"someText","type":"String","description":"source string","type_expr":"String"},{"name":"beginning","type":"Number","optional":true,"default":"0","description":"start index; indexing starts at 0","type_expr":"Number","text":"beginning: Number (Optional, default 0) - start index; indexing starts at 0"},{"name":"length","type":"Number","optional":true,"default":"end of string","description":"end index. A negative number means X chars *from the string end*","type_expr":"Number","text":"length: Number (Optional, default end of string) - end index. A negative number means X chars *from the string end*"}],"returns":{"type":"String","type_expr":"String"}}],"examples":[{"text":"```sqf\n[\"dreaded_is_the_man\", 0, 6] call BIS_fnc_trimString;    // will return \"dreaded\"\n```","code":["[\"dreaded_is_the_man\", 0, 6] call BIS_fnc_trimString;\t// will return \"dreaded\""]},{"text":"```sqf\n[\"dreaded_is_the_man\", 15] call BIS_fnc_trimString;    // will return \"man\"\n```","code":["[\"dreaded_is_the_man\", 15] call BIS_fnc_trimString;\t// will return \"man\""]},{"text":"```sqf\n[\"dreaded_is_the_man\"] call BIS_fnc_trimString;        // will return \"dreaded_is_the_man\"\n```","code":["[\"dreaded_is_the_man\"] call BIS_fnc_trimString;\t\t// will return \"dreaded_is_the_man\""]}],"see_also":["select"],"notes":[{"user":"R3vo","date":"2017-08-24T15:45:00Z","text":"```sqf\n\"test\" select [0, 4];                        // 0.0007 ms\n[\"test\", 0, 4] call BIS_fnc_trimString;    // 0.013 ms\n```\n\nThe first method is about **18 times faster**."}]},{"name":"BIS_fnc_turretConfig","title":"BIS fnc turretConfig","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_turretConfig","revid":378551,"updated":"2026-05-05T15:09:52Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Returns vehicle turret config for the turret given by the turret path.","syntaxes":[{"syntax":"[vehicle, turret] call BIS_fnc_turretConfig","params":[{"name":"vehicle","type":"Object or String","description":"vehicle or vehicle type","type_expr":"Object | String"},{"name":"turret","type":"Turret Path","type_expr":"Turret Path"}],"returns":{"type":"Config","type_expr":"Config","description":"turret config or configNull. Using `[-1]` for turret path returns vehicle config"}}],"examples":[{"code":["getNumber ([\"B_APC_Wheeled_01_cannon_F\", [0,0]] call BIS_fnc_turretConfig >> \"hasGunner\") > 0;"]},{"code":["getNumber ([car1, [-1]] call BIS_fnc_turretConfig >> \"hasDriver\") > 0;"]}],"see_also":["BIS_fnc_vehicleCrewTurrets","BIS_fnc_allTurrets"]},{"name":"BIS_fnc_twoWingDoorNoHandleClose","title":"BIS fnc twoWingDoorNoHandleClose","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_twoWingDoorNoHandleClose","revid":274282,"updated":"2021-06-13T01:19:57Z","groups":["Scripts"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_twoWingDoorNoHandleClose","params":[],"returns":null}]},{"name":"BIS_fnc_twoWingDoorNoHandleOpen","title":"BIS fnc twoWingDoorNoHandleOpen","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_twoWingDoorNoHandleOpen","revid":274437,"updated":"2021-06-13T01:22:34Z","groups":["Scripts"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_twoWingDoorNoHandleOpen","params":[],"returns":null}]},{"name":"BIS_fnc_twoWingDoorOneHandleClose","title":"BIS fnc twoWingDoorOneHandleClose","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_twoWingDoorOneHandleClose","revid":274432,"updated":"2021-06-13T01:22:31Z","groups":["Scripts"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_twoWingDoorOneHandleClose","params":[],"returns":null}]},{"name":"BIS_fnc_twoWingDoorOneHandleOpen","title":"BIS fnc twoWingDoorOneHandleOpen","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_twoWingDoorOneHandleOpen","revid":274346,"updated":"2021-06-13T01:21:08Z","groups":["Scripts"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_twoWingDoorOneHandleOpen","params":[],"returns":null}]},{"name":"BIS_fnc_twoWingDoorTwoHandleClose","title":"BIS fnc twoWingDoorTwoHandleClose","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_twoWingDoorTwoHandleClose","revid":274405,"updated":"2021-06-13T01:22:07Z","groups":["Scripts"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_twoWingDoorTwoHandleClose","params":[],"returns":null}]},{"name":"BIS_fnc_twoWingDoorTwoHandleOpen","title":"BIS fnc twoWingDoorTwoHandleOpen","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_twoWingDoorTwoHandleOpen","revid":274423,"updated":"2021-06-13T01:22:22Z","groups":["Scripts"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_twoWingDoorTwoHandleOpen","params":[],"returns":null}]},{"name":"BIS_fnc_twoWingSlideDoorClose","title":"BIS fnc twoWingSlideDoorClose","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_twoWingSlideDoorClose","revid":274329,"updated":"2021-06-13T01:20:45Z","groups":["Scripts"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_twoWingSlideDoorClose","params":[],"returns":null}]},{"name":"BIS_fnc_twoWingSlideDoorOpen","title":"BIS fnc twoWingSlideDoorOpen","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_twoWingSlideDoorOpen","revid":274305,"updated":"2021-06-13T01:20:13Z","groups":["Scripts"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_twoWingSlideDoorOpen","params":[],"returns":null}]},{"name":"BIS_fnc_typeText","title":"BIS fnc typeText","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_typeText","revid":379283,"updated":"2026-10-30T23:45:54Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"effect":"local"},"exec":"spawn","description":"Types a structured text on the screen, letter by letter, cursor blinking.","syntaxes":[{"syntax":"[stringLines, posX, posY, rootFormat] spawn BIS_fnc_typeText","params":[{"name":"stringLines","type":"Array of Strings or Array of Arrays","description":"Array of Strings or Array of Arrays\n\n- Array of Strings - array containing lines of text with same structured text formatting.\n- Array of Arrays format [text, format, blinkCount]:\n  - text: String - (Optional, default \"\")\n  - format: String - (Optional, default \"<t align = 'center' shadow = '1' size = '0.7'>%1</t><br/>\")\n  - blinkCount: Number - (Optional, default 5) number of cursor blinks after text typing","type_expr":"Array<String> | Array<Array>","text":"stringLines: Array of Strings or Array of Arrays\n\n- Array of Strings - array containing lines of text with same structured text formatting.\n- Array of Arrays format [text, format, blinkCount]:\n  - text: String - (Optional, default \"\")\n  - format: String - (Optional, default \"<t align = 'center' shadow = '1' size = '0.7'>%1</t><br/>\")\n  - blinkCount: Number - (Optional, default 5) number of cursor blinks after text typing"},{"name":"posX","type":"Number","optional":true,"default":"0","type_expr":"Number","text":"posX: Number - (Optional, default 0)"},{"name":"posY","type":"Number","optional":true,"default":"0","type_expr":"Number","text":"posY: Number - (Optional, default 0)"},{"name":"rootFormat","type":"String","optional":true,"default":"\"<t>%1</t>\"","description":"the parent format","type_expr":"String","text":"rootFormat: String - (Optional, default \"<t>%1</t>\") the parent format"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"```sqf\n[\n    [\n        [\"CAMP ROGAIN,\", \"<t align = 'center' shadow = '1' size = '0.7' font='PuristaBold'>%1</t>\"],\n        [\"RESUPPLY POINT\", \"<t align = 'center' shadow = '1' size = '0.7'>%1</t><br/>\"],\n        [\"10 MINUTES LATER ...\", \"<t align = 'center' shadow = '1' size = '1.0'>%1</t>\", 15]\n    ]\n] spawn BIS_fnc_typeText;\n```","code":["[\n\t[\n\t\t[\"CAMP ROGAIN,\", \"<t align = 'center' shadow = '1' size = '0.7' font='PuristaBold'>%1</t>\"],\n\t\t[\"RESUPPLY POINT\", \"<t align = 'center' shadow = '1' size = '0.7'>%1</t><br/>\"],\n\t\t[\"10 MINUTES LATER ...\", \"<t align = 'center' shadow = '1' size = '1.0'>%1</t>\", 15]\n\t]\n] spawn BIS_fnc_typeText;"]},{"text":"```sqf\n[\n    [\n        [\"Hello there...\", nil, 30]\n    ],\n    0, safeZoneY + safeZoneH / 2\n] spawn BIS_fnc_typeText;\n```","code":["[\n\t[\n\t\t[\"Hello there...\", nil, 30]\n\t],\n\t0, safeZoneY + safeZoneH / 2\n] spawn BIS_fnc_typeText;"]}],"see_also":["BIS_fnc_dynamicText","BIS_fnc_infoText","BIS_fnc_textTiles","BIS_fnc_typeText2"]},{"name":"BIS_fnc_typeText2","title":"BIS fnc typeText2","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_typeText2","revid":379284,"updated":"2026-10-30T23:46:02Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"effect":"local"},"exec":"spawn","description":"Types a structured text on the screen, letter by letter, cursor blinking. Note that line returns are manual, unlike BIS_fnc_typeText.","syntaxes":[{"syntax":"[stringLines, posX, posY, alignBottom, rootFormat, abortParams, abortCond, playSounds] call BIS_fnc_typeText2","params":[{"name":"stringLines","type":"Array of Strings or Array of Array of Strings","description":"Array of Strings or Array of Array of Strings\n\n- Array of Strings - array containing lines of text with same structured text formatting.\n- Array of Array of Strings [text, format, color]\n  - text: String - (Optional, default `\"\"`)\n  - format: String - (Optional, default `\"align = 'center' size = '0.7'\"`) a linebreak is defined as \"<br/>\" **and this only!**\n  - color: String - (Optional, default `\"#ffffff\"`)","type_expr":"Array<String> | Array<Array<String>>","text":"stringLines: Array of Strings or Array of Array of Strings\n\n- Array of Strings - array containing lines of text with same structured text formatting.\n- Array of Array of Strings [text, format, color]\n  - text: String - (Optional, default `\"\"`)\n  - format: String - (Optional, default `\"align = 'center' size = '0.7'\"`) a linebreak is defined as \"<br/>\" **and this only!**\n  - color: String - (Optional, default `\"#ffffff\"`)"},{"name":"posX","type":"Number","optional":true,"default":"0","type_expr":"Number","text":"posX: Number - (Optional, default 0)"},{"name":"posY","type":"Number","optional":true,"default":"0","type_expr":"Number","text":"posY: Number - (Optional, default 0)"},{"name":"alignBottom","type":"Boolean","optional":true,"default":"true","type_expr":"Boolean","text":"alignBottom: Boolean - (Optional, default true)"},{"name":"rootFormat","type":"String","optional":true,"default":"`\"<t>%1</t>\"`","type_expr":"String","text":"rootFormat: String - (Optional, default `\"<t>%1</t>\"`)"},{"name":"abortParams","type":"Array","optional":true,"default":"`[]`","type_expr":"Array","text":"abortParams: Array - (Optional, default `[]`)"},{"name":"abortCond","type":"Code","optional":true,"default":"`{ false }`","type_expr":"Code","text":"abortCond: Code - (Optional, default `{ false }`)"},{"name":"playSounds","type":"Boolean","optional":true,"default":"true","type_expr":"Boolean","text":"playSounds: Boolean - (Optional, default true)"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"text":"```sqf\n[\n    [\n        [\"CAMP ROGAIN, \", \"align = 'center' shadow = '1' size = '0.7' font='PuristaBold'\"],\n        [\"RESUPPLY POINT\", \"align = 'center' shadow = '1' size = '0.7'\", \"#aaaaaa\"],\n        [\"\", \"<br/>\"], // line break\n        [\"10 MINUTES LATER...\", \"align = 'center' shadow = '1' size = '1.0'\"]\n    ]\n] spawn BIS_fnc_typeText2;\n```","code":["[\n\t[\n\t\t[\"CAMP ROGAIN, \", \"align = 'center' shadow = '1' size = '0.7' font='PuristaBold'\"],\n\t\t[\"RESUPPLY POINT\", \"align = 'center' shadow = '1' size = '0.7'\", \"#aaaaaa\"],\n\t\t[\"\", \"<br/>\"], // line break\n\t\t[\"10 MINUTES LATER...\", \"align = 'center' shadow = '1' size = '1.0'\"]\n\t]\n] spawn BIS_fnc_typeText2;"]},{"text":"```sqf\n[\n    [\"Hello there\"],\n    safeZoneX, safeZoneH / 2,\n    true,\n    \"<t font='PuristaBold'>%1</t>\",\n    [],\n    { false },\n    true\n] spawn BIS_fnc_typeText2;\n```","code":["[\n\t[\"Hello there\"],\n\tsafeZoneX, safeZoneH / 2,\n\ttrue,\n\t\"<t font='PuristaBold'>%1</t>\",\n\t[],\n\t{ false },\n\ttrue\n] spawn BIS_fnc_typeText2;"]}],"see_also":["BIS_fnc_dynamicText","BIS_fnc_infoText","BIS_fnc_textTiles","BIS_fnc_typeText","BIS_fnc_EXP_camp_SITREP"]},{"name":"BIS_fnc_unflipThing","title":"BIS fnc unflipThing","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_unflipThing","revid":369764,"updated":"2024-10-08T15:08:57Z","groups":["Vehicles"],"status":"ok","games":{"arma3":"2.18"},"since":"arma3 2.18","arma3_since":"2.18","description":"Called by unflip thing action. Can be used to unflip vehicle without transition. The caller is made invincible during flipping and the original isDamageAllowed state is set afterward.","syntaxes":[{"syntax":"[caller, thing] call BIS_fnc_unflipThing","params":[{"name":"caller","type":"Object","description":"the unit that called the action, used in context of the unflip action","type_expr":"Object"},{"name":"thing","type":"Object","description":"the thing that should be flipped","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true"}}],"examples":[{"code":["[player, quad1] call BIS_fnc_unflipThing;"]}],"see_also":["BIS_fnc_unflipVehicle"]},{"name":"BIS_fnc_unflipVehicle","title":"BIS fnc unflipVehicle","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_unflipVehicle","revid":352643,"updated":"2024-02-17T15:56:50Z","groups":["Vehicles"],"status":"ok","games":{"arma3":"2.02"},"since":"arma3 2.02","arma3_since":"2.02","description":"Can be used to unflip a vehicle or a turret, without transition.","syntaxes":[{"syntax":"[veh] call BIS_fnc_unflipVehicle","params":[{"name":"veh","type":"Object","description":"the vehicle/turret that should be flipped","type_expr":"Object"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[quad1] call BIS_fnc_unflipVehicle;"]}],"see_also":["BIS_fnc_unflipThing"]},{"name":"BIS_fnc_uniqueClasses","title":"BIS fnc uniqueClasses","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_uniqueClasses","revid":373744,"updated":"2025-06-24T21:38:03Z","groups":["Configs"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Composes an array of classes with unique param (based on returned value of passed code). If class inherits the param from parent, it's not listed.","syntaxes":[{"syntax":"[config, code] call BIS_fnc_uniqueClasses","params":[{"name":"config","type":"Config","description":"class which is searched","type_expr":"Config"},{"name":"code","type":"Code","description":"code executed on class, which is passed as `_this` or `_x`","type_expr":"Code"}],"returns":{"type_expr":"Array","description":"- config: Config - config which defines the parameter value - value: Anything - value returned by the specified `code` parameter","text":"Array of classes with unique param in format [[config, value], ...] where:\n\n- config: Config - config which defines the parameter value\n- value: Anything - value returned by the specified `code` parameter"}}],"examples":[{"code":["_aiClassTypes = [configFile >> \"CfgVehicles\", { getText (_this >> \"aiBrainType\") }] call BIS_fnc_uniqueClasses;"]}],"see_also":["BIS_fnc_returnChildren","BIS_fnc_returnParents"]},{"name":"BIS_fnc_unitAddon","title":"BIS fnc unitAddon","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_unitAddon","revid":349389,"updated":"2023-11-08T16:27:00Z","groups":["Configs"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Return addon from CfgPatches to which a given object belongs to.","syntaxes":[{"syntax":"[object] call BIS_fnc_unitAddon","params":[{"name":"object","type":"Object","description":"object whose addon should be returned","type_expr":"Object"}],"returns":{"type":"String","type_expr":"String","description":"addon class"}}],"examples":[{"code":["[player] call BIS_fnc_unitAddon;"]}],"see_also":["unitAddons","activatedAddons"]},{"name":"BIS_fnc_unitCapture","title":"BIS fnc unitCapture","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_unitCapture","revid":347970,"updated":"2023-11-08T09:41:00Z","groups":["Scenes"],"status":"ok","games":{"arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2oa 1.50","arma3_since":"0.50","exec":"spawn","description":"Records movement data of input unit over a specified period of time. Simplified.\nPressing the <kbd>Esc</kbd> key, the duration ending, or the unit dying ends the recording.\nCopies to clipboard an Array in format [frameTime, unitPosition, unitDirectionVector, unitUpVector, unitVelocity] for each frame.","syntaxes":[{"syntax":"[unit, duration, FPS, firing, startTime] spawn BIS_fnc_unitCapture","params":[{"name":"unit","type":"Object","description":"unit from which to capture movement data","type_expr":"Object"},{"name":"duration","type":"Number","description":"capture's maximum duration","type_expr":"Number"},{"name":"FPS","type":"Number","optional":true,"default":"20","description":"frames recorded per second. Range is 1..100","type_expr":"Number","text":"FPS: Number - (Optional, default 20) frames recorded per second (default 20). Range is 1..100"},{"name":"firing","type":"Boolean","optional":true,"default":"false","description":"if set to true, will record the input unit's weapon fire data as well","type_expr":"Boolean","text":"firing: Boolean - (Optional, default false) if set to true, will record the input unit's weapon fire data as well"},{"name":"startTime","type":"Number","optional":true,"default":"0","description":"starting time offset for the frame time","type_expr":"Number","text":"startTime: Number - (Optional, default 0) starting time offset for the frame time"}],"returns":{"type":"Script Handle","type_expr":"Script Handle"}}],"examples":[{"code":["[BIS_Vehicle, 50, 30, true, 10] spawn BIS_fnc_unitCapture;"]}],"see_also":["BIS_fnc_unitCaptureFiring","BIS_fnc_unitCaptureSimple","BIS_fnc_unitPlaySimple","BIS_fnc_unitPlayFiring","BIS_fnc_unitPlay","BIS_fnc_scriptedMove"],"notes":[{"user":"Benargee","date":"2014-09-29T21:31:00Z","text":"Video Tutorial by **[TheJserver](https://www.youtube.com/channel/UCY63DNbVREJIaANChQhYDTA)**\nArma 2: Operation Arrowhead v1.56 **Part 1:** <https://www.youtube.com/watch?v=ryB20wQhSr0>\nArma 2: Operation Arrowhead v1.56 **Part 2:** <https://www.youtube.com/watch?v=ePszdYfMRvc>\n*Works exactly the same in Arma 3 in my experience.*"}]},{"name":"BIS_fnc_unitCaptureFiring","title":"BIS fnc unitCaptureFiring","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_unitCaptureFiring","revid":336358,"updated":"2022-12-29T08:47:04Z","groups":["Scenes"],"status":"ok","games":{"arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2oa 1.50","arma3_since":"0.50","exec":"spawn","description":"Records weapon fire data of input unit over a specified period of time. Pressing the <kbd>ESC</kbd> key, the duration ending, or the unit dying ends the recording.","syntaxes":[{"syntax":"[unit, duration, startTime] spawn BIS_fnc_unitCaptureFiring","params":[{"name":"unit","type":"Object","description":"unit to capture weapon fire data from","type_expr":"Object"},{"name":"duration","type":"Number","description":"maximum duration to capture","type_expr":"Number"},{"name":"startTime","type":"Number","optional":true,"default":"0","description":"starting time offset for the frame time","type_expr":"Number","text":"startTime: Number - (Optional, default 0) starting time offset for the frame time"}],"returns":{"type":"Script Handle","type_expr":"Script Handle"}}],"examples":[{"code":["[BIS_Vehicle, 50, 10] spawn BIS_fnc_unitCaptureFiring;"]},{"code":["[[2.135, \"GAU8\", \"<NULL-object>\"], [2.157, \"GAU8\", \"<NULL-object>\"]] // output example"]}],"see_also":["BIS_fnc_unitCaptureSimple","BIS_fnc_unitPlaySimple","BIS_fnc_unitPlayFiring","BIS_fnc_unitCapture","BIS_fnc_unitPlay"]},{"name":"BIS_fnc_unitCaptureSimple","title":"BIS fnc unitCaptureSimple","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_unitCaptureSimple","revid":347971,"updated":"2023-11-08T09:42:41Z","groups":["Scenes"],"status":"ok","games":{"arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2oa 1.50","arma3_since":"0.50","exec":"spawn","description":"Records movement data of input unit over a specified period of time. Simplified.\nPressing the <kbd>Esc</kbd> key, the duration ending, or the unit dying ends the recording.","syntaxes":[{"syntax":"[unit, duration, FPS, firing, startTime] spawn BIS_fnc_unitCaptureSimple","params":[{"name":"unit","type":"Object","description":"unit to capture movement data from","type_expr":"Object"},{"name":"duration","type":"Array","description":"duration to capture for","type_expr":"Array"},{"name":"FPS","type":"Number","optional":true,"default":"20","description":"frames recorded per second. Limit is 1 - 100","type_expr":"Number","text":"FPS: Number - (Optional, default 20) frames recorded per second (default 20). Limit is 1 - 100"},{"name":"firing","type":"Boolean","optional":true,"default":"false","description":"if true, will record the input unit's weapon fire data as well","type_expr":"Boolean","text":"firing: Boolean - (Optional, default false) if true, will record the input unit's weapon fire data as well"},{"name":"startTime","type":"Number","optional":true,"default":"0","description":"starting time offset for the frame time","type_expr":"Number","text":"startTime: Number - (Optional, default 0) starting time offset for the frame time"}],"returns":{"type":"Script Handle","type_expr":"Script Handle","description":"> [!NOTE] > Copies to clipboard an Array of Arrays in format [frameTime, unitPosition, unitDirection] for each frame.","text":"Script Handle\n\n> [!NOTE]\n> Copies to clipboard an Array of Arrays in format [frameTime, unitPosition, unitDirection] for each frame."}}],"examples":[{"code":["[BIS_Vehicle, 50, 30, true, 10] spawn BIS_fnc_unitCaptureSimple;"]}],"see_also":["BIS_fnc_unitCaptureFiring","BIS_fnc_unitPlaySimple","BIS_fnc_unitPlayFiring","BIS_fnc_unitCapture","BIS_fnc_unitPlay"]},{"name":"BIS_fnc_unitHeadgear","title":"BIS fnc unitHeadgear","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_unitHeadgear","revid":336872,"updated":"2023-01-04T16:43:48Z","groups":["Inventory"],"status":"ok","games":{"arma3":"1.48"},"since":"arma3 1.48","arma3_since":"1.48","locality":{"argument":"local"},"description":"Randomise headgear and facewear of a character.\n\n> [!IMPORTANT]\n> If the randomization is disabled, only strings parameters will be processed, array will be ignored and considered as false.","syntaxes":[{"syntax":"[unit, headgear, facewear] call BIS_fnc_unitHeadgear","params":[{"name":"unit","type":"Object","type_expr":"Object"},{"name":"headgear","type":"Boolean, String or Array","optional":true,"default":"false","description":"can be one of:\n\n- Boolean - if false, change nothing to the headgear\n- String - valid Headgear class or a valid class from Description.ext CfgUnitTemplates\n- Array - headgear list with individual probability","type_expr":"Boolean | String | Array","text":"headgear: Boolean, String or Array - (Optional, default false) can be one of:\n\n- Boolean - if false, change nothing to the headgear\n- String - valid Headgear class or a valid class from Description.ext CfgUnitTemplates\n- Array - headgear list with individual probability"},{"name":"facewear","type":"Boolean, String or Array","optional":true,"default":"false","description":"can be one of:\n\n- Boolean - if false, change nothing to the facewear\n- String - valid facewear class or a valid class from Description.ext CfgUnitTemplates\n- Array - facewear list with individual probability","type_expr":"Boolean | String | Array","text":"facewear: Boolean, String or Array - (Optional, default false) can be one of:\n\n- Boolean - if false, change nothing to the facewear\n- String - valid facewear class or a valid class from Description.ext CfgUnitTemplates\n- Array - facewear list with individual probability"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when done"}}],"examples":[{"text":"```sqf\n[this] call BIS_fnc_unitHeadgear;                    // headgear and face wear, same as [this, [], []]\n[this, [], []] call BIS_fnc_unitHeadgear;            // headgear only\n[this, nil, []] call BIS_fnc_unitHeadgear;            // facewear only\n[this, \"myTemplate\"] call BIS_fnc_unitHeadgear;    // class defined in Description.ext - CfgUnitTemplates\n```","code":["[this] call BIS_fnc_unitHeadgear;\t\t\t\t\t// headgear and face wear, same as [this, [], []]\n[this, [], []] call BIS_fnc_unitHeadgear;\t\t\t// headgear only\n[this, nil, []] call BIS_fnc_unitHeadgear;\t\t\t// facewear only\n[this, \"myTemplate\"] call BIS_fnc_unitHeadgear;\t// class defined in Description.ext - CfgUnitTemplates"]}],"see_also":["addGoggles","addHeadgear"]},{"name":"BIS_fnc_unitPlay","title":"BIS fnc unitPlay","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_unitPlay","revid":349483,"updated":"2023-11-08T17:09:03Z","groups":["Scenes"],"status":"ok","games":{"arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2oa 1.50","arma3_since":"0.50","exec":"spawn","description":"Plays back input movement data on input unit.","syntaxes":[{"syntax":"[unit, data, varDone, stateIgnore, obsolete_1, obsolete_2, skipTime] spawn BIS_fnc_unitPlay","params":[{"name":"unit","type":"Object","description":"unit to play movement data on","type_expr":"Object"},{"name":"data","type":"Array","description":"movement data recorder by BIS_fnc_unitCapture","type_expr":"Array"},{"name":"varDone","type":"Array","optional":true,"default":"`[]`","description":"variable to set on specified Object once playback has finished in format:\n\n- 0: Object - Target object\n- 1: String - Variable name","type_expr":"Array","text":"varDone: Array - (Optional, default `[]`) variable to set on specified Object once playback has finished in format:\n\n- 0: Object - Target object\n- 1: String - Variable name"},{"name":"stateIgnore","type":"Boolean","optional":true,"default":"false","description":"whether to ignore if the Unit is dead and/or cannot move","type_expr":"Boolean","text":"stateIgnore: Boolean - (Optional, default false) whether to ignore if the Unit is dead and/or cannot move"},{"name":"obsolete_1","type":"Nothing","description":"obsolete param, preserved because of backward compatibility","type_expr":"Nothing"},{"name":"obsolete_2","type":"Nothing","description":"obsolete param, preserved because of backward compatibility","type_expr":"Nothing"},{"name":"skipTime","type":"Number","optional":true,"default":"0","description":"amount of time to skip at the start of playback. For example if you wish to play the data from halfway instead of the start.","type_expr":"Number","text":"skipTime: Number - (Optional, default 0) amount of time to skip at the start of playback. For example if you wish to play the data from halfway instead of the start."}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"always true"}}],"examples":[{"code":["[vehicle player, _unitCaptureData] spawn BIS_fnc_unitPlay"]}],"see_also":["BIS_fnc_unitCaptureFiring","BIS_fnc_unitCaptureSimple","BIS_fnc_unitPlaySimple","BIS_fnc_unitPlayFiring","BIS_fnc_unitCapture"]},{"name":"BIS_fnc_unitPlayFiring","title":"BIS fnc unitPlayFiring","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_unitPlayFiring","revid":336355,"updated":"2022-12-29T08:44:18Z","groups":["Scenes"],"status":"ok","games":{"arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2oa 1.50","arma3_since":"0.50","exec":"spawn","description":"Plays back input weapon fire data on input unit.","syntaxes":[{"syntax":"[unit, data, stateIgnore] spawn BIS_fnc_unitPlayFiring","params":[{"name":"unit","type":"Object","description":"unit to play weapon fire data on","type_expr":"Object"},{"name":"data","type":"Array","description":"firing data to use BIS_fnc_unitCaptureFiring","type_expr":"Array"},{"name":"stateIgnore","type":"Boolean","optional":true,"default":"false","description":"whether to ignore if the Unit is dead and/or cannot move","type_expr":"Boolean","text":"stateIgnore: Boolean - (Optional, default false) whether to ignore if the Unit is dead and/or cannot move"}],"returns":{"type":"Script Handle","type_expr":"Script Handle"}}],"examples":[{"code":["private _capturedFireData = [[2.135, \"GAU8\", \"<NULL-object>\"]];\n[BIS_Vehicle, _capturedData, true] spawn BIS_fnc_unitPlayFiring;"]}],"see_also":["BIS_fnc_unitCaptureFiring","BIS_fnc_unitCaptureSimple","BIS_fnc_unitPlaySimple","BIS_fnc_unitCapture","BIS_fnc_unitPlay"]},{"name":"BIS_fnc_unitPlaySimple","title":"BIS fnc unitPlaySimple","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_unitPlaySimple","revid":349494,"updated":"2023-11-08T17:09:09Z","groups":["Scenes"],"status":"ok","games":{"arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2oa 1.50","arma3_since":"0.50","exec":"spawn","description":"Plays back input movement data on input unit. Simplified.","syntaxes":[{"syntax":"[unit, data, varDone, stateIngnore, debug, sleep, skipTime] spawn BIS_fnc_unitPlaySimple","params":[{"name":"unit","type":"Object","description":"unit to play movement data on","type_expr":"Object"},{"name":"data","type":"Array","description":"movement data to use","type_expr":"Array"},{"name":"varDone","type":"Array","optional":true,"default":"`[]`","description":"variable to set on specified Object once playback has finished in format:\n\n- 0: Object, Group or Namespace - target\n- 1: String - variable name","type_expr":"Array","text":"varDone: Array - (Optional, default `[]`) variable to set on specified Object once playback has finished in format:\n\n- 0: Object, Group or Namespace - target\n- 1: String - variable name"},{"name":"stateIgnore","type":"Boolean","optional":true,"default":"false","description":"whether to ignore if the Unit is dead and/or cannot move","type_expr":"Boolean","text":"stateIgnore: Boolean - (Optional, default false) whether to ignore if the Unit is dead and/or cannot move"},{"name":"debug","type":"Boolean","optional":true,"default":"false whether to give debug information on played frames per second","type_expr":"Boolean","text":"debug: Boolean - (Optional, default false whether to give debug information on played frames per second"},{"name":"sleep","type":"Number","optional":true,"default":"0","description":"time to sleep between frames. This is if you want to be recording another unit and playing back movement data on another as well. Limit is 0-1 seconds.","type_expr":"Number","text":"sleep: Number - (Optional, default 0) time to sleep between frames. This is if you want to be recording another unit and playing back movement data on another as well. Limit is 0-1 seconds."},{"name":"skipTime","type":"Number","optional":true,"default":"0","description":"amount of time to skip at the start of playback. For example if you wish to play the data from halfway instead of the start.","type_expr":"Number","text":"skipTime: Number - (Optional, default 0) amount of time to skip at the start of playback. For example if you wish to play the data from halfway instead of the start."}],"returns":{"type":"Script Handle","type_expr":"Script Handle","description":"script handle"}}],"examples":[{"code":["private _capturedData = [[0, [8208.26, 1953.13, 296.04], 67]];\n[BIS_Vehicle, _capturedData, [BIS_Object, \"DoneRecording\"], true, false, 0.2, 5] spawn BIS_fnc_unitPlaySimple;"]}],"see_also":["BIS_fnc_unitCaptureFiring","BIS_fnc_unitCaptureSimple","BIS_fnc_unitPlayFiring","BIS_fnc_unitPlay","BIS_fnc_unitCapture"]},{"name":"BIS_fnc_unitVector","title":"BIS fnc unitVector","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_unitVector","revid":280851,"updated":"2021-06-14T08:22:30Z","groups":["Vectors"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Unit Vector\n\nReturns the unit vector for the passed vector (vector pointing in the same direction, but with magnitude == 1) This does not modify the original array. The array can have any number of elements (2, 3, etc).","syntaxes":[{"syntax":"","params":[],"returns":null}],"docblock":{"text":"    Unit Vector\n\nReturns the unit vector for the passed vector (vector pointing\nin the same direction, but with magnitude == 1)\nThis does not modify the original array.\nThe array can have any number of elements (2, 3, etc)."},"filled_from_docblock":["description"]},{"name":"BIS_fnc_unpackStaticWeapon","title":"BIS fnc unpackStaticWeapon","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_unpackStaticWeapon","revid":352038,"updated":"2024-02-01T23:24:28Z","groups":["Weapons"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"This function will move given support team to the given weapon position.\nThe weapon crew will unpack carried weapon and start watching given target position.\nRequires three personnel in the team: Team Leader, Gunner and Asst. Gunner.\nThis function is MP compatible.\nWhen the weapon is unpacked, the \"StaticWeaponUnpacked\" scripted EH is called.\n\n> [!NOTE]\n> If a unit flees, all bets are off and the function will exit leaving units on their own.\n> To guarantee weapon disassembly, make sure the group has maximum courage: `_group allowFleeing 0;`.","syntaxes":[{"syntax":"[group, weaponPos, targetPos, leaderPos] call BIS_fnc_unpackStaticWeapon","params":[{"name":"group","type":"Group or Object","description":"the support team group or a unit from this group","type_expr":"Group | Object"},{"name":"weaponPos","type":"Array, String or Object","description":"weapon placement position, object position or marker","type_expr":"Array | String | Object"},{"name":"targetPos","type":"Array, String or Object","description":"target position, object position to watch or marker","type_expr":"Array | String | Object"},{"name":"leaderPos","type":"Array, String or Object","optional":true,"description":"position, object or marker group leader should move to","type_expr":"Array | String | Object","text":"leaderPos: Array, String or Object - (Optional) position, object or marker group leader should move to"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[leader1, \"weapon_mrk\", \"target_mrk\"] call BIS_fnc_unpackStaticWeapon;"]},{"code":["group1 allowFleeing 0;\n[group1, \"weapon_mrk\", tank1, \"leader_mrk\"] call BIS_fnc_unpackStaticWeapon;"]}],"see_also":["BIS_fnc_packStaticWeapon","BIS_fnc_addScriptedEventHandler"],"notes":[{"user":"Killzone_Kid","date":"2017-01-06T23:10:00Z","text":"The following script will create a group consisting of a Team Leader, Gunner and Asst. Gunner and give the group 2 random MOVE waypoints. After the group reached the 1st waypoint, waypoint statement will execute BIS_fnc_unpackStaticWeapon and the group will stop and unpack static weapon, while leader is given random position to go to. After 7 seconds the BIS_fnc_packStaticWeapon is executed and the group packs and heads to 2nd waypoint.\n\n```sqf\nprivate _group = createGroup west;\nprivate _pos = player getRelPos [20, 0];\nprivate _randomDir = random 360;\nprivate _wp1 = _group addWaypoint [_pos getPos [20, _randomDir], 10];\n_wp1 setWaypointType \"MOVE\";\n_wp1 setWaypointStatements [\"true\", \"\n    group this allowFleeing 0;\n    [group this, 'StaticWeaponUnpacked', {\n        _this spawn\n        {\n            sleep 7;\n            [_this select 0] call BIS_fnc_packStaticWeapon;\n        };\n    }] call BIS_fnc_addScriptedEventHandler;\n    [\n        this,\n        this,\n        this getPos [1000, random 360],\n        this getPos [10, 0]\n    ] call BIS_fnc_unpackStaticWeapon;\n\"];\nprivate _wp2 = _group addWaypoint [_pos getPos [20, _randomDir - 180], 10];\n_wp2 setWaypointType \"MOVE\";\nprivate _leader = _group createUnit [\"B_Soldier_TL_F\", _pos, [], 0, \"NONE\"];\nprivate _gunner = _group createUnit [\"B_Support_GMG_F\", _pos, [], 0, \"NONE\"];\nprivate _assistant = _group createUnit [\"B_Support_AMG_F\", _pos, [], 0, \"NONE\"];\nunits _group doFollow _leader;\n```"}]},{"name":"BIS_fnc_updatePlayerArray","title":"BIS fnc updatePlayerArray","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_updatePlayerArray","revid":348288,"updated":"2023-11-08T11:40:40Z","groups":["Respawn"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Updates dead player objects to their current respawned objects.","syntaxes":[{"syntax":"[input] call BIS_fnc_updatePlayerArray","params":[{"name":"input","type":"Array of Objects","description":"array of old player objects","type_expr":"Array<Object>"}],"returns":{"type":"Array","type_expr":"Array","description":"array with new player objects"}}],"examples":[{"code":["private _newPlayerObjects = _oldPlayerObjects call BIS_fnc_updatePlayerArray;"]}],"see_also":["player","allPlayers","playableUnits"]},{"name":"BIS_fnc_validateParametersOO","title":"BIS fnc validateParametersOO","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_validateParametersOO","revid":349337,"updated":"2023-11-08T14:53:28Z","groups":["OO"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Validating the parameters of a certain method in a class.","syntaxes":[{"syntax":"[class,method,params] call BIS_fnc_validateParametersOO","params":[{"name":"class","type":"String","description":"class name","type_expr":"String"},{"name":"method","type":"String","description":"method used for validating (Taken from **class >> \"Methods\"**)","type_expr":"String"},{"name":"params","type":"Array","description":"to be validated parameters","type_expr":"Array"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"validating flag"}}],"examples":[{"code":["[\"someClass\",\"someMethod\",[5,47,\"test\"]] call BIS_fnc_validateParametersOO;"]}],"see_also":["BIS_fnc_addClassOO","BIS_fnc_createObjectOO"]},{"name":"BIS_fnc_variableSpaceAdd","title":"BIS fnc variableSpaceAdd","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_variableSpaceAdd","revid":337310,"updated":"2023-01-15T12:01:18Z","groups":["Variables"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Add element to variable from someone's variable space.","syntaxes":[{"syntax":"[object, varName, element, global, inArray] call BIS_fnc_variableSpaceAdd","params":[{"name":"object","type":"Object","description":"owner of variable space","type_expr":"Object"},{"name":"varName","type":"String","description":"name of variable","type_expr":"String"},{"name":"element","type":"Anything","description":"element which will be added (must be of same type as variable)","type_expr":"Anything"},{"name":"global","type":"Boolean","optional":true,"default":"false","description":"true to save modified variable globally","type_expr":"Boolean","text":"global: Boolean - (Optional, default false) true to save modified variable globally"},{"name":"inArray","type":"Boolean","optional":true,"default":"false","description":"true to check if element is already in variable (only for Arrays)","type_expr":"Boolean","text":"inArray: Boolean - (Optional, default false) true to check if element is already in variable (only for Arrays)"}],"returns":{"type":"Anything","type_expr":"Anything","description":"updated variable"}}],"examples":[{"code":["[player, \"someVar\", 1337, true, true] call BIS_fnc_variableSpaceAdd;"]}],"see_also":["BIS_fnc_variableSpaceRemove"]},{"name":"BIS_fnc_variableSpaceRemove","title":"BIS fnc variableSpaceRemove","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_variableSpaceRemove","revid":349319,"updated":"2023-11-08T14:52:29Z","groups":["Variables"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Remove element from variable from someone's variable space.","syntaxes":[{"syntax":"[object,varName,element,global,inArray] call BIS_fnc_variableSpaceRemove","params":[{"name":"object","type":"Object","description":"owner of variable space","type_expr":"Object"},{"name":"varName","type":"String","description":"name of variable","type_expr":"String"},{"name":"element","type":"Anything","description":"element which will be removed (must be of same type as variable)","type_expr":"Anything"},{"name":"global","type":"Boolean","optional":true,"default":"false","description":"true to save modified variable globally]]","type_expr":"Boolean","text":"global: Boolean - (Optional, default false) true to save modified variable globally]]"}],"returns":{"type":"Anything","type_expr":"Anything","description":"updated variable"}}],"examples":[{"code":["[player, \"someVar\", 1337, true] call BIS_fnc_variableSpaceRemove;"]}],"see_also":["BIS_fnc_variableSpaceAdd","setVariable"]},{"name":"BIS_fnc_vectorAdd","title":"BIS fnc vectorAdd","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_vectorAdd","revid":349009,"updated":"2023-11-08T14:47:05Z","groups":["Vectors"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Returns the sum of two vectors.\n\n> [!NOTE]\n> **Arma 3:** If the vector is either 2D or 3D use vectorAdd instead.","syntaxes":[{"syntax":"[vector1, vector2] call BIS_fnc_vectorAdd","params":[{"name":"vector1","type":"Array of Numbers","type_expr":"Array<Number>"},{"name":"vector2","type":"Array of Numbers","type_expr":"Array<Number>"}],"returns":{"type":"Array of Numbers","type_expr":"Array<Number>","description":"resulting vector"}}],"examples":[{"code":["[[1, 1, 1, 1, 1], [2, 5, 3, 1, 1]] call BIS_fnc_vectorAdd; // returns [3,6,4,2,2]"]}],"see_also":["vectorAdd"]},{"name":"BIS_fnc_vectorDiff","title":"BIS fnc vectorDiff","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_vectorDiff","revid":327961,"updated":"2022-07-13T13:36:27Z","groups":["Vectors"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Returns a vector that is the difference between two vectors.\n\n> [!NOTE]\n> **Arma 3:** Use vectorDiff instead.","syntaxes":[{"syntax":"[vector1, vector2] call BIS_fnc_vectorDiff","params":[{"name":"vector1","type":"Array","type_expr":"Array"},{"name":"vector2","type":"Array","type_expr":"Array"}],"returns":{"type":"Array","type_expr":"Array","description":"vector difference"}}],"examples":[{"code":["private _vectorDiff = [[1,2,3], [5,6,7]] call BIS_fnc_vectorDiff;"]}],"see_also":["vectorDiff"],"notes":[{"user":"KingArthur98","date":"2020-11-03T07:42:00Z","text":"Note that this function is unreliable in Arma 2 and gives different outputs than the same function on Arma 3 OR the native vectorDiff Arma 3 command.\nIf you want to be sure, replace this function with a manual calculation in Arma 2."}]},{"name":"BIS_fnc_vectorDirAndUpRelative","title":"BIS fnc vectorDirAndUpRelative","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_vectorDirAndUpRelative","revid":325129,"updated":"2022-07-01T12:35:35Z","groups":["Vectors"],"status":"ok","games":{"arma3":"1.64"},"since":"arma3 1.64","arma3_since":"1.64","description":"Returns vectorDirAndUp of object 1 relative to object 2","syntaxes":[{"syntax":"[object1, object2, visual] call BIS_fnc_vectorDirAndUpRelative","params":[{"name":"object1","type":"Object","type_expr":"Object"},{"name":"object2","type":"Object","type_expr":"Object"},{"name":"visual","type":"Boolean","optional":true,"default":"true","description":"true for a render scope result, false for simulation scope","type_expr":"Boolean","text":"visual: Boolean - (Optional, default true) true for a render scope result, false for simulation scope"}],"returns":{"type":"Array","type_expr":"Array","description":"in format [vectorDir, vectorUp]","text":"Array in format [vectorDir, vectorUp]"}}],"examples":[{"code":["private _vectorDirAndUp = [tank, car] call BIS_fnc_vectorDirAndUpRelative;"]}],"see_also":["BIS_fnc_attachToRelative","BIS_fnc_weaponDirectionRelative","vectorDir","vectorUp","setVectorDirAndUp"]},{"name":"BIS_fnc_vectorDivide","title":"BIS fnc vectorDivide","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_vectorDivide","revid":327960,"updated":"2022-07-13T13:35:15Z","groups":["Vectors"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Divides vector by scalar, by dividing all vector elements.\n\n> [!NOTE]\n> vectorMultiply can be used instead as `vector vectorMultiply 1/scale`, but:\n>\n> - *scale* cannot be 0\n> - in some rare cases, the result is not *exactly* the same as BIS_fnc_vectorDivide - this is due to Floating Point Number precision and rounding.","syntaxes":[{"syntax":"[vector, divider] call BIS_fnc_vectorDivide","params":[{"name":"vector","type":"Array of Numbers","optional":true,"default":"[0,0,0]","description":"can be any array of numbers","type_expr":"Array<Number>","text":"vector: Array of Numbers - (Optional, default [0,0,0]) can be any array of numbers"},{"name":"divider","type":"Number","optional":true,"default":"1","type_expr":"Number","text":"divider: Number - (Optional, default 1)"}],"returns":{"type":"Array of Numbers","type_expr":"Array<Number>"}}],"examples":[{"code":["[[123, 456, 789], 5] call BIS_fnc_vectorDivide;"]},{"code":["[[1, 2, 3, 4, 5, 6, 7, 8, 9], 5] call BIS_fnc_vectorDivide;"]}],"see_also":["vectorMultiply","BIS_fnc_vectorMultiply"]},{"name":"BIS_fnc_vectorFromXToY","title":"BIS fnc vectorFromXToY","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_vectorFromXToY","revid":352158,"updated":"2024-02-01T23:25:22Z","groups":["Vectors"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Returns a unit vector that 'points' from *vector1* to *vector2*.\nThis is a very useful function as it can be used with the velocity command to move an object from one position to another (i.e *vector1* to *vector2*).\n\n> [!NOTE]\n> Ensure both positions are found using getPosASL.\n\n> [!NOTE]\n> **Arma 3:** Since Arma 3 v1.26 For better performance, use the vectorFromTo command instead.","syntaxes":[{"syntax":"[vector1, vector2] call BIS_fnc_vectorFromXToY","params":[{"name":"vector1","type":"Array","type_expr":"Array"},{"name":"vector2","type":"Array","type_expr":"Array"}],"returns":{"type":"Array","type_expr":"Array"}}],"examples":[{"code":["private _resultVector = [getPosASL vehicle player, getPosASL airTarget] call BIS_fnc_vectorFromXToY;"]}],"see_also":["velocity","setVelocity","vectorAdd"]},{"name":"BIS_fnc_vectorMultiply","title":"BIS fnc vectorMultiply","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_vectorMultiply","revid":327959,"updated":"2022-07-13T13:15:38Z","groups":["Vectors"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Multiplies 3D vector by a scalar.\n\n> [!NOTE]\n> **Arma 3:** Use vectorMultiply instead.","syntaxes":[{"syntax":"[vector, factor] call BIS_fnc_vectorMultiply","params":[{"name":"vector","type":"Array of Numbers","description":"to format [x,y,z]","type_expr":"Array<Number>"},{"name":"factor","type":"Number","type_expr":"Number"}],"returns":{"type":"Array of Numbers","type_expr":"Array<Number>","description":"result vector"}}],"examples":[{"code":["private _newVector = [[1,2,3], 3] call BIS_fnc_vectorMultiply; // returns [3,6,9]"]}],"see_also":["vectorMultiply","BIS_fnc_vectorDivide"]},{"name":"BIS_fnc_vehicleCrewTurrets","title":"BIS fnc vehicleCrewTurrets","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_vehicleCrewTurrets","revid":378549,"updated":"2026-05-05T15:08:47Z","groups":["Object Manipulation"],"status":"ok","games":{"arma3":"1.94"},"since":"arma3 1.94","arma3_since":"1.94","description":"Returns vehicle crew turrets, which will be filled with crew if createVehicleCrew command is executed on the vehicle. If vehicle class is passed as param, all vehicle crew turrets are returned.","syntaxes":[{"syntax":"vehicle call BIS_fnc_vehicleCrewTurrets","params":[{"name":"vehicle","type":"Object or String","description":"vehicle or vehicle type","type_expr":"Object | String"}],"returns":{"type":"Array of Turret Paths","type_expr":"Array<Turret Path>"}}],"examples":[{"code":["\"B_APC_Wheeled_01_cannon_F\" call BIS_fnc_vehicleCrewTurrets;"]},{"code":["car1 call BIS_fnc_vehicleCrewTurrets;"]}],"see_also":["createVehicleCrew","BIS_fnc_allTurrets","BIS_fnc_turretConfig"]},{"name":"BIS_fnc_vehicleRoles","title":"BIS fnc vehicleRoles","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_vehicleRoles","revid":330776,"updated":"2022-11-01T15:58:26Z","groups":["Vehicles"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns vehicle roles.","syntaxes":[{"syntax":"vehicle call BIS_fnc_vehicleRoles","params":[{"name":"Object or String","description":"vehicle itself or a classname","type_expr":"Object | String"}],"returns":{"type":"Array","type_expr":"Array","description":"to format [[role, path], [role, path], …] like this:\n```sqf [ [\"Driver\",[]], [\"Turret\",[0]], [\"Turret\",[0,0]], [\"Cargo\",[0]], [\"Cargo\",[1]], // ... ] ```","text":"Array - to format [[role, path], [role, path], …] like this:\n\n```sqf\n[\n    [\"Driver\",[]],\n    [\"Turret\",[0]],\n    [\"Turret\",[0,0]],\n    [\"Cargo\",[0]],\n    [\"Cargo\",[1]],\n    // ...\n]\n```"}}],"examples":[{"code":["cursorObject call BIS_fnc_vehicleRoles;"]},{"code":["\"B_MBT_01_cannon_F\" call BIS_fnc_vehicleRoles;"]}],"see_also":["BIS_fnc_moveIn","assignedVehicleRole","weaponsTurret"]},{"name":"BIS_fnc_version","title":"BIS fnc version","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_version","revid":353287,"updated":"2024-03-15T17:03:27Z","groups":["Diagnostic"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Detects which **Arma 2** expansions and addons are available. Only works in Arma 2/Arma 2: Operation Arrowhead.\n\n> [!NOTE]\n> Arma 2: Army of the Czech Republic is not detected by this function.","syntaxes":[{"syntax":"call BIS_fnc_version","params":[],"returns":{"type":"Array of Numbers","type_expr":"Array<Number>","description":"can contain:\n- 0: Arma 2 - 1: Arma 2: Operation Arrowhead - 2: Arma 2: British Armed Forces - 4: Arma 2: Private Military Company","text":"Array of Numbers - can contain:\n\n- 0: Arma 2\n- 1: Arma 2: Operation Arrowhead\n- 2: Arma 2: British Armed Forces\n- 4: Arma 2: Private Military Company"}}],"examples":[{"code":["private _availableExpansions = call BIS_fnc_version;"]},{"code":["private _playerHasPMC = 4 in (call BIS_fnc_version);"]}],"see_also":["productVersion","requiredVersion"]},{"name":"BIS_fnc_versionInfo","title":"BIS fnc versionInfo","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_versionInfo","revid":379513,"updated":"2026-10-31T00:28:45Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Fills the first passed control with game type and version number, and positions both controls according to the game type.","syntaxes":[{"syntax":"[gameTypeVersionControl, modControl] call BIS_fnc_versionInfo","params":[{"name":"gameTypeVersionControl","type":"Control","description":"Control for indication of game type (Stable/Dev) and version number (RscText)","type_expr":"Control"},{"name":"modControl","type":"Control","description":"Control for indication of modded game (RscActiveText)","type_expr":"Control"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[_ctrlVersion, _ctrlModded] call BIS_fnc_versionInfo;"]}],"see_also":["productVersion"]},{"name":"BIS_fnc_VRCourseBallistics1","title":"BIS fnc VRCourseBallistics1","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseBallistics1","revid":308099,"updated":"2022-01-20T21:39:09Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseBallistics2","title":"BIS fnc VRCourseBallistics2","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseBallistics2","revid":308076,"updated":"2022-01-20T21:38:54Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseBallistics3","title":"BIS fnc VRCourseBallistics3","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseBallistics3","revid":308007,"updated":"2022-01-20T21:38:18Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseBallistics4","title":"BIS fnc VRCourseBallistics4","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseBallistics4","revid":308029,"updated":"2022-01-20T21:38:29Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseCommandingActions1","title":"BIS fnc VRCourseCommandingActions1","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseCommandingActions1","revid":308048,"updated":"2022-01-20T21:38:41Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseCommandingActions2","title":"BIS fnc VRCourseCommandingActions2","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseCommandingActions2","revid":307916,"updated":"2022-01-20T21:37:13Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseCommandingActions3","title":"BIS fnc VRCourseCommandingActions3","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseCommandingActions3","revid":308045,"updated":"2022-01-20T21:38:40Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseCommandingBehaviour1","title":"BIS fnc VRCourseCommandingBehaviour1","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseCommandingBehaviour1","revid":308019,"updated":"2022-01-20T21:38:22Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseCommandingBehaviour2","title":"BIS fnc VRCourseCommandingBehaviour2","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseCommandingBehaviour2","revid":308092,"updated":"2022-01-20T21:39:05Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseCommandingBehaviour3","title":"BIS fnc VRCourseCommandingBehaviour3","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseCommandingBehaviour3","revid":308108,"updated":"2022-01-20T21:39:21Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseCommandingMovement1","title":"BIS fnc VRCourseCommandingMovement1","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseCommandingMovement1","revid":308084,"updated":"2022-01-20T21:38:57Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseCommandingMovement2","title":"BIS fnc VRCourseCommandingMovement2","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseCommandingMovement2","revid":308040,"updated":"2022-01-20T21:38:37Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseCommandingVehicles1","title":"BIS fnc VRCourseCommandingVehicles1","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseCommandingVehicles1","revid":307918,"updated":"2022-01-20T21:37:15Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseCommandingVehicles2","title":"BIS fnc VRCourseCommandingVehicles2","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseCommandingVehicles2","revid":307982,"updated":"2022-01-20T21:38:01Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseCommandingVehicles3","title":"BIS fnc VRCourseCommandingVehicles3","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseCommandingVehicles3","revid":307910,"updated":"2022-01-20T21:37:10Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseHeliAdvanced1","title":"BIS fnc VRCourseHeliAdvanced1","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseHeliAdvanced1","revid":308004,"updated":"2022-01-20T21:38:16Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseHeliAdvanced2","title":"BIS fnc VRCourseHeliAdvanced2","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseHeliAdvanced2","revid":308055,"updated":"2022-01-20T21:38:43Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseHeliAdvanced3","title":"BIS fnc VRCourseHeliAdvanced3","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseHeliAdvanced3","revid":308037,"updated":"2022-01-20T21:38:35Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseHeliAdvanced4","title":"BIS fnc VRCourseHeliAdvanced4","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseHeliAdvanced4","revid":308066,"updated":"2022-01-20T21:38:47Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseHeliAdvanced5","title":"BIS fnc VRCourseHeliAdvanced5","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseHeliAdvanced5","revid":308041,"updated":"2022-01-20T21:38:37Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseHeliAdvanced6","title":"BIS fnc VRCourseHeliAdvanced6","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseHeliAdvanced6","revid":307928,"updated":"2022-01-20T21:37:21Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseHeliBasics1","title":"BIS fnc VRCourseHeliBasics1","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseHeliBasics1","revid":308026,"updated":"2022-01-20T21:38:29Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseHeliBasics2","title":"BIS fnc VRCourseHeliBasics2","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseHeliBasics2","revid":308089,"updated":"2022-01-20T21:39:01Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseHeliBasics3","title":"BIS fnc VRCourseHeliBasics3","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseHeliBasics3","revid":307888,"updated":"2022-01-20T21:36:59Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseHeliSlingload1","title":"BIS fnc VRCourseHeliSlingload1","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseHeliSlingload1","revid":308102,"updated":"2022-01-20T21:39:14Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseHeliWeapons1","title":"BIS fnc VRCourseHeliWeapons1","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseHeliWeapons1","revid":307933,"updated":"2022-01-20T21:37:27Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseHeliWeapons2","title":"BIS fnc VRCourseHeliWeapons2","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseHeliWeapons2","revid":307929,"updated":"2022-01-20T21:37:23Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseHeliWeapons3","title":"BIS fnc VRCourseHeliWeapons3","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseHeliWeapons3","revid":308044,"updated":"2022-01-20T21:38:38Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseHeliWeapons4","title":"BIS fnc VRCourseHeliWeapons4","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseHeliWeapons4","revid":308090,"updated":"2022-01-20T21:39:03Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseLaunchers1","title":"BIS fnc VRCourseLaunchers1","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseLaunchers1","revid":308072,"updated":"2022-01-20T21:38:51Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseLaunchers2","title":"BIS fnc VRCourseLaunchers2","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseLaunchers2","revid":308062,"updated":"2022-01-20T21:38:46Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseLaunchers3","title":"BIS fnc VRCourseLaunchers3","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseLaunchers3","revid":308085,"updated":"2022-01-20T21:38:59Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCoursePlaceables1","title":"BIS fnc VRCoursePlaceables1","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCoursePlaceables1","revid":308022,"updated":"2022-01-20T21:38:24Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCoursePlaceables2","title":"BIS fnc VRCoursePlaceables2","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCoursePlaceables2","revid":308111,"updated":"2022-01-20T21:39:23Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCoursePlaceables3","title":"BIS fnc VRCoursePlaceables3","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCoursePlaceables3","revid":308043,"updated":"2022-01-20T21:38:38Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseTargetDesignation1","title":"BIS fnc VRCourseTargetDesignation1","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseTargetDesignation1","revid":307938,"updated":"2022-01-20T21:37:30Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseTargetDesignation2","title":"BIS fnc VRCourseTargetDesignation2","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseTargetDesignation2","revid":308095,"updated":"2022-01-20T21:39:07Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseTargetDesignation3","title":"BIS fnc VRCourseTargetDesignation3","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseTargetDesignation3","revid":307943,"updated":"2022-01-20T21:37:35Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseWeaponHandlingA1","title":"BIS fnc VRCourseWeaponHandlingA1","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseWeaponHandlingA1","revid":307977,"updated":"2022-01-20T21:37:57Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseWeaponHandlingA2","title":"BIS fnc VRCourseWeaponHandlingA2","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseWeaponHandlingA2","revid":308107,"updated":"2022-01-20T21:39:20Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseWeaponHandlingA3","title":"BIS fnc VRCourseWeaponHandlingA3","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseWeaponHandlingA3","revid":308024,"updated":"2022-01-20T21:38:26Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseWeaponHandlingB1","title":"BIS fnc VRCourseWeaponHandlingB1","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseWeaponHandlingB1","revid":307962,"updated":"2022-01-20T21:37:50Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseWeaponHandlingB2","title":"BIS fnc VRCourseWeaponHandlingB2","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseWeaponHandlingB2","revid":307979,"updated":"2022-01-20T21:37:59Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseWeaponHandlingB3","title":"BIS fnc VRCourseWeaponHandlingB3","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseWeaponHandlingB3","revid":307909,"updated":"2022-01-20T21:37:09Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseWeaponHandlingC1","title":"BIS fnc VRCourseWeaponHandlingC1","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseWeaponHandlingC1","revid":307917,"updated":"2022-01-20T21:37:14Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRCourseWeaponHandlingC2","title":"BIS fnc VRCourseWeaponHandlingC2","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRCourseWeaponHandlingC2","revid":307935,"updated":"2022-01-20T21:37:28Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"> [!IMPORTANT]\n> Used for VR Courses, internal use only.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRDrawBorder","title":"BIS fnc VRDrawBorder","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRDrawBorder","revid":348816,"updated":"2023-11-08T14:38:18Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"Visualizes area border (used primarily for VR missions).","syntaxes":[{"syntax":"[center, radius] call BIS_fnc_VRDrawBorder","params":[{"name":"center","type":"Position","description":"center position","type_expr":"Position"},{"name":"radius","type":"Number","description":"radius","type_expr":"Number"}],"returns":{"type":"Array","type_expr":"Array","description":"list of created objects for easy deletion"}}],"examples":[{"code":["[[0,0,0], 200] call BIS_fnc_VRDrawBorder;"]}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRDrawGrid","title":"BIS fnc VRDrawGrid","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRDrawGrid","revid":352028,"updated":"2024-02-01T23:24:26Z","groups":["VR"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Visualizes surface grid (used primarily for VR missions).\n\n> [!NOTE]\n> Only one instance of grid visualisation can run at any given time. Calling this function multiple times will only move the grid center.","syntaxes":[{"syntax":"[location, colour] call BIS_fnc_VRDrawGrid","params":[{"name":"location","type":"Boolean or Array format Position:","description":"Boolean or Array format Position:\n\n- Boolean: use false to disable grid visualisation\n- Position: center position (should be multiple of 4 in both axis to correspond with the tiles on the ground, like [1000,1000] or [2400,2400])","type_expr":"Boolean | Position","types":["Boolean","Array","Position"],"text":"location: Boolean or Array format Position:\n\n- Boolean: use false to disable grid visualisation\n- Position: center position (should be multiple of 4 in both axis to correspond with the tiles on the ground, like [1000,1000] or [2400,2400])"},{"name":"colour","type":"Array","optional":true,"default":"[0,0,0,1]","description":"to format [R,G,B,A]","type_expr":"Array","text":"colour: Array - (Optional, default [0,0,0,1]) to format [R,G,B,A]"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[getPosATL player, [0.078, 0.3647, 0.0]] call BIS_fnc_VRDrawGrid;"]},{"code":["[false] call BIS_fnc_VRDrawGrid;"]}],"see_also":["BIS_fnc_VRDrawBorder"]},{"name":"BIS_fnc_VREffectKilled","title":"BIS fnc VREffectKilled","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VREffectKilled","revid":349396,"updated":"2023-11-08T16:27:25Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","exec":"spawn","description":"Delete body of a virtual soldier after he's killed.","syntaxes":[{"syntax":"[object, instant, delay] call BIS_fnc_VREffectKilled","params":[{"name":"object","type":"Object","description":"object","type_expr":"Object"},{"name":"instant","type":"Boolean","optional":true,"default":"false","description":"true to delete the body right away, false to add **killed** EH which will delete it after death","type_expr":"Boolean","text":"instant: Boolean - (Optional, default false) true to delete the body right away, false to add **killed** EH which will delete it after death"},{"name":"delay","type":"Number","optional":true,"default":"10","description":"time in seconds before the body disappears","type_expr":"Number","text":"delay: Number - (Optional, default 10) time in seconds before the body disappears"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when the function is done"}}],"examples":[{"code":["[player] call BIS_fnc_VREffectKilled;"]},{"code":["[player, true, 5] spawn BIS_fnc_VREffectKilled;"]}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRFadeIn","title":"BIS fnc VRFadeIn","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRFadeIn","revid":379318,"updated":"2026-10-30T23:50:34Z","groups":["VR"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Fade In effect for VR.","syntaxes":[{"syntax":"call BIS_fnc_VRFadeIn","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_VRFadeIn;"]}],"see_also":["BIS_fnc_VRFadeOut"],"notes":[{"user":"Kalthramis","date":"2018-05-22T00:42:00Z","text":"This is also used in Triggers. Under \"Triggers: Effects -> UI Overlay,\" select \"Video Glitch\"."}]},{"name":"BIS_fnc_VRFadeOut","title":"BIS fnc VRFadeOut","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRFadeOut","revid":309376,"updated":"2022-05-05T12:04:33Z","groups":["VR"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Fade Out effect for VR.","syntaxes":[{"syntax":"call BIS_fnc_VRFadeOut","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["call BIS_fnc_VRFadeOut;"]}],"see_also":["BIS_fnc_VRFadeIn"]},{"name":"BIS_fnc_VRHitpart","title":"BIS fnc VRHitpart","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRHitpart","revid":348044,"updated":"2023-11-08T11:28:46Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"Initialize hit effects on VR targets.\n\ngrey - undamaged\n\norange - damaged\n\nred - destroyed","syntaxes":[{"syntax":"[object,time] call BIS_fnc_VRHitpart","params":[{"name":"object","type":"Object","description":"VR Object","type_expr":"Object"},{"name":"time","type":"Number","optional":true,"default":"30","description":"delay before hit parts are returned back to default","type_expr":"Number","text":"time: Number - (Optional, default 30) delay before hit parts are returned back to default"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["private _delta = [someObject, 60] call BIS_fnc_VRHitpart;"]}]},{"name":"BIS_fnc_VRSpawnEffect","title":"BIS fnc VRSpawnEffect","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRSpawnEffect","revid":348587,"updated":"2023-11-08T13:42:16Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"VR (unit) spawn effect.","syntaxes":[{"syntax":"[object, reverse, size] call BIS_fnc_VRSpawnEffect","params":[{"name":"object","type":"Object","description":"object","type_expr":"Object"},{"name":"effectType","type":"Boolean","optional":true,"default":"false","description":"reverse effect (hiding)","type_expr":"Boolean","text":"effectType: Boolean - (Optional, default false) reverse effect (hiding)"},{"name":"size","type":"Number","optional":true,"default":"0","description":"size of the effect","type_expr":"Number","text":"size: Number - (Optional, default 0) size of the effect"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[player, false, 5] call BIS_fnc_VRSpawnEffect;"]}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRSpawnSelector","title":"BIS fnc VRSpawnSelector","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRSpawnSelector","revid":349414,"updated":"2023-11-08T16:27:28Z","groups":["VR"],"status":"ok","games":{"arma3":"1.24"},"since":"arma3 1.24","arma3_since":"1.24","description":"Spawns the course selector (used primarily for VR missions).","syntaxes":[{"syntax":"[center, type] call BIS_fnc_VRSpawnSelector","params":[{"name":"center","type":"Position","type_expr":"Position"},{"name":"type","type":"String","optional":true,"default":"\"default\"","description":"can be:\n\"default\" (blue)\n\"incomplete\" (orange)\n\"complete\" (dark orange)\n\"exit\" (red)","type_expr":"String","text":"type: String - (Optional, default \"default\") can be:\n\"default\" (blue)\n\"incomplete\" (orange)\n\"complete\" (dark orange)\n\"exit\" (red)"}],"returns":{"type":"Object","type_expr":"Object","description":"created object for easy deletion"}}],"examples":[{"code":["[[0,0,0], \"exit\"] call BIS_fnc_VRSpawnSelector;"]}],"see_also":["Arma 3: Virtual Reality Custom Courses"]},{"name":"BIS_fnc_VRTimer","title":"BIS fnc VRTimer","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_VRTimer","revid":376474,"updated":"2025-10-16T20:10:46Z","groups":["VR"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"effect":"local"},"exec":"spawn","description":"Timer for VR and time trials. The following missionNamespace variables can be used:\n\n- `BIS_stopTimer`: set to true to stop the timer. Once stopped, the function must be executed again to restart the timer\n- `RscFiringDrillTime_current`: fill with Structured Text to display text instead of timer (when timer is stopped)\n- `RscFiringDrillTime_done`: set to true to close the display. ***Stop the timer first***","syntaxes":[{"syntax":"[colour] spawn BIS_fnc_VRTimer","params":[{"name":"colour","type":"String","optional":true,"default":"`([\"IGUI\", \"WARNING_RGB\"] call BIS_fnc_displayColorGet) call BIS_fnc_colorRGBtoHTML`","description":"timer colour in HTML format (#RRGGBB)","type_expr":"String","text":"colour: String (Optional, default `([\"IGUI\", \"WARNING_RGB\"] call BIS_fnc_displayColorGet) call BIS_fnc_colorRGBtoHTML`) timer colour in HTML format (#RRGGBB)"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[] spawn BIS_fnc_VRTimer;"]},{"code":["\"#025D00\" spawn BIS_fnc_VRTimer;"]},{"code":["[\"#025D00\"] spawn BIS_fnc_VRTimer;"]}],"see_also":["BIS_fnc_displayColorGet","BIS_fnc_colorRGBtoHTML"],"notes":[{"user":"Lou Montana","date":"2018-06-04T19:50:00Z","text":"Here is a countdown, inspired by this function:\n\n```sqf\nLM_fnc_timeoutCountdown = {\n\n    params [\n        [\"_time\", 30, [0]],\n        [\"_colour\", \"#FFFFFF\", [\"\"]]\n    ];\n    private _timeout = time + _time;\n    RscFiringDrillTime_done = false;\n    1 cutRsc [\"RscFiringDrillTime\", \"PLAIN\"];\n    while { time < _timeout } do\n    {\n        private _remainingTime = _timeout - time;\n        private _timeFormat = [_remainingTime, \"MM:SS.MS\", true] call BIS_fnc_secondsToString;\n        private _text = format [\"<t align='left' color='%1'><img image='%2' />%3:%4<t size='0.8'>.%5</t>\",\n            _colour,\n            \"A3\\Modules_F_Beta\\data\\FiringDrills\\timer_ca\",\n            _timeFormat select 0,\n            _timeFormat select 1,\n            _timeFormat select 2\n        ];\n        RscFiringDrillTime_current = parseText _text;\n        sleep 0.01;\n    };\n    private _timeFormat = [0, \"MM:SS.MS\", true] call BIS_fnc_secondsToString;\n    RscFiringDrillTime_current = parseText format [\"<t align='left' color='%1'><img image='%2' />%3:%4<t size='0.8'>.%5</t>\",\n        _colour,\n        \"A3\\Modules_F_Beta\\data\\FiringDrills\\timer_ca\",\n        _timeFormat select 0,\n        _timeFormat select 1,\n        _timeFormat select 2];\n    sleep 4;\n    RscFiringDrillTime_done = true;\n};\n```\n\nand to use it:\n\n```sqf\n[10, \"#FF5500\"] spawn LM_fnc_timeoutCountdown;\n```"}]},{"name":"BIS_fnc_weaponAddon","title":"BIS fnc weaponAddon","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_weaponAddon","revid":379514,"updated":"2026-10-31T00:28:53Z","groups":["Weapons"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Return addon from CfgPatches to which a given weapon class belongs to.\n\n> [!IMPORTANT]\n> This function is quite performance heavy, use only when absolutely necessary!","syntaxes":[{"syntax":"classname call BIS_fnc_weaponAddon","params":[{"name":"classname","type":"String","description":"weapon's classname","type_expr":"String"}],"returns":{"type":"String","type_expr":"String","description":"addon's config name"}}],"examples":[{"code":["\"arifle_MX_F\" call BIS_fnc_weaponAddon; // returns \"A3_Weapons_F_Rifles_MX\""]}]},{"name":"BIS_fnc_weaponComponents","title":"BIS fnc weaponComponents","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_weaponComponents","revid":348382,"updated":"2023-11-08T12:59:58Z","groups":["Weapons"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Returns array with classname of the parent weapon (without attachments), followed by classnames of all its attachments.\n\n> [!IMPORTANT]\n> The returned classnames are all converted to lower cases.","syntaxes":[{"syntax":"[classname] call BIS_fnc_weaponComponents","params":[{"name":"classname","type":"String","description":"classname of the parent weapon","type_expr":"String"}],"returns":{"type":"Array","type_expr":"Array"}}],"examples":[{"code":["\"arifle_mx_aco_pointer_f\" call BIS_fnc_weaponComponents; // [\"arifle_mx_f\",\"optic_aco\",\"acc_pointer_ir\"]"]},{"code":["\"arifle_mx_gl_black_hamr_pointer_f\" call BIS_fnc_weaponComponents; // [\"arifle_mx_gl_black_f\",\"optic_hamr\",\"acc_pointer_ir\"]"]},{"code":["\"arifle_mx_black_f\" call BIS_fnc_weaponComponents; // [\"arifle_mx_f\"]"]}]},{"name":"BIS_fnc_weaponDirectionRelative","title":"BIS fnc weaponDirectionRelative","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_weaponDirectionRelative","revid":339146,"updated":"2023-04-26T10:55:04Z","groups":["Weapons"],"status":"ok","games":{"arma3":"1.64"},"since":"arma3 1.64","arma3_since":"1.64","description":"Returns relative direction vector of given weapon for the given vehicle","syntaxes":[{"syntax":"[vehicle, weapon, visual] call BIS_fnc_weaponDirectionRelative","params":[{"name":"vehicle","type":"Object","description":"vehicle","type_expr":"Object"},{"name":"weapon","type":"String","description":"vehicle weapon","type_expr":"String"},{"name":"visual","type":"Boolean","optional":true,"default":"true","description":"if true - result is in render scope, false - simulation scope","type_expr":"Boolean","text":"visual: Boolean - (Optional, default true) if true - result is in render scope, false - simulation scope"}],"returns":{"type":"Array format Vector3D","types":["Array","Vector3D"],"type_expr":"Vector3D"}}],"examples":[{"code":["private _relweapondir = [tank, \"cannon_105mm\"] call BIS_fnc_weaponDirectionRelative;"]}],"see_also":["BIS_fnc_attachToRelative","BIS_fnc_vectorDirAndUpRelative","weaponDirection"]},{"name":"BIS_fnc_weaponsEntityType","title":"BIS fnc weaponsEntityType","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_weaponsEntityType","revid":327745,"updated":"2022-07-13T10:53:31Z","groups":["Weapons"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Return object's weapons as defined in config. Scans also turrets and pylons.","syntaxes":[{"syntax":"class call BIS_fnc_weaponsEntityType","params":[{"name":"class","type":"String or Array of Strings","description":"entity classes","type_expr":"String | Array<String>"}],"returns":{"type":"Array of Strings","type_expr":"Array<String>"}}],"examples":[{"code":["[\"B_Soldier_GL_F\"] call BIS_fnc_weaponsEntityType;\n// returns e.g [\"arifle_MX_GL_ACO_F\",\"hgun_P07_F\",\"Throw\",\"Put\"]"]},{"text":"```sqf\n\"B_Plane_CAS_01_dynamicLoadout_F\" call BIS_fnc_weaponsEntityType;\n/*\n    returns e.g\n    [\n        \"Gatling_30mm_Plane_CAS_01_F\",\n        \"Laserdesignator_pilotCamera\",\n        \"CMFlareLauncher\",\n        \"Missile_AA_04_Plane_CAS_01_F\",\n        \"Rocket_04_HE_Plane_CAS_01_F\",\n        \"Missile_AGM_02_Plane_CAS_01_F\",\n        \"Bomb_04_Plane_CAS_01_F\",\n        \"Rocket_04_AP_Plane_CAS_01_F\"\n    ]\n*/\n```","code":["\"B_Plane_CAS_01_dynamicLoadout_F\" call BIS_fnc_weaponsEntityType;\n/*\n\treturns e.g\n\t[\n\t\t\"Gatling_30mm_Plane_CAS_01_F\",\n\t\t\"Laserdesignator_pilotCamera\",\n\t\t\"CMFlareLauncher\",\n\t\t\"Missile_AA_04_Plane_CAS_01_F\",\n\t\t\"Rocket_04_HE_Plane_CAS_01_F\",\n\t\t\"Missile_AGM_02_Plane_CAS_01_F\",\n\t\t\"Bomb_04_Plane_CAS_01_F\",\n\t\t\"Rocket_04_AP_Plane_CAS_01_F\"\n\t]\n*/"]}],"see_also":["weapons","weaponsTurret"]},{"name":"BIS_fnc_WLAICore","title":"BIS fnc WLAICore","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLAICore","revid":273954,"updated":"2021-06-13T01:14:05Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_WLAICore","params":[],"returns":null}]},{"name":"BIS_fnc_WLAIPathSegmentation","title":"BIS fnc WLAIPathSegmentation","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLAIPathSegmentation","revid":273960,"updated":"2021-06-13T01:14:10Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Sets up a path and behavior for AI to a specific sector.","syntaxes":[{"syntax":"[] call BIS_fnc_WLAIPathSegmentation","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Sets up a path and behavior for AI to a specific sector.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLAIPurchases","title":"BIS fnc WLAIPurchases","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLAIPurchases","revid":274104,"updated":"2021-06-13T01:16:40Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_WLAIPurchases","params":[],"returns":null}]},{"name":"BIS_fnc_WLAircraftArrival","title":"BIS fnc WLAircraftArrival","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLAircraftArrival","revid":273943,"updated":"2021-06-13T01:13:55Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Spawns a requested aircraft and makes it land properly.","syntaxes":[{"syntax":"[] call BIS_fnc_WLAircraftArrival","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Spawns a requested aircraft and makes it land properly.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLAirdrop","title":"BIS fnc WLAirdrop","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLAirdrop","revid":273903,"updated":"2021-06-13T01:13:07Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Spawns a requested asset and drops it on a specific location.","syntaxes":[{"syntax":"[] call BIS_fnc_WLAirdrop","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Spawns a requested asset and drops it on a specific location.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLAISectorScan","title":"BIS fnc WLAISectorScan","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLAISectorScan","revid":274109,"updated":"2021-06-13T01:16:47Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Sector scan routine for AI.","syntaxes":[{"syntax":"[] call BIS_fnc_WLAISectorScan","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Sector scan routine for AI.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLArsenalFilter","title":"BIS fnc WLArsenalFilter","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLArsenalFilter","revid":281316,"updated":"2021-06-14T09:08:12Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.96"},"since":"arma3 1.96","arma3_since":"1.96","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_WLArsenalFilter","params":[],"returns":null}]},{"name":"BIS_fnc_WLCalculateIncome","title":"BIS fnc WLCalculateIncome","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLCalculateIncome","revid":274001,"updated":"2021-06-13T01:14:58Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Recalculate CP income for a specific side.","syntaxes":[{"syntax":"[] call BIS_fnc_WLCalculateIncome","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Recalculate CP income for a specific side.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLCalculateSectorConnections","title":"BIS fnc WLCalculateSectorConnections","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLCalculateSectorConnections","revid":273956,"updated":"2021-06-13T01:14:07Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Evaluates sector grid so it can be drawn on map.","syntaxes":[{"syntax":"[] call BIS_fnc_WLCalculateSectorConnections","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Evaluates sector grid so it can be drawn on map.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLClientInit","title":"BIS fnc WLClientInit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLClientInit","revid":273952,"updated":"2021-06-13T01:14:04Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"System init (client-side).","syntaxes":[{"syntax":"[] call BIS_fnc_WLClientInit","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: System init (client-side).","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLDebug","title":"BIS fnc WLDebug","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLDebug","revid":274002,"updated":"2021-06-13T01:14:59Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Debug logging.","syntaxes":[{"syntax":"[] call BIS_fnc_WLDebug","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Debug logging.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLDefenceSetup","title":"BIS fnc WLDefenceSetup","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLDefenceSetup","revid":274052,"updated":"2021-06-13T01:15:54Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Requested static weapon positionining routine.","syntaxes":[{"syntax":"[] call BIS_fnc_WLDefenceSetup","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Requested static weapon positionining routine.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLDropPurchase","title":"BIS fnc WLDropPurchase","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLDropPurchase","revid":273892,"updated":"2021-06-13T01:13:01Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Airdrop location selection routine.","syntaxes":[{"syntax":"[] call BIS_fnc_WLDropPurchase","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Airdrop location selection routine.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLFundsInfo","title":"BIS fnc WLFundsInfo","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLFundsInfo","revid":273976,"updated":"2021-06-13T01:14:24Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Funds & sector status UI handle","syntaxes":[{"syntax":"[] call BIS_fnc_WLFundsInfo","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Funds & sector status UI handle","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLGarrisonRetreat","title":"BIS fnc WLGarrisonRetreat","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLGarrisonRetreat","revid":273998,"updated":"2021-06-13T01:14:55Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_WLGarrisonRetreat","params":[],"returns":null}]},{"name":"BIS_fnc_WLInit","title":"BIS fnc WLInit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLInit","revid":274121,"updated":"2021-06-13T01:16:57Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"System init.","syntaxes":[{"syntax":"[] call BIS_fnc_WLInit","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: System init.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLInSectorArea","title":"BIS fnc WLInSectorArea","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLInSectorArea","revid":273992,"updated":"2021-06-13T01:14:43Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Checks if the given unit is inside a specific sector.","syntaxes":[{"syntax":"[] call BIS_fnc_WLInSectorArea","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Checks if the given unit is inside a specific sector.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLLoadoutApply","title":"BIS fnc WLLoadoutApply","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLLoadoutApply","revid":273983,"updated":"2021-06-13T01:14:35Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Reapply a saved loadout.","syntaxes":[{"syntax":"[] call BIS_fnc_WLLoadoutApply","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Reapply a saved loadout.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLLoadoutGrab","title":"BIS fnc WLLoadoutGrab","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLLoadoutGrab","revid":273920,"updated":"2021-06-13T01:13:27Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Save a loadout for later.","syntaxes":[{"syntax":"[] call BIS_fnc_WLLoadoutGrab","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Save a loadout for later.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLMostVotedSector","title":"BIS fnc WLMostVotedSector","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLMostVotedSector","revid":273933,"updated":"2021-06-13T01:13:40Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Evaluates which sector was most voted for.","syntaxes":[{"syntax":"[] call BIS_fnc_WLMostVotedSector","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Evaluates which sector was most voted for.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLNavalArrival","title":"BIS fnc WLNavalArrival","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLNavalArrival","revid":273974,"updated":"2021-06-13T01:14:23Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Spawns a requested naval asset.","syntaxes":[{"syntax":"[] call BIS_fnc_WLNavalArrival","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Spawns a requested naval asset.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLOpenArsenal","title":"BIS fnc WLOpenArsenal","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLOpenArsenal","revid":274004,"updated":"2021-06-13T01:15:00Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Opens Arsenal interface.","syntaxes":[{"syntax":"[] call BIS_fnc_WLOpenArsenal","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Opens Arsenal interface.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLOSD","title":"BIS fnc WLOSD","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLOSD","revid":274046,"updated":"2021-06-13T01:15:47Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Manages temporary info in hints.","syntaxes":[{"syntax":"[] call BIS_fnc_WLOSD","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Manages temporary info in hints.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLOutlineIcons","title":"BIS fnc WLOutlineIcons","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLOutlineIcons","revid":274009,"updated":"2021-06-13T01:15:06Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Handles icons selection visualization in map.","syntaxes":[{"syntax":"[] call BIS_fnc_WLOutlineIcons","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Handles icons selection visualization in map.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLParseAssetList","title":"BIS fnc WLParseAssetList","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLParseAssetList","revid":281252,"updated":"2021-06-14T09:06:41Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.96"},"since":"arma3 1.96","arma3_since":"1.96","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_WLParseAssetList","params":[],"returns":null}]},{"name":"BIS_fnc_WLPlayersTracking","title":"BIS fnc WLPlayersTracking","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLPlayersTracking","revid":274015,"updated":"2021-06-13T01:15:11Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Keeps track of player unit & its marker.","syntaxes":[{"syntax":"[] call BIS_fnc_WLPlayersTracking","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Keeps track of player unit & its marker.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLPlayersTrackingServer","title":"BIS fnc WLPlayersTrackingServer","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLPlayersTrackingServer","revid":273940,"updated":"2021-06-13T01:13:48Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Manage connecting and disconnecting players.","syntaxes":[{"syntax":"[] call BIS_fnc_WLPlayersTrackingServer","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Manage connecting and disconnecting players.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLPurchaseMenu","title":"BIS fnc WLPurchaseMenu","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLPurchaseMenu","revid":273926,"updated":"2021-06-13T01:13:34Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Purchase interface handle.","syntaxes":[{"syntax":"[] call BIS_fnc_WLPurchaseMenu","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Purchase interface handle.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLRandomPosRect","title":"BIS fnc WLRandomPosRect","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLRandomPosRect","revid":273993,"updated":"2021-06-13T01:14:44Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Returns a random position in rectangle area.","syntaxes":[{"syntax":"[] call BIS_fnc_WLRandomPosRect","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Returns a random position in rectangle area.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLRecalculateServices","title":"BIS fnc WLRecalculateServices","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLRecalculateServices","revid":274030,"updated":"2021-06-13T01:15:25Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Refreshes a side's available services.","syntaxes":[{"syntax":"[] call BIS_fnc_WLRecalculateServices","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Refreshes a side's available services.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLRemovalHandle","title":"BIS fnc WLRemovalHandle","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLRemovalHandle","revid":274068,"updated":"2021-06-13T01:16:08Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Units & vehicles garbage collector.","syntaxes":[{"syntax":"[] call BIS_fnc_WLRemovalHandle","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Units & vehicles garbage collector.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLReputation","title":"BIS fnc WLReputation","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLReputation","revid":273957,"updated":"2021-06-13T01:14:07Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Calculate player's reputiation (how rapidly they lose subordinates).","syntaxes":[{"syntax":"[] call BIS_fnc_WLReputation","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Calculate player's reputiation (how rapidly they lose subordinates).","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLRequestFastTravel","title":"BIS fnc WLRequestFastTravel","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLRequestFastTravel","revid":274118,"updated":"2021-06-13T01:16:54Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Fast travel routine.","syntaxes":[{"syntax":"[] call BIS_fnc_WLRequestFastTravel","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Fast travel routine.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLRequestFundsTransfer","title":"BIS fnc WLRequestFundsTransfer","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLRequestFundsTransfer","revid":274069,"updated":"2021-06-13T01:16:08Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Funds transfer routine.","syntaxes":[{"syntax":"[] call BIS_fnc_WLRequestFundsTransfer","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Funds transfer routine.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLRequestPurchase","title":"BIS fnc WLRequestPurchase","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLRequestPurchase","revid":273975,"updated":"2021-06-13T01:14:24Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Handles proper purchase subroutine based on asset type.","syntaxes":[{"syntax":"[] call BIS_fnc_WLRequestPurchase","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Handles proper purchase subroutine based on asset type.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLRequestSectorScan","title":"BIS fnc WLRequestSectorScan","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLRequestSectorScan","revid":274108,"updated":"2021-06-13T01:16:47Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Sector scan routine (selection part).","syntaxes":[{"syntax":"[] call BIS_fnc_WLRequestSectorScan","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Sector scan routine (selection part).","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLRequestVotingReset","title":"BIS fnc WLRequestVotingReset","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLRequestVotingReset","revid":274063,"updated":"2021-06-13T01:16:05Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Voting reset routine.","syntaxes":[{"syntax":"[] call BIS_fnc_WLRequestVotingReset","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Voting reset routine.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLSectorFundsPayoff","title":"BIS fnc WLSectorFundsPayoff","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLSectorFundsPayoff","revid":274032,"updated":"2021-06-13T01:15:27Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_WLSectorFundsPayoff","params":[],"returns":null}]},{"name":"BIS_fnc_WLSectorHandle","title":"BIS fnc WLSectorHandle","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLSectorHandle","revid":274044,"updated":"2021-06-13T01:15:46Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_WLSectorHandle","params":[],"returns":null}]},{"name":"BIS_fnc_WLSectorHandleServer","title":"BIS fnc WLSectorHandleServer","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLSectorHandleServer","revid":273915,"updated":"2021-06-13T01:13:19Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_WLSectorHandleServer","params":[],"returns":null}]},{"name":"BIS_fnc_WLSectorIconUpdate","title":"BIS fnc WLSectorIconUpdate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLSectorIconUpdate","revid":273900,"updated":"2021-06-13T01:13:06Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Handles sector icons.","syntaxes":[{"syntax":"[] call BIS_fnc_WLSectorIconUpdate","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Handles sector icons.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLSectorInit","title":"BIS fnc WLSectorInit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLSectorInit","revid":273923,"updated":"2021-06-13T01:13:33Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Spawns sector garrison based on its size, sends a patrolling vehicle if feasible.","syntaxes":[{"syntax":"[] call BIS_fnc_WLSectorInit","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Spawns sector garrison based on its size, sends a patrolling vehicle if feasible.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLSectorListing","title":"BIS fnc WLSectorListing","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLSectorListing","revid":273995,"updated":"2021-06-13T01:14:47Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Keeps track of sectors status for a given side.","syntaxes":[{"syntax":"[] call BIS_fnc_WLSectorListing","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Keeps track of sectors status for a given side.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLSectorPopulate","title":"BIS fnc WLSectorPopulate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLSectorPopulate","revid":274048,"updated":"2021-06-13T01:15:48Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Spawns sector garrison.","syntaxes":[{"syntax":"[] call BIS_fnc_WLSectorPopulate","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Spawns sector garrison.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLSectorScanHandle","title":"BIS fnc WLSectorScanHandle","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLSectorScanHandle","revid":273997,"updated":"2021-06-13T01:14:54Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_WLSectorScanHandle","params":[],"returns":null}]},{"name":"BIS_fnc_WLSectorsCommonInit","title":"BIS fnc WLSectorsCommonInit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLSectorsCommonInit","revid":274098,"updated":"2021-06-13T01:16:36Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Sectors init (client-side).","syntaxes":[{"syntax":"[] call BIS_fnc_WLSectorsCommonInit","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Sectors init (client-side).","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLSectorSelectionEnd","title":"BIS fnc WLSectorSelectionEnd","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLSectorSelectionEnd","revid":273981,"updated":"2021-06-13T01:14:28Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Sector voting termination subroutine.","syntaxes":[{"syntax":"[] call BIS_fnc_WLSectorSelectionEnd","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Sector voting termination subroutine.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLSectorSelectionHandle","title":"BIS fnc WLSectorSelectionHandle","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLSectorSelectionHandle","revid":273907,"updated":"2021-06-13T01:13:10Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_WLSectorSelectionHandle","params":[],"returns":null}]},{"name":"BIS_fnc_WLSectorSelectionHandleServer","title":"BIS fnc WLSectorSelectionHandleServer","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLSectorSelectionHandleServer","revid":274088,"updated":"2021-06-13T01:16:27Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_WLSectorSelectionHandleServer","params":[],"returns":null}]},{"name":"BIS_fnc_WLSectorSelectionStart","title":"BIS fnc WLSectorSelectionStart","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLSectorSelectionStart","revid":274122,"updated":"2021-06-13T01:16:58Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Initializes sector voting.","syntaxes":[{"syntax":"[] call BIS_fnc_WLSectorSelectionStart","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Initializes sector voting.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLSectorsSetup","title":"BIS fnc WLSectorsSetup","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLSectorsSetup","revid":274053,"updated":"2021-06-13T01:15:55Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Sectors init (server-side).","syntaxes":[{"syntax":"[] call BIS_fnc_WLSectorsSetup","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Sectors init (server-side).","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLSectorTaskHandle","title":"BIS fnc WLSectorTaskHandle","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLSectorTaskHandle","revid":274084,"updated":"2021-06-13T01:16:24Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_WLSectorTaskHandle","params":[],"returns":null}]},{"name":"BIS_fnc_WLSectorUpdate","title":"BIS fnc WLSectorUpdate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLSectorUpdate","revid":273999,"updated":"2021-06-13T01:14:56Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Sector update after its owner changed.","syntaxes":[{"syntax":"[] call BIS_fnc_WLSectorUpdate","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Sector update after its owner changed.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLSeizingBarHandle","title":"BIS fnc WLSeizingBarHandle","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLSeizingBarHandle","revid":274072,"updated":"2021-06-13T01:16:12Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Handles the seizing bar element in UI.","syntaxes":[{"syntax":"[] call BIS_fnc_WLSeizingBarHandle","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Handles the seizing bar element in UI.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLSendResponseTeam","title":"BIS fnc WLSendResponseTeam","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLSendResponseTeam","revid":274120,"updated":"2021-06-13T01:16:57Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Spawns and manages response teams.","syntaxes":[{"syntax":"[] call BIS_fnc_WLSendResponseTeam","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Spawns and manages response teams.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLShowInfo","title":"BIS fnc WLShowInfo","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLShowInfo","revid":273912,"updated":"2021-06-13T01:13:15Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Hints buffer.","syntaxes":[{"syntax":"[] call BIS_fnc_WLShowInfo","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Hints buffer.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLSideToFaction","title":"BIS fnc WLSideToFaction","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLSideToFaction","revid":273889,"updated":"2021-06-13T01:12:57Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Returns the primary faction for a given side.","syntaxes":[{"syntax":"[] call BIS_fnc_WLSideToFaction","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Returns the primary faction for a given side.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLSmoothText","title":"BIS fnc WLSmoothText","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLSmoothText","revid":326960,"updated":"2022-07-12T21:44:41Z","groups":["Warlords","GUI"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","locality":{"effect":"local"},"exec":"spawn","description":"Display given text smoothly.","syntaxes":[{"syntax":"[text, nbOfLines, duration, color, outline] call BIS_fnc_WLSmoothText","params":[{"name":"text","type":"String","description":"text to display","type_expr":"String"},{"name":"nbOfLines","type":"Number","optional":true,"default":"3","description":"maximum number of lines to be shown at the same time","type_expr":"Number","text":"nbOfLines: Number - (Optional, default 3) maximum number of lines to be shown at the same time"},{"name":"duration","type":"Number","optional":true,"default":"5","description":"on-screen duration","type_expr":"Number","text":"duration: Number - (Optional, default 5) on-screen duration"},{"name":"color","type":"Color (RGBA)","optional":true,"default":"[1,1,1,1]","description":"text color","type_expr":"Color","text":"color: Color (RGBA) - (Optional, default [1,1,1,1]) text color"},{"name":"outline","type":"Boolean","optional":true,"default":"true","description":"true to outline the text, false not to","type_expr":"Boolean","text":"outline: Boolean - (Optional, default true) true to outline the text, false not to"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[\"Hello, hidden FX\", 2, 3, [1,0,0,1], true] spawn BIS_fnc_WLSmoothText; // no sounds, letters appear in a smooth transition"]}],"see_also":["Arma 3: Notification","BIS_fnc_titleText","BIS_fnc_typeText","BIS_fnc_typeText2"]},{"name":"BIS_fnc_WLSoundMsg","title":"BIS fnc WLSoundMsg","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLSoundMsg","revid":273934,"updated":"2021-06-13T01:13:42Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Play a given announcer message.","syntaxes":[{"syntax":"[] call BIS_fnc_WLSoundMsg","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Play a given announcer message.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLSubroutine_purchaseMenuAssetAvailability","title":"BIS fnc WLSubroutine purchaseMenuAssetAvailability","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLSubroutine_purchaseMenuAssetAvailability","revid":274036,"updated":"2021-06-13T01:15:33Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_WLSubroutine_purchaseMenuAssetAvailability","params":[],"returns":null}]},{"name":"BIS_fnc_WLSubroutine_purchaseMenuGetUIScale","title":"BIS fnc WLSubroutine purchaseMenuGetUIScale","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLSubroutine_purchaseMenuGetUIScale","revid":273882,"updated":"2021-06-13T01:12:49Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_WLSubroutine_purchaseMenuGetUIScale","params":[],"returns":null}]},{"name":"BIS_fnc_WLSubroutine_purchaseMenuHandleDLC","title":"BIS fnc WLSubroutine purchaseMenuHandleDLC","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLSubroutine_purchaseMenuHandleDLC","revid":274077,"updated":"2021-06-13T01:16:19Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_WLSubroutine_purchaseMenuHandleDLC","params":[],"returns":null}]},{"name":"BIS_fnc_WLSubroutine_purchaseMenuRefresh","title":"BIS fnc WLSubroutine purchaseMenuRefresh","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLSubroutine_purchaseMenuRefresh","revid":273930,"updated":"2021-06-13T01:13:38Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_WLSubroutine_purchaseMenuRefresh","params":[],"returns":null}]},{"name":"BIS_fnc_WLSubroutine_purchaseMenuSetAssetDetails","title":"BIS fnc WLSubroutine purchaseMenuSetAssetDetails","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLSubroutine_purchaseMenuSetAssetDetails","revid":273989,"updated":"2021-06-13T01:14:41Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_WLSubroutine_purchaseMenuSetAssetDetails","params":[],"returns":null}]},{"name":"BIS_fnc_WLSubroutine_purchaseMenuSetItemsList","title":"BIS fnc WLSubroutine purchaseMenuSetItemsList","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLSubroutine_purchaseMenuSetItemsList","revid":274027,"updated":"2021-06-13T01:15:21Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"*N/A*","syntaxes":[{"syntax":"[] call BIS_fnc_WLSubroutine_purchaseMenuSetItemsList","params":[],"returns":null}]},{"name":"BIS_fnc_WLSyncedTime","title":"BIS fnc WLSyncedTime","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLSyncedTime","revid":281229,"updated":"2021-06-14T09:06:21Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.96"},"since":"arma3 1.96","arma3_since":"1.96","description":"Returns time synced between server and clients","syntaxes":[{"syntax":"[] call BIS_fnc_WLSyncedTime","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Returns time synced between server and clients","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLSyncTime","title":"BIS fnc WLSyncTime","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLSyncTime","revid":274050,"updated":"2021-06-13T01:15:52Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Introduces a synchronized time value for server and clients. OBSOLETE NOW AFTER SERVERTIME FIX","syntaxes":[{"syntax":"[] call BIS_fnc_WLSyncTime","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Introduces a synchronized time value for server and clients.\nOBSOLETE NOW AFTER SERVERTIME FIX","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLUpdateAO","title":"BIS fnc WLUpdateAO","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLUpdateAO","revid":274119,"updated":"2021-06-13T01:16:56Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Recalculates AO info (sector distribution).","syntaxes":[{"syntax":"[] call BIS_fnc_WLUpdateAO","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Recalculates AO info (sector distribution).","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLVarsInit","title":"BIS fnc WLVarsInit","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLVarsInit","revid":273982,"updated":"2021-06-13T01:14:31Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Init variables.","syntaxes":[{"syntax":"[] call BIS_fnc_WLVarsInit","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Init variables.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLVehicleHandle","title":"BIS fnc WLVehicleHandle","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLVehicleHandle","revid":274081,"updated":"2021-06-13T01:16:22Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Keeps track of spawned vehicles.","syntaxes":[{"syntax":"[] call BIS_fnc_WLVehicleHandle","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Keeps track of spawned vehicles.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_WLVotingBarHandle","title":"BIS fnc WLVotingBarHandle","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_WLVotingBarHandle","revid":274057,"updated":"2021-06-13T01:15:57Z","groups":["Warlords"],"status":"ok","games":{"arma3":"1.86"},"since":"arma3 1.86","arma3_since":"1.86","description":"Handles the voting bar element in UI.","syntaxes":[{"syntax":"[] call BIS_fnc_WLVotingBarHandle","params":[],"returns":null}],"docblock":{"text":"WARLORDS-SPECIFIC FUNCTION\n\nAuthor: Josef Zemánek\n\nDescription: Handles the voting bar element in UI.","author":"Josef Zemánek"},"filled_from_docblock":["description"]},{"name":"BIS_fnc_worldArea","title":"BIS fnc worldArea","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_worldArea","revid":379515,"updated":"2026-10-31T00:29:01Z","groups":["Map and Markers"],"status":"ok","games":{"tkoh":"1.00","arma3":"0.50"},"since":"tkoh 1.00","arma3_since":"0.50","locality":{"effect":"local"},"description":"Creates (or returns if it already exists) trigger with size of map.","syntaxes":[{"syntax":"call BIS_fnc_worldArea","params":[],"returns":{"type":"Object","type_expr":"Object","description":"a trigger covering the whole defined terrain. Referenced by hsim_worldArea variable","text":"Object - a trigger covering the whole *defined* terrain. Referenced by **hsim_worldArea** variable"}}],"examples":[{"code":["private _bigTrigger = call BIS_fnc_worldArea;"]}],"see_also":["worldSize","2D Editor: Triggers","Eden Editor: Trigger","createTrigger"]},{"name":"BIS_fnc_wpArtillery","title":"BIS fnc wpArtillery","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_wpArtillery","revid":328431,"updated":"2022-07-13T16:00:51Z","groups":["Waypoints"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Let group members fire artillery barrage on waypoint position. Units must have magazine type.","syntaxes":[{"syntax":"[group, position, target, firedRounds, type] call BIS_fnc_wpArtillery","params":[{"name":"group","type":"Group","type_expr":"Group"},{"name":"position","type":"Array format Position","type_expr":"Position","types":["Array","Position"]},{"name":"target","type":"Object","optional":true,"default":"objNull","description":"***unused parameter***","type_expr":"Object","text":"target: Object - (Optional, default objNull) ***unused parameter***"},{"name":"firedRounds","type":"Number","optional":true,"default":"100","description":"number of fired rounds","type_expr":"Number","text":"firedRounds: Number - (Optional, default 100) number of fired rounds"},{"name":"type","type":"String","optional":true,"default":"\"\"","description":"magazine type to be used. If empty, first found magazine will be used","type_expr":"String","text":"type: String - (Optional, default \"\") magazine type to be used. If empty, first found magazine will be used"}],"returns":{"type":"Boolean","type_expr":"Boolean","description":"true when done"}}],"examples":[{"code":["[group player, getMarkerPos \"artilleryStrike\", objNull, 30, \"8Rnd_82mm_Mo_shells\"] call BIS_fnc_wpArtillery;"]}],"see_also":["doArtilleryFire","inRangeOfArtillery"]},{"name":"BIS_fnc_wpDemine","title":"BIS fnc wpDemine","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_wpDemine","revid":310701,"updated":"2022-05-06T11:19:11Z","groups":["Waypoints"],"status":"ok","games":{"arma3":"1.76"},"since":"arma3 1.76","arma3_since":"1.76","description":"Scripted \"CLEAR MINES\" Advanced Waypoint.\nThe script needs a unit with the abiility to demine (engineer or explosive specialist trait **and** a toolkit).","syntaxes":[{"syntax":"[group, position, target, clearUnknownMines] call BIS_fnc_wpDemine","params":[{"name":"group","type":"Group","description":"a group with a mine expert","type_expr":"Group"},{"name":"position","type":"Position","description":"the demining centre. Demining radius is defined by waypointCompletionRadius, and defaults to 50 if set to 0","type_expr":"Position"},{"name":"target","type":"Anything","optional":true,"default":"objNull","description":"unused parameter","type_expr":"Anything","text":"target: Anything - (Optional, default objNull) unused parameter"},{"name":"clearUnknownMines","type":"Boolean","optional":true,"default":"true","description":"should the group demine all mines or only the one its side knows about","type_expr":"Boolean","text":"clearUnknownMines: Boolean - (Optional, default true) should the group demine all mines or only the one its side knows about"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[group player, getMarkerPos \"mineField\", objNull, false] call BIS_fnc_wpDemine;"]}],"see_also":["Waypoints"]},{"name":"BIS_fnc_wpLand","title":"BIS fnc wpLand","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_wpLand","revid":328354,"updated":"2022-07-13T16:00:46Z","groups":["Waypoints"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","exec":"spawn","description":"Let group members land at the waypoint position.","syntaxes":[{"syntax":"[group, position, target] spawn BIS_fnc_wpLand","params":[{"name":"group","type":"Group","description":"group which is supposed to land","type_expr":"Group"},{"name":"position","type":"Position","description":"waypoint position","type_expr":"Position"},{"name":"target","type":"Object","description":"object the waypoint is attached to","type_expr":"Object"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"code":["[group player, [0,0,0], BIS_vehicle] spawn BIS_fnc_wpLand;"]}],"see_also":["BIS_fnc_scriptedWaypointType","BIS_fnc_wpTransport"],"categories_extra":["Introduced with Take On Helicopters version 1.00","Take On Helicopters: Functions","Take On Helicopters: New Functions"]},{"name":"BIS_fnc_wpPatrol","title":"BIS fnc wpPatrol","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_wpPatrol","revid":339140,"updated":"2023-04-26T10:55:02Z","groups":["Waypoints","Broken Functions"],"status":"broken","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"> [!IMPORTANT]\n> This function does not work.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}]},{"name":"BIS_fnc_wpRelax","title":"BIS fnc wpRelax","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_wpRelax","revid":339104,"updated":"2023-04-26T10:54:29Z","groups":["Waypoints"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"> [!IMPORTANT]\n> This function does not work.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}]},{"name":"BIS_fnc_wpSuppress","title":"BIS fnc wpSuppress","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_wpSuppress","revid":279208,"updated":"2021-06-13T22:14:31Z","groups":["Waypoints"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"> [!IMPORTANT]\n> This function does not work.","syntaxes":[{"syntax":"-","params":[],"returns":{"type":"Nothing","type_expr":"Nothing","text":"-"}}],"examples":[{"text":"-"}]},{"name":"BIS_fnc_zoomLock","title":"BIS fnc zoomLock","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_zoomLock","revid":328000,"updated":"2022-07-13T15:48:50Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","locality":{"effect":"local"},"description":"Locks the camera in place when the map is open.","syntaxes":[{"syntax":"[cameraCenter] call BIS_fnc_zoomLock","params":[{"name":"cameraCenter","type":"Array format Position2D","optional":true,"default":"[0, 0]","description":"position where the camera should be placed and locked","type_expr":"Position2D","types":["Array","Position2D"],"text":"cameraCenter: Array format Position2D - (Optional, default [0, 0]) position where the camera should be placed and locked"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[[0, 0]] call BIS_fnc_zoomLock;"]}],"see_also":["BIS_fnc_zoomUnlock","BIS_fnc_zoomLockEH"],"notes":[{"user":"Poslovitch","date":"2020-04-22T16:29:00Z","text":"In **Arma 3 v1.98.146303**, closing the map after running this function **does not unlock** the map's camera. One must use BIS_fnc_zoomUnlock to allow the player to move the camera again."}]},{"name":"BIS_fnc_zoomLockEH","title":"BIS fnc zoomLockEH","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_zoomLockEH","revid":348988,"updated":"2023-11-08T14:45:47Z","groups":["Map and Markers","Event Handlers"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","locality":{"effect":"local"},"description":"Event handler function for locking the camera.","syntaxes":[{"syntax":"position call BIS_fnc_zoomLockEH","params":[{"name":"position","type":"Position","description":"position that the camera should focus","type_expr":"Position"}],"returns":null}],"examples":[{"code":["[position player] call BIS_fnc_zoomLockEH;"]}],"see_also":["BIS_fnc_zoomLock","BIS_fnc_zoomUnlock"]},{"name":"BIS_fnc_zoomOnArea","title":"BIS fnc zoomOnArea","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_zoomOnArea","revid":322348,"updated":"2022-05-31T21:47:12Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Map will zoom on the given area. Function always takes the longer side of the area to zoom on.","syntaxes":[{"syntax":"[area, center, time, handler, forceCam] call BIS_fnc_zoomOnArea","params":[{"name":"area","type":"Array","description":"area to zoom on","type_expr":"Array"},{"name":"center","type":"Array","description":"coordinates of the center","type_expr":"Array"},{"name":"time","type":"Number","optional":true,"default":"1","description":"time of the zoom operation","type_expr":"Number","text":"time: Number - (Optional, default 1) time of the zoom operation"},{"name":"handler","type":"Control","optional":true,"default":"nil","description":"handler to the map display control (you can pass one if already exists, if not, handler is created)","type_expr":"Control","text":"handler: Control - (Optional, default nil) handler to the map display control (you can pass one if already exists, if not, handler is created)"},{"name":"forceCam","type":"Boolean","optional":true,"default":"false","description":"whether to force the camera in position after the zoom.","type_expr":"Boolean","text":"forceCam: Boolean - (Optional, default false) whether to force the camera in position after the zoom."}],"returns":{"type":"Number","type_expr":"Number","description":"zoom level"}}],"examples":[{"code":["openMap true;\n[markerSize \"BIS_areaMarker\", markerPos \"BIS_areaMarker\", 5] call BIS_fnc_zoomOnArea;"]}],"see_also":["BIS_fnc_zoomLock","BIS_fnc_zoomUnlock"]},{"name":"BIS_fnc_zoomUnlock","title":"BIS fnc zoomUnlock","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_zoomUnlock","revid":309295,"updated":"2022-05-05T12:02:22Z","groups":["Map and Markers"],"status":"ok","games":{"arma3":"1.78"},"since":"arma3 1.78","arma3_since":"1.78","description":"Function that unlocks the camera in which has been previously locked with BIS_fnc_zoomLock.","syntaxes":[{"syntax":"call BIS_fnc_zoomUnlock","params":[],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[] call BIS_fnc_zoomUnlock;"]}],"see_also":["BIS_fnc_zoomLock"]},{"name":"BIS_fnc_zzRotate","title":"BIS fnc zzRotate","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_zzRotate","revid":309734,"updated":"2022-05-05T12:09:47Z","groups":["Scenes"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"> [!NOTE]\n> This function is non functional in Arma 3 because of undefined variables.","syntaxes":[{"syntax":"","params":[],"returns":null}]}]}