allCutLayers: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
m (Text replacement - " (\|[pr][0-9]+ *= *[^-]+) *- *A([a-z])" to " $1 - a$2")
Line 12: Line 12:
|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 <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|""}}.
|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 <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|""}}.


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

Revision as of 13:39, 8 November 2023

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