allActiveTitleEffects: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("serv...) |
||
| Line 1: | Line 1: | ||
{{Command | {{Command | ||
| arma3 | | arma3 | ||
|1.98 | |1.98 | ||
|gr1= GUI Control | |gr1= GUI Control | ||
| 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.<br><br> | | 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.<br><br> | ||
{{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.}} | {{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]] | | [[allActiveTitleEffects]] | ||
| [[Array]] of [[Number]]s, where each number represents index of currently active effect layer. | | [[Array]] of [[Number]]s, where each number represents index of currently active effect layer. | ||
|x1= <code>[[cutText]] ["Hello World!" ,"PLAIN", 2]; | |x1= <code>[[cutText]] ["Hello World!" ,"PLAIN", 2]; | ||
[[hint]] [[str]] [[allActiveTitleEffects]]; // [0]</code> | [[hint]] [[str]] [[allActiveTitleEffects]]; // [0]</code> | ||
|x2= <code>21 [[cutText]] ["Hello World!", "PLAIN", 2]; | |x2= <code>21 [[cutText]] ["Hello World!", "PLAIN", 2]; | ||
[[hint]] [[str]] [[allActiveTitleEffects]]; // [21]</code> | [[hint]] [[str]] [[allActiveTitleEffects]]; // [21]</code> | ||
|x3= <code>[[cutText]] ["Hello World!", "PLAIN", 2]; | |x3= <code>[[cutText]] ["Hello World!", "PLAIN", 2]; | ||
[[titleText]] ["Hello World!", "PLAIN", 2]; | [[titleText]] ["Hello World!", "PLAIN", 2]; | ||
[[hint]] [[str]] [[allActiveTitleEffects]]; // [-1, 0]</code> | [[hint]] [[str]] [[allActiveTitleEffects]]; // [-1, 0]</code> | ||
| [[allCutLayers]], [[cutText]], [[cutRsc]], [[cutObj]], [[cutFadeOut]], [[titleText]], [[titleRsc]], [[titleObj]], [[titleFadeOut]], [[Title Effect Type]] | | [[allCutLayers]], [[cutText]], [[cutRsc]], [[cutObj]], [[cutFadeOut]], [[titleText]], [[titleRsc]], [[titleObj]], [[titleFadeOut]], [[Title Effect Type]] | ||
}} | }} | ||
Revision as of 00:04, 18 January 2021
Description
- 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.
- 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