OnClientTransferBoxProgressChange: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client event}}  
{{Client event}}  
{{New feature/item|3.0160|1.5.8|20788|This event is triggered every time the resource file downloader (aka. transfer box) updates the download progress.}}
{{New feature/item|3.0159|1.5.8|20788|This event is triggered every time the resource file downloader (aka. transfer box) updates the download progress.}}


==Parameters==
==Parameters==

Revision as of 11:25, 11 April 2021

This event is triggered every time the resource file downloader (aka. transfer box) updates the download progress.

Parameters

float downloadedSizeTotal, float downloadTotalBytes
  • downloadedSizeTotal: total progress in bytes
  • downloadTotalBytes: download total size in bytes

Source

The source of this event is the root element.

Example

This example will show the percentage of the download progress, whenever a resource is started.

Click to collapse [-]
Client-side
addEventHandler("onClientTransferBoxProgressChange", root, function(downloadedSize, totalSize)
    local percentage = math.min((downloadedSize / totalSize) * 100, 100)

    print(percentage .. "%")
end)

NOTE: The code must be in a separated resource. It will be responsible to be watching other resources.

Requirements

Minimum server version
Minimum client version 1.5.8-9.20788

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 server="" client="1.5.8-9.20788" />

See Also

Client other events


Client event functions