IsResourceProtected

From Multi Theft Auto: Wiki

BETA: FROM VERSION 1.5.7 r20468 ONWARDS

This will check if a resource is currently protected, as defined in mtaserver.conf.

Syntax

bool isResourceProtected(resource theResource)

OOP Syntax Help! I don't understand this!

Method: resource:isProtected(...)
Variable: .protected

Required Arguments

  • theResource: the resource to check

Returns

Returns true if the resource is 'protected', false otherwise.

Example

This example creates a command which allows you to check if the given resource with the name provided is protected. The command is "/isprotected [Resource Name]".

function resourceProtectedCommand(thePlayer, command, resourceName)
    if resourceName then -- If the player provided a resource name.
        local theResource = getResourceFromName(resourceName) -- Get the resource element.
        if theResource then -- If we have an element, the resource must exist.
            local protectedResource = isResourceProtected(theResource) -- Check to see if the resource is protected.
            if protectedResource then -- if it is protected.
                outputChatBox("This resource is a protected resource in the server config.", thePlayer, 0, 255, 0)
            else -- If the resource is not protected.
                outputChatBox("This resource is not a protected resource in the server config.", thePlayer, 0, 255, 0)
            end
        else -- A resource with the name didn't exist.
            outputChatBox("A resource with the name '" .. resourceName .. "' does not exist!", thePlayer, 255, 0, 0)
        end
    else -- The player didn't provide a resource name.
        outputChatBox("Please specify a resource name.", thePlayer, 255, 0, 0)
    end
end
addCommandHandler("isprotected", resourceProtectedCommand)

See Also

BETA: FROM VERSION 1.5.7 r20468 ONWARDS