Arma 3 Scripting

Command in GUI Control

allActiveTitleEffects

Also available as Markdown and JSON, or read the original wiki page.

Description

Returns a list of all layers that have currently active title effect. Numbers equal to or greater than 0 represent cut layers, where as -1 represents title layer (see Title Effect Type). Named layers are represented by their respective index.

Note

Effects created with titleText, titleRsc and titleObj commands do not have a numbered layer, so they are represented as -1 layer in the result. Effects created with cutText, cutRsc and cutObj are created either on layer 0, if no layer is specified, or on the given layer, if the layer index is specified, so they are represented by the layer index.

Syntax

allActiveTitleEffects

Returns: Array of Numbers - indexes of currently active effect layer

Examples

Example 1

cutText ["Hello World!" ,"PLAIN", 2];
hint str allActiveTitleEffects; // [0]

Example 2

21 cutText ["Hello World!", "PLAIN", 2];
hint str allActiveTitleEffects; // [21]

Example 3

cutText ["Hello World!", "PLAIN", 2];
titleText ["Hello World!", "PLAIN", 2];
hint str allActiveTitleEffects; // [-1, 0]

See also

allCutLayers · cutText · cutRsc · cutObj · cutFadeOut · titleText · titleRsc · titleObj · titleFadeOut · activeTitleEffectParams · Title Effect Type