ISourceMod.h

Go to the documentation of this file.

#ifndef _INCLUDE_SOURCEMOD_MAIN_HELPER_INTERFACE_H_
#define _INCLUDE_SOURCEMOD_MAIN_HELPER_INTERFACE_H_

#include <IHandleSys.h>
#include <sp_vm_api.h>
#include <IDataPack.h>
#include <time.h>

#define SMINTERFACE_SOURCEMOD_NAME              "ISourceMod"
#define SMINTERFACE_SOURCEMOD_VERSION   13

class KeyValues;

namespace SourceMod
{
        enum PathType
        {
                Path_None = 0,                  
                Path_Game,                              
                Path_SM,                                
                Path_SM_Rel,                    
        };

        typedef void (*GAME_FRAME_HOOK)(bool simulating);

        typedef void (*FRAMEACTION)(void *data);

        class ISourceMod : public SMInterface
        {
        public:
                virtual const char *GetInterfaceName()
                {
                        return SMINTERFACE_SOURCEMOD_NAME;
                }
                virtual unsigned int GetInterfaceVersion()
                {
                        return SMINTERFACE_SOURCEMOD_VERSION;
                }
        public:
                virtual const char *GetGamePath() const =0;

                virtual const char *GetSourceModPath() const =0;

                virtual size_t BuildPath(PathType type, char *buffer, size_t maxlength, const char *format, ...) =0;

                virtual void LogMessage(IExtension *pExt, const char *format, ...) =0;

                virtual void LogError(IExtension *pExt, const char *format, ...) =0;

                virtual size_t FormatString(char *buffer, 
                                                                        size_t maxlength, 
                                                                        SourcePawn::IPluginContext *pContext,
                                                                        const cell_t *params,
                                                                        unsigned int param) =0;

                virtual IDataPack *CreateDataPack() =0;

                virtual void FreeDataPack(IDataPack *pack) =0;

                virtual HandleType_t GetDataPackHandleType(bool readonly=false) =0;

                virtual KeyValues *ReadKeyValuesHandle(Handle_t hndl, HandleError *err=NULL, bool root=false) =0;

                virtual const char *GetGameFolderName() const =0;

                virtual SourcePawn::ISourcePawnEngine *GetScriptingEngine() =0;

                virtual SourcePawn::IVirtualMachine *GetScriptingVM() =0;

                virtual time_t GetAdjustedTime() =0;

                virtual unsigned int SetGlobalTarget(unsigned int index) =0;

                virtual unsigned int GetGlobalTarget() const =0;

                virtual void AddGameFrameHook(GAME_FRAME_HOOK hook) =0;

                virtual void RemoveGameFrameHook(GAME_FRAME_HOOK hook) =0;

                virtual size_t Format(char *buffer, size_t maxlength, const char *fmt, ...) = 0;

                virtual size_t FormatArgs(char *buffer, size_t maxlength, const char *fmt, va_list ap) = 0;

                virtual void AddFrameAction(FRAMEACTION fn, void *data) = 0;

                virtual const char *GetCoreConfigValue(const char *key) = 0;

                virtual int GetPluginId() = 0;

                
                virtual int GetShApiVersion() = 0;

                virtual bool IsMapRunning() = 0;
        };
}

#endif //_INCLUDE_SOURCEMOD_MAIN_HELPER_INTERFACE_H_