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
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@2075
    53
	public IGameEventListener2
dvander@1945
    54
{
dvander@1945
    55
public:
dvander@1945
    56
	/**
dvander@1945
    57
	 * @brief This is called after the initial loading sequence has been processed.
dvander@1945
    58
	 *
dvander@1945
    59
	 * @param error		Error message buffer.
dvander@1945
    60
	 * @param maxlength	Size of error message buffer.
dvander@1945
    61
	 * @param late		Whether or not the module was loaded after map load.
dvander@1945
    62
	 * @return			True to succeed loading, false to fail.
dvander@1945
    63
	 */
dvander@1945
    64
	virtual bool SDK_OnLoad(char *error, size_t maxlength, bool late);
dvander@1945
    65
	
dvander@1945
    66
	/**
dvander@1945
    67
	 * @brief This is called right before the extension is unloaded.
dvander@1945
    68
	 */
dvander@1945
    69
	virtual void SDK_OnUnload();
dvander@1945
    70
dvander@1945
    71
	/**
dvander@1945
    72
	 * @brief This is called once all known extensions have been loaded.
dvander@1945
    73
	 * Note: It is is a good idea to add natives here, if any are provided.
dvander@1945
    74
	 */
dvander@1945
    75
	virtual void SDK_OnAllLoaded();
dvander@1945
    76
dvander@1945
    77
	/**
dvander@1945
    78
	 * @brief Called when the pause state is changed.
dvander@1945
    79
	 */
dvander@1945
    80
	//virtual void SDK_OnPauseChange(bool paused);
dvander@1945
    81
dvander@1945
    82
	/**
dvander@1945
    83
	 * @brief this is called when Core wants to know if your extension is working.
dvander@1945
    84
	 *
dvander@1945
    85
	 * @param error		Error message buffer.
dvander@1945
    86
	 * @param maxlength	Size of error message buffer.
dvander@1945
    87
	 * @return			True if working, false otherwise.
dvander@1945
    88
	 */
dvander@1945
    89
	virtual bool QueryRunning(char *error, size_t maxlength);
dvander@1945
    90
dvander@1945
    91
	void NotifyInterfaceDrop(SMInterface *pInterface);
dvander@1945
    92
	bool QueryInterfaceDrop(SMInterface *pInterface);
dvander@1945
    93
public:
dvander@1945
    94
	bool ProcessCommandTarget(cmd_target_info_t *info);
pred@1979
    95
	bool RegisterConCommandBase(ConCommandBase *pVar);
pred@2075
    96
pred@2075
    97
	IGameEventManager2 *m_GameEventManager;
pred@2075
    98
	void FireGameEvent( IGameEvent *event );
dvander@1945
    99
public:
dvander@1945
   100
#if defined SMEXT_CONF_METAMOD
dvander@1945
   101
	/**
dvander@1945
   102
	 * @brief Called when Metamod is attached, before the extension version is called.
dvander@1945
   103
	 *
dvander@1945
   104
	 * @param error			Error buffer.
dvander@1945
   105
	 * @param maxlength		Maximum size of error buffer.
dvander@1945
   106
	 * @param late			Whether or not Metamod considers this a late load.
dvander@1945
   107
	 * @return				True to succeed, false to fail.
dvander@1945
   108
	 */
dvander@1945
   109
	virtual bool SDK_OnMetamodLoad(ISmmAPI *ismm, char *error, size_t maxlength, bool late);
dvander@1945
   110
dvander@1945
   111
	/**
dvander@1945
   112
	 * @brief Called when Metamod is detaching, after the extension version is called.
dvander@1945
   113
	 * NOTE: By default this is blocked unless sent from SourceMod.
dvander@1945
   114
	 *
dvander@1945
   115
	 * @param error			Error buffer.
dvander@1945
   116
	 * @param maxlength		Maximum size of error buffer.
dvander@1945
   117
	 * @return				True to succeed, false to fail.
dvander@1945
   118
	 */
dvander@1945
   119
	//virtual bool SDK_OnMetamodUnload(char *error, size_t maxlength);
dvander@1945
   120
dvander@1945
   121
	/**
dvander@1945
   122
	 * @brief Called when Metamod's pause state is changing.
dvander@1945
   123
	 * NOTE: By default this is blocked unless sent from SourceMod.
dvander@1945
   124
	 *
dvander@1945
   125
	 * @param paused		Pause state being set.
dvander@1945
   126
	 * @param error			Error buffer.
dvander@1945
   127
	 * @param maxlength		Maximum size of error buffer.
dvander@1945
   128
	 * @return				True to succeed, false to fail.
dvander@1945
   129
	 */
dvander@1945
   130
	//virtual bool SDK_OnMetamodPauseChange(bool paused, char *error, size_t maxlength);
dvander@1945
   131
#endif
dvander@1945
   132
};
dvander@1945
   133
pred@1963
   134
enum TFClassType
pred@1963
   135
{
pred@1963
   136
	TFClass_Unknown = 0,
pred@1963
   137
	TFClass_Scout,
pred@1963
   138
	TFClass_Sniper,
pred@1963
   139
	TFClass_Soldier,
pred@1963
   140
	TFClass_DemoMan,
pred@1963
   141
	TFClass_Medic,
pred@1963
   142
	TFClass_Heavy,
pred@1963
   143
	TFClass_Pyro,
pred@1963
   144
	TFClass_Spy,
pred@1963
   145
	TFClass_Engineer
pred@1963
   146
};
pred@1963
   147
pred@1963
   148
TFClassType ClassnameToType(const char *classname);
pred@1963
   149
dvander@1945
   150
extern IBinTools *g_pBinTools;
dvander@1945
   151
extern IGameConfig *g_pGameConf;
pred@1963
   152
extern sm_sendprop_info_t *playerSharedOffset;
pred@1963
   153
pred@1963
   154
void OnServerActivate(edict_t *pEdictList, int edictCount, int clientMax);
pred@1963
   155
pred@1963
   156
int FindResourceEntity();
pred@1963
   157
int FindEntityByNetClass(int start, const char *classname);
pred@1963
   158
pred@1963
   159
extern int g_resourceEntity;
pred@1963
   160
dvander@1945
   161
dvander@1945
   162
#endif // _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_