EngineRestreamWorld: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 4: Line 4:


==Syntax==
==Syntax==
{{New feature/item|3.0161|1.6.0|22663|
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool engineRestreamWorld ()
bool engineRestreamWorld ()
</syntaxhighlight>
</syntaxhighlight>
}}


{{Deprecated items|3.0161|1.6.0|
{{Deprecated items|3.0161|1.6.0|

Revision as of 20:53, 15 August 2024

This function re-streams everything in the GTA world. Read this pull request to understand what it is for.

Syntax

bool engineRestreamWorld ()
BEFORE VERSION 1.6.0 r22663:
bool engineRestreamWorld ( [ bool includeLODs = false ] )

Optional Arguments

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

Returns

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

Example

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

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

Requirements

Minimum server version n/a
Minimum client version 1.5.8-9.20704

Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version client="1.5.8-9.20704" />

Changelog

Version Description
1.6.0-9.21712 Added includeLODs argument
1.6.0-9.22663 Removed includeLODs argument

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/EngineRestreamWorld?oldid=80025"