SourceMod::SMInterface Class Reference

Defines the base functionality required by a shared interface. More...

#include <public/IShareSys.h>

Inherited by SourceMod::IAdminSystem, SourceMod::IADTFactory, SourceMod::IBinTools, SourceMod::IDBManager, SourceMod::IExtensionManager, SourceMod::IForwardManager, SourceMod::IGameConfigManager, SourceMod::IGameHelpers, SourceMod::IHandleSys, SourceMod::ILibrarySys, SourceMod::IMemoryUtils, SourceMod::IMenuManager, SourceMod::IPlayerManager, SourceMod::IPluginManager, SourceMod::IRootConsole, SourceMod::ISourceMod, SourceMod::ITextParsers, SourceMod::IThreader, SourceMod::ITimerSystem, SourceMod::ITopMenuManager, SourceMod::ITranslator, and SourceMod::IUserMessages.

Inheritance diagram for SourceMod::SMInterface:

[legend]
List of all members.

Public Member Functions

virtual unsigned int GetInterfaceVersion ()=0
 Must return an integer defining the interface's version.
virtual const char * GetInterfaceName ()=0
 Must return a string defining the interface's unique name.
virtual bool IsVersionCompatible (unsigned int version)
 Must return whether the requested version number is backwards compatible. Note: This can be overridden for breaking changes or custom versioning.

Detailed Description

Defines the base functionality required by a shared interface.

Definition at line 60 of file IShareSys.h.


Member Function Documentation

virtual bool SourceMod::SMInterface::IsVersionCompatible ( unsigned int  version  )  [inline, virtual]

Must return whether the requested version number is backwards compatible. Note: This can be overridden for breaking changes or custom versioning.

Parameters:
version Version number to compare against.
Returns:
True if compatible, false otherwise.

Reimplemented in SourceMod::ITopMenuManager, SourceMod::IExtensionManager, SourceMod::IForwardManager, SourceMod::IMenuManager, SourceMod::ITextParsers, and SourceMod::IThreader.

Definition at line 80 of file IShareSys.h.


The documentation for this class was generated from the following file:
Generated on Fri Nov 21 06:10:04 2008 for SourceMod SDK by  doxygen 1.5.1