allCutLayers: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <dl class="command_description"> </dl>" to "")
(formatting)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma3
|game1= arma3


|1.58
|version1= 1.58


|gr1= GUI Control
|gr1= GUI Control


| 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 "".
|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: <br>{{ic|_layerNum <nowiki>=</nowiki> "TAG_myLayerName" [[cutFadeOut]] 0;}}.


| '''allCutLayers'''
|s1= '''allCutLayers'''


| [[Array]] - array of [[Strings]]
|r1= [[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 {{ic|[""]}}, because 0 layer is reserved for usage in cut commands without layer param or when name of the layer given is empty {{ic|""}}.
   
   
|x1= <code>_allLayers = [[allCutLayers]];</code>
|x1= <code>[[private]] _allLayers = [[allCutLayers]];</code>


|seealso= [[cutRsc]], [[cutText]], [[cutObj]], [[cutFadeOut]], [[allActiveTitleEffects]]
|seealso= [[cutRsc]] [[cutText]] [[cutObj]] [[cutFadeOut]] [[allActiveTitleEffects]]
}}
}}

Revision as of 02:21, 5 March 2021

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:
_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 0 layer is reserved for usage in cut commands without layer param or when name of the layer given is empty "".

Examples

Example 1:
private _allLayers = allCutLayers;

Additional Information

See also:
cutRsc cutText cutObj cutFadeOut allActiveTitleEffects

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