OnClientResourceFileDownload: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Fix error with code ( the first parameter was used as resource name ))
(Remove obsolete Requirements section)
 
(2 intermediate revisions by one other user not shown)
Line 6: Line 6:
==Parameters==
==Parameters==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
resource fileResource, string fileName, number fileSize, string state
resource fileResource, string fileName, int fileSize, string state
</syntaxhighlight>
</syntaxhighlight>
*'''fileResource:''' [[Resource]] the file belongs to.
*'''fileResource:''' [[Resource]] the file belongs to.
Line 26: Line 26:
addEventHandler ("onClientResourceFileDownload", root, writeMsg)
addEventHandler ("onClientResourceFileDownload", root, writeMsg)
</syntaxhighlight>
</syntaxhighlight>
==Requirements==
{{Requirements|n/a|1.5.8-9.20788|}}


==See Also==
==See Also==

Latest revision as of 17:26, 7 November 2024

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, 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)

See Also

Client resource events


Client event functions