BIN_fnc_setPointOfInterest

Description

Add point of interest shown in the map

Note

This content is exclusive to the Arma 3 Contact Expansion.

Syntax

syntax inferred from the function header

[param0, param1, param2, param3, param4, param5, param0] call BIN_fnc_setPointOfInterest

Parameters:

• param0 — 0: STRING - unique ID of the point
• param1 — 1: BOOL - true if the point is completed (shown faded in the map) NUMBER - status, can be: -1: dormant, will be activated when player gets close 0: shown, but not completed +1: completed
• param2 — 2: ARRAY - position
• param3 — 3: ARRAY - area in format [width,height,angle,isRectangle]
• param4 — 4: STRING - type, can be "Unknown" or "Warning" (default: "Unknown")
• param5 — 5: STRING - color, can be "Black", "Blue" or "Red" (default: "Black") or
• param0 — 0: OBJECT - "Point of interest" module

Returns: STRING - ID of the point

Examples

Example 1

//--- Activate existing module
_myID = myModule call BIN_fnc_setPointOfInterest;

Example 2

//--- Mark POI as completed
[_myID,true] call BIN_fnc_setPointOfInterest;

Example 3

//--- Set custom POI
["myID",false,position myObject,[50,50,0,false],"Warning","Red"] call BIN_fnc_setPointOfInterest;

Example 4

//--- Set custom POI using default type and color
["myID",false,position myObject,[50,50,0,false]] call BIN_fnc_setPointOfInterest;

Function header

The comment at the top of the function's file in the game; this page's params, syntax, returns, examples, description come from it.

/*
Description:
    Add point of interest shown in the map

Parameter(s):
    0: STRING - unique ID of the point
    1:
        BOOL - true if the point is completed (shown faded in the map)
        NUMBER - status, can be:
            -1: dormant, will be activated when player gets close
             0: shown, but not completed
            +1: completed
    2: ARRAY - position
    3: ARRAY - area in format [width,height,angle,isRectangle]
    4: STRING - type, can be "Unknown" or "Warning" (default: "Unknown")
    5: STRING - color, can be "Black", "Blue" or "Red" (default: "Black")

    or

    0: OBJECT - "Point of interest" module

Returns:
    STRING - ID of the point

Examples:

    //--- Activate existing module
    _myID = myModule call BIN_fnc_setPointOfInterest;

    //--- Mark POI as completed
    [_myID,true] call BIN_fnc_setPointOfInterest;

    //--- Set custom POI
    ["myID",false,position myObject,[50,50,0,false],"Warning","Red"] call BIN_fnc_setPointOfInterest;

    //--- Set custom POI using default type and color
    ["myID",false,position myObject,[50,50,0,false]] call BIN_fnc_setPointOfInterest;
*/