extensions/tf2/extension.h
author David Anderson <dvander@alliedmods.net>
Wed Feb 25 20:07:12 2009 -0500 (2009-02-25)
changeset 2607 f3b8bbe17f85
parent 2289 44045ead61cd
child 2619 1c0acf43cc0c
permissions -rw-r--r--
Backed out changeset fa286305bd3f
     1 /**
     2  * vim: set ts=4 :
     3  * =============================================================================
     4  * SourceMod Team Fortress 2 Extension
     5  * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
     6  * =============================================================================
     7  *
     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.
    11  * 
    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
    15  * details.
    16  *
    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/>.
    19  *
    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>.
    28  *
    29  * Version: $Id$
    30  */
    31 
    32 #ifndef _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_
    33 #define _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_
    34 
    35 /**
    36  * @file extension.h
    37  * @brief Sample extension code header.
    38  */
    39 
    40 #include "smsdk_ext.h"
    41 #include <IBinTools.h>
    42 #include <server_class.h>
    43 #include <igameevents.h>
    44 
    45 /**
    46  * @brief Sample implementation of the SDK Extension.
    47  * Note: Uncomment one of the pre-defined virtual functions in order to use it.
    48  */
    49 class TF2Tools : 
    50 	public SDKExtension,
    51 	public ICommandTargetProcessor,
    52 	public IConCommandBaseAccessor,
    53 	public IGameEventListener2
    54 {
    55 public:
    56 	/**
    57 	 * @brief This is called after the initial loading sequence has been processed.
    58 	 *
    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.
    63 	 */
    64 	virtual bool SDK_OnLoad(char *error, size_t maxlength, bool late);
    65 	
    66 	/**
    67 	 * @brief This is called right before the extension is unloaded.
    68 	 */
    69 	virtual void SDK_OnUnload();
    70 
    71 	/**
    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.
    74 	 */
    75 	virtual void SDK_OnAllLoaded();
    76 
    77 	/**
    78 	 * @brief Called when the pause state is changed.
    79 	 */
    80 	//virtual void SDK_OnPauseChange(bool paused);
    81 
    82 	/**
    83 	 * @brief this is called when Core wants to know if your extension is working.
    84 	 *
    85 	 * @param error		Error message buffer.
    86 	 * @param maxlength	Size of error message buffer.
    87 	 * @return			True if working, false otherwise.
    88 	 */
    89 	virtual bool QueryRunning(char *error, size_t maxlength);
    90 
    91 	void NotifyInterfaceDrop(SMInterface *pInterface);
    92 	bool QueryInterfaceDrop(SMInterface *pInterface);
    93 public:
    94 	bool ProcessCommandTarget(cmd_target_info_t *info);
    95 	bool RegisterConCommandBase(ConCommandBase *pVar);
    96 
    97 	IGameEventManager2 *m_GameEventManager;
    98 	void FireGameEvent( IGameEvent *event );
    99 public:
   100 #if defined SMEXT_CONF_METAMOD
   101 	/**
   102 	 * @brief Called when Metamod is attached, before the extension version is called.
   103 	 *
   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.
   108 	 */
   109 	virtual bool SDK_OnMetamodLoad(ISmmAPI *ismm, char *error, size_t maxlength, bool late);
   110 
   111 	/**
   112 	 * @brief Called when Metamod is detaching, after the extension version is called.
   113 	 * NOTE: By default this is blocked unless sent from SourceMod.
   114 	 *
   115 	 * @param error			Error buffer.
   116 	 * @param maxlength		Maximum size of error buffer.
   117 	 * @return				True to succeed, false to fail.
   118 	 */
   119 	//virtual bool SDK_OnMetamodUnload(char *error, size_t maxlength);
   120 
   121 	/**
   122 	 * @brief Called when Metamod's pause state is changing.
   123 	 * NOTE: By default this is blocked unless sent from SourceMod.
   124 	 *
   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.
   129 	 */
   130 	//virtual bool SDK_OnMetamodPauseChange(bool paused, char *error, size_t maxlength);
   131 #endif
   132 };
   133 
   134 enum TFClassType
   135 {
   136 	TFClass_Unknown = 0,
   137 	TFClass_Scout,
   138 	TFClass_Sniper,
   139 	TFClass_Soldier,
   140 	TFClass_DemoMan,
   141 	TFClass_Medic,
   142 	TFClass_Heavy,
   143 	TFClass_Pyro,
   144 	TFClass_Spy,
   145 	TFClass_Engineer
   146 };
   147 
   148 TFClassType ClassnameToType(const char *classname);
   149 
   150 extern IBinTools *g_pBinTools;
   151 extern IGameConfig *g_pGameConf;
   152 extern sm_sendprop_info_t *playerSharedOffset;
   153 
   154 void OnServerActivate(edict_t *pEdictList, int edictCount, int clientMax);
   155 
   156 int FindResourceEntity();
   157 int FindEntityByNetClass(int start, const char *classname);
   158 
   159 extern int g_resourceEntity;
   160 
   161 
   162 #endif // _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_