{"name":"BIS_fnc_blackOut","operator":null,"title":"BIS fnc blackOut","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_blackOut","revid":327267,"updated":"2022-07-12T22:11:50Z","groups":["GUI"],"status":"ok","replaced_by":[],"games":[{"game":"arma3","name":"Arma 3","version":"1.00"}],"since":{"game":"arma3","name":"Arma 3","version":"1.00"},"arma3_since":"1.00","branch":null,"locality":{"argument":null,"effect":null,"server_exec":false},"exec":null,"description":"Register a black screen. Start the black screen when the first request is registered.","syntaxes":[{"syntax":"[id, smoothing, fadeSpeed] call BIS_fnc_blackOut","since":null,"effect":null,"exec":null,"params":[{"name":"id","type":"String","optional":false,"default":null,"description":"black screen id used for registration (case sensitive)","types":["String"],"since":null,"text":"id: String - black screen id used for registration (case sensitive)"},{"name":"smoothing","type":"Boolean","optional":true,"default":"true","description":"smooth transition - false for an immediate blackout","types":["Boolean"],"since":null,"text":"smoothing: Boolean - (Optional, default true) smooth transition - false for an immediate blackout"},{"name":"fadeSpeed","type":"Number","optional":true,"default":"2","description":"transition duration (if *smoothing* is true)","types":["Number"],"since":null,"text":"fadeSpeed: Number - (Optional, default 2) transition duration (if *smoothing* is true)"}],"returns":{"type":"Nothing","types":["Nothing"],"description":null,"text":"Nothing"}}],"examples":[{"text":"```sqf\n[\"TAG_aVeryUniqueID\", false, 5] call BIS_fnc_blackOut;\n```","code":["[\"TAG_aVeryUniqueID\", false, 5] call BIS_fnc_blackOut;"]}],"multiplayer":null,"problems":null,"aliases":[],"see_also":["BIS_fnc_blackIn"],"notes":[],"categories":["Arma 3: Functions","Arma 3: New Functions","Function Group: GUI","Functions","Introduced with Arma 3 version 1.00"],"docblock":null,"filled_from_docblock":[]}