EngineStreamingRestoreBufferSize: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Add a line break)
mNo edit summary
 
Line 2: Line 2:
{{Client function}}
{{Client function}}


==Description==
This function resets the streaming buffer. The value is automatically reset when disconnected.
This function resets the streaming buffer.<br>
The value is automatically reset when disconnected.


==Syntax==  
==Syntax==  
Line 12: Line 10:


===Returns===
===Returns===
Returns ''true'' if the event occurred, otherwise it throws an error message.
Returns ''true'' if the event occurred, otherwise it throws an error message and returns ''false''.


==Requirements==
==Requirements==

Latest revision as of 09:36, 30 June 2024

This function resets the streaming buffer. The value is automatically reset when disconnected.

Syntax

bool engineStreamingRestoreBufferSize()

Returns

Returns true if the event occurred, otherwise it throws an error message and returns false.

Requirements

Minimum server version n/a
Minimum client version 1.6.0-9.22195

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.22195" />

Example

Click to collapse [-]
Client

This example restores streaming buffer size.

addEventHandler("onClientResourceStart", resourceRoot,
    function()
        engineStreamingRestoreBufferSize()
    end
)

See Also