Commands (SourceMod Scripting) - Revision history

Naleksuh: fix compile error

2020-04-29T16:26:40Z

fix compile error

Joinedsenses: Update formatting for readability and consistency

2020-03-30T01:21:33Z

Update formatting for readability and consistency

Show changes

Joinedsenses: Update highlighting

2020-03-29T23:57:52Z

Update highlighting

Show changes

Xerox8521: Replaced ServerCommand with KickClient

2018-09-05T14:14:22Z

Replaced ServerCommand with KickClient

Xerox8521: Replaced ServerCommand with KickClient

2018-09-05T14:13:38Z

Replaced ServerCommand with KickClient

Xerox8521: /* Creating Admin Commands */

2015-10-03T16:34:53Z

‎Creating Admin Commands

Xerox8521: /* Hooking Commands */

2015-10-03T16:33:41Z

‎Hooking Commands

Xerox8521: /* Hooking Commands */

2015-10-03T16:31:31Z

‎Hooking Commands

Dr. Jekyll: /* Console Commands */

2015-09-28T04:45:54Z

‎Console Commands

Xerox8521: Updated to 1.7 Syntax

2015-08-12T22:40:11Z

Updated to 1.7 Syntax

@@ Line 93: / Line 93: @@
      if (client)
+     {
-         PrintToServer("Command from client: %N", name);
+         PrintToServer("Command from client: %N", client);
+     }
      else

@@ Line 255: / Line 255: @@
+	}
-	ServerCommand("kickid %d", GetClientUserId(target));
+	KickClient(target);
 	return Plugin_Handled;

@@ Line 193: / Line 193: @@
+	}
-	ServerCommand("kickid %d", GetClientUserId(target));
+	KickClient(target);
 	return Plugin_Handled;

@@ Line 158: / Line 158: @@
 <pawn>public void OnPluginStart()
+{
-	RegAdminCmd("admin_kick",
+	RegAdminCmd("admin_kick", Command_Kick, ADMFLAG_KICK, "Kicks a player by name");
+}

@@ Line 120: / Line 120: @@
 *Argument #2: like
 *Argument #3: yams
 <pawn>ConVar ff = null;

@@ Line 127: / Line 127: @@
 public void OnPluginStart()
+{
 	ff = FindConVar("mp_friendlyfire");
+}
-public Action Command_Say(int client, const char[] command, int argc)
+public Action OnClientSayCommand(int client, const char[] command, const char[] sArgs)
+{
-	char text[192];
+	if (strcmp(sArgs, "ff", false) == 0)
+	{
 		if (ff != null)
@@ Line 159: / Line 139: @@
+			{
 				PrintToChat(client, "Friendly fire is enabled.");
 			} else {
 				PrintToChat(client, "Friendly fire is disabled.");
+			}
 			/* Block the client's messsage from broadcasting */
-			return Plugin_Handled;
+ 			return Plugin_Handled;
+		}
+	}
@@ Line 170: / Line 152: @@
 	return Plugin_Continue;
 }</pawn>
 ==Creating Admin Commands==

@@ Line 67: / Line 67: @@
 *<tt>Plugin_Handled</tt>: The original functionality of the command (if any) will be blocked.  If there was no functionality originally, this prevents clients from seeing "Unknown command" in their console.
 *<tt>Plugin_Stop</tt>: Same as <tt>Plugin_Handled</tt>, except that this will be the last hook called.
 Note that, unlike AMX Mod X, SourceMod does not allow you to register command filters.  I.e., there is no equivalent to this notation:
@@ Line 279: / Line 280: @@
 	return Plugin_Handled;
 }</pawn>
 =Client-Only Commands=

@@ Line 23: / Line 23: @@
 Let's say we want to add a test command to show how Half-Life 2 breaks down command arguments.  A possible implementation might be
 <pawn>
-public OnPluginStart()
+public void OnPluginStart()
+{
 	RegServerCmd("test_command", Command_Test);
+}
-public Action:Command_Test(args)
+public Action Command_Test(int args)
+{
-	new String:arg[128];
+	char arg[128];
-	new String:full[256];
+	char full[256];
 	GetCmdArgString(full, sizeof(full));
@@ Line 37: / Line 37: @@
 	PrintToServer("Argument string: %s", full);
 	PrintToServer("Argument count: %d", args);
-	for (new i=1; i<=args; i++)
+	for (int i=1; i<=args; i++)
+	{
 		GetCmdArg(i, arg, sizeof(arg));
@@ Line 49: / Line 49: @@
 Let's say we wanted to disable the "kickid" command on the server.  There's no real good reason to do this, but for example's sake:
 <pawn>
-public OnPluginStart()
+public void OnPluginStart()
+{
 	RegServerCmd("kickid", Command_KickId);
+}
-public Action:Command_Kickid(args)
+public Action Command_Kickid(int args)
+{
 	return Plugin_Handled;
@@ Line 76: / Line 76: @@
 Adding client commands is very simple.  Let's port our earlier testing command to display information about the client as well.
-<pawn>public OnPluginStart()
+<pawn>public void OnPluginStart()
+{
 	RegConsoleCmd("test_command", Command_Test);
+}
-public Action:Command_Test(client, args)
+public Action Command_Test(int client, int args)
+{
-	new String:arg[128];
+	char arg[128];
-	new String:full[256];
+	char full[256];
 	GetCmdArgString(full, sizeof(full));
@@ Line 97: / Line 97: @@
 	PrintToServer("Argument string: %s", full);
 	PrintToServer("Argument count: %d", args);
-	for (new i=1; i<=args; i++)
+	for (int i=1; i<=args; i++)
+	{
 		GetCmdArg(i, arg, sizeof(arg));
@@ Line 122: / Line 122: @@
 Thus, to take into account both of these situations, we are going to use <tt>GetCmdArgString</tt> and manually parse the input.
-<pawn>new Handle:ff = INVALID_HANDLE;
+<pawn>ConVar ff = null;
-public OnPluginStart()
+public void OnPluginStart()
+{
 	AddCommandListener(Command_Say, "say");
@@ Line 133: / Line 133: @@
+}
-public Action:Command_Say(client, const String:command[], argc)
+public Action Command_Say(int client, const char[] command, int argc)
+{
-	decl String:text[192];
+	char text[192];
-	new startidx = 0;
+	int startidx = 0;
 	if (GetCmdArgString(text, sizeof(text)) < 1)
+	{
@@ Line 153: / Line 153: @@
 	if (strcmp(text[startidx], "ff", false) == 0)
+	{
-		if (ff != INVALID_HANDLE)
+		if (ff != null)
+		{
-			if (GetConVarBool(ff))
+			if (ff.BoolValue)
+			{
 				PrintToChat(client, "Friendly fire is enabled.");
@@ Line 173: / Line 173: @@
 Let's create a simple admin command which kicks another player by their full name.
-<pawn>public OnPluginStart()
+<pawn>public void OnPluginStart()
+{
 	RegAdminCmd("admin_kick",
@@ Line 181: / Line 181: @@
+}
-public Action:Command_Kick(client, args)
+public Action Command_Kick(int client, int args)
+{
 	if (args < 1)
@@ Line 189: / Line 189: @@
+	}
-	new String:name[32], target = -1;
+	char name[32];
 	GetCmdArg(1, name, sizeof(name));
-	for (new i=1; i<=MaxClients; i++)
+	for (int i=1; i<=MaxClients; i++)
+	{
 		if (!IsClientConnected(i))
@@ Line 198: / Line 199: @@
 			continue;
+		}
-		decl String:other[32];
+		char other[32];
 		GetClientName(i, other, sizeof(other));
 		if (StrEqual(name, other))
@@ Line 236: / Line 237: @@
 So, how can we adapt our function about to use immunity?
-<pawn>public Action:Command_Kick(client, args)
+<pawn>public Action Command_Kick(int client, int args)
+{
 	if (args < 1)
@@ Line 244: / Line 245: @@
+	}
-	new String:name[32], target = -1;
+	char name[32];
 	GetCmdArg(1, name, sizeof(name));
-	for (new i=1; i<=MaxClients; i++)
+	for (int i=1; i<=MaxClients; i++)
+	{
 		if (!IsClientConnected(i))
@@ Line 253: / Line 255: @@
 			continue;
+		}
-		decl String:other[32];
+		char other[32];
 		GetClientName(i, other, sizeof(other));
 		if (StrEqual(name, other))
@@ Line 282: / Line 284: @@
 SourceMod exposes a forward that is called whenever a client executes any command string in their console, called <tt>OnClientCommand</tt>.  An example of this looks like:
-<pawn>public Action:OnClientCommand(client, args)
+<pawn>public Action OnClientCommand(int client, int args)
+{
-	new String:cmd[16];
+	char cmd[16];
 	GetCmdArg(0, cmd, sizeof(cmd));	/* Get command name */