Skip to content

Latest commit

 

History

History
145 lines (127 loc) · 3.49 KB

README.md

File metadata and controls

145 lines (127 loc) · 3.49 KB
Raw

Pawn.CMD

🚀 Plugin-powered command processor for SA:MP server

Natives

native PC_RegAlias(const cmd[], const alias[], ...);
native PC_SetFlags(const cmd[], flags);
native PC_GetFlags(const cmd[]);
native PC_RenameCommand(const cmd[], const newname[]);
native PC_CommandExists(const cmd[]);
native PC_DeleteCommand(const cmd[]);

native CmdArray:PC_GetCommandArray();
native CmdArray:PC_GetAliasArray(const cmd[]);
native PC_GetArraySize(CmdArray:arr);
native PC_GetCommandName(CmdArray:arr, index, dest[], size = sizeof dest);
native PC_FreeArray(&CmdArray:arr);

native PC_EmulateCommand(playerid, const cmdtext[]);

Callbacks

forward PC_OnInit();
forward OnPlayerCommandReceived(playerid, cmd[], params[], flags);
forward OnPlayerCommandPerformed(playerid, cmd[], params[], result, flags);

How to install

Extract archive in server folder. Update your server.cfg

  • Windows
plugins pawncmd.dll
  • Linux
plugins pawncmd.so

Configuration (pawncmd.cfg in plugins folder)

The values in parentheses are default values

  • CaseInsensitivity (true)
  • LegacyOpctSupport (true)
  • LocaleName ("C")
  • UseCaching (true)
  • LogAmxErrors (true)

Example command

#include <Pawn.CMD>

cmd:help(playerid, params[]) // you can also use 'CMD' or 'COMMAND' instead of 'cmd'
{
  // code here
  return 1;
}

Registering aliases

You can register aliases for a command

#include <Pawn.CMD>

cmd:help(playerid, params[])
{
  // code here
  return 1;
}
alias:help("commands", "cmds")

Using flags

You can set flags for a command

#include <Pawn.CMD>

enum (<<= 1)
{
  CMD_ADMIN = 1, // 0b00000000000000000000000000000001
  CMD_MODER,     // 0b00000000000000000000000000000010
  CMD_JR_MODER   // 0b00000000000000000000000000000100
};

new pPermissions[MAX_PLAYERS];

flags:ban(CMD_ADMIN)
cmd:ban(playerid, params[])
{
  // code here
  return 1;
}
alias:ban("block")

flags:kick(CMD_ADMIN | CMD_MODER)
cmd:kick(playerid, params[])
{
  // code here
  return 1;
}

flags:jail(CMD_ADMIN | CMD_MODER | CMD_JR_MODER)
cmd:jail(playerid, params[])
{
  // code here
  return 1;
}

public OnPlayerCommandReceived(playerid, cmd[], params[], flags)
{
  if (!(flags & pPermissions[playerid]))
  {
    printf("player %d doesn’t have access to command '%s'", playerid, cmd);

    return 0;
  }

  return 1;
}

public OnPlayerCommandPerformed(playerid, cmd[], params[], result, flags)
{
  if (result == -1)
  {
    SendClientMessage(playerid, 0xFFFFFFFF, "SERVER: Unknown command.");

    return 0;
  }

  return 1;
}

public PC_OnInit()
{
  const testAdminPlayerId = 1, testModerPlayerId = 2, testJrModerPlayerId = 3, testSimplePlayerId = 4;

  pPermissions[testAdminPlayerId] = CMD_ADMIN | CMD_MODER | CMD_JR_MODER;
  pPermissions[testModerPlayerId] = CMD_MODER | CMD_JR_MODER;
  pPermissions[testJrModerPlayerId] = CMD_JR_MODER;
  pPermissions[testSimplePlayerId] = 0;

  PC_EmulateCommand(testAdminPlayerId, "/ban 4 some reason"); // ok
  PC_EmulateCommand(testModerPlayerId, "/ban 8 some reason"); // not ok, moder doesn’t have access to 'ban'
  PC_EmulateCommand(testModerPlayerId, "/kick 15 some reason"); // ok
  PC_EmulateCommand(testModerPlayerId, "/jail 16 some reason"); // ok, moder can use commands of junior moderator
  PC_EmulateCommand(testJrModerPlayerId, "/jail 23 some reason"); // ok
  PC_EmulateCommand(testSimplePlayerId, "/ban 42 some reason"); // not ok
}
If you want to use Pawn.CMD in a filterscript, put this define before including:
#define FILTERSCRIPT