allCutLayers: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Bot: Replacing category Scripting Commands Arma 3 with Arma 3: Scripting Commands)
m (Text replacement - "Strings" to "Strings")
 
(33 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 1.58


|1.58|= Game version
|gr1= GUI Control


____________________________________________________________________________________________
|descr= Returns all named layers used by [[cutRsc]], [[cutText]], [[cutObj]] or [[cutFadeOut]].
The layer normally would be added on the first use of any of the aforementioned commands, however if a layer needs to be reserved it could be done like so:
<sqf>private _layerNum = "TAG_myLayerName" cutFadeOut 0;</sqf>


| Returns all named layers used by [[cutRsc]], [[cutText]], [[cutObj]] or [[cutFadeOut]]. The layer normally would be added on the first use of any of the aforementioned commands, however if a layer needs to be reserved it could be done like so: <br><tt>_layerNum <nowiki>=</nowiki> "myLayerName" [[cutFadeOut]] 0;</tt>.<br><br> The index of the layer name in the array corresponds to the layer number the cut effect will be displayed on. If no layers were defined, the return is [""], because 0 layer is reserved for usage in cut commands without layer param or when name of the layer given is empty "". |= Description
|s1= [[allCutLayers]]
____________________________________________________________________________________________


| '''allCutLayers'''|= Syntax
|r1= [[Array]] - array of [[String]]s: The index of the layer name in the array corresponds to the layer number the cut effect will be displayed on. If no layers were defined, the return is <sqf inline>[""]</sqf>, because layer 0 is reserved for usage in cut commands without layer param or when the provided layer name is empty {{hl|""}}.


| [[Array]] - array of [[Strings]]|= Return value
|x1= <sqf>private _allLayers = allCutLayers;</sqf>
____________________________________________________________________________________________
 
|x1= <code>_allLayers = [[allCutLayers]];</code> |= Example 1
____________________________________________________________________________________________
 
| [[cutRsc]], [[cutText]], [[cutObj]], [[cutFadeOut]] |= See also


|seealso= [[cutRsc]] [[cutText]] [[cutObj]] [[cutFadeOut]] [[allActiveTitleEffects]] [[activeTitleEffectParams]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Arma 3: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Arma 3: Scripting Commands]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 21:51, 16 February 2024

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

Description

Description:
Returns all named layers used by cutRsc, cutText, cutObj or cutFadeOut. The layer normally would be added on the first use of any of the aforementioned commands, however if a layer needs to be reserved it could be done like so:
private _layerNum = "TAG_myLayerName" cutFadeOut 0;
Groups:
GUI Control

Syntax

Syntax:
allCutLayers
Return Value:
Array - array of Strings: The index of the layer name in the array corresponds to the layer number the cut effect will be displayed on. If no layers were defined, the return is [""], because layer 0 is reserved for usage in cut commands without layer param or when the provided layer name is empty "".

Examples

Example 1:
private _allLayers = allCutLayers;

Additional Information

See also:
cutRsc cutText cutObj cutFadeOut 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
Retrieved from "https://community.bistudio.com/wiki?title=allCutLayers&oldid=352623"