3 * =============================================================================
4 * SourceMod SQLite Extension
5 * Copyright (C) 2004-2008 AlliedModders LLC. All rights reserved.
6 * =============================================================================
8 * This program is free software; you can redistribute it and/or modify it under
9 * the terms of the GNU General Public License, version 3.0, as published by the
10 * Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but WITHOUT
13 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
14 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
17 * You should have received a copy of the GNU General Public License along with
18 * this program. If not, see <http://www.gnu.org/licenses/>.
20 * As a special exception, AlliedModders LLC gives you permission to link the
21 * code of this program (as well as its derivative works) to "Half-Life 2," the
22 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
23 * by the Valve Corporation. You must obey the GNU General Public License in
24 * all respects for all other code used. Additionally, AlliedModders LLC grants
25 * this exception to all derivative works. AlliedModders LLC defines further
26 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
27 * or <http://www.sourcemod.net/license.php>.
32 #ifndef _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_
33 #define _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_
37 * @brief Sample extension code header.
40 #include "smsdk_ext.h"
44 * @brief Sample implementation of the SDK Extension.
45 * Note: Uncomment one of the pre-defined virtual functions in order to use it.
47 class SqliteExt : public SDKExtension
51 * @brief This is called after the initial loading sequence has been processed.
53 * @param error Error message buffer.
54 * @param maxlength Size of error message buffer.
55 * @param late Whether or not the module was loaded after map load.
56 * @return True to succeed loading, false to fail.
58 virtual bool SDK_OnLoad(char *error, size_t maxlength, bool late);
61 * @brief This is called right before the extension is unloaded.
63 virtual void SDK_OnUnload();
65 const char *GetExtensionVerString();
66 const char *GetExtensionDateString();
69 * @brief This is called once all known extensions have been loaded.
70 * Note: It is is a good idea to add natives here, if any are provided.
72 //virtual void SDK_OnAllLoaded();
75 * @brief Called when the pause state is changed.
77 //virtual void SDK_OnPauseChange(bool paused);
80 * @brief this is called when Core wants to know if your extension is working.
82 * @param error Error message buffer.
83 * @param maxlength Size of error message buffer.
84 * @return True if working, false otherwise.
86 //virtual bool QueryRunning(char *error, size_t maxlength);
88 #if defined SMEXT_CONF_METAMOD
90 * @brief Called when Metamod is attached, before the extension version is called.
92 * @param error Error buffer.
93 * @param maxlength Maximum size of error buffer.
94 * @param late Whether or not Metamod considers this a late load.
95 * @return True to succeed, false to fail.
97 //virtual bool SDK_OnMetamodLoad(ISmmAPI *ismm, char *error, size_t maxlength, bool late);
100 * @brief Called when Metamod is detaching, after the extension version is called.
101 * NOTE: By default this is blocked unless sent from SourceMod.
103 * @param error Error buffer.
104 * @param maxlength Maximum size of error buffer.
105 * @return True to succeed, false to fail.
107 //virtual bool SDK_OnMetamodUnload(char *error, size_t maxlength);
110 * @brief Called when Metamod's pause state is changing.
111 * NOTE: By default this is blocked unless sent from SourceMod.
113 * @param paused Pause state being set.
114 * @param error Error buffer.
115 * @param maxlength Maximum size of error buffer.
116 * @return True to succeed, false to fail.
118 //virtual bool SDK_OnMetamodPauseChange(bool paused, char *error, size_t maxlength);
122 size_t UTIL_Format(char *buffer, size_t maxlength, const char *fmt, ...);
124 #endif // _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_
