preloadObject: Difference between revisions

Latest revision as of 11:34, 3 September 2024

Hover & click on the images for 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:

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

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

: 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|P]]
+{{RV|type=command
-[[Category:Scripting Commands OFP Elite |P]]
-[[Category:Scripting Commands ArmA|P]]
-<new command not populated>
+|game1= ofpe
+|version1= 1.00
+|game2= arma1
+|version2= 1.00
-<h2 style="color:#000066">''''' preloadObject '''''</h2>
+|game3= arma2
+|version3= 1.00
+|game4= arma2oa
+|version4= 1.50
-'''Operand types:'''
+|game5= tkoh
+|version5= 1.00
-'''Type of returned value:'''
+|game6= arma3
+|version6= 0.50
-'''Compatibility:'''
+|gr1= Object Manipulation
-'''Description:'''
+|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
-'''Example:'''
+|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
+|r1= [[Boolean]] - [[true]] when preload is finished
+|x1= <sqf>
+spawn
+{
+	waitUntil { 10 preloadObject "SoldierW" };
+	hint "Preload finished";
+};
+</sqf>
+|x2= <sqf>
+spawn
+{
+	waitUntil { 10 preloadObject leader player };
+	hint "Preload finished";
+};
+</sqf>
+|seealso= [[preloadCamera]] [[preloadSound]] [[preloadTitleObj]] [[preloadTitleRsc]]
+}}