activeTitleEffectParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
m (Text replacement - "\|branch= *dev " to "")
 
(One intermediate revision by the same user not shown)
Line 4: Line 4:
|version1= 2.10
|version1= 2.10


|branch= dev


|gr1= GUI Control
|gr1= GUI Control
Line 15: Line 14:


|r1= [[Array]] in format [type, effect, speed, showInMap] or [], 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
* speed: [[Number]] - effect speed multiplier
* showInMap: [[Boolean]] - [[true]] if effect is available over map
* showInMap: [[Boolean]] - [[true]] if effect is available over map

Latest revision as of 14:23, 23 August 2022

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:

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