setTitleEffect: Difference between revisions

From Bohemia Interactive Community
m (Text replacement - "String Enum" to "String")
mNo edit summary
 
Line 31: Line 31:
|s1= triggerOrWaypoint [[setTitleEffect]] [type, effect, text]
|s1= triggerOrWaypoint [[setTitleEffect]] [type, effect, text]


|p1= triggerOrWaypoint: [[Object]] or [[Array]] format [[Waypoint]]
|p1= triggerOrWaypoint: [[Object]] or [[Waypoint]]


|p2= type: [[String]] - defines [[Title Effect Type]] when not NONE, can be one of:
|p2= type: [[String]] - defines [[Title Effect Type]] when not NONE, can be one of:

Latest revision as of 07:56, 2 January 2026

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:
TriggersWaypoints

Syntax

Syntax:
triggerOrWaypoint setTitleEffect [type, effect, text]
Parameters:
triggerOrWaypoint: Object or Waypoint
type: String - 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.
Only post proven facts here! Add Note