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