waypoints: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
mNo edit summary
 
(47 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma1 |Game name=
|game1= arma1
|version1= 1.05


|1.05|Game version=
|game2= arma2
|version2= 1.00


|arg= global|Multiplayer Arguments=
|game3= arma2oa
|version3= 1.50


|gr1= Waypoints |GROUP1=
|game4= tkoh
____________________________________________________________________________________________
|version4= 1.00


| Returns an array of waypoints for the specified unit/group. |DESCRIPTION=
|game5= arma3
____________________________________________________________________________________________
|version5= 0.50


| '''waypoints''' groupName |SYNTAX=
|arg= global


|p1= groupName: [[Group]] |PARAMETER1=
|gr1= Waypoints


| [[Array]] of waypoints each in format [[Waypoint]] |RETURNVALUE=
|descr= Returns an array of waypoints for the specified unit/group.
____________________________________________________________________________________________
 
|x1=<code>[[waypoints]] [[player]];</code>
|x2=<code>_wPosArray = [[waypoints]] group10;{{cc|could return [[EAST 1-1-A,0],[EAST 1-1-A,1],[EAST 1-1-A,2]]}}</code>|EXAMPLE1=
____________________________________________________________________________________________


| [[deleteWaypoint]], [[copyWaypoints]], [[setCurrentWaypoint]], [[setWaypointBehaviour]], [[setWaypointCombatMode]], [[setWaypointCompletionRadius]], [[setWaypointDescription]], [[setWaypointFormation]], [[setWaypointHousePosition]], [[setWaypointPosition]], [[setWaypointScript]], [[setWaypointSpeed]], [[setWaypointStatements]], [[setWaypointTimeout]], [[setWaypointType]], [[setWaypointVisible]], [[waypointAttachVehicle]], [[waypointAttachedVehicle]], [[setWaypointLoiterRadius]], [[waypointLoiterRadius]], [[addWaypoint]], [[setWaypointLoiterType]], [[waypointSpeed]], [[setWPPos]], [[waypointName]]
|s1= [[waypoints]] groupName
|SEEALSO=


}}
|p1= groupName: [[Group]] or [[Object]]


<h3 style="display:none">Notes</h3>
|r1= [[Array]] of [[Waypoint]]s
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x1= <sqf>waypoints player;</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|x2= <sqf>_wPosArray = waypoints group10; // returns e.g [[EAST 1-1-A,0],[EAST 1-1-A,1],[EAST 1-1-A,2]]</sqf>


[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
|seealso= [[deleteWaypoint]] [[copyWaypoints]] [[setCurrentWaypoint]] [[setWaypointBehaviour]] [[setWaypointCombatMode]] [[setWaypointCompletionRadius]] [[setWaypointDescription]] [[setWaypointFormation]] [[setWaypointHousePosition]] [[setWaypointPosition]] [[setWaypointScript]] [[setWaypointSpeed]] [[setWaypointStatements]] [[setWaypointTimeout]] [[setWaypointType]] [[setWaypointVisible]] [[waypointAttachVehicle]] [[waypointAttachedVehicle]] [[setWaypointLoiterRadius]] [[waypointLoiterRadius]] [[addWaypoint]] [[setWaypointLoiterType]] [[waypointSpeed]] [[setWPPos]] [[waypointName]]
{{GameCategory|arma1|Scripting Commands}}
}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 10:43, 28 September 2023

Logo A1 black.png1.05Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobal
Hover & click on the images for description

Description

Description:
Returns an array of waypoints for the specified unit/group.
Groups:
Waypoints

Syntax

Syntax:
waypoints groupName
Parameters:
groupName: Group or Object
Return Value:
Array of Waypoints

Examples

Example 1:
waypoints player;
Example 2:
_wPosArray = waypoints group10; // returns e.g [[EAST 1-1-A,0],[EAST 1-1-A,1],[EAST 1-1-A,2]]

Additional Information

See also:
deleteWaypoint copyWaypoints setCurrentWaypoint setWaypointBehaviour setWaypointCombatMode setWaypointCompletionRadius setWaypointDescription setWaypointFormation setWaypointHousePosition setWaypointPosition setWaypointScript setWaypointSpeed setWaypointStatements setWaypointTimeout setWaypointType setWaypointVisible waypointAttachVehicle waypointAttachedVehicle setWaypointLoiterRadius waypointLoiterRadius addWaypoint setWaypointLoiterType waypointSpeed setWPPos waypointName

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=waypoints&oldid=347556"