Introduction to sourceMod Plugins - Revision history

Nosoop: /* Will SourceMod support Source 2? Will plugins for existing games continue to work if they are ported? */ Add answers for ongoing development

2023-03-23T13:14:42Z

‎Will SourceMod support Source 2? Will plugins for existing games continue to work if they are ported?: Add answers for ongoing development

Nosoop: /* Will SourceMod support Source 2? Will plugins for existing games continue to work if they are ported? */ S2 is already released; reword to specifically mention game releases

2023-03-13T16:54:03Z

‎Will SourceMod support Source 2? Will plugins for existing games continue to work if they are ported?: S2 is already released; reword to specifically mention game releases

Nosoop: /* Will SourceMod support Source 2? Will plugins for existing games continue to work if they are ported? */ Bring response up to date; thx duck

2023-03-13T15:34:32Z

‎Will SourceMod support Source 2? Will plugins for existing games continue to work if they are ported?: Bring response up to date; thx duck

Nosoop: /* Why am I seeing references to STEAM_ID_STOP_IGNORING_RETVALS? */ fixup code tag; incl. additional reasoning for clearing the buffer

2023-01-03T18:08:02Z

‎Why am I seeing references to STEAM_ID_STOP_IGNORING_RETVALS?: fixup code tag; incl. additional reasoning for clearing the buffer

Nosoop: /* General Callbacks */ Use API template

2023-01-03T17:49:05Z

‎General Callbacks: Use API template

Nosoop: /* Client Callbacks */ Use API template

2023-01-01T15:48:19Z

‎Client Callbacks: Use API template

Nosoop: /* Client Callbacks */ Add clarifications on connected / in-game phrasing

2023-01-01T15:39:45Z

‎Client Callbacks: Add clarifications on connected / in-game phrasing

Nosoop: /* Frequently Asked Questions */ Add "Source 2?"

2022-08-20T17:08:28Z

‎Frequently Asked Questions: Add "Source 2?"

Nosoop: Add reference to STEAM_ID_STOP_IGNORING_RETVALS

2021-04-30T01:22:46Z

Add reference to STEAM_ID_STOP_IGNORING_RETVALS

Naleksuh: /* Setting up plugin info */ new syntax

2021-01-29T19:38:29Z

‎Setting up plugin info: new syntax

← Older revision		Revision as of 13:14, 23 March 2023
Line 454:		Line 454:

	It's safe to say that SourceMod will currently not work on the day of release for any games powered by Source 2.		It's safe to say that SourceMod will currently not work on the day of release for any games powered by Source 2.
		+
		+	Notes as of the initial limited testing phase for Counter-Strike 2:
		+
		+	* <code>-dedicated</code> allows for the creation of listen servers.
		+	* The VSP plugin / VDF loading capabilities have been removed. [[Installing_Metamod:Source#GameInfo\|Metamod:Source needs to be loaded as a GameDLL.]]
		+
		+	Keep in mind that this is an ongoing development; nothing is ready for public use yet.

	=Further Reading=		=Further Reading=

@@ Line 453: / Line 453: @@
 No decision has been made yet on if development will be focused on bringing SourceMod to Source 2, on creating a successor scripting ecosystem much like SourceMod was to [[AMX Mod X]], or on extending VScript functionality.
-It's likely safe to say that SourceMod will not work on day 1 of the release of Source 2.
+It's safe to say that SourceMod will currently not work on the day of release for any games powered by Source 2.
 =Further Reading=

@@ Line 449: / Line 449: @@
 == Will SourceMod support Source 2? Will plugins for existing games continue to work if they are ported? ==
-There is no way to tell without Source 2 games that ship with dedicated servers.  None currently exist.
+The engine already exists; Metamod:Source works to some extent.  Further reverse engineering efforts are required to get Metamod:Source in a stable state before work can even start on SourceMod.
 =Further Reading=

@@ Line 446: / Line 446: @@
 == Why am I seeing references to <tt>STEAM_ID_STOP_IGNORING_RETVALS</tt>? ==
-When {{SourceMod API|file=clients|function=GetClientAuthId}} is called and returns <tt>false</tt>, the buffer that should have the client's auth id is populated with <tt>STEAM_ID_STOP_IGNORING_RETVALS</tt>, both to clear the previous contents of the buffer and to inform the developer to stop ignoring the return value of the <tt>GetClientAuthId</tt> call.
+When {{SourceMod API|file=clients|function=GetClientAuthId}} is called and returns <tt>false</tt>, the buffer that should have the client's auth id is populated with <tt>STEAM_ID_STOP_IGNORING_RETVALS</tt>, both to clear the previous contents of the buffer (thereby preventing accidental reuse of old values) and to inform the developer to stop ignoring the return value of the <code>GetClientAuthId</code> call.
 == Will SourceMod support Source 2? Will plugins for existing games continue to work if they are ported? ==

@@ Line 393: / Line 393: @@
 These callbacks are listed in the order they are called, in the lifetime of a plugin and the server.
-*[https://sm.alliedmods.net/new-api/sourcemod/AskPluginLoad2 AskPluginLoad2()] - Called once, immediately after the plugin is loaded from the disk.  This function can be used to stop a plugin from loading and return a custom error message; return APLRes_Failure and use strcopy on to replace the error string.  All CreateNative and RegPluginLibrary calls should be done here.
+* {{SourceMod API|file=sourcemod|function=AskPluginLoad2}} - Called once, immediately after the plugin is loaded from the disk.  This function can be used to stop a plugin from loading and return a custom error message; return APLRes_Failure and use strcopy on to replace the error string.  All CreateNative and RegPluginLibrary calls should be done here.
-*[https://sm.alliedmods.net/new-api/sourcemod/OnPluginStart OnPluginStart()] - Called once, after the plugin has been fully initialized and can proceed to load.  Any run-time errors in this function will cause the plugin to fail to load.  '''This is paired with OnPluginEnd()'''.
+* {{SourceMod API|file=sourcemod|function=OnPluginStart}} - Called once, after the plugin has been fully initialized and can proceed to load.  Any run-time errors in this function will cause the plugin to fail to load.  '''This is paired with OnPluginEnd()'''.
-*[https://sm.alliedmods.net/new-api/sourcemod/OnAllPluginsLoaded OnAllPluginsLoaded()] - Called once, after all non-late loaded plugins have called OnPluginStart.
+* {{SourceMod API|file=sourcemod|function=OnAllPluginsLoaded}} - Called once, after all non-late loaded plugins have called OnPluginStart.
-*[https://sm.alliedmods.net/new-api/sourcemod/OnMapStart OnMapStart()] - Called every time the map loads.  If the plugin is loaded late, and the map has already started, this function is called anyway after load, in order to preserve pairing.  '''This function is paired with OnMapEnd().'''
+* {{SourceMod API|file=sourcemod|function=OnMapStart}} - Called every time the map loads.  If the plugin is loaded late, and the map has already started, this function is called anyway after load, in order to preserve pairing.  '''This function is paired with OnMapEnd().'''
-*[https://sm.alliedmods.net/new-api/sourcemod/OnConfigsExecuted OnConfigsExecuted()] - Called once per map-change after  <tt>servercfgfile</tt> (usually <tt>server.cfg</tt>), <tt>sourcemod.cfg</tt>, and all plugin config files have finished executing.  If a plugin is loaded after this has happened, the callback is called anyway, in order to preserve pairing.  '''This function is paired with OnMapEnd().'''
+* {{SourceMod API|file=sourcemod|function=OnConfigsExecuted}} - Called once per map-change after <tt>servercfgfile</tt> (usually <tt>server.cfg</tt>), <tt>sourcemod.cfg</tt>, and all plugin config files have finished executing.  If a plugin is loaded after this has happened, the callback is called anyway, in order to preserve pairing.  '''This function is paired with OnMapEnd().'''
 *At this point, most game callbacks can occur, such as events and callbacks involving clients (or other things, like OnGameFrame).
-*[https://sm.alliedmods.net/new-api/sourcemod/OnMapEnd OnMapEnd()] - Called when the map is about to end.  At this point, all clients are disconnected, but <tt>TIMER_NO_MAPCHANGE</tt> timers are not yet destroyed.  '''This function is paired to OnMapStart().'''
+* {{SourceMod API|file=sourcemod|function=OnMapEnd}} - Called when the map is about to end.  At this point, all clients are disconnected, but <tt>TIMER_NO_MAPCHANGE</tt> timers are not yet destroyed.  '''This function is paired to OnMapStart().'''
-*[https://sm.alliedmods.net/new-api/sourcemod/OnPluginEnd OnPluginEnd()] - Called once, immediately before the plugin is unloaded.  '''This function is paired to OnPluginStart().'''
+* {{SourceMod API|file=sourcemod|function=OnPluginEnd}} - Called once, immediately before the plugin is unloaded.  '''This function is paired to OnPluginStart().'''
 ==Client Callbacks==

@@ Line 405: / Line 405: @@
 These callbacks are listed in no specific order, however, their documentation holds for both fake and real clients.
-*[https://sm.alliedmods.net/new-api/clients/OnClientConnect OnClientConnect()] - Called when a player initiates a connection.  You can block a player from connecting by returning Plugin_Stop and setting rejectmsg to an error message.
+* {{SourceMod API|file=clients|function=OnClientConnect}} - Called when a player initiates a connection.  You can block a player from connecting by returning <code>Plugin_Stop</code> and setting rejectmsg to an error message.
-*[https://sm.alliedmods.net/new-api/clients/OnClientConnected OnClientConnected()] - Called after a player connects. Signifies that the player is connected and IsClientConnected() will return true. '''This is paired with OnClientDisconnect() for successful connections only.'''
+* {{SourceMod API|file=clients|function=OnClientConnected}} - Called after a player connects. Signifies that the player is connected and {{SourceMod API|file=clients|function=IsClientConnected}} will return true. '''This is paired with <code>OnClientDisconnect</code> for successful connections only.'''
-*[https://sm.alliedmods.net/new-api/clients/OnClientAuthorized OnClientAuthorized()] - Called when a player gets a Steam ID.  It is important to note that this may never be called.  It may occur any time in between OnClientConnected and OnClientPreAdminCheck/OnClientDisconnect.  Do not rely on it unless you are writing something that needs Steam IDs, and even then you should use OnClientPostAdminCheck().
+*{{SourceMod API|file=clients|function=OnClientAuthorized}} - Called when a player gets a Steam ID.  It is important to note that this may never be called.  It may occur any time in between <code>OnClientConnected</code> and <code>OnClientPreAdminCheck</code>/<code>OnClientDisconnect</code>.  Do not rely on it unless you are writing something that needs Steam IDs, and even then you should use <code>OnClientPostAdminCheck</code>.
-*[https://sm.alliedmods.net/new-api/clients/OnClientPutInServer OnClientPutInServer()] - Signifies that the player is fully in-game and IsClientInGame() will return true.
+* {{SourceMod API|file=clients|function=OnClientPutInServer}} - Signifies that the player is fully in-game and {{SourceMod API|file=clients|function=IsClientInGame}} will return true.
-**If you want to check if the player is in-game, you just need to call this; IsClientConnected() will also be true if this is (but not the other way around - a player may be connected but not in-game yet).
+** If you want to check if the player is in-game, you just need to call this; {{SourceMod API|file=clients|function=IsClientConnected}} will also be true if this is (but not the other way around - a player may be connected but not in-game yet).
-*[https://sm.alliedmods.net/new-api/clients/OnClientPostAdminCheck OnClientPostAdminCheck()] - Called after the player is '''both authorized and in-game'''.  This is the best callback for checking administrative access after connect.
+* {{SourceMod API|file=clients|function=OnClientPostAdminCheck}} - Called after the player is '''both authorized and in-game'''.  This is the best callback for checking administrative access after connect.
-*[https://sm.alliedmods.net/new-api/clients/OnClientDisconnect OnClientDisconnect()] - Called when a player's disconnection starts.  '''This is paired to OnClientConnected().'''
+* {{SourceMod API|file=clients|function=OnClientDisconnect}} - Called when a player's disconnection starts.  '''This is paired to <code>OnClientConnected</code>.'''
-*[https://sm.alliedmods.net/new-api/clients/OnClientDisconnect_Post OnClientDisconnect_Post()] - Called when a player's disconnection ends.  '''This is paired to OnClientConnected().'''
+* {{SourceMod API|file=clients|function=OnClientDisconnect_Post}} - Called when a player's disconnection ends.  '''This is paired to <code>OnClientConnected</code>.'''
 =Frequently Asked Questions=

@@ Line 443: / Line 443: @@
 ==When do I need to manually unhook things?==
 You only need to do so when you do not want the callback to fire anymore while the plugin is running.  SourceMod itself, as well as extensions such as SDKHooks, unhooks entities and players when they are removed and disconnected, respectively.  Everything a plugin hooks is unhooked when it is unloaded.
 =Further Reading=

@@ Line 44: / Line 44: @@
 };</sourcepawn>
-The <tt>public</tt> keyword means that SourceMod will be able to directly access our variable. <tt>Plugin:</tt> defines a type of our variable. <tt>myinfo</tt> is, obviously, a name of our variable as required by SourceMod. You see that we initialize it right away. This is the preferable way to fill out plugin info.
+The <tt>public</tt> keyword means that SourceMod will be able to directly access our variable. <tt>Plugin</tt> defines a type of our variable. <tt>myinfo</tt> is, obviously, a name of our variable as required by SourceMod. You see that we initialize it right away. This is the preferable way to fill out plugin info.
 After that the full code of your plugin should look like this: