a1009aed38
All plugin and include file headers also have been changed to say about GPL3 instead of GPL2. (This day shall henceforth be known as the Eighty Column Massacre of '07) --HG-- extra : convert_revision : svn%3A39bc706e-5318-0410-9160-8a85361fbb7c/trunk%401336
146 lines
4.5 KiB
C++
146 lines
4.5 KiB
C++
/**
|
|
* vim: set ts=4 :
|
|
* =============================================================================
|
|
* SourceMod
|
|
* Copyright (C) 2004-2007 AlliedModders LLC. All rights reserved.
|
|
* =============================================================================
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify it under
|
|
* the terms of the GNU General Public License, version 3.0, as published by the
|
|
* Free Software Foundation.
|
|
*
|
|
* This program is distributed in the hope that it will be useful, but WITHOUT
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
|
|
* details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along with
|
|
* this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
* As a special exception, AlliedModders LLC gives you permission to link the
|
|
* code of this program (as well as its derivative works) to "Half-Life 2," the
|
|
* "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
|
|
* by the Valve Corporation. You must obey the GNU General Public License in
|
|
* all respects for all other code used. Additionally, AlliedModders LLC grants
|
|
* this exception to all derivative works. AlliedModders LLC defines further
|
|
* exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
|
|
* or <http://www.sourcemod.net/license.php>.
|
|
*
|
|
* Version: $Id$
|
|
*/
|
|
|
|
#ifndef _INCLUDE_SOURCEMOD_GLOBALHEADER_H_
|
|
#define _INCLUDE_SOURCEMOD_GLOBALHEADER_H_
|
|
|
|
#include "sm_globals.h"
|
|
#include <ISourceMod.h>
|
|
#include <sh_stack.h>
|
|
#include "CDataPack.h"
|
|
|
|
using namespace SourceHook;
|
|
|
|
/**
|
|
* @brief Implements SourceMod's global overall management, API, and logic
|
|
*/
|
|
|
|
class SourceModBase :
|
|
public ISourceMod,
|
|
public SMGlobalClass
|
|
{
|
|
public:
|
|
SourceModBase();
|
|
public:
|
|
/**
|
|
* @brief Initializes SourceMod, or returns an error on failure.
|
|
*/
|
|
bool InitializeSourceMod(char *error, size_t maxlength, bool late);
|
|
|
|
/**
|
|
* @brief Starts everything SourceMod needs to run
|
|
*/
|
|
void StartSourceMod(bool late);
|
|
|
|
/**
|
|
* @brief Shuts down all SourceMod components
|
|
*/
|
|
void CloseSourceMod();
|
|
|
|
/**
|
|
* @brief Map change hook
|
|
*/
|
|
bool LevelInit(char const *pMapName, char const *pMapEntities, char const *pOldLevel, char const *pLandmarkName, bool loadGame, bool background);
|
|
|
|
/**
|
|
* @brief Level shutdown hook
|
|
*/
|
|
void LevelShutdown();
|
|
|
|
/**
|
|
* @brief Returns whether or not a map load is in progress
|
|
*/
|
|
bool IsMapLoading() const;
|
|
|
|
/**
|
|
* @brief Stores the global target index.
|
|
*/
|
|
void SetGlobalTarget(unsigned int index);
|
|
|
|
/**
|
|
* @brief Returns the global target index.
|
|
*/
|
|
unsigned int GetGlobalTarget() const;
|
|
|
|
/**
|
|
* @brief Sets whether if SoureMod needs to check player auths.
|
|
*/
|
|
void SetAuthChecking(bool set);
|
|
public: // SMGlobalClass
|
|
ConfigResult OnSourceModConfigChanged(const char *key,
|
|
const char *value,
|
|
ConfigSource source,
|
|
char *error,
|
|
size_t maxlength);
|
|
public: // ISourceMod
|
|
const char *GetGamePath() const;
|
|
const char *GetSourceModPath() const;
|
|
size_t BuildPath(PathType type, char *buffer, size_t maxlength, char *format, ...);
|
|
void LogMessage(IExtension *pExt, const char *format, ...);
|
|
void LogError(IExtension *pExt, const char *format, ...);
|
|
size_t FormatString(char *buffer, size_t maxlength, IPluginContext *pContext, const cell_t *params, unsigned int param);
|
|
IDataPack *CreateDataPack();
|
|
void FreeDataPack(IDataPack *pack);
|
|
HandleType_t GetDataPackHandleType(bool readonly=false);
|
|
KeyValues *ReadKeyValuesHandle(Handle_t hndl, HandleError *err=NULL, bool root=false);
|
|
const char *GetGameFolderName() const;
|
|
ISourcePawnEngine *GetScriptingEngine();
|
|
IVirtualMachine *GetScriptingVM();
|
|
void AllPluginsLoaded();
|
|
private:
|
|
/**
|
|
* @brief Loading plugins
|
|
*/
|
|
void DoGlobalPluginLoads();
|
|
|
|
/**
|
|
* @brief GameFrame hook
|
|
*/
|
|
void GameFrame(bool simulating);
|
|
private:
|
|
CStack<CDataPack *> m_freepacks;
|
|
char m_SMBaseDir[PLATFORM_MAX_PATH];
|
|
char m_SMRelDir[PLATFORM_MAX_PATH];
|
|
char m_ModDir[32];
|
|
bool m_IsMapLoading;
|
|
bool m_ExecPluginReload;
|
|
bool m_ExecOnMapEnd;
|
|
unsigned int m_target;
|
|
bool m_CheckingAuth;
|
|
bool m_GotBasePath;
|
|
};
|
|
|
|
extern SourceModBase g_SourceMod;
|
|
extern HandleType_t g_WrBitBufType; //:TODO: find a better place for this
|
|
extern HandleType_t g_RdBitBufType; //:TODO: find a better place for this
|
|
|
|
#endif //_INCLUDE_SOURCEMOD_GLOBALHEADER_H_
|