EngineSetAsynchronousLoading: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 1: Line 1:
{{Client function}}
{{Client function}}
{{Needs_Example}}
__NOTOC__
__NOTOC__
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.
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.

Revision as of 09:40, 18 January 2014

Accessories-text-editor.png Script Example Missing Function EngineSetAsynchronousLoading needs a script example, help out by writing one.
Before submitting check out Editing Guidelines Script Examples.


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.

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

Returns true if the function executed successfully, false otherwise.

Example

Click to collapse [-]
Client
-- TODO

How it works

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

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/EngineSetAsynchronousLoading?oldid=38477"