BIS fnc fadeEffect: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...) |
||
| Line 1: | Line 1: | ||
{{Function | {{Function | ||
| arma3 | | arma3 | ||
|1.00 | |1.00 | ||
|eff= local |MP effect= | |eff= local |MP effect= | ||
|gr1 = GUI | |gr1 = GUI | ||
| Easily carry out complex fading. Default values will be used if parameters aren't defined or set to nil. | | Easily carry out complex fading. Default values will be used if parameters aren't defined or set to nil. | ||
| [''fadeInOrOut, blackOrWhite, duration, blur, music, ending, success''] spawn [[BIS_fnc_fadeEffect]] | | [''fadeInOrOut, blackOrWhite, duration, blur, music, ending, success''] spawn [[BIS_fnc_fadeEffect]] | ||
|p1= fadeInOrOut: [[Number]] - (Optional, default 1) 0 to fade out, 1 to fade in | |p1= fadeInOrOut: [[Number]] - (Optional, default 1) 0 to fade out, 1 to fade in | ||
|p2= fadeColor: [[String]] - (Optional, default "BLACK") '''case-sensitive''' can be "BLACK" or "WHITE" | |p2= fadeColor: [[String]] - (Optional, default "BLACK") '''case-sensitive''' can be "BLACK" or "WHITE" | ||
|p3= duration: [[Number]] - (Optional, default 3) fade duration in seconds | |p3= duration: [[Number]] - (Optional, default 3) fade duration in seconds | ||
|p4= blur: [[Number]] - (Optional, default 0) 0 to not blur, 1 to blur (blur-in for fade-in, blur-out for fade-out) | |p4= blur: [[Number]] - (Optional, default 0) 0 to not blur, 1 to blur (blur-in for fade-in, blur-out for fade-out) | ||
|p5= music: [[String]] - (Optional, default "") '''only for fade-out''' music class name defined in [[Description.ext#CfgMusic|CfgMusic]] | |p5= music: [[String]] - (Optional, default "") '''only for fade-out''' music class name defined in [[Description.ext#CfgMusic|CfgMusic]] | ||
|p6= 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''' | |p6= 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''' | ||
|p7= success: [[Number]] - (Optional, default 1) '''if ''ending'' != ""''' 1 to end mission with success, 0 to fail mission | |p7= success: [[Number]] - (Optional, default 1) '''if ''ending'' != ""''' 1 to end mission with success, 0 to fail mission | ||
| [[Nothing]] | | [[Nothing]] | ||
|x1= <code>[1, "WHITE", 5, 1] [[spawn]] [[BIS_fnc_fadeEffect]];</code> | |x1= <code>[1, "WHITE", 5, 1] [[spawn]] [[BIS_fnc_fadeEffect]];</code> | ||
| [[endMission]], [[failMission]], [[BIS_fnc_endMission]], [[BIS_fnc_endMissionServer]], [[titleCut]] | | [[endMission]], [[failMission]], [[BIS_fnc_endMission]], [[BIS_fnc_endMissionServer]], [[titleCut]] | ||
|exec= spawn |= Execution By (defaults to [[call]] if omitted) | |exec= spawn |= Execution By (defaults to [[call]] if omitted) | ||
}} | }} | ||
Revision as of 23:04, 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