1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/extensions/clientprefs/extension.h Sun Jul 06 04:49:55 2008 +0000
1.3 @@ -0,0 +1,172 @@
1.4 +/**
1.5 + * vim: set ts=4 :
1.6 + * =============================================================================
1.7 + * SourceMod Client Preferences Extension
1.8 + * Copyright (C) 2004-2008 AlliedModders LLC. All rights reserved.
1.9 + * =============================================================================
1.10 + *
1.11 + * This program is free software; you can redistribute it and/or modify it under
1.12 + * the terms of the GNU General Public License, version 3.0, as published by the
1.13 + * Free Software Foundation.
1.14 + *
1.15 + * This program is distributed in the hope that it will be useful, but WITHOUT
1.16 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
1.17 + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
1.18 + * details.
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License along with
1.21 + * this program. If not, see <http://www.gnu.org/licenses/>.
1.22 + *
1.23 + * As a special exception, AlliedModders LLC gives you permission to link the
1.24 + * code of this program (as well as its derivative works) to "Half-Life 2," the
1.25 + * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
1.26 + * by the Valve Corporation. You must obey the GNU General Public License in
1.27 + * all respects for all other code used. Additionally, AlliedModders LLC grants
1.28 + * this exception to all derivative works. AlliedModders LLC defines further
1.29 + * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
1.30 + * or <http://www.sourcemod.net/license.php>.
1.31 + *
1.32 + * Version: $Id$
1.33 + */
1.34 +
1.35 +#ifndef _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_
1.36 +#define _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_
1.37 +
1.38 +#define MAXCLIENTS 64
1.39 +
1.40 +#include <stdlib.h>
1.41 +#include <stdarg.h>
1.42 +#include "smsdk_ext.h"
1.43 +#include "sh_list.h"
1.44 +#include "cookie.h"
1.45 +#include "menus.h"
1.46 +#include "query.h"
1.47 +
1.48 +#define DRIVER_MYSQL 1
1.49 +#define DRIVER_SQLITE 0
1.50 +
1.51 +#define MAX_TRANSLATE_PARAMS 32
1.52 +
1.53 +/**
1.54 + * @brief Sample implementation of the SDK Extension.
1.55 + * Note: Uncomment one of the pre-defined virtual functions in order to use it.
1.56 + */
1.57 +class ClientPrefs : public SDKExtension
1.58 +{
1.59 +public:
1.60 + /**
1.61 + * @brief This is called after the initial loading sequence has been processed.
1.62 + *
1.63 + * @param error Error message buffer.
1.64 + * @param maxlength Size of error message buffer.
1.65 + * @param late Whether or not the module was loaded after map load.
1.66 + * @return True to succeed loading, false to fail.
1.67 + */
1.68 + virtual bool SDK_OnLoad(char *error, size_t maxlength, bool late);
1.69 +
1.70 + /**
1.71 + * @brief This is called right before the extension is unloaded.
1.72 + */
1.73 + virtual void SDK_OnUnload();
1.74 +
1.75 + /**
1.76 + * @brief This is called once all known extensions have been loaded.
1.77 + * Note: It is is a good idea to add natives here, if any are provided.
1.78 + */
1.79 + virtual void SDK_OnAllLoaded();
1.80 +
1.81 + virtual bool QueryInterfaceDrop(SMInterface *pInterface);
1.82 +
1.83 + virtual void NotifyInterfaceDrop(SMInterface *pInterface);
1.84 +
1.85 + /**
1.86 + * @brief Called when the pause state is changed.
1.87 + */
1.88 + //virtual void SDK_OnPauseChange(bool paused);
1.89 +
1.90 + /**
1.91 + * @brief this is called when Core wants to know if your extension is working.
1.92 + *
1.93 + * @param error Error message buffer.
1.94 + * @param maxlength Size of error message buffer.
1.95 + * @return True if working, false otherwise.
1.96 + */
1.97 + //virtual bool QueryRunning(char *error, size_t maxlength);
1.98 +public:
1.99 +#if defined SMEXT_CONF_METAMOD
1.100 + /**
1.101 + * @brief Called when Metamod is attached, before the extension version is called.
1.102 + *
1.103 + * @param error Error buffer.
1.104 + * @param maxlength Maximum size of error buffer.
1.105 + * @param late Whether or not Metamod considers this a late load.
1.106 + * @return True to succeed, false to fail.
1.107 + */
1.108 + //virtual bool SDK_OnMetamodLoad(ISmmAPI *ismm, char *error, size_t maxlength, bool late);
1.109 +
1.110 + /**
1.111 + * @brief Called when Metamod is detaching, after the extension version is called.
1.112 + * NOTE: By default this is blocked unless sent from SourceMod.
1.113 + *
1.114 + * @param error Error buffer.
1.115 + * @param maxlength Maximum size of error buffer.
1.116 + * @return True to succeed, false to fail.
1.117 + */
1.118 + //virtual bool SDK_OnMetamodUnload(char *error, size_t maxlength);
1.119 +
1.120 + /**
1.121 + * @brief Called when Metamod's pause state is changing.
1.122 + * NOTE: By default this is blocked unless sent from SourceMod.
1.123 + *
1.124 + * @param paused Pause state being set.
1.125 + * @param error Error buffer.
1.126 + * @param maxlength Maximum size of error buffer.
1.127 + * @return True to succeed, false to fail.
1.128 + */
1.129 + //virtual bool SDK_OnMetamodPauseChange(bool paused, char *error, size_t maxlength);
1.130 +#endif
1.131 +public:
1.132 + IDBDriver *Driver;
1.133 + IDatabase *Database;
1.134 + IPhraseCollection *phrases;
1.135 +};
1.136 +
1.137 +class CookieTypeHandler : public IHandleTypeDispatch
1.138 +{
1.139 +public:
1.140 + void OnHandleDestroy(HandleType_t type, void *object)
1.141 + {
1.142 + /* No delete needed since Cookies are persistant */
1.143 + }
1.144 +};
1.145 +
1.146 +class CookieIteratorHandler : public IHandleTypeDispatch
1.147 +{
1.148 +public:
1.149 + void OnHandleDestroy(HandleType_t type, void *object)
1.150 + {
1.151 + delete (SourceHook::List<Cookie *>::iterator *)object;
1.152 + }
1.153 +};
1.154 +
1.155 +size_t UTIL_Format(char *buffer, size_t maxlength, const char *fmt, ...);
1.156 +
1.157 +extern sp_nativeinfo_t g_ClientPrefNatives[];
1.158 +
1.159 +extern ClientPrefs g_ClientPrefs;
1.160 +extern HandleType_t g_CookieType;
1.161 +extern CookieTypeHandler g_CookieTypeHandler;
1.162 +
1.163 +extern HandleType_t g_CookieIterator;
1.164 +extern CookieIteratorHandler g_CookieIteratorHandler;
1.165 +
1.166 +bool Translate(char *buffer,
1.167 + size_t maxlength,
1.168 + const char *format,
1.169 + unsigned int numparams,
1.170 + size_t *pOutLength,
1.171 + ...);
1.172 +
1.173 +extern int driver;
1.174 +
1.175 +#endif // _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_
