BIN fnc setPointOfInterest: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "</small> |= Description" to "</small> |Description=")
m (Some wiki formatting)
 
(30 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.94


| arma3 |= Game name
|gr1= Contact


|1.94|Game version=
|descr= <pre>/*
____________________________________________________________________________________________
 
| <pre>/*


Description:
Description:
Line 47: Line 45:
["myID",false,position myObject,[50,50,0,false]] call BIN_fnc_setPointOfInterest;
["myID",false,position myObject,[50,50,0,false]] call BIN_fnc_setPointOfInterest;
*/
*/
</pre>


{{Wiki|placeholder}}
{{Feature|arma3contact}}


#define VAR "bin_POIs"
|s1= <!-- [] call [[BIN_fnc_setPointOfInterest]] -->
#define TASK_PRIORITY 2
#define REVEAL_DISTANCE 100


#define POS_DEFAULT []
|r1=
#define AREA_DEFAULT []
#define TYPE_DEFAULT ""
#define COLOR_DEFAULT ""
#define STATUS_DEFAULT 0


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |Description=
|x1=
____________________________________________________________________________________________
 
| <!-- [] call [[BIN_fnc_setPointOfInterest]]; --> |= Syntax
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso=
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Misc|{{uc:setPointOfInterest}}]]
[[Category:Functions|{{uc:setPointOfInterest}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:setPointOfInterest}}]]

Latest revision as of 11:35, 6 May 2024

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;
*/
🏗
Placeholder description extracted from the function header by BIS_fnc_exportFunctionsToWiki.
enoch icon ca.png
This content is exclusive to the Arma 3 Contact Expansion.
Execution:
call
Groups:
Contact

Syntax

Syntax:
Syntax needed
Return Value:
Return value needed

Examples

Examples:
Example needed

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