AbortRemoteRequest: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Fix the example - make the description match what the code actually does..)
(Undo revision 67561 by Pirulax (talk))
Tag: Undo
Line 19: Line 19:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function CMD_abortRequests()
function CMD_abortRequests()
     local requests = getRemoteRequests(getThisResource())
     local requests = getRemoteRequests()
     for _, request in ipairs(requests) do
     for _, request in ipairs(requests) do

Revision as of 21:24, 16 October 2020

Aborts a fetchRemote or callRemote request.

Syntax

bool abortRemoteRequest( request theRequest )

Required Arguments

Returns

Returns true on success, false when invalid request was provided

Example

this example aborts all pending requests of currently running resource. 

function CMD_abortRequests()
    local requests = getRemoteRequests()
	
    for _, request in ipairs(requests) do
        abortRemoteRequest(request)
    end
end

addCommandHandler("abortrequests", CMD_abortRequests)
Minimum server version 1.5.7-9.20307
Minimum client version 1.5.7-9.20307

Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version server="1.5.7-9.20307" client="1.5.7-9.20307" />

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/AbortRemoteRequest?oldid=67562"