Difference between revisions of "allActiveTitleEffects"

From Bohemia Interactive Community
Jump to navigation Jump to search
m
m (Fixed the code for all of the examples)
Line 16: Line 16:
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
 
   
 
   
|x1= <code>[[cutText]] ["Hello World!" ,"PLAIN", 2]];
+
|x1= <code>[[cutText]] ["Hello World!" ,"PLAIN", 2];
 
[[hint]] [[str]] [[allActiveTitleEffects]]; // [0]</code> |EXAMPLE1=
 
[[hint]] [[str]] [[allActiveTitleEffects]]; // [0]</code> |EXAMPLE1=
  
|x2= <code>21 [[cutText]] ["Hello World!", "PLAIN", 2]];
+
|x2= <code>21 [[cutText]] ["Hello World!", "PLAIN", 2];
 
[[hint]] [[str]] [[allActiveTitleEffects]]; // [21]</code> |EXAMPLE2=
 
[[hint]] [[str]] [[allActiveTitleEffects]]; // [21]</code> |EXAMPLE2=
  
|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> |EXAMPLE3=
 
[[hint]] [[str]] [[allActiveTitleEffects]]; // [-1, 0]</code> |EXAMPLE3=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________

Revision as of 15:23, 13 March 2020

-wrong parameter ("arma3dev") defined!-[[:Category:Introduced with arma3dev version 1.97|1.97]]
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:
Uncategorised

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

[[Category:Introduced with arma3dev version 1.97]][[ Category: arma3dev: New Scripting Commands | ALLACTIVETITLEEFFECTS]][[ Category: arma3dev: Scripting Commands | ALLACTIVETITLEEFFECTS]]