SqMod/bin/demo/cmd.nut

/* --------------------------------------------------------------------------------------------------------------------
 * We need a command manager to be able to create and manage commands.
 * We also store it in the root table to make it accessible in other scripts.
*/
g_Cmd <- SqCmd.Manager();
/* --------------------------------------------------------------------------------------------------------------------
 * This is our global function we give to the command manager to tell whether someone is allowed
 * or not to execute a certain function. If this function returns false, the command is ignored
*/
g_Cmd.BindAuth(this, function(player, command) {
    // I guess we can use the default authority level to make the decision :/
    return (player.Authority >= command.Authority);
});
/* --------------------------------------------------------------------------------------------------------------------
 * General purpose error handler for a command manager.
 * Otherwise the player doesn't know why a command failed.
*/
g_Cmd.BindFail(this, function(type, msg, payload) {
    // Retrieve the player that executed the command
    local player = g_Cmd.Invoker;
    // See if the invoker even exists
    if (!player || typeof(player) != "SqPlayer") {
        return; // No one to report!
    }
    // Let players know how to get in contact with the owner
    local contact = SqCore.GetOptionOr("OwnerContact", "no.email@to.me");
    // Identify the error type
    switch (type) {
        // The command failed for unknown reasons
        case SqCmdErr.Unknown: {
            player.Message("Unable to execute the command for reasons unknown");
            player.Message("=> Please contact the owner: %s", contact);
        } break;
        // The command failed to execute because there was nothing to execute
        case SqCmdErr.EmptyCommand: {
            player.Message("Cannot execute an empty command");
        } break;
        // The command failed to execute because the command name was invalid after processing
        case SqCmdErr.InvalidCommand: {
            player.Message("The specified command name is invalid");
        } break;
        // The command failed to execute because there was a syntax error in the arguments
        case SqCmdErr.SyntaxError: {
            player.Message("There was a syntax error in argument: %d", payload);
        } break;
        // The command failed to execute because there was no such command
        case SqCmdErr.UnknownCommand: {
            player.Message("The specified command does no exist");
        } break;
        // The command failed to execute because the it's currently suspended
        case SqCmdErr.ListenerSuspended: {
            player.Message("The requested command is currently suspended");
        } break;
        // The command failed to execute because the invoker does not have the proper authority
        case SqCmdErr.InsufficientAuth: {
            player.Message("You don't have the proper authority to execute this command");
        } break;
        // The command failed to execute because there was no callback to handle the execution
        case SqCmdErr.MissingExecuter: {
            player.Message("The specified command is not being processed");
        } break;
        // The command was unable to execute because the argument limit was not reached
        case SqCmdErr.IncompleteArgs: {
            player.Message("The specified command requires at least %d arguments", payload);
        } break;
        // The command was unable to execute because the argument limit was exceeded
        case SqCmdErr.ExtraneousArgs: {
            player.Message("The specified command requires no more than %d arguments", payload);
        } break;
        // Command was unable to execute due to argument type mismatch
        case SqCmdErr.UnsupportedArg: {
            player.Message("Argument %d requires a different type than the one you specified", payload);
        } break;
        // The command arguments contained more data than the internal buffer can handle
        case SqCmdErr.BufferOverflow: {
            player.Message("An internal error occurred and the execution was aborted");
            player.Message("=> Please contact the owner: %s", contact);
        } break;
        // The command failed to complete execution due to a runtime exception
        case SqCmdErr.ExecutionFailed: {
            player.Message("The command failed to complete the execution properly");
            player.Message("=> Please contact the owner: %s", contact);
        } break;
        // The command completed the execution but returned a negative result
        case SqCmdErr.ExecutionAborted: {
            player.Message("The command execution was aborted and therefore had no effect");
        } break;
        // The post execution callback failed to execute due to a runtime exception
        case SqCmdErr.PostProcessingFailed: {
            player.Message("The command post-processing stage failed to complete properly");
            player.Message("=> Please contact the owner: %s", contact);
        } break;
        // The callback that was supposed to deal with the failure also failed due to a runtime exception
        case SqCmdErr.UnresolvedFailure: {
            player.Message("Unable to resolve the failures during command execution");
            player.Message("=> Please contact the owner: %s", contact);
        } break;
        // Something bad happened and no one knows what
        default: {
            SqLog.Inf("Command failed to execute because [%s][%s]", msg, ""+payload);
        }
    }
});