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

engineSetAsynchronousLoading

Client-side
Server-side
Shared

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.

If asynchronous loading is disabled, MTA requests all resources to be loaded at the time they have been requested. This will halt game execution for the time being. Otherwise, all resource requests are queued up on the to-be-loaded queue. At the beginning of the game frame, the GTA:SA streaming system is updated, along with its streaming slicers. This is when a model is loaded after going through multiple stages. Having asynchronous loading disabled forces all stages to be consecutively run through.

For more details read GTA:SA Resource Streaming.

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 = false ] )
Required Arguments
  • enable: Set to true/false to enable/disable asynchronous loading.
Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use.

  • force (default: false): If set to true, ignores the client's preferences.

Returns

  • bool: result

Returns true if the function executed successfully, false otherwise.

Code Examples

client

The 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