titleObj: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(corrections, format)
m (Some wiki formatting)
 
(49 intermediate revisions by 5 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


| Shows object defined in global config in CfgTitles. Type may be one of:
|game3= arma1
* "PLAIN"
|version3= 1.00
* "PLAIN DOWN"
* "BLACK"
* "BLACK FADED"
* "BLACK OUT"
* "BLACK IN"
* "WHITE OUT"
* "WHITE IN"
See [[Title Effect Type]] for more information about these types. |= Description
____________________________________________________________________________________________


| '''titleObj''' [class, type, speed] |= Syntax
|game4= arma2
|version4= 1.00


|p1= [class, type, speed]: [[Array]] |= Parameter 1
|game5= arma2oa
|p2= class: [[String]] |= Parameter 2
|version5= 1.50
|p3= type: [[String]] |= Parameter 3
|p4= speed (Optional): [[Number]] |= Parameter 4
|p5= showOnMap  (Optional): [[Boolean]]  (''Since Arma 3'')|= Parameter 5


| [[Nothing]] |= Return value
|game6= tkoh
____________________________________________________________________________________________
|version6= 1.00
 
|x1= <code>[[titleObj]] ["BISLogo", "PLAIN"]</code> |= Example 1
____________________________________________________________________________________________


| [[titleText]], [[titleRsc]], [[cutRsc]], [[cutObj]], [[cutText]] |= See also
|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


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


<!-- Note Section END -->
|x1= <sqf>titleObj ["BISLogo", "PLAIN"];</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[titleText]] [[titleRsc]] [[cutRsc]] [[cutObj]] [[cutText]] [[allActiveTitleEffects]] [[activeTitleEffectParams]]  
[[Category:Scripting Commands|TITLEOBJ]]
}}
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|TITLEOBJ]]
[[Category:Scripting Commands OFP 1.46|TITLEOBJ]]
[[Category:Scripting Commands ArmA|TITLEOBJ]]
[[Category:Command_Group:_Interaction|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]

Latest revision as of 10:05, 19 April 2024

Logo A0.png1.00ofpe 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:
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
Retrieved from "https://community.bistudio.com/wiki?title=titleObj&oldid=363770"