allCutLayers: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<code>\[\[private\]\] _([a-zA-Z0-9_]+) = \[\[([a-zA-Z0-9]+)\]\];?<\/code>" to "<sqf>private _$1 = $2;</sqf>")
m (Some wiki formatting)
Line 7: Line 7:


|descr= Returns all named layers used by [[cutRsc]], [[cutText]], [[cutObj]] or [[cutFadeOut]].
|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;}}.
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>


|s1= [[allCutLayers]]  
|s1= [[allCutLayers]]


|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|""}}.
|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 {{hl|""}}.


|x1= <sqf>private _allLayers = allCutLayers;</sqf>
|x1= <sqf>private _allLayers = allCutLayers;</sqf>


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

Revision as of 12:44, 13 May 2022

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