titleObj: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(add. ArmA2 classification)
m (Some wiki formatting)
 
(55 intermediate revisions by 9 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


| Object title - Object can be defined in [[Description.ext]]
|game3= arma1
|version3= 1.00


<i>type</i> may be one of:
|game4= arma2
|version4= 1.00


• "PLAIN"
|game5= arma2oa
|version5= 1.50


• "PLAIN DOWN"
|game6= tkoh
|version6= 1.00


• "BLACK"
|game7= arma3
|version7= 0.50


• "BLACK FADED"
|gr1= GUI Control


• "BLACK OUT"
|descr= Shows object defined in global config in CfgTitles


• "BLACK IN"
|s1= [[titleObj]] [class, type, speed, showInMap]


• "WHITE OUT"
|p1= class: [[String]] - defined in <sqf inline>configFile >> "CfgTitles" >> class</sqf>


• "WHITE IN"
|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


See [[Title Effect Type]] for more information about these types. |= Description
|p3= speed: [[Number]] - (Optional, default -1) time in seconds to fade in resource
____________________________________________________________________________________________


| '''titleObj''' [text, type, speed] |= Syntax
|p4= showInMap: [[Boolean]] - (Optional, default [[true]]) [[false]] to hide the text when the map is opened


|p1= [text, type, speed]: [[Array]] |= Parameter 1
|r1= [[Nothing]]
|p2= text: [[String]] |= Parameter 2
|p3= type: [[String]]. |= Parameter 3
|p4= speed: [[Number]] - optional, default 1. |= Parameter 4


| [[Nothing]] |= Return value
|x1= <sqf>titleObj ["BISLogo", "PLAIN"];</sqf>
____________________________________________________________________________________________
 
|x1= <pre>titleObj ["BISLogo", "PLAIN"]</pre> |= Example 1
____________________________________________________________________________________________


| |= See also
|seealso= [[titleText]] [[titleRsc]] [[cutRsc]] [[cutObj]] [[cutText]] [[allActiveTitleEffects]] [[activeTitleEffectParams]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|TITLEOBJ]]
[[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}}}}]]

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"