setTitleEffect: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|x([0-9])= <sqf>([^\/: ]+)([^;])<\/sqf>" to "|x$1= <sqf>$2$3;</sqf>")
m (Some wiki formatting)
 
Line 25: Line 25:
|descr= Defines the title effect to show on activation via [Type, Effect, Text] where
|descr= Defines the title effect to show on activation via [Type, Effect, Text] where


'Type' can be
'Type'  
*"NONE"
*"OBJECT"
**'Text' defines the shown object , a subclass of CfgTitles (see [[cutObj]])
**'Effect' defines [[Title Effect Type]]
*"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]]


The title effect does not disappear on deactivation, this should be done manually if required.
The title effect does not disappear on deactivation, this should be done manually if required.


|s1= trigger [[setTitleEffect]] [type, effect, text]
|s1= triggerOrWaypoint [[setTitleEffect]] [type, effect, text]


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


|p2= [type, effect, text]: [[Array]] of [[String]] - See above
|p2= type: [[String]] - can be one of:
* "NONE"
* "OBJECT"
** ''text'' defines the shown object , a subclass of {{hl|CfgTitles}} (see [[cutObj]])
** ''effect'' defines [[Title Effect Type]]
* "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= type: [[String]]
|p3= effect: [[String]]


|p4= effect: [[String]]
|p4= text: [[String]]
 
|p5= text: [[String]]


|r1= [[Nothing]]
|r1= [[Nothing]]
|s2= waypoint [[setTitleEffect]] [type, effect, text]
|p21= waypoint: [[Array]] - format [[Waypoint]]
|p22= [type, effect, text]: [[Array]] of strings. See above
|r2= [[Nothing]]


|x1= <sqf>_trigger setTitleEffect ["TEXT", "PLAIN DOWN", "Hello world."];</sqf>
|x1= <sqf>_trigger setTitleEffect ["TEXT", "PLAIN DOWN", "Hello world."];</sqf>

Latest revision as of 16:53, 15 August 2022

ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.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:
TriggersWaypoints

Syntax

Syntax:
triggerOrWaypoint setTitleEffect [type, effect, text]
Parameters:
triggerOrWaypoint: Object or Array format Waypoint
type: String - can be one of:
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
Retrieved from "https://community.bistudio.com/wiki?title=setTitleEffect&oldid=330029"