EngineStreamingGetMemorySize: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Client function}} {{New feature/item|3.0160|1.6.0|21946|Gets the maximum amount of RAM [in bytes] that can be used for streaming}} ==Syntax== <syntaxhighlight lang="lua"> number engineStreamingGetMemorySize() </syntaxhighlight> {{OOP||EngineStreaming:getMemorySize|memorySize|engineStreamingSetMemorySize}} ==Returns== The maximum amount of RAM [in bytes] that can be used for streaming. It is always a non-zero positive number. ==Example== This example add...")
 
m (incorrect function name)
 
(6 intermediate revisions by 4 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
{{New feature/item|3.0160|1.6.0|21946|Gets the maximum amount of RAM [in bytes] that can be used for streaming}}
{{New feature/item|3.0160|1.6.0|21874|Gets the maximum amount of RAM [in bytes] that can be used for streaming}}
{{Tip|The `showmemstat` command can be used to see this value in real-time [You might have to scroll down using PgDown on your keyboard]}}
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
number engineStreamingGetMemorySize()
int engineStreamingGetMemorySize()
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[EngineStreaming]]:getMemorySize|memorySize|engineStreamingSetMemorySize}}
{{OOP||[[EngineStreaming]]:getMemorySize|memorySize|engineStreamingSetMemorySize}}


==Returns==
===Returns===
The maximum amount of RAM [in bytes] that can be used for streaming. It is always a non-zero positive number.
The maximum amount of RAM [in bytes] that can be used for streaming. It is always a non-zero positive number.


Line 16: Line 17:
addCommandHandler("ssms", function(_, sizeMB)
addCommandHandler("ssms", function(_, sizeMB)
     if tonumber(sizeMB) then
     if tonumber(sizeMB) then
         outputChatbox("The maximum streaming memory available has been changed from " .. math.floor(engineGetStreamingMemorySize() / 1024 / 1024) .. " MB to " .. sizeMB .. " MB")       
         outputChatBox("The maximum streaming memory available has been changed from " .. math.floor(engineStreamingGetMemorySize() / 1024 / 1024) .. " MB to " .. sizeMB .. " MB")       
         engineStreamingSetMemorySize(tonumber(sizeMB) * 1024 * 1024) -- Convert MB to Bytes
         engineStreamingSetMemorySize(tonumber(sizeMB) * 1024 * 1024) -- Convert MB to Bytes
     else
     else
         outputChatbox("Please enter a numeric value!")
         outputChatBox("Please enter a numeric value!")
     end
     end
end, false, false)
end, false, false)
</syntaxhighlight>
</syntaxhighlight>
==Requirements==
{{Requirements|n/a|1.6.0-9.21946|}}


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

Latest revision as of 10:28, 1 January 2025

Gets the maximum amount of RAM [in bytes] that can be used for streaming

[[{{{image}}}|link=|]] Tip: The `showmemstat` command can be used to see this value in real-time [You might have to scroll down using PgDown on your keyboard]

Syntax

int engineStreamingGetMemorySize()

OOP Syntax Help! I don't understand this!

Method: EngineStreaming:getMemorySize(...)
Variable: .memorySize
Counterpart: engineStreamingSetMemorySize


Returns

The maximum amount of RAM [in bytes] that can be used for streaming. It is always a non-zero positive number.

Example

This example adds a command that can be used to change the streaming memory size, and display the previous value. 

addCommandHandler("ssms", function(_, sizeMB)
    if tonumber(sizeMB) then
        outputChatBox("The maximum streaming memory available has been changed from " .. math.floor(engineStreamingGetMemorySize() / 1024 / 1024) .. " MB to " .. sizeMB .. " MB")      
        engineStreamingSetMemorySize(tonumber(sizeMB) * 1024 * 1024) -- Convert MB to Bytes
    else
        outputChatBox("Please enter a numeric value!")
    end
end, false, false)

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/EngineStreamingGetMemorySize?oldid=81604"