BIS fnc fadeEffect: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
(Page filling)
Line 1: Line 1:
{{Function|Comments=
____________________________________________________________________________________________


{{Function|= Comments
| arma3 |Game name=
 
|1.00|Game version=
 
|eff= local |MP effect=
____________________________________________________________________________________________
____________________________________________________________________________________________


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


|1.00|= Game version
| [''fadeInOrOut, blackOrWhite, duration, blur, music, ending, success''] call [[BIS_fnc_fadeEffect]] |Syntax=
____________________________________________________________________________________________


| <pre>/*
|p1= fadeInOrOut: [[Number]] - (Optional, default 1) 0 to fade out, 1 to fade in |Parameter 1=


Description:
|p2= fadeColor: [[String]] - (Optional, default "BLACK") '''case-sensitive''' can be "BLACK" or "WHITE" |Parameter 2=
Easily carry out complex fading. Default values will be used if parameters aren't defined or set to nil.


Parameter(s):
|p3= duration: [[Number]] - (Optional, default 3) fade duration in seconds |Parameter 3=
_this select 0 (Optional): NUMBER - 0: fade out, 1: fade in
_this select 1 (Optional): STRING - "BLACK": black fade, "WHITE": white fade
_this select 2 (Optional): NUMBER - Duration of the fade in seconds
_this select 3 (Optional): NUMBER - 1: blur while fading, 0: don't use blur
_this select 4 (Optional): STRING - String of the music track you wish to play (will only work with fading in)
_this select 5 (Optional): STRING - Ending you wish to use (will only work with fading out)
_this select 6 (Optional): NUMBER - Use 0: failMission, 1: endMission


Returns:
|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=
Nothing.
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|p5= music: [[String]] - (Optional, default "") '''only for fade-out''' music class name defined in [[Description.ext#CfgMusic|CfgMusic]] |Parameter 5=
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_fadeEffect]]; --> |= Syntax
|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=


|p1= |= Parameter 1
|p7= success: [[Number]] - (Optional, default 1) '''if ''ending'' != ""''' 1 to end mission with success, 0 to fail mission


| |= Return value
| [[Nothing]] |Return value=
____________________________________________________________________________________________
____________________________________________________________________________________________


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


| |= See also
| [[endMission]], [[failMission]], [[BIS_fnc_endMission]], [[BIS_fnc_endMissionServer]], [[titleCut]] |See also=
 
}}
}}


Line 51: Line 45:


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Functions|{{uc:fadeEffect}}]]
[[Category:Function Group: Misc|{{uc:fadeEffect}}]]
[[Category:Function Group: Misc|{{uc:fadeEffect}}]]
[[Category:Functions|{{uc:fadeEffect}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:fadeEffect}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:fadeEffect}}]]

Revision as of 10:59, 6 June 2018

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 aren't defined or set to nil.
Execution:
call
Groups:
Uncategorised

Syntax

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

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_fadeEffect&oldid=108099"