EngineStreamingSetModelCacheLimits: Difference between revisions
Jump to navigation
Jump to search
(Created page with "To do") |
(Filling in page data & structure) |
||
Line 1: | Line 1: | ||
__NOTOC__ | |||
{{Client function}} | |||
==Description== | |||
This function sets custom cache limits for vehicle and pedestrian models based on provided values.<br> | |||
The arguments that receive zero mean complete deactivation. | |||
==Syntax== | |||
<syntaxhighlight lang="lua"> | |||
bool engineStreamingSetModelCacheLimits( [ int numVehicles, int numPeds ] ) | |||
</syntaxhighlight> | |||
===Arguments=== | |||
*'''numVehicles:''' Specifies the maximum number of vehicle models that can be cached. | |||
*'''numPeds:''' Specifies the maximum number of pedestrian models that can be cached. | |||
===Returns=== | |||
Returns ''true'' if the event occurred, otherwise it throws an error message. | |||
==Requirements== | |||
{{Requirements|n/a|1.6.0-9.21947}} | |||
==Example== | |||
<section name="Client" class="client" show="true"> | |||
This example turns off cache limiting. | |||
<syntaxhighlight lang="lua"> | |||
addEventHandler("onClientResourceStart", resourceRoot, | |||
function() | |||
engineStreamingSetModelCacheLimits(0, 0) | |||
end | |||
) | |||
</syntaxhighlight> | |||
</section> | |||
<section name="Client" class="client" show="true"> | |||
This example sets a limit of 128 for the cache. | |||
<syntaxhighlight lang="lua"> | |||
addEventHandler("onClientResourceStart", resourceRoot, | |||
function() | |||
engineStreamingSetModelCacheLimits(128, 128) | |||
end | |||
) | |||
</syntaxhighlight> | |||
</section> | |||
==See Also== | |||
{{Engine_functions}} |
Revision as of 00:37, 8 June 2024
Description
This function sets custom cache limits for vehicle and pedestrian models based on provided values.
The arguments that receive zero mean complete deactivation.
Syntax
bool engineStreamingSetModelCacheLimits( [ int numVehicles, int numPeds ] )
Arguments
- numVehicles: Specifies the maximum number of vehicle models that can be cached.
- numPeds: Specifies the maximum number of pedestrian models that can be cached.
Returns
Returns true if the event occurred, otherwise it throws an error message.
Requirements
Minimum server version | n/a |
---|---|
Minimum client version | 1.6.0-9.21947 |
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.6.0-9.21947" />
Example
Click to collapse [-]
ClientThis example turns off cache limiting.
addEventHandler("onClientResourceStart", resourceRoot, function() engineStreamingSetModelCacheLimits(0, 0) end )
Click to collapse [-]
ClientThis example sets a limit of 128 for the cache.
addEventHandler("onClientResourceStart", resourceRoot, function() engineStreamingSetModelCacheLimits(128, 128) 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