BIS fnc fadeEffect: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Page filling)
m (Text replacement - "\|seealso= ([^ ]+)(\]\]|\}\}), *(\[\[|\{\{)" to "|seealso= $1$2 $3")
 
(24 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.00


|1.00|Game version=
|eff= local


|eff= local |MP effect=
|gr1= GUI
____________________________________________________________________________________________


| Easily carry out complex fading. Default values will be used if parameters aren't defined or set to nil. |Description=
|exec= spawn
____________________________________________________________________________________________


| [''fadeInOrOut, blackOrWhite, duration, blur, music, ending, success''] call [[BIS_fnc_fadeEffect]] |Syntax=
|descr= Easily carry out complex fading. Default values will be used if parameters are not defined or set to nil.


|p1= fadeInOrOut: [[Number]] - (Optional, default 1) 0 to fade out, 1 to fade in |Parameter 1=
|s1= [fadeInOrOut, blackOrWhite, duration, blur, music, ending, success] spawn [[BIS_fnc_fadeEffect]]


|p2= fadeColor: [[String]] - (Optional, default "BLACK") '''case-sensitive''' can be "BLACK" or "WHITE" |Parameter 2=
|p1= fadeInOrOut: [[Number]] - (Optional, default 1) 0 to fade out, 1 to fade in


|p3= duration: [[Number]] - (Optional, default 3) fade duration in seconds |Parameter 3=
|p2= fadeColor: [[String]] - (Optional, default "BLACK") '''case-sensitive''' can be "BLACK" or "WHITE"


|p4= blur: [[Number]] - (Optional, default 0) 0 to not blur, 1 to blur (blur-in for fade-in, blur-out for fade-out) |Parameter 4=
|p3= duration: [[Number]] - (Optional, default 3) fade duration in seconds


|p5= music: [[String]] - (Optional, default "") '''only for fade-out''' music class name defined in [[Description.ext#CfgMusic|CfgMusic]] |Parameter 5=
|p4= blur: [[Number]] - (Optional, default 0) 0 to not blur, 1 to blur (blur-in for fade-in, blur-out for fade-out)


|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''' |Parameter 6=
|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'''


|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]] |Return value=
|r1= [[Nothing]]
____________________________________________________________________________________________


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


| [[endMission]], [[failMission]], [[BIS_fnc_endMission]], [[BIS_fnc_endMissionServer]], [[titleCut]] |See also=
|seealso= [[endMission]] [[failMission]] [[BIS_fnc_endMission]] [[BIS_fnc_endMissionServer]] [[titleCut]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Functions|{{uc:fadeEffect}}]]
[[Category:Function Group: Misc|{{uc:fadeEffect}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:fadeEffect}}]]

Latest revision as of 13:00, 1 July 2022

Arma 3 logo black.png1.00
LELocal
Hover & click on the images for description

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:
[1, "WHITE", 5, 1] spawn BIS_fnc_fadeEffect;

Additional Information

See also:
endMission failMission BIS_fnc_endMission BIS_fnc_endMissionServer titleCut

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_fadeEffect&oldid=324311"