3 * ===============================================================
4 * SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved.
5 * ===============================================================
7 * This file is not open source and may not be copied without explicit
8 * written permission of AlliedModders LLC. This file may not be redistributed
9 * in whole or significant part.
10 * For information, see LICENSE.txt or http://www.sourcemod.net/license.php
15 #include "sm_stringutil.h"
16 #include "PlayerManager.h"
17 #include "MenuStyle_Valve.h"
18 #include "Translator.h"
19 #include "PlayerManager.h"
20 #include "ConCmdManager.h"
22 SH_DECL_HOOK4_void(IServerPluginHelpers, CreateMessage, SH_NOATTRIB, false, edict_t *, DIALOG_TYPE, KeyValues *, IServerPluginCallbacks *);
24 ValveMenuStyle g_ValveMenuStyle;
25 const char *g_OptionNumTable[];
26 const char *g_OptionCmdTable[];
27 IServerPluginCallbacks *g_pVSPHandle = NULL;
28 CallClass<IServerPluginHelpers> *g_pSPHCC = NULL;
30 class TestHandler : public IMenuHandler
33 virtual void OnMenuEnd(IBaseMenu *menu)
39 ValveMenuStyle::ValveMenuStyle() : m_players(new CValveMenuPlayer[256+1]), m_WatchList(256)
43 bool ValveMenuStyle::OnClientCommand(int client)
45 const char *cmd = engine->Cmd_Argv(0);
47 if (strcmp(cmd, "sm_vmenuselect") == 0)
49 int key_press = atoi(engine->Cmd_Argv(1));
50 g_ValveMenuStyle.ClientPressedKey(client, key_press);
54 if (strcmp(cmd, "sm_test") == 0)
56 IBaseMenu *menu = g_ValveMenuStyle.CreateMenu();
57 menu->AppendItem("test1", ItemDrawInfo("Test #1", 0));
58 menu->AppendItem("test2", ItemDrawInfo("Test #2", 0));
59 menu->AppendItem("test3", ItemDrawInfo("Test #3", 0));
60 menu->AppendItem("test4", ItemDrawInfo("Test #4", 0));
61 menu->AppendItem("test5", ItemDrawInfo("Test #5", 0));
62 menu->AppendItem("test6", ItemDrawInfo("Test #6", 0));
63 menu->AppendItem("test7", ItemDrawInfo("Test #7", 0));
64 menu->AppendItem("test8", ItemDrawInfo("Test #8", 0));
65 menu->AppendItem("test9", ItemDrawInfo("Test #9", 0));
66 menu->AppendItem("test10", ItemDrawInfo("Test #10", 0));
67 menu->AppendItem("test11", ItemDrawInfo("Test #11", 0));
68 menu->AppendItem("test12", ItemDrawInfo("Test #12", 0));
69 menu->AppendItem("test13", ItemDrawInfo("Test #13", 0));
70 menu->AppendItem("test14", ItemDrawInfo("Test #14", 0));
71 menu->AppendItem("test15", ItemDrawInfo("Test #15", 0));
72 menu->AppendItem("test16", ItemDrawInfo("Test #16", 0));
73 menu->AppendItem("test17", ItemDrawInfo("Test #17", 0));
74 menu->AppendItem("test18", ItemDrawInfo("Test #18", 0));
75 menu->AppendItem("test19", ItemDrawInfo("Test #19", 0));
76 menu->AppendItem("test20", ItemDrawInfo("Test #20", 0));
78 menu->Display(client, new TestHandler, 20);
80 } else if (strcmp(cmd, "gaben") == 0) {
81 KeyValues *kv = new KeyValues("menu");
82 kv->SetString("msg", "hi");
83 serverpluginhelpers->CreateMessage(engine->PEntityOfEntIndex(client), DIALOG_MENU, kv, g_pVSPHandle);
90 void ValveMenuStyle::OnSourceModAllInitialized()
92 g_Players.AddClientListener(this);
93 SH_ADD_HOOK_MEMFUNC(IServerPluginHelpers, CreateMessage, serverpluginhelpers, this, &ValveMenuStyle::HookCreateMessage, false);
94 g_pSPHCC = SH_GET_CALLCLASS(serverpluginhelpers);
97 void ValveMenuStyle::OnSourceModShutdown()
99 SH_RELEASE_CALLCLASS(g_pSPHCC);
100 SH_REMOVE_HOOK_MEMFUNC(IServerPluginHelpers, CreateMessage, serverpluginhelpers, this, &ValveMenuStyle::HookCreateMessage, false);
101 g_Players.RemoveClientListener(this);
104 void ValveMenuStyle::OnClientDisconnected(int client)
106 CValveMenuPlayer *player = &m_players[client];
107 if (!player->bInMenu)
112 menu_states_t &states = player->states;
113 states.mh->OnMenuCancel(states.menu, client, MenuCancel_Disconnect);
114 states.mh->OnMenuEnd(states.menu);
116 if (player->menuHoldTime)
118 m_WatchList.remove(client);
121 player->bInMenu = false;
124 void ValveMenuStyle::HookCreateMessage(edict_t *pEdict,
127 IServerPluginCallbacks *plugin)
129 if (type != DIALOG_MENU)
134 int client = engine->IndexOfEdict(pEdict);
135 if (client < 1 || client > 256)
140 CValveMenuPlayer *player = &m_players[client];
142 /* We don't care if the player is in a menu because, for all intents and purposes,
143 * the menu is completely private. Instead, we just figure out the level we'll need
144 * in order to override it.
146 player->curPrioLevel = kv->GetInt("level", player->curPrioLevel);
148 /* Oh no! What happens if we got a menu that overwrites ours?! */
151 /* Okay, let the external menu survive for now. It may live another
152 * day to avenge its grandfather, killed in the great Menu Interruption
155 _CancelMenu(client, true);
159 void ValveMenuStyle::OnSourceModVSPReceived(IServerPluginCallbacks *iface)
161 g_pVSPHandle = iface;
164 IMenuDisplay *ValveMenuStyle::CreateDisplay()
166 return new CValveMenuDisplay();
169 IBaseMenu *ValveMenuStyle::CreateMenu()
171 return new CValveMenu();
174 const char *ValveMenuStyle::GetStyleName()
179 unsigned int ValveMenuStyle::GetMaxPageItems()
184 static int do_lookup[256];
185 void ValveMenuStyle::ProcessWatchList()
187 if (!m_WatchList.size())
192 FastLink<int>::iterator iter;
194 unsigned int total = 0;
195 for (iter=m_WatchList.begin(); iter!=m_WatchList.end(); ++iter)
197 do_lookup[total++] = (*iter);
201 CValveMenuPlayer *player;
202 float curTime = gpGlobals->curtime;
203 for (unsigned int i=0; i<total; i++)
205 client = do_lookup[i];
206 player = &m_players[client];
207 if (!player->bInMenu || !player->menuHoldTime)
209 m_WatchList.remove(i);
212 if (curTime > player->menuStartTime + player->menuHoldTime)
214 _CancelMenu(i, false);
219 void ValveMenuStyle::_CancelMenu(int client, bool bAutoIgnore)
221 CValveMenuPlayer *player = &m_players[client];
222 menu_states_t &states = player->states;
224 bool bOldIgnore = player->bAutoIgnore;
227 player->bAutoIgnore = true;
231 IMenuHandler *mh = states.mh;
232 IBaseMenu *menu = states.menu;
235 player->bInMenu = false;
236 if (player->menuHoldTime)
238 m_WatchList.remove(client);
242 mh->OnMenuCancel(menu, client, MenuCancel_Interrupt);
247 player->bAutoIgnore = bOldIgnore;
251 void ValveMenuStyle::CancelMenu(CValveMenu *menu)
253 int maxClients = g_Players.GetMaxClients();
254 for (int i=1; i<=maxClients; i++)
256 if (m_players[i].bInMenu)
258 menu_states_t &states = m_players[i].states;
259 if (states.menu == menu)
267 bool ValveMenuStyle::CancelClientMenu(int client, bool autoIgnore)
269 if (client < 1 || client > 256 || !m_players[client].bInMenu)
274 _CancelMenu(client, autoIgnore);
280 void ValveMenuStyle::ClientPressedKey(int client, unsigned int key_press)
282 CValveMenuPlayer *player = &m_players[client];
284 /* First question: Are we in a menu? */
285 if (!player->bInMenu)
291 unsigned int item = 0;
292 MenuCancelReason reason = MenuCancel_Exit;
293 menu_states_t &states = player->states;
295 assert(states.mh != NULL);
297 if (states.menu == NULL)
300 } else if (key_press < 1 || key_press > 8) {
303 ItemSelection type = states.slots[key_press].type;
305 /* For navigational items, we're going to redisplay */
306 if (type == ItemSel_Back)
308 if (!RedoClientMenu(client, ItemOrder_Descending))
311 reason = MenuCancel_NoDisplay;
315 } else if (type == ItemSel_Next) {
316 if (!RedoClientMenu(client, ItemOrder_Ascending))
318 cancel = true; /* I like Saltines. */
319 reason = MenuCancel_NoDisplay;
323 } else if (type == ItemSel_Exit || type == ItemSel_None) {
326 item = states.slots[key_press].item;
331 IMenuHandler *mh = states.mh;
332 IBaseMenu *menu = states.menu;
335 player->bInMenu = false;
336 if (player->menuHoldTime)
338 m_WatchList.remove(client);
343 mh->OnMenuCancel(menu, client, reason);
345 mh->OnMenuSelect(menu, client, item);
351 bool ValveMenuStyle::DoClientMenu(int client, CValveMenuDisplay *menu, IMenuHandler *mh, unsigned int time)
353 if (!g_pVSPHandle || !mh)
358 CPlayer *pPlayer = g_Players.GetPlayerByIndex(client);
359 if (!pPlayer || pPlayer->IsFakeClient() || !pPlayer->IsInGame())
364 CValveMenuPlayer *player = &m_players[client];
365 if (player->bAutoIgnore)
370 /* For the duration of this, we are going to totally ignore whether
371 * the player is already in a menu or not (except to cancel the old one).
372 * Instead, we are simply going to ignore any further menu displays, so
373 * this display can't be interrupted.
375 player->bAutoIgnore = true;
377 /* Cancel any old menus */
378 menu_states_t &states = player->states;
381 /* We need to cancel the old menu */
382 if (player->menuHoldTime)
384 m_WatchList.remove(client);
386 states.mh->OnMenuCancel(states.menu, client, MenuCancel_Interrupt);
387 states.mh->OnMenuEnd(states.menu);
390 states.firstItem = 0;
394 states.apiVers = SMINTERFACE_MENUMANAGER_VERSION;
395 player->curPrioLevel--;
396 player->bInMenu = true;
397 player->menuStartTime = gpGlobals->curtime;
398 player->menuHoldTime = time;
402 m_WatchList.push_back(client);
405 /* Draw the display */
406 menu->SendRawDisplay(client, player->curPrioLevel, time);
408 /* We can be interrupted again! */
409 player->bAutoIgnore = false;
414 bool ValveMenuStyle::DoClientMenu(int client, CValveMenu *menu, IMenuHandler *mh, unsigned int time)
416 mh->OnMenuStart(menu);
418 if (!g_pVSPHandle || !mh)
420 mh->OnMenuCancel(menu, client, MenuCancel_NoDisplay);
425 CPlayer *pPlayer = g_Players.GetPlayerByIndex(client);
426 if (!pPlayer || pPlayer->IsFakeClient() || !pPlayer->IsInGame())
428 mh->OnMenuCancel(menu, client, MenuCancel_NoDisplay);
433 CValveMenuPlayer *player = &m_players[client];
434 if (player->bAutoIgnore)
436 mh->OnMenuCancel(menu, client, MenuCancel_NoDisplay);
441 /* For the duration of this, we are going to totally ignore whether
442 * the player is already in a menu or not (except to cancel the old one).
443 * Instead, we are simply going to ignore any further menu displays, so
444 * this display can't be interrupted.
446 player->bAutoIgnore = true;
448 /* Cancel any old menus */
449 menu_states_t &states = player->states;
452 /* We need to cancel the old menu */
453 if (player->menuHoldTime)
455 m_WatchList.remove(client);
457 states.mh->OnMenuCancel(states.menu, client, MenuCancel_Interrupt);
458 states.mh->OnMenuEnd(states.menu);
461 states.firstItem = 0;
465 states.apiVers = SMINTERFACE_MENUMANAGER_VERSION;
467 IMenuDisplay *display = g_Menus.RenderMenu(client, states, ItemOrder_Ascending);
470 player->bAutoIgnore = false;
471 player->bInMenu = false;
472 mh->OnMenuCancel(menu, client, MenuCancel_NoDisplay);
477 /* Finally, set our states */
478 player->curPrioLevel--;
479 player->bInMenu = true;
480 player->menuStartTime = gpGlobals->curtime;
481 player->menuHoldTime = time;
485 m_WatchList.push_back(client);
488 /* Draw the display */
489 CValveMenuDisplay *vDisplay = (CValveMenuDisplay *)display;
490 vDisplay->SendRawDisplay(client, player->curPrioLevel, time);
492 /* Free the display pointer */
495 /* We can be interrupted again! */
496 player->bAutoIgnore = false;
501 bool ValveMenuStyle::RedoClientMenu(int client, ItemOrder order)
503 CValveMenuPlayer *player = &m_players[client];
504 menu_states_t &states = player->states;
506 player->bAutoIgnore = true;
507 IMenuDisplay *display = g_Menus.RenderMenu(client, states, order);
510 if (player->menuHoldTime)
512 m_WatchList.remove(client);
514 player->bAutoIgnore = false;
518 CValveMenuDisplay *vDisplay = (CValveMenuDisplay *)display;
519 vDisplay->SendRawDisplay(client, --player->curPrioLevel, player->menuHoldTime);
523 player->bAutoIgnore = false;
528 MenuSource ValveMenuStyle::GetClientMenu(int client, void **object)
530 if (client < 1 || client > 256 || !m_players[client].bInMenu)
532 return MenuSource_None;
536 if ((menu=m_players[client].states.menu) != NULL)
542 return MenuSource_BaseMenu;
545 return MenuSource_Display;
548 CValveMenuDisplay::CValveMenuDisplay()
554 CValveMenuDisplay::CValveMenuDisplay(CValveMenu *pMenu)
558 m_pKv->SetColor("color", pMenu->m_IntroColor);
559 m_pKv->SetString("title", pMenu->m_IntroMsg);
562 CValveMenuDisplay::~CValveMenuDisplay()
567 IMenuStyle *CValveMenuDisplay::GetParentStyle()
569 return &g_ValveMenuStyle;
572 void CValveMenuDisplay::Reset()
578 m_pKv = new KeyValues("menu");
580 m_TitleDrawn = false;
583 bool CValveMenuDisplay::SetExtOption(MenuOption option, const void *valuePtr)
585 if (option == MenuOption_IntroMessage)
587 m_pKv->SetString("title", (const char *)valuePtr);
589 } else if (option == MenuOption_IntroColor) {
590 int *array = (int *)valuePtr;
591 m_pKv->SetColor("color", Color(array[0], array[1], array[2], array[3]));
598 bool CValveMenuDisplay::CanDrawItem(unsigned int drawFlags)
601 * ITEMDRAW_RAWLINE - We can't draw random text, and this doesn't add a slot,
602 * so it's completely safe to ignore it.
603 * -----------------------------------------
605 if (drawFlags & ITEMDRAW_RAWLINE)
611 * Special cases, explained in DrawItem()
613 if ((drawFlags & ITEMDRAW_NOTEXT)
614 || (drawFlags & ITEMDRAW_SPACER))
620 * We can't draw disabled text. We could bump the position, but we
621 * want DirectDraw() to find some actual items to display.
623 if (drawFlags & ITEMDRAW_DISABLED)
631 unsigned int CValveMenuDisplay::DrawItem(const ItemDrawInfo &item)
633 if (m_NextPos > 9 || !CanDrawItem(item.style))
639 * For these cases we can't draw anything at all, but
640 * we can at least bump the position since we were explicitly asked to.
642 if ((item.style & ITEMDRAW_NOTEXT)
643 || (item.style & ITEMDRAW_SPACER))
649 UTIL_Format(buffer, sizeof(buffer), "%d. %s", m_NextPos, item.display);
651 KeyValues *ki = m_pKv->FindKey(g_OptionNumTable[m_NextPos], true);
652 ki->SetString("command", g_OptionCmdTable[m_NextPos]);
653 ki->SetString("msg", buffer);
658 void CValveMenuDisplay::DrawTitle(const char *text, bool onlyIfEmpty/* =false */)
660 if (onlyIfEmpty && m_TitleDrawn)
665 m_pKv->SetString("msg", text);
669 bool CValveMenuDisplay::DrawRawLine(const char *rawline)
674 void CValveMenuDisplay::SendRawDisplay(int client, int priority, unsigned int time)
676 m_pKv->SetInt("level", priority);
677 m_pKv->SetInt("time", time);
679 SH_CALL(g_pSPHCC, &IServerPluginHelpers::CreateMessage)(
680 engine->PEntityOfEntIndex(client),
686 bool CValveMenuDisplay::SendDisplay(int client, IMenuHandler *handler, unsigned int time)
688 return g_ValveMenuStyle.DoClientMenu(client, this, handler, time);
691 CValveMenu::CValveMenu() : CBaseMenu(&g_ValveMenuStyle),
692 m_IntroColor(255, 0, 0, 255), m_bShouldDelete(false), m_bCancelling(false)
694 strcpy(m_IntroMsg, "You have a menu, press ESC");
698 void CValveMenu::Cancel()
705 m_bCancelling = true;
706 g_ValveMenuStyle.CancelMenu(this);
707 m_bCancelling = false;
715 void CValveMenu::Destroy()
717 if (!m_bCancelling || m_bShouldDelete)
722 m_bShouldDelete = true;
726 bool CValveMenu::SetPagination(unsigned int itemsPerPage)
728 if (itemsPerPage < 1 || itemsPerPage > 5)
733 CBaseMenu::SetPagination(itemsPerPage);
738 bool CValveMenu::SetExtOption(MenuOption option, const void *valuePtr)
740 if (option == MenuOption_IntroMessage)
742 strncopy(m_IntroMsg, (const char *)valuePtr, sizeof(m_IntroMsg));
744 } else if (option == MenuOption_IntroColor) {
745 unsigned int *array = (unsigned int *)valuePtr;
746 m_IntroColor = Color(array[0], array[1], array[2], array[3]);
753 bool CValveMenu::Display(int client, IMenuHandler *handler, unsigned int time)
760 return g_ValveMenuStyle.DoClientMenu(client, this, handler, time);
763 IMenuDisplay *CValveMenu::CreateDisplay()
765 return new CValveMenuDisplay(this);
768 bool CValveMenu::GetExitButton()
773 bool CValveMenu::SetExitButton(bool set)
778 static const char *g_OptionNumTable[11] =
780 "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10"
783 static const char *g_OptionCmdTable[11] =
785 "sm_vmenuselect 0", /* INVALID! */