setWaypointCompletionRadius: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " | }}" to " }}")
m (Text replacement - "‎" to "")
(43 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma2
|game1= arma2
|version1= 1.00


|1.00
|game2= arma2oa
|version2= 1.50
 
|game3= tkoh
|version3= 1.00
 
|game4= arma3
|version4= 0.50


|gr1= Waypoints
|gr1= Waypoints


| The completion radius allows units to call the waypoint completed once they are inside of the given circle.
|descr= The completion radius allows units to call the waypoint completed once they are inside of the given circle. If the given radius is less than unit’s or vehicle’s configured 'precision' then the latter is used. For example tank precision is 10m, if the given radius is 5m, the final radius will be 10m. For units in [[player]]’s group there is an additional multiplier x5 to the configured precision. Units that are [[fleeing]] and are not in [[player]]'s [[Group]] will ignore the completion radius and would not be able to complete by proximity until they stop fleeing.


| waypoint '''setWaypointCompletionRadius''' radius
|s1= waypoint [[setWaypointCompletionRadius]] radius


|p1= waypoint:  [[Array]] - format [[Waypoint]]
|p1= waypoint:  [[Array]] - format [[Waypoint]]
Line 15: Line 23:
|p2= radius: [[Number]]
|p2= radius: [[Number]]


| [[Nothing]]
|r1= [[Nothing]]


|x1= <code>[grp, 2] [[setWaypointCompletionRadius]] 30;</code>
|x1= <sqf>[grp, 2] setWaypointCompletionRadius 30;</sqf>


| [[waypoints]], [[deleteWaypoint]], [[copyWaypoints]], [[setCurrentWaypoint]], [[setWaypointBehaviour]], [[setWaypointCombatMode]] [[setWaypointDescription]], [[setWaypointFormation]], [[setWaypointHousePosition]], [[setWaypointPosition]], [[setWaypointScript]], [[setWaypointSpeed]], [[setWaypointStatements]], [[setWaypointTimeout]], [[setWaypointType]], [[setWaypointVisible]], [[waypointAttachVehicle]], [[waypointAttachedVehicle]], [[setWaypointLoiterRadius]], [[waypointLoiterRadius]], [[addWaypoint]], [[setWaypointLoiterType]], [[waypointSpeed]]
|seealso= [[waypoints]] [[deleteWaypoint]] [[copyWaypoints]] [[setCurrentWaypoint]] [[setWaypointBehaviour]] [[setWaypointCombatMode]] [[setWaypointDescription]] [[setWaypointFormation]] [[setWaypointHousePosition]] [[setWaypointPosition]] [[setWaypointScript]] [[setWaypointSpeed]] [[setWaypointStatements]] [[setWaypointTimeout]] [[setWaypointType]] [[setWaypointVisible]] [[waypointAttachVehicle]] [[waypointAttachedVehicle]] [[setWaypointLoiterRadius]] [[waypointLoiterRadius]] [[addWaypoint]] [[setWaypointLoiterType]] [[waypointSpeed]]
}}
}}


<dl class='command_description'>
<dl class="command_description">
<!-- Note Section BEGIN -->
 
<dd class="notedate">Posted on 29 January 2010‎, 14:12</dd>
<dt></dt>
<dd class="notedate">Posted on 29 January 2010, 14:12</dd>
<dt class="note">[[User:Laking|Laking]]</dt>
<dt class="note">[[User:Laking|Laking]]</dt>
<dd class="note">
<dd class="note">
Line 32: Line 41:
* This does not necessarily mean the waypoint is complete once they are inside of the circle.  
* This does not necessarily mean the waypoint is complete once they are inside of the circle.  
* The way it works now it is complete once unit is inside and does not think it would be reasonable to move any closer.  
* The way it works now it is complete once unit is inside and does not think it would be reasonable to move any closer.  
<!-- Note Section END -->
</dl>
</dl>
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Revision as of 11:55, 26 April 2023

Hover & click on the images for description

Description

Description:
The completion radius allows units to call the waypoint completed once they are inside of the given circle. If the given radius is less than unit’s or vehicle’s configured 'precision' then the latter is used. For example tank precision is 10m, if the given radius is 5m, the final radius will be 10m. For units in player’s group there is an additional multiplier x5 to the configured precision. Units that are fleeing and are not in player's Group will ignore the completion radius and would not be able to complete by proximity until they stop fleeing.
Groups:
Waypoints

Syntax

Syntax:
waypoint setWaypointCompletionRadius radius
Parameters:
waypoint: Array - format Waypoint
radius: Number
Return Value:
Nothing

Examples

Example 1:
[grp, 2] setWaypointCompletionRadius 30;

Additional Information

See also:
waypoints deleteWaypoint copyWaypoints setCurrentWaypoint setWaypointBehaviour setWaypointCombatMode 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 29 January 2010, 14:12
Laking
  • The completion radius is currently important for units moving in the Combat mode.
  • With default completion radius = 0 the leader always finishes in the exact location of the waypoint.
  • By providing a completion radius you allow him to plan his road to a cover nearby instead.
  • This does not necessarily mean the waypoint is complete once they are inside of the circle.
  • The way it works now it is complete once unit is inside and does not think it would be reasonable to move any closer.