setTitleEffect: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]OFP[ _]Elite *(\|.*)?\]\]" to "{{GameCategory|ofpe|Scripting Commands}}")
mNo edit summary
 
(33 intermediate revisions by 4 users not shown)
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"
 
* "OBJECT" - ''text'' defines the shown object , a subclass of {{hl|CfgTitles}} (see [[cutObj]])
|x1= <pre>_trigger setTitleEffect ["TEXT", "PLAIN DOWN", "Hello world."]</pre> |EXAMPLE1=
* "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]]


<h3 style="display:none">Notes</h3>
|r1= [[Nothing]]
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x1= <sqf>_trigger setTitleEffect ["TEXT", "PLAIN DOWN", "Hello world."];</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[createTrigger]] [[setSoundEffect]] [[setMusicEffect]]
[[Category:Scripting Commands|SETTITLEEFFECT]]
}}
{{GameCategory|ofpe|Scripting Commands}}
{{GameCategory|arma1|Scripting Commands}}
[[Category:Command_Group:_Interaction|{{uc:{{PAGENAME}}}}]]
{{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"