cutFadeOut: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (fixed description)
m (template:command argument fix)
Line 8: Line 8:


| Terminates the effect in the given layer by fading it out according to the given duration. If named layer used and it doesn't exist, it will be allocated.<br><br>
| Terminates the effect in the given layer by fading it out according to the given duration. If named layer used and it doesn't exist, it will be allocated.<br><br>
{{Feature arma3|For greater efficiency and ease of modability it is recommended to use named layers available with alternative syntax since Arma 3 v1.57.134673}}|= Description
{{Feature arma3|For greater efficiency and ease of modability it is recommended to use named layers available with alternative syntax since Arma 3 v1.57.134673}}|DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| layer '''cutFadeOut''' duration|= Syntax
| layer '''cutFadeOut''' duration|SYNTAX=


|p1= layer: [[Number]]|= Parameter 1
|p1= layer: [[Number]]|PARAMETER1=


|p2= duration: [[Number]]|= Parameter 2
|p2= duration: [[Number]]|PARAMETER2=


| [[Nothing]] |= Return value
| [[Nothing]] |RETURNVALUE=


|s2= layerName '''cutFadeOut''' duration  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(''Since Arma 3 v1.57.134673'')|= Syntax
|s2= layerName '''cutFadeOut''' duration  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(''Since Arma 3 v1.57.134673'')|SYNTAX=


|p21= layerName: [[String]] - effect layer name. Layer names are CaSe SeNsItIvE|= Parameter 1
|p21= layerName: [[String]] - effect layer name. Layer names are CaSe SeNsItIvE|PARAMETER1=


|p22= duration: [[Number]] - fade out time|= Parameter 2
|p22= duration: [[Number]] - fade out time|PARAMETER2=


|r2= [[Number]] - number of the corresponding layer |= Return value
|r2= [[Number]] - number of the corresponding layer |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <code>0 [[cutFadeOut]] 2;</code> |= Example 1
|x1= <code>0 [[cutFadeOut]] 2;</code> |EXAMPLE1=


|x2= <code>_layer = "layer1" [[cutFadeOut]] 2;</code> |= Example 1
|x2= <code>_layer = "layer1" [[cutFadeOut]] 2;</code> |EXAMPLE1=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[allCutLayers]], [[cutText]], [[cutRsc]], [[cutObj]] |= See also
| [[allCutLayers]], [[cutText]], [[cutRsc]], [[cutObj]] |SEEALSO=


}}
}}

Revision as of 15:37, 7 April 2019

-wrong parameter ("Arma") defined!-1.05
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 used and it doesn't exist, it will be allocated.

Arma 3
For greater efficiency and ease of modability it is recommended to use named layers available with alternative syntax since Arma 3 v1.57.134673
Groups:
Uncategorised

Syntax

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

Alternative Syntax

Syntax:
layerName cutFadeOut duration        (Since Arma 3 v1.57.134673)
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:
_layer = "layer1" cutFadeOut 2;

Additional Information

See also:
allCutLayerscutTextcutRsccutObj

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

Posted on July 9, 2016 - 11:30 (UTC)
Krzmbrzl00
(ArmA v1.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