Scripting FAQ (SourceMod) - Revision history

Nosoop: /* How do I learn SourcePawn? */ Remove underscores from cross-page link

2023-03-23T15:45:07Z

‎How do I learn SourcePawn?: Remove underscores from cross-page link

Fyren: /* Where can I find all the SourcePawn functions and other information? */ swap IRC link to Discord

2022-03-06T12:33:24Z

‎Where can I find all the SourcePawn functions and other information?: swap IRC link to Discord

Nosoop: Add info on RGB colors

2018-02-26T11:12:53Z

Add info on RGB colors

Xerox8521: Updated API Links from "old" to "new"

2017-08-18T02:40:51Z

Updated API Links from "old" to "new"

Xerox8521: /* Why is Source telling me my command is an "Unknown command"? */

2016-02-16T21:22:22Z

‎Why is Source telling me my command is an "Unknown command"?

Xerox8521: /* Color Libraries */

2016-02-16T21:22:02Z

‎Color Libraries

Xerox8521: /* How do I add color to my messages? */

2016-02-16T21:21:17Z

‎How do I add color to my messages?

Xerox8521: /* How do I get rid of tag mismatch warnings? */

2016-02-16T21:20:41Z

‎How do I get rid of tag mismatch warnings?

Xerox8521: /* Where can I find all the SourcePawn functions and other information? */

2016-02-16T21:16:17Z

‎Where can I find all the SourcePawn functions and other information?

Xerox8521: /* How do I learn SourcePawn? */

2016-02-16T21:14:34Z

‎How do I learn SourcePawn?

@@ Line 3: / Line 3: @@
 =How do I learn SourcePawn?=
-A good start is on the [[Introduction_to_SourcePawn_1.7]] page, which will teach you the SourcePawn language. Then go through the [[Introduction to SourceMod Plugins]], which will teach you how to write your first plug-in.
+A good start is on the [[Introduction to SourcePawn 1.7]] page, which will teach you the SourcePawn language. Then go through the [[Introduction to SourceMod Plugins]], which will teach you how to write your first plug-in.
 =Where can I find all the SourcePawn functions and other information?=

@@ Line 14: / Line 14: @@
 But searching through all those files can be quite tedious. Thankfully, the honourable [https://forums.alliedmods.net/member.php?u=9443 Nican] created an API reference viewable on the web, complete with searching and commenting: [https://sm.alliedmods.net/new-api/ https://sm.alliedmods.net/new-api/]
-Also, if you are in the SourceMod IRC channel ([irc://irc.gamesurge.net/sourcemod #sourcemod on GameSurge]), you can use the <tt>!api</tt> command to search [https://forums.alliedmods.net/member.php?u=9443 Nican's] API reference:
+Also, if you are in the AlliedMods Discord server (https://discord.gg/HUc67zN), you can use the <tt>/docs</tt> command to search the API.
 =How do I find the classname of an entity? (e.g., "<tt>weapon_knife</tt>" or "<tt>prop_physics</tt>")=

← Older revision		Revision as of 11:12, 26 February 2018
Line 136:		Line 136:

	There's another catch, however: this is only known to work in CS:S and TF2. For other mods, your mileage may vary.		There's another catch, however: this is only known to work in CS:S and TF2. For other mods, your mileage may vary.
		+
		+	Additionally, CS:S, TF2, HL2:DM, and DoD:S all support RGB(A) hex values in chat messages with <tt style="color: blue;">0x07</tt> and <tt style="color: blue;">0x08</tt>, followed by a 6- or 8- char hex value (e.g., <tt>\x07ABCDEF</tt>, <tt>\x0801234567</tt>).

	==Color Libraries==		==Color Libraries==

@@ Line 131: / Line 131: @@
 }</pawn>
-<tt>player_to</tt> is the client index to send the message to (or use [http://docs.sourcemod.net/api/index.php?fastload=show&id=132& StartMessageAll()] instead of [http://docs.sourcemod.net/api/index.php?fastload=show&id=133& StartMessageOne()] to send the message to all players). <tt>player_from</tt> is the client index of the player whose team color will be utilized in the message. The message will now look like this (assuming <tt>player_from</tt> is on the RED team):
+<tt>player_to</tt> is the client index to send the message to (or use [https://sm.alliedmods.net/new-api/usermessages/StartMessageAll StartMessageAll()] instead of [https://sm.alliedmods.net/new-api/usermessages/StartMessageOne StartMessageOne()] to send the message to all players). <tt>player_from</tt> is the client index of the player whose team color will be utilized in the message. The message will now look like this (assuming <tt>player_from</tt> is on the RED team):
   <span style="color:#AA0">&lt;</span><span style="color:#F00">player_from team color</span><span style="color:#AA0">&gt; My message</span>

@@ Line 186: / Line 186: @@
 This is because you're not returning <tt>Plugin_Handled</tt> in your callback. If you don't, SourceMod believes you didn't want the Source Engine to know the command was registered, and it handles it so.
-<pawn>public Action:MyCommand(client, args)
+<pawn>public Action MyCommand(int client, int args)
+{
      // Do something...

@@ Line 147: / Line 147: @@
 <pawn>#include <colors>
-public OnPluginStart()
+public void OnPluginStart()
+{
      CPrintToChatAll("{green}Hello {red}World! {default}Test 1 concluded.");
-     new client_on_blu_team = 1;
+     int client_on_blu_team = 1;
      CPrintToChatAllEx(client_on_blu_team, "{teamcolor}BLU team {default}says {green}hi!");
 }</pawn>
@@ Line 167: / Line 167: @@
 <pawn>#include <smlib>
-public OnPluginStart()
+public void OnPluginStart()
+{
      Client_PrintToChatAll("{G}Hello {R}World! {N}Test 1 concluded.");
-     new client_on_blu_team = 1;
+     int client_on_blu_team = 1;
      Client_PrintToChatAll(client_on_blu_team, "{T}BLU team {N}says {G}hi!");
 }</pawn>

@@ Line 121: / Line 121: @@
 Unfortunately, to use players' team colors, you must use UserMessages, because there is no way for the current SourceMod functions to know which team color to use. Here's an example:
-<pawn>new Handle:hBf;
+<pawn>Handle hBf;
 hBf = StartMessageOne("SayText2", player_to); // To send the message to all players, use StartMessageAll("SayText2");
-if (hBf != INVALID_HANDLE)
+if (hBf != null)
+{
      BfWriteByte(hBf, player_from);

@@ Line 85: / Line 85: @@
 =How do I get rid of tag mismatch warnings?=
-Though every variable in SourcePawn is one cell (4 bytes), with the exception of strings, there are many different ways to interpret what's inside a cell. To signify a cell's contents, tags are used. The most common are <tt>_</tt> (the default tag: a vanilla cell. This tag is implied when no other tag is specified.), <tt>Float</tt>, <tt>bool</tt>, and <tt>String</tt>. See [[Introduction to SourcePawn#Variables_2]] for more information.
+Though every variable in SourcePawn is one cell (4 bytes), with the exception of strings, there are many different ways to interpret what's inside a cell. To signify a cell's contents, tags are used. The most common are <tt>_</tt> (the default tag: a vanilla cell. This tag is implied when no other tag is specified.), <tt>float</tt>, <tt>bool</tt>, and <tt>char</tt>. See [[Introduction_to_SourcePawn_1.7#Variables_2]] for more information.
 Functions wear these tags on their parameters so you can tell what needs to be passed to the function:
-<pawn>native SetEntPropFloat(entity, PropType:type, const String:prop[], Float:value);</pawn>
+<pawn>native int SetEntPropFloat(int entity, PropType type, const char[] prop, float value, int element)</pawn>
-This function calls for '''<tt>entity</tt>''', a cell with the implied tag '''''<tt>_</tt>'''''; '''<tt>type</tt>''', with the developer-defined tag '''''<tt>PropType</tt>'''''; '''<tt>prop</tt>''', with the built-in tag '''''<tt>String</tt>'''''; and '''<tt>value</tt>''', with the built-in tag '''''<tt>Float</tt>'''''.
+This function calls for '''<tt>entity</tt>''', a cell with the implied tag '''''<tt>int</tt>'''''; '''<tt>type</tt>''', with the developer-defined tag '''''<tt>PropType</tt>'''''; '''<tt>prop</tt>''', with the built-in tag '''''<tt>char</tt>'''''; and '''<tt>value</tt>''', with the built-in tag '''''<tt>float</tt>'''''.
 To call this function, then, you must pass values with the specified tags. For example:
 <pawn>SetEntPropFloat(1234, Prop_Send, "m_fNumber", 1.0);</pawn>
-This calls the function correctly: <tt>1234</tt> is a regular cell ('''''<tt>_</tt>'''''), <tt>Prop_Send</tt> is a variable defined in the enum '''''<tt>PropType</tt>''''' in [http://docs.sourcemod.net/api/index.php?fastload=file&id=4&file=& entity.inc], <tt>"m_fNumber"</tt> is a '''''<tt>String</tt>''''', and <tt>1.0</tt> is a '''''<tt>Float</tt>'''''. For a nonexample:
+This calls the function correctly: <tt>1234</tt> is a regular cell ('''''<tt>_</tt>'''''), <tt>Prop_Send</tt> is a variable defined in the enum '''''<tt>PropType</tt>''''' in [https://sm.alliedmods.net/new-api/entity/__raw entity.inc], <tt>"m_fNumber"</tt> is a '''''<tt>char</tt>''''', and <tt>1.0</tt> is a '''''<tt>float</tt>'''''. For a nonexample:
 <pawn>SetEntPropFloat(1234.0, 1, "m_fNumber", 1337);</pawn>
-This is incorrect! <tt>1234.0</tt> is a '''''<tt>Float</tt>''''' that should be a regular cell ('''''<tt>_</tt>'''''); <tt>1</tt> is a regular cell ('''''<tt>_</tt>''''') that should be a '''''<tt>PropType</tt>'''''; and <tt>1337</tt> is a regular cell ('''''<tt>_</tt>''''') that should be a '''''<tt>Float</tt>'''''. This call will generate a tag mismatch warning. To correct it, simply use a value with the correct tag. Most of the time, tags that are not built-in (such as '''''<tt>PropType</tt>''''') can be found in the same file where a function uses them (you can find '''''<tt>PropType</tt>''''' in [http://docs.sourcemod.net/api/index.php?fastload=file&id=4&file=& entity.inc]).
+This is incorrect! <tt>1234.0</tt> is a '''''<tt>float</tt>''''' that should be a regular cell ('''''<tt>int</tt>'''''); <tt>1</tt> is a regular cell ('''''<tt>int</tt>''''') that should be a '''''<tt>PropType</tt>'''''; and <tt>1337</tt> is a regular cell ('''''<tt>int</tt>''''') that should be a '''''<tt>float</tt>'''''. This call will generate a tag mismatch warning. To correct it, simply use a value with the correct tag. Most of the time, tags that are not built-in (such as '''''<tt>PropType</tt>''''') can be found in the same file where a function uses them (you can find '''''<tt>PropType</tt>''''' in [https://sm.alliedmods.net/new-api/entity/__raw entity.inc]).
 =How do I add color to my messages?=

@@ Line 12: / Line 12: @@
 This line instructs the compiler to retrieve the file <tt>sourcemod.inc</tt> from the <tt>sourcemod/scripting/include</tt> folder. Every function, variable, and definition can be found in the <tt>.inc</tt> files inside the <tt>sourcemod/scripting/include</tt> folder.
-But searching through all those files can be quite tedious. Thankfully, the honourable [https://forums.alliedmods.net/member.php?u=9443 Nican] created an API reference viewable on the web, complete with searching and commenting: [http://docs.sourcemod.net/api/ http://docs.sourcemod.net/api/]
+But searching through all those files can be quite tedious. Thankfully, the honourable [https://forums.alliedmods.net/member.php?u=9443 Nican] created an API reference viewable on the web, complete with searching and commenting: [https://sm.alliedmods.net/new-api/ https://sm.alliedmods.net/new-api/]
 Also, if you are in the SourceMod IRC channel ([irc://irc.gamesurge.net/sourcemod #sourcemod on GameSurge]), you can use the <tt>!api</tt> command to search [https://forums.alliedmods.net/member.php?u=9443 Nican's] API reference:
 <pre><theY4Kman> !api Netclass
-<yakbot> theY4Kman: GetEntityNetClass(edict, String:clsname[], maxlength): Retrieves an entity's networkable serverclass name. This is not the same as the classname and is used for networkable state changes. (http://docs.sourcemod.net/api/index.php?fastload=show&id=66)</pre>
+<yakbot> theY4Kman: bool GetEntityNetClass(int edict, char[] clsname, int maxlength): Retrieves an entity's networkable serverclass name. This is not the same as the classname and is used for networkable state changes. (https://sm.alliedmods.net/new-api/entity/GetEntityNetClass)</pre>
 =How do I find the classname of an entity? (e.g., "<tt>weapon_knife</tt>" or "<tt>prop_physics</tt>")=