Home - sourcemod-central - file revision - core/EventManager.h@13c62962a9ef Mercurial
summary | shortlog | changelog | graph | tags | branches | files | changeset | file | latest | revisions | annotate | diff | raw | help
core/EventManager.h
author Michael McKoy <ferret99gt@gmail.com>
Wed Aug 08 23:26:42 2007 +0000 (2007-08-08)
changeset 1280 13c62962a9ef
parent 1231 17badaf66ce4
child 1330 ab94316bb52b
permissions -rw-r--r--
Corrected filename in header of basefuncommands.sp 
     1 /**
     2  * vim: set ts=4 :
     3  * ================================================================
     4  * SourceMod
     5  * Copyright (C) 2004-2007 AlliedModders LLC.  All rights reserved.
     6  * ================================================================
     7  *
     8  * This program is free software; you can redistribute it and/or 
     9  * modify it under the terms of the GNU General Public License, 
    10  * version 3.0, as published by the Free Software Foundation.
    11  * 
    12  * This program is distributed in the hope that it will be useful,
    13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
    14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    15  * GNU General Public License for more details.
    16  *
    17  * You should have received a copy of the GNU General Public License
    18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
    19  *
    20  * As a special exception, AlliedModders LLC gives you permission to 
    21  * link the code of this program (as well as its derivative works) to 
    22  * "Half-Life 2," the "Source Engine," the "SourcePawn JIT," and any 
    23  * Game MODs that run on software by the Valve Corporation.  You must 
    24  * obey the GNU General Public License in all respects for all other 
    25  * code used. Additionally, AlliedModders LLC grants this exception 
    26  * to all derivative works. AlliedModders LLC defines further 
    27  * exceptions, found in LICENSE.txt (as of this writing, version 
    28  * JULY-31-2007), or <http://www.sourcemod.net/license.php>.
    29  *
    30  * Version: $Id$
    31  */
    32 
    33 #ifndef _INCLUDE_SOURCEMOD_EVENTMANAGER_H_
    34 #define _INCLUDE_SOURCEMOD_EVENTMANAGER_H_
    35 
    36 #include "sm_globals.h"
    37 #include "sourcemm_api.h"
    38 #include "sm_trie.h"
    39 #include <sh_list.h>
    40 #include <sh_stack.h>
    41 #include <IHandleSys.h>
    42 #include <IForwardSys.h>
    43 #include <IPluginSys.h>
    44 
    45 using namespace SourceHook;
    46 
    47 struct EventInfo
    48 {
    49 	IGameEvent *pEvent;
    50 	IdentityToken_t *pOwner;
    51 };
    52 
    53 struct EventHook
    54 {
    55 	EventHook()
    56 	{
    57 		pPreHook = NULL;
    58 		pPostHook = NULL;
    59 		postCopy = false;
    60 		pEventCopy = NULL;
    61 		refCount = 0;
    62 	}
    63 	IChangeableForward *pPreHook;
    64 	IChangeableForward *pPostHook;
    65 	bool postCopy;
    66 	IGameEvent *pEventCopy;
    67 	unsigned int refCount;
    68 };
    69 
    70 enum EventHookMode
    71 {
    72 	EventHookMode_Pre,
    73 	EventHookMode_Post,
    74 	EventHookMode_PostNoCopy
    75 };
    76 
    77 enum EventHookError
    78 {
    79 	EventHookErr_Okay = 0,			/**< No error */
    80 	EventHookErr_InvalidEvent,		/**< Specified event does not exist */
    81 	EventHookErr_NotActive,			/**< Specified event has no active hook */
    82 	EventHookErr_InvalidCallback,	/**< Specified event does not fire specified callback */ 
    83 };
    84 
    85 class EventManager :
    86 	public SMGlobalClass,
    87 	public IHandleTypeDispatch,
    88 	public IPluginsListener,
    89 	public IGameEventListener2
    90 {
    91 public:
    92 	EventManager();
    93 	~EventManager();
    94 public: // SMGlobalClass
    95 	void OnSourceModAllInitialized();
    96 	void OnSourceModShutdown();
    97 public: // IHandleTypeDispatch
    98 	void OnHandleDestroy(HandleType_t type, void *object);
    99 public: // IPluginsListener
   100 	void OnPluginUnloaded(IPlugin *plugin);
   101 public: // IGameEventListener2
   102 	void FireGameEvent(IGameEvent *pEvent);
   103 public:
   104 	/**
   105 	 * Get the 'GameEvent' handle type ID.
   106 	 */
   107 	inline HandleType_t GetHandleType()
   108 	{
   109 		return m_EventType;
   110 	}
   111 public:
   112 	EventHookError HookEvent(const char *name, IPluginFunction *pFunction, EventHookMode mode=EventHookMode_Post);
   113 	EventHookError UnhookEvent(const char *name, IPluginFunction *pFunction, EventHookMode mode=EventHookMode_Post);
   114 	EventInfo *CreateEvent(IPluginContext *pContext, const char *name, bool force=false);
   115 	void FireEvent(EventInfo *pInfo, bool bDontBroadcast=false);
   116 	void CancelCreatedEvent(EventInfo *pInfo);
   117 private: // IGameEventManager2 hooks
   118 	bool OnFireEvent(IGameEvent *pEvent, bool bDontBroadcast);
   119 	bool OnFireEvent_Post(IGameEvent *pEvent, bool bDontBroadcast);
   120 private:
   121 	HandleType_t m_EventType;
   122 	Trie *m_EventHooks;
   123 	CStack<EventInfo *> m_FreeEvents;
   124 	CStack<const char *> m_EventNames;
   125 };
   126 
   127 extern EventManager g_EventManager;
   128 
   129 #endif // _INCLUDE_SOURCEMOD_EVENTMANAGER_H_
sourcemod-central
Feed