core/MenuVoting.cpp
author David Anderson <dvander@alliedmods.net>
Wed Feb 27 13:49:57 2008 +0000 (2008-02-27)
changeset 1900 457329ae65bd
parent 1541 e46ad208b9b4
child 1947 e73a1e51833b
permissions -rw-r--r--
fixed amb1483 - GetEntPropString() rejected FIELD_MODELNAME/FIELD_SOUNDNAME
dvander@1269
     1
/**
dvander@1269
     2
 * vim: set ts=4 :
ds@1330
     3
 * =============================================================================
dvander@1269
     4
 * SourceMod
dvander@1269
     5
 * Copyright (C) 2004-2007 AlliedModders LLC.  All rights reserved.
ds@1330
     6
 * =============================================================================
dvander@1269
     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@1269
    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@1269
    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@1269
    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>.
dvander@1269
    28
 *
dvander@1269
    29
 * Version: $Id$
dvander@1269
    30
 */
dvander@1269
    31
dvander@1269
    32
#include <string.h>
dvander@1269
    33
#include <stdlib.h>
dvander@1269
    34
#include "MenuVoting.h"
dvander@1269
    35
#include "PlayerManager.h"
dvander@1269
    36
#include "sourcemm_api.h"
dvander@1269
    37
dvander@1291
    38
float g_next_vote = 0.0f;
dvander@1291
    39
faluco@1541
    40
#if defined ORANGEBOX_BUILD
faluco@1541
    41
void OnVoteDelayChange(IConVar *cvar, const char *value, float flOldValue);
faluco@1541
    42
#else
dvander@1291
    43
void OnVoteDelayChange(ConVar *cvar, const char *value);
faluco@1541
    44
#endif
dvander@1291
    45
ConVar sm_vote_delay("sm_vote_delay",
dvander@1291
    46
					 "30",
dvander@1291
    47
					 0,
dvander@1291
    48
					 "Sets the recommended time in between public votes",
dvander@1291
    49
					 false,
dvander@1291
    50
					 0.0,
dvander@1291
    51
					 false,
dvander@1291
    52
					 0.0,
dvander@1291
    53
					 OnVoteDelayChange);
dvander@1291
    54
faluco@1541
    55
#if defined ORANGEBOX_BUILD
faluco@1541
    56
void OnVoteDelayChange(IConVar *cvar, const char *value, float flOldValue)
faluco@1541
    57
#else
dvander@1291
    58
void OnVoteDelayChange(ConVar *cvar, const char *value)
faluco@1541
    59
#endif
dvander@1291
    60
{
dvander@1291
    61
	/* See if the new vote delay isn't something we need to account for */
dvander@1291
    62
	if (sm_vote_delay.GetFloat() < 1.0f)
dvander@1291
    63
	{
dvander@1291
    64
		g_next_vote = 0.0f;
dvander@1291
    65
		return;
dvander@1291
    66
	}
dvander@1291
    67
dvander@1291
    68
	/* If there was never a last vote, ignore this change */
dvander@1291
    69
	if (g_next_vote < 0.1f)
dvander@1291
    70
	{
dvander@1291
    71
		return;
dvander@1291
    72
	}
dvander@1291
    73
dvander@1291
    74
	/* Subtract the original value, then add the new one. */
dvander@1291
    75
	g_next_vote -= (float)atof(value);
dvander@1291
    76
	g_next_vote += sm_vote_delay.GetFloat();
dvander@1291
    77
}
dvander@1291
    78
dvander@1291
    79
unsigned int VoteMenuHandler::GetRemainingVoteDelay()
dvander@1291
    80
{
dvander@1291
    81
	if (g_next_vote <= gpGlobals->curtime)
dvander@1291
    82
	{
dvander@1291
    83
		return 0;
dvander@1291
    84
	}
dvander@1291
    85
dvander@1291
    86
	return (unsigned int)(g_next_vote - gpGlobals->curtime);
dvander@1291
    87
}
dvander@1291
    88
dvander@1269
    89
void VoteMenuHandler::OnSourceModAllInitialized()
dvander@1269
    90
{
dvander@1269
    91
	g_Players.AddClientListener(this);
dvander@1269
    92
}
dvander@1269
    93
dvander@1269
    94
void VoteMenuHandler::OnSourceModShutdown()
dvander@1269
    95
{
dvander@1269
    96
	g_Players.RemoveClientListener(this);
dvander@1269
    97
}
dvander@1269
    98
dvander@1291
    99
void VoteMenuHandler::OnSourceModLevelChange(const char *mapName)
dvander@1291
   100
{
dvander@1291
   101
	g_next_vote = 0.0f;
dvander@1291
   102
}
dvander@1291
   103
dvander@1269
   104
unsigned int VoteMenuHandler::GetMenuAPIVersion2()
dvander@1269
   105
{
dvander@1269
   106
	return m_pHandler->GetMenuAPIVersion2();
dvander@1269
   107
}
dvander@1269
   108
dvander@1269
   109
void VoteMenuHandler::OnClientDisconnected(int client)
dvander@1269
   110
{
dvander@1269
   111
	if (!IsVoteInProgress())
dvander@1269
   112
	{
dvander@1269
   113
		return;
dvander@1269
   114
	}
dvander@1269
   115
dvander@1269
   116
	/* Wipe out their vote if they had one */
dvander@1269
   117
	int item;
dvander@1269
   118
	if ((item = m_ClientVotes[client]) >= 0)
dvander@1269
   119
	{
dvander@1269
   120
		assert((unsigned)item < m_Items);
dvander@1269
   121
		assert(m_Votes[item] > 0);
dvander@1269
   122
		m_Votes[item]--;
dvander@1269
   123
		m_ClientVotes[client] = -1;
dvander@1269
   124
	}
dvander@1269
   125
}
dvander@1269
   126
dvander@1269
   127
bool VoteMenuHandler::IsVoteInProgress()
dvander@1269
   128
{
dvander@1269
   129
	return (m_pCurMenu != NULL);
dvander@1269
   130
}
dvander@1269
   131
dvander@1269
   132
bool VoteMenuHandler::StartVote(IBaseMenu *menu, unsigned int num_clients, int clients[], unsigned int max_time, unsigned int flags/* =0 */)
dvander@1269
   133
{
dvander@1269
   134
	if (!InitializeVoting(menu, menu->GetHandler(), max_time, flags))
dvander@1269
   135
	{
dvander@1269
   136
		return false;
dvander@1269
   137
	}
dvander@1269
   138
dvander@1291
   139
	float fVoteDelay = sm_vote_delay.GetFloat();
dvander@1291
   140
	if (fVoteDelay < 1.0)
dvander@1291
   141
	{
dvander@1291
   142
		g_next_vote = 0.0;
dvander@1291
   143
	} else {
dvander@1291
   144
		/* This little trick breaks for infinite votes!
dvander@1291
   145
		 * However, we just ignore that since those 1) shouldn't exist and 
dvander@1291
   146
		 * 2) people must be checking IsVoteInProgress() beforehand anyway.
dvander@1291
   147
		 */
dvander@1291
   148
		g_next_vote = gpGlobals->curtime + fVoteDelay + (float)max_time;
dvander@1291
   149
	}
dvander@1291
   150
dvander@1269
   151
	for (unsigned int i=0; i<num_clients; i++)
dvander@1269
   152
	{
dvander@1269
   153
		menu->Display(clients[i], max_time, this);
dvander@1269
   154
	}
dvander@1269
   155
dvander@1269
   156
	StartVoting();
dvander@1269
   157
dvander@1269
   158
	return true;
dvander@1269
   159
}
dvander@1269
   160
dvander@1269
   161
bool VoteMenuHandler::InitializeVoting(IBaseMenu *menu, 
dvander@1269
   162
									   IMenuHandler *handler,
dvander@1269
   163
									   unsigned int time,
dvander@1269
   164
									   unsigned int flags)
dvander@1269
   165
{
dvander@1269
   166
	if (IsVoteInProgress())
dvander@1269
   167
	{
dvander@1269
   168
		return false;
dvander@1269
   169
	}
dvander@1269
   170
dvander@1269
   171
	InternalReset();
dvander@1269
   172
dvander@1269
   173
	/* Mark all clients as not voting */
dvander@1269
   174
	for (int i=1; i<=gpGlobals->maxClients; i++)
dvander@1269
   175
	{
dvander@1269
   176
		m_ClientVotes[i] = -2;
dvander@1269
   177
	}
dvander@1269
   178
dvander@1269
   179
	m_Items = menu->GetItemCount();
dvander@1269
   180
dvander@1269
   181
	if (m_Votes.size() < (size_t)m_Items)
dvander@1269
   182
	{
dvander@1269
   183
		/* Only clear the items we need to... */
dvander@1269
   184
		size_t size = m_Votes.size();
dvander@1269
   185
		for (size_t i=0; i<size; i++)
dvander@1269
   186
		{
dvander@1269
   187
			m_Votes[i] = 0;
dvander@1269
   188
		}
dvander@1269
   189
		m_Votes.resize(m_Items, 0);
dvander@1269
   190
	} else {
dvander@1269
   191
		for (unsigned int i=0; i<m_Items; i++)
dvander@1269
   192
		{
dvander@1269
   193
			m_Votes[i] = 0;
dvander@1269
   194
		}
dvander@1269
   195
	}
dvander@1269
   196
dvander@1269
   197
	m_pCurMenu = menu;
dvander@1269
   198
	m_VoteTime = time;
dvander@1269
   199
	m_VoteFlags = flags;
dvander@1269
   200
	m_pHandler = handler;
dvander@1269
   201
dvander@1269
   202
	m_pHandler->OnMenuStart(m_pCurMenu);
dvander@1269
   203
dvander@1269
   204
	return true;
dvander@1269
   205
}
dvander@1269
   206
dvander@1269
   207
void VoteMenuHandler::StartVoting()
dvander@1269
   208
{
dvander@1269
   209
	if (!m_pCurMenu)
dvander@1269
   210
	{
dvander@1269
   211
		return;
dvander@1269
   212
	}
dvander@1269
   213
dvander@1269
   214
	m_bStarted = true;
dvander@1269
   215
dvander@1269
   216
	m_pHandler->OnMenuVoteStart(m_pCurMenu);
dvander@1269
   217
dvander@1269
   218
	/* By now we know how many clients were set.  
dvander@1269
   219
	 * If there are none, we should end IMMEDIATELY.
dvander@1269
   220
	 */
dvander@1269
   221
	if (m_Clients == 0)
dvander@1269
   222
	{
dvander@1269
   223
		EndVoting();
dvander@1269
   224
	}
dvander@1269
   225
}
dvander@1269
   226
dvander@1269
   227
void VoteMenuHandler::DecrementPlayerCount()
dvander@1269
   228
{
dvander@1269
   229
	assert(m_Clients > 0);
dvander@1269
   230
dvander@1269
   231
	m_Clients--;
dvander@1269
   232
dvander@1269
   233
	if (m_bStarted && m_Clients == 0)
dvander@1269
   234
	{
dvander@1269
   235
		EndVoting();
dvander@1269
   236
	}
dvander@1269
   237
}
dvander@1269
   238
dvander@1269
   239
int SortVoteItems(const void *item1, const void *item2)
dvander@1269
   240
{
dvander@1269
   241
	return ((menu_vote_result_t::menu_item_vote_t *)item2)->count 
dvander@1269
   242
		- ((menu_vote_result_t::menu_item_vote_t *)item1)->count;
dvander@1269
   243
}
dvander@1269
   244
dvander@1269
   245
void VoteMenuHandler::EndVoting()
dvander@1269
   246
{
dvander@1291
   247
	/* Set when the next delay ends.  We ignore cancellation because a menu
dvander@1291
   248
	 * was, at one point, displayed, which is all that counts.  However, we
dvander@1291
   249
	 * do re-calculate the time just in case the menu had no time limit.
dvander@1291
   250
	 */
dvander@1291
   251
	float fVoteDelay = sm_vote_delay.GetFloat();
dvander@1291
   252
	if (fVoteDelay < 1.0)
dvander@1291
   253
	{
dvander@1291
   254
		g_next_vote = 0.0;
dvander@1291
   255
	} else {
dvander@1291
   256
		g_next_vote = gpGlobals->curtime + fVoteDelay;
dvander@1291
   257
	}
dvander@1291
   258
dvander@1269
   259
	if (m_bCancelled)
dvander@1269
   260
	{
dvander@1269
   261
		/* If we were cancelled, don't bother tabulating anything.
dvander@1269
   262
		 * Reset just in case someone tries to redraw, which means
dvander@1269
   263
		 * we need to save our states.
dvander@1269
   264
		 */
dvander@1269
   265
		IBaseMenu *menu = m_pCurMenu;
dvander@1269
   266
		IMenuHandler *handler = m_pHandler;
dvander@1269
   267
		InternalReset();
dvander@1296
   268
		handler->OnMenuVoteCancel(menu, VoteCancel_Generic);
dvander@1269
   269
		handler->OnMenuEnd(menu, MenuEnd_VotingCancelled);
dvander@1269
   270
		return;
dvander@1269
   271
	}
dvander@1269
   272
dvander@1269
   273
	menu_vote_result_t vote;
dvander@1269
   274
	menu_vote_result_t::menu_client_vote_t client_vote[256];
dvander@1269
   275
	menu_vote_result_t::menu_item_vote_t item_vote[256];
dvander@1269
   276
dvander@1269
   277
	memset(&vote, 0, sizeof(vote));
dvander@1269
   278
dvander@1269
   279
	/* Build the item list */
dvander@1269
   280
	for (unsigned int i=0; i<m_Items; i++)
dvander@1269
   281
	{
dvander@1269
   282
		if (m_Votes[i] > 0)
dvander@1269
   283
		{
dvander@1269
   284
			item_vote[vote.num_items].count = m_Votes[i];
dvander@1269
   285
			item_vote[vote.num_items].item = i;
dvander@1269
   286
			vote.num_votes += m_Votes[i];
dvander@1269
   287
			vote.num_items++;
dvander@1269
   288
		}
dvander@1269
   289
	}
dvander@1269
   290
	vote.item_list = item_vote;
dvander@1269
   291
dvander@1269
   292
	if (!vote.num_votes)
dvander@1269
   293
	{
dvander@1269
   294
		IBaseMenu *menu = m_pCurMenu;
dvander@1269
   295
		IMenuHandler *handler = m_pHandler;
dvander@1269
   296
		InternalReset();
dvander@1296
   297
		handler->OnMenuVoteCancel(menu, VoteCancel_NoVotes);
dvander@1296
   298
		handler->OnMenuEnd(menu, MenuEnd_VotingCancelled);
dvander@1269
   299
		return;
dvander@1269
   300
	}
dvander@1269
   301
dvander@1269
   302
	/* Build the client list */
dvander@1269
   303
	for (int i=1; i<=gpGlobals->maxClients; i++)
dvander@1269
   304
	{
dvander@1269
   305
		if (m_ClientVotes[i] >= -1)
dvander@1269
   306
		{
dvander@1269
   307
			client_vote[vote.num_clients].client = i;
dvander@1269
   308
			client_vote[vote.num_clients].item = m_ClientVotes[i];
dvander@1269
   309
			vote.num_clients++;
dvander@1269
   310
		}
dvander@1269
   311
	}
dvander@1269
   312
	vote.client_list = client_vote;
dvander@1269
   313
dvander@1269
   314
	/* Sort the item list descending like we promised */
dvander@1269
   315
	qsort(item_vote,
dvander@1269
   316
		vote.num_items,
dvander@1269
   317
		sizeof(menu_vote_result_t::menu_item_vote_t),
dvander@1269
   318
		SortVoteItems);
dvander@1269
   319
dvander@1269
   320
	/* Save states, then clear what we've saved.
dvander@1269
   321
	 * This makes us re-entrant, which is always the safe way to go.
dvander@1269
   322
	 */
dvander@1269
   323
	IBaseMenu *menu = m_pCurMenu;
dvander@1269
   324
	IMenuHandler *handler = m_pHandler;
dvander@1269
   325
	InternalReset();
dvander@1269
   326
dvander@1269
   327
	/* Send vote info */
dvander@1269
   328
	handler->OnMenuVoteResults(menu, &vote);
dvander@1269
   329
	handler->OnMenuEnd(menu, MenuEnd_VotingDone);
dvander@1269
   330
}
dvander@1269
   331
dvander@1269
   332
void VoteMenuHandler::OnMenuStart(IBaseMenu *menu)
dvander@1269
   333
{
dvander@1269
   334
	m_Clients++;
dvander@1269
   335
}
dvander@1269
   336
dvander@1269
   337
void VoteMenuHandler::OnMenuEnd(IBaseMenu *menu, MenuEndReason reason)
dvander@1269
   338
{
dvander@1269
   339
	DecrementPlayerCount();
dvander@1269
   340
}
dvander@1269
   341
dvander@1269
   342
void VoteMenuHandler::OnMenuCancel(IBaseMenu *menu, int client, MenuCancelReason reason)
dvander@1269
   343
{
dvander@1269
   344
	m_pHandler->OnMenuCancel(menu, client, reason);
dvander@1269
   345
}
dvander@1269
   346
dvander@1269
   347
void VoteMenuHandler::OnMenuDisplay(IBaseMenu *menu, int client, IMenuPanel *display)
dvander@1269
   348
{
dvander@1269
   349
	m_ClientVotes[client] = -1;
dvander@1269
   350
	m_pHandler->OnMenuDisplay(menu, client, display);
dvander@1269
   351
}
dvander@1269
   352
dvander@1269
   353
unsigned int VoteMenuHandler::OnMenuDisplayItem(IBaseMenu *menu, int client, IMenuPanel *panel, unsigned int item, const ItemDrawInfo &dr)
dvander@1269
   354
{
dvander@1269
   355
	return m_pHandler->OnMenuDisplayItem(menu, client, panel, item, dr);
dvander@1269
   356
}
dvander@1269
   357
dvander@1269
   358
void VoteMenuHandler::OnMenuDrawItem(IBaseMenu *menu, int client, unsigned int item, unsigned int &style)
dvander@1269
   359
{
dvander@1269
   360
	m_pHandler->OnMenuDrawItem(menu, client, item, style);
dvander@1269
   361
}
dvander@1269
   362
dvander@1269
   363
void VoteMenuHandler::OnMenuSelect(IBaseMenu *menu, int client, unsigned int item)
dvander@1269
   364
{
dvander@1269
   365
	/* Check by our item count, NOT the vote array size */
dvander@1269
   366
	if (item < m_Items)
dvander@1269
   367
	{
dvander@1269
   368
		m_ClientVotes[client] = item;
dvander@1269
   369
		m_Votes[item]++;
dvander@1269
   370
		m_NumVotes++;
dvander@1269
   371
	}
dvander@1269
   372
dvander@1269
   373
	m_pHandler->OnMenuSelect(menu, client, item);
dvander@1269
   374
}
dvander@1269
   375
dvander@1474
   376
void VoteMenuHandler::OnMenuSelect2(IBaseMenu *menu, int client, unsigned int item, unsigned int item_on_page)
dvander@1474
   377
{
dvander@1474
   378
	if (m_pHandler->GetMenuAPIVersion2() >= 13)
dvander@1474
   379
	{
dvander@1474
   380
		m_pHandler->OnMenuSelect2(menu, client, item, item_on_page);
dvander@1474
   381
	}
dvander@1474
   382
}
dvander@1474
   383
dvander@1269
   384
void VoteMenuHandler::InternalReset()
dvander@1269
   385
{
dvander@1269
   386
	m_Clients = 0;
dvander@1269
   387
	m_Items = 0;
dvander@1269
   388
	m_bStarted = false;
dvander@1269
   389
	m_pCurMenu = NULL;
dvander@1269
   390
	m_NumVotes = 0;
dvander@1269
   391
	m_bCancelled = false;
dvander@1269
   392
	m_pHandler = NULL;
dvander@1269
   393
}
dvander@1269
   394
dvander@1269
   395
void VoteMenuHandler::CancelVoting()
dvander@1269
   396
{
dvander@1269
   397
	if (m_bCancelled || !m_pCurMenu)
dvander@1269
   398
	{
dvander@1269
   399
		return;
dvander@1269
   400
	}
dvander@1269
   401
	m_bCancelled = true;
dvander@1269
   402
	m_pCurMenu->Cancel();
dvander@1269
   403
}
dvander@1269
   404
dvander@1269
   405
IBaseMenu *VoteMenuHandler::GetCurrentMenu()
dvander@1269
   406
{
dvander@1269
   407
	return m_pCurMenu;
dvander@1269
   408
}
dvander@1269
   409
dvander@1269
   410
bool VoteMenuHandler::IsCancelling()
dvander@1269
   411
{
dvander@1269
   412
	return m_bCancelled;
dvander@1269
   413
}