{"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"]}