core/MenuStyle_Valve.cpp
author David Anderson <dvander@alliedmods.net>
Fri Aug 03 11:40:21 2007 +0000 (2007-08-03)
changeset 1259 472c5e61cdc8
parent 1231 17badaf66ce4
child 1269 27397584df9c
permissions -rw-r--r--
implemented amb705 (you can now disable sounds per-menu)
dvander@769
     1
/**
dvander@769
     2
 * vim: set ts=4 :
dvander@1231
     3
 * ================================================================
dvander@1231
     4
 * SourceMod
dvander@1231
     5
 * Copyright (C) 2004-2007 AlliedModders LLC.  All rights reserved.
dvander@1231
     6
 * ================================================================
dvander@769
     7
 *
dvander@1231
     8
 * This program is free software; you can redistribute it and/or 
dvander@1231
     9
 * modify it under the terms of the GNU General Public License, 
dvander@1231
    10
 * version 3.0, as published by the Free Software Foundation.
dvander@1231
    11
 * 
dvander@1231
    12
 * This program is distributed in the hope that it will be useful,
dvander@1231
    13
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
dvander@1231
    14
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
dvander@1231
    15
 * GNU General Public License for more details.
dvander@1231
    16
 *
dvander@1231
    17
 * You should have received a copy of the GNU General Public License
dvander@1231
    18
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1231
    19
 *
dvander@1231
    20
 * As a special exception, AlliedModders LLC gives you permission to 
dvander@1231
    21
 * link the code of this program (as well as its derivative works) to 
dvander@1231
    22
 * "Half-Life 2," the "Source Engine," the "SourcePawn JIT," and any 
dvander@1231
    23
 * Game MODs that run on software by the Valve Corporation.  You must 
dvander@1231
    24
 * obey the GNU General Public License in all respects for all other 
dvander@1231
    25
 * code used. Additionally, AlliedModders LLC grants this exception 
dvander@1231
    26
 * to all derivative works. AlliedModders LLC defines further 
dvander@1231
    27
 * exceptions, found in LICENSE.txt (as of this writing, version 
dvander@1231
    28
 * JULY-31-2007), or <http://www.sourcemod.net/license.php>.
dvander@769
    29
 *
dvander@769
    30
 * Version: $Id$
dvander@769
    31
 */
dvander@769
    32
dvander@769
    33
#include "sm_stringutil.h"
dvander@769
    34
#include "PlayerManager.h"
dvander@769
    35
#include "MenuStyle_Valve.h"
dvander@769
    36
#include "Translator.h"
dvander@769
    37
#include "PlayerManager.h"
dvander@769
    38
#include "ConCmdManager.h"
dvander@769
    39
dvander@769
    40
SH_DECL_HOOK4_void(IServerPluginHelpers, CreateMessage, SH_NOATTRIB, false, edict_t *, DIALOG_TYPE, KeyValues *, IServerPluginCallbacks *);
dvander@769
    41
dvander@769
    42
ValveMenuStyle g_ValveMenuStyle;
dvander@778
    43
extern const char *g_OptionNumTable[];
dvander@778
    44
extern const char *g_OptionCmdTable[];
dvander@769
    45
IServerPluginCallbacks *g_pVSPHandle = NULL;
dvander@769
    46
CallClass<IServerPluginHelpers> *g_pSPHCC = NULL;
dvander@769
    47
dvander@775
    48
ValveMenuStyle::ValveMenuStyle() : m_players(new CValveMenuPlayer[256+1])
dvander@769
    49
{
dvander@769
    50
}
dvander@769
    51
dvander@775
    52
CBaseMenuPlayer *ValveMenuStyle::GetMenuPlayer(int client)
dvander@775
    53
{
dvander@775
    54
	return &m_players[client];
dvander@775
    55
}
dvander@775
    56
dvander@769
    57
bool ValveMenuStyle::OnClientCommand(int client)
dvander@769
    58
{
dvander@769
    59
	const char *cmd = engine->Cmd_Argv(0);
dvander@769
    60
dvander@769
    61
	if (strcmp(cmd, "sm_vmenuselect") == 0)
dvander@769
    62
	{
dvander@769
    63
		int key_press = atoi(engine->Cmd_Argv(1));
dvander@769
    64
		g_ValveMenuStyle.ClientPressedKey(client, key_press);
dvander@769
    65
		return true;
dvander@769
    66
	}
dvander@769
    67
dvander@769
    68
	return false;
dvander@769
    69
}
dvander@769
    70
dvander@769
    71
void ValveMenuStyle::OnSourceModAllInitialized()
dvander@769
    72
{
dvander@769
    73
	g_Players.AddClientListener(this);
dvander@769
    74
	SH_ADD_HOOK_MEMFUNC(IServerPluginHelpers, CreateMessage, serverpluginhelpers, this, &ValveMenuStyle::HookCreateMessage, false);
dvander@769
    75
	g_pSPHCC = SH_GET_CALLCLASS(serverpluginhelpers);
dvander@769
    76
}
dvander@769
    77
dvander@769
    78
void ValveMenuStyle::OnSourceModShutdown()
dvander@769
    79
{
dvander@769
    80
	SH_RELEASE_CALLCLASS(g_pSPHCC);
dvander@769
    81
	SH_REMOVE_HOOK_MEMFUNC(IServerPluginHelpers, CreateMessage, serverpluginhelpers, this, &ValveMenuStyle::HookCreateMessage, false);
dvander@769
    82
	g_Players.RemoveClientListener(this);
dvander@769
    83
}
dvander@769
    84
dvander@769
    85
void ValveMenuStyle::HookCreateMessage(edict_t *pEdict,
dvander@769
    86
									   DIALOG_TYPE type,
dvander@769
    87
									   KeyValues *kv,
dvander@769
    88
									   IServerPluginCallbacks *plugin)
dvander@769
    89
{
dvander@769
    90
	if (type != DIALOG_MENU)
dvander@769
    91
	{
dvander@769
    92
		return;
dvander@769
    93
	}
dvander@769
    94
dvander@769
    95
	int client = engine->IndexOfEdict(pEdict);
dvander@769
    96
	if (client < 1 || client > 256)
dvander@769
    97
	{
dvander@769
    98
		return;
dvander@769
    99
	}
dvander@769
   100
dvander@769
   101
	CValveMenuPlayer *player = &m_players[client];
dvander@769
   102
	
dvander@769
   103
	/* We don't care if the player is in a menu because, for all intents and purposes,
dvander@769
   104
	 * the menu is completely private.  Instead, we just figure out the level we'll need
dvander@769
   105
	 * in order to override it.
dvander@769
   106
	 */
dvander@769
   107
	player->curPrioLevel = kv->GetInt("level", player->curPrioLevel);
dvander@769
   108
dvander@769
   109
	/* Oh no! What happens if we got a menu that overwrites ours?! */
dvander@769
   110
	if (player->bInMenu)
dvander@769
   111
	{
dvander@769
   112
		/* Okay, let the external menu survive for now.  It may live another 
dvander@769
   113
		 * day to avenge its grandfather, killed in the great Menu Interruption
dvander@769
   114
		 * battle.
dvander@769
   115
		 */
dvander@1005
   116
		_CancelClientMenu(client, MenuCancel_Interrupted, true);
dvander@769
   117
	}
dvander@769
   118
}
dvander@769
   119
dvander@769
   120
void ValveMenuStyle::OnSourceModVSPReceived(IServerPluginCallbacks *iface)
dvander@769
   121
{
dvander@769
   122
	g_pVSPHandle = iface;
dvander@769
   123
}
dvander@769
   124
dvander@787
   125
IMenuPanel *ValveMenuStyle::CreatePanel()
dvander@769
   126
{
dvander@769
   127
	return new CValveMenuDisplay();
dvander@769
   128
}
dvander@769
   129
dvander@790
   130
IBaseMenu *ValveMenuStyle::CreateMenu(IMenuHandler *pHandler, IdentityToken_t *pOwner)
dvander@769
   131
{
dvander@790
   132
	return new CValveMenu(pHandler, pOwner);
dvander@769
   133
}
dvander@769
   134
dvander@769
   135
const char *ValveMenuStyle::GetStyleName()
dvander@769
   136
{
dvander@769
   137
	return "valve";
dvander@769
   138
}
dvander@769
   139
dvander@769
   140
unsigned int ValveMenuStyle::GetMaxPageItems()
dvander@769
   141
{
dvander@769
   142
	return 8;
dvander@769
   143
}
dvander@769
   144
dvander@787
   145
void ValveMenuStyle::SendDisplay(int client, IMenuPanel *display)
dvander@769
   146
{
dvander@775
   147
	m_players[client].curPrioLevel--;
dvander@775
   148
	CValveMenuDisplay *vDisplay = (CValveMenuDisplay *)display;
dvander@775
   149
	vDisplay->SendRawDisplay(client, m_players[client].curPrioLevel, m_players[client].menuHoldTime);
dvander@769
   150
}
dvander@769
   151
dvander@787
   152
bool ValveMenuStyle::DoClientMenu(int client, IMenuPanel *menu, IMenuHandler *mh, unsigned int time)
dvander@769
   153
{
dvander@775
   154
	if (!g_pVSPHandle)
dvander@769
   155
	{
dvander@769
   156
		return false;
dvander@769
   157
	}
dvander@769
   158
dvander@775
   159
	return BaseMenuStyle::DoClientMenu(client, menu, mh, time);
dvander@769
   160
}
dvander@769
   161
dvander@775
   162
bool ValveMenuStyle::DoClientMenu(int client, CBaseMenu *menu, IMenuHandler *mh, unsigned int time)
dvander@769
   163
{
dvander@775
   164
	if (!g_pVSPHandle)
dvander@769
   165
	{
dvander@775
   166
		mh->OnMenuStart(menu);
dvander@769
   167
		mh->OnMenuCancel(menu, client, MenuCancel_NoDisplay);
dvander@997
   168
		mh->OnMenuEnd(menu, MenuEnd_Cancelled);
dvander@769
   169
		return false;
dvander@769
   170
	}
dvander@769
   171
dvander@775
   172
	return BaseMenuStyle::DoClientMenu(client, menu, mh, time);
dvander@769
   173
}
dvander@769
   174
dvander@769
   175
CValveMenuDisplay::CValveMenuDisplay()
dvander@769
   176
{
dvander@769
   177
	m_pKv = NULL;
dvander@769
   178
	Reset();
dvander@769
   179
}
dvander@769
   180
dvander@769
   181
CValveMenuDisplay::CValveMenuDisplay(CValveMenu *pMenu)
dvander@769
   182
{
dvander@769
   183
	m_pKv = NULL;
dvander@769
   184
	Reset();
dvander@769
   185
	m_pKv->SetColor("color", pMenu->m_IntroColor);
dvander@769
   186
	m_pKv->SetString("title", pMenu->m_IntroMsg);
dvander@769
   187
}
dvander@769
   188
dvander@776
   189
void CValveMenuDisplay::DeleteThis()
dvander@776
   190
{
dvander@776
   191
	delete this;
dvander@776
   192
}
dvander@776
   193
dvander@769
   194
CValveMenuDisplay::~CValveMenuDisplay()
dvander@769
   195
{
dvander@769
   196
	m_pKv->deleteThis();
dvander@769
   197
}
dvander@769
   198
dvander@769
   199
IMenuStyle *CValveMenuDisplay::GetParentStyle()
dvander@769
   200
{
dvander@769
   201
	return &g_ValveMenuStyle;
dvander@769
   202
}
dvander@769
   203
dvander@769
   204
void CValveMenuDisplay::Reset()
dvander@769
   205
{
dvander@769
   206
	if (m_pKv)
dvander@769
   207
	{
dvander@769
   208
		m_pKv->deleteThis();
dvander@769
   209
	}
dvander@769
   210
	m_pKv = new KeyValues("menu");
dvander@769
   211
	m_NextPos = 1;
dvander@769
   212
	m_TitleDrawn = false;
dvander@769
   213
}
dvander@769
   214
dvander@840
   215
unsigned int CValveMenuDisplay::GetCurrentKey()
dvander@840
   216
{
dvander@840
   217
	return m_NextPos;
dvander@840
   218
}
dvander@840
   219
dvander@840
   220
bool CValveMenuDisplay::SetCurrentKey(unsigned int key)
dvander@840
   221
{
dvander@840
   222
	if (key < m_NextPos || key > 9)
dvander@840
   223
	{
dvander@840
   224
		return false;
dvander@840
   225
	}
dvander@840
   226
dvander@840
   227
	m_NextPos = key;
dvander@840
   228
dvander@840
   229
	return true;
dvander@840
   230
}
dvander@840
   231
dvander@769
   232
bool CValveMenuDisplay::SetExtOption(MenuOption option, const void *valuePtr)
dvander@769
   233
{
dvander@769
   234
	if (option == MenuOption_IntroMessage)
dvander@769
   235
	{
dvander@769
   236
		m_pKv->SetString("title", (const char *)valuePtr);
dvander@769
   237
		return true;
dvander@769
   238
	} else if (option == MenuOption_IntroColor) {
dvander@769
   239
		int *array = (int *)valuePtr;
dvander@769
   240
		m_pKv->SetColor("color", Color(array[0], array[1], array[2], array[3]));
dvander@769
   241
		return true;
dvander@775
   242
	} else if (option == MenuOption_Priority) {
dvander@775
   243
		m_pKv->SetInt("level", *(int *)valuePtr);
dvander@775
   244
		return true;
dvander@769
   245
	}
dvander@769
   246
dvander@769
   247
	return false;
dvander@769
   248
}
dvander@769
   249
dvander@769
   250
bool CValveMenuDisplay::CanDrawItem(unsigned int drawFlags)
dvander@769
   251
{
dvander@769
   252
	/**
dvander@769
   253
	 * ITEMDRAW_RAWLINE - We can't draw random text, and this doesn't add a slot,
dvander@769
   254
	 *  so it's completely safe to ignore it.
dvander@769
   255
	 * -----------------------------------------
dvander@769
   256
	 */
dvander@769
   257
	if (drawFlags & ITEMDRAW_RAWLINE)
dvander@769
   258
	{
dvander@769
   259
		return false;
dvander@769
   260
	}
dvander@769
   261
dvander@769
   262
	/**
dvander@769
   263
	 * Special cases, explained in DrawItem()
dvander@769
   264
	 */
dvander@769
   265
	if ((drawFlags & ITEMDRAW_NOTEXT)
dvander@769
   266
		|| (drawFlags & ITEMDRAW_SPACER))
dvander@769
   267
	{
dvander@769
   268
		return true;
dvander@769
   269
	}
dvander@769
   270
dvander@769
   271
	/**
dvander@769
   272
	 * We can't draw disabled text.  We could bump the position, but we
dvander@769
   273
	 * want DirectDraw() to find some actual items to display.
dvander@769
   274
	 */
dvander@769
   275
	if (drawFlags & ITEMDRAW_DISABLED)
dvander@769
   276
	{
dvander@769
   277
		return false;
dvander@769
   278
	}
dvander@769
   279
dvander@769
   280
	return true;
dvander@769
   281
}
dvander@769
   282
dvander@769
   283
unsigned int CValveMenuDisplay::DrawItem(const ItemDrawInfo &item)
dvander@769
   284
{
dvander@769
   285
	if (m_NextPos > 9 || !CanDrawItem(item.style))
dvander@769
   286
	{
dvander@769
   287
		return 0;
dvander@769
   288
	}
dvander@769
   289
dvander@769
   290
	/**
dvander@769
   291
	 * For these cases we can't draw anything at all, but
dvander@769
   292
	 * we can at least bump the position since we were explicitly asked to.
dvander@769
   293
	 */
dvander@769
   294
	if ((item.style & ITEMDRAW_NOTEXT)
dvander@769
   295
		|| (item.style & ITEMDRAW_SPACER))
dvander@769
   296
	{
dvander@769
   297
		return m_NextPos++;
dvander@769
   298
	}
dvander@769
   299
dvander@769
   300
	char buffer[255];
dvander@769
   301
	UTIL_Format(buffer, sizeof(buffer), "%d. %s", m_NextPos, item.display);
dvander@769
   302
dvander@769
   303
	KeyValues *ki = m_pKv->FindKey(g_OptionNumTable[m_NextPos], true);
dvander@769
   304
	ki->SetString("command", g_OptionCmdTable[m_NextPos]);
dvander@769
   305
	ki->SetString("msg", buffer);
dvander@769
   306
dvander@769
   307
	return m_NextPos++;
dvander@769
   308
}
dvander@769
   309
dvander@769
   310
void CValveMenuDisplay::DrawTitle(const char *text, bool onlyIfEmpty/* =false */)
dvander@769
   311
{
dvander@769
   312
	if (onlyIfEmpty && m_TitleDrawn)
dvander@769
   313
	{
dvander@769
   314
		return;
dvander@769
   315
	}
dvander@769
   316
dvander@769
   317
	m_pKv->SetString("msg", text);
dvander@769
   318
	m_TitleDrawn = true;
dvander@769
   319
}
dvander@769
   320
dvander@769
   321
bool CValveMenuDisplay::DrawRawLine(const char *rawline)
dvander@769
   322
{
dvander@769
   323
	return false;
dvander@769
   324
}
dvander@769
   325
dvander@769
   326
void CValveMenuDisplay::SendRawDisplay(int client, int priority, unsigned int time)
dvander@769
   327
{
dvander@769
   328
	m_pKv->SetInt("level", priority);
dvander@775
   329
	m_pKv->SetInt("time", time ? time : 200);
dvander@769
   330
dvander@769
   331
	SH_CALL(g_pSPHCC, &IServerPluginHelpers::CreateMessage)(
dvander@769
   332
		engine->PEntityOfEntIndex(client),
dvander@769
   333
		DIALOG_MENU,
dvander@769
   334
		m_pKv,
dvander@769
   335
		g_pVSPHandle);
dvander@769
   336
}
dvander@769
   337
dvander@769
   338
bool CValveMenuDisplay::SendDisplay(int client, IMenuHandler *handler, unsigned int time)
dvander@769
   339
{
dvander@769
   340
	return g_ValveMenuStyle.DoClientMenu(client, this, handler, time);
dvander@769
   341
}
dvander@769
   342
dvander@819
   343
bool CValveMenuDisplay::SetSelectableKeys(unsigned int keymap)
dvander@819
   344
{
dvander@819
   345
	return false;
dvander@819
   346
}
dvander@819
   347
dvander@790
   348
CValveMenu::CValveMenu(IMenuHandler *pHandler, IdentityToken_t *pOwner) : 
dvander@790
   349
CBaseMenu(pHandler, &g_ValveMenuStyle, pOwner), 
dvander@775
   350
	m_IntroColor(255, 0, 0, 255)
dvander@769
   351
{
dvander@769
   352
	strcpy(m_IntroMsg, "You have a menu, press ESC");
dvander@769
   353
	m_Pagination = 5;
dvander@769
   354
}
dvander@769
   355
dvander@775
   356
void CValveMenu::Cancel_Finally()
dvander@769
   357
{
dvander@769
   358
	g_ValveMenuStyle.CancelMenu(this);
dvander@769
   359
}
dvander@769
   360
dvander@769
   361
bool CValveMenu::SetPagination(unsigned int itemsPerPage)
dvander@769
   362
{
dvander@820
   363
	if (itemsPerPage > 5)
dvander@769
   364
	{
dvander@769
   365
		return false;
dvander@769
   366
	}
dvander@769
   367
dvander@820
   368
	return CBaseMenu::SetPagination(itemsPerPage);
dvander@769
   369
}
dvander@769
   370
dvander@769
   371
bool CValveMenu::SetExtOption(MenuOption option, const void *valuePtr)
dvander@769
   372
{
dvander@769
   373
	if (option == MenuOption_IntroMessage)
dvander@769
   374
	{
dvander@769
   375
		strncopy(m_IntroMsg, (const char *)valuePtr, sizeof(m_IntroMsg));
dvander@769
   376
		return true;
dvander@769
   377
	} else if (option == MenuOption_IntroColor) {
dvander@769
   378
		unsigned int *array = (unsigned int *)valuePtr;
dvander@769
   379
		m_IntroColor = Color(array[0], array[1], array[2], array[3]);
dvander@769
   380
		return true;
dvander@769
   381
	}
dvander@769
   382
dvander@769
   383
	return false;
dvander@769
   384
}
dvander@769
   385
dvander@790
   386
bool CValveMenu::Display(int client, unsigned int time)
dvander@769
   387
{
dvander@769
   388
	if (m_bCancelling)
dvander@769
   389
	{
dvander@769
   390
		return false;
dvander@769
   391
	}
dvander@769
   392
dvander@790
   393
	return g_ValveMenuStyle.DoClientMenu(client, this, m_pHandler, time);
dvander@769
   394
}
dvander@769
   395
dvander@877
   396
void CValveMenu::VoteDisplay(int client, unsigned int maxTime)
dvander@877
   397
{
dvander@877
   398
	if (m_bCancelling)
dvander@877
   399
	{
dvander@877
   400
		return;
dvander@877
   401
	}
dvander@877
   402
dvander@877
   403
	g_ValveMenuStyle.DoClientMenu(client, this, m_pVoteHandler, maxTime);
dvander@877
   404
}
dvander@877
   405
dvander@787
   406
IMenuPanel *CValveMenu::CreatePanel()
dvander@769
   407
{
dvander@769
   408
	return new CValveMenuDisplay(this);
dvander@769
   409
}
dvander@769
   410
dvander@769
   411
bool CValveMenu::GetExitButton()
dvander@769
   412
{
dvander@769
   413
	return true;
dvander@769
   414
}
dvander@769
   415
dvander@769
   416
bool CValveMenu::SetExitButton(bool set)
dvander@769
   417
{
dvander@769
   418
	return false;
dvander@769
   419
}
dvander@769
   420
dvander@1259
   421
void CValveMenu::SetMenuOptionFlags(unsigned int flags)
dvander@1259
   422
{
dvander@1259
   423
	flags &= ~MENUFLAG_BUTTON_EXIT;
dvander@1259
   424
	CBaseMenu::SetMenuOptionFlags(flags);
dvander@1259
   425
}
dvander@1259
   426
dvander@778
   427
const char *g_OptionNumTable[] = 
dvander@769
   428
{
dvander@769
   429
	"0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10"
dvander@769
   430
};
dvander@769
   431
dvander@778
   432
const char *g_OptionCmdTable[] = 
dvander@769
   433
{
dvander@769
   434
	"sm_vmenuselect 0", /* INVALID! */
dvander@769
   435
	"sm_vmenuselect 1",
dvander@769
   436
	"sm_vmenuselect 2",
dvander@769
   437
	"sm_vmenuselect 3",
dvander@769
   438
	"sm_vmenuselect 4",
dvander@769
   439
	"sm_vmenuselect 5",
dvander@769
   440
	"sm_vmenuselect 6",
dvander@769
   441
	"sm_vmenuselect 7",
dvander@769
   442
	"sm_vmenuselect 8",
dvander@769
   443
	"sm_vmenuselect 9",
dvander@769
   444
	"sm_vmenuselect 10"
dvander@769
   445
};