sourcemm/sample_mm/SamplePlugin.h
author David Anderson <dvander@alliedmods.net>
Sat Apr 30 18:45:41 2005 +0000 (2005-04-30)
changeset 44 935c3ec3baf5
parent 35 78188da97068
child 68 5433659a62ae
permissions -rw-r--r--
committed new callclass code
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@7
    16
dvander@7
    17
class SamplePlugin : public ISmmPlugin
dvander@7
    18
{
dvander@7
    19
public:
dvander@7
    20
	bool Load(PluginId id, ISmmAPI *ismm, factories *list, char *error, size_t maxlen);
dvander@7
    21
	bool Unload(char *error, size_t maxlen);
dvander@20
    22
	void AllPluginsLoaded();
dvander@7
    23
	bool Pause(char *error, size_t maxlen)
dvander@7
    24
	{
dvander@7
    25
		return true;
dvander@7
    26
	}
dvander@7
    27
	bool Unpause(char *error, size_t maxlen)
dvander@7
    28
	{
dvander@7
    29
		return true;
dvander@7
    30
	}
dvander@7
    31
public:
dvander@7
    32
	int GetApiVersion() { return PLAPI_VERSION; }
dvander@7
    33
public:
dvander@7
    34
	const char *GetAuthor()
dvander@7
    35
	{
dvander@7
    36
		return "BAILOPAN";
dvander@7
    37
	}
dvander@7
    38
	const char *GetName()
dvander@7
    39
	{
dvander@7
    40
		return "Sample Plugin";
dvander@7
    41
	}
dvander@7
    42
	const char *GetDescription()
dvander@7
    43
	{
dvander@7
    44
		return "Sample plugin that hooks basic things";
dvander@7
    45
	}
dvander@7
    46
	const char *GetURL()
dvander@7
    47
	{
dvander@7
    48
		return "http://www.sourcemm.net/";
dvander@7
    49
	}
dvander@7
    50
	const char *GetLicense()
dvander@7
    51
	{
dvander@7
    52
		return "zlib/libpng";
dvander@7
    53
	}
dvander@7
    54
	const char *GetVersion()
dvander@7
    55
	{
dvander@7
    56
		return "1.00";
dvander@7
    57
	}
dvander@7
    58
	const char *GetDate()
dvander@7
    59
	{
dvander@7
    60
		return __DATE__;
dvander@7
    61
	}
dvander@7
    62
	const char *GetLogTag()
dvander@7
    63
	{
dvander@7
    64
		return "SAMPLE";
dvander@7
    65
	}
dvander@22
    66
public:
dvander@22
    67
	//These functions are from IServerPluginCallbacks
dvander@22
    68
	//Note, the parameters might be a little different to match the actual calls!
dvander@22
    69
dvander@22
    70
	//Called on LevelInit.  Server plugins only have pMapName
dvander@22
    71
	bool LevelInit(const char *pMapName, char const *pMapEntities, char const *pOldLevel, char const *pLandmarkName, bool loadGame, bool background);
dvander@22
    72
dvander@22
    73
	//Called on ServerActivate.  Same definition as server plugins
dvander@22
    74
	void ServerActivate(edict_t *pEdictList, int edictCount, int clientMax);
dvander@22
    75
dvander@22
    76
	//Called on a game tick.  Same definition as server plugins
dvander@22
    77
	void GameFrame(bool simulating);
dvander@22
    78
dvander@22
    79
	//Called on level shutdown.  Same definition as server plugins 
dvander@22
    80
	void LevelShutdown(void);
dvander@22
    81
dvander@22
    82
	//Client is activate (whatever that means).  We get an extra parameter...
dvander@22
    83
	// "If bLoadGame is true, don't spawn the player because its state is already setup."
dvander@22
    84
	void ClientActive(edict_t *pEntity, bool bLoadGame);
dvander@22
    85
dvander@22
    86
	//Client disconnects - same as server plugins
dvander@22
    87
	void ClientDisconnect(edict_t *pEntity);
dvander@22
    88
dvander@22
    89
	//Client is put in server - same as server plugins
dvander@22
    90
	void ClientPutInServer(edict_t *pEntity, char const *playername);
dvander@22
    91
dvander@22
    92
	//Sets the client index - same as server plugins
dvander@22
    93
	void SetCommandClient(int index);
dvander@22
    94
dvander@22
    95
	//Called on client settings changed (duh) - same as server plugins
dvander@22
    96
	void ClientSettingsChanged(edict_t *pEdict);
dvander@22
    97
dvander@22
    98
	//Called on client connect.  Unlike server plugins, we return whether the 
dvander@22
    99
	// connection is allowed rather than set it through a pointer in the first parameter.
dvander@22
   100
	// You can still supercede the GameDLL through RETURN_META_VALUE(MRES_SUPERCEDE, true/false)
dvander@22
   101
	bool ClientConnect(edict_t *pEntity, const char *pszName, const char *pszAddress, char *reject, int maxrejectlen);
dvander@22
   102
dvander@22
   103
	//Called when a client uses a command.  Unlike server plugins, it's void.
dvander@22
   104
	// You can still supercede the gamedll through RETURN_META(MRES_SUPERCEDE).
dvander@22
   105
	void ClientCommand(edict_t *pEntity);
dvander@22
   106
dvander@22
   107
private:
dvander@22
   108
	IVEngineServer *m_Engine;
dvander@22
   109
	IServerGameDLL *m_ServerDll;
dvander@22
   110
	IServerGameClients *m_ServerClients;
dvander@44
   111
	SourceHook::CallClass<IVEngineServer> *m_Engine_CC;
dvander@7
   112
};
dvander@7
   113
dvander@7
   114
extern SamplePlugin g_SamplePlugin;
dvander@7
   115
PLUGIN_GLOBALVARS();
dvander@7
   116
dvander@7
   117
#endif //_INCLUDE_SAMPLEPLUGIN_H