dvander@1203: /**
dvander@1203: * vim: set ts=4 :
ds@1330: * =============================================================================
dvander@1226: * SourceMod SQLite Extension
ds@1947: * Copyright (C) 2004-2008 AlliedModders LLC. All rights reserved.
ds@1330: * =============================================================================
dvander@1203: *
ds@1330: * This program is free software; you can redistribute it and/or modify it under
ds@1330: * the terms of the GNU General Public License, version 3.0, as published by the
ds@1330: * Free Software Foundation.
dvander@1226: *
ds@1330: * This program is distributed in the hope that it will be useful, but WITHOUT
ds@1330: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
ds@1330: * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
ds@1330: * details.
dvander@1226: *
ds@1330: * You should have received a copy of the GNU General Public License along with
ds@1330: * this program. If not, see .
dvander@1226: *
ds@1330: * As a special exception, AlliedModders LLC gives you permission to link the
ds@1330: * code of this program (as well as its derivative works) to "Half-Life 2," the
ds@1330: * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
ds@1330: * by the Valve Corporation. You must obey the GNU General Public License in
ds@1330: * all respects for all other code used. Additionally, AlliedModders LLC grants
ds@1330: * this exception to all derivative works. AlliedModders LLC defines further
ds@1330: * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
ds@1330: * or .
dvander@1203: *
dvander@1203: * Version: $Id$
dvander@1203: */
dvander@1203:
dvander@1203: #ifndef _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_
dvander@1203: #define _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_
dvander@1203:
dvander@1203: /**
dvander@1203: * @file extension.h
dvander@1203: * @brief Sample extension code header.
dvander@1203: */
dvander@1203:
dvander@1203: #include "smsdk_ext.h"
dvander@1203:
dvander@1203:
dvander@1203: /**
dvander@1203: * @brief Sample implementation of the SDK Extension.
dvander@1203: * Note: Uncomment one of the pre-defined virtual functions in order to use it.
dvander@1203: */
dvander@1203: class SqliteExt : public SDKExtension
dvander@1203: {
dvander@1203: public:
dvander@1203: /**
dvander@1203: * @brief This is called after the initial loading sequence has been processed.
dvander@1203: *
dvander@1203: * @param error Error message buffer.
dvander@1203: * @param maxlength Size of error message buffer.
dvander@1203: * @param late Whether or not the module was loaded after map load.
dvander@1203: * @return True to succeed loading, false to fail.
dvander@1203: */
dvander@1203: virtual bool SDK_OnLoad(char *error, size_t maxlength, bool late);
dvander@1203:
dvander@1203: /**
dvander@1203: * @brief This is called right before the extension is unloaded.
dvander@1203: */
dvander@1203: virtual void SDK_OnUnload();
dvander@1203:
dvander@1203: /**
dvander@1203: * @brief This is called once all known extensions have been loaded.
dvander@1203: * Note: It is is a good idea to add natives here, if any are provided.
dvander@1203: */
dvander@1203: //virtual void SDK_OnAllLoaded();
dvander@1203:
dvander@1203: /**
dvander@1203: * @brief Called when the pause state is changed.
dvander@1203: */
dvander@1203: //virtual void SDK_OnPauseChange(bool paused);
dvander@1203:
dvander@1203: /**
dvander@1203: * @brief this is called when Core wants to know if your extension is working.
dvander@1203: *
dvander@1203: * @param error Error message buffer.
dvander@1203: * @param maxlength Size of error message buffer.
dvander@1203: * @return True if working, false otherwise.
dvander@1203: */
dvander@1203: //virtual bool QueryRunning(char *error, size_t maxlength);
dvander@1203: public:
dvander@1203: #if defined SMEXT_CONF_METAMOD
dvander@1203: /**
dvander@1203: * @brief Called when Metamod is attached, before the extension version is called.
dvander@1203: *
dvander@1203: * @param error Error buffer.
dvander@1203: * @param maxlength Maximum size of error buffer.
dvander@1203: * @param late Whether or not Metamod considers this a late load.
dvander@1203: * @return True to succeed, false to fail.
dvander@1203: */
dvander@1203: //virtual bool SDK_OnMetamodLoad(ISmmAPI *ismm, char *error, size_t maxlength, bool late);
dvander@1203:
dvander@1203: /**
dvander@1203: * @brief Called when Metamod is detaching, after the extension version is called.
dvander@1203: * NOTE: By default this is blocked unless sent from SourceMod.
dvander@1203: *
dvander@1203: * @param error Error buffer.
dvander@1203: * @param maxlength Maximum size of error buffer.
dvander@1203: * @return True to succeed, false to fail.
dvander@1203: */
dvander@1203: //virtual bool SDK_OnMetamodUnload(char *error, size_t maxlength);
dvander@1203:
dvander@1203: /**
dvander@1203: * @brief Called when Metamod's pause state is changing.
dvander@1203: * NOTE: By default this is blocked unless sent from SourceMod.
dvander@1203: *
dvander@1203: * @param paused Pause state being set.
dvander@1203: * @param error Error buffer.
dvander@1203: * @param maxlength Maximum size of error buffer.
dvander@1203: * @return True to succeed, false to fail.
dvander@1203: */
dvander@1203: //virtual bool SDK_OnMetamodPauseChange(bool paused, char *error, size_t maxlength);
dvander@1203: #endif
dvander@1203: };
dvander@1203:
dvander@1203: size_t UTIL_Format(char *buffer, size_t maxlength, const char *fmt, ...);
dvander@1203:
dvander@1203: #endif // _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_