titleObj: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Some wiki formatting)
 
(67 intermediate revisions by 12 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands]]
{{RV|type=command
[[Category:Scripting Commands OFP 1.97]]
[[Category:Scripting Commands OFP 1.46]]
[[Category:Scripting Commands ArmA]]


back to [[Scripting_Reference#T|COMREF]]
|game1= ofp
|version1= 1.00


<h2 style="color:#000066">'''titleObj ''effect'''''</h2>
|game2= ofpe
|version2= 1.00


|game3= arma1
|version3= 1.00


'''Operand types:'''
|game4= arma2
|version4= 1.00


'''effect:''' [[Array]]
|game5= arma2oa
|version5= 1.50


'''Type of returned value:'''
|game6= tkoh
|version6= 1.00


[[Nothing]]
|game7= arma3
|version7= 0.50


'''Description:'''
|gr1= GUI Control


Object title - argument in format '''''["text", "type", speed]''''' or '''''["name", "type"]'''''
|descr= Shows object defined in global config in CfgTitles


If speed is not given, it is assumed 1.
|s1= [[titleObj]] [class, type, speed, showInMap]


Object can be defined in [[Description.ext|description.ext]]
|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


'''Example:'''
|p3= speed: [[Number]] - (Optional, default -1) time in seconds to fade in resource


'''titleObj''' ["BISLogo", "PLAIN"]
|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]]
}}

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