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
-| arma1 |Game name=
+|game1= ofpe
+|version1= 1.00
-|1.00|Game version=
+|game2= arma1
+|version2= 1.00
-|gr1= Triggers |GROUP1=
+|game3= arma2
+|version3= 1.00
-|gr2= Waypoints |GROUP2=
+|game4= arma2oa
+|version4= 1.50
-| Defines the title effect via [Type, Effect, Text] where
+|game5= tkoh
+|version5= 1.00
-'Type' can be
+|game6= arma3
-*"NONE",
+|version6= 0.50
-*"OBJECT",
-**'Text' defines the shown object , a subclass of CfgTitles.
-*"RES"
+|gr1= Triggers
-**'Text' defines a resource class, a subclass of RscTitles.
-*"TEXT"
-**The 'Text' is shown as text itself. 'Effect' defines a subtype: "PLAIN", "PLAIN DOWN", "BLACK", "BLACK FADED", "BLACK OUT", "BLACK IN", "WHITE OUT" or "WHITE IN".  |DESCRIPTION=
-| trigger '''setTitleEffect''' [type, effect, text] |SYNTAX=
+|gr2= Waypoints
-|p1= trigger: [[Object]] |PARAMETER1=
+|descr= Defines the title effect to show on activation via [Type, Effect, Text] where
-|p2= [type, effect, text]: [[Array]] of strings. See above  |PARAMETER2=
+'Type'
-| [[Nothing]] |RETURNVALUE=
+The title effect does not disappear on deactivation, this should be done manually if required.
-|s2= waypoint '''setTitleEffect''' [type, effect, text] |SYNTAX2=
-|p21= waypoint: [[Array]] - format [[Waypoint]] |PARAMETER21=
+|s1= triggerOrWaypoint [[setTitleEffect]] [type, effect, text]
-|p22= [type, effect, text]: [[Array]] of strings. See above  |PARAMETER22=
+|p1= triggerOrWaypoint: [[Object]] or [[Array]] format [[Waypoint]]
-|r2= [[Nothing]] |RETURNVALUE2=
+|p2= type: [[String]] Enum - defines [[Title Effect Type]] when not NONE, can be one of:
+* "NONE"
-|x1= <pre>_trigger setTitleEffect ["TEXT", "PLAIN DOWN", "Hello world."]</pre> |EXAMPLE1=
+* "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]])
-| [[createTrigger]] |SEEALSO=
+|p3= effect: [[String]]
-}}
+|p4= text: [[String]]
+|r1= [[Nothing]]
-<h3 style="display:none">Bottom Section</h3>
+|x1= <sqf>_trigger setTitleEffect ["TEXT", "PLAIN DOWN", "Hello world."];</sqf>
-[[Category:Scripting Commands|SETTITLEEFFECT]]
-{{GameCategory|ofpe|Scripting Commands}}
-{{GameCategory|arma1|Scripting Commands}}
-{{GameCategory|arma2|Scripting Commands}}
+|seealso= [[createTrigger]] [[setSoundEffect]] [[setMusicEffect]]
-{{GameCategory|arma3|Scripting Commands}}
+}}
-{{GameCategory|tkoh|Scripting Commands}}