MM:S API Differences - Revision history

BAILOPAN at 07:30, 26 November 2008

2008-11-26T07:30:31Z

BAILOPAN at 07:30, 26 November 2008

2008-11-26T07:30:08Z

BAILOPAN at 07:26, 26 November 2008

2008-11-26T07:26:56Z

BAILOPAN: Engine Portability and MM:S Plugins moved to MM:S API Differences

2008-11-26T07:25:48Z

Engine Portability and MM:S Plugins moved to MM:S API Differences

BAILOPAN at 07:25, 26 November 2008

2008-11-26T07:25:02Z

BAILOPAN: Editing Engine Portability and MM:S Plugins moved to Engine Portability and MM:S Plugins

2008-11-26T07:18:56Z

Editing Engine Portability and MM:S Plugins moved to Engine Portability and MM:S Plugins

BAILOPAN at 07:18, 26 November 2008

2008-11-26T07:18:48Z

BAILOPAN: Upgrading Plugins to Metamod:Source 1.6.0 moved to Editing Engine Portability and MM:S Plugins

2008-11-26T07:12:31Z

Upgrading Plugins to Metamod:Source 1.6.0 moved to Editing Engine Portability and MM:S Plugins

BAILOPAN at 02:24, 18 October 2007

2007-10-18T02:24:45Z

Mani: /* Breaking */

2007-10-16T21:16:26Z

‎Breaking

@@ Line 2: / Line 2: @@
 If you want to write a Metamod:Source plugin that works against both engines, ultimately you must take care to make sure it compiles against both APIs.
 =What to Use=
@@ Line 10: / Line 18: @@
 **Orange Box (Team Fortress, Day of Defeat, Garry's Mod)
 **Left 4 Dead

← Older revision		Revision as of 07:30, 26 November 2008
Line 2:		Line 2:

	If you want to write a Metamod:Source plugin that works against both engines, ultimately you must take care to make sure it compiles against both APIs.		If you want to write a Metamod:Source plugin that works against both engines, ultimately you must take care to make sure it compiles against both APIs.
		+
		+	=What to Use=
		+	*[http://www.metamodsource.net/dox-1.4.3/ 1.4 API], contained in <tt>core-legacy</tt>. This is the API you should use if you're building a plugin to run on the following Source engines:
		+	**Episode 1 (CS:S, and third party mods).
		+	**Original (The Ship)
		+	*[http://www.metamodsource.net/dox/ 1.6 API], contained in <tt>core</tt>. This is the API you should use if you're building against the following Source engines:
		+	**Orange Box (Team Fortress, Day of Defeat, Garry's Mod)
		+	**Left 4 Dead

← Older revision		Revision as of 07:26, 26 November 2008
Line 1:		Line 1:
	Metamod:Source broke API compatibility when adding Orange Box support. The old API was not maintainable. This article describes the changes from the 1.4 API to the 1.6 API (core-legacy versus core).		Metamod:Source broke API compatibility when adding Orange Box support. The old API was not maintainable. This article describes the changes from the 1.4 API to the 1.6 API (core-legacy versus core).
		+
		+	If you want to write a Metamod:Source plugin that works against both engines, ultimately you must take care to make sure it compiles against both APIs.
		+

	=Metamod API History=		=Metamod API History=

@@ Line 1: / Line 1: @@
-Portability between Source engine versions is tricky.  Each SDK can change fundamental calls, and Metamod:Source itself has compatibility breaks.  This article documents everything you need to know.
+Metamod:Source broke API compatibility when adding Orange Box support.  The old API was not maintainable.  This article describes the changes from the 1.4 API to the 1.6 API (core-legacy versus core).
 =Metamod API History=
@@ Line 6: / Line 6: @@
 As the name suggests, the 1.4 API is legacy and is only used on the Episode 1 engines and older.  The 1.6 API is used on all new engines, including Orange Box (for TF and DoDS) and Left 4 Dead.
-Unfortunately, the APIs are not compatible.  Some functions were removed and others were renamed.  For this reason, it is not easily possible to compile a single binary that works on both
+Unfortunately, the APIs are not compatible.  Some functions were removed and others were renamed.  For this reason it is not easily possible to compile a single binary that works on both.  However, there is an advanced loading API that allows you to to route load requests to alternate binaries.  This allows you to distribute unified packages.  This is explained later in this article.
 =Renamed Calls=
 ==Transparent==
-The following functions have received simple renamings, which should be transparent from the <tt>META_REGCMD</tt> and <tt>META_REGCVAR</tt> macros.
+The following functions were renamed.  These changes are masked by the <tt>META_REGCMD</tt> and <tt>META_REGCVAR</tt> macros and should not affect anyone.
 *<tt>RegisterConCmdBase()</tt> -> <tt>RegisterConCommandBase()</tt>
 *<tt>UnregisterConCmdBase()</tt> -> <tt>UnregisterConCommandBase()</tt>
 ==Breaking==
-<tt>oslink.h</tt> was renamed to <tt>metamod_oslink.h</tt>.  This file is not a public file, however, it has some useful macros and a few plugins used it.
+<tt>oslink.h</tt> was renamed to <tt>metamod_oslink.h</tt>.  This file is not a public file and should not be included, so it may be removed in the future.
 The following functions have received simple renamings, however, old code will be affected.
@@ Line 30: / Line 32: @@
 To this:
 <cpp>GET_V_IFACE_CURRENT(GetEngineFactory, engine, IVEngineServer, INTERFACEVERSION_VENGINESERVER);</cpp>
 =Removed Calls=
@@ Line 39: / Line 42: @@
 <tt>SH_GET_CALLCLASS</tt> and <tt>SH_RELEASE_CALLCLASS</tt> have been removed.  For more information, see the [[SourceHook_Development#Bypassing_Hooks|updated SH_CALL syntax]].
 =Changed Calls=
@@ Line 44: / Line 48: @@
 <tt>SH_CALL</tt> and <tt>SH_MCALL</tt> are changed - the concept of "CallClasses" has been removed, and these macros are now much simpler.  See the [[SourceHook_Development#Bypassing_Hooks|updated SH_CALL syntax]].
 =Miscellaneous=
@@ Line 56: / Line 59: @@
 *SourceHook Version: 4.3
-Versiono 1.5.0 (unureleased) had the following version numbers:
+Version 1.5.0 (unureleased) had the following version numbers:
 *API Major: 1
 *API Minor: 6
@@ Line 83: / Line 86: @@
 *<tt>ISmmAPI::Format</tt> and <tt>ISmmAPI::FormatArgs</tt> are new platform-safe replacements for <tt>snprintf</tt> and <tt>vsnprintf</tt>.
 *<tt>ISmmAPI::GetSourceEngineBuild()</tt> returns a constant describing the Source engine version.
-*<tt>ISmmAPI::GetVSPInfo()</tt> returns information about Valve Server Plugin interface, if enabled through Metamod:Source.
+*<tt>ISmmAPI::GetVSPInfo()</tt> returns information about the Valve Server Plugin interface, if enabled through Metamod:Source.
 SourceHook has many new changes, the greatest of which is "global hooks," which can hook a function on any number of instances of that derived class.  See [[SourceHook Development]] for more information.
 Metamod:Source 1.6.0 provides an alternative method of implementing a plugin's loading and instantiation process.  This method allows authors to implement very simple loader interfaces which can pass different plugin implementations based on the current Metamod:Source version.  For example, the loader can detect engine version A versus engine version B, and load an alternate library.
@@ Line 100: / Line 104: @@
-=Where is 1.6.0 for the Original Engine?=
+=Is there 1.6 API for the original engine?=
-Metamod:Source 1.6's original upgrade path was very confusing.  After the community's initial response, we have slightly altered the upgrade path.  Metamod:Source 1.4 will always remain the stable, supported branch for development on the original Source engine.  Metamod:Source 1.6 is intended for all engines on Orange Box or later.  Thus, the download link for "Metamod:Source 1.6.0 on the Original Source Engine" has been removed.
+No.  There are no immediate plans to do this because they are not compatible, and it would confuse people.
 [[Category:Metamod:Source Development]]

← Older revision		Revision as of 07:18, 26 November 2008
Line 1:		Line 1:
−	Metamod:Source 1.6.~~0 makes several~~ API ~~changes which may affect plugins~~. ~~These changes~~ are ~~fully documented below~~.	+	Portability between Source engine versions is tricky. Each SDK can change fundamental calls, and Metamod:Source itself has compatibility breaks. This article documents everything you need to know.
		+
		+	=Metamod API History=
		+	Metamod:Source contains two APIs, the "1.6 API" (contained in <tt>core</tt>) and the "1.4 API" (contained in <tt>core-legacy</tt>).
		+
		+	As the name suggests, the 1.4 API is legacy and is only used on the Episode 1 engines and older. The 1.6 API is used on all new engines, including Orange Box (for TF and DoDS) and Left 4 Dead.
		+
		+	Unfortunately, the APIs are not compatible. Some functions were removed and others were renamed. For this reason, it is not easily possible to compile a single binary that works on both

	=Renamed Calls=		=Renamed Calls=

← Older revision	Revision as of 07:25, 26 November 2008
(No difference)

← Older revision	Revision as of 07:12, 26 November 2008
(No difference)

← Older revision		Revision as of 02:24, 18 October 2007
Line 92:		Line 92:
	Note that this plugin uses the new "extended loading" API available in Metamod:Source 1.6.0. The thin-loader library runs on any Metamod:Source version, and will correctly pick one of 6 child plugins to load. This allows Stripper:Source to be distributed as one package with no configuration hassle.		Note that this plugin uses the new "extended loading" API available in Metamod:Source 1.6.0. The thin-loader library runs on any Metamod:Source version, and will correctly pick one of 6 child plugins to load. This allows Stripper:Source to be distributed as one package with no configuration hassle.

		+
		+	=Where is 1.6.0 for the Original Engine?=
		+	Metamod:Source 1.6's original upgrade path was very confusing. After the community's initial response, we have slightly altered the upgrade path. Metamod:Source 1.4 will always remain the stable, supported branch for development on the original Source engine. Metamod:Source 1.6 is intended for all engines on Orange Box or later. Thus, the download link for "Metamod:Source 1.6.0 on the Original Source Engine" has been removed.
		+
		+	Of course, Metamod:Source 1.6.0 features many API and SourceHook improvements. If you are a developer who wishes to take advantage of these improvements on the original engine, there are two methods of retrieving binaries:
		+	*Build them from source code.
		+	*[http://www.sourcemm.net/autobuilds/1.6.0/ Look in the package folder].
		+
		+	It is recommended that developers do not release plugins compiled against 1.6.0 for the original Source engine. It is provided for technical interest only, and thus the majority of people in the community will be running Metamod:Source 1.4.x, which is incompatible.
		+
		+	When Valve deprecates the original Source engine, Metamod:Source 1.4 will continue to be the stable branch for that platform. However, at that point, the vast majority of users will be running the Orange Box engine.

	[[Category:Metamod:Source Development]]		[[Category:Metamod:Source Development]]

@@ Line 11: / Line 11: @@
 The following functions have received simple renamings, however, old code will be affected.
-*<tt>pGlobals()</tt> -> <tt>GetCClobals</tt>
+*<tt>pGlobals()</tt> -> <tt>GetCGlobals</tt>
 *<tt>engineFactory()</tt> -> <tt>GetEngineFactory()</tt>
 *<tt>serverFactory()</tt> -> <tt>GetServerFactory()</tt>
@@ Line 23: / Line 23: @@
 To this:
 <cpp>GET_V_IFACE_CURRENT(GetEngineFactory, engine, IVEngineServer, INTERFACEVERSION_VENGINESERVER);</cpp>
 =Removed Calls=