cutFadeOut: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (new command needs populating.)
 
m (Text replacement - "<sqf>([^↵][^>]*↵[^>]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(79 intermediate revisions by 11 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma |= Game name
|game1= arma1
|version1= 1.05


|1.05|= Game version
|game2= arma2
____________________________________________________________________________________________
|version2= 1.00


| Added 1.05 Needs populating. |= Description
|game3= arma2oa
____________________________________________________________________________________________
|version3= 1.55


| '''cutFadeOut'''|= Syntax
|game4= tkoh
|version4= 1.00


|p1= |= Parameter 1
|game5= arma3
|version5= 0.50


| |= Return value
|gr1= GUI Control
____________________________________________________________________________________________
 
|x1=  |= Example 1
____________________________________________________________________________________________


| |= See also
|descr= Terminates the effect in the given layer by fading it out according to the given duration. If named layer is used and it doesn't exist, it will be allocated. For title layer see [[titleFadeOut]].
{{Feature|arma3|For greater efficiency and ease of moddability, it is recommended to use named layers.}}


|s1= layer [[cutFadeOut]]  duration
|p1= layer: [[Number]]
|p2= duration: [[Number]]
|r1= [[Nothing]]
|s2= layerName [[cutFadeOut]]  duration
|s2since= arma3 1.58
|p21= layerName: [[String]] - effect layer name. Layer names are CaSe SeNsItIvE
|p22= duration: [[Number]] - fade out time
|r2= [[Number]] - number of the corresponding layer
|x1= <sqf>0 cutFadeOut 2;</sqf>
|x2= <sqf>private _layer = "layer1" cutFadeOut 2;</sqf>
|seealso= [[allCutLayers]] [[cutText]] [[cutRsc]] [[cutObj]] [[allActiveTitleEffects]] [[activeTitleEffectParams]]
}}
}}


<h3 style="display:none">Notes</h3>
<dl class="command_description">
<dl class="command_description">


<!-- Note Section BEGIN -->
<dt></dt>
<dd class="notedate">Posted on 2016-07-09 - 11:30 (UTC)</dd>
<dt class="note">[[User:Krzmbrzl00|Krzmbrzl00]]</dt>
<dd class="note">
{{GVI|arma3|1.60}} The actual fadeOut-duration can be dependent on the duration for the fadeIn (e.g. specified by [[cutText]]). If the fadeIn-duration is set to a value less than 1 the fadeOut-duration will be the given number multiplied by the fadeIn-duration.
<sqf>
"test" cutText ["", "BLACK", 0.5, true]; // fadein is < 0
"test" cutFadeOut 2; // The actual fadeout-time is 2 * 0.5 = 1
</sqf>
</dd>


<!-- Note Section END -->
</dl>
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA|{{uc:{{PAGENAME}}}}]]

Latest revision as of 19:46, 3 September 2024

Logo A1 black.png1.05Logo A2.png1.00A2 OA Logo.png1.55tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Terminates the effect in the given layer by fading it out according to the given duration. If named layer is used and it doesn't exist, it will be allocated. For title layer see titleFadeOut.
Arma 3
For greater efficiency and ease of moddability, it is recommended to use named layers.
Groups:
GUI Control

Syntax

Syntax:
layer cutFadeOut duration
Parameters:
layer: Number
duration: Number
Return Value:
Nothing

Alternative Syntax

Syntax:
layerName cutFadeOut duration
Parameters:
layerName: String - effect layer name. Layer names are CaSe SeNsItIvE
duration: Number - fade out time
Return Value:
Number - number of the corresponding layer

Examples

Example 1:
0 cutFadeOut 2;
Example 2:
private _layer = "layer1" cutFadeOut 2;

Additional Information

See also:
allCutLayers cutText cutRsc cutObj allActiveTitleEffects activeTitleEffectParams

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
Posted on 2016-07-09 - 11:30 (UTC)
Krzmbrzl00
Arma 3 logo black.png1.60 The actual fadeOut-duration can be dependent on the duration for the fadeIn (e.g. specified by cutText). If the fadeIn-duration is set to a value less than 1 the fadeOut-duration will be the given number multiplied by the fadeIn-duration.
"test" cutText ["", "BLACK", 0.5, true]; // fadein is < 0 "test" cutFadeOut 2; // The actual fadeout-time is 2 * 0.5 = 1
Retrieved from "https://community.bistudio.com/wiki?title=cutFadeOut&oldid=369415"