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
-| arma1 |Game name=
+|game1= ofpe
+|version1= 1.00
-|1.00|Game version=
+|game2= arma1
+|version2= 1.00
-|gr1= Object Manipulation |GROUP1=
+|game3= arma2
+|version3= 1.00
-| 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.<br><br>
+|game4= arma2oa
-{{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}}|DESCRIPTION=
+|version4= 1.50
-| distance '''preloadObject''' object |SYNTAX=
+|game5= tkoh
+|version5= 1.00
-|p1= distance: [[Number]] -  distance at which preload the object |PARAMETER1=
+|game6= arma3
-|p2 = object: [[Object]] - existing object |PARAMETER2=
+|version6= 0.50
-| [[Boolean]] - [[true]] when preload is finished |RETURNVALUE=
+|gr1= Object Manipulation
-|s2 = distance '''preloadObject''' classname |SYNTAX2=
+|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.
-|p21= distance: [[Number]]  -  distance at which preload the object |PARAMETER21=
+|s1= distance [[preloadObject]] object
-|p22 = classname: [[String]] - classname of the object |PARAMETER22=
+|p1= distance: [[Number]] -  distance at which preload the object
-| r2 = [[Boolean]] - [[true]] when preload is finished |RETURNVALUE2=
+|p2= object: [[Object]] or [[String]]
+* [[Object]] - existing object
-|x1= <code>[] [[spawn]]
+* [[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
+|x1= <sqf>
+spawn
 {
-	[[waitUntil]] {10 [[preloadObject]] "SoldierW"};
+	waitUntil { 10 preloadObject "SoldierW" };
-	[[hint]] "Preload finished";
+	hint "Preload finished";
-};</code>|EXAMPLE1=
+};
-|x2= <code>[] [[spawn]]
+</sqf>
+|x2= <sqf>
+spawn
 {
-	[[waitUntil]] {10 [[preloadObject]] [[leader]] [[player]]};
+	waitUntil { 10 preloadObject leader player };
-	[[hint]] "Preload finished";
+	hint "Preload finished";
-};</code>|EXAMPLE2=
+};
+</sqf>
-|   [[preloadCamera]], [[preloadSound]], [[preloadTitleObj]], [[preloadTitleRsc]]|SEEALSO=
+|seealso= [[preloadCamera]] [[preloadSound]] [[preloadTitleObj]] [[preloadTitleRsc]]
 }}
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Scripting Commands|PRELOADOBJECT]]
-{{GameCategory|ofpe|Scripting Commands}}
-{{GameCategory|arma1|Scripting Commands}}
-{{GameCategory|arma2|Scripting Commands}}
-{{GameCategory|arma3|Scripting Commands}}
-{{GameCategory|tkoh|Scripting Commands}}