OnClientResourceFileDownload: Difference between revisions
Jump to navigation
Jump to search
mNo 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.}} | ||
{{Warning|This event is '''NOT''' related to [[downloadFile]] and [[onClientFileDownloadComplete]]!|true}} | {{Warning|This event is '''NOT''' related to [[downloadFile]] and [[onClientFileDownloadComplete]]!|true}} | ||
Line 9: | Line 9: | ||
resource fileResource, string fileName, number fileSize, string state | resource fileResource, string fileName, number 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 18: | ||
==Example== | ==Example== | ||
This example will output the file's resource name/file name/size/state when downloading | This example will output the file's resource name/file name/size/state when downloading: | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function writeMsg(resourceName, fileName, fileSize, fileState) | function writeMsg (resourceName, fileName, fileSize, fileState) | ||
outputChatBox("Resource name: "..resourceName..", file name: "..fileName..", size: "..fileSize..", state: "..fileState) | outputChatBox ("Resource name: "..resourceName..", file name: "..fileName..", size: "..fileSize..", state: "..fileState) | ||
end | end | ||
addEventHandler("onClientResourceFileDownload", root, writeMsg) | |||
addEventHandler ("onClientResourceFileDownload", root, writeMsg) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==Requirements== | ==Requirements== | ||
{{Requirements||1.5.8-9.20788|}} | {{Requirements|n/a|1.5.8-9.20788|}} | ||
==See Also== | ==See Also== |
Revision as of 12:56, 23 September 2021
20788
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
- triggerLatentServerEvent
- triggerServerEvent
- Shared
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled