customWaypointPosition: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]3(\|.*)]]" to "{{GameCategory|arma3|Scripting Commands}}")
m (Some wiki formatting)
 
(21 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3 |Game=
|game1= arma3
|version1= 1.92


|1.92|Game Version =
|gr1= Waypoints


|arg= |Multiplayer Arguments =
|descr= Returns player's custom waypoint ({{Controls|LShift|LMB}}) position.


|eff=  |Multiplayer Effects =
|s1= [[customWaypointPosition]]


|serverExec= |Multiplayer Execution ("server" or empty)=
|r1= [[Array]] in format [[Position]] as [x,y,0], or empty array [] if the waypoint does not exist


|gr1= Waypoints |GROUP1=
|x1= <sqf>
____________________________________________________________________________________________
if (customWaypointPosition isNotEqualTo []) then
{
hint format ["You are %1m away from your custom waypoint.", round (player distance customWaypointPosition)];
};
</sqf>


| Returns player's custom waypoint (LShift + LMB) [[Position]] or an empty array <tt>[]</tt> if no custom waypoint exists. |Description=
|seealso= [[allMapMarkers]]
____________________________________________________________________________________________
 
| [[customWaypointPosition]] |Syntax=
 
| [[Position]] in format [x,y,0] or [] |Return Value=
____________________________________________________________________________________________
 
|x1= <code>[[customWaypointPosition]]</code> |Example 1=
____________________________________________________________________________________________
 
| [[allMapMarkers]] |See Also=
}}
}}
<dl class="command_description">
<!-- BEGIN Note Section -->
<!-- For example:
<dd class="notedate">Posted on Month Day, Year - Time (UTC)</dd>
<dt class="note">[[User:User Name|User Name]]</dt>
<dd class="note">This is an example note. It is true and verifiable, and contains a little code snippet.
<code>[[if]] ([[_this]] == anExample) [[then]] { [[hint]] "Leave it here for others to read"; };</code></dd>
-->
<!-- END Note Section -->
</dl>
<h3 style="display:none">Bottom Section</h3>
<!-- Appropriate categories go here -->
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 12:13, 7 March 2023

Arma 3 logo black.png1.92
Hover & click on the images for description

Description

Description:
Returns player's custom waypoint (⇧ Shift + Left Mouse Button) position.
Groups:
Waypoints

Syntax

Syntax:
customWaypointPosition
Return Value:
Array in format Position as [x,y,0], or empty array [] if the waypoint does not exist

Examples

Example 1:
if (customWaypointPosition isNotEqualTo []) then { hint format ["You are %1m away from your custom waypoint.", round (player distance customWaypointPosition)]; };

Additional Information

See also:
allMapMarkers

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
Retrieved from "https://community.bistudio.com/wiki?title=customWaypointPosition&oldid=338428"