EngineStreamingFreeUpMemory: Difference between revisions
Jump to navigation
Jump to search
(Created page with "__NOTOC__ {{Client function}} {{Added feature/item|3.0159|1.5.9|1.5.8|20901|This function frees up the RAM streaming memory.}} {{Note|This function isn't accurate. The funct...") |
No edit summary |
||
| (7 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
{{Added feature/item | {{Added feature/item|1.5.9|1.5.8|20901|This function frees up the streaming RAM memory.}} | ||
{{Note|This function isn't accurate. The function works more like ''try to free up at least this amount of bytes''. It usually ends up freeing everything that isn't currently needed (which, depending on the scenery might be 1-200 megabytes).}} | {{Note|This function isn't accurate. The function works more like ''try to free up at least this amount of bytes''. It usually ends up freeing everything that isn't currently needed (which, depending on the scenery might be 1-200 megabytes).}} | ||
{{Important Note|'''This function is meant for advanced users only, as it can lead to stability issues'''. If you use it too often, the map might start to flicker.}} | |||
==Syntax== | ==Syntax== | ||
| Line 17: | Line 17: | ||
addEventHandler ("onClientResourceStart", resourceRoot, | addEventHandler ("onClientResourceStart", resourceRoot, | ||
function () | function () | ||
engineStreamingFreeUpMemory ( | engineStreamingFreeUpMemory (104857600) -- 100 megabytes | ||
end | end | ||
) | ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Engine_functions}} | {{Engine_functions}} | ||
Latest revision as of 11:23, 28 February 2025
This function frees up the streaming RAM memory.
| Important Note: This function is meant for advanced users only, as it can lead to stability issues. If you use it too often, the map might start to flicker. |
Syntax
bool engineStreamingFreeUpMemory ( int bytes )
Required Arguments
- bytes: The amount of RAM to be freed up in bytes.
Returns
- Returns true if the function has succeeded, false otherwise.
Example
This example frees up the streaming memory when the resource starts:
addEventHandler ("onClientResourceStart", resourceRoot,
function ()
engineStreamingFreeUpMemory (104857600) -- 100 megabytes
end
)
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