OnClientResourceFileDownload: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client event}}  
{{Client event}}  
{{Added feature/item|3.0160|1.5.9|1.5.8|20788|This event is triggered every time a [[resource]] file download is queued, finished or has failed.}}
{{Added feature/item|1.5.9|1.5.8|20788|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]]!|true}}
{{Warning|This event is '''NOT''' related to [[downloadFile]] and [[onClientFileDownloadComplete]]!|true}}



Revision as of 21:02, 23 September 2021

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

This template will be deleted.

See Also

Client resource events


Client event functions