OnClientResourceFileDownload

From Multi Theft Auto: Wiki
Jump to navigation Jump to search

BETA: FROM VERSION 1.5.8 r20788 ONWARDS
This event is triggered every time a resource file download is queued, finished or has failed.


Dialog-warning.png 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 supported server
Minimum supported client 1.5.8-9.20788

Note: Using this function/event 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

BETA: FROM VERSION 1.5.8 r20788 ONWARDS

Client event functions