1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/extensions/bintools/extension.h Sun Jul 06 04:49:55 2008 +0000
1.3 @@ -0,0 +1,121 @@
1.4 +/**
1.5 + * vim: set ts=4 :
1.6 + * =============================================================================
1.7 + * SourceMod BinTools 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 +/**
1.39 + * @file extension.h
1.40 + * @brief Sample extension code header.
1.41 + */
1.42 +
1.43 +#include "smsdk_ext.h"
1.44 +
1.45 +
1.46 +/**
1.47 + * @brief Implementation of the BinTools extension.
1.48 + * Note: Uncomment one of the pre-defined virtual functions in order to use it.
1.49 + */
1.50 +class BinTools : public SDKExtension
1.51 +{
1.52 +public:
1.53 + /**
1.54 + * @brief This is called after the initial loading sequence has been processed.
1.55 + *
1.56 + * @param error Error message buffer.
1.57 + * @param maxlength Size of error message buffer.
1.58 + * @param late Whether or not the module was loaded after map load.
1.59 + * @return True to succeed loading, false to fail.
1.60 + */
1.61 + virtual bool SDK_OnLoad(char *error, size_t maxlength, bool late);
1.62 +
1.63 + /**
1.64 + * @brief This is called right before the extension is unloaded.
1.65 + */
1.66 + //virtual void SDK_OnUnload();
1.67 +
1.68 + /**
1.69 + * @brief This is called once all known extensions have been loaded.
1.70 + * Note: It is is a good idea to add natives here, if any are provided.
1.71 + */
1.72 + //virtual void SDK_OnAllLoaded();
1.73 +
1.74 + /**
1.75 + * @brief Called when the pause state is changed.
1.76 + */
1.77 + //virtual void SDK_OnPauseChange(bool paused);
1.78 +
1.79 + /**
1.80 + * @brief this is called when Core wants to know if your extension is working.
1.81 + *
1.82 + * @param error Error message buffer.
1.83 + * @param maxlength Size of error message buffer.
1.84 + * @return True if working, false otherwise.
1.85 + */
1.86 + //virtual bool QueryRunning(char *error, size_t maxlength);
1.87 +public:
1.88 +#if defined SMEXT_CONF_METAMOD
1.89 + /**
1.90 + * @brief Called when Metamod is attached, before the extension version is called.
1.91 + *
1.92 + * @param error Error buffer.
1.93 + * @param maxlength Maximum size of error buffer.
1.94 + * @param late Whether or not Metamod considers this a late load.
1.95 + * @return True to succeed, false to fail.
1.96 + */
1.97 + //virtual bool SDK_OnMetamodLoad(ISmmAPI *ismm, char *error, size_t maxlength, bool late);
1.98 +
1.99 + /**
1.100 + * @brief Called when Metamod is detaching, after the extension version is called.
1.101 + * NOTE: By default this is blocked unless sent from SourceMod.
1.102 + *
1.103 + * @param error Error buffer.
1.104 + * @param maxlength Maximum size of error buffer.
1.105 + * @return True to succeed, false to fail.
1.106 + */
1.107 + //virtual bool SDK_OnMetamodUnload(char *error, size_t maxlength);
1.108 +
1.109 + /**
1.110 + * @brief Called when Metamod's pause state is changing.
1.111 + * NOTE: By default this is blocked unless sent from SourceMod.
1.112 + *
1.113 + * @param paused Pause state being set.
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_OnMetamodPauseChange(bool paused, char *error, size_t maxlength);
1.119 +#endif
1.120 +};
1.121 +
1.122 +extern ISourcePawnEngine *g_SPEngine;
1.123 +
1.124 +#endif // _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_
