allActiveTitleEffects: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "| arma3dev |Game name= |1.97|Game version=" to "| arma3 |Game name= |1.98|Game version=")
m (Text replacement - "<sqf>([^↵][^<]*↵[^<]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(37 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.98


|1.98|Game version=
|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>
|descr= 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.}}
{{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=
|s1= [[allActiveTitleEffects]]


| [[Array]] of [[Number]]s, where each number represents index of currently active effect layer. |RETURNVALUE=
|r1= [[Array]] of [[Number]]s, where each number represents index of currently active effect layer.
____________________________________________________________________________________________
 
|x1= <code>[[cutText]] ["Hello World!" ,"PLAIN", 2];
[[hint]] [[str]] [[allActiveTitleEffects]]; // [0]</code> |EXAMPLE1=


|x2= <code>21 [[cutText]] ["Hello World!", "PLAIN", 2];
|x1= <sqf>
[[hint]] [[str]] [[allActiveTitleEffects]]; // [21]</code> |EXAMPLE2=
cutText ["Hello World!" ,"PLAIN", 2];
hint str allActiveTitleEffects; // [0]
</sqf>


|x3= <code>[[cutText]] ["Hello World!", "PLAIN", 2];
|x2= <sqf>
[[titleText]] ["Hello World!", "PLAIN", 2];
21 cutText ["Hello World!", "PLAIN", 2];
[[hint]] [[str]] [[allActiveTitleEffects]]; // [-1, 0]</code> |EXAMPLE3=
hint str allActiveTitleEffects; // [21]
____________________________________________________________________________________________
</sqf>


| [[allCutLayers]], [[cutText]], [[cutRsc]], [[cutObj]], [[cutFadeOut]], [[titleText]], [[titleRsc]], [[titleObj]], [[titleFadeOut]], [[Title Effect Type]]|SEEALSO=
|x3= <sqf>
cutText ["Hello World!", "PLAIN", 2];
titleText ["Hello World!", "PLAIN", 2];
hint str allActiveTitleEffects; // [-1, 0]
</sqf>


|seealso= [[allCutLayers]] [[cutText]] [[cutRsc]] [[cutObj]] [[cutFadeOut]] [[titleText]] [[titleRsc]] [[titleObj]] [[titleFadeOut]] [[activeTitleEffectParams]] [[Title Effect Type]]
}}
}}
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|ALLACTIVETITLEEFFECTS]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]

Latest revision as of 19:42, 3 September 2024

Arma 3 logo black.png1.98
Hover & click on the images for description

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.
ⓘ
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.
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:
allCutLayers cutText cutRsc cutObj cutFadeOut titleText titleRsc titleObj titleFadeOut activeTitleEffectParams Title 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
Retrieved from "https://community.bistudio.com/wiki?title=allActiveTitleEffects&oldid=369291"