activeTitleEffectParams: Difference between revisions

Latest revision as of 13:23, 23 August 2022

2.10

Hover & click on the images for description

Description

Description:: Returns type, effect, speed and map visibility of the given active title effect (see allActiveTitleEffects)
Groups:: GUI Control

Syntax

Syntax:

activeTitleEffectParams layer

Parameters:

layer: Number - layer number or -1 (see allActiveTitleEffects)

Return Value:

Array in format [type, effect, speed, showInMap] or [], where:

type: String - type of effect, can be "OBJ", "RSC" or "TXT"
effect: String - Title Effect Type ("PLAIN", "BLACK OUT" etc)
speed: Number - effect speed multiplier
showInMap: Boolean - true if effect is available over map

Examples

Example 1:: 21 cutText ["Hello World!", "PLAIN", 2]; hint str activeTitleEffectParams 21; // ["TXT", "PLAIN", 2, true]
Example 2:: titleText ["Hello World!", "BLACK"]; hint str activeTitleEffectParams -1; // ["TXT", "BLACK", 1, true]

Additional Information

See also:: allCutLayers cutText cutRsc cutObj cutFadeOut titleText titleRsc titleObj titleFadeOut allActiveTitleEffects 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

@@ Line 3: / Line 3: @@
 |game1= arma3
 |version1= 2.10
-|branch= dev
 |gr1= GUI Control
@@ Line 13: / Line 13: @@
 |p1 = layer: [[Number]] - layer number or -1 (see [[allActiveTitleEffects]])
-|r1= [[Array]] in format [type, effect, speed, showInMap], where:
+|r1= [[Array]] in format [type, effect, speed, showInMap] or [], where:
-* type: [[String]] - type of effect, could be <tt>"OBJ"</tt>, <tt>"RSC"</tt>, <tt>"TXT"</tt>
+* type: [[String]] - type of effect, can be {{hl|"OBJ"}}, {{hl|"RSC"}} or {{hl|"TXT"}}
-* effect: [[String]] - [[Title Effect Type]] (<tt>"PLAIN"</tt>, <tt>"BLACK OUT"</tt>...etc)
+* effect: [[String]] - [[Title Effect Type]] ({{hl|"PLAIN"}}, {{hl|"BLACK OUT"}} etc)
 * speed: [[Number]] - effect speed multiplier
 * showInMap: [[Boolean]] - [[true]] if effect is available over map
-|x1= <code>21 [[cutText]] ["Hello World!", "PLAIN", 2];
+|x1= <sqf>
-[[hint]] [[str]] [[activeTitleEffectParams]] 21; // ["TXT", "PLAIN", 2, true]</code>
+cutText ["Hello World!", "PLAIN", 2];
+hint str activeTitleEffectParams 21; // ["TXT", "PLAIN", 2, true]
+</sqf>
-|x2= <code>[[titleText]] ["Hello World!", "BLACK"];
+|x2= <sqf>
-[[hint]] [[str]] [[activeTitleEffectParams]] -1; // ["TXT", "BLACK", 1, true]</code>
+titleText ["Hello World!", "BLACK"];
+hint str activeTitleEffectParams -1; // ["TXT", "BLACK", 1, true]
+</sqf>
 |seealso= [[allCutLayers]] [[cutText]] [[cutRsc]] [[cutObj]] [[cutFadeOut]] [[titleText]] [[titleRsc]] [[titleObj]] [[titleFadeOut]] [[allActiveTitleEffects]] [[Title Effect Type]]
 }}