sourcemm/sample_mm/SamplePlugin.h
author David Anderson <dvander@alliedmods.net>
Tue Sep 18 20:03:47 2007 +0000 (2007-09-18)
branchsourcemm-1.6.0
changeset 347 e82968c21606
permissions -rw-r--r--
branched 1.4.2 to 1.6.0
dvander@347
     1
/* ======== sample_mm ========
dvander@347
     2
 * Copyright (C) 2004-2007 Metamod:Source Development Team
dvander@347
     3
 * No warranties of any kind
dvander@347
     4
 *
dvander@347
     5
 * License: zlib/libpng
dvander@347
     6
 *
dvander@347
     7
 * Author(s): David "BAILOPAN" Anderson
dvander@347
     8
 * ============================
dvander@347
     9
 */
dvander@347
    10
dvander@347
    11
#ifndef _INCLUDE_SAMPLEPLUGIN_H
dvander@347
    12
#define _INCLUDE_SAMPLEPLUGIN_H
dvander@347
    13
dvander@347
    14
#include <ISmmPlugin.h>
dvander@347
    15
#include <sourcehook/sourcehook.h>
dvander@347
    16
#include <igameevents.h>
dvander@347
    17
dvander@347
    18
#define SAMPLE_VERSION	"1.10"
dvander@347
    19
dvander@347
    20
class SamplePlugin : public ISmmPlugin, public IMetamodListener
dvander@347
    21
{
dvander@347
    22
public:
dvander@347
    23
	bool Load(PluginId id, ISmmAPI *ismm, char *error, size_t maxlen, bool late);
dvander@347
    24
	bool Unload(char *error, size_t maxlen);
dvander@347
    25
	void AllPluginsLoaded();
dvander@347
    26
	bool Pause(char *error, size_t maxlen)
dvander@347
    27
	{
dvander@347
    28
		return true;
dvander@347
    29
	}
dvander@347
    30
	bool Unpause(char *error, size_t maxlen)
dvander@347
    31
	{
dvander@347
    32
		return true;
dvander@347
    33
	}
dvander@347
    34
public:
dvander@347
    35
	int GetApiVersion() { return PLAPI_VERSION; }
dvander@347
    36
public:
dvander@347
    37
	const char *GetAuthor()
dvander@347
    38
	{
dvander@347
    39
		return "BAILOPAN";
dvander@347
    40
	}
dvander@347
    41
	const char *GetName()
dvander@347
    42
	{
dvander@347
    43
		return "Sample Plugin";
dvander@347
    44
	}
dvander@347
    45
	const char *GetDescription()
dvander@347
    46
	{
dvander@347
    47
		return "Sample plugin that hooks basic things";
dvander@347
    48
	}
dvander@347
    49
	const char *GetURL()
dvander@347
    50
	{
dvander@347
    51
		return "http://www.sourcemm.net/";
dvander@347
    52
	}
dvander@347
    53
	const char *GetLicense()
dvander@347
    54
	{
dvander@347
    55
		return "zlib/libpng";
dvander@347
    56
	}
dvander@347
    57
	const char *GetVersion()
dvander@347
    58
	{
dvander@347
    59
		return SAMPLE_VERSION;
dvander@347
    60
	}
dvander@347
    61
	const char *GetDate()
dvander@347
    62
	{
dvander@347
    63
		return __DATE__;
dvander@347
    64
	}
dvander@347
    65
	const char *GetLogTag()
dvander@347
    66
	{
dvander@347
    67
		return "SAMPLE";
dvander@347
    68
	}
dvander@347
    69
public:
dvander@347
    70
	//These functions are from IServerPluginCallbacks
dvander@347
    71
	//Note, the parameters might be a little different to match the actual calls!
dvander@347
    72
dvander@347
    73
	//Called on LevelInit.  Server plugins only have pMapName
dvander@347
    74
	bool LevelInit(const char *pMapName, char const *pMapEntities, char const *pOldLevel, char const *pLandmarkName, bool loadGame, bool background);
dvander@347
    75
dvander@347
    76
	//Called on ServerActivate.  Same definition as server plugins
dvander@347
    77
	void ServerActivate(edict_t *pEdictList, int edictCount, int clientMax);
dvander@347
    78
dvander@347
    79
	//Called on a game tick.  Same definition as server plugins
dvander@347
    80
	void GameFrame(bool simulating);
dvander@347
    81
dvander@347
    82
	//Called on level shutdown.  Same definition as server plugins 
dvander@347
    83
	void LevelShutdown(void);
dvander@347
    84
dvander@347
    85
	//Client is activate (whatever that means).  We get an extra parameter...
dvander@347
    86
	// "If bLoadGame is true, don't spawn the player because its state is already setup."
dvander@347
    87
	void ClientActive(edict_t *pEntity, bool bLoadGame);
dvander@347
    88
dvander@347
    89
	//Client disconnects - same as server plugins
dvander@347
    90
	void ClientDisconnect(edict_t *pEntity);
dvander@347
    91
dvander@347
    92
	//Client is put in server - same as server plugins
dvander@347
    93
	void ClientPutInServer(edict_t *pEntity, char const *playername);
dvander@347
    94
dvander@347
    95
	//Sets the client index - same as server plugins
dvander@347
    96
	void SetCommandClient(int index);
dvander@347
    97
dvander@347
    98
	//Called on client settings changed (duh) - same as server plugins
dvander@347
    99
	void ClientSettingsChanged(edict_t *pEdict);
dvander@347
   100
dvander@347
   101
	//Called on client connect.  Unlike server plugins, we return whether the 
dvander@347
   102
	// connection is allowed rather than set it through a pointer in the first parameter.
dvander@347
   103
	// You can still supercede the GameDLL through RETURN_META_VALUE(MRES_SUPERCEDE, true/false)
dvander@347
   104
	bool ClientConnect(edict_t *pEntity, const char *pszName, const char *pszAddress, char *reject, int maxrejectlen);
dvander@347
   105
dvander@347
   106
	//Called when a client uses a command.  Unlike server plugins, it's void.
dvander@347
   107
	// You can still supercede the gamedll through RETURN_META(MRES_SUPERCEDE).
dvander@347
   108
	void ClientCommand(edict_t *pEntity);
dvander@347
   109
dvander@347
   110
	//From IMetamodListener
dvander@347
   111
	virtual void OnLevelShutdown();
dvander@347
   112
dvander@347
   113
private:
dvander@347
   114
	IGameEventManager2 *m_GameEventManager;	
dvander@347
   115
	IVEngineServer *m_Engine;
dvander@347
   116
	IServerGameDLL *m_ServerDll;
dvander@347
   117
	IServerGameClients *m_ServerClients;
dvander@347
   118
	SourceHook::CallClass<IVEngineServer> *m_Engine_CC;
dvander@347
   119
};
dvander@347
   120
dvander@347
   121
class MyListener : public IMetamodListener
dvander@347
   122
{
dvander@347
   123
public:
dvander@347
   124
	virtual void *OnMetamodQuery(const char *iface, int *ret);
dvander@347
   125
};
dvander@347
   126
dvander@347
   127
extern SamplePlugin g_SamplePlugin;
dvander@347
   128
PLUGIN_GLOBALVARS();
dvander@347
   129
dvander@347
   130
bool FireEvent_Handler(IGameEvent *event, bool bDontBroadcast);
dvander@347
   131
dvander@347
   132
#endif //_INCLUDE_SAMPLEPLUGIN_H