titleObj: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<h3 style="display:none">Bottom Section</h3> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame( +[0-9])?|Game [Vv]ersion( +[0-9])?|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|MP[Aa]rg|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| ofp |Game name=
| ofp


|1.00|Game version=
|1.00


|gr1= GUI Control |GROUP1=
|gr1= GUI Control


| Shows object defined in global config in CfgTitles |DESCRIPTION=
| Shows object defined in global config in CfgTitles


| '''titleObj''' [class, type, speed, showInMap] |SYNTAX=
| '''titleObj''' [class, type, speed, showInMap]
|p1= [class, type, speed, showInMap]: [[Array]] |PARAMETER1=
|p1= [class, type, speed, showInMap]: [[Array]]
|p2= class: [[String]] - defined in <tt>[[configFile]] >> "CfgTitles" >> class</tt> |PARAMETER2=
|p2= class: [[String]] - defined in <tt>[[configFile]] >> "CfgTitles" >> class</tt>
|p3= type: [[String]] one of "PLAIN", "PLAIN DOWN", "BLACK", "BLACK FADED", "BLACK OUT", "BLACK IN", "WHITE OUT" and "WHITE IN". See [[Title Effect Type]]s for more information about these values.|PARAMETER3=
|p3= type: [[String]] one of "PLAIN", "PLAIN DOWN", "BLACK", "BLACK FADED", "BLACK OUT", "BLACK IN", "WHITE OUT" and "WHITE IN". See [[Title Effect Type]]s for more information about these values.
|p4= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1 |PARAMETER4=
|p4= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1
|p5= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]] |PARAMETER5=
|p5= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]]


| [[Nothing]] |RETURNVALUE=
| [[Nothing]]
   
   
|x1= <code>[[titleObj]] ["BISLogo", "PLAIN"]</code> |EXAMPLE1=
|x1= <code>[[titleObj]] ["BISLogo", "PLAIN"]</code>


| [[titleText]], [[titleRsc]], [[cutRsc]], [[cutObj]], [[cutText]], [[allActiveTitleEffects]] |SEEALSO=
| [[titleText]], [[titleRsc]], [[cutRsc]], [[cutObj]], [[cutText]], [[allActiveTitleEffects]]
}}
}}



Revision as of 11:25, 18 January 2021

Hover & click on the images for description

Description

Description:
Shows object defined in global config in CfgTitles
Groups:
GUI Control

Syntax

Syntax:
titleObj [class, type, speed, showInMap]
Parameters:
[class, type, speed, showInMap]: Array
class: String - defined in configFile >> "CfgTitles" >> class
type: String one of "PLAIN", "PLAIN DOWN", "BLACK", "BLACK FADED", "BLACK OUT", "BLACK IN", "WHITE OUT" and "WHITE IN". See Title Effect Types for more information about these values.
speed (Optional): Number - Time in seconds to fade in resource. Default: -1
showInMap (Optional): Boolean - false to hide the text when the map is opened. Default: true
Return Value:
Nothing

Examples

Example 1:
titleObj ["BISLogo", "PLAIN"]

Additional Information

See also:
titleTexttitleRsccutRsccutObjcutTextallActiveTitleEffects

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