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 21: / Line 21: @@
 |gr1= Object Manipulation
-|descr= Preloads all textures, materials and proxies needed to render given object. Works with both class names and objects. Returns true once all data is loaded and ready.{{Feature | important | At least one object of the given classname has to be present in the current mission in order for alternative syntax version of the command to have any effect}}
+|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.
-|s1=  distance '''preloadObject''' object
+|s1= distance [[preloadObject]] object
 |p1= distance: [[Number]] -  distance at which preload the object
-|p2= object: [[Object]] - existing object
+|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
 |r1= [[Boolean]] - [[true]] when preload is finished
-|s2= distance '''preloadObject''' classname
+|x1= <sqf>
+spawn
-|p21= distance: [[Number]]  -  distance at which preload the object
-|p22= classname: [[String]] - classname of the object
-|r2= [[Boolean]] - [[true]] when preload is finished
-|x1= <code>[] [[spawn]]
 {
-	[[waitUntil]] {10 [[preloadObject]] "SoldierW"};
+	waitUntil { 10 preloadObject "SoldierW" };
-	[[hint]] "Preload finished";
+	hint "Preload finished";
-};</code>
+};
-|x2= <code>[] [[spawn]]
+</sqf>
+|x2= <sqf>
+spawn
 {
-	[[waitUntil]] {10 [[preloadObject]] [[leader]] [[player]]};
+	waitUntil { 10 preloadObject leader player };
-	[[hint]] "Preload finished";
+	hint "Preload finished";
-};</code>
+};
+</sqf>
-|seealso= [[preloadCamera]], [[preloadSound]], [[preloadTitleObj]], [[preloadTitleRsc]]
+|seealso= [[preloadCamera]] [[preloadSound]] [[preloadTitleObj]] [[preloadTitleRsc]]
 }}
-{{GameCategory|ofpe|Scripting Commands}}
-{{GameCategory|arma1|Scripting Commands}}
-{{GameCategory|arma2|Scripting Commands}}
-{{GameCategory|arma3|Scripting Commands}}
-{{GameCategory|tkoh|Scripting Commands}}