setCurrentWaypoint: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "<code>([a-zA-Z0-9_, ]+) +\[\[([a-zA-Z0-9_]+)\]\] +(\[[a-zA-Z0-9_, ]+\]);?<\/code>" to "<sqf>$1 $2 $3;</sqf>")
 
(55 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


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


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


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


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


____________________________________________________________________________________________
|game5= arma3
|version5= 0.50


| Sets the currently active waypoint for a group. |DESCRIPTION=
|arg= local
____________________________________________________________________________________________


| groupName '''setCurrentWaypoint''' waypoint |SYNTAX=
|gr1= Waypoints


|p1= groupName: [[Object]] or [[Group]] |PARAMETER1=
|descr= Sets the currently active waypoint for a group.
|p2= waypoint: [[Array]] - format [[Waypoint]] |PARAMETER2=


| [[Nothing]] |RETURNVALUE=
|s1= groupName [[setCurrentWaypoint]] waypoint
____________________________________________________________________________________________
 
|x1= <code>_grp [[setCurrentWaypoint]] [_grp, 1];</code> |EXAMPLE1=
____________________________________________________________________________________________


| [[waypoints]], [[deleteWaypoint]], [[copyWaypoints]], [[setWaypointBehaviour]], [[setWaypointCombatMode]], [[setWaypointCompletionRadius]], [[setWaypointDescription]], [[setWaypointFormation]], [[setWaypointHousePosition]], [[setWaypointPosition]], [[setWaypointScript]], [[setWaypointSpeed]], [[setWaypointStatements]], [[setWaypointTimeout]], [[setWaypointType]], [[setWaypointVisible]], [[waypointAttachVehicle]], [[waypointAttachedVehicle]], [[setWaypointLoiterRadius]], [[waypointLoiterRadius]], [[addWaypoint]], [[setWaypointLoiterType]], [[waypointSpeed]] |SEEALSO=
|p1= groupName: [[Object]] or [[Group]]
|p2= waypoint: [[Array]] - format [[Waypoint]]


|r1= [[Nothing]]
|x1= <sqf>_grp setCurrentWaypoint [_grp, 1];</sqf>
|seealso= [[waypoints]] [[deleteWaypoint]] [[copyWaypoints]] [[setWaypointBehaviour]] [[setWaypointCombatMode]] [[setWaypointCompletionRadius]] [[setWaypointDescription]] [[setWaypointFormation]] [[setWaypointHousePosition]] [[setWaypointPosition]] [[setWaypointScript]] [[setWaypointSpeed]] [[setWaypointStatements]] [[setWaypointTimeout]] [[setWaypointType]] [[setWaypointVisible]] [[waypointAttachVehicle]] [[waypointAttachedVehicle]] [[setWaypointLoiterRadius]] [[waypointLoiterRadius]] [[addWaypoint]] [[setWaypointLoiterType]] [[waypointSpeed]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->
 
<dd class="notedate">Posted on 27 Aug 2007
<dt></dt>
<dt class="note">[[User:Way|Way]]
<dd class="notedate">Posted on 27 Aug 2007</dd>
<dt class="note">[[User:Way|Way]]</dt>
<dd class="note">
<dd class="note">
(A1 1.08) Does not seem to work with Game Logic. Crashes to desktop.
(A1 1.08) Does not seem to work with Game Logic. Crashes to desktop.
 
<dt><dt>
<dd class="notedate">Posted on 26 Nov 2008
<dd class="notedate">Posted on 26 Nov 2008</dd>
<dt class="note">[[User:Ceeeb|Ceeeb]]
<dt class="note">[[User:Ceeeb|Ceeeb]]</dt>
<dd class="note">
<dd class="note">
Note that a waypoints number as seen in the mission editor is not the same as it is waypoint number using this command. In the mission editor, waypoint 0 refers to the first placed waypoint, whereas waypoint 0 with the setCurrentWaypoint command refers to the unit's initial position waypoint.
Note that a waypoints number as seen in the mission editor is not the same as it is waypoint number using this command. In the mission editor, waypoint 0 refers to the first placed waypoint, whereas waypoint 0 with the setCurrentWaypoint command refers to the unit's initial position waypoint.
 
<dt><dt>
<dd class="notedate">Posted on 17 Jan 2010
<dd class="notedate">Posted on 17 Jan 2010</dd>
<dt class="note">[[User:Galzohar|Galzohar]]
<dt class="note">[[User:Galzohar|Galzohar]]</dt>
<dd class="note">
<dd class="note">
(A2 1.05) This command may crash the game to desktop if you call it from the on act field of a waypoint that belongs to that same unit.  
(A2 1.05) This command may crash the game to desktop if you call it from the on act field of a waypoint that belongs to that same unit.  
 
<dt><dt>
<dd class="notedate">Posted on 13 Aug 2012
<dd class="notedate">Posted on 13 Aug 2012</dd>
<dt class="note">[[User:Igneous01|Igneous01]]
<dt class="note">[[User:Igneous01|Igneous01]]</dt>
<dd class="note">
<dd class="note">
Using this command forces the last waypoint to complete. Any code in the on Act of that waypoint will run.  
Using this command forces the last waypoint to complete. Any code in the on Act of that waypoint will run.  
<!-- Note Section END -->
</dl>
</dl>
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Armed Assault|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Waypoints|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]

Latest revision as of 13:23, 5 May 2022

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

Description

Description:
Sets the currently active waypoint for a group.
Groups:
Waypoints

Syntax

Syntax:
groupName setCurrentWaypoint waypoint
Parameters:
groupName: Object or Group
waypoint: Array - format Waypoint
Return Value:
Nothing

Examples

Example 1:
_grp setCurrentWaypoint [_grp, 1];

Additional Information

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

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
Posted on 27 Aug 2007
Way
(A1 1.08) Does not seem to work with Game Logic. Crashes to desktop.
Posted on 26 Nov 2008
Ceeeb
Note that a waypoints number as seen in the mission editor is not the same as it is waypoint number using this command. In the mission editor, waypoint 0 refers to the first placed waypoint, whereas waypoint 0 with the setCurrentWaypoint command refers to the unit's initial position waypoint.
Posted on 17 Jan 2010
Galzohar
(A2 1.05) This command may crash the game to desktop if you call it from the on act field of a waypoint that belongs to that same unit.
Posted on 13 Aug 2012
Igneous01
Using this command forces the last waypoint to complete. Any code in the on Act of that waypoint will run.
Retrieved from "https://community.bistudio.com/wiki?title=setCurrentWaypoint&oldid=310053"