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 (Some wiki formatting)
 
(28 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command


| ofp |Game name=
|game1= ofp
|version1= 1.00


|1.00|Game version=
|game2= ofpe
|version2= 1.00


|gr1= GUI Control |GROUP1=
|game3= arma1
|version3= 1.00


| Shows object defined in global config in CfgTitles |DESCRIPTION=
|game4= arma2
|version4= 1.00


| '''titleObj''' [class, type, speed, showInMap] |SYNTAX=
|game5= arma2oa
|p1= [class, type, speed, showInMap]: [[Array]] |PARAMETER1=
|version5= 1.50
|p2= class: [[String]] - defined in <tt>[[configFile]] >> "CfgTitles" >> class</tt> |PARAMETER2=
|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=
|p4= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1 |PARAMETER4=
|p5= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]]  |PARAMETER5=


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


| [[titleText]], [[titleRsc]], [[cutRsc]], [[cutObj]], [[cutText]], [[allActiveTitleEffects]] |SEEALSO=
|game7= arma3
}}
|version7= 0.50
 
|gr1= GUI Control
 
|descr= Shows object defined in global config in CfgTitles
 
|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]]


[[Category:Scripting Commands|TITLEOBJ]]
|x1= <sqf>titleObj ["BISLogo", "PLAIN"];</sqf>
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|TITLEOBJ]]
[[Category:Scripting Commands OFP 1.46|TITLEOBJ]]
{{GameCategory|arma1|Scripting Commands}}


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

Latest revision as of 10: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