core/MenuManager.h
author David Anderson <dvander@alliedmods.net>
Wed Aug 08 02:27:10 2007 +0000 (2007-08-08)
changeset 1269 27397584df9c
parent 1258 f89bcd42fff5
child 1291 c6d26de53926
permissions -rw-r--r--
- massive overhaul of the voting subsystem
- NOTE: menu API compatibility was COMPLETELY broken for C++!
- cleaned up various aspects of the menu API
- implemented new extended vote results callback
- extended the debug reporter a tiny bit
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
#ifndef _INCLUDE_SOURCEMOD_MENUMANAGER_H_
dvander@769
    34
#define _INCLUDE_SOURCEMOD_MENUMANAGER_H_
dvander@769
    35
dvander@769
    36
#include <IMenuManager.h>
dvander@769
    37
#include <sh_vector.h>
dvander@769
    38
#include <sh_stack.h>
dvander@769
    39
#include <sh_list.h>
dvander@1220
    40
#include <sh_string.h>
dvander@769
    41
#include "sm_memtable.h"
dvander@769
    42
#include "sm_globals.h"
dvander@769
    43
dvander@769
    44
using namespace SourceMod;
dvander@769
    45
using namespace SourceHook;
dvander@769
    46
dvander@769
    47
class MenuManager : 
dvander@769
    48
	public IMenuManager,
dvander@790
    49
	public SMGlobalClass,
dvander@790
    50
	public IHandleTypeDispatch
dvander@769
    51
{
dvander@769
    52
	friend class BroadcastHandler;
dvander@769
    53
	friend class VoteHandler;
dvander@790
    54
	friend class CBaseMenu;
dvander@790
    55
	friend class BaseMenuStyle;
dvander@769
    56
public:
dvander@769
    57
	MenuManager();
dvander@769
    58
public: //SMGlobalClass
dvander@769
    59
	void OnSourceModAllInitialized();
dvander@769
    60
	void OnSourceModAllShutdown();
dvander@1220
    61
	ConfigResult OnSourceModConfigChanged(const char *key,
dvander@1220
    62
		const char *value,
dvander@1220
    63
		ConfigSource source,
dvander@1220
    64
		char *error,
dvander@1220
    65
		size_t maxlength);
dvander@1258
    66
	void OnSourceModLevelChange(const char *mapName);
dvander@769
    67
public: //IMenuManager
dvander@769
    68
	virtual const char *GetInterfaceName()
dvander@769
    69
	{
dvander@769
    70
		return SMINTERFACE_MENUMANAGER_NAME;
dvander@769
    71
	}
dvander@769
    72
	virtual unsigned int GetInterfaceVersion()
dvander@769
    73
	{
dvander@769
    74
		return SMINTERFACE_MENUMANAGER_VERSION;
dvander@769
    75
	}
dvander@769
    76
public:
dvander@769
    77
	unsigned int GetStyleCount();
dvander@769
    78
	IMenuStyle *GetStyle(unsigned int index);
dvander@769
    79
	IMenuStyle *FindStyleByName(const char *name);
dvander@769
    80
	IMenuStyle *GetDefaultStyle();
dvander@780
    81
	void AddStyle(IMenuStyle *style);
dvander@769
    82
	bool SetDefaultStyle(IMenuStyle *style);
dvander@787
    83
	IMenuPanel *RenderMenu(int client, menu_states_t &states, ItemOrder order);
dvander@1269
    84
	void CancelMenu(IBaseMenu *menu);
dvander@1269
    85
	bool StartVote(IBaseMenu *menu,
dvander@1269
    86
		unsigned int num_clients,
dvander@1269
    87
		int clients[],
dvander@1269
    88
		unsigned int max_time,
dvander@1269
    89
		unsigned int flags=0);
dvander@1269
    90
	bool IsVoteInProgress();
dvander@1269
    91
	void CancelVoting();
dvander@790
    92
public: //IHandleTypeDispatch
dvander@790
    93
	void OnHandleDestroy(HandleType_t type, void *object);
dvander@790
    94
public:
dvander@790
    95
	HandleError ReadMenuHandle(Handle_t handle, IBaseMenu **menu);
dvander@790
    96
	HandleError ReadStyleHandle(Handle_t handle, IMenuStyle **style);
dvander@1220
    97
public:
dvander@1220
    98
	bool MenuSoundsEnabled();
dvander@1220
    99
	const char *GetMenuSound(ItemSelection sel);
dvander@769
   100
protected:
dvander@790
   101
	Handle_t CreateMenuHandle(IBaseMenu *menu, IdentityToken_t *pOwner);
dvander@790
   102
	Handle_t CreateStyleHandle(IMenuStyle *style);
dvander@769
   103
private:
dvander@769
   104
	int m_ShowMenu;
dvander@769
   105
	IMenuStyle *m_pDefaultStyle;
dvander@769
   106
	CVector<IMenuStyle *> m_Styles;
dvander@790
   107
	HandleType_t m_StyleType;
dvander@790
   108
	HandleType_t m_MenuType;
dvander@1220
   109
	String m_SelectSound;
dvander@1220
   110
	String m_ExitBackSound;
dvander@1243
   111
	String m_ExitSound;
dvander@769
   112
};
dvander@769
   113
dvander@769
   114
extern MenuManager g_Menus;
dvander@769
   115
dvander@769
   116
#endif //_INCLUDE_SOURCEMOD_MENUMANAGER_H_