BIS fnc shakeMap: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *M([a-z ])" to "$1 - m$2")
 
(25 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=--->
|descr= "Camera shake" function for the map. Shakes the map for a given amount of time with a given amount of force around the given camera center. Exits if map is not open.


<!---|eff= local |Multiplayer Effects=--->
|s1= [duration, magnitude, center] call [[BIS_fnc_shakeMap]]


| <pre>/*
|p1= duration: [[Number]] - duration of the effect
Author: Riccardo Argiolas


Description:
|p2= magnitude: [[Number]] - magnitude of the shaking force
"Camera shake" function for the map. Shakes the map for a given amount of time with a given amount of force around the given camera center. Exits if map is not open.


Parameters:
|p3= center: [[Array]] - center [[Position|position]] of the effect
Select 0 - NUMBER: duration of shake effect.
Select 1 - NUMBER: magnitude of the shaking force.
Select 2 - ARRAY: position of the camera center around which the shake effect occurs.


Returns: None
|r1= [[Nothing]]


Examples:
|x1= <sqf>[2,20,getMarkerPos "BIS_markerExtraction0"] call BIS_fnc_shakeMap;</sqf>


[2,20,getMarkerPos "BIS_markerExtraction0"] call BIS_fnc_shakeMap;
|x2= <sqf>[2,20,getPos player] call BIS_fnc_shakeMap;</sqf>
[2,20,getPos player] call BIS_fnc_shakeMap;
*/</pre>{{Informative|Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]]}} |Description=


|[] call [[BIS_fnc_shakeMap]]|Syntax=
|seealso= [[BIS_fnc_shakeMapEH]]
 
|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
 
|Datatype - description|Return value=
 
|x1= <code></code>|Example 1=
 
|exec= call |Execution=
 
| |See also=
}}
}}
[[Category:Function Group: Map|{{uc:shakeMap}}]]
[[Category:Functions|{{uc:shakeMap}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:shakeMap}}]]

Latest revision as of 15:39, 8 November 2023

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

Description

Description:
"Camera shake" function for the map. Shakes the map for a given amount of time with a given amount of force around the given camera center. Exits if map is not open.
Execution:
call
Groups:
Map and Markers

Syntax

Syntax:
[duration, magnitude, center] call BIS_fnc_shakeMap
Parameters:
duration: Number - duration of the effect
magnitude: Number - magnitude of the shaking force
center: Array - center position of the effect
Return Value:
Nothing

Examples

Example 1:
[2,20,getMarkerPos "BIS_markerExtraction0"] call BIS_fnc_shakeMap;
Example 2:
[2,20,getPos player] call BIS_fnc_shakeMap;

Additional Information

See also:
BIS_fnc_shakeMapEH

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_shakeMap&oldid=348853"