allCutLayers: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\{\{GameCategory\|(arma[0123])\|New[ _]Scripting[ _]Commands[ _]List\}\}" to "{{GameCategory|$1|New Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Command|Comments=
{{Command|Comments=
____________________________________________________________________________________________


| arma3 |Game name=
| arma3 |Game name=
Line 7: Line 6:


|gr1= GUI Control |GROUP1=
|gr1= GUI Control |GROUP1=
____________________________________________________________________________________________


| 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=
| 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=
____________________________________________________________________________________________


| '''allCutLayers'''|SYNTAX=
| '''allCutLayers'''|SYNTAX=


| [[Array]] - array of [[Strings]]|RETURNVALUE=
| [[Array]] - array of [[Strings]]|RETURNVALUE=
____________________________________________________________________________________________
   
   
|x1= <code>_allLayers = [[allCutLayers]];</code> |EXAMPLE1=
|x1= <code>_allLayers = [[allCutLayers]];</code> |EXAMPLE1=
____________________________________________________________________________________________


| [[cutRsc]], [[cutText]], [[cutObj]], [[cutFadeOut]], [[allActiveTitleEffects]] |SEEALSO=
| [[cutRsc]], [[cutText]], [[cutObj]], [[cutFadeOut]], [[allActiveTitleEffects]] |SEEALSO=

Revision as of 01:11, 17 January 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 = "myLayerName" cutFadeOut 0;.

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 "".
Groups:
GUI Control

Syntax

Syntax:
allCutLayers
Return Value:
Array - array of Strings

Examples

Example 1:
_allLayers = allCutLayers;

Additional Information

See also:
cutRsccutTextcutObjcutFadeOutallActiveTitleEffects

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