EngineRestreamWorld: Difference between revisions
Jump to navigation
Jump to search
Fernando187 (talk | contribs) m (add link to PR#1735) |
mNo edit summary |
||
| (3 intermediate revisions by the same 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 28: | Line 33: | ||
{{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}} | |||
==See Also== | ==See Also== | ||
{{Engine functions}} | {{Engine functions}} | ||
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 ()
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
- 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