EngineRestreamWorld: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 5: Line 5:
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool engineRestreamWorld ( )
bool engineRestreamWorld ( [bool includeLODs] )
</syntaxhighlight>
</syntaxhighlight>


===Returns===
===Returns===
Returns ''true'' if the world was restreamed successfully, ''false'' otherwise.
Returns ''true'' if the world was restreamed successfully, ''false'' otherwise.
===Optional Arguments===
*'''includeLODs:''' If is set to ''true'' this function will re-stream LOD models too.


==Example==
==Example==
Line 21: Line 24:
==Requirements==
==Requirements==
{{Requirements|n/a|1.5.8-9.20704|}}
{{Requirements|n/a|1.5.8-9.20704|}}
==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.6.0-9.21712|Added includeLODs argument}}


==See Also==
==See Also==
{{Engine functions}}
{{Engine functions}}

Revision as of 18:37, 16 June 2023

This function re-streams everything in the GTA world.

Syntax

bool engineRestreamWorld ( [bool includeLODs] )

Returns

Returns true if the world was restreamed successfully, false otherwise.

Optional Arguments

  • includeLODs: If is set to true this function will re-stream LOD models too.

Example

This function can be used after a model (or more) is loaded with engineLoadDFF:

addEventHandler ("onClientResourceStart", resourceRoot, function ()
    engineRestreamWorld ()
end)

Requirements

This template will be deleted.

Changelog

Version Description
1.6.0-9.21712 Added includeLODs argument

See Also