1 /* ======== sample_mm ========
2 * Copyright (C) 2004-2005 Metamod:Source Development Team
3 * No warranties of any kind
7 * Author(s): David "BAILOPAN" Anderson
8 * ============================
11 #ifndef _INCLUDE_SAMPLEPLUGIN_H
12 #define _INCLUDE_SAMPLEPLUGIN_H
14 #include <ISmmPlugin.h>
16 class SamplePlugin : public ISmmPlugin
19 bool Load(PluginId id, ISmmAPI *ismm, factories *list, char *error, size_t maxlen);
20 bool Unload(char *error, size_t maxlen);
21 void AllPluginsLoaded();
22 bool Pause(char *error, size_t maxlen)
26 bool Unpause(char *error, size_t maxlen)
31 int GetApiVersion() { return PLAPI_VERSION; }
33 const char *GetAuthor()
39 return "Sample Plugin";
41 const char *GetDescription()
43 return "Sample plugin that hooks basic things";
47 return "http://www.sourcemm.net/";
49 const char *GetLicense()
53 const char *GetVersion()
61 const char *GetLogTag()
66 //These functions are from IServerPluginCallbacks
67 //Note, the parameters might be a little different to match the actual calls!
69 //Called on LevelInit. Server plugins only have pMapName
70 bool LevelInit(const char *pMapName, char const *pMapEntities, char const *pOldLevel, char const *pLandmarkName, bool loadGame, bool background);
72 //Called on ServerActivate. Same definition as server plugins
73 void ServerActivate(edict_t *pEdictList, int edictCount, int clientMax);
75 //Called on a game tick. Same definition as server plugins
76 void GameFrame(bool simulating);
78 //Called on level shutdown. Same definition as server plugins
79 void LevelShutdown(void);
81 //Client is activate (whatever that means). We get an extra parameter...
82 // "If bLoadGame is true, don't spawn the player because its state is already setup."
83 void ClientActive(edict_t *pEntity, bool bLoadGame);
85 //Client disconnects - same as server plugins
86 void ClientDisconnect(edict_t *pEntity);
88 //Client is put in server - same as server plugins
89 void ClientPutInServer(edict_t *pEntity, char const *playername);
91 //Sets the client index - same as server plugins
92 void SetCommandClient(int index);
94 //Called on client settings changed (duh) - same as server plugins
95 void ClientSettingsChanged(edict_t *pEdict);
97 //Called on client connect. Unlike server plugins, we return whether the
98 // connection is allowed rather than set it through a pointer in the first parameter.
99 // You can still supercede the GameDLL through RETURN_META_VALUE(MRES_SUPERCEDE, true/false)
100 bool ClientConnect(edict_t *pEntity, const char *pszName, const char *pszAddress, char *reject, int maxrejectlen);
102 //Called when a client uses a command. Unlike server plugins, it's void.
103 // You can still supercede the gamedll through RETURN_META(MRES_SUPERCEDE).
104 void ClientCommand(edict_t *pEntity);
107 IVEngineServer *m_Engine;
108 IServerGameDLL *m_ServerDll;
109 IServerGameClients *m_ServerClients;
110 IServerGameDLL *m_ServerDll_CC;
111 IServerGameClients *m_ServerClients_CC;
114 extern SamplePlugin g_SamplePlugin;
117 #endif //_INCLUDE_SAMPLEPLUGIN_H