titleObj: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\| *(arg|eff|mp|serverExec|gr[0-9]) *= *(.*) * *\|([^=0-9]{12})" to "|$1=$2 |descr=$3")
m (Some wiki formatting)
 
(17 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| ofp
|game1= ofp
|1.00
|version1= 1.00


|game2= ofpe
|game2= ofpe
Line 26: Line 26:
|descr= Shows object defined in global config in CfgTitles
|descr= Shows object defined in global config in CfgTitles


|s1= '''titleObj''' [class, type, speed, showInMap]
|s1= [[titleObj]] [class, type, speed, showInMap]


|p1= [class, type, speed, showInMap]: [[Array]]
|p1= class: [[String]] - defined in <sqf inline>configFile >> "CfgTitles" >> class</sqf>
|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.
|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]]


|r1=[[Nothing]]
|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


|x1= <code>[[titleObj]] ["BISLogo", "PLAIN"]</code>
|p3= speed: [[Number]] - (Optional, default -1) time in seconds to fade in resource


|seealso= [[titleText]], [[titleRsc]], [[cutRsc]], [[cutObj]], [[cutText]], [[allActiveTitleEffects]]
|p4= showInMap: [[Boolean]] - (Optional, default [[true]]) [[false]] to hide the text when the map is opened
}}
 
|r1= [[Nothing]]


{{GameCategory|arma1|Scripting Commands}}
|x1= <sqf>titleObj ["BISLogo", "PLAIN"];</sqf>


{{GameCategory|arma2|Scripting Commands}}
|seealso= [[titleText]] [[titleRsc]] [[cutRsc]] [[cutObj]] [[cutText]] [[allActiveTitleEffects]] [[activeTitleEffectParams]]
{{GameCategory|arma3|Scripting Commands}}
}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 11:05, 19 April 2024

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

Examples

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

Additional Information

See also:
titleText titleRsc cutRsc cutObj cutText allActiveTitleEffects activeTitleEffectParams

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