setWaypointCompletionRadius: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Updated Description to the proper definition)
mNo edit summary
 
(76 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma2 |= Game name
|game1= arma2
|version1= 1.00


|1.00|= Game version
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


| The completion radius allows units to call the waypoint completed once they are inside of the given circle. |= Description
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| waypoint '''setWaypointCompletionRadius''' radius |= Syntax
|game4= arma3
|version4= 0.50


|p1= waypoint:  [[Array]] - format [[Waypoint]] |= PARAMETER1
|gr1= Waypoints


|p2= radius: [[Number]] |= PARAMETER2
|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.


| [[Nothing]] |= RETURNVALUE
|s1= waypoint [[setWaypointCompletionRadius]] radius


|p1= waypoint:  [[Array]] format [[Waypoint]]


|x1= <code>[grp,2] setWaypointCompletionRadius 30</code>|= EXAMPLE1
|p2= radius: [[Number]]


____________________________________________________________________________________________
|r1= [[Nothing]]


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


| |= MPBEHAVIOUR
|seealso= [[waypoints]] [[deleteWaypoint]] [[copyWaypoints]] [[setCurrentWaypoint]] [[setWaypointBehaviour]] [[setWaypointCombatMode]] [[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 -->


<!-- Note Section END -->
<dt></dt>
<dd class="notedate">Posted on 29 January 2010, 14:12</dd>
<dt class="note">[[User:Laking|Laking]]</dt>
<dd class="note">
* 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.
</dl>
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 21:38, 26 September 2024

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
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.
Retrieved from "https://community.bistudio.com/wiki?title=setWaypointCompletionRadius&oldid=369606"