BIS fnc fadeEffect: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "\[\[Category\:Function Group\: Misc(\|\{\{[a-zA-Z0-9_:]+\}\})?\]\]" to "") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Function|Comments= | {{Function|Comments= | ||
| arma3 |Game name= | | arma3 |Game name= | ||
| Line 9: | Line 8: | ||
|gr1 = GUI |GROUP1= | |gr1 = GUI |GROUP1= | ||
| Easily carry out complex fading. Default values will be used if parameters aren't defined or set to nil. |Description= | | Easily carry out complex fading. Default values will be used if parameters aren't defined or set to nil. |Description= | ||
| [''fadeInOrOut, blackOrWhite, duration, blur, music, ending, success''] spawn [[BIS_fnc_fadeEffect]] |Syntax= | | [''fadeInOrOut, blackOrWhite, duration, blur, music, ending, success''] spawn [[BIS_fnc_fadeEffect]] |Syntax= | ||
| Line 31: | Line 28: | ||
| [[Nothing]] |Return value= | | [[Nothing]] |Return value= | ||
|x1= <code>[1, "WHITE", 5, 1] [[spawn]] [[BIS_fnc_fadeEffect]];</code> |Example 1= | |x1= <code>[1, "WHITE", 5, 1] [[spawn]] [[BIS_fnc_fadeEffect]];</code> |Example 1= | ||
| [[endMission]], [[failMission]], [[BIS_fnc_endMission]], [[BIS_fnc_endMissionServer]], [[titleCut]] |See also= | | [[endMission]], [[failMission]], [[BIS_fnc_endMission]], [[BIS_fnc_endMissionServer]], [[titleCut]] |See also= | ||
Revision as of 00:11, 17 January 2021
Description
- Description:
- Easily carry out complex fading. Default values will be used if parameters aren't defined or set to nil.
- Execution:
- spawn
- Groups:
- GUI
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
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