Home - sourcemod-central - file revision - core/sm_globals.h@e73a1e51833b Mercurial
summary | shortlog | changelog | graph | tags | branches | files | changeset | file | latest | revisions | annotate | diff | raw | help
core/sm_globals.h
author Scott Ehlert <ds@alliedmods.net>
Thu Mar 27 04:54:56 2008 +0000 (2008-03-27)
changeset 1947 e73a1e51833b
parent 1915 ab031366cfd1
child 2289 44045ead61cd
permissions -rw-r--r--
Updated copyright year 
     1 /**
     2  * vim: set ts=4 :
     3  * =============================================================================
     4  * SourceMod
     5  * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
     6  * =============================================================================
     7  *
     8  * This program is free software; you can redistribute it and/or modify it under
     9  * the terms of the GNU General Public License, version 3.0, as published by the
    10  * Free Software Foundation.
    11  * 
    12  * This program is distributed in the hope that it will be useful, but WITHOUT
    13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    14  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
    15  * details.
    16  *
    17  * You should have received a copy of the GNU General Public License along with
    18  * this program.  If not, see <http://www.gnu.org/licenses/>.
    19  *
    20  * As a special exception, AlliedModders LLC gives you permission to link the
    21  * code of this program (as well as its derivative works) to "Half-Life 2," the
    22  * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
    23  * by the Valve Corporation.  You must obey the GNU General Public License in
    24  * all respects for all other code used.  Additionally, AlliedModders LLC grants
    25  * this exception to all derivative works.  AlliedModders LLC defines further
    26  * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
    27  * or <http://www.sourcemod.net/license.php>.
    28  *
    29  * Version: $Id$
    30  */
    31 
    32 #ifndef _INCLUDE_SOURCEMOD_GLOBALS_H_
    33 #define _INCLUDE_SOURCEMOD_GLOBALS_H_
    34 
    35 /**
    36  * @file Contains global headers that most files in SourceMod will need.
    37  */
    38 
    39 #include <sp_vm_types.h>
    40 #include <sp_vm_api.h>
    41 #include "sm_platform.h"
    42 #include <IShareSys.h>
    43 
    44 using namespace SourcePawn;
    45 using namespace SourceMod;
    46 
    47 class IServerPluginCallbacks;
    48 
    49 /**
    50  * @brief Lists result codes possible from attempting to set a core configuration option.
    51  */
    52 enum ConfigResult
    53 {
    54 	ConfigResult_Accept = 0,	/**< Config option was successfully set */
    55 	ConfigResult_Reject = 1,	/**< Config option was given an invalid value and was rejected */
    56 	ConfigResult_Ignore = 2		/**< Config option was invalid, but ignored */
    57 };
    58 
    59 /**
    60  * @brief Lists possible sources of a config option change
    61  */
    62 enum ConfigSource
    63 {
    64 	ConfigSource_File = 0,		/**< Config option was set from config file (core.cfg) */
    65 	ConfigSource_Console = 1,	/**< Config option was set from console command (sm config) */
    66 };
    67 
    68 /** 
    69  * @brief Any class deriving from this will be automatically initiated/shutdown by SourceMod
    70  */
    71 class SMGlobalClass
    72 {
    73 	friend class SourceMod_Core;
    74 	friend class SourceModBase;
    75 	friend class CoreConfig;
    76 	friend class CExtensionManager;
    77 public:
    78 	SMGlobalClass();
    79 public:
    80 	/**
    81 	 * @brief Called when SourceMod is initially loading
    82 	 */
    83 	virtual void OnSourceModStartup(bool late)
    84 	{
    85 	}
    86 
    87 	/**
    88 	 * @brief Called after all global classes have been started up
    89 	 */
    90 	virtual void OnSourceModAllInitialized()
    91 	{
    92 	}
    93 
    94 	/**
    95 	 * @brief Called after all global classes have initialized
    96 	 */
    97 	virtual void OnSourceModAllInitialized_Post()
    98 	{
    99 	}
   100 
   101 	/**
   102 	 * @brief Called when SourceMod is shutting down
   103 	 */
   104 	virtual void OnSourceModShutdown()
   105 	{
   106 	}
   107 
   108 	/**
   109 	 * @brief Called after SourceMod is completely shut down
   110 	 */
   111 	virtual void OnSourceModAllShutdown()
   112 	{
   113 	}
   114 
   115 	/**
   116 	 * @brief Called when a core config option is changed.
   117 	 * @note This is called once BEFORE OnSourceModStartup() when SourceMod is loading
   118 	 * @note It can then be called again when the 'sm config' command is used
   119 	 */
   120 	virtual ConfigResult OnSourceModConfigChanged(const char *key, 
   121 												  const char *value, 
   122 												  ConfigSource source,
   123 												  char *error, 
   124 												  size_t maxlength)
   125 	{
   126 		return ConfigResult_Ignore;
   127 	}
   128 
   129 	/**
   130 	 * @brief Called when the level changes.
   131 	 */
   132 	virtual void OnSourceModLevelChange(const char *mapName)
   133 	{
   134 	}
   135 
   136 	/**
   137 	 * @brief Called when the level ends.
   138 	 */
   139 	virtual void OnSourceModLevelEnd()
   140 	{
   141 	}
   142 
   143 	/**
   144 	 * @brief Called after plugins are loaded on mapchange.
   145 	 */
   146 	virtual void OnSourceModPluginsLoaded()
   147 	{
   148 	}
   149 
   150 	/**
   151 	 * @brief Called when SourceMod receives a pointer to IServerPluginCallbacks from SourceMM
   152 	 */
   153 	virtual void OnSourceModVSPReceived()
   154 	{
   155 	}
   156 
   157 	/**
   158 	 * @brief Called once all MM:S plugins are loaded.
   159 	 */
   160 	virtual void OnSourceModGameInitialized()
   161 	{
   162 	}
   163 
   164 	/**
   165 	 * @brief Called when an identity is dropped (right now, extensions only)
   166 	 */
   167 	virtual void OnSourceModIdentityDropped(IdentityToken_t *pToken)
   168 	{
   169 	}
   170 private:
   171 	SMGlobalClass *m_pGlobalClassNext;
   172 	static SMGlobalClass *head;
   173 };
   174 
   175 extern ISourcePawnEngine *g_pSourcePawn;
   176 extern IVirtualMachine *g_pVM;
   177 extern IdentityToken_t *g_pCoreIdent;
   178 
   179 #include "sm_autonatives.h"
   180 
   181 #endif //_INCLUDE_SOURCEMOD_GLOBALS_H_
sourcemod-central
Feed