BIS_fnc_fadeEffect

From Bohemia Interactive Community
Jump to navigation Jump to search
Introduced with Arma 3 version 1.00
  Effects of this scripting function are not broadcasted over the network and remain local to the client the function is executed on

Click on the images for descriptions

Introduced in

Game:
Arma 3
Version:
1.00

Description

Description:
Easily carry out complex fading. Default values will be used if parameters aren't defined or set to nil.

Syntax

Syntax:
[fadeInOrOut, blackOrWhite, duration, blur, music, ending, success] call BIS_fnc_fadeEffect
Parameters:
fadeInOrOut: Number - (Optional, default 1) 0 to fade out, 1 to fade in
fadeColor: String - (Optional, default "BLACK") case-sensitive can be "BLACK" or "WHITE"
duration: Number - (Optional, default 3) fade duration in seconds
blur: Number - (Optional, default 0) 0 to not blur, 1 to blur (blur-in for fade-in, blur-out for fade-out)
music: String - (Optional, default "") only for fade-out music class name defined in CfgMusic
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
success: Number - (Optional, default 1) if ending != "" 1 to end mission with success, 0 to fail mission
Return Value:
Nothing

Examples

Example 1:
[1, "WHITE", 5, 1] call BIS_fnc_fadeEffect;

Additional Information

Execution:
call
Multiplayer:
-
See also:
endMissionfailMissionBIS_fnc_endMissionBIS_fnc_endMissionServertitleCut

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Bottom Section