preloadObject: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|s([0-9])\= ([^' ]+)'''([^' ]+)'''([^ ]*) " to "|s$1= $2$3$4 ")
m (Text replacement - "<sqf>([^↵][^\/]*↵[^\/]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(14 intermediate revisions by 3 users not shown)
Line 21: Line 21:
|gr1= Object Manipulation
|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
|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
|r1= [[Boolean]] - [[true]] when preload is finished


|s2= distance [[preloadObject]] classname
|x1= <sqf>
 
0 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>
0 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]]
}}
}}

Latest revision as of 11:34, 3 September 2024

ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.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
Retrieved from "https://community.bistudio.com/wiki?title=preloadObject&oldid=369157"