OnClientFileDownloadComplete: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "my test example until I get a chance to document properly <syntaxhighlight lang="lua"> function onStart ( ) outputChatBox ( "downloading test.mp3" ) downloadFile ( "test.mp3" ) end addEventH...")
 
 
(16 intermediate revisions by 7 users not shown)
Line 1: Line 1:
my test example until I get a chance to document properly
{{Client event}}
{{New items|3.0140|1.4|
__NOTOC__
This event is triggered when a file has been downloaded after [[downloadFile]] has been successfully called.
}}
==Parameters==
<syntaxhighlight lang="lua">
string fileName, bool success, resource requestResource
</syntaxhighlight>
 
*'''fileName''': the file downloaded.
*'''success''': whether successful or not.
{{New items|4.0157|1.5.7-20468|
*'''requestResource''': the resource that called [[downloadFile]].
}}
 
==Source==
The [[event system#Event source|source]] of this event is the [[root element]] of the resource that downloaded file.


==Example==
This example plays a sound if it was downloaded successfully
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function onStart ( )
outputChatBox ( "downloading test.mp3" )
downloadFile ( "test.mp3" )
end
addEventHandler ( "onClientResourceStart", getRootElement(), onStart )
function onDownloadFinish ( file, success )
function onDownloadFinish ( file, success )
if ( success ) then
    if ( source == resourceRoot ) then                            -- if the file relates to this resource
if ( file == "test.mp3" ) then
        if ( success ) then                                       -- if the file was downloaded successfully
outputChatBox ( "test.mp3 downloaded successfully" )
            if ( file == "test.mp3" ) then                       -- if the file name is what we were expecting
playSound ( "test.mp3" )
                currentTrack = playSound ( "test.mp3" )
outputChatBox ( "playing test.mp3" )
            end
end
        else                                                     -- if the file wasn't downloaded successfully
else
            if ( file == "test.mp3" ) then
if ( file == "test.mp3" ) then
                outputChatBox ( "test.mp3 failed to download" )
outputChatBox ( "test.mp3 failed to download" )
            end
end
        end
end
    end
end
end
addEventHandler ( "onFileDownloadComplete", getRootElement(), onDownloadFinish )
addEventHandler ( "onClientFileDownloadComplete", root, onDownloadFinish )
</syntaxhighlight>
</syntaxhighlight>
==See Also==
===Other client events===
{{Client_other_events}}
===Client event functions===
{{Client_event_functions}}

Latest revision as of 18:46, 24 April 2020

This event is triggered when a file has been downloaded after downloadFile has been successfully called.

Parameters

string fileName, bool success, resource requestResource
  • fileName: the file downloaded.
  • success: whether successful or not.
ADDED/UPDATED IN VERSION 1.5.7-20468 :

Source

The source of this event is the root element of the resource that downloaded file.

Example

This example plays a sound if it was downloaded successfully 

function onDownloadFinish ( file, success )
    if ( source == resourceRoot ) then                            -- if the file relates to this resource
        if ( success ) then                                       -- if the file was downloaded successfully
            if ( file == "test.mp3" ) then                        -- if the file name is what we were expecting
                currentTrack = playSound ( "test.mp3" )
            end
        else                                                      -- if the file wasn't downloaded successfully
            if ( file == "test.mp3" ) then
                outputChatBox ( "test.mp3 failed to download" )
            end
        end
    end
end
addEventHandler ( "onClientFileDownloadComplete", root, onDownloadFinish )

See Also

Other client events


Client event functions


Retrieved from "https://wiki.multitheftauto.com/wiki/OnClientFileDownloadComplete?oldid=65990"