{"name":"BIN_fnc_setPointOfInterest","operator":null,"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","replaced_by":[],"games":[{"game":"arma3","name":"Arma 3","version":"1.94"}],"since":{"game":"arma3","name":"Arma 3","version":"1.94"},"arma3_since":"1.94","branch":null,"locality":{"argument":null,"effect":null,"server_exec":false},"exec":null,"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","since":null,"effect":null,"exec":null,"params":[{"name":"param0","type":"String","types":["String"],"optional":false,"default":null,"description":"unique ID of the point","since":null,"text":"0: STRING - unique ID of the point","source":"docblock"},{"name":"param1","type":"Boolean, Number","types":["Boolean","Number"],"optional":false,"default":null,"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","since":null,"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","types":["Array"],"optional":false,"default":null,"description":"position","since":null,"text":"2: ARRAY - position","source":"docblock"},{"name":"param3","type":"Array","types":["Array"],"optional":false,"default":null,"description":"area in format [width,height,angle,isRectangle]","since":null,"text":"3: ARRAY - area in format [width,height,angle,isRectangle]","source":"docblock"},{"name":"param4","type":"String","types":["String"],"optional":false,"default":"\"Unknown\"","description":"type, can be \"Unknown\" or \"Warning\" (default: \"Unknown\")","since":null,"text":"4: STRING - type, can be \"Unknown\" or \"Warning\" (default: \"Unknown\")","source":"docblock"},{"name":"param5","type":"String","types":["String"],"optional":false,"default":"\"Black\"","description":"color, can be \"Black\", \"Blue\" or \"Red\" (default: \"Black\")\nor","since":null,"text":"5: STRING - color, can be \"Black\", \"Blue\" or \"Red\" (default: \"Black\")\nor","source":"docblock"},{"name":"param0","type":"Object","types":["Object"],"optional":false,"default":null,"description":"\"Point of interest\" module","since":null,"text":"0: OBJECT - \"Point of interest\" module","source":"docblock"}],"returns":{"type":"String","types":["String"],"description":null,"text":"STRING - ID of the point","source":"docblock"},"inferred":true}],"examples":[{"text":"```sqf\n//--- Activate existing module\n_myID = myModule call BIN_fnc_setPointOfInterest;\n```","code":["//--- Activate existing module\n_myID = myModule call BIN_fnc_setPointOfInterest;"]},{"text":"```sqf\n//--- Mark POI as completed\n[_myID,true] call BIN_fnc_setPointOfInterest;\n```","code":["//--- Mark POI as completed\n[_myID,true] call BIN_fnc_setPointOfInterest;"]},{"text":"```sqf\n//--- Set custom POI\n[\"myID\",false,position myObject,[50,50,0,false],\"Warning\",\"Red\"] call BIN_fnc_setPointOfInterest;\n```","code":["//--- Set custom POI\n[\"myID\",false,position myObject,[50,50,0,false],\"Warning\",\"Red\"] call BIN_fnc_setPointOfInterest;"]},{"text":"```sqf\n//--- Set custom POI using default type and color\n[\"myID\",false,position myObject,[50,50,0,false]] call BIN_fnc_setPointOfInterest;\n```","code":["//--- Set custom POI using default type and color\n[\"myID\",false,position myObject,[50,50,0,false]] call BIN_fnc_setPointOfInterest;"]}],"multiplayer":null,"problems":null,"aliases":[],"see_also":[],"notes":[],"categories":["Arma 3: Functions","Arma 3: New Functions","Function Group: Contact","Functions","Introduced with Arma 3 version 1.94"],"docblock":{"author":null,"description":"Add point of interest shown in the map","params":[{"index":0,"name":null,"types":["String"],"optional":false,"default":null,"description":"unique ID of the point","text":"STRING - unique ID of the point"},{"index":1,"name":null,"types":["Boolean","Number"],"optional":false,"default":null,"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":"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"},{"index":2,"name":null,"types":["Array"],"optional":false,"default":null,"description":"position","text":"ARRAY - position"},{"index":3,"name":null,"types":["Array"],"optional":false,"default":null,"description":"area in format [width,height,angle,isRectangle]","text":"ARRAY - area in format [width,height,angle,isRectangle]"},{"index":4,"name":null,"types":["String"],"optional":false,"default":"\"Unknown\"","description":"type, can be \"Unknown\" or \"Warning\" (default: \"Unknown\")","text":"STRING - type, can be \"Unknown\" or \"Warning\" (default: \"Unknown\")"},{"index":5,"name":null,"types":["String"],"optional":false,"default":"\"Black\"","description":"color, can be \"Black\", \"Blue\" or \"Red\" (default: \"Black\")\nor","text":"STRING - color, can be \"Black\", \"Blue\" or \"Red\" (default: \"Black\")\nor"},{"index":0,"name":null,"types":["Object"],"optional":false,"default":null,"description":"\"Point of interest\" module","text":"OBJECT - \"Point of interest\" module"}],"returns":{"types":["String"],"text":"STRING - ID of the point"},"examples":["//--- Activate existing module\n_myID = myModule call BIN_fnc_setPointOfInterest;","//--- Mark POI as completed\n[_myID,true] call BIN_fnc_setPointOfInterest;","//--- Set custom POI\n[\"myID\",false,position myObject,[50,50,0,false],\"Warning\",\"Red\"] call BIN_fnc_setPointOfInterest;","//--- Set custom POI using default type and color\n[\"myID\",false,position myObject,[50,50,0,false]] call BIN_fnc_setPointOfInterest;"],"syntax":null,"execution":null,"notes":null,"requirements":null,"meta":{},"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"]}