dvander@1488: /**
dvander@1488:  * vim: set ts=4 :
dvander@1488:  * =============================================================================
dvander@1488:  * SourceMod Sample Extension
ds@1947:  * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
dvander@1488:  * =============================================================================
dvander@1488:  *
dvander@1488:  * This program is free software; you can redistribute it and/or modify it under
dvander@1488:  * the terms of the GNU General Public License, version 3.0, as published by the
dvander@1488:  * Free Software Foundation.
dvander@1488:  * 
dvander@1488:  * This program is distributed in the hope that it will be useful, but WITHOUT
dvander@1488:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
dvander@1488:  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
dvander@1488:  * details.
dvander@1488:  *
dvander@1488:  * You should have received a copy of the GNU General Public License along with
dvander@1488:  * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1488:  *
dvander@1488:  * As a special exception, AlliedModders LLC gives you permission to link the
dvander@1488:  * code of this program (as well as its derivative works) to "Half-Life 2," the
dvander@1488:  * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
dvander@1488:  * by the Valve Corporation.  You must obey the GNU General Public License in
dvander@1488:  * all respects for all other code used.  Additionally, AlliedModders LLC grants
dvander@1488:  * this exception to all derivative works.  AlliedModders LLC defines further
dvander@1488:  * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
dvander@1488:  * or <http://www.sourcemod.net/license.php>.
dvander@1488:  *
dvander@1491:  * Version: $Id$
dvander@1488:  */
dvander@1488: 
dvander@1488: #ifndef _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_
dvander@1488: #define _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_
dvander@1488: 
dvander@1488: /**
dvander@1488:  * @file extension.h
dvander@1488:  * @brief Sample extension code header.
dvander@1488:  */
dvander@1488: 
dvander@1488: #include "smsdk_ext.h"
dvander@1488: 
dvander@1488: 
dvander@1488: /**
dvander@1488:  * @brief Sample implementation of the SDK Extension.
dvander@1488:  * Note: Uncomment one of the pre-defined virtual functions in order to use it.
dvander@1488:  */
dvander@1488: class TopMenuExtension : public SDKExtension
dvander@1488: {
dvander@1488: public:
dvander@1488: 	/**
dvander@1488: 	 * @brief This is called after the initial loading sequence has been processed.
dvander@1488: 	 *
dvander@1488: 	 * @param error		Error message buffer.
dvander@1488: 	 * @param maxlength	Size of error message buffer.
dvander@1488: 	 * @param late		Whether or not the module was loaded after map load.
dvander@1488: 	 * @return			True to succeed loading, false to fail.
dvander@1488: 	 */
dvander@1488: 	virtual bool SDK_OnLoad(char *error, size_t maxlength, bool late);
dvander@1488: 	
dvander@1488: 	/**
dvander@1488: 	 * @brief This is called right before the extension is unloaded.
dvander@1488: 	 */
dvander@1488: 	virtual void SDK_OnUnload();
dvander@1488: };
dvander@1488: 
dvander@1488: #endif // _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_