allActiveTitleEffects: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\{\{GameCategory\|(arma[0123])\|New[ _]Scripting[ _]Commands[ _]List\}\}" to "{{GameCategory|$1|New Scripting Commands}}") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Command|Comments= | {{Command|Comments= | ||
| arma3 |Game name= | | arma3 |Game name= | ||
| Line 7: | Line 6: | ||
|gr1= GUI Control |GROUP1= | |gr1= GUI Control |GROUP1= | ||
| 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.}} |DESCRIPTION= | {{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.}} |DESCRIPTION= | ||
| [[allActiveTitleEffects]] |SYNTAX= | | [[allActiveTitleEffects]] |SYNTAX= | ||
| [[Array]] of [[Number]]s, where each number represents index of currently active effect layer. |RETURNVALUE= | | [[Array]] of [[Number]]s, where each number represents index of currently active effect layer. |RETURNVALUE= | ||
|x1= <code>[[cutText]] ["Hello World!" ,"PLAIN", 2]; | |x1= <code>[[cutText]] ["Hello World!" ,"PLAIN", 2]; | ||
| Line 27: | Line 23: | ||
[[titleText]] ["Hello World!", "PLAIN", 2]; | [[titleText]] ["Hello World!", "PLAIN", 2]; | ||
[[hint]] [[str]] [[allActiveTitleEffects]]; // [-1, 0]</code> |EXAMPLE3= | [[hint]] [[str]] [[allActiveTitleEffects]]; // [-1, 0]</code> |EXAMPLE3= | ||
| [[allCutLayers]], [[cutText]], [[cutRsc]], [[cutObj]], [[cutFadeOut]], [[titleText]], [[titleRsc]], [[titleObj]], [[titleFadeOut]], [[Title Effect Type]]|SEEALSO= | | [[allCutLayers]], [[cutText]], [[cutRsc]], [[cutObj]], [[cutFadeOut]], [[titleText]], [[titleRsc]], [[titleObj]], [[titleFadeOut]], [[Title Effect Type]]|SEEALSO= | ||
Revision as of 00:11, 17 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