OnClientResourceFileDownload
Jump to navigation
Jump to search
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, int 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 (fileResource, fileName, fileSize, state) local resourceName = getResourceName( fileResource ) outputChatBox ( "Resource name: " .. resourceName .. ", file name: " .. fileName .. ", size: " .. fileSize .. ", state: " .. state) end addEventHandler ("onClientResourceFileDownload", root, writeMsg)
Requirements
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 resource events
Client event functions
- triggerLatentServerEvent
- triggerServerEvent
- Shared
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled