OnClientResourceFileDownload: Difference between revisions
Jump to navigation
Jump to search
Line 18: | Line 18: | ||
==Example== | ==Example== | ||
This example will output the file's resource name/file name/size/state when downloading | |||
function writeMsg ( | <syntaxhighlight lang="lua"> | ||
function writeMsg(resourceName, fileName, fileSize, fileState) | |||
outputChatBox(" | outputChatBox("Resource name: "..resourceName..", file name: "..fileName..", size: "..fileSize..", state: "..fileState) | ||
end | end | ||
addEventHandler(" | addEventHandler("onClientResourceFileDownload", root, writeMsg) | ||
</syntaxhighlight> | |||
==Requirements== | ==Requirements== |
Revision as of 09:06, 15 February 2021
This event is triggered every time a resource file download is queued, finished or has failed.
Warning: This event is NOT related to downloadFile and onClientFileDownloadComplete! | |
Parameters
resource fileResource, string fileName, number fileSize, string state
- fileResource: resource the file belongs to
- fileName: relative resource file path
- fileSize: size of the file in bytes
- state: possible values:
"queued"
or"finished"
or"failed"
Source
The source of this event is the resource's root element.
Example
This example will output the file's resource name/file name/size/state when downloading
function writeMsg(resourceName, fileName, fileSize, fileState) outputChatBox("Resource name: "..resourceName..", file name: "..fileName..", size: "..fileSize..", state: "..fileState) end addEventHandler("onClientResourceFileDownload", root, writeMsg)
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 resource events
Client event functions
Shared
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled