sourcemod/public/extensions/ISDKTools.h

/**
 * vim: set ts=4 :
 * =============================================================================
 * SourceMod SDKTools Extension
 * Copyright (C) 2004-2009 AlliedModders LLC.  All rights reserved.
 * =============================================================================
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, version 3.0, as published by the
 * Free Software Foundation.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * As a special exception, AlliedModders LLC gives you permission to link the
 * code of this program (as well as its derivative works) to "Half-Life 2," the
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
 * by the Valve Corporation.  You must obey the GNU General Public License in
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
 * this exception to all derivative works.  AlliedModders LLC defines further
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
 * or <http://www.sourcemod.net/license.php>.
 *
 * Version: $Id$
 */

#ifndef _INCLUDE_SMEXT_I_SDKTOOLS_H_
#define _INCLUDE_SMEXT_I_SDKTOOLS_H_

#include <IShareSys.h>

#define SMINTERFACE_SDKTOOLS_NAME		"ISDKTools"
#define SMINTERFACE_SDKTOOLS_VERSION	2

class IServer;

/**
 * @brief SDKTools shared API
 * @file ISDKTools.h
 */

namespace SourceMod
{
	/**
	 * @brief SDKTools API.
	 */
	class ISDKTools : public SMInterface
	{
	public:
		virtual const char *GetInterfaceName() = 0;
		virtual unsigned int GetInterfaceVersion() = 0;
	public:
		/**
		 * @brief Returns a pointer to IServer if one was found.
		 *
		 * @return			IServer pointer, or NULL if SDKTools was unable to find one.
		 */
		virtual IServer* GetIServer() = 0;
		
		/**
		 * @brief Returns a pointer to game's CGameRules class.
		 *
		 * @return			CGameRules pointer or NULL if not found.
		 */
		virtual void* GetGameRules() = 0;
	};
}

#endif /* _INCLUDE_SMEXT_I_SDKTOOLS_H_ */