3 * =============================================================================
4 * SourceMod Team Fortress 2 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"
41 #include <IBinTools.h>
42 #include <server_class.h>
43 #include <igameevents.h>
46 * @brief Sample implementation of the SDK Extension.
47 * Note: Uncomment one of the pre-defined virtual functions in order to use it.
51 public ICommandTargetProcessor,
52 public IConCommandBaseAccessor,
53 public IGameEventListener2
57 * @brief This is called after the initial loading sequence has been processed.
59 * @param error Error message buffer.
60 * @param maxlength Size of error message buffer.
61 * @param late Whether or not the module was loaded after map load.
62 * @return True to succeed loading, false to fail.
64 virtual bool SDK_OnLoad(char *error, size_t maxlength, bool late);
67 * @brief This is called right before the extension is unloaded.
69 virtual void SDK_OnUnload();
72 * @brief This is called once all known extensions have been loaded.
73 * Note: It is is a good idea to add natives here, if any are provided.
75 virtual void SDK_OnAllLoaded();
78 * @brief Called when the pause state is changed.
80 //virtual void SDK_OnPauseChange(bool paused);
83 * @brief this is called when Core wants to know if your extension is working.
85 * @param error Error message buffer.
86 * @param maxlength Size of error message buffer.
87 * @return True if working, false otherwise.
89 virtual bool QueryRunning(char *error, size_t maxlength);
91 void NotifyInterfaceDrop(SMInterface *pInterface);
92 bool QueryInterfaceDrop(SMInterface *pInterface);
94 bool ProcessCommandTarget(cmd_target_info_t *info);
95 bool RegisterConCommandBase(ConCommandBase *pVar);
97 IGameEventManager2 *m_GameEventManager;
98 void FireGameEvent( IGameEvent *event );
100 #if defined SMEXT_CONF_METAMOD
102 * @brief Called when Metamod is attached, before the extension version is called.
104 * @param error Error buffer.
105 * @param maxlength Maximum size of error buffer.
106 * @param late Whether or not Metamod considers this a late load.
107 * @return True to succeed, false to fail.
109 virtual bool SDK_OnMetamodLoad(ISmmAPI *ismm, char *error, size_t maxlength, bool late);
112 * @brief Called when Metamod is detaching, after the extension version is called.
113 * NOTE: By default this is blocked unless sent from SourceMod.
115 * @param error Error buffer.
116 * @param maxlength Maximum size of error buffer.
117 * @return True to succeed, false to fail.
119 //virtual bool SDK_OnMetamodUnload(char *error, size_t maxlength);
122 * @brief Called when Metamod's pause state is changing.
123 * NOTE: By default this is blocked unless sent from SourceMod.
125 * @param paused Pause state being set.
126 * @param error Error buffer.
127 * @param maxlength Maximum size of error buffer.
128 * @return True to succeed, false to fail.
130 //virtual bool SDK_OnMetamodPauseChange(bool paused, char *error, size_t maxlength);
148 TFClassType ClassnameToType(const char *classname);
150 extern IBinTools *g_pBinTools;
151 extern IGameConfig *g_pGameConf;
152 extern sm_sendprop_info_t *playerSharedOffset;
154 void OnServerActivate(edict_t *pEdictList, int edictCount, int clientMax);
156 int FindResourceEntity();
157 int FindEntityByNetClass(int start, const char *classname);
159 extern int g_resourceEntity;
162 #endif // _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_