OnClientTransferBoxProgressChange: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (7 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client event}} | {{Client event}} | ||
{{ | {{Added feature/item|1.5.9|1.5.8|20788|This event is triggered every time the [[resource]] file downloader (aka. transfer box) updates the download progress.}} | ||
==Parameters== | ==Parameters== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
float downloadedSizeTotal, float downloadTotalBytes | |||
</syntaxhighlight> | </syntaxhighlight> | ||
*'''downloadedSizeTotal:''' total progress in bytes | *'''downloadedSizeTotal:''' The total progress in bytes. | ||
*'''downloadTotalBytes:''' | *'''downloadTotalBytes:''' The total size of the download in bytes. | ||
==Source== | ==Source== | ||
| Line 14: | Line 14: | ||
==Example== | ==Example== | ||
This example will show the percentage of the download progress, whenever a resource is started: | |||
<syntaxhighlight lang="lua"> | |||
addEventHandler ("onClientTransferBoxProgressChange", root, function (downloadedSize, totalSize) | |||
local percentage = math.min ((downloadedSize / totalSize) * 100, 100) | |||
print (percentage .. "%") | |||
end) | |||
</syntaxhighlight> | |||
'''NOTE''': The code must be in a separated resource. It will be responsible to be watching other resources. | |||
==Requirements== | ==Requirements== | ||
{{Requirements||1.5.8-9.20788|}} | {{Requirements|n/a|1.5.8-9.20788|}} | ||
==See Also== | ==See Also== | ||
Latest revision as of 21:03, 23 September 2021
This event is triggered every time the resource file downloader (aka. transfer box) updates the download progress.
Parameters
float downloadedSizeTotal, float downloadTotalBytes
- downloadedSizeTotal: The total progress in bytes.
- downloadTotalBytes: The total size of the download 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:
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 | n/a |
|---|---|
| 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 client="1.5.8-9.20788" />
See Also
Client other events
- onClientChatMessage
- onClientConsole
- onClientDebugMessage
- onClientExplosion
- onClientFileDownloadComplete
- onClientHUDRender
- onClientMinimize
- onClientMTAFocusChange
- onClientPedsProcessed
- onClientPlayerNetworkStatus
- onClientPreRender
- onClientRender
- onClientRestore
- onClientTransferBoxProgressChange
- onClientTransferBoxVisibilityChange
- onClientWorldSound
Client event functions
Shared
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled