BIS fnc rotateMarker: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Created page with "{{Function|= Comments | arma3 |Game name= |1.78|Game version= <!---|arg= local |Multiplayer Arguments=---> <!---|eff= local |Multiplayer Effects=---> | <pre>/* Author:...")
 
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *N([a-z ])" to "$1 - n$2")
 
(23 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function


| arma3 |Game name=
|game1= arma3
|version1= 1.78


|1.78|Game version=
|gr1= Map and Markers


<!---|arg= local |Multiplayer Arguments=--->
|arg= global


<!---|eff= local |Multiplayer Effects=--->
|eff= global


| <pre>/*
|descr= Rotating a marker to new azimuth, using shortest turn, clockwise or anticlockwise movement.
Author:
BIS


Description:
|s1= [marker, newAzimuth, absoluteOrRelativ, shortestTurn, duraton] spawn [[BIS_fnc_rotateMarker]]
Rotating a marker to new azimuth, using shortest turn, clockwise or anticlockwise movement


Parameters:
|p1= marker: [[String]] - marker to rotate
Select 0 - STRING: Marker
Select 1 - NUMBER: New azimuth
Select 2 (OPTIONAL) - BOOLEAN: Absolute (true) or relative (false) azimuth (default true)
Select 3 (OPTIONAL) - NUMBER: 0 - shortest turn (default, if used with relative dir, counter clockwise is used), 1 - force clockwise, 2 - force counter clockwise
Select 4 (OPTIONAL) - NUMBER: Duration for complete rotation (default 2)


Returns:
|p2= newAzimuth: [[Number]] - new azimuth
Nothing


Examples:
|p3= absoluteOrRelativ: [[Boolean]] - (Optional, default [[true]]) defines if the azimuth is absolute [[true]] or relative [[false]]
_rotate = ["BIS_marker",90] spawn BIS_fnc_rotateMarker;
_rotate = ["BIS_marker",90,false] spawn BIS_fnc_rotateMarker;
_rotate = ["BIS_marker",90,true,1] spawn BIS_fnc_rotateMarker;
_rotate = ["BIS_marker",90,false,2,5] spawn BIS_fnc_rotateMarker;
*/</pre>{{Informative|Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]]}} |Description=


|[] call [[BIS_fnc_rotateMarker]]|Syntax=
|p4= shortestTurn: [[Number]] - (Optional, default 0) 0 - shortest turn (default, if used with relative dir, counter clockwise is used)<br>1 - force clockwise<br>2 - force counter clockwise


|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
|p5= duraton: [[Number]] - (Optional, default 2) duration for the complete rotation in seconds


|Datatype - description|Return value=
|r1= [[Nothing]]


|x1= <code></code>|Example 1=
|x1= <sqf>["BIS_marker",90] spawn BIS_fnc_rotateMarker;</sqf>


|exec= call |Execution=
|x2= <sqf>["BIS_marker",90,false,2,5] spawn BIS_fnc_rotateMarker;</sqf>


| |See also=
|exec= spawn
 
|seealso= [[BIS_fnc_blinkMarker]] [[BIS_fnc_resizeMarker]] [[BIS_fnc_moveMarker]]
}}
}}
[[Category:Function Group: Map|{{uc:rotateMarker}}]]
[[Category:Functions|{{uc:rotateMarker}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:rotateMarker}}]]

Latest revision as of 15:39, 8 November 2023

Arma 3 logo black.png1.78
GAGlobalGEGlobal
Hover & click on the images for description

Description

Description:
Rotating a marker to new azimuth, using shortest turn, clockwise or anticlockwise movement.
Execution:
spawn
Groups:
Map and Markers

Syntax

Syntax:
[marker, newAzimuth, absoluteOrRelativ, shortestTurn, duraton] spawn BIS_fnc_rotateMarker
Parameters:
marker: String - marker to rotate
newAzimuth: Number - new azimuth
absoluteOrRelativ: Boolean - (Optional, default true) defines if the azimuth is absolute true or relative false
shortestTurn: Number - (Optional, default 0) 0 - shortest turn (default, if used with relative dir, counter clockwise is used)
1 - force clockwise
2 - force counter clockwise
duraton: Number - (Optional, default 2) duration for the complete rotation in seconds
Return Value:
Nothing

Examples

Example 1:
["BIS_marker",90] spawn BIS_fnc_rotateMarker;
Example 2:
["BIS_marker",90,false,2,5] spawn BIS_fnc_rotateMarker;

Additional Information

See also:
BIS_fnc_blinkMarker BIS_fnc_resizeMarker BIS_fnc_moveMarker

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_rotateMarker&oldid=348885"