EngineStreamingGetBufferSize: Difference between revisions
		
		
		
		
		
		Jump to navigation
		Jump to search
		
				
		
		
	
 (Created page with "__NOTOC__ {{Client function}} {{New feature/item|3.0160|1.6.0|21874|Get the streaming buffer size ['''not''' maximum memory size]}} ==Syntax== <syntaxhighlight lang="lua"> number engineStreamingGetBufferSize() </syntaxhighlight> {{OOP||EngineStreaming:setBufferSize|bufferSize|engineStreamingGetBufferSize}}  ===Returns=== The streaming buffer size. It is always a positive non-zero number.  ==Example== This example adds a command that can be used to change the streamin...")  | 
				mNo edit summary  | 
				||
| Line 6: | Line 6: | ||
number engineStreamingGetBufferSize()  | number engineStreamingGetBufferSize()  | ||
</syntaxhighlight>  | </syntaxhighlight>  | ||
{{OOP||[[EngineStreaming]]:  | {{OOP||[[EngineStreaming]]:getBufferSize|bufferSize|engineStreamingSetBufferSize}}  | ||
===Returns===  | ===Returns===  | ||
Revision as of 23:32, 25 August 2023
Get the streaming buffer size [not maximum memory size]
Syntax
number engineStreamingGetBufferSize()
OOP Syntax Help! I don't understand this!
- Method: EngineStreaming:getBufferSize(...)
 - Variable: .bufferSize
 - Counterpart: engineStreamingSetBufferSize
 
Returns
The streaming buffer size. It is always a positive non-zero number.
Example
This example adds a command that can be used to change the streaming buffer size, and display the previous value.
addCommandHandler("sbs", function(_, sizeMB)
    if tonumber(sizeMB) then
        if engineStreamingSetBufferSize(tonumber(sizeMB) * 1024 * 1024) then -- Convert MB to Bytes
            outputChatbox("The streaming buffer size has been changed from " .. math.floor(engineStreamingGetBufferSize() / 1024 / 1024) .. " MB to " .. sizeMB .. " MB")
        else
            outputChatbox("Not enough memory!")
        end
    else
        outputChatbox("Please enter a numeric value!")
    end
end, false, false)
Requirements
This template will be deleted.
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