core/MenuStyle_Valve.cpp
author Nicholas Hastings <skamonkey@gmail.com>
Sat Sep 10 12:08:38 2011 -0400 (2011-09-10)
changeset 3389 68d3e56f4bb7
parent 3004 e3ac0dc6d9a4
child 3819 d17aed3d46bf
permissions -rw-r--r--
Added CheckAccess native to check cmd/override access of AdminId (bug 5083, r=fyren).
dvander@769
     1
/**
dvander@769
     2
 * vim: set ts=4 :
ds@1330
     3
 * =============================================================================
dvander@1231
     4
 * SourceMod
ds@1947
     5
 * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
ds@1330
     6
 * =============================================================================
dvander@769
     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>.
dvander@769
    28
 *
dvander@769
    29
 * Version: $Id$
dvander@769
    30
 */
dvander@769
    31
dvander@769
    32
#include "sm_stringutil.h"
dvander@769
    33
#include "PlayerManager.h"
dvander@769
    34
#include "MenuStyle_Valve.h"
dvander@769
    35
#include "PlayerManager.h"
dvander@769
    36
#include "ConCmdManager.h"
dvander@769
    37
dvander@769
    38
SH_DECL_HOOK4_void(IServerPluginHelpers, CreateMessage, SH_NOATTRIB, false, edict_t *, DIALOG_TYPE, KeyValues *, IServerPluginCallbacks *);
dvander@769
    39
dvander@769
    40
ValveMenuStyle g_ValveMenuStyle;
dvander@778
    41
extern const char *g_OptionNumTable[];
dvander@778
    42
extern const char *g_OptionCmdTable[];
dvander@769
    43
CallClass<IServerPluginHelpers> *g_pSPHCC = NULL;
dvander@769
    44
dvander@775
    45
ValveMenuStyle::ValveMenuStyle() : m_players(new CValveMenuPlayer[256+1])
dvander@769
    46
{
dvander@769
    47
}
dvander@769
    48
dvander@775
    49
CBaseMenuPlayer *ValveMenuStyle::GetMenuPlayer(int client)
dvander@775
    50
{
dvander@775
    51
	return &m_players[client];
dvander@775
    52
}
dvander@775
    53
faluco@1541
    54
bool ValveMenuStyle::OnClientCommand(int client, const char *cmdname, const CCommand &cmd)
dvander@769
    55
{
faluco@1541
    56
	if (strcmp(cmdname, "sm_vmenuselect") == 0)
dvander@769
    57
	{
faluco@1541
    58
		int key_press = atoi(cmd.Arg(1));
dvander@769
    59
		g_ValveMenuStyle.ClientPressedKey(client, key_press);
dvander@769
    60
		return true;
dvander@769
    61
	}
dvander@769
    62
dvander@769
    63
	return false;
dvander@769
    64
}
dvander@769
    65
dvander@769
    66
void ValveMenuStyle::OnSourceModAllInitialized()
dvander@769
    67
{
dvander@769
    68
	g_Players.AddClientListener(this);
dvander@769
    69
	SH_ADD_HOOK_MEMFUNC(IServerPluginHelpers, CreateMessage, serverpluginhelpers, this, &ValveMenuStyle::HookCreateMessage, false);
dvander@769
    70
	g_pSPHCC = SH_GET_CALLCLASS(serverpluginhelpers);
dvander@769
    71
}
dvander@769
    72
dvander@769
    73
void ValveMenuStyle::OnSourceModShutdown()
dvander@769
    74
{
dvander@769
    75
	SH_RELEASE_CALLCLASS(g_pSPHCC);
dvander@769
    76
	SH_REMOVE_HOOK_MEMFUNC(IServerPluginHelpers, CreateMessage, serverpluginhelpers, this, &ValveMenuStyle::HookCreateMessage, false);
dvander@769
    77
	g_Players.RemoveClientListener(this);
dvander@769
    78
}
dvander@769
    79
dvander@769
    80
void ValveMenuStyle::HookCreateMessage(edict_t *pEdict,
dvander@769
    81
									   DIALOG_TYPE type,
dvander@769
    82
									   KeyValues *kv,
dvander@769
    83
									   IServerPluginCallbacks *plugin)
dvander@769
    84
{
dvander@769
    85
	if (type != DIALOG_MENU)
dvander@769
    86
	{
dvander@769
    87
		return;
dvander@769
    88
	}
dvander@769
    89
ds@2400
    90
	int client = IndexOfEdict(pEdict);
dvander@769
    91
	if (client < 1 || client > 256)
dvander@769
    92
	{
dvander@769
    93
		return;
dvander@769
    94
	}
dvander@769
    95
dvander@769
    96
	CValveMenuPlayer *player = &m_players[client];
dvander@769
    97
	
dvander@769
    98
	/* We don't care if the player is in a menu because, for all intents and purposes,
dvander@769
    99
	 * the menu is completely private.  Instead, we just figure out the level we'll need
dvander@769
   100
	 * in order to override it.
dvander@769
   101
	 */
dvander@769
   102
	player->curPrioLevel = kv->GetInt("level", player->curPrioLevel);
dvander@769
   103
dvander@769
   104
	/* Oh no! What happens if we got a menu that overwrites ours?! */
dvander@769
   105
	if (player->bInMenu)
dvander@769
   106
	{
dvander@769
   107
		/* Okay, let the external menu survive for now.  It may live another 
dvander@769
   108
		 * day to avenge its grandfather, killed in the great Menu Interruption
dvander@769
   109
		 * battle.
dvander@769
   110
		 */
dvander@1005
   111
		_CancelClientMenu(client, MenuCancel_Interrupted, true);
dvander@769
   112
	}
dvander@769
   113
}
dvander@769
   114
dvander@787
   115
IMenuPanel *ValveMenuStyle::CreatePanel()
dvander@769
   116
{
dvander@769
   117
	return new CValveMenuDisplay();
dvander@769
   118
}
dvander@769
   119
dvander@790
   120
IBaseMenu *ValveMenuStyle::CreateMenu(IMenuHandler *pHandler, IdentityToken_t *pOwner)
dvander@769
   121
{
dvander@790
   122
	return new CValveMenu(pHandler, pOwner);
dvander@769
   123
}
dvander@769
   124
dvander@769
   125
const char *ValveMenuStyle::GetStyleName()
dvander@769
   126
{
dvander@769
   127
	return "valve";
dvander@769
   128
}
dvander@769
   129
dvander@769
   130
unsigned int ValveMenuStyle::GetMaxPageItems()
dvander@769
   131
{
dvander@769
   132
	return 8;
dvander@769
   133
}
dvander@769
   134
dvander@787
   135
void ValveMenuStyle::SendDisplay(int client, IMenuPanel *display)
dvander@769
   136
{
dvander@775
   137
	m_players[client].curPrioLevel--;
dvander@775
   138
	CValveMenuDisplay *vDisplay = (CValveMenuDisplay *)display;
dvander@775
   139
	vDisplay->SendRawDisplay(client, m_players[client].curPrioLevel, m_players[client].menuHoldTime);
dvander@769
   140
}
dvander@769
   141
dvander@787
   142
bool ValveMenuStyle::DoClientMenu(int client, IMenuPanel *menu, IMenuHandler *mh, unsigned int time)
dvander@769
   143
{
dvander@1605
   144
	if (vsp_interface == NULL)
dvander@769
   145
	{
dvander@769
   146
		return false;
dvander@769
   147
	}
dvander@769
   148
dvander@775
   149
	return BaseMenuStyle::DoClientMenu(client, menu, mh, time);
dvander@769
   150
}
dvander@769
   151
dvander@1474
   152
bool ValveMenuStyle::DoClientMenu(int client, CBaseMenu *menu, unsigned int first_item, IMenuHandler *mh, unsigned int time)
dvander@769
   153
{
dvander@1605
   154
	if (vsp_interface == NULL)
dvander@769
   155
	{
dvander@775
   156
		mh->OnMenuStart(menu);
dvander@769
   157
		mh->OnMenuCancel(menu, client, MenuCancel_NoDisplay);
dvander@997
   158
		mh->OnMenuEnd(menu, MenuEnd_Cancelled);
dvander@769
   159
		return false;
dvander@769
   160
	}
dvander@769
   161
dvander@1474
   162
	return BaseMenuStyle::DoClientMenu(client, menu, first_item, mh, time);
dvander@769
   163
}
dvander@769
   164
dvander@1766
   165
unsigned int ValveMenuStyle::GetApproxMemUsage()
dvander@1766
   166
{
dvander@1766
   167
	return sizeof(ValveMenuStyle) + (sizeof(CValveMenuPlayer) * 257);
dvander@1766
   168
}
dvander@1766
   169
dvander@769
   170
CValveMenuDisplay::CValveMenuDisplay()
dvander@769
   171
{
dvander@769
   172
	m_pKv = NULL;
dvander@769
   173
	Reset();
dvander@769
   174
}
dvander@769
   175
dvander@769
   176
CValveMenuDisplay::CValveMenuDisplay(CValveMenu *pMenu)
dvander@769
   177
{
dvander@769
   178
	m_pKv = NULL;
dvander@769
   179
	Reset();
dvander@769
   180
	m_pKv->SetColor("color", pMenu->m_IntroColor);
dvander@769
   181
	m_pKv->SetString("title", pMenu->m_IntroMsg);
dvander@769
   182
}
dvander@769
   183
dvander@776
   184
void CValveMenuDisplay::DeleteThis()
dvander@776
   185
{
dvander@776
   186
	delete this;
dvander@776
   187
}
dvander@776
   188
dvander@769
   189
CValveMenuDisplay::~CValveMenuDisplay()
dvander@769
   190
{
dvander@769
   191
	m_pKv->deleteThis();
dvander@769
   192
}
dvander@769
   193
dvander@769
   194
IMenuStyle *CValveMenuDisplay::GetParentStyle()
dvander@769
   195
{
dvander@769
   196
	return &g_ValveMenuStyle;
dvander@769
   197
}
dvander@769
   198
dvander@769
   199
void CValveMenuDisplay::Reset()
dvander@769
   200
{
dvander@769
   201
	if (m_pKv)
dvander@769
   202
	{
dvander@769
   203
		m_pKv->deleteThis();
dvander@769
   204
	}
dvander@769
   205
	m_pKv = new KeyValues("menu");
dvander@769
   206
	m_NextPos = 1;
dvander@769
   207
	m_TitleDrawn = false;
dvander@769
   208
}
dvander@769
   209
dvander@840
   210
unsigned int CValveMenuDisplay::GetCurrentKey()
dvander@840
   211
{
dvander@840
   212
	return m_NextPos;
dvander@840
   213
}
dvander@840
   214
dvander@840
   215
bool CValveMenuDisplay::SetCurrentKey(unsigned int key)
dvander@840
   216
{
dvander@840
   217
	if (key < m_NextPos || key > 9)
dvander@840
   218
	{
dvander@840
   219
		return false;
dvander@840
   220
	}
dvander@840
   221
dvander@840
   222
	m_NextPos = key;
dvander@840
   223
dvander@840
   224
	return true;
dvander@840
   225
}
dvander@840
   226
dvander@769
   227
bool CValveMenuDisplay::SetExtOption(MenuOption option, const void *valuePtr)
dvander@769
   228
{
dvander@769
   229
	if (option == MenuOption_IntroMessage)
dvander@769
   230
	{
dvander@769
   231
		m_pKv->SetString("title", (const char *)valuePtr);
dvander@769
   232
		return true;
dvander@769
   233
	} else if (option == MenuOption_IntroColor) {
dvander@769
   234
		int *array = (int *)valuePtr;
dvander@769
   235
		m_pKv->SetColor("color", Color(array[0], array[1], array[2], array[3]));
dvander@769
   236
		return true;
dvander@775
   237
	} else if (option == MenuOption_Priority) {
dvander@775
   238
		m_pKv->SetInt("level", *(int *)valuePtr);
dvander@775
   239
		return true;
dvander@769
   240
	}
dvander@769
   241
dvander@769
   242
	return false;
dvander@769
   243
}
dvander@769
   244
dvander@769
   245
bool CValveMenuDisplay::CanDrawItem(unsigned int drawFlags)
dvander@769
   246
{
dvander@769
   247
	/**
dvander@769
   248
	 * ITEMDRAW_RAWLINE - We can't draw random text, and this doesn't add a slot,
dvander@769
   249
	 *  so it's completely safe to ignore it.
dvander@769
   250
	 * -----------------------------------------
dvander@769
   251
	 */
dvander@769
   252
	if (drawFlags & ITEMDRAW_RAWLINE)
dvander@769
   253
	{
dvander@769
   254
		return false;
dvander@769
   255
	}
dvander@769
   256
dvander@769
   257
	/**
dvander@769
   258
	 * Special cases, explained in DrawItem()
dvander@769
   259
	 */
dvander@769
   260
	if ((drawFlags & ITEMDRAW_NOTEXT)
dvander@769
   261
		|| (drawFlags & ITEMDRAW_SPACER))
dvander@769
   262
	{
dvander@769
   263
		return true;
dvander@769
   264
	}
dvander@769
   265
dvander@769
   266
	/**
dvander@769
   267
	 * We can't draw disabled text.  We could bump the position, but we
dvander@769
   268
	 * want DirectDraw() to find some actual items to display.
dvander@769
   269
	 */
dvander@769
   270
	if (drawFlags & ITEMDRAW_DISABLED)
dvander@769
   271
	{
dvander@769
   272
		return false;
dvander@769
   273
	}
dvander@769
   274
dvander@769
   275
	return true;
dvander@769
   276
}
dvander@769
   277
dvander@769
   278
unsigned int CValveMenuDisplay::DrawItem(const ItemDrawInfo &item)
dvander@769
   279
{
dvander@769
   280
	if (m_NextPos > 9 || !CanDrawItem(item.style))
dvander@769
   281
	{
dvander@769
   282
		return 0;
dvander@769
   283
	}
dvander@769
   284
dvander@769
   285
	/**
dvander@769
   286
	 * For these cases we can't draw anything at all, but
dvander@769
   287
	 * we can at least bump the position since we were explicitly asked to.
dvander@769
   288
	 */
dvander@769
   289
	if ((item.style & ITEMDRAW_NOTEXT)
dvander@769
   290
		|| (item.style & ITEMDRAW_SPACER))
dvander@769
   291
	{
dvander@769
   292
		return m_NextPos++;
dvander@769
   293
	}
dvander@769
   294
dvander@769
   295
	char buffer[255];
dvander@769
   296
	UTIL_Format(buffer, sizeof(buffer), "%d. %s", m_NextPos, item.display);
dvander@769
   297
dvander@769
   298
	KeyValues *ki = m_pKv->FindKey(g_OptionNumTable[m_NextPos], true);
dvander@769
   299
	ki->SetString("command", g_OptionCmdTable[m_NextPos]);
dvander@769
   300
	ki->SetString("msg", buffer);
dvander@769
   301
dvander@769
   302
	return m_NextPos++;
dvander@769
   303
}
dvander@769
   304
dvander@769
   305
void CValveMenuDisplay::DrawTitle(const char *text, bool onlyIfEmpty/* =false */)
dvander@769
   306
{
dvander@769
   307
	if (onlyIfEmpty && m_TitleDrawn)
dvander@769
   308
	{
dvander@769
   309
		return;
dvander@769
   310
	}
dvander@769
   311
dvander@769
   312
	m_pKv->SetString("msg", text);
dvander@769
   313
	m_TitleDrawn = true;
dvander@769
   314
}
dvander@769
   315
dvander@769
   316
bool CValveMenuDisplay::DrawRawLine(const char *rawline)
dvander@769
   317
{
dvander@769
   318
	return false;
dvander@769
   319
}
dvander@769
   320
dvander@769
   321
void CValveMenuDisplay::SendRawDisplay(int client, int priority, unsigned int time)
dvander@769
   322
{
dvander@769
   323
	m_pKv->SetInt("level", priority);
dvander@775
   324
	m_pKv->SetInt("time", time ? time : 200);
dvander@769
   325
dvander@769
   326
	SH_CALL(g_pSPHCC, &IServerPluginHelpers::CreateMessage)(
ds@2400
   327
		PEntityOfEntIndex(client),
dvander@769
   328
		DIALOG_MENU,
dvander@769
   329
		m_pKv,
dvander@1605
   330
		vsp_interface);
dvander@769
   331
}
dvander@769
   332
dvander@769
   333
bool CValveMenuDisplay::SendDisplay(int client, IMenuHandler *handler, unsigned int time)
dvander@769
   334
{
dvander@769
   335
	return g_ValveMenuStyle.DoClientMenu(client, this, handler, time);
dvander@769
   336
}
dvander@769
   337
dvander@819
   338
bool CValveMenuDisplay::SetSelectableKeys(unsigned int keymap)
dvander@819
   339
{
dvander@819
   340
	return false;
dvander@819
   341
}
dvander@819
   342
dvander@1361
   343
int CValveMenuDisplay::GetAmountRemaining()
dvander@1361
   344
{
dvander@1361
   345
	/* :TODO: this is a lie, but nothing really seems meaningful... */
dvander@1361
   346
	return -1;
dvander@1361
   347
}
dvander@1361
   348
dvander@1766
   349
unsigned int CValveMenuDisplay::GetApproxMemUsage()
dvander@1766
   350
{
dvander@1766
   351
	return sizeof(CValveMenuDisplay) + (sizeof(KeyValues) * m_NextPos * 10);
dvander@1766
   352
}
dvander@1766
   353
dvander@790
   354
CValveMenu::CValveMenu(IMenuHandler *pHandler, IdentityToken_t *pOwner) : 
dvander@790
   355
CBaseMenu(pHandler, &g_ValveMenuStyle, pOwner), 
dvander@775
   356
	m_IntroColor(255, 0, 0, 255)
dvander@769
   357
{
dvander@769
   358
	strcpy(m_IntroMsg, "You have a menu, press ESC");
dvander@769
   359
	m_Pagination = 5;
dvander@769
   360
}
dvander@769
   361
dvander@775
   362
void CValveMenu::Cancel_Finally()
dvander@769
   363
{
dvander@769
   364
	g_ValveMenuStyle.CancelMenu(this);
dvander@769
   365
}
dvander@769
   366
dvander@769
   367
bool CValveMenu::SetPagination(unsigned int itemsPerPage)
dvander@769
   368
{
dvander@820
   369
	if (itemsPerPage > 5)
dvander@769
   370
	{
dvander@769
   371
		return false;
dvander@769
   372
	}
dvander@769
   373
dvander@820
   374
	return CBaseMenu::SetPagination(itemsPerPage);
dvander@769
   375
}
dvander@769
   376
dvander@769
   377
bool CValveMenu::SetExtOption(MenuOption option, const void *valuePtr)
dvander@769
   378
{
dvander@769
   379
	if (option == MenuOption_IntroMessage)
dvander@769
   380
	{
dvander@769
   381
		strncopy(m_IntroMsg, (const char *)valuePtr, sizeof(m_IntroMsg));
dvander@769
   382
		return true;
dvander@769
   383
	} else if (option == MenuOption_IntroColor) {
dvander@769
   384
		unsigned int *array = (unsigned int *)valuePtr;
dvander@769
   385
		m_IntroColor = Color(array[0], array[1], array[2], array[3]);
dvander@769
   386
		return true;
dvander@769
   387
	}
dvander@769
   388
dvander@769
   389
	return false;
dvander@769
   390
}
dvander@769
   391
dvander@1269
   392
bool CValveMenu::Display(int client, unsigned int time, IMenuHandler *alt_handler)
dvander@769
   393
{
dvander@1474
   394
	return DisplayAtItem(client, time, 0, alt_handler);
dvander@1474
   395
}
dvander@1474
   396
dvander@1474
   397
bool CValveMenu::DisplayAtItem(int client,
dvander@1474
   398
							   unsigned int time,
dvander@1474
   399
							   unsigned int start_item,
dvander@1474
   400
							   IMenuHandler *alt_handler/* =NULL */)
dvander@1474
   401
{
dvander@769
   402
	if (m_bCancelling)
dvander@769
   403
	{
dvander@769
   404
		return false;
dvander@769
   405
	}
dvander@769
   406
dvander@1474
   407
	return g_ValveMenuStyle.DoClientMenu(client, this, start_item, alt_handler ? alt_handler : m_pHandler, time);
dvander@877
   408
}
dvander@877
   409
dvander@787
   410
IMenuPanel *CValveMenu::CreatePanel()
dvander@769
   411
{
dvander@769
   412
	return new CValveMenuDisplay(this);
dvander@769
   413
}
dvander@769
   414
dvander@1259
   415
void CValveMenu::SetMenuOptionFlags(unsigned int flags)
dvander@1259
   416
{
dvander@1269
   417
	flags |= MENUFLAG_BUTTON_EXIT;
dvander@1259
   418
	CBaseMenu::SetMenuOptionFlags(flags);
dvander@1259
   419
}
dvander@1259
   420
dvander@1766
   421
unsigned int CValveMenu::GetApproxMemUsage()
dvander@1766
   422
{
dvander@1766
   423
	return sizeof(CValveMenu) + GetBaseMemUsage();
dvander@1766
   424
}
dvander@1766
   425
dvander@778
   426
const char *g_OptionNumTable[] = 
dvander@769
   427
{
dvander@769
   428
	"0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10"
dvander@769
   429
};
dvander@769
   430
dvander@778
   431
const char *g_OptionCmdTable[] = 
dvander@769
   432
{
dvander@769
   433
	"sm_vmenuselect 0", /* INVALID! */
dvander@769
   434
	"sm_vmenuselect 1",
dvander@769
   435
	"sm_vmenuselect 2",
dvander@769
   436
	"sm_vmenuselect 3",
dvander@769
   437
	"sm_vmenuselect 4",
dvander@769
   438
	"sm_vmenuselect 5",
dvander@769
   439
	"sm_vmenuselect 6",
dvander@769
   440
	"sm_vmenuselect 7",
dvander@769
   441
	"sm_vmenuselect 8",
dvander@769
   442
	"sm_vmenuselect 9",
dvander@769
   443
	"sm_vmenuselect 10"
dvander@769
   444
};