EngineStreamingGetMemorySize: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Fix Returns styling)
(Remove obsolete Requirements section)
 
(2 intermediate revisions by 2 users not shown)
Line 2: Line 2:
{{Client function}}
{{Client function}}
{{New feature/item|3.0160|1.6.0|21874|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}}
Line 23: Line 24:
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

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(engineGetStreamingMemorySize() / 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=81350"