extensions/tf2/extension.h
author Nicholas Hastings <skamonkey@gmail.com>
Mon Jun 28 17:48:14 2010 -0400 (2010-06-28)
changeset 3056 4e1591dceb8d
parent 2790 6dd851ba15fd
child 3151 aef99299f88b
permissions -rw-r--r--
Added forward/detour for TF2's GetHoliday function (bug 4462, r=pred)
dvander@1945
     1
/**
dvander@1945
     2
 * vim: set ts=4 :
dvander@1945
     3
 * =============================================================================
pred@1963
     4
 * SourceMod Team Fortress 2 Extension
ds@1947
     5
 * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
dvander@1945
     6
 * =============================================================================
dvander@1945
     7
 *
dvander@1945
     8
 * This program is free software; you can redistribute it and/or modify it under
dvander@1945
     9
 * the terms of the GNU General Public License, version 3.0, as published by the
dvander@1945
    10
 * Free Software Foundation.
dvander@1945
    11
 * 
dvander@1945
    12
 * This program is distributed in the hope that it will be useful, but WITHOUT
dvander@1945
    13
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
dvander@1945
    14
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
dvander@1945
    15
 * details.
dvander@1945
    16
 *
dvander@1945
    17
 * You should have received a copy of the GNU General Public License along with
dvander@1945
    18
 * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1945
    19
 *
dvander@1945
    20
 * As a special exception, AlliedModders LLC gives you permission to link the
dvander@1945
    21
 * code of this program (as well as its derivative works) to "Half-Life 2," the
dvander@1945
    22
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
dvander@1945
    23
 * by the Valve Corporation.  You must obey the GNU General Public License in
dvander@1945
    24
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
dvander@1945
    25
 * this exception to all derivative works.  AlliedModders LLC defines further
dvander@1945
    26
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
dvander@1945
    27
 * or <http://www.sourcemod.net/license.php>.
dvander@1945
    28
 *
dvander@1945
    29
 * Version: $Id$
dvander@1945
    30
 */
dvander@1945
    31
dvander@1945
    32
#ifndef _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_
dvander@1945
    33
#define _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_
dvander@1945
    34
dvander@1945
    35
/**
dvander@1945
    36
 * @file extension.h
dvander@1945
    37
 * @brief Sample extension code header.
dvander@1945
    38
 */
dvander@1945
    39
dvander@1945
    40
#include "smsdk_ext.h"
dvander@1945
    41
#include <IBinTools.h>
ds@2051
    42
#include <server_class.h>
pred@2075
    43
#include <igameevents.h>
dvander@1945
    44
dvander@1945
    45
/**
dvander@1945
    46
 * @brief Sample implementation of the SDK Extension.
dvander@1945
    47
 * Note: Uncomment one of the pre-defined virtual functions in order to use it.
dvander@1945
    48
 */
dvander@1945
    49
class TF2Tools : 
dvander@1945
    50
	public SDKExtension,
pred@1979
    51
	public ICommandTargetProcessor,
pred@2075
    52
	public IConCommandBaseAccessor,
pred@2619
    53
	public IGameEventListener2,
pred@2619
    54
	public IPluginsListener
dvander@1945
    55
{
pred@2619
    56
public: //SDKExtension
dvander@1945
    57
	/**
dvander@1945
    58
	 * @brief This is called after the initial loading sequence has been processed.
dvander@1945
    59
	 *
dvander@1945
    60
	 * @param error		Error message buffer.
dvander@1945
    61
	 * @param maxlength	Size of error message buffer.
dvander@1945
    62
	 * @param late		Whether or not the module was loaded after map load.
dvander@1945
    63
	 * @return			True to succeed loading, false to fail.
dvander@1945
    64
	 */
dvander@1945
    65
	virtual bool SDK_OnLoad(char *error, size_t maxlength, bool late);
dvander@1945
    66
	
dvander@1945
    67
	/**
dvander@1945
    68
	 * @brief This is called right before the extension is unloaded.
dvander@1945
    69
	 */
dvander@1945
    70
	virtual void SDK_OnUnload();
dvander@1945
    71
dvander@1945
    72
	/**
dvander@1945
    73
	 * @brief This is called once all known extensions have been loaded.
dvander@1945
    74
	 * Note: It is is a good idea to add natives here, if any are provided.
dvander@1945
    75
	 */
dvander@1945
    76
	virtual void SDK_OnAllLoaded();
dvander@1945
    77
dvander@1945
    78
	/**
dvander@1945
    79
	 * @brief this is called when Core wants to know if your extension is working.
dvander@1945
    80
	 *
dvander@1945
    81
	 * @param error		Error message buffer.
dvander@1945
    82
	 * @param maxlength	Size of error message buffer.
dvander@1945
    83
	 * @return			True if working, false otherwise.
dvander@1945
    84
	 */
dvander@1945
    85
	virtual bool QueryRunning(char *error, size_t maxlength);
dvander@1945
    86
dvander@1945
    87
	void NotifyInterfaceDrop(SMInterface *pInterface);
dvander@1945
    88
	bool QueryInterfaceDrop(SMInterface *pInterface);
dvander@2783
    89
dvander@2790
    90
	const char *GetExtensionVerString();
dvander@2790
    91
	const char *GetExtensionDateString();
pred@2619
    92
public: //ICommandTargetProcessor
dvander@1945
    93
	bool ProcessCommandTarget(cmd_target_info_t *info);
pred@2619
    94
public: //IConCommandBaseAccessor
pred@1979
    95
	bool RegisterConCommandBase(ConCommandBase *pVar);
pred@2619
    96
public: //IGameEventManager
pred@2075
    97
	IGameEventManager2 *m_GameEventManager;
pred@2075
    98
	void FireGameEvent( IGameEvent *event );
pred@2619
    99
public: //IPluginsListener
pred@2619
   100
	void OnPluginLoaded(IPlugin *plugin);
pred@2619
   101
	void OnPluginUnloaded(IPlugin *plugin);
dvander@1945
   102
public:
dvander@1945
   103
#if defined SMEXT_CONF_METAMOD
dvander@1945
   104
	/**
dvander@1945
   105
	 * @brief Called when Metamod is attached, before the extension version is called.
dvander@1945
   106
	 *
dvander@1945
   107
	 * @param error			Error buffer.
dvander@1945
   108
	 * @param maxlength		Maximum size of error buffer.
dvander@1945
   109
	 * @param late			Whether or not Metamod considers this a late load.
dvander@1945
   110
	 * @return				True to succeed, false to fail.
dvander@1945
   111
	 */
dvander@1945
   112
	virtual bool SDK_OnMetamodLoad(ISmmAPI *ismm, char *error, size_t maxlength, bool late);
dvander@1945
   113
#endif
pred@2619
   114
private:
skamonkey@3056
   115
	bool m_CritDetoursEnabled;
skamonkey@3056
   116
	bool m_GetHolidayDetourEnabled;
dvander@1945
   117
};
dvander@1945
   118
pred@1963
   119
enum TFClassType
pred@1963
   120
{
pred@1963
   121
	TFClass_Unknown = 0,
pred@1963
   122
	TFClass_Scout,
pred@1963
   123
	TFClass_Sniper,
pred@1963
   124
	TFClass_Soldier,
pred@1963
   125
	TFClass_DemoMan,
pred@1963
   126
	TFClass_Medic,
pred@1963
   127
	TFClass_Heavy,
pred@1963
   128
	TFClass_Pyro,
pred@1963
   129
	TFClass_Spy,
pred@1963
   130
	TFClass_Engineer
pred@1963
   131
};
pred@1963
   132
pred@1963
   133
TFClassType ClassnameToType(const char *classname);
pred@1963
   134
dvander@1945
   135
extern IBinTools *g_pBinTools;
dvander@1945
   136
extern IGameConfig *g_pGameConf;
pred@1963
   137
extern sm_sendprop_info_t *playerSharedOffset;
pred@1963
   138
pred@1963
   139
void OnServerActivate(edict_t *pEdictList, int edictCount, int clientMax);
pred@1963
   140
pred@1963
   141
int FindResourceEntity();
pred@1963
   142
int FindEntityByNetClass(int start, const char *classname);
pred@1963
   143
pred@1963
   144
extern int g_resourceEntity;
pred@1963
   145
dvander@1945
   146
dvander@1945
   147
#endif // _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_