OnClientResourceFileDownload: Difference between revisions
Jump to navigation
Jump to search
(Created page with "__NOTOC__ {{Client event}} {{New feature/item|3.0160|1.5.8|20788|This event is triggered every time a resource file download is queued, finished or has failed.}} {{Warning|T...") |
Fernando187 (talk | contribs) (Remove obsolete Requirements section) |
||
| (10 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client event}} | {{Client event}} | ||
{{ | {{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}} | ||
==Parameters== | ==Parameters== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
resource fileResource, string fileName, | resource fileResource, string fileName, int fileSize, string state | ||
</syntaxhighlight> | </syntaxhighlight> | ||
*'''fileResource:''' | *'''fileResource:''' [[Resource]] the file belongs to. | ||
*'''fileName:''' | *'''fileName:''' Relative [[resource]] file path. | ||
*'''fileSize:''' | *'''fileSize:''' Size of the file in bytes. | ||
*'''state:''' | *'''state:''' Possible values: <code>"queued"</code> or <code>"finished"</code> or <code>"failed"</code>. | ||
==Source== | ==Source== | ||
| Line 18: | Line 17: | ||
==Example== | ==Example== | ||
This example will output the file's resource name/file name/size/state when downloading: | |||
<syntaxhighlight lang="lua"> | |||
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) | |||
</syntaxhighlight> | |||
==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.
|
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
- triggerLatentServerEvent
- triggerServerEvent
- Shared
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled