titleObj: Difference between revisions

Latest revision as of 11:05, 19 April 2024

Hover & click on the images for description

Syntax:: titleObj [class, type, speed, showInMap]
Parameters:: 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: Number - (Optional, default -1) time in seconds to fade in resource
: showInMap: Boolean - (Optional, default true) false to hide the text when the map is opened
Return Value:: Nothing

See also:: titleText titleRsc cutRsc cutObj cutText allActiveTitleEffects activeTitleEffectParams

: 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

@@ Line 1: / Line 1: @@
-<h2 style="color:#000066">'''titleObj ''effect'''''</h2>
+{{RV|type=command
-'''Operand types:'''
+|game1= ofp
+|version1= 1.00
-effect: [[Array]]
+|game2= ofpe
+|version2= 1.00
-'''Type of returned value:'''
+|game3= arma1
+|version3= 1.00
-Nothing
+|game4= arma2
+|version4= 1.00
-'''Description:'''
+|game5= arma2oa
+|version5= 1.50
-Object title - argument in format '''''["text", "type", speed]''''' or '''''["name", "type"]'''''
+|game6= tkoh
+|version6= 1.00
-If speed is not given, it is assumed 1.
+|game7= arma3
+|version7= 0.50
-Object can be defined in [[description.ext]]
+|gr1= GUI Control
-'''Example:'''
+|descr= Shows object defined in global config in CfgTitles
-'''titleObj''' ["BISLogo", "PLAIN"]
+|s1= [[titleObj]] [class, type, speed, showInMap]
+|p1= class: [[String]] - defined in <sqf inline>configFile >> "CfgTitles" >> class</sqf>
+|p2= 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
+|p3= speed: [[Number]] - (Optional, default -1) time in seconds to fade in resource
+|p4= showInMap: [[Boolean]] - (Optional, default [[true]]) [[false]] to hide the text when the map is opened
+|r1= [[Nothing]]
+|x1= <sqf>titleObj ["BISLogo", "PLAIN"];</sqf>
+|seealso= [[titleText]] [[titleRsc]] [[cutRsc]] [[cutObj]] [[cutText]] [[allActiveTitleEffects]] [[activeTitleEffectParams]]
+}}