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: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-| arma |= Game name
+|game1= ofpe
+|version1= 1.00
-|1.00|= Game version
+|game2= arma1
-____________________________________________________________________________________________
+|version2= 1.00
-| 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. |= Description
+|game3= arma2
-____________________________________________________________________________________________
+|version3= 1.00
-| trigger or waypoint '''setTitleEffect''' [type, effect, text] |= Syntax
+|game4= arma2oa
+|version4= 1.50
-|p1= trigger or waypoint: [[Object]] |= Parameter 1
+|game5= tkoh
+|version5= 1.00
-|p2= [type, effect, text]: [[Array]] |= Parameter 2
+|game6= arma3
+|version6= 0.50
-| [[Nothing]] |= Return value
+|gr1= Triggers
-____________________________________________________________________________________________
-|x1= <pre>trigger setTitleEffect ["TEXT", "PLAIN DOWN", "Hello world."]</pre> |= Example 1
-____________________________________________________________________________________________
-|  |= See also
+|gr2= Waypoints
-}}
+|descr= 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.
+|s1= triggerOrWaypoint [[setTitleEffect]] [type, effect, text]
+|p1= triggerOrWaypoint: [[Object]] or [[Array]] format [[Waypoint]]
+|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]])
+|p3= effect: [[String]]
+|p4= text: [[String]]
-<h3 style="display:none">Notes</h3>
+|r1= [[Nothing]]
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
+|x1= <sqf>_trigger setTitleEffect ["TEXT", "PLAIN DOWN", "Hello world."];</sqf>
-</dl>
-<h3 style="display:none">Bottom Section</h3>
+|seealso= [[createTrigger]] [[setSoundEffect]] [[setMusicEffect]]
-[[Category:Scripting Commands|SETTITLEEFFECT]]
+}}
-[[Category:Scripting Commands OFP Elite |SETTITLEEFFECT]]
-[[Category:Scripting Commands ArmA|SETTITLEEFFECT]]