setTitleEffect: Difference between revisions

Latest revision as of 22:08, 26 September 2024

1.00

1.50

1.00

0.50

Hover & click on the images for description

Description

Description:: Defines the title effect to show on activation via [Type, Effect, Text] where 'Type' The title effect does not disappear on deactivation, this should be done manually if required.
Groups:: Triggers Waypoints

Syntax

Syntax:

triggerOrWaypoint setTitleEffect [type, effect, text]

Parameters:

triggerOrWaypoint: Object or Array format Waypoint

type: String Enum - defines Title Effect Type when not NONE, can be one of:

"NONE"
"OBJECT" - text defines the shown object , a subclass of CfgTitles (see cutObj)
"RES" - text defines a resource class, a subclass of RscTitles (see cutRsc)
"TEXT" - text defines text string to show (see cutText)

effect: String

text: String

Return Value:

Nothing

Examples

Example 1:: _trigger setTitleEffect ["TEXT", "PLAIN DOWN", "Hello world."];

Additional Information

See also:: createTrigger setSoundEffect setMusicEffect

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 1: / Line 1: @@
-[[Category:Scripting Commands|SETTITLEEFFECT]]
+{{RV|type=command
-[[Category:Scripting Commands OFP Elite |SETTITLEEFFECT]]
-[[Category:Scripting Commands ArmA|SETTITLEEFFECT]]
+|game1= ofpe
+|version1= 1.00
-<h2 style="color:#000066">'''''trigger or waypoint'' setTitleEffect ''[type, effect, text]'''''</h2>
+|game2= arma1
+|version2= 1.00
+|game3= arma2
+|version3= 1.00
-'''Operand types:'''
+|game4= arma2oa
+|version4= 1.50
-'''trigger or waypoint:''' [[Object]] or [[Array]]
+|game5= tkoh
+|version5= 1.00
-'''[type, effect, text]:''' [[Array]]
+|game6= arma3
+|version6= 0.50
-'''Type of returned value:'''
+|gr1= Triggers
-[[Nothing]]
+|gr2= Waypoints
-'''Compatibility:'''
+|descr= Defines the title effect to show on activation via [Type, Effect, Text] where
-Version 1.86 required.
+'Type'
-'''Description:'''
+The title effect does not disappear on deactivation, this should be done manually if required.
-Defines the title effect. Type can be "NONE", "OBJECT", "RES" or "TEXT". For "TEXT", the effect defines a subtype: "PLAIN", "PLAIN DOWN", "BLACK", "BLACK FADED", "BLACK OUT", "BLACK IN", "WHITE OUT" or "WHITE IN". Text is shown as text itself. For "OBJECT", text defines the shown object, a subclass of CfgTitles. For "RES", text defines a resource class, a subclass of RscTitles.
+|s1= triggerOrWaypoint [[setTitleEffect]] [type, effect, text]
+|p1= triggerOrWaypoint: [[Object]] or [[Array]] format [[Waypoint]]
-'''Example:'''
+|p2= type: [[String]] Enum - defines [[Title Effect Type]] when not NONE, can be one of:
+* "NONE"
+* "OBJECT" - ''text'' defines the shown object , a subclass of {{hl|CfgTitles}} (see [[cutObj]])
+* "RES" - ''text'' defines a resource class, a subclass of RscTitles (see [[cutRsc]])
+* "TEXT" - ''text'' defines text string to show (see [[cutText]])
-trigger '''setTitleEffect''' ["TEXT", "PLAIN DOWN", "Hello world."]
+|p3= effect: [[String]]
+|p4= text: [[String]]
+|r1= [[Nothing]]
+|x1= <sqf>_trigger setTitleEffect ["TEXT", "PLAIN DOWN", "Hello world."];</sqf>
+|seealso= [[createTrigger]] [[setSoundEffect]] [[setMusicEffect]]
+}}