ITimerSystem.h

Go to the documentation of this file.

#ifndef _INCLUDE_SOURCEMOD_TIMER_SYSTEM_H_
#define _INCLUDE_SOURCEMOD_TIMER_SYSTEM_H_

#include <IShareSys.h>
#include <IForwardSys.h>

#define SMINTERFACE_TIMERSYS_NAME               "ITimerSys"
#define SMINTERFACE_TIMERSYS_VERSION    4

namespace SourceMod
{
        class ITimer;

        class IMapTimer
        {
        public:
                virtual int GetMapTimeLimit() =0;
                
                virtual void ExtendMapTimeLimit(int extra_time) =0;

                virtual void SetMapTimerStatus(bool enabled) =0;
        };

        class ITimedEvent
        {
        public:
                virtual ResultType OnTimer(ITimer *pTimer, void *pData) =0;

                virtual void OnTimerEnd(ITimer *pTimer, void *pData) =0;
        };

        #define TIMER_FLAG_REPEAT                       (1<<0)          
        #define TIMER_FLAG_NO_MAPCHANGE         (1<<1)          
        class ITimerSystem : public SMInterface
        {
        public:
                const char *GetInterfaceName()
                {
                        return SMINTERFACE_TIMERSYS_NAME;
                }
                unsigned int GetInterfaceVersion()
                {
                        return SMINTERFACE_TIMERSYS_VERSION;
                }
        public:
                virtual ITimer *CreateTimer(ITimedEvent *pCallbacks, 
                                                                                 float fInterval, 
                                                                                 void *pData,
                                                                                 int flags) =0;

                virtual void KillTimer(ITimer *pTimer) =0;

                virtual void FireTimerOnce(ITimer *pTimer, bool delayExec=false) =0;

                virtual IMapTimer *SetMapTimer(IMapTimer *pTimer) =0;

                virtual void MapTimeLeftChanged() =0;

                virtual float GetTickedTime() =0;

                virtual void NotifyOfGameStart(float offset = 0.0f) =0;

                virtual bool GetMapTimeLeft(float *pTime) =0;

                virtual IMapTimer *GetMapTimer() = 0;
        };
}

#endif //_INCLUDE_SOURCEMOD_TIMER_SYSTEM_H_