core/MenuStyle_Valve.cpp
author David Anderson <dvander@alliedmods.net>
Sun May 13 17:12:16 2007 +0000 (2007-05-13)
changeset 785 bca431afd754
parent 778 07e49a8cf046
child 787 52283fe61d42
permissions -rw-r--r--
finished radio menus
added a new item flag so radio menus could ignore disabled control items due to a bug where 0 is always white in Valve menus
fixed a bug where ClientPressedKey() did not account for the max page items in a style
fixed some pagination drawing bugs with control items
dvander@769
     1
/**
dvander@769
     2
 * vim: set ts=4 :
dvander@769
     3
 * ===============================================================
dvander@769
     4
 * SourceMod (C)2004-2007 AlliedModders LLC.  All rights reserved.
dvander@769
     5
 * ===============================================================
dvander@769
     6
 *
dvander@769
     7
 * This file is not open source and may not be copied without explicit
dvander@769
     8
 * written permission of AlliedModders LLC.  This file may not be redistributed 
dvander@769
     9
 * in whole or significant part.
dvander@769
    10
 * For information, see LICENSE.txt or http://www.sourcemod.net/license.php
dvander@769
    11
 *
dvander@769
    12
 * Version: $Id$
dvander@769
    13
 */
dvander@769
    14
dvander@769
    15
#include "sm_stringutil.h"
dvander@769
    16
#include "PlayerManager.h"
dvander@769
    17
#include "MenuStyle_Valve.h"
dvander@769
    18
#include "Translator.h"
dvander@769
    19
#include "PlayerManager.h"
dvander@769
    20
#include "ConCmdManager.h"
dvander@769
    21
dvander@769
    22
SH_DECL_HOOK4_void(IServerPluginHelpers, CreateMessage, SH_NOATTRIB, false, edict_t *, DIALOG_TYPE, KeyValues *, IServerPluginCallbacks *);
dvander@769
    23
dvander@769
    24
ValveMenuStyle g_ValveMenuStyle;
dvander@778
    25
extern const char *g_OptionNumTable[];
dvander@778
    26
extern const char *g_OptionCmdTable[];
dvander@769
    27
IServerPluginCallbacks *g_pVSPHandle = NULL;
dvander@769
    28
CallClass<IServerPluginHelpers> *g_pSPHCC = NULL;
dvander@769
    29
dvander@775
    30
ValveMenuStyle::ValveMenuStyle() : m_players(new CValveMenuPlayer[256+1])
dvander@769
    31
{
dvander@769
    32
}
dvander@769
    33
dvander@775
    34
CBaseMenuPlayer *ValveMenuStyle::GetMenuPlayer(int client)
dvander@775
    35
{
dvander@775
    36
	return &m_players[client];
dvander@775
    37
}
dvander@775
    38
dvander@769
    39
bool ValveMenuStyle::OnClientCommand(int client)
dvander@769
    40
{
dvander@769
    41
	const char *cmd = engine->Cmd_Argv(0);
dvander@769
    42
dvander@769
    43
	if (strcmp(cmd, "sm_vmenuselect") == 0)
dvander@769
    44
	{
dvander@769
    45
		int key_press = atoi(engine->Cmd_Argv(1));
dvander@769
    46
		g_ValveMenuStyle.ClientPressedKey(client, key_press);
dvander@769
    47
		return true;
dvander@769
    48
	}
dvander@769
    49
dvander@769
    50
	return false;
dvander@769
    51
}
dvander@769
    52
dvander@769
    53
void ValveMenuStyle::OnSourceModAllInitialized()
dvander@769
    54
{
dvander@769
    55
	g_Players.AddClientListener(this);
dvander@769
    56
	SH_ADD_HOOK_MEMFUNC(IServerPluginHelpers, CreateMessage, serverpluginhelpers, this, &ValveMenuStyle::HookCreateMessage, false);
dvander@769
    57
	g_pSPHCC = SH_GET_CALLCLASS(serverpluginhelpers);
dvander@769
    58
}
dvander@769
    59
dvander@769
    60
void ValveMenuStyle::OnSourceModShutdown()
dvander@769
    61
{
dvander@769
    62
	SH_RELEASE_CALLCLASS(g_pSPHCC);
dvander@769
    63
	SH_REMOVE_HOOK_MEMFUNC(IServerPluginHelpers, CreateMessage, serverpluginhelpers, this, &ValveMenuStyle::HookCreateMessage, false);
dvander@769
    64
	g_Players.RemoveClientListener(this);
dvander@769
    65
}
dvander@769
    66
dvander@769
    67
void ValveMenuStyle::HookCreateMessage(edict_t *pEdict,
dvander@769
    68
									   DIALOG_TYPE type,
dvander@769
    69
									   KeyValues *kv,
dvander@769
    70
									   IServerPluginCallbacks *plugin)
dvander@769
    71
{
dvander@769
    72
	if (type != DIALOG_MENU)
dvander@769
    73
	{
dvander@769
    74
		return;
dvander@769
    75
	}
dvander@769
    76
dvander@769
    77
	int client = engine->IndexOfEdict(pEdict);
dvander@769
    78
	if (client < 1 || client > 256)
dvander@769
    79
	{
dvander@769
    80
		return;
dvander@769
    81
	}
dvander@769
    82
dvander@769
    83
	CValveMenuPlayer *player = &m_players[client];
dvander@769
    84
	
dvander@769
    85
	/* We don't care if the player is in a menu because, for all intents and purposes,
dvander@769
    86
	 * the menu is completely private.  Instead, we just figure out the level we'll need
dvander@769
    87
	 * in order to override it.
dvander@769
    88
	 */
dvander@769
    89
	player->curPrioLevel = kv->GetInt("level", player->curPrioLevel);
dvander@769
    90
dvander@769
    91
	/* Oh no! What happens if we got a menu that overwrites ours?! */
dvander@769
    92
	if (player->bInMenu)
dvander@769
    93
	{
dvander@769
    94
		/* Okay, let the external menu survive for now.  It may live another 
dvander@769
    95
		 * day to avenge its grandfather, killed in the great Menu Interruption
dvander@769
    96
		 * battle.
dvander@769
    97
		 */
dvander@775
    98
		_CancelClientMenu(client, true);
dvander@769
    99
	}
dvander@769
   100
}
dvander@769
   101
dvander@769
   102
void ValveMenuStyle::OnSourceModVSPReceived(IServerPluginCallbacks *iface)
dvander@769
   103
{
dvander@769
   104
	g_pVSPHandle = iface;
dvander@769
   105
}
dvander@769
   106
dvander@769
   107
IMenuDisplay *ValveMenuStyle::CreateDisplay()
dvander@769
   108
{
dvander@769
   109
	return new CValveMenuDisplay();
dvander@769
   110
}
dvander@769
   111
dvander@769
   112
IBaseMenu *ValveMenuStyle::CreateMenu()
dvander@769
   113
{
dvander@769
   114
	return new CValveMenu();
dvander@769
   115
}
dvander@769
   116
dvander@769
   117
const char *ValveMenuStyle::GetStyleName()
dvander@769
   118
{
dvander@769
   119
	return "valve";
dvander@769
   120
}
dvander@769
   121
dvander@769
   122
unsigned int ValveMenuStyle::GetMaxPageItems()
dvander@769
   123
{
dvander@769
   124
	return 8;
dvander@769
   125
}
dvander@769
   126
dvander@775
   127
void ValveMenuStyle::SendDisplay(int client, IMenuDisplay *display)
dvander@769
   128
{
dvander@775
   129
	m_players[client].curPrioLevel--;
dvander@775
   130
	CValveMenuDisplay *vDisplay = (CValveMenuDisplay *)display;
dvander@775
   131
	vDisplay->SendRawDisplay(client, m_players[client].curPrioLevel, m_players[client].menuHoldTime);
dvander@769
   132
}
dvander@769
   133
dvander@775
   134
bool ValveMenuStyle::DoClientMenu(int client, IMenuDisplay *menu, IMenuHandler *mh, unsigned int time)
dvander@769
   135
{
dvander@775
   136
	if (!g_pVSPHandle)
dvander@769
   137
	{
dvander@769
   138
		return false;
dvander@769
   139
	}
dvander@769
   140
dvander@775
   141
	return BaseMenuStyle::DoClientMenu(client, menu, mh, time);
dvander@769
   142
}
dvander@769
   143
dvander@775
   144
bool ValveMenuStyle::DoClientMenu(int client, CBaseMenu *menu, IMenuHandler *mh, unsigned int time)
dvander@769
   145
{
dvander@775
   146
	if (!g_pVSPHandle)
dvander@769
   147
	{
dvander@775
   148
		mh->OnMenuStart(menu);
dvander@769
   149
		mh->OnMenuCancel(menu, client, MenuCancel_NoDisplay);
dvander@769
   150
		mh->OnMenuEnd(menu);
dvander@769
   151
		return false;
dvander@769
   152
	}
dvander@769
   153
dvander@775
   154
	return BaseMenuStyle::DoClientMenu(client, menu, mh, time);
dvander@769
   155
}
dvander@769
   156
dvander@769
   157
CValveMenuDisplay::CValveMenuDisplay()
dvander@769
   158
{
dvander@769
   159
	m_pKv = NULL;
dvander@769
   160
	Reset();
dvander@769
   161
}
dvander@769
   162
dvander@769
   163
CValveMenuDisplay::CValveMenuDisplay(CValveMenu *pMenu)
dvander@769
   164
{
dvander@769
   165
	m_pKv = NULL;
dvander@769
   166
	Reset();
dvander@769
   167
	m_pKv->SetColor("color", pMenu->m_IntroColor);
dvander@769
   168
	m_pKv->SetString("title", pMenu->m_IntroMsg);
dvander@769
   169
}
dvander@769
   170
dvander@776
   171
void CValveMenuDisplay::DeleteThis()
dvander@776
   172
{
dvander@776
   173
	delete this;
dvander@776
   174
}
dvander@776
   175
dvander@769
   176
CValveMenuDisplay::~CValveMenuDisplay()
dvander@769
   177
{
dvander@769
   178
	m_pKv->deleteThis();
dvander@769
   179
}
dvander@769
   180
dvander@769
   181
IMenuStyle *CValveMenuDisplay::GetParentStyle()
dvander@769
   182
{
dvander@769
   183
	return &g_ValveMenuStyle;
dvander@769
   184
}
dvander@769
   185
dvander@769
   186
void CValveMenuDisplay::Reset()
dvander@769
   187
{
dvander@769
   188
	if (m_pKv)
dvander@769
   189
	{
dvander@769
   190
		m_pKv->deleteThis();
dvander@769
   191
	}
dvander@769
   192
	m_pKv = new KeyValues("menu");
dvander@769
   193
	m_NextPos = 1;
dvander@769
   194
	m_TitleDrawn = false;
dvander@769
   195
}
dvander@769
   196
dvander@769
   197
bool CValveMenuDisplay::SetExtOption(MenuOption option, const void *valuePtr)
dvander@769
   198
{
dvander@769
   199
	if (option == MenuOption_IntroMessage)
dvander@769
   200
	{
dvander@769
   201
		m_pKv->SetString("title", (const char *)valuePtr);
dvander@769
   202
		return true;
dvander@769
   203
	} else if (option == MenuOption_IntroColor) {
dvander@769
   204
		int *array = (int *)valuePtr;
dvander@769
   205
		m_pKv->SetColor("color", Color(array[0], array[1], array[2], array[3]));
dvander@769
   206
		return true;
dvander@775
   207
	} else if (option == MenuOption_Priority) {
dvander@775
   208
		m_pKv->SetInt("level", *(int *)valuePtr);
dvander@775
   209
		return true;
dvander@769
   210
	}
dvander@769
   211
dvander@769
   212
	return false;
dvander@769
   213
}
dvander@769
   214
dvander@769
   215
bool CValveMenuDisplay::CanDrawItem(unsigned int drawFlags)
dvander@769
   216
{
dvander@769
   217
	/**
dvander@769
   218
	 * ITEMDRAW_RAWLINE - We can't draw random text, and this doesn't add a slot,
dvander@769
   219
	 *  so it's completely safe to ignore it.
dvander@769
   220
	 * -----------------------------------------
dvander@769
   221
	 */
dvander@769
   222
	if (drawFlags & ITEMDRAW_RAWLINE)
dvander@769
   223
	{
dvander@769
   224
		return false;
dvander@769
   225
	}
dvander@769
   226
dvander@769
   227
	/**
dvander@769
   228
	 * Special cases, explained in DrawItem()
dvander@769
   229
	 */
dvander@769
   230
	if ((drawFlags & ITEMDRAW_NOTEXT)
dvander@769
   231
		|| (drawFlags & ITEMDRAW_SPACER))
dvander@769
   232
	{
dvander@769
   233
		return true;
dvander@769
   234
	}
dvander@769
   235
dvander@769
   236
	/**
dvander@769
   237
	 * We can't draw disabled text.  We could bump the position, but we
dvander@769
   238
	 * want DirectDraw() to find some actual items to display.
dvander@769
   239
	 */
dvander@769
   240
	if (drawFlags & ITEMDRAW_DISABLED)
dvander@769
   241
	{
dvander@769
   242
		return false;
dvander@769
   243
	}
dvander@769
   244
dvander@769
   245
	return true;
dvander@769
   246
}
dvander@769
   247
dvander@769
   248
unsigned int CValveMenuDisplay::DrawItem(const ItemDrawInfo &item)
dvander@769
   249
{
dvander@769
   250
	if (m_NextPos > 9 || !CanDrawItem(item.style))
dvander@769
   251
	{
dvander@769
   252
		return 0;
dvander@769
   253
	}
dvander@769
   254
dvander@769
   255
	/**
dvander@769
   256
	 * For these cases we can't draw anything at all, but
dvander@769
   257
	 * we can at least bump the position since we were explicitly asked to.
dvander@769
   258
	 */
dvander@769
   259
	if ((item.style & ITEMDRAW_NOTEXT)
dvander@769
   260
		|| (item.style & ITEMDRAW_SPACER))
dvander@769
   261
	{
dvander@769
   262
		return m_NextPos++;
dvander@769
   263
	}
dvander@769
   264
dvander@769
   265
	char buffer[255];
dvander@769
   266
	UTIL_Format(buffer, sizeof(buffer), "%d. %s", m_NextPos, item.display);
dvander@769
   267
dvander@769
   268
	KeyValues *ki = m_pKv->FindKey(g_OptionNumTable[m_NextPos], true);
dvander@769
   269
	ki->SetString("command", g_OptionCmdTable[m_NextPos]);
dvander@769
   270
	ki->SetString("msg", buffer);
dvander@769
   271
dvander@769
   272
	return m_NextPos++;
dvander@769
   273
}
dvander@769
   274
dvander@769
   275
void CValveMenuDisplay::DrawTitle(const char *text, bool onlyIfEmpty/* =false */)
dvander@769
   276
{
dvander@769
   277
	if (onlyIfEmpty && m_TitleDrawn)
dvander@769
   278
	{
dvander@769
   279
		return;
dvander@769
   280
	}
dvander@769
   281
dvander@769
   282
	m_pKv->SetString("msg", text);
dvander@769
   283
	m_TitleDrawn = true;
dvander@769
   284
}
dvander@769
   285
dvander@769
   286
bool CValveMenuDisplay::DrawRawLine(const char *rawline)
dvander@769
   287
{
dvander@769
   288
	return false;
dvander@769
   289
}
dvander@769
   290
dvander@769
   291
void CValveMenuDisplay::SendRawDisplay(int client, int priority, unsigned int time)
dvander@769
   292
{
dvander@769
   293
	m_pKv->SetInt("level", priority);
dvander@775
   294
	m_pKv->SetInt("time", time ? time : 200);
dvander@769
   295
dvander@769
   296
	SH_CALL(g_pSPHCC, &IServerPluginHelpers::CreateMessage)(
dvander@769
   297
		engine->PEntityOfEntIndex(client),
dvander@769
   298
		DIALOG_MENU,
dvander@769
   299
		m_pKv,
dvander@769
   300
		g_pVSPHandle);
dvander@769
   301
}
dvander@769
   302
dvander@769
   303
bool CValveMenuDisplay::SendDisplay(int client, IMenuHandler *handler, unsigned int time)
dvander@769
   304
{
dvander@769
   305
	return g_ValveMenuStyle.DoClientMenu(client, this, handler, time);
dvander@769
   306
}
dvander@769
   307
dvander@769
   308
CValveMenu::CValveMenu() : CBaseMenu(&g_ValveMenuStyle), 
dvander@775
   309
	m_IntroColor(255, 0, 0, 255)
dvander@769
   310
{
dvander@769
   311
	strcpy(m_IntroMsg, "You have a menu, press ESC");
dvander@769
   312
	m_Pagination = 5;
dvander@769
   313
}
dvander@769
   314
dvander@775
   315
void CValveMenu::Cancel_Finally()
dvander@769
   316
{
dvander@769
   317
	g_ValveMenuStyle.CancelMenu(this);
dvander@769
   318
}
dvander@769
   319
dvander@769
   320
bool CValveMenu::SetPagination(unsigned int itemsPerPage)
dvander@769
   321
{
dvander@769
   322
	if (itemsPerPage < 1 || itemsPerPage > 5)
dvander@769
   323
	{
dvander@769
   324
		return false;
dvander@769
   325
	}
dvander@769
   326
dvander@769
   327
	CBaseMenu::SetPagination(itemsPerPage);
dvander@769
   328
dvander@769
   329
	return true;
dvander@769
   330
}
dvander@769
   331
dvander@769
   332
bool CValveMenu::SetExtOption(MenuOption option, const void *valuePtr)
dvander@769
   333
{
dvander@769
   334
	if (option == MenuOption_IntroMessage)
dvander@769
   335
	{
dvander@769
   336
		strncopy(m_IntroMsg, (const char *)valuePtr, sizeof(m_IntroMsg));
dvander@769
   337
		return true;
dvander@769
   338
	} else if (option == MenuOption_IntroColor) {
dvander@769
   339
		unsigned int *array = (unsigned int *)valuePtr;
dvander@769
   340
		m_IntroColor = Color(array[0], array[1], array[2], array[3]);
dvander@769
   341
		return true;
dvander@769
   342
	}
dvander@769
   343
dvander@769
   344
	return false;
dvander@769
   345
}
dvander@769
   346
dvander@769
   347
bool CValveMenu::Display(int client, IMenuHandler *handler, unsigned int time)
dvander@769
   348
{
dvander@769
   349
	if (m_bCancelling)
dvander@769
   350
	{
dvander@769
   351
		return false;
dvander@769
   352
	}
dvander@769
   353
dvander@769
   354
	return g_ValveMenuStyle.DoClientMenu(client, this, handler, time);
dvander@769
   355
}
dvander@769
   356
dvander@769
   357
IMenuDisplay *CValveMenu::CreateDisplay()
dvander@769
   358
{
dvander@769
   359
	return new CValveMenuDisplay(this);
dvander@769
   360
}
dvander@769
   361
dvander@769
   362
bool CValveMenu::GetExitButton()
dvander@769
   363
{
dvander@769
   364
	return true;
dvander@769
   365
}
dvander@769
   366
dvander@769
   367
bool CValveMenu::SetExitButton(bool set)
dvander@769
   368
{
dvander@769
   369
	return false;
dvander@769
   370
}
dvander@769
   371
dvander@778
   372
const char *g_OptionNumTable[] = 
dvander@769
   373
{
dvander@769
   374
	"0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10"
dvander@769
   375
};
dvander@769
   376
dvander@778
   377
const char *g_OptionCmdTable[] = 
dvander@769
   378
{
dvander@769
   379
	"sm_vmenuselect 0", /* INVALID! */
dvander@769
   380
	"sm_vmenuselect 1",
dvander@769
   381
	"sm_vmenuselect 2",
dvander@769
   382
	"sm_vmenuselect 3",
dvander@769
   383
	"sm_vmenuselect 4",
dvander@769
   384
	"sm_vmenuselect 5",
dvander@769
   385
	"sm_vmenuselect 6",
dvander@769
   386
	"sm_vmenuselect 7",
dvander@769
   387
	"sm_vmenuselect 8",
dvander@769
   388
	"sm_vmenuselect 9",
dvander@769
   389
	"sm_vmenuselect 10"
dvander@769
   390
};