preloadObject: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "<sqf>([^↵][^\/]*↵[^\/]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(70 intermediate revisions by 14 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma |= Game name
|game1= ofpe
|version1= 1.00


|2.4|= 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. Returns true once all data are ready. |= Description
|game3= arma2
____________________________________________________________________________________________
|version3= 1.00


| '''distance preloadObject object''' |= Syntax
|game4= arma2oa
|version4= 1.50


|p1= distance: [[Number]] |= Parameter 1
|game5= tkoh
|version5= 1.00


|p2= object: [[String]] |= Parameter 2
|game6= arma3
|version6= 0.50


| [[Boolean]] |= Return value
|gr1= Object Manipulation
____________________________________________________________________________________________
 
|x1= <pre>[[spawn]] {[[waitUntil]] preloadObject "SoldierW"} [[spawn]] {[[waitUntil]] preloadObject [[leader]] [[player]]}</pre> |= Example 1
____________________________________________________________________________________________


| |= See also
|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
 
|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>
0 spawn
{
waitUntil { 10 preloadObject "SoldierW" };
hint "Preload finished";
};
</sqf>
|x2= <sqf>
0 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]]

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"