engineSetAsynchronousLoading | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

engineSetAsynchronousLoading

Client-side
Server-side
Shared
Needs checking

This function was partially migrated from the old wiki. Please review manually:

  • Missing section: How it works

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

This function enables or disables asynchronous model loading. Enabling asynchronous model loading may reduce the small pauses that occur when a new model is displayed for the first time. However, it can cause the new models to appear slightly later than they might have otherwise.

Caution

Using this function with a large amounts of engineReplace* at the same time may cause loading times to be exponentially slower.

OOP Syntax Help! I don't understand this!

  • Method: Engine.setAsynchronousLoading(...)

Syntax

bool engineSetAsynchronousLoading ( bool enable, bool force )
Required Arguments
  • enable: Set to true/false to enable/disable asynchronous loading. Only works if the client's preferences has 'Asynchronous Loading' set to 'Auto'.
  • force: If set to true, ignores the client's preferences.

Returns

  • bool: value

Returns true if the function executed successfully, false otherwise.

Code Examples

shared

The next example enables the model asynchronous loading ignoring client preferences if there are a lot of objects (and the player wants to).

addEventHandler("onClientResourceStart", resourceRoot, function()
    if #getElementsByType("object") > 500 then
  engineSetAsynchronousLoading( true, false )
    end
end)

See Also

Engine Functions
Engine Elements
Reference