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();
66 * @brief This is called once all known extensions have been loaded.
67 * Note: It is is a good idea to add natives here, if any are provided.
69 //virtual void SDK_OnAllLoaded();
72 * @brief Called when the pause state is changed.
74 //virtual void SDK_OnPauseChange(bool paused);
77 * @brief this is called when Core wants to know if your extension is working.
79 * @param error Error message buffer.
80 * @param maxlength Size of error message buffer.
81 * @return True if working, false otherwise.
83 //virtual bool QueryRunning(char *error, size_t maxlength);
85 #if defined SMEXT_CONF_METAMOD
87 * @brief Called when Metamod is attached, before the extension version is called.
89 * @param error Error buffer.
90 * @param maxlength Maximum size of error buffer.
91 * @param late Whether or not Metamod considers this a late load.
92 * @return True to succeed, false to fail.
94 //virtual bool SDK_OnMetamodLoad(ISmmAPI *ismm, char *error, size_t maxlength, bool late);
97 * @brief Called when Metamod is detaching, after the extension version is called.
98 * NOTE: By default this is blocked unless sent from SourceMod.
100 * @param error Error buffer.
101 * @param maxlength Maximum size of error buffer.
102 * @return True to succeed, false to fail.
104 //virtual bool SDK_OnMetamodUnload(char *error, size_t maxlength);
107 * @brief Called when Metamod's pause state is changing.
108 * NOTE: By default this is blocked unless sent from SourceMod.
110 * @param paused Pause state being set.
111 * @param error Error buffer.
112 * @param maxlength Maximum size of error buffer.
113 * @return True to succeed, false to fail.
115 //virtual bool SDK_OnMetamodPauseChange(bool paused, char *error, size_t maxlength);
119 size_t UTIL_Format(char *buffer, size_t maxlength, const char *fmt, ...);
121 #endif // _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_
