Writing Extensions - Revision history

Asherkin at 17:00, 22 May 2021

2021-05-22T17:00:33Z

Joinedsenses: /* Dynamic Autoloading */ Updated syntax

2020-03-30T05:08:23Z

‎Dynamic Autoloading: Updated syntax

Psychonic: pawn -> sourcepawn tag

2020-03-26T19:44:46Z

pawn -> sourcepawn tag

Hmmmmm: Updated sourcepawn sections to new syntax

2018-01-31T14:54:41Z

Updated sourcepawn sections to new syntax

Hmmmmm: Added hl2sdk github link

2018-01-01T21:31:48Z

Added hl2sdk github link

Darkid: /* Starting an Extension */ Directory structure is listed above. I'm separating out CONF_METAMOD since most people won't need it, and removed the bit about removing lines.

2016-04-16T18:28:02Z

‎Starting an Extension: Directory structure is listed above. I'm separating out CONF_METAMOD since most people won't need it, and removed the bit about removing lines.

Darkid: /* SDK Structure */ Updated, trying to make instructions clearer.

2016-04-16T18:17:09Z

‎SDK Structure: Updated, trying to make instructions clearer.

Darkid: /* Starting an Extension */

2016-04-11T19:20:51Z

‎Starting an Extension

Darkid: /* Starting an Extension */

2016-04-11T19:20:41Z

‎Starting an Extension

Darkid: I assume this is the correct link, please update if wrong.

2016-04-11T18:16:41Z

I assume this is the correct link, please update if wrong.

@@ Line 4: / Line 4: @@
 =SDK Structure=
-First, download the [[SourceMod SDK]] from the [https://github.com/alliedmodders/sourcemod/releases SourceMod github], and one of the SDKs from the [https://github.com/alliedmodders/hl2sdk hl2sdk github]. The directory structure should contain these folders:
+First, download the [[SourceMod SDK]] from the [https://github.com/alliedmodders/sourcemod SourceMod github], and one of the SDKs from the [https://github.com/alliedmodders/hl2sdk hl2sdk github].
 <code>
 * hl2sdk-something - One of the HL2 SDKs
@@ Line 22: / Line 26: @@
 **** smsdk_config.h - Sample C++ plugin settings
 ** sourcepawn - The include/interface files for SourcePawn
 </code>

@@ Line 391: / Line 391: @@
   * Do not edit below this line!
   */
-public Extension:__ext_geoip =
+public Extension __ext_geoip =
+{
 	name = "GeoIP",
@@ Line 418: / Line 418: @@
 *<b>"GeoIP</b>: Change the GeoIP portion to your extension's name.  This should match the name you chose as <tt>SMEXT_CONF_NAME</tt>.
 *<b>"geoip.ext"</b>: Change this to your extension's file name, without the .dll/.so portion.
 ==Global Autoloading==

@@ Line 72: / Line 72: @@
 ==Prototyping==
 The first step to creating a native is to <tt>spec it</tt>, or <tt>prototype</tt> it.  This is a simple but often time consuming process, but if you get in the habit of it, your documentation will be much better.  Let's first create a very simply native.  Here is a prototype for it, which we will place in <tt>sample.inc</tt>:
-<pawn>/**
+<sourcepawn>/**
   * Returns the square of a number.
+  *
@@ Line 78: / Line 78: @@
   * @return	The square of num.
   */
-native int SquareNumber(num);</pawn>
+native int SquareNumber(num);</sourcepawn>
 The <tt>native</tt> keyword tells the compiler that this function exists in an outside source.  The comment style is similar to [http://www.stack.nl/~dimitri/doxygen/ doxygen] or [http://java.sun.com/j2se/javadoc/ Javadoc], and is preferred by the SourceMod Development Team.
@@ Line 138: / Line 138: @@
 As we did before, first let's prototype our global forward.  In our include file, we add this:
-<pawn>/**
+<sourcepawn>/**
   * @brief Called whenever a client says something in chat.
+  *
@@ Line 145: / Line 145: @@
   * @return 		Plugin_Handled to block text from printing, Plugin_Continue otherwise.
   */
-forward Action OnPlayerSayChat(int client, const char[] text);</pawn>
+forward Action OnPlayerSayChat(int client, const char[] text);</sourcepawn>
 The <tt>forward</tt> keyword tells the compiler that any function having this name must be declared exactly the same.  In a plugin, this would
@@ Line 201: / Line 201: @@
 Example prototype:
-<pawn>typedef SayChatHook = function Action (int client, const char[] text);
+<sourcepawn>typedef SayChatHook = function Action (int client, const char[] text);
 native void AddSayChatHook(SayChatHook hook);
-native void RemoveSayChatHook(SayChatHook hook);</pawn>
+native void RemoveSayChatHook(SayChatHook hook);</sourcepawn>
 The <tt>funcenum</tt> syntax lets you define all the valid prototypes for your hook.  In this example, the only valid method is a function declared like this (only MyHook can be changed):
-<pawn>Action MyHook(int client, const char[] text)</pawn>
+<sourcepawn>Action MyHook(int client, const char[] text)</sourcepawn>
 How do we make such a beast?  The first step is setting up our forward.
@@ Line 388: / Line 388: @@
 Dynamic loading requires that you create an include file for plugins.  Plugins that include your file will automatically load your extension.  This requires implementing the <tt>Extension</tt> structure found in <tt>core.inc</tt>.  You must expose the structure as <tt>public</tt>, and the name must start with "<tt>__ext_</tt>".
-<pawn>/**
+<sourcepawn>/**
   * Do not edit below this line!
   */
@@ Line 406: / Line 406: @@
 #endif
 };
-</pawn>
+</sourcepawn>
 Explanations:

@@ Line 78: / Line 78: @@
   * @return	The square of num.
   */
-native SquareNumber(num);</pawn>
+native int SquareNumber(num);</pawn>
 The <tt>native</tt> keyword tells the compiler that this function exists in an outside source.  The comment style is similar to [http://www.stack.nl/~dimitri/doxygen/ doxygen] or [http://java.sun.com/j2se/javadoc/ Javadoc], and is preferred by the SourceMod Development Team.
@@ Line 143: / Line 143: @@
   * @param client	Index of the client.
   * @param text		String containing the say text.
-  * @return 		Pl_Handled to block text from printing, Pl_Continue otherwise.
+  * @return 		Plugin_Handled to block text from printing, Plugin_Continue otherwise.
   */
-forward ResultType:OnPlayerSayChat(client, const String:text[]);</pawn>
+forward Action OnPlayerSayChat(int client, const char[] text);</pawn>
 The <tt>forward</tt> keyword tells the compiler that any function having this name must be declared exactly the same.  In a plugin, this would
@@ Line 201: / Line 201: @@
 Example prototype:
-<pawn>funcenum SayChatHook
+<pawn>typedef SayChatHook = function Action (int client, const char[] text);
-native AddSayChatHook(SayChatHook:hook);
+native void AddSayChatHook(SayChatHook hook);
-native RemoveSayChatHook(SayChatHook:hook);</pawn>
+native void RemoveSayChatHook(SayChatHook hook);</pawn>
 The <tt>funcenum</tt> syntax lets you define all the valid prototypes for your hook.  In this example, the only valid method is a function declared like this (only MyHook can be changed):
-<pawn>MyHook(client, const String:text[])</pawn>
+<pawn>Action MyHook(int client, const char[] text)</pawn>
 How do we make such a beast?  The first step is setting up our forward.

@@ Line 4: / Line 4: @@
 =SDK Structure=
-First, download the [[SourceMod SDK]] from the [https://github.com/alliedmodders/sourcemod/releases SourceMod github], and one of the SDKs from the [hl2sdk github]. The directory structure should contain these folders:
+First, download the [[SourceMod SDK]] from the [https://github.com/alliedmodders/sourcemod/releases SourceMod github], and one of the SDKs from the [https://github.com/alliedmodders/hl2sdk hl2sdk github]. The directory structure should contain these folders:
 <code>
 * hl2sdk-something - One of the HL2 SDKs

@@ Line 26: / Line 26: @@
 =Starting an Extension=
-For simplicity, this article will assume you are using the SDK base files (<code>public/sample_ext</code>).  These are:
+For simplicity, this article will assume you are using the SDK base files. Navigate to <code>extensions/public/sample_ext</code>, and ensure that you can compile your code. If using the command line, <code>make</code> should do this, if using Visual Studio, see [[#Setting up Visual Studio|Setting up Visual Studio]].
 The first step of creating your extension is to configure it.  Open the <tt>smsdk_config.h</tt> file and edit each of the following defines.  Use the information below to guide you.
-*<tt>SMEXT_CONF_NAME</tt> - The general name for your Extension (should be short).
+<code>
-*<tt>SMEXT_CONF_DESCRIPTION</tt> - A short description of what your extension does.
+*SMEXT_CONF_NAME - The general name for your Extension (should be short).
-*<tt>SMEXT_CONF_VERSION</tt> - A version number string.  By convention, SourceMod uses the four set build number notation.  I.e. for 1.2.3.4:
+*SMEXT_CONF_DESCRIPTION - A short description of what your extension does.
-**<tt>1</tt> is the "Major" release version.
+*SMEXT_CONF_VERSION - A version number string.  By convention, SourceMod uses the four set build number notation, so build 1.2.3.4 means:
-**<tt>2</tt> is the "Minor" release version.
+**1 is the "Major" release version.
-**<tt>3</tt> is the "Maintenance" or "Revision" version.
+**2 is the "Minor" release version.
-**<tt>4</tt> is the "Build," usually an internal source control number.
+**3 is the "Maintenance" or "Revision" version.
-*<tt>SMEXT_CONF_AUTHOR</tt> - Your name (or whoever/whatever authored the plugin).
+**4 is the "Build," usually an internal source control number.
-*<tt>SMEXT_CONF_URL</tt> - The URL/homepage of this extension.
+*SMEXT_CONF_AUTHOR - Your name (or whoever/whatever authored the plugin).
-*<tt>SMEXT_CONF_LOGTAG</tt> - The logtag your extension will use for SourceMod logging.  By convention, try to keep this under ten characters or so, and to make it all caps.
+*SMEXT_CONF_URL - The URL/homepage of this extension.
-*<tt>SMEXT_CONF_LICENSE</tt> - Right now, the SourceMod Dev Team mandates that 3rd party extensions must be under an Open Source license.  Putting a license abbreviation or very short message here is appropriate.  For more information, see [[SourceMod License]].
+*SMEXT_CONF_LOGTAG - The logtag your extension will use for SourceMod logging.  By convention, try to keep this under ten characters or so, and to make it all caps.
-*<tt>SMEXT_CONF_DATESTRING</tt> - You do not need to modify this.
+*SMEXT_CONF_LICENSE - Right now, the SourceMod Dev Team mandates that 3rd party extensions must be under an Open Source license.  Putting a license abbreviation or very short message here is appropriate.  For more information, see [https://www.sourcemod.net/license.php the SourceMod license].
-*<tt>SMEXT_CONF_METAMOD</tt> - If your plugin requires using SourceHook or Metamod:Source, uncomment this line.
+*SMEXT_CONF_DATESTRING - You do not need to modify this.
+</code>
 ==Visual Studio Users==

@@ Line 4: / Line 4: @@
 =SDK Structure=
-First, download the [[SourceMod SDK]] from the [[SourceMod]] github: [https://github.com/alliedmodders/sourcemod/releases].  The directory structure looks like this:
+First, download the [[SourceMod SDK]] from the [https://github.com/alliedmodders/sourcemod/releases SourceMod github], and one of the SDKs from the [hl2sdk github]. The directory structure should contain these folders:
-*<tt>extensions</tt>
+<code>
-**<tt>geoip/</tt> - Source code to the GeoIP extension
+* hl2sdk-something - One of the HL2 SDKs
-**<tt>mysql/</tt> - Source code to the MySQL extension
+* sourcemod-version - The sourcemod package
-**<tt>threader/</tt> - Source code to the Threader extension
+** extensions - Sourcemod Extensions code
-*<tt>plugins/</tt> - Source code to all of SourceMod's plugins
+*** curl - Source code to the cURL extension
-**<tt>include/</tt> - The include files which document plugin API
+*** geoip - Source code to the GeoIP extension
-*<tt>public/</tt> - Interface files for SourceMod's Core Interfaces
+*** mysql - Source code to the MySQL extension
-**<tt>extensions/</tt> - Interfaces that are provided by extensions
+** plugins - Source code to all of SourceMod's plugins
-**<tt>sample_ext/</tt> - The Sample Extension SDK
+*** include - The include files which document plugin API
-**<tt>sourcepawn</tt> - The include/interface files for SourcePawn
+** public - Interface files for SourceMod's Core Interfaces
-*<tt>sourcepawn/</tt>
+*** extensions  - Interfaces that are provided by extensions
-**<tt>compiler/</tt> - The SourcePawn Compiler
+*** '''sample_ext''' - The Sample Extension SDK
+**** extension.cpp - Sample C++ plugin
 =Starting an Extension=

@@ Line 20: / Line 20: @@
 =Starting an Extension=
-For simplicity, this article will assume you are using the SDK base files (<code>public/sample_ext</code).  These are:
+For simplicity, this article will assume you are using the SDK base files (<code>public/sample_ext</code>).  These are:
 *<tt>sdk/smsdk_config.h</tt> - Configuration settings (we will be editing this)
 *<tt>sdk/smsdk_ext.h</tt> - Header for SDK wrappers (usually never needs to be edited)