BIS fnc wpHover: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= |p4=" to "|PARAMETER3= |p4=")
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *W([a-z ])" to "$1 - w$2")
 
(26 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| TKOH |Game name=
|game1= tkoh
|version1= 1.00


|1.00|Game version=
|gr1= Waypoints
____________________________________________________________________________________________


| HOVER [[Custom_Waypoints|custom waypoint]].
|descr= HOVER [[Custom_Waypoints|custom waypoint]].
Hover on specific spot.
Hover on specific spot.
|DESCRIPTION=
____________________________________________________________________________________________


| [[Custom_Waypoints#Function|arguments]]: [minTime, reset, altDiff, visualize] |SYNTAX=
|exec= spawn


|p1= minTime: [[Number]] - What time in seconds must be spent hovering before completion|Parameter1=
|s1= [[Custom Waypoints#Function|Custom Waypoint arguments]]: [minTime, reset, altDiff, visualize]
|p2= reset: [[Boolean]] - Reset the timer every time you fail hovering |Parameter2=


|p3= altDiff: [[Number]] - How far from the waypoint height must you hover (-1: altitude does not matter, only completionRadius does) (default: -1) |PARAMETER3=
|p1= minTime: [[Number]] - what time in seconds must be spent hovering before completion


|p4= visualize: [[Boolean]] - true to show hint (default: false) |=
|p2= reset: [[Boolean]] - reset the timer every time you fail hovering


| [[Nothing]] |RETURNVALUE=
|p3= altDiff: [[Number]] - how far from the waypoint height must you hover (-1: altitude does not matter, only completionRadius does) (default: -1)
____________________________________________________________________________________________
 
|x1= <code><nowiki>[</nowiki>[[player]], [[position]] dude, 10, 10, [[false]], -1, [[true]]] [[spawn]] BIS_fnc_wpLand;</code> |=


____________________________________________________________________________________________
|p4= visualize: [[Boolean]] - true to show hint (default: false)
| exec=spawn |=


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


|x1= <sqf>[player, position dude, 10, 10, false, -1, true] spawn BIS_fnc_wpLand;</sqf>
|seealso=
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Take_On_Helicopters:_Functions|wpHover]]
[[Category:Function Group: Waypoints|wpHover]]

Latest revision as of 16:35, 8 November 2023

Hover & click on the images for description

Description

Description:
HOVER custom waypoint. Hover on specific spot.
Execution:
spawn
Groups:
Waypoints

Syntax

Syntax:
Custom Waypoint arguments: [minTime, reset, altDiff, visualize]
Parameters:
minTime: Number - what time in seconds must be spent hovering before completion
reset: Boolean - reset the timer every time you fail hovering
altDiff: Number - how far from the waypoint height must you hover (-1: altitude does not matter, only completionRadius does) (default: -1)
visualize: Boolean - true to show hint (default: false)
Return Value:
Nothing

Examples

Example 1:
[player, position dude, 10, 10, false, -1, true] spawn BIS_fnc_wpLand;

Additional Information

See also:
See also needed

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