{"name":"BIS_fnc_fadeEffect","title":"BIS fnc fadeEffect","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_fadeEffect","revid":324311,"updated":"2022-07-01T12:00:44Z","groups":["GUI"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","locality":{"effect":"local"},"exec":"spawn","description":"Easily carry out complex fading. Default values will be used if parameters are not defined or set to nil.","syntaxes":[{"syntax":"[fadeInOrOut, blackOrWhite, duration, blur, music, ending, success] spawn BIS_fnc_fadeEffect","params":[{"name":"fadeInOrOut","type":"Number","optional":true,"default":"1","description":"0 to fade out, 1 to fade in","type_expr":"Number","text":"fadeInOrOut: Number - (Optional, default 1) 0 to fade out, 1 to fade in"},{"name":"fadeColor","type":"String","optional":true,"default":"\"BLACK\"","description":"**case-sensitive** can be \"BLACK\" or \"WHITE\"","type_expr":"String","text":"fadeColor: String - (Optional, default \"BLACK\") **case-sensitive** can be \"BLACK\" or \"WHITE\""},{"name":"duration","type":"Number","optional":true,"default":"3","description":"fade duration in seconds","type_expr":"Number","text":"duration: Number - (Optional, default 3) fade duration in seconds"},{"name":"blur","type":"Number","optional":true,"default":"0","description":"0 to not blur, 1 to blur (blur-in for fade-in, blur-out for fade-out)","type_expr":"Number","text":"blur: Number - (Optional, default 0) 0 to not blur, 1 to blur (blur-in for fade-in, blur-out for fade-out)"},{"name":"music","type":"String","optional":true,"default":"\"\"","description":"**only for fade-out** music class name defined in CfgMusic","type_expr":"String","text":"music: String - (Optional, default \"\") **only for fade-out** music class name defined in CfgMusic"},{"name":"ending","type":"String","optional":true,"default":"\"\"","description":"\"\" to not end the mission, else a value compatible with endMission or failMission. **Will end mission only for the local player**","type_expr":"String","text":"ending: String - (Optional, default \"\") \"\" to not end the mission, else a value compatible with endMission or failMission. **Will end mission only for the local player**"},{"name":"success","type":"Number","optional":true,"default":"1","description":"**if *ending* != \"\"** 1 to end mission with success, 0 to fail mission","type_expr":"Number","text":"success: Number - (Optional, default 1) **if *ending* != \"\"** 1 to end mission with success, 0 to fail mission"}],"returns":{"type":"Nothing","type_expr":"Nothing"}}],"examples":[{"code":["[1, \"WHITE\", 5, 1] spawn BIS_fnc_fadeEffect;"]}],"see_also":["endMission","failMission","BIS_fnc_endMission","BIS_fnc_endMissionServer","titleCut"]}