cutFadeOut: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "\[\[Category\: ?Command[ _]Group\:.*\|\{\{uc\:\{\{PAGENAME\}\}\}\}\]\] " to "") |
Lou Montana (talk | contribs) m (Add since template usage) |
||
| Line 9: | Line 9: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| 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. | | 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 | {{Feature arma3|For greater efficiency and ease of moddability, it is recommended to use named layers.}} |DESCRIPTION= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| layer '''cutFadeOut''' duration|SYNTAX= | | layer '''cutFadeOut''' duration |SYNTAX= | ||
|p1= layer: [[Number]]|PARAMETER1= | |p1= layer: [[Number]]|PARAMETER1= | ||
| Line 20: | Line 20: | ||
| [[Nothing]] |RETURNVALUE= | | [[Nothing]] |RETURNVALUE= | ||
____________________________________________________________________________________________ | |||
|s2= layerName '''cutFadeOut''' duration | |s2= layerName '''cutFadeOut''' duration {{since|arma3|1.57.134673|y}} |SYNTAX2= | ||
|p21= layerName: [[String]] - effect layer name. Layer names are CaSe SeNsItIvE|PARAMETER21= | |p21= layerName: [[String]] - effect layer name. Layer names are CaSe SeNsItIvE |PARAMETER21= | ||
|p22= duration: [[Number]] - fade out time|PARAMETER22= | |p22= duration: [[Number]] - fade out time |PARAMETER22= | ||
|r2= [[Number]] - number of the corresponding layer |RETURNVALUE2= | |r2= [[Number]] - number of the corresponding layer |RETURNVALUE2= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code>0 [[cutFadeOut]] 2;</code> |EXAMPLE1= | |x1= <code>0 [[cutFadeOut]] 2;</code> |EXAMPLE1= | ||
| Line 36: | Line 37: | ||
| [[allCutLayers]], [[cutText]], [[cutRsc]], [[cutObj]], [[allActiveTitleEffects]] |SEEALSO= | | [[allCutLayers]], [[cutText]], [[cutRsc]], [[cutObj]], [[allActiveTitleEffects]] |SEEALSO= | ||
}} | }} | ||
<h3 style="display:none">Notes</h3> | <h3 style="display:none">Notes</h3> | ||
<dl class="command_description"> | <dl class="command_description"> | ||
<!-- Note Section BEGIN --> | <!-- Note Section BEGIN --> | ||
| Line 48: | Line 47: | ||
<h3 style="display:none">Bottom Section</h3> | <h3 style="display:none">Bottom Section</h3> | ||
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | ||
| Line 61: | Line 57: | ||
<dd class="note"> | <dd class="note"> | ||
(ArmA v1.60)<br> | (ArmA v1.60)<br> | ||
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. | 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. | ||
< | <code>"test" cutText ["", "BLACK", 0.5, true]; {{cc|fadein is < 0}} | ||
"test" cutFadeout 2; | "test" cutFadeout 2; {{cc|The actual fadeout-time is 2 * 0.5 = 1}} | ||
</ | </code> | ||
</dd> | </dd> | ||
</dl> | </dl> | ||
<!-- DISCONTINUE Notes --> | <!-- DISCONTINUE Notes --> | ||
Revision as of 23:52, 23 December 2020
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.
For greater efficiency and ease of moddability, it is recommended to use named layers. - Groups:
- GUI Control
Syntax
Alternative Syntax
- Syntax:
- layerName cutFadeOut duration Template:since
- 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
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; // -no comment defined-