StopResource

From Multi Theft Auto: Wiki
Revision as of 03:28, 5 January 2008 by ChrML (talk | contribs)
Jump to navigation Jump to search

This function stops a running resource.
Note: This function does not stop the resource immediately, so don't expect that it starts stopping until onResourceStop for that resource is called. This happens after the scripts are done executing for this server frame.

Syntax

bool stopResource ( resource theResource )

Required Arguments

  • theResource: the resource that should be stopped.

Returns

Returns true if the resource was stopped, false if the stopping failed, or an invalid resource was passed.

Example

This function stops all running resources except the current one.

function stopAllResources()
    -- we store a table of resources
    local allResources = getResources()
    -- for each one of them,
    for i, resource in ipairs(allResources) do
        -- if it's running, and it is not the current resource
        if ( getResourceState(resource) == "running" ) and ( resource ~= getThisResource() ) then
            -- then stop it
            stopResource(resource)
        end
    end
end

See Also