preloadTitleObj: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Some wiki formatting)
 
(54 intermediate revisions by 11 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma |= Game name
|game1= ofpe
|version1= 1.00


|1.00|= Game version
|game2= arma1
____________________________________________________________________________________________
|version2= 1.00


| Object title - argument uses format '''["text","type",speed]''' or '''["name","type"]'''. Speed is ignored. Preload data the object can be defined in the [[Description.ext]] file. |= Description
|game3= arma2
____________________________________________________________________________________________
|version3= 1.00


|
|game4= arma2oa
*[[Boolean]] <nowiki>=</nowiki> '''preloadTitleObj''' ["text","type",speed]
|version4= 1.50
*[[Boolean]] <nowiki>=</nowiki> '''preloadTitleObj''' ["name","type"] |= Syntax


|p1= "Text": [[String]] Literal text to display
|game5= tkoh
|p2= "name": [[String]] defined in [[Description.ext]] for the mission
|version5= 1.00
|p3= speed: ignored, but used as a 3rd element to distinguish betweeen 'text' and 'name'
| [[Boolean]] |= Return value
____________________________________________________________________________________________
 
|x1= <code>'''preloadTitleObj''' ["BISLogo","plain"]</code> |= Example 1
____________________________________________________________________________________________


| |= See also
|game6= arma3
|version6= 0.50


}}
|gr1= GUI Control
 
|descr= Preloads data for the given resource object.
 
|s1= [[preloadTitleObj]] [name, type, speed, showInMap]
 
|p1= name: [[String]] - defined in <sqf inline>configFile >> "CfgTitles" >> name</sqf>
 
|p2= type: [[String]] - see [[Title Effect Type]]s
 
|p3= speed: [[Number]] - (Optional, default -1)
 
|p4= showInMap: [[Boolean]] - (Optional, default [[true]])


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


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


<h3 style="display:none">Bottom Section</h3>
|seealso= [[cutObj]]
[[Category:Scripting Commands|PRELOADTITLEOBJ]]
}}
[[Category:Scripting Commands OFP Elite |PRELOADTITLEOBJ]]
[[Category:Scripting Commands ArmA|PRELOADTITLEOBJ]]

Latest revision as of 09:56, 19 April 2024

ofpe 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:
Preloads data for the given resource object.
Groups:
GUI Control

Syntax

Syntax:
preloadTitleObj [name, type, speed, showInMap]
Parameters:
name: String - defined in configFile >> "CfgTitles" >> name
type: String - see Title Effect Types
speed: Number - (Optional, default -1)
showInMap: Boolean - (Optional, default true)
Return Value:
Boolean

Examples

Example 1:
_ok = preloadTitleObj ["BISLogo", "PLAIN"];

Additional Information

See also:
cutObj

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=preloadTitleObj&oldid=363768"