BIS fnc EXP camp setCinematicMode: Difference between revisions

From Bohemia Interactive Community
m (rollback)
m (Text replacement - "(\|p[0-9]+ *= *[^(]+\(Optional(, default[^)]*)\) )H([a-z])" to "$1h$3")
 
(24 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function


| arma3 |Game name=
|game1= arma3
|version1= 1.62


|1.62|Game version=
|gr1= Campaign


<!---|arg= local |Multiplayer Arguments=--->
|descr= Sets cinematic mode, with cinematic mode enabled the sounds are muted and screen is black.


<!---|eff= local |Multiplayer Effects=--->
|mp= Must be executed for every player.


| <pre>/*
|s1= [mode, fadeBlack, fadeSound] call [[BIS_fnc_EXP_camp_setCinematicMode]]
Author: Nelson Duarte


Description:
|p1= mode: [[Boolean]] - (Optional, default [[false]]) [[true]] to enable, [[false]] to disable
Set's cinematic mode, with cinematic mode enabled the sounds are muted and screen is black


Parameters:
|p2= fadeBlack: [[Number]] - (Optional, default 5) how long it takes in seconds to fade the screen
_mode: Enable or not


Returns:
|p3= fadeSound: [[Number]] - (Optional, default 5) how long it takes in seconds to fade the sound
Nothing
*/</pre>{{Informative|Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]]}} |Description=


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


|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
|x1= <sqf>[true, 3, 3] call BIS_fnc_EXP_camp_setCinematicMode;</sqf>


|Datatype - description|Return value=
|seealso= [[BIS_fnc_EXP_camp_getCinematicMode]]
 
|x1= <code></code>|Example 1=
 
|exec= call |Execution=
 
| |See also=
}}
}}
[[Category:Function Group: Campaign|{{uc:EXP_camp_setCinematicMode}}]]
[[Category:Functions|{{uc:EXP_camp_setCinematicMode}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:EXP_camp_setCinematicMode}}]]

Latest revision as of 12:29, 8 November 2023

Arma 3 logo black.png 1.62
Hover & click on the images for description

Description

Description:
Sets cinematic mode, with cinematic mode enabled the sounds are muted and screen is black.
Execution:
call
Multiplayer:
Must be executed for every player.
Groups:
Campaign

Syntax

Syntax:
[mode, fadeBlack, fadeSound] call BIS_fnc_EXP_camp_setCinematicMode
Parameters:
mode: Boolean - (Optional, default false) true to enable, false to disable
fadeBlack: Number - (Optional, default 5) how long it takes in seconds to fade the screen
fadeSound: Number - (Optional, default 5) how long it takes in seconds to fade the sound
Return Value:
Nothing

Examples

Example 1:
[true, 3, 3] call BIS_fnc_EXP_camp_setCinematicMode;

Additional Information

See also:
BIS_fnc_EXP_camp_getCinematicMode

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_EXP_camp_setCinematicMode&oldid=348061"