BIS fnc fadeEffect: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Page filling)
m (spawn not call)
Line 12: Line 12:
____________________________________________________________________________________________
____________________________________________________________________________________________


| [''fadeInOrOut, blackOrWhite, duration, blur, music, ending, success''] call [[BIS_fnc_fadeEffect]] |Syntax=
| [''fadeInOrOut, blackOrWhite, duration, blur, music, ending, success''] spawn [[BIS_fnc_fadeEffect]] |Syntax=


|p1= fadeInOrOut: [[Number]] - (Optional, default 1) 0 to fade out, 1 to fade in |Parameter 1=
|p1= fadeInOrOut: [[Number]] - (Optional, default 1) 0 to fade out, 1 to fade in |Parameter 1=
Line 31: Line 31:
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code>[1, "WHITE", 5, 1] [[call]] [[BIS_fnc_fadeEffect]];</code> |Example 1=
|x1= <code>[1, "WHITE", 5, 1] [[spawn]] [[BIS_fnc_fadeEffect]];</code> |Example 1=
____________________________________________________________________________________________
____________________________________________________________________________________________



Revision as of 16:30, 5 July 2019

Hover & click on the images for description

Description

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

Syntax

Syntax:
[fadeInOrOut, blackOrWhite, duration, blur, music, ending, success] spawn 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] spawn BIS_fnc_fadeEffect;

Additional Information

See also:
endMissionfailMissionBIS_fnc_endMissionBIS_fnc_endMissionServertitleCut

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

Notes

Bottom Section