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