OnClientResourceFileDownload: Difference between revisions

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


==Example==
==Example==
{{Needs_Example}}
This example will output the file's resource name/file name/size/state when downloading
function writeMsg (name,size,state)
<syntaxhighlight lang="lua">
 
function writeMsg(resourceName, fileName, fileSize, fileState)
outputChatBox("resource "..name.." downloading...",0,200,0)
    outputChatBox("Resource name: "..resourceName..", file name: "..fileName..", size: "..fileSize..", state: "..fileState)
 
end
end
addEventHandler("OnClientResourceFileDownload", root, writeMsg)
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.

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