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