BIS fnc shakeCuratorCamera: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "(Optional, default {{hl|[]}})" to "(Optional, default <sqf inline>[]</sqf>)")
 
(33 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.16


| arma3 |= Game name
|gr1= Curator


|1.00|= Game version
|descr= Shake curator camera.
____________________________________________________________________________________________


| <pre>/*
|s1= [strength,duration,area] spawn [[BIS_fnc_shakeCuratorCamera]]


Description:
|p1=strength: [[Number]] - (Optional, default 0.01) shaking strength
Shake curator camera.
Must be executed in scheduled environment.


Parameter(s):
|p2= duration: [[Number]] - (Optional, default 0.7) duration in seconds
0: NUMBER - shaking strength
1: NUMBER - duration
2: ARRAY in format [<center>,<radius>] - shake only when camera is in given distance from center


Returns:
|p3= area: [[Array]] - (Optional, default <sqf inline>[]</sqf>) shake only when camera is in given distance from center. In format:<br>
BOOL
0: [[Position]] - Center<br>
*/
1: [[Number]] - Radius
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_shakeCuratorCamera]]; --> |= Syntax
|exec= spawn|r1= [[Boolean]]


|p1= |= Parameter 1
|x1= <sqf>[] spawn BIS_fnc_shakeCuratorCamera;</sqf>


| |= Return value
|x2= <sqf>[0.1, 5, [BIS_explosion_center,500]] spawn BIS_fnc_shakeCuratorCamera;</sqf>
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[Arma 3: Curator]]
}}
}}
<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:Function Group: Curator|{{uc:shakeCuratorCamera}}]]
[[Category:Functions|{{uc:shakeCuratorCamera}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:shakeCuratorCamera}}]]

Latest revision as of 19:09, 8 November 2023

Hover & click on the images for description

Description

Description:
Shake curator camera.
Execution:
spawn
Groups:
Curator

Syntax

Syntax:
[strength,duration,area] spawn BIS_fnc_shakeCuratorCamera
Parameters:
strength: Number - (Optional, default 0.01) shaking strength
duration: Number - (Optional, default 0.7) duration in seconds
area: Array - (Optional, default []) shake only when camera is in given distance from center. In format:
0: Position - Center
1: Number - Radius
Return Value:
Boolean

Examples

Example 1:
[] spawn BIS_fnc_shakeCuratorCamera;
Example 2:
[0.1, 5, [BIS_explosion_center,500]] spawn BIS_fnc_shakeCuratorCamera;

Additional Information

See also:
Arma 3: Curator

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