BIN fnc setPointOfInterest: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{Feature arma3contact|This function is part of the Arma 3 Contact expansion only.}}" to "{{Feature arma3contact}}")
m (Text replacement - "\[\[Category\:Function Group\: Misc(\|\{\{[a-zA-Z0-9_:]+\}\})?\]\]" to "")
Line 83: Line 83:


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Misc|{{uc:setPointOfInterest}}]]
 
[[Category:Functions|{{uc:setPointOfInterest}}]]
[[Category:Functions|{{uc:setPointOfInterest}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:setPointOfInterest}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:setPointOfInterest}}]]

Revision as of 09:01, 10 October 2020

Hover & click on the images for description

Description

Description:
/*

	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;
*/


#define VAR			"bin_POIs"
#define TASK_PRIORITY		2
#define REVEAL_DISTANCE		100

#define POS_DEFAULT		[]
#define AREA_DEFAULT		[]
#define TYPE_DEFAULT		""
#define COLOR_DEFAULT		""
#define STATUS_DEFAULT		0

(Placeholder description extracted from the function header by BIS_fnc_exportFunctionsToWiki) Template:Feature arma3contact
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
Syntax needed
Return Value:
Return value needed

Examples

Example 1:

Additional Information

See also:
See also needed

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

Notes

Bottom Section