SA-MP Forums

SA-MP Forums (https://forum.sa-mp.com/index.php)
-   Includes (https://forum.sa-mp.com/forumdisplay.php?f=83)
-   -   [Include] [INC] zcmd 0.3.1 | Fast & Simple Command Processor (updated 30/10/2009) (https://forum.sa-mp.com/showthread.php?t=91354)

Zeex 14/08/2009 12:59 PM

[INC] zcmd 0.3.1 | Fast & Simple Command Processor (updated 30/10/2009)
 
Description

This is just a little include that uses OnPlayerCommandText() to process players' commands. Each command has a separate function like in dcmd, but zcmd calls them directly via CallLocalFunction(). Such method is much faster than when you successively compare the text player entered to each command you have in your script (especially if he send a nonexistent cmd, you pass though all then) and its superiority over the old way is proportional to the number of commands. I did a speed test when I've just statrted thinking about this approach, you can find its results here.


Usage

All you need to add a command is just make a public function using special pre-defined macro, like this:

pawn Code:
COMMAND:mycommand(playerid, params[]) // or CMD:mycommand(playerid, params[])
{
  // Do something
  return 1;
}

or (old style):

pawn Code:
command(mycommand, playerid, params[]) // or cmd(mycommand, playerid, params[])
{
  // Do something
  return 1;
}

Here params[] is the parameters string, playerid is an ID of the player who send this command.
That's all! Very easy, isn't it?


Important: Since v0.3 OnPlayerCommandText cannot be used anymore (also ZCMD_NO_CALLBACK option has been removed), but there are two new callbacks instead:

pawn Code:
OnPlayerCommandReceived(playerid, cmdtext[])

This one is called when someone sends a command. If you return 0 here, the command won't be performed.

pawn Code:
OnPlayerCommandPerformed(playerid, cmdtext[], success)

And this one gets called after command execution, here if you do "return 0" the player will see standard "Unknown command" message. The "success" parameter is equal to value returned by command function returns (if it doesn't exist success will be 0).

Note that it's not necessary to add these callbacks to your script if you don't use them.


How to make two different commands doing the same thing

For example, you have /something cmd:

pawn Code:
COMMAND:something(playerid, params[])
{
  // some stuff here
  return 1;
}

and you want to create another one such as /another that does what /something does. The simpliest way of doing that is:

pawn Code:
COMMAND:another(playerid, params[])
{
  return cmd_something(playerid, params);
}


Note #1: If you want to use zcmd in a filterscript, put this define before including:

pawn Code:
#define FILTERSCRIPT

Note #2: If you want to check whether parameters string is empty you should not do it like:

pawn Code:
if (!strlen(params))
{
  // no parameters
}

or :

pawn Code:
if (!params[0])

because its length is never null (read more here), simply use isnull() included into zcmd:

pawn Code:
if (isnull(params))
Actually, if you use sscanf you don't need to do this as it has built-in isnull checking.

Here is an example of how you can make /givemoney command using zcmd with sscanf:

pawn Code:
COMMAND:givemoney(playerid, params[])
{
    if (IsPlayerAdmin(playerid))
    {
        new
          toplayerid, // the player we want to give money to
          amount;
        // extracting player's ID and amount from params
        if (!sscanf(params, "ii", toplayerid, amount))
        {
          if (toplayerid != INVALID_PLAYER_ID)
          {
            new
              message[40];
            GivePlayerMoney(toplayerid, amount);
            format(message, sizeof(message), "You got $%d from admin!", amount);
            SendClientMessage(toplayerid, 0x00FF00FF, message);
          }
          else SendClientMessage(playerid, 0xFF0000FF, "That player is not connected");
        }
        else SendClientMessage(playerid, 0xFFFFFFFF, "Usage: /givemoney <playerid> <amount>");
    }
    else SendClientMessage(playerid, 0xFF0000FF, "Only admins can use this command!");
    return 1;
}

Download


Special thanks to:
- ******

MatrixBoY 14/08/2009 01:13 PM

Re: [INC] zcmd - simple command system
 
nice work, this good for newbie pawners :)

nuriel8833 14/08/2009 01:15 PM

Re: [INC] zcmd - simple command system
 
Great job :)

Zeex 14/08/2009 01:18 PM

Re: [INC] zcmd - simple command system
 
Thanks :)

Agent_Smith 14/08/2009 01:36 PM

Re: [INC] zcmd - simple command system
 
Good for new scripters

.::: Ecko :::. 14/08/2009 09:23 PM

Re: [INC] zcmd - simple command system
 
This is some kind,similar to dcmd,isn't it?!
Anyway,nice work.

Ecko

Zeex 15/08/2009 03:15 AM

Re: [INC] zcmd - simple command system [updated]
 
Updated! Current version is 0.2

Quote:

Originally Posted by .::: [E
Ecko :::. ]
This is some kind,similar to dcmd,isn't it?!

Maybe they are similar, but zcmd works much faster.

Gappy 15/08/2009 04:53 AM

Re: [INC] zcmd - simple command system [updated]
 
nvm I worked it out.

Gappy 15/08/2009 06:11 AM

Re: [INC] zcmd - simple command system [updated]
 
Sorry for double post, I have a new problem. This is my code:

pawn Code:
zcmd(setrank, playerid, params[])
{
  new string[128];
    new idx;
    new tmp[256];
    new sendername[MAX_PLAYER_NAME];
    new giveplayername[MAX_PLAYER_NAME];
   
  if (AccountInfo[playerid][AdminLevel] >= 3 || IsPlayerAdmin(playerid))
    {
        tmp = strtok(params, idx);
        if(isnull(tmp))
        {
            SendClientMessage(playerid, COLOR_WHITE, "USAGE: /giverank [playername/id] [rank 1-8]");
            SendClientMessage(playerid, COLOR_WHITE, "FUNCTION: Will give selected player selective rank.");
            return 1;
        }
        new giveplayerid = ReturnUser(tmp, playerid);
        new rank = strval(tmp);
        if(giveplayerid != INVALID_PLAYER_ID)
        {
          if ((rank >= 1) && (rank <= 8))
          {
                GetPlayerName(giveplayerid, giveplayername, sizeof(giveplayername));
                GetPlayerName(playerid, sendername, sizeof(sendername));
                printf("ADMIN: %s gave %s rank %s.", sendername, giveplayername, RankNames[rank-1]);
                format(string, sizeof(string), "Admin %s has set your rank to %s.", sendername, RankNames[rank-1]);
                SendClientMessage(giveplayerid, COLOR_LIGHTBLUE, string);
                format(string, sizeof(string), "ADMIN: Administrator %s has given %s rank %s.", sendername,giveplayername,RankNames[rank-1]);
                SendClientMessageToAll(COLOR_LIGHTRED, string);
                AccountInfo[giveplayerid][Rank] = rank-1;
                format(string, sizeof(string), "You have given %s rank %s.", giveplayername,RankNames[AccountInfo[giveplayerid][Rank]]);
                SendClientMessage(playerid, COLOR_LIGHTBLUE, string);
            }
            else return SendClientMessage(playerid, COLOR_RED, "Invalid Rank!");
        }
    }
    else SendClientMessage(playerid, COLOR_GREY, "You are not authorized to use that command!");
    return 1;
}

It compiles fine and all, but when I use the command it always returns rank as 0. If I type /setrank 0 5 it would say "Invalid Rank".

Zeex 15/08/2009 06:25 AM

Re: [INC] zcmd - simple command system [updated]
 
I think you placed first else statement where "Invalid rank" message is sent not to where it should be and also strtok should be called for rank too.
Try this:
pawn Code:
zcmd(setrank, playerid, params[])
{
  new string[128];
    new idx;
    new tmp[256];
    new sendername[MAX_PLAYER_NAME];
    new giveplayername[MAX_PLAYER_NAME];

  if (AccountInfo[playerid][AdminLevel] >= 3 || IsPlayerAdmin(playerid))
    {
        tmp = strtok(params, idx);
        if(isnull(tmp))
        {
            SendClientMessage(playerid, COLOR_WHITE, "USAGE: /giverank [playername/id] [rank 1-8]");
            SendClientMessage(playerid, COLOR_WHITE, "FUNCTION: Will give selected player selective rank.");
            return 1;
        }
        new giveplayerid = ReturnUser(tmp, playerid);
        new rank = strval(strtok(params, idx));
        if(giveplayerid != INVALID_PLAYER_ID)
        {
          if ((rank >= 1) && (rank <= 8))
          {
                GetPlayerName(giveplayerid, giveplayername, sizeof(giveplayername));
                GetPlayerName(playerid, sendername, sizeof(sendername));
                printf("ADMIN: %s gave %s rank %s.", sendername, giveplayername, RankNames[rank-1]);
                format(string, sizeof(string), "Admin %s has set your rank to %s.", sendername, RankNames[rank-1]);
                SendClientMessage(giveplayerid, COLOR_LIGHTBLUE, string);
                format(string, sizeof(string), "ADMIN: Administrator %s has given %s rank %s.", sendername,giveplayername,RankNames[rank-1]);
                SendClientMessageToAll(COLOR_LIGHTRED, string);
                AccountInfo[giveplayerid][Rank] = rank-1;
                format(string, sizeof(string), "You have given %s rank %s.", giveplayername,RankNames[AccountInfo[giveplayerid][Rank]]);
                SendClientMessage(playerid, COLOR_LIGHTBLUE, string);
            }
        }
        else return SendClientMessage(playerid, COLOR_RED, "Invalid Rank!");
    }
    else SendClientMessage(playerid, COLOR_GREY, "You are not authorized to use that command!");
    return 1;
}
#else


All times are GMT. The time now is 06:55 PM.

Powered by vBulletin® Version 3.8.6
Copyright ©2000 - 2020, Jelsoft Enterprises Ltd.