setTitleEffect: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " +" to " ")
mNo edit summary
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma1
|game1= ofpe
|version1= 1.00


|1.00
|game2= arma1
|version2= 1.00
 
|game3= arma2
|version3= 1.00
 
|game4= arma2oa
|version4= 1.50
 
|game5= tkoh
|version5= 1.00
 
|game6= arma3
|version6= 0.50


|gr1= Triggers
|gr1= Triggers
Line 9: Line 23:
|gr2= Waypoints
|gr2= Waypoints


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


| 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 strings. See above
|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]])


| [[Nothing]]
|p3= effect: [[String]]
|s2= waypoint '''setTitleEffect''' [type, effect, text]


|p21= waypoint: [[Array]] - format [[Waypoint]]
|p4= text: [[String]]


|p22= [type, effect, text]: [[Array]] of strings. See above
|r1= [[Nothing]]


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


|x1= <code>_trigger [[setTitleEffect]] ["TEXT", "PLAIN DOWN", "Hello world."]</code>
|seealso= [[createTrigger]] [[setSoundEffect]] [[setMusicEffect]]
 
|seealso= [[createTrigger]], [[setSoundEffect]], [[setMusicEffect]]
}}
}}
{{GameCategory|ofpe|Scripting Commands}}
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 22:08, 26 September 2024

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 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
Retrieved from "https://community.bistudio.com/wiki?title=setTitleEffect&oldid=369615"