Optional Requirements (SourceMod Scripting) - Revision history

Joinedsenses: Update highlighting and formatting

2020-03-30T00:41:36Z

Update highlighting and formatting

Show changes

Shavit: Update example code to transitional syntax

2016-07-26T02:43:20Z

Update example code to transitional syntax

Peace-Maker at 14:00, 10 February 2014

2014-02-10T14:00:43Z

Psychonic at 16:04, 3 February 2011

2011-02-03T16:04:56Z

Zerak: /* Optional Natives */

2008-07-20T15:51:19Z

‎Optional Natives

BAILOPAN at 00:11, 16 November 2007

2007-11-16T00:11:13Z

BAILOPAN at 19:00, 29 September 2007

2007-09-29T19:00:35Z

BAILOPAN at 19:00, 29 September 2007

2007-09-29T19:00:11Z

Shane: /* Full Example */

2007-07-30T05:53:59Z

‎Full Example

Shane: /* Full Example */

2007-07-30T02:29:06Z

‎Full Example

@@ Line 33: / Line 33: @@
 To mark a native as optional, use <tt>MarkNativeAsOptional</tt>.  It should be called in <tt>AskPluginLoad2</tt>.  For example:
-<pawn>public APLRes:AskPluginLoad2(Handle:myself, bool:late, String:error[], err_max)
+<pawn>public APLRes AskPluginLoad2(Handle myself, bool late, char[] error, int err_max)
+{
 	MarkNativeAsOptional("SDKCall");
@@ Line 42: / Line 42: @@
 If you use a plugin or extension as an optional dependency, you may need to check whether it exists.  For example, let's say we're relying on a plugin with the library name of "ircrelay."  The way to always know whether ircrelay is loaded (and working) is:
-<pawn>new bool:ircrelay = false;
+<pawn>bool ircrelay = false;
-public OnAllPluginsLoaded()
+public void OnAllPluginsLoaded()
+{
 	ircrelay = LibraryExists("ircrelay");
+}
-public OnLibraryRemoved(const String:name[])
+public void OnLibraryRemoved(const char[] name)
+{
 	if (StrEqual(name, "ircrelay"))
@@ Line 57: / Line 57: @@
+}
-public OnLibraryAdded(const String:name[])
+public void OnLibraryAdded(const char[] name)
+{
 	if (StrEqual(name, "ircrelay"))
@@ Line 69: / Line 69: @@
 Allowing other plugins to use your plugin as a library requires making an include file with two structures (the second of which is optional).  The first structure must look like this:
-<pawn>public SharedPlugin:__pl_myfile =
+<pawn>public SharedPlugin __pl_myfile =
+{
 	name = "myfile",
@@ Line 88: / Line 88: @@
 Additionally, you should expose a function which marks all of your natives as optional.  You can do this by:
 <pawn>#if !defined REQUIRE_PLUGIN
-public __pl_myfile_SetNTVOptional()
+public void __pl_myfile_SetNTVOptional()
+{
 	MarkNativeAsOptional("native1");
@@ Line 101: / Line 101: @@
 <pawn>
-public APLRes:AskPluginLoad2(Handle:myself, bool:late, String:error[], err_max)
+public APLRes AskPluginLoad2(Handle myself, bool late, char[] error, int err_max)
+{
 	//... code here ...
@@ Line 119: / Line 119: @@
 ;''Bounty: bounty.config.sp''
 <pawn>
-new bool:plugin_IrcRelay = LibraryExists("ircrelay");
+bool plugin_IrcRelay = LibraryExists("ircrelay");
 if ((BountyIRC) && (plugin_IrcRelay))
+{
@@ Line 133: / Line 133: @@
 ;''IRC Relay: ircrelay.sp''
 <pawn>
-public APLRes:AskPluginLoad2(Handle:myself, bool:late, String:error[], err_max)
+public APLRes AskPluginLoad2(Handle myself, bool late, char[] error, int err_max)
+{
 	//... code here ...
@@ Line 143: / Line 143: @@
 ;''IRC Relay: ircrelay.inc''
 <pawn>
-public SharedPlugin:__pl_ircrelay =
+public SharedPlugin __pl_ircrelay =
+{
 	name = "ircrelay",
@@ Line 155: / Line 155: @@
 #if !defined REQUIRE_PLUGIN
-public __pl_ircrelay_SetNTVOptional()
+public void __pl_ircrelay_SetNTVOptional()
+{
 	MarkNativeAsOptional("IrcMessage");

@@ Line 87: / Line 87: @@
 Additionally, you should expose a function which marks all of your natives as optional.  You can do this by:
-<pawn>public __pl_myfile_SetNTVOptional()
+<pawn>#if !defined REQUIRE_PLUGIN
+{
 	MarkNativeAsOptional("native1");
 	MarkNativeAsOptional("native2");
 	MarkNativeAsOptional("native3");
 }</pawn>
 This function will be secretly called before the plugin loads (if and only if the requirement is optional), thus allowing seamless optional usage by third party developers.  Note that the <tt>__pl_</tt> and <tt>_SetNTVOptional</tt> portions <b>must</b> be present, and that everything in between must match the ending of <tt>__pl_</tt> for the <tt>SharedPlugin</tt> structure.
-You also must register the library name with SourceMod -- again this should be the unique string. This is should be done inside the <code>AskPluginLoad2</code> function.
+You also must register the library name with SourceMod -- again this should be the unique string. This should be done inside the <code>AskPluginLoad2</code> function.
 <pawn>
@@ Line 152: / Line 154: @@
 };
 public __pl_ircrelay_SetNTVOptional()
+{
@@ Line 159: / Line 162: @@
 	MarkNativeAsOptional("IrcGetCmdArgv");
+}
 </pawn>
 The <code>name</code> value is what will be checked when you run <code>LibraryExists</code>. This allows the bounty script to fully work, even if the IRC relay plugin is not installed and/or running correctly on your server.

@@ Line 31: / Line 31: @@
 ==Optional Natives==
-To mark a native as optional, use <tt>MarkNativeAsOptional</tt>.  It should be called in <tt>AskPluginLoad</tt>.  For example:
+To mark a native as optional, use <tt>MarkNativeAsOptional</tt>.  It should be called in <tt>AskPluginLoad2</tt>.  For example:
-<pawn>public bool:AskPluginLoad(Handle:myself, bool:late, String:error[], err_max)
+<pawn>public APLRes:AskPluginLoad2(Handle:myself, bool:late, String:error[], err_max)
+{
 	MarkNativeAsOptional("SDKCall");
-	return true;
+	return APLRes_Success;
 }</pawn>
@@ Line 44: / Line 44: @@
 <pawn>new bool:ircrelay = false;
-public OnPluginStart()
+public OnAllPluginsLoaded()
+{
 	ircrelay = LibraryExists("ircrelay");
@@ Line 96: / Line 96: @@
 This function will be secretly called before the plugin loads (if and only if the requirement is optional), thus allowing seamless optional usage by third party developers.  Note that the <tt>__pl_</tt> and <tt>_SetNTVOptional</tt> portions <b>must</b> be present, and that everything in between must match the ending of <tt>__pl_</tt> for the <tt>SharedPlugin</tt> structure.
-You also must register the library name with SourceMod -- again this should be the unique string. This is should be done inside the <code>OnPluginStart</code> function.
+You also must register the library name with SourceMod -- again this should be the unique string. This is should be done inside the <code>AskPluginLoad2</code> function.
 <pawn>
-public OnPluginStart()
+public APLRes:AskPluginLoad2(Handle:myself, bool:late, String:error[], err_max)
+{
 	//... code here ...
 	RegPluginLibrary("myfile");
+}
 </pawn>
@@ Line 129: / Line 131: @@
 ;''IRC Relay: ircrelay.sp''
 <pawn>
-public OnPluginStart()
+public APLRes:AskPluginLoad2(Handle:myself, bool:late, String:error[], err_max)
+{
 	//... code here ...
 	RegPluginLibrary("ircrelay");
+}
 </pawn>

@@ Line 36: / Line 36: @@
+{
 	MarkNativeAsOptional("SDKCall");
 }</pawn>
 =Checking Optional Dependencies=

← Older revision		Revision as of 00:11, 16 November 2007
Line 160:		Line 160:

	[[Category:SourceMod Scripting]]		[[Category:SourceMod Scripting]]
−	~~[[Category:SourceMod Development]]~~

@@ Line 23: / Line 23: @@
 #include <ircrelay></pawn>
-Note that any plugins included after the <tt>#undef</tt> will also be marked as required.  Thus, you may need to move the include down, or do something like:
+Note that any plugins included after the <tt>#undef</tt> will also be marked as not required.  Thus, you may need to move the include down, or do something like:
 <pawn>#include <sourcemod>

@@ Line 9: / Line 9: @@
 #include <sdktools></pawn>
-Note that any extensions included after the <tt>#undef</tt> will also be marked as required.  Thus, you may need to move the include down, or do something like:
+Note that any extensions included after the <tt>#undef</tt> will also be marked as not required.  Thus, you may need to move the include down, or do something like:
 <pawn>#include <sourcemod>

@@ Line 156: / Line 156: @@
+}
 </pawn>
-The <code>name</code> value is what will be checked when you run <code>LibraryExists</code>. This allows the bounty script to fully work, even if the IRC relay plugin is not installed or running correctly on your server.
+The <code>name</code> value is what will be checked when you run <code>LibraryExists</code>. This allows the bounty script to fully work, even if the IRC relay plugin is not installed and/or running correctly on your server.
 [[Category:SourceMod Scripting]]
 [[Category:SourceMod Development]]