/**

 * vim: set ts=4 :

 * =============================================================================

 * SourceMod (C)2004-2008 AlliedModders LLC.  All rights reserved.

 * =============================================================================

 *

 * This file is part of the SourceMod/SourcePawn SDK.

 *

 * This program is free software; you can redistribute it and/or modify it under

 * the terms of the GNU General Public License, version 3.0, as published by the

 * Free Software Foundation.

 * 

 * This program is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS

 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more

 * details.

 *

 * You should have received a copy of the GNU General Public License along with

 * this program.  If not, see <http://www.gnu.org/licenses/>.

 *

 * As a special exception, AlliedModders LLC gives you permission to link the

 * code of this program (as well as its derivative works) to "Half-Life 2," the

 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software

 * by the Valve Corporation.  You must obey the GNU General Public License in

 * all respects for all other code used.  Additionally, AlliedModders LLC grants

 * this exception to all derivative works.  AlliedModders LLC defines further

 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),

 * or <http://www.sourcemod.net/license.php>.

 *

 * Version: $Id$

 */

#if defined _adminmenu_included

 #endinput

#endif

#define _adminmenu_included

/* Decide whether topmenus should be required */

#if !defined REQUIRE_PLUGIN

 #if defined REQUIRE_EXTENSIONS

  #define TEMP_REQUIRE_EXTENSIONS

  #undef REQUIRE_EXTENSIONS

 #endif

#endif

#include <topmenus>

/* Restore old REQUIRE_EXTENSIONS value if necessary */

#if defined TEMP_REQUIRE_EXTENSIONS

 #define REQUIRE_EXTENSIONS

 #undef TEMP_REQUIRE_EXTENSIONS

#endif

/** Category for player commands. */

#define ADMINMENU_PLAYERCOMMANDS		"PlayerCommands"

/** Category for server commands. */

#define ADMINMENU_SERVERCOMMANDS		"ServerCommands"

/** Category for voting commands. */

#define ADMINMENU_VOTINGCOMMANDS		"VotingCommands"

/**

 * Called when the admin menu is created and 3rd party plugins can grab 

 * the Handle or add categories.

 * 

 * @param topmenu		Handle to the admin menu's TopMenu.

 * @noreturn

 */

forward OnAdminMenuCreated(Handle:topmenu);

/**

 * Called when the admin menu is ready to have items added.

 * 

 * @param topmenu		Handle to the admin menu's TopMenu.

 * @noreturn

 */

forward OnAdminMenuReady(Handle:topmenu);

/**

 * Retrieves the Handle to the admin top menu.

 *

 * @return				Handle to the admin menu's TopMenu,

 *						or INVALID_HANDLE if not created yet.

 */

native Handle:GetAdminTopMenu();

/**

 * Adds targets to an admin menu.

 *

 * Each client is displayed as: name (userid)

 * Each item contains the userid as a string for its info.

 *

 * @param menu			Menu Handle.

 * @param source_client	Source client, or 0 to ignore immunity.

 * @param in_game_only	True to only select in-game players.

 * @param alive_only 	True to only select alive players.

 * @return				Number of clients added.

 */

native AddTargetsToMenu(Handle:menu, 

						source_client, 

						bool:in_game_only=true, 

						bool:alive_only=false);

/**

 * Adds targets to an admin menu.

 *

 * Each client is displayed as: name (userid)

 * Each item contains the userid as a string for its info.

 *

 * @param menu			Menu Handle.

 * @param source_client	Source client, or 0 to ignore immunity.

 * @param flags			COMMAND_FILTER flags from commandfilters.inc.

 * @return				Number of clients added.

 */

native AddTargetsToMenu2(Handle:menu, source_client, flags);

/**

 * Re-displays the admin menu to a client after selecting an item.

 * Auto-aborts if the Handle is invalid.

 *

 * @param topmenu		TopMenu Handle.

 * @param client		Client index.

 * @return				True on success, false on failure.

 */

stock bool:RedisplayAdminMenu(Handle:topmenu, client)

{

	if (topmenu == INVALID_HANDLE)

	{

		return false;

	}

	return DisplayTopMenu(topmenu, client, TopMenuPosition_LastCategory);

}

/* DO NOT EDIT BELOW THIS LINE */

public SharedPlugin:__pl_adminmenu = 

{

	name = "adminmenu",

	file = "adminmenu.smx",

#if defined REQUIRE_PLUGIN

	required = 1,

#else

	required = 0,

#endif

};

#if !defined REQUIRE_PLUGIN

public __pl_adminmenu_SetNTVOptional()

{

	MarkNativeAsOptional("GetAdminTopMenu");

	MarkNativeAsOptional("AddTargetsToMenu");

	MarkNativeAsOptional("AddTargetsToMenu2");

}

#endif