core/TimerSys.cpp
author David Anderson <dvander@alliedmods.net>
Sun Sep 23 19:33:19 2007 +0000 (2007-09-23)
changeset 1459 8132c2259758
parent 1415 edf4efe5707c
child 1462 c5feb60740cf
permissions -rw-r--r--
- added timeleft functionality to cstrike extension
- finalized timeleft api once again (i hope)
- added weapon slot definitions to cstrike.inc
- bumped timer API
dvander@592
     1
/**
ds@653
     2
 * vim: set ts=4 :
ds@1330
     3
 * =============================================================================
dvander@1231
     4
 * SourceMod
dvander@1231
     5
 * Copyright (C) 2004-2007 AlliedModders LLC.  All rights reserved.
ds@1330
     6
 * =============================================================================
ds@653
     7
 *
ds@1330
     8
 * This program is free software; you can redistribute it and/or modify it under
ds@1330
     9
 * the terms of the GNU General Public License, version 3.0, as published by the
ds@1330
    10
 * Free Software Foundation.
dvander@1231
    11
 * 
ds@1330
    12
 * This program is distributed in the hope that it will be useful, but WITHOUT
ds@1330
    13
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
ds@1330
    14
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
ds@1330
    15
 * details.
dvander@1231
    16
 *
ds@1330
    17
 * You should have received a copy of the GNU General Public License along with
ds@1330
    18
 * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1231
    19
 *
ds@1330
    20
 * As a special exception, AlliedModders LLC gives you permission to link the
ds@1330
    21
 * code of this program (as well as its derivative works) to "Half-Life 2," the
ds@1330
    22
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
ds@1330
    23
 * by the Valve Corporation.  You must obey the GNU General Public License in
ds@1330
    24
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
ds@1330
    25
 * this exception to all derivative works.  AlliedModders LLC defines further
ds@1330
    26
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
ds@1330
    27
 * or <http://www.sourcemod.net/license.php>.
ds@653
    28
 *
ds@653
    29
 * Version: $Id$
ds@653
    30
 */
dvander@592
    31
dvander@1371
    32
#include <time.h>
dvander@592
    33
#include "TimerSys.h"
dvander@1412
    34
#include "ForwardSys.h"
dvander@1371
    35
#include "sourcemm_api.h"
dvander@1412
    36
#include "frame_hooks.h"
dvander@592
    37
dvander@1414
    38
SH_DECL_HOOK2_void(ICvar, CallGlobalChangeCallback, SH_NOATTRIB, false, ConVar *, const char *);
dvander@1414
    39
dvander@616
    40
TimerSystem g_Timers;
dvander@1412
    41
float g_fUniversalTime = 0.0f;
dvander@1459
    42
float g_fGameStartTime = 0.0f;	/* Game game start time, non-universal */
dvander@1412
    43
const float *g_pUniversalTime = &g_fUniversalTime;
dvander@1414
    44
ConVar *mp_timelimit = NULL;
dvander@1459
    45
int g_TimeLeftMode = 0;
dvander@727
    46
dvander@1371
    47
ConVar sm_time_adjustment("sm_time_adjustment", "0", 0, "Adjusts the server time in seconds");
dvander@1371
    48
dvander@1412
    49
inline float GetSimulatedTime()
dvander@1412
    50
{
dvander@1412
    51
	return g_fUniversalTime;
dvander@1412
    52
}
dvander@1410
    53
dvander@1371
    54
time_t GetAdjustedTime(time_t *buf)
dvander@1371
    55
{
dvander@1371
    56
	time_t val = time(NULL) + sm_time_adjustment.GetInt();
dvander@1371
    57
	if (buf)
dvander@1371
    58
	{
dvander@1371
    59
		*buf = val;
dvander@1371
    60
	}
dvander@1371
    61
	return val;
dvander@1371
    62
}
dvander@1371
    63
dvander@1414
    64
class DefaultMapTimer : 
dvander@1414
    65
	public IMapTimer,
dvander@1414
    66
	public SMGlobalClass
dvander@1414
    67
{
dvander@1414
    68
public:
dvander@1414
    69
	DefaultMapTimer()
dvander@1414
    70
	{
dvander@1414
    71
		m_bInUse = false;
dvander@1414
    72
	}
dvander@1414
    73
dvander@1459
    74
	void OnSourceModLevelChange(const char *mapName)
dvander@1459
    75
	{
dvander@1459
    76
		g_fGameStartTime = 0.0f;
dvander@1459
    77
	}
dvander@1459
    78
dvander@1414
    79
	int GetMapTimeLimit()
dvander@1414
    80
	{
dvander@1414
    81
		return mp_timelimit->GetInt();
dvander@1414
    82
	}
dvander@1414
    83
dvander@1414
    84
	void SetMapTimerStatus(bool enabled)
dvander@1414
    85
	{
dvander@1414
    86
		if (enabled && !m_bInUse)
dvander@1414
    87
		{
dvander@1414
    88
			Enable();
dvander@1414
    89
		} 
dvander@1414
    90
		else if (!enabled && m_bInUse)
dvander@1414
    91
		{
dvander@1414
    92
			Disable();
dvander@1414
    93
		}
dvander@1414
    94
		m_bInUse = enabled;
dvander@1414
    95
	}
dvander@1414
    96
dvander@1414
    97
	void ExtendMapTimeLimit(int extra_time)
dvander@1414
    98
	{
dvander@1414
    99
		extra_time /= 60;
dvander@1414
   100
dvander@1414
   101
		if (extra_time == 0)
dvander@1414
   102
		{
dvander@1414
   103
			mp_timelimit->SetValue(0);
dvander@1414
   104
			return;
dvander@1414
   105
		}
dvander@1414
   106
dvander@1414
   107
		mp_timelimit->SetValue(mp_timelimit->GetInt() + extra_time);
dvander@1414
   108
	}
dvander@1414
   109
dvander@1414
   110
	void GlobalChangeCallback(ConVar *pVar, const char *old_value)
dvander@1414
   111
	{
dvander@1414
   112
		if (pVar != mp_timelimit)
dvander@1414
   113
		{
dvander@1414
   114
			return;
dvander@1414
   115
		}
dvander@1414
   116
dvander@1415
   117
		if (atoi(old_value) == pVar->GetInt())
dvander@1415
   118
		{
dvander@1415
   119
			return;
dvander@1415
   120
		}
dvander@1415
   121
dvander@1415
   122
		g_Timers.MapTimeLeftChanged();
dvander@1414
   123
	}
dvander@1414
   124
dvander@1414
   125
private:
dvander@1414
   126
	void Enable()
dvander@1414
   127
	{
dvander@1414
   128
		SH_ADD_HOOK_MEMFUNC(ICvar, CallGlobalChangeCallback, icvar, this, &DefaultMapTimer::GlobalChangeCallback, false);
dvander@1414
   129
	}
dvander@1414
   130
dvander@1414
   131
	void Disable()
dvander@1414
   132
	{
dvander@1414
   133
		SH_REMOVE_HOOK_MEMFUNC(ICvar, CallGlobalChangeCallback, icvar, this, &DefaultMapTimer::GlobalChangeCallback, false);
dvander@1414
   134
	}
dvander@1414
   135
dvander@1414
   136
private:
dvander@1414
   137
	bool m_bInUse;
dvander@1414
   138
} s_DefaultMapTimer;
dvander@1414
   139
dvander@592
   140
void ITimer::Initialize(ITimedEvent *pCallbacks, float fInterval, float fToExec, void *pData, int flags)
dvander@592
   141
{
dvander@592
   142
	m_Listener = pCallbacks;
dvander@592
   143
	m_Interval = fInterval;
dvander@592
   144
	m_ToExec = fToExec;
dvander@592
   145
	m_pData = pData;
dvander@592
   146
	m_Flags = flags;
dvander@592
   147
	m_InExec = false;
dvander@592
   148
	m_KillMe = false;
dvander@592
   149
}
dvander@592
   150
dvander@1408
   151
TimerSystem::TimerSystem()
dvander@1408
   152
{
dvander@1414
   153
	m_pMapTimer = NULL;
dvander@1412
   154
	m_bHasMapTickedYet = false;
dvander@1412
   155
	m_fLastTickedTime = 0.0f;
dvander@1412
   156
	m_LastExecTime = 0.0f;
dvander@1408
   157
}
dvander@1408
   158
faluco@641
   159
TimerSystem::~TimerSystem()
faluco@641
   160
{
faluco@641
   161
	CStack<ITimer *>::iterator iter;
faluco@641
   162
	for (iter=m_FreeTimers.begin(); iter!=m_FreeTimers.end(); iter++)
faluco@641
   163
	{
faluco@641
   164
		delete (*iter);
faluco@641
   165
	}
faluco@641
   166
	m_FreeTimers.popall();
faluco@641
   167
}
faluco@641
   168
dvander@616
   169
void TimerSystem::OnSourceModAllInitialized()
dvander@592
   170
{
dvander@592
   171
	g_ShareSys.AddInterface(NULL, this);
dvander@1412
   172
	m_pOnGameFrame = g_Forwards.CreateForward("OnGameFrame", ET_Ignore, 0, NULL);
dvander@1459
   173
	m_pOnMapTimeLeftChanged = g_Forwards.CreateForward("OnMapTimeLeftChanged", ET_Ignore, 0, NULL);
dvander@1412
   174
}
dvander@1412
   175
dvander@1414
   176
void TimerSystem::OnSourceModGameInitialized()
dvander@1414
   177
{
dvander@1414
   178
	mp_timelimit = icvar->FindVar("mp_timelimit");
dvander@1414
   179
dvander@1414
   180
	if (m_pMapTimer == NULL && mp_timelimit != NULL)
dvander@1414
   181
	{
dvander@1414
   182
		SetMapTimer(&s_DefaultMapTimer);
dvander@1414
   183
	}
dvander@1414
   184
}
dvander@1414
   185
dvander@1412
   186
void TimerSystem::OnSourceModShutdown()
dvander@1412
   187
{
dvander@1414
   188
	SetMapTimer(NULL);
dvander@1412
   189
	g_Forwards.ReleaseForward(m_pOnGameFrame);
dvander@1459
   190
	g_Forwards.ReleaseForward(m_pOnMapTimeLeftChanged);
dvander@592
   191
}
dvander@592
   192
dvander@673
   193
void TimerSystem::OnSourceModLevelChange(const char *mapName)
dvander@673
   194
{
dvander@1142
   195
	MapChange(true);
dvander@673
   196
}
dvander@673
   197
dvander@1412
   198
void TimerSystem::OnSourceModLevelEnd()
dvander@1412
   199
{
dvander@1412
   200
	m_bHasMapTickedYet = false;
dvander@1412
   201
}
dvander@1412
   202
dvander@1412
   203
void TimerSystem::GameFrame(bool simulating)
dvander@1412
   204
{
dvander@1412
   205
	if (simulating && m_bHasMapTickedYet)
dvander@1412
   206
	{
dvander@1412
   207
		g_fUniversalTime += gpGlobals->curtime - m_fLastTickedTime;
dvander@1412
   208
	}
dvander@1412
   209
	else 
dvander@1412
   210
	{
dvander@1412
   211
		g_fUniversalTime += gpGlobals->interval_per_tick;
dvander@1412
   212
	}
dvander@1412
   213
dvander@1412
   214
	m_fLastTickedTime = gpGlobals->curtime;
dvander@1459
   215
	m_bHasMapTickedYet = true;
dvander@1412
   216
dvander@1412
   217
	if (g_fUniversalTime - m_LastExecTime >= 0.1)
dvander@1412
   218
	{
dvander@1412
   219
		RunFrame();
dvander@1412
   220
	}
dvander@1412
   221
dvander@1412
   222
	RunFrameHooks();
dvander@1412
   223
dvander@1412
   224
	if (m_pOnGameFrame->GetFunctionCount())
dvander@1412
   225
	{
dvander@1412
   226
		m_pOnGameFrame->Execute(NULL);
dvander@1412
   227
	}
dvander@1412
   228
}
dvander@1412
   229
dvander@616
   230
void TimerSystem::RunFrame()
dvander@592
   231
{
dvander@592
   232
	ITimer *pTimer;
dvander@592
   233
	TimerIter iter;
dvander@592
   234
dvander@727
   235
	float curtime = GetSimulatedTime();
dvander@592
   236
	for (iter=m_SingleTimers.begin(); iter!=m_SingleTimers.end(); )
dvander@592
   237
	{
dvander@592
   238
		pTimer = (*iter);
dvander@727
   239
		if (curtime >= pTimer->m_ToExec)
dvander@592
   240
		{
dvander@592
   241
			pTimer->m_InExec = true;
dvander@592
   242
			pTimer->m_Listener->OnTimer(pTimer, pTimer->m_pData);
faluco@612
   243
			pTimer->m_Listener->OnTimerEnd(pTimer, pTimer->m_pData);
dvander@592
   244
			iter = m_SingleTimers.erase(iter);
dvander@592
   245
			m_FreeTimers.push(pTimer);
dvander@592
   246
		} else {
dvander@592
   247
			break;
dvander@592
   248
		}
dvander@592
   249
	}
dvander@592
   250
dvander@592
   251
	ResultType res;
dvander@592
   252
	for (iter=m_LoopTimers.begin(); iter!=m_LoopTimers.end(); )
dvander@592
   253
	{
dvander@592
   254
		pTimer = (*iter);
dvander@727
   255
		if (curtime >= pTimer->m_ToExec)
dvander@592
   256
		{
dvander@592
   257
			pTimer->m_InExec = true;
dvander@592
   258
			res = pTimer->m_Listener->OnTimer(pTimer, pTimer->m_pData);
dvander@592
   259
			if (pTimer->m_KillMe || (res == Pl_Stop))
dvander@592
   260
			{
dvander@592
   261
				pTimer->m_Listener->OnTimerEnd(pTimer, pTimer->m_pData);
dvander@592
   262
				iter = m_LoopTimers.erase(iter);
dvander@592
   263
				m_FreeTimers.push(pTimer);
dvander@592
   264
				continue;
dvander@592
   265
			}
dvander@592
   266
			pTimer->m_InExec = false;
dvander@727
   267
			pTimer->m_ToExec = curtime + pTimer->m_Interval;
dvander@592
   268
		}
dvander@592
   269
		iter++;
dvander@592
   270
	}
dvander@592
   271
dvander@727
   272
	m_LastExecTime = curtime;
dvander@592
   273
}
dvander@592
   274
dvander@616
   275
ITimer *TimerSystem::CreateTimer(ITimedEvent *pCallbacks, float fInterval, void *pData, int flags)
dvander@592
   276
{
dvander@592
   277
	ITimer *pTimer;
dvander@592
   278
	TimerIter iter;
dvander@727
   279
	float to_exec = GetSimulatedTime() + fInterval;
dvander@592
   280
dvander@592
   281
	if (m_FreeTimers.empty())
dvander@592
   282
	{
dvander@592
   283
		pTimer = new ITimer;
dvander@592
   284
	} else {
dvander@592
   285
		pTimer = m_FreeTimers.front();
dvander@592
   286
		m_FreeTimers.pop();
dvander@592
   287
	}
dvander@592
   288
dvander@592
   289
	pTimer->Initialize(pCallbacks, fInterval, to_exec, pData, flags);
dvander@592
   290
dvander@592
   291
	if (flags & TIMER_FLAG_REPEAT)
dvander@592
   292
	{
dvander@592
   293
		m_LoopTimers.push_back(pTimer);
dvander@592
   294
		goto return_timer;
dvander@592
   295
	}
dvander@592
   296
dvander@1414
   297
	if (m_SingleTimers.size() >= 1)
dvander@592
   298
	{
dvander@1414
   299
		iter = --m_SingleTimers.end();
dvander@1414
   300
		if ((*iter)->m_ToExec <= to_exec)
dvander@592
   301
		{
dvander@1414
   302
			goto normal_insert_end;
dvander@592
   303
		}
dvander@1414
   304
	}
dvander@1414
   305
dvander@1414
   306
	for (iter=m_SingleTimers.begin(); iter!=m_SingleTimers.end(); iter++)
dvander@1414
   307
	{
dvander@1414
   308
		if ((*iter)->m_ToExec >= to_exec)
dvander@1407
   309
		{
dvander@1414
   310
			m_SingleTimers.insert(iter, pTimer);
dvander@1414
   311
			goto return_timer;
dvander@1407
   312
		}
dvander@1414
   313
	}
dvander@1407
   314
dvander@1407
   315
normal_insert_end:
dvander@1414
   316
	m_SingleTimers.push_back(pTimer);
dvander@592
   317
dvander@592
   318
return_timer:
dvander@592
   319
	return pTimer;
dvander@592
   320
}
dvander@592
   321
dvander@616
   322
void TimerSystem::FireTimerOnce(ITimer *pTimer, bool delayExec)
dvander@592
   323
{
dvander@592
   324
	ResultType res;
dvander@592
   325
dvander@592
   326
	if (pTimer->m_InExec)
dvander@592
   327
	{
dvander@592
   328
		return;
dvander@592
   329
	}
dvander@592
   330
dvander@592
   331
	pTimer->m_InExec = true;
dvander@592
   332
	res = pTimer->m_Listener->OnTimer(pTimer, pTimer->m_pData);
dvander@592
   333
dvander@592
   334
	if (!(pTimer->m_Flags & TIMER_FLAG_REPEAT))
dvander@592
   335
	{
dvander@592
   336
		pTimer->m_Listener->OnTimerEnd(pTimer, pTimer->m_pData);
dvander@1414
   337
		m_SingleTimers.remove(pTimer);
dvander@592
   338
		m_FreeTimers.push(pTimer);
dvander@592
   339
	} else {
faluco@612
   340
		if ((res != Pl_Stop) && !pTimer->m_KillMe)
dvander@592
   341
		{
faluco@612
   342
			if (delayExec)
faluco@612
   343
			{
dvander@727
   344
				pTimer->m_ToExec = GetSimulatedTime() + pTimer->m_Interval;
faluco@612
   345
			}
dvander@592
   346
			pTimer->m_InExec = false;
dvander@592
   347
			return;
dvander@592
   348
		}
dvander@592
   349
		pTimer->m_Listener->OnTimerEnd(pTimer, pTimer->m_pData);
dvander@592
   350
		m_LoopTimers.remove(pTimer);
dvander@592
   351
		m_FreeTimers.push(pTimer);
dvander@592
   352
	}
dvander@592
   353
}
dvander@592
   354
dvander@616
   355
void TimerSystem::KillTimer(ITimer *pTimer)
dvander@592
   356
{
dvander@592
   357
	if (pTimer->m_KillMe)
dvander@592
   358
	{
dvander@592
   359
		return;
dvander@592
   360
	}
dvander@592
   361
dvander@592
   362
	if (pTimer->m_InExec)
dvander@592
   363
	{
dvander@592
   364
		pTimer->m_KillMe = true;
dvander@592
   365
		return;
dvander@592
   366
	}
dvander@592
   367
dvander@592
   368
	pTimer->m_InExec = true; /* The timer it's not really executed but this check needs to be done */
dvander@592
   369
	pTimer->m_Listener->OnTimerEnd(pTimer, pTimer->m_pData);
dvander@592
   370
dvander@1407
   371
	if (pTimer->m_Flags & TIMER_FLAG_REPEAT)
dvander@1407
   372
	{
dvander@1407
   373
		m_LoopTimers.remove(pTimer);
dvander@1407
   374
	} else {
dvander@1407
   375
		m_SingleTimers.remove(pTimer);
dvander@1407
   376
	}
dvander@592
   377
dvander@592
   378
	m_FreeTimers.push(pTimer);
dvander@592
   379
}
dvander@592
   380
dvander@1108
   381
CStack<ITimer *> s_tokill;
dvander@1142
   382
void TimerSystem::MapChange(bool real_mapchange)
dvander@592
   383
{
dvander@592
   384
	ITimer *pTimer;
dvander@592
   385
	TimerIter iter;
dvander@592
   386
dvander@592
   387
	for (iter=m_SingleTimers.begin(); iter!=m_SingleTimers.end(); iter++)
dvander@592
   388
	{
dvander@592
   389
		pTimer = (*iter);
dvander@1142
   390
		if (real_mapchange && (pTimer->m_Flags & TIMER_FLAG_NO_MAPCHANGE))
dvander@1108
   391
		{
dvander@1108
   392
			s_tokill.push(pTimer);
dvander@1108
   393
		}
dvander@592
   394
	}
dvander@592
   395
dvander@592
   396
	for (iter=m_LoopTimers.begin(); iter!=m_LoopTimers.end(); iter++)
dvander@592
   397
	{
dvander@592
   398
		pTimer = (*iter);
dvander@1142
   399
		if (real_mapchange && (pTimer->m_Flags & TIMER_FLAG_NO_MAPCHANGE))
dvander@1108
   400
		{
dvander@1108
   401
			s_tokill.push(pTimer);
dvander@1108
   402
		}
dvander@1108
   403
	}
dvander@1108
   404
dvander@1108
   405
	while (!s_tokill.empty())
dvander@1108
   406
	{
dvander@1108
   407
		KillTimer(s_tokill.front());
dvander@1108
   408
		s_tokill.pop();
dvander@592
   409
	}
dvander@592
   410
}
dvander@1407
   411
dvander@1414
   412
IMapTimer *TimerSystem::SetMapTimer(IMapTimer *pTimer)
dvander@1407
   413
{
dvander@1414
   414
	IMapTimer *old = m_pMapTimer;
dvander@1414
   415
dvander@1414
   416
	m_pMapTimer = pTimer;
dvander@1414
   417
dvander@1414
   418
	if (m_pMapTimer)
dvander@1414
   419
	{
dvander@1414
   420
		m_pMapTimer->SetMapTimerStatus(true);
dvander@1414
   421
	}
dvander@1414
   422
dvander@1414
   423
	if (old)
dvander@1414
   424
	{
dvander@1414
   425
		old->SetMapTimerStatus(false);
dvander@1414
   426
	}
dvander@1414
   427
dvander@1407
   428
	return old;
dvander@1407
   429
}
dvander@1407
   430
dvander@1414
   431
IMapTimer *TimerSystem::GetMapTimer()
dvander@1414
   432
{
dvander@1414
   433
	return m_pMapTimer;
dvander@1414
   434
}
dvander@1414
   435
dvander@1415
   436
void TimerSystem::MapTimeLeftChanged()
dvander@1414
   437
{
dvander@1459
   438
	m_pOnMapTimeLeftChanged->Execute(NULL);
dvander@1459
   439
}
dvander@1415
   440
dvander@1459
   441
void TimerSystem::NotifyOfGameStart(float offset)
dvander@1459
   442
{
dvander@1459
   443
	g_fGameStartTime = gpGlobals->curtime + offset;
dvander@1414
   444
}
dvander@1415
   445
dvander@1415
   446
float TimerSystem::GetTickedTime()
dvander@1415
   447
{
dvander@1415
   448
	return g_fUniversalTime;
dvander@1415
   449
}
dvander@1459
   450
dvander@1459
   451
bool TimerSystem::GetMapTimeLeft(float *time_left)
dvander@1459
   452
{
dvander@1459
   453
	int time_limit;
dvander@1459
   454
	if (!m_pMapTimer || (time_limit = m_pMapTimer->GetMapTimeLimit()) < 1)
dvander@1459
   455
	{
dvander@1459
   456
		return false;
dvander@1459
   457
	}
dvander@1459
   458
dvander@1459
   459
	*time_left = (g_fGameStartTime + time_limit * 60.0f) - gpGlobals->curtime;
dvander@1459
   460
dvander@1459
   461
	return true;
dvander@1459
   462
}