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