BIS fnc wpAngle: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= |p5=" to "|PARAMETER4= |p5=")
m (Text replacement - "‎" to "")
 
(18 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
____________________________________________________________________________________________
 
| CIRCLE [[Custom_Waypoints|custom waypoint]].


|descr= CIRCLE [[Custom_Waypoints|custom waypoint]].
Keep helicopter rotated in given vector toward target.
Keep helicopter rotated in given vector toward target.
|DESCRIPTION=
____________________________________________________________________________________________


| [[Custom_Waypoints#Function|arguments]]: [circleLimit, circleBorder, circleDir, customCond, hint] |SYNTAX=
|exec= spawn


|p1= circleLimit: [[Number]] - what time in seconds must be spent withing limit (default: 0)|Parameter1=
|s1= [[Custom Waypoints#Function|Custom Waypoint arguments]]: [circleLimit, circleBorder, circleDir, customCond, hint]
|p2= circleBorder: [[Number]] - precision tolerance (smaller number means more precision) (default: 0.75) |Parameter2=


|p3= circleDir: [[Number]] or [[Array]] - limit - direction or vector towards target (default: view of 2nd [[crew]] member - left (-90) or right (90)) |=
|p1= circleLimit: [[Number]] - what time in seconds must be spent withing limit (default: 0)
|p4= customCond: [[Code]] - additional condition required for waypoint completion. Passed arguments are [_veh,_target]. (default: {[[true]]}) |PARAMETER4=


|p5= hint: [[String]] - [[format]]ted hint. %1 is value showing how precise current vector is (in percents), %2 is precent symbol "%1" (default: "%1%2") |=
|p2= circleBorder: [[Number]] - precision tolerance (smaller number means more precision) (default: 0.75)


| [[Nothing]] |RETURNVALUE=
|p3= circleDir: [[Number]] or [[Array]] - limit - direction or vector towards target (default: view of 2nd [[crew]] member - left (-90) or right (90))
____________________________________________________________________________________________
 
|x1= <code><nowiki>[</nowiki>
[[player]],
[[position]] dude,
250,
60 1, 45 {[[alive]] dude}, "Spotted: %1%2"
] [[spawn]] BIS_fnc_wpAngle;</code> |EXAMPLE1=


____________________________________________________________________________________________
|p4= customCond: [[Code]] - additional condition required for waypoint completion. Passed arguments are [_veh,_target]. (default: {[[true]]})
| exec=spawn |=


| [[:Category:Function Group: Waypoints|Waypoint functions]] |SEEALSO=
|p5= hint: [[String]] - [[format]]ted hint. %1 is value showing how precise current vector is (in percents), %2 is precent symbol "%1" (default: "%1%2")


}}
|r1= [[Nothing]]


<h3 style="display:none">Notes</h3>
|x1=
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|seealso= [[:Category:Function Group: Waypoints|Waypoint functions]]
</dl>
}}
 
<h3 style="display:none">Bottom Section</h3>
 
[[Category:Take_On_Helicopters:_Functions|wpAngle]]
[[Category:Function Group: Waypoints|wpAngle]]

Latest revision as of 11:54, 26 April 2023

Hover & click on the images for description

Description

Description:
CIRCLE custom waypoint. Keep helicopter rotated in given vector toward target.
Execution:
spawn
Groups:
Waypoints

Syntax

Syntax:
Custom Waypoint arguments: [circleLimit, circleBorder, circleDir, customCond, hint]
Parameters:
circleLimit: Number - what time in seconds must be spent withing limit (default: 0)
circleBorder: Number - precision tolerance (smaller number means more precision) (default: 0.75)
circleDir: Number or Array - limit - direction or vector towards target (default: view of 2nd crew member - left (-90) or right (90))
customCond: Code - additional condition required for waypoint completion. Passed arguments are [_veh,_target]. (default: {true})
hint: String - formatted hint. %1 is value showing how precise current vector is (in percents), %2 is precent symbol "%1" (default: "%1%2")
Return Value:
Nothing

Examples

Examples:
Example needed

Additional Information

See also:
Waypoint functions

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