EngineRestreamWorld: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
(Remove obsolete Requirements section)
 
(2 intermediate revisions by one other user not shown)
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|
Line 29: Line 26:
end)
end)
</syntaxhighlight>
</syntaxhighlight>
==Requirements==
{{Requirements|n/a|1.5.8-9.20704|}}


==Changelog==
==Changelog==
{{ChangelogHeader}}
{{ChangelogHeader}}
{{ChangelogItem|1.6.0-9.21712|Added includeLODs argument}}
{{ChangelogItem|1.6.0-9.21712|Added includeLODs argument}}
{{ChangelogItem|1.6.0-9.22663|Removed includeLODs argument}}
{{ChangelogItem|1.6.0-9.22663|Removed includeLODs argument. Now it's always true}}


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

Latest revision as of 17:22, 7 November 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)

Changelog

Version Description
1.6.0-9.21712 Added includeLODs argument
1.6.0-9.22663 Removed includeLODs argument. Now it's always true

See Also