plugins/adminmenu.sp
author Fyren <fyrenmoo@gmail.com>
Mon Apr 13 16:39:53 2009 -0700 (2009-04-13)
changeset 2696 32a50b96b644
parent 2334 88fbdb7e1a7c
child 2676 e470e7a8734c
permissions -rw-r--r--
Fix OnClientConnect rejectmsg handling, improve doc (bug 3690, r=dvander)
dvander@1510
     1
/**
dvander@1510
     2
 * vim: set ts=4 :
dvander@1510
     3
 * =============================================================================
pred@1537
     4
 * SourceMod Admin Menu Plugin
pred@1537
     5
 * Creates the base admin menu, for plugins to add items to.
dvander@1510
     6
 *
ds@1947
     7
 * SourceMod (C)2004-2008 AlliedModders LLC.  All rights reserved.
dvander@1510
     8
 * =============================================================================
dvander@1510
     9
 *
dvander@1510
    10
 * This program is free software; you can redistribute it and/or modify it under
dvander@1510
    11
 * the terms of the GNU General Public License, version 3.0, as published by the
dvander@1510
    12
 * Free Software Foundation.
dvander@1510
    13
 * 
dvander@1510
    14
 * This program is distributed in the hope that it will be useful, but WITHOUT
dvander@1510
    15
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
dvander@1510
    16
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
dvander@1510
    17
 * details.
dvander@1510
    18
 *
dvander@1510
    19
 * You should have received a copy of the GNU General Public License along with
dvander@1510
    20
 * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1510
    21
 *
dvander@1510
    22
 * As a special exception, AlliedModders LLC gives you permission to link the
dvander@1510
    23
 * code of this program (as well as its derivative works) to "Half-Life 2," the
dvander@1510
    24
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
dvander@1510
    25
 * by the Valve Corporation.  You must obey the GNU General Public License in
dvander@1510
    26
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
dvander@1510
    27
 * this exception to all derivative works.  AlliedModders LLC defines further
dvander@1510
    28
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
dvander@1510
    29
 * or <http://www.sourcemod.net/license.php>.
dvander@1510
    30
 *
dvander@1510
    31
 * Version: $Id$
dvander@1510
    32
 */
dvander@1510
    33
dvander@1510
    34
#pragma semicolon 1
dvander@1510
    35
dvander@1510
    36
#include <sourcemod>
dvander@1510
    37
#include <topmenus>
dvander@1510
    38
dvander@1510
    39
public Plugin:myinfo = 
dvander@1510
    40
{
dvander@1510
    41
	name = "Admin Menu",
dvander@1510
    42
	author = "AlliedModders LLC",
dvander@1510
    43
	description = "Administration Menu",
dvander@1510
    44
	version = SOURCEMOD_VERSION,
dvander@1510
    45
	url = "http://www.sourcemod.net/"
dvander@1510
    46
};
dvander@1510
    47
dvander@1945
    48
new g_maxPlayers;
dvander@1945
    49
dvander@1510
    50
/* Forwards */
dvander@1510
    51
new Handle:hOnAdminMenuReady = INVALID_HANDLE;
dvander@1510
    52
new Handle:hOnAdminMenuCreated = INVALID_HANDLE;
dvander@1510
    53
dvander@1510
    54
/* Menus */
dvander@1510
    55
new Handle:hAdminMenu = INVALID_HANDLE;
dvander@1510
    56
dvander@1510
    57
/* Top menu objects */
dvander@1510
    58
new TopMenuObject:obj_playercmds = INVALID_TOPMENUOBJECT;
dvander@1518
    59
new TopMenuObject:obj_servercmds = INVALID_TOPMENUOBJECT;
dvander@1523
    60
new TopMenuObject:obj_votingcmds = INVALID_TOPMENUOBJECT;
dvander@1510
    61
dvander@1945
    62
#include "adminmenu/dynamicmenu.sp"
dvander@1945
    63
dvander@1510
    64
public bool:AskPluginLoad(Handle:myself, bool:late, String:error[], err_max)
dvander@1510
    65
{
dvander@1510
    66
	CreateNative("GetAdminTopMenu", __GetAdminTopMenu);
dvander@1510
    67
	CreateNative("AddTargetsToMenu", __AddTargetsToMenu);
dvander@1832
    68
	CreateNative("AddTargetsToMenu2", __AddTargetsToMenu2);
dvander@1510
    69
	RegPluginLibrary("adminmenu");
dvander@1510
    70
	return true;
dvander@1510
    71
}
dvander@1510
    72
dvander@1510
    73
public OnPluginStart()
dvander@1510
    74
{
dvander@1510
    75
	LoadTranslations("common.phrases");
dvander@1625
    76
	LoadTranslations("adminmenu.phrases");
dvander@1510
    77
	
dvander@1510
    78
	hOnAdminMenuCreated = CreateGlobalForward("OnAdminMenuCreated", ET_Ignore, Param_Cell);
dvander@1510
    79
	hOnAdminMenuReady = CreateGlobalForward("OnAdminMenuReady", ET_Ignore, Param_Cell);
dvander@1510
    80
dvander@1630
    81
	RegAdminCmd("sm_admin", Command_DisplayMenu, ADMFLAG_GENERIC, "Displays the admin menu");
dvander@1510
    82
}
dvander@1510
    83
dvander@1590
    84
public OnConfigsExecuted()
dvander@1590
    85
{
dvander@1590
    86
	decl String:path[PLATFORM_MAX_PATH];
dvander@1590
    87
	decl String:error[256];
dvander@1590
    88
	
dvander@1590
    89
	BuildPath(Path_SM, path, sizeof(path), "configs/adminmenu_sorting.txt");
dvander@1590
    90
	
dvander@1590
    91
	if (!LoadTopMenuConfig(hAdminMenu, path, error, sizeof(error)))
dvander@1590
    92
	{
dvander@1590
    93
		LogError("Could not load admin menu config (file \"%s\": %s)", path, error);
dvander@1590
    94
		return;
dvander@1590
    95
	}
dvander@1590
    96
}
dvander@1590
    97
dvander@1945
    98
public OnMapStart()
dvander@1945
    99
{
dvander@1945
   100
	g_maxPlayers = GetMaxClients();
dvander@1945
   101
	
dvander@1945
   102
	ParseConfigs();
dvander@1945
   103
}
dvander@1945
   104
dvander@1510
   105
public OnAllPluginsLoaded()
dvander@1510
   106
{
dvander@1945
   107
	hAdminMenu = CreateTopMenu(DefaultCategoryHandler);
dvander@1510
   108
	
dvander@1510
   109
	obj_playercmds = AddToTopMenu(hAdminMenu, 
dvander@1510
   110
		"PlayerCommands",
dvander@1510
   111
		TopMenuObject_Category,
dvander@1945
   112
		DefaultCategoryHandler,
dvander@1510
   113
		INVALID_TOPMENUOBJECT);
dvander@1518
   114
dvander@1518
   115
	obj_servercmds = AddToTopMenu(hAdminMenu,
dvander@1518
   116
		"ServerCommands",
dvander@1518
   117
		TopMenuObject_Category,
dvander@1945
   118
		DefaultCategoryHandler,
dvander@1518
   119
		INVALID_TOPMENUOBJECT);
dvander@1523
   120
dvander@1523
   121
	obj_votingcmds = AddToTopMenu(hAdminMenu,
dvander@1523
   122
		"VotingCommands",
dvander@1523
   123
		TopMenuObject_Category,
dvander@1945
   124
		DefaultCategoryHandler,
dvander@1523
   125
		INVALID_TOPMENUOBJECT);
dvander@1945
   126
		
dvander@1945
   127
	BuildDynamicMenu();
dvander@1510
   128
	
dvander@1510
   129
	Call_StartForward(hOnAdminMenuCreated);
dvander@1510
   130
	Call_PushCell(hAdminMenu);
dvander@1510
   131
	Call_Finish();
dvander@1510
   132
	
dvander@1510
   133
	Call_StartForward(hOnAdminMenuReady);
dvander@1510
   134
	Call_PushCell(hAdminMenu);
dvander@1510
   135
	Call_Finish();
dvander@1510
   136
}
dvander@1510
   137
dvander@1945
   138
public DefaultCategoryHandler(Handle:topmenu, 
dvander@1510
   139
						TopMenuAction:action,
dvander@1510
   140
						TopMenuObject:object_id,
dvander@1510
   141
						param,
dvander@1510
   142
						String:buffer[],
dvander@1510
   143
						maxlength)
dvander@1510
   144
{
dvander@1525
   145
	if (action == TopMenuAction_DisplayTitle)
dvander@1510
   146
	{
dvander@1510
   147
		if (object_id == INVALID_TOPMENUOBJECT)
dvander@1510
   148
		{
dvander@1510
   149
			Format(buffer, maxlength, "%T:", "Admin Menu", param);
dvander@1510
   150
		}
dvander@1510
   151
		else if (object_id == obj_playercmds)
dvander@1510
   152
		{
dvander@1510
   153
			Format(buffer, maxlength, "%T:", "Player Commands", param);
dvander@1510
   154
		}
dvander@1518
   155
		else if (object_id == obj_servercmds)
dvander@1518
   156
		{
dvander@1518
   157
			Format(buffer, maxlength, "%T:", "Server Commands", param);
dvander@1518
   158
		}
dvander@1523
   159
		else if (object_id == obj_votingcmds)
dvander@1523
   160
		{
dvander@1523
   161
			Format(buffer, maxlength, "%T:", "Voting Commands", param);
dvander@1523
   162
		}
dvander@1510
   163
	}
dvander@1525
   164
	else if (action == TopMenuAction_DisplayOption)
dvander@1510
   165
	{
dvander@1510
   166
		if (object_id == obj_playercmds)
dvander@1510
   167
		{
dvander@1510
   168
			Format(buffer, maxlength, "%T", "Player Commands", param);
dvander@1510
   169
		}
dvander@1518
   170
		else if (object_id == obj_servercmds)
dvander@1518
   171
		{
dvander@1518
   172
			Format(buffer, maxlength, "%T", "Server Commands", param);
dvander@1518
   173
		}
dvander@1523
   174
		else if (object_id == obj_votingcmds)
dvander@1523
   175
		{
dvander@1523
   176
			Format(buffer, maxlength, "%T", "Voting Commands", param);
dvander@1523
   177
		}
dvander@1510
   178
	}
dvander@1510
   179
}
dvander@1510
   180
dvander@1510
   181
public __GetAdminTopMenu(Handle:plugin, numParams)
dvander@1510
   182
{
dvander@1510
   183
	return _:hAdminMenu;
dvander@1510
   184
}
dvander@1510
   185
dvander@1510
   186
public __AddTargetsToMenu(Handle:plugin, numParams)
dvander@1510
   187
{
dvander@1632
   188
	new bool:alive_only = false;
dvander@1632
   189
	
dvander@1632
   190
	if (numParams >= 4)
dvander@1632
   191
	{
dvander@1632
   192
		alive_only = GetNativeCell(4);
dvander@1632
   193
	}
dvander@1632
   194
	
dvander@1632
   195
	return UTIL_AddTargetsToMenu(GetNativeCell(1), GetNativeCell(2), GetNativeCell(3), alive_only);
dvander@1510
   196
}
dvander@1510
   197
dvander@1832
   198
public __AddTargetsToMenu2(Handle:plugin, numParams)
dvander@1832
   199
{
dvander@1832
   200
	return UTIL_AddTargetsToMenu2(GetNativeCell(1), GetNativeCell(2), GetNativeCell(3));
dvander@1832
   201
}
dvander@1832
   202
dvander@1510
   203
public Action:Command_DisplayMenu(client, args)
dvander@1510
   204
{
dvander@1603
   205
	if (client == 0)
dvander@1603
   206
	{
dvander@1603
   207
		ReplyToCommand(client, "[SM] %t", "Command is in-game only");
dvander@1603
   208
		return Plugin_Handled;
dvander@1603
   209
	}
dvander@1603
   210
	
dvander@1510
   211
	DisplayTopMenu(hAdminMenu, client, TopMenuPosition_Start);
dvander@1510
   212
	
dvander@1510
   213
	return Plugin_Handled;
dvander@1510
   214
}
dvander@1510
   215
dvander@1832
   216
stock UTIL_AddTargetsToMenu2(Handle:menu, source_client, flags)
dvander@1510
   217
{
dvander@1510
   218
	new max_clients = GetMaxClients();
dvander@1510
   219
	decl String:user_id[12];
dvander@1510
   220
	decl String:name[MAX_NAME_LENGTH];
dvander@1510
   221
	decl String:display[MAX_NAME_LENGTH+12];
dvander@1510
   222
	
dvander@1510
   223
	new num_clients;
dvander@1510
   224
	
dvander@1510
   225
	for (new i = 1; i <= max_clients; i++)
dvander@1510
   226
	{
dvander@1510
   227
		if (!IsClientConnected(i) || IsClientInKickQueue(i))
dvander@1510
   228
		{
dvander@1510
   229
			continue;
dvander@1510
   230
		}
dvander@1510
   231
		
dvander@1832
   232
		if (((flags & COMMAND_FILTER_NO_BOTS) == COMMAND_FILTER_NO_BOTS)
dvander@1832
   233
			&& IsFakeClient(i))
dvander@1832
   234
		{
dvander@1832
   235
			continue;
dvander@1832
   236
		}
dvander@1832
   237
		
dvander@1832
   238
		if (((flags & COMMAND_FILTER_CONNECTED) != COMMAND_FILTER_CONNECTED)
dvander@1832
   239
			&& !IsClientInGame(i))
dvander@1510
   240
		{
dvander@1510
   241
			continue;
dvander@1510
   242
		}
dvander@1510
   243
		
dvander@1832
   244
		if (((flags & COMMAND_FILTER_ALIVE) == COMMAND_FILTER_ALIVE) 
dvander@1832
   245
			&& !IsPlayerAlive(i))
pred@1626
   246
		{
pred@1626
   247
			continue;
pred@1626
   248
		}
pred@1626
   249
		
dvander@1832
   250
		if (((flags & COMMAND_FILTER_DEAD) == COMMAND_FILTER_DEAD)
dvander@1832
   251
			&& IsPlayerAlive(i))
dvander@1832
   252
		{
dvander@1832
   253
			continue;
dvander@1832
   254
		}
dvander@1832
   255
		
dvander@1832
   256
		if ((source_client && ((flags & COMMAND_FILTER_NO_IMMUNITY) != COMMAND_FILTER_NO_IMMUNITY))
dvander@1832
   257
			&& !CanUserTarget(source_client, i))
dvander@1510
   258
		{
dvander@1510
   259
			continue;
dvander@1510
   260
		}
dvander@1510
   261
		
dvander@1510
   262
		IntToString(GetClientUserId(i), user_id, sizeof(user_id));
dvander@1510
   263
		GetClientName(i, name, sizeof(name));
dvander@1510
   264
		Format(display, sizeof(display), "%s (%s)", name, user_id);
dvander@1510
   265
		AddMenuItem(menu, user_id, display);
dvander@1510
   266
		num_clients++;
dvander@1510
   267
	}
dvander@1510
   268
	
dvander@1510
   269
	return num_clients;
dvander@1510
   270
}
dvander@1518
   271
dvander@1832
   272
stock UTIL_AddTargetsToMenu(Handle:menu, source_client, bool:in_game_only, bool:alive_only)
dvander@1832
   273
{
dvander@1832
   274
	new flags = 0;
dvander@1832
   275
	
dvander@1832
   276
	if (!in_game_only)
dvander@1832
   277
	{
dvander@1832
   278
		flags |= COMMAND_FILTER_CONNECTED;
dvander@1832
   279
	}
dvander@1832
   280
	
dvander@1832
   281
	if (alive_only)
dvander@1832
   282
	{
dvander@1832
   283
		flags |= COMMAND_FILTER_ALIVE;
dvander@1832
   284
	}
dvander@1832
   285
	
dvander@1832
   286
	return UTIL_AddTargetsToMenu2(menu, source_client, flags);
dvander@1832
   287
}
dvander@1832
   288