1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/plugins/include/adminmenu.inc	Mon Oct 01 18:50:07 2007 +0000
     1.3 @@ -0,0 +1,110 @@
     1.4 +/**
     1.5 + * vim: set ts=4 :
     1.6 + * =============================================================================
     1.7 + * SourceMod (C)2004-2007 AlliedModders LLC.  All rights reserved.
     1.8 + * =============================================================================
     1.9 + *
    1.10 + * This file is part of the SourceMod/SourcePawn SDK.
    1.11 + *
    1.12 + * This program is free software; you can redistribute it and/or modify it under
    1.13 + * the terms of the GNU General Public License, version 3.0, as published by the
    1.14 + * Free Software Foundation.
    1.15 + * 
    1.16 + * This program is distributed in the hope that it will be useful, but WITHOUT
    1.17 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    1.18 + * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
    1.19 + * details.
    1.20 + *
    1.21 + * You should have received a copy of the GNU General Public License along with
    1.22 + * this program.  If not, see <http://www.gnu.org/licenses/>.
    1.23 + *
    1.24 + * As a special exception, AlliedModders LLC gives you permission to link the
    1.25 + * code of this program (as well as its derivative works) to "Half-Life 2," the
    1.26 + * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
    1.27 + * by the Valve Corporation.  You must obey the GNU General Public License in
    1.28 + * all respects for all other code used.  Additionally, AlliedModders LLC grants
    1.29 + * this exception to all derivative works.  AlliedModders LLC defines further
    1.30 + * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
    1.31 + * or <http://www.sourcemod.net/license.php>.
    1.32 + *
    1.33 + * Version: $Id$
    1.34 + */
    1.35 + 
    1.36 +#if defined _adminmenu_included
    1.37 + #endinput
    1.38 +#endif
    1.39 +#define _adminmenu_included
    1.40 +
    1.41 +/* Decide whether topmenus should be required */
    1.42 +#if !defined REQUIRE_PLUGIN
    1.43 + #if defined REQUIRE_EXTENSIONS
    1.44 + #define TEMP_REQUIRE_EXTENSIONS
    1.45 + #undef REQUIRE_EXTENSIONS
    1.46 +#endif
    1.47 +
    1.48 +#include <topmenus>
    1.49 +
    1.50 +/* Restore old REQUIRE_EXTENSIONS value if necessary */
    1.51 +#if defined TEMP_REQUIRE_EXTENSIONS
    1.52 + #define REQUIRE_EXTENSIONS
    1.53 + #undef TEMP_REQUIRE_EXTENSIONS
    1.54 +#endif
    1.55 +
    1.56 +/** Category for player commands. */
    1.57 +#define ADMINMENU_PLAYERCOMMANDS		"PlayerCommands"
    1.58 +
    1.59 +/**
    1.60 + * Called when the admin menu is created and 3rd party plugins can grab 
    1.61 + * the Handle or add categories.
    1.62 + * 
    1.63 + * @param topmenu		Handle to the admin menu's TopMenu.
    1.64 + * @noreturn
    1.65 + */
    1.66 +forward OnAdminMenuCreated(Handle:topmenu);
    1.67 +
    1.68 +/**
    1.69 + * Called when the admin menu is ready to have items added.
    1.70 + * 
    1.71 + * @param topmenu		Handle to the admin menu's TopMenu.
    1.72 + * @noreturn
    1.73 + */
    1.74 +forward OnAdminMenuReady(Handle:topmenu);
    1.75 +
    1.76 +/**
    1.77 + * Retrieves the Handle to the admin top menu.
    1.78 + *
    1.79 + * @return				Handle to the admin menu's TopMenu,
    1.80 + *						or INVALID_HANDLE if not created yet.
    1.81 + */
    1.82 +native Handle:GetAdminTopMenu();
    1.83 +
    1.84 +/**
    1.85 + * Adds targets to an admin menu.
    1.86 + *
    1.87 + * Each client is displayed as: name (userid)
    1.88 + * Each item contains the userid as a string for its info.
    1.89 + *
    1.90 + * @param menu			Menu Handle.
    1.91 + * @param source_client	Source client, or 0 to ignore immunity.
    1.92 + * @param in_game_only	True to only select in-game players.
    1.93 + * @return				Number of clients added.
    1.94 + */
    1.95 +native AddTargetsToMenu(Handle:menu, source_client, bool:in_game_only=true);
    1.96 +
    1.97 +/* DO NOT EDIT BELOW THIS LINE */
    1.98 +
    1.99 +public SharedPlugin:__pl_adminmenu = 
   1.100 +{
   1.101 +	name = "adminmenu",
   1.102 +	file = "adminmenu.smx",
   1.103 +#if defined REQUIRE_PLUGIN
   1.104 +	required = 1,
   1.105 +#else
   1.106 +	required = 0,
   1.107 +#endif
   1.108 +};
   1.109 +
   1.110 +public __pl_adminmenu_SetNTVOptional()
   1.111 +{
   1.112 +	MarkNativeAsOptional("GetAdminTopMenu");
   1.113 +}