setTitleEffect: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
mNo edit summary
 
Line 33: Line 33:
|p1= triggerOrWaypoint: [[Object]] or [[Array]] format [[Waypoint]]
|p1= triggerOrWaypoint: [[Object]] or [[Array]] format [[Waypoint]]


|p2= type: [[String]] - can be one of:
|p2= type: [[String]] Enum - defines [[Title Effect Type]] when not NONE, can be one of:
* "NONE"
* "NONE"
* "OBJECT"
* "OBJECT" - ''text'' defines the shown object , a subclass of {{hl|CfgTitles}} (see [[cutObj]])
** ''text'' defines the shown object , a subclass of {{hl|CfgTitles}} (see [[cutObj]])
* "RES" - ''text'' defines a resource class, a subclass of RscTitles (see [[cutRsc]])
** ''effect'' defines [[Title Effect Type]]
* "TEXT" - ''text'' defines text string to show (see [[cutText]])
* "RES"
** ''text'' defines a resource class, a subclass of RscTitles (see [[cutRsc]])
** ''effect'' defines [[Title Effect Type]]
* "TEXT"
** ''text'' defines text string to show (see [[cutText]])
** ''effect'' defines [[Title Effect Type]]


|p3= effect: [[String]]
|p3= effect: [[String]]

Latest revision as of 22:08, 26 September 2024

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