preloadObject: Difference between revisions

Latest revision as of 11:34, 3 September 2024

1.00

1.50

1.00

0.50

Hover & click on the images for description

Description

Description:: Preloads all textures, materials and proxies needed to render given object. Works with objects and classnames - note that classnames require an object instance in the mission.
Groups:: Object Manipulation

Syntax

Syntax:

distance preloadObject object

Parameters:

distance: Number - distance at which preload the object

object: Object or String

Object - existing object
String - object classname - an object of that type must exist in the mission for it to have effect

Return Value:

Boolean - true when preload is finished

Examples

Example 1:: 0 spawn { waitUntil { 10 preloadObject "SoldierW" }; hint "Preload finished"; };
Example 2:: 0 spawn { waitUntil { 10 preloadObject leader player }; hint "Preload finished"; };

Additional Information

See also:: preloadCamera preloadSound preloadTitleObj preloadTitleRsc

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

@@ Line 1: / Line 1: @@
-[[Category:Scripting Commands|PRELOADOBJECT]]
+{{RV|type=command
-[[Category:Scripting Commands OFP Elite |PRELOADOBJECT]]
-[[Category:Scripting Commands ArmA|PRELOADOBJECT]]
+|game1= ofpe
+|version1= 1.00
-<h2 style="color:#000066">''' distance preloadObject object '''</h2>
+|game2= arma1
+|version2= 1.00
+|game3= arma2
+|version3= 1.00
-'''Operand types:'''
+|game4= arma2oa
+|version4= 1.50
-distance: [[Number]]
+|game5= tkoh
+|version5= 1.00
-object: [[String]] or [[Object]]
+|game6= arma3
+|version6= 0.50
-'''Type of returned value:'''
+|gr1= Object Manipulation
-[[Boolean]]
+|descr= Preloads all textures, materials and proxies needed to render given object. Works with objects and classnames - note that classnames require an object instance in the mission.
-'''Compatibility:'''
+|s1= distance [[preloadObject]] object
-Version 2.40 required.
+|p1= distance: [[Number]] -  distance at which preload the object
-'''Description:'''
+|p2= object: [[Object]] or [[String]]
+* [[Object]] - existing object
+* [[String]] - object classname - an object of that type '''must''' exist in the mission for it to have effect
-Preload all textures, materials and proxies needed to render given object. Object can be determined either by config class name, or by object id.
+|r1= [[Boolean]] - [[true]] when preload is finished
-Returns true once all data are ready.
-'''Example:'''
+|x1= <sqf>
+spawn
+{
+	waitUntil { 10 preloadObject "SoldierW" };
+	hint "Preload finished";
+};
+</sqf>
+|x2= <sqf>
+spawn
+{
+	waitUntil { 10 preloadObject leader player };
+	hint "Preload finished";
+};
+</sqf>
-[[spawn]] {[[waitUntil]] '''preloadObject''' "SoldierW"}
+|seealso= [[preloadCamera]] [[preloadSound]] [[preloadTitleObj]] [[preloadTitleRsc]]
+}}
-[[spawn]] {[[waitUntil]] '''preloadObject''' [[leader unit|leader]] [[player]]}