BIS fnc fadeEffect: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\|gr([0-9]+) = " to "|gr$1= ") |
Lou Montana (talk | contribs) m (Text replacement - "\|seealso= ([^ ]+)(\]\]|\}\}), *(\[\[|\{\{)" to "|seealso= $1$2 $3") |
||
| (9 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{RV|type=function | {{RV|type=function | ||
| arma3 | |game1= arma3 | ||
|version1= 1.00 | |||
|1.00 | |||
|eff= local | |eff= local | ||
| Line 9: | Line 8: | ||
|gr1= GUI | |gr1= GUI | ||
| Easily carry out complex fading. Default values will be used if parameters are not defined or set to nil. | |exec= spawn | ||
|descr= Easily carry out complex fading. Default values will be used if parameters are not defined or set to nil. | |||
| [ | |s1= [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 | ||
| Line 27: | Line 28: | ||
|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]] | |r1= [[Nothing]] | ||
|x1= < | |x1= <sqf>[1, "WHITE", 5, 1] spawn BIS_fnc_fadeEffect;</sqf> | ||
| [[endMission]] | |seealso= [[endMission]] [[failMission]] [[BIS_fnc_endMission]] [[BIS_fnc_endMissionServer]] [[titleCut]] | ||
}} | }} | ||
Latest revision as of 14:00, 1 July 2022
Description
- Description:
- Easily carry out complex fading. Default values will be used if parameters are not 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:
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