BIS fnc shakeMap: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{Function|= Comments " to "{{Function|Comments= ")
m (page filled)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
|game1= arma3


|1.78|Game version=
|version1= 1.78


<!---|arg= local |Multiplayer Arguments=--->
<!--|serverExec= server-->


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


| <pre>/*
<!--|eff= local-->
Author: Riccardo Argiolas


Description:
|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.
"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:
|s1= [duration, magnitude, center] call [[BIS_fnc_shakeMap]]
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
|p1= duration: [[Number]] - Duration of the effect


Examples:
|p2= magnitude: [[Number]] - Magnitude of the shaking force


[2,20,getMarkerPos "BIS_markerExtraction0"] call BIS_fnc_shakeMap;
|p3= center: [[Array]] - Center [[Position|position]] of the effect
[2,20,getPos player] call BIS_fnc_shakeMap;
*/</pre>{{placeholder}}<!-- Remove this after fill-in --> |Description=


|[] call [[BIS_fnc_shakeMap]]|Syntax=
|r1= [[Nothing]]


|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
|x1= <code>[2,20,[[getMarkerPos]] "BIS_markerExtraction0"] [[call]] [[BIS_fnc_shakeMap]];</code>


|Datatype - description|Return value=
|x2= <code>[2,20,[[getPos]] [[player]]] [[call]] [[BIS_fnc_shakeMap]];</code>


|x1= <code></code>|Example 1=
|exec= call


|exec= call |Execution=
|seealso= [[BIS_fnc_shakeMapEH]]


| |See also=
}}
}}



Revision as of 16:17, 20 July 2020

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:
Uncategorised

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