EngineRestreamWorld: Difference between revisions
Jump to navigation
Jump to search
Fernando187 (talk | contribs) m (add link to PR#1735) |
Fernando187 (talk | contribs) (Remove obsolete Requirements section) |
||
| (5 intermediate revisions by one other user not shown) | |||
| Line 5: | Line 5: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool engineRestreamWorld ( | bool engineRestreamWorld () | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== | {{Deprecated items|3.0161|1.6.0| | ||
<syntaxhighlight lang="lua"> | |||
bool engineRestreamWorld ( [ bool includeLODs = false ] ) | |||
</syntaxhighlight> | |||
===Optional Arguments=== | ===Optional Arguments=== | ||
*'''includeLODs:''' If is set to ''true'' this function will re-stream LOD models too. | *'''includeLODs:''' If is set to ''true'' this function will re-stream LOD models too. | ||
|22663}} | |||
===Returns=== | |||
Returns ''true'' if the world was restreamed successfully, ''false'' otherwise. | |||
==Example== | ==Example== | ||
| Line 21: | Line 26: | ||
end) | end) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==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. 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 ()
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
- engineAddImage
- engineApplyShaderToWorldTexture
- engineFreeModel
- engineGetModelFlags
- engineGetModelIDFromName
- engineGetModelLODDistance
- engineGetModelNameFromID
- engineGetModelPhysicalPropertiesGroup
- engineGetModelTextureNames
- engineGetModelTextures
- engineGetModelTXDID
- engineGetModelVisibleTime
- engineGetObjectGroupPhysicalProperty
- engineGetSurfaceProperties
- engineGetVisibleTextureNames
- engineImageGetFilesCount
- engineImageGetFiles
- engineImageGetFile
- engineImageLinkDFF
- engineImageLinkTXD
- engineImportTXD
- engineLoadCOL
- engineLoadDFF
- engineLoadIMG
- engineLoadIFP
- engineLoadTXD
- engineRemoveImage
- engineRemoveShaderFromWorldTexture
- engineReplaceAnimation
- engineReplaceCOL
- engineReplaceModel
- engineRequestModel
- engineResetModelFlags
- engineResetModelLODDistance
- engineResetSurfaceProperties
- engineRestoreAnimation
- engineRestoreCOL
- engineRestoreDFFImage
- engineRestoreModel
- engineRestoreModelPhysicalPropertiesGroup
- engineRestoreObjectGroupPhysicalProperties
- engineRestoreTXDImage
- engineRestreamWorld
- engineSetAsynchronousLoading
- engineSetModelFlag
- engineSetModelFlags
- engineSetModelLODDistance
- engineSetModelPhysicalPropertiesGroup
- engineSetModelVisibleTime
- engineSetObjectGroupPhysicalProperty
- engineSetSurfaceProperties
- engineStreamingFreeUpMemory
- engineStreamingGetUsedMemory