EngineStreamingGetBufferSize: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
(Remove obsolete Requirements section)
 
(One intermediate revision by one other user not shown)
Line 4: Line 4:
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
number engineStreamingGetBufferSize()
int engineStreamingGetBufferSize()
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[EngineStreaming]]:getBufferSize|bufferSize|engineStreamingSetBufferSize}}
{{OOP||[[EngineStreaming]]:getBufferSize|bufferSize|engineStreamingSetBufferSize}}
Line 26: Line 26:
end, false, false)
end, false, false)
</syntaxhighlight>
</syntaxhighlight>
==Requirements==
{{Requirements|n/a|1.6.0-9.21874|}}


==See Also==
==See Also==
{{Engine functions}}
{{Engine functions}}

Latest revision as of 17:33, 7 November 2024

Get the streaming buffer size [not maximum memory size]

Syntax

int 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)

See Also