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: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-| arma |= Game name
+|game1= ofpe
+|version1= 1.00
-|1.00|= Game version
+|game2= arma1
-____________________________________________________________________________________________
+|version2= 1.00
-| Preload all textures, materials and proxies needed to render given object. Object can be determined either by config class name, or by object id.
+|game3= arma2
+|version3= 1.00
-Returns true once all data is loaded and ready. |= Description
+|game4= arma2oa
-____________________________________________________________________________________________
+|version4= 1.50
-| '''distance preloadObject object''' |= Syntax
+|game5= tkoh
+|version5= 1.00
-|p1= distance: [[Number]] |= Parameter 1
+|game6= arma3
+|version6= 0.50
-|p2= object: [[String]] |= Parameter 2
+|gr1= Object Manipulation
-| [[Boolean]] |= Return value
+|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.
-____________________________________________________________________________________________
-|x1= <pre>[[spawn]] {[[waitUntil]] preloadObject "SoldierW"} [[spawn]] {[[waitUntil]] preloadObject [[leader]] [[player]]}</pre> |= Example 1
-____________________________________________________________________________________________
-|  |= See also
+|s1= distance [[preloadObject]] object
-}}
+|p1= distance: [[Number]] -  distance at which preload the 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
-<h3 style="display:none">Notes</h3>
+|r1= [[Boolean]] - [[true]] when preload is finished
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
+|x1= <sqf>
-</dl>
+spawn
+{
+	waitUntil { 10 preloadObject "SoldierW" };
+	hint "Preload finished";
+};
+</sqf>
+|x2= <sqf>
+spawn
+{
+	waitUntil { 10 preloadObject leader player };
+	hint "Preload finished";
+};
+</sqf>
-<h3 style="display:none">Bottom Section</h3>
+|seealso= [[preloadCamera]] [[preloadSound]] [[preloadTitleObj]] [[preloadTitleRsc]]
-[[Category:Scripting Commands|PRELOADOBJECT]]
+}}
-[[Category:Scripting Commands OFP Elite |PRELOADOBJECT]]
-[[Category:Scripting Commands ArmA|PRELOADOBJECT]]