allActiveTitleEffects: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \{\{GameCategory *\| *arma3 *\| *(New )?Scripting Commands\}\}" to "")
m (Text replacement - "\| *\[\[([a-zA-Z0-9_]+)\]\] * \|r1=" to "|s1= $1 |r1=")
Line 9: Line 9:
| 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.{{Feature | Informative | 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.}}
| 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.{{Feature | Informative | 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.}}


| [[allActiveTitleEffects]]
|s1= [[allActiveTitleEffects]]


|r1=[[Array]] of [[Number]]s, where each number represents index of currently active effect layer.
|r1=[[Array]] of [[Number]]s, where each number represents index of currently active effect layer.

Revision as of 16:49, 13 June 2021

Hover & click on the images for description

Description

Description:
Description needed
Groups:
GUI Control

Syntax

Syntax:
allActiveTitleEffects
Return Value:
Array of Numbers, where each number represents index 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]

Additional Information

See also:
allCutLayerscutTextcutRsccutObjcutFadeOuttitleTexttitleRsctitleObjtitleFadeOutTitle Effect Type

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