preloadTitleObj: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]OFP[ _]Elite(\|.*)?\]\]" to "{{GameCategory|ofpe|Scripting Commands}}")
m (Some wiki formatting)
 
(22 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


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


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


|gr1= GUI Control |GROUP1=
|game3= arma2
____________________________________________________________________________________________
|version3= 1.00


| Preloads data for the given resource object. |DESCRIPTION=
|game4= arma2oa
____________________________________________________________________________________________
|version4= 1.50


|'''preloadTitleObj''' [name, type, speed, showInMap] |SYNTAX=
|game5= tkoh
|version5= 1.00


|p1= [name, type, speed, showInMap]: [[Array]] |PARAMETER1=
|game6= arma3
|p2= name: [[String]] - defined in <tt>[[configFile]] >> "CfgTitles" >> name</tt> |PARAMETER2=
|version6= 0.50
|p3= type: [[String]] - "PLAIN" e.g. |PARAMETER3=
|p4= speed (Optional): [[Number]] - Default: -1|PARAMETER4=
|p5= showInMap (Optional): [[Boolean]] - Default: [[true]] |PARAMETER5=
|[[Boolean]] |RETURNVALUE=
____________________________________________________________________________________________
 
|x1= <code>_ok = [[preloadTitleObj]] ["BISLogo", "PLAIN"]</code> |EXAMPLE1=
____________________________________________________________________________________________


| [[cutObj]] |SEEALSO=
|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]]
{{GameCategory|ofpe|Scripting Commands}}
}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 09:56, 19 April 2024

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