Function |
Description |
menu_create | @brief Creates a new menu object.
The handler function should be prototyped as:
public <function>(id, menu, item)
id - Client the menu is being acted upon.
menu - Menu resource identifier.
item - Item the client selected. If less than 0, the menu was
cancelled and the item is a status code. menu_display
should never be called immediately if the item is a status
code, for re-entrancy reasons.
The handler function should always return PLUGIN_HANDLED to block
any old menu handlers from potentially feeding on the menu, unless
that is the desired functionality.
@param title Title the menu should use.
@param handler Name of the handler function. The function will be invoked
once and only once to every menu_display() call.
@param ml Unused (should be 0).
@return Menu resource identifier which must be destroyed via
menu_destroy(). All menus are destroyed when the plugin
unloads.
@error Function name not found. |
menu_makecallback | Creates a menu item callback handler.
The handler function should be prototyped as:
public <function>(id, menu, item)
id - Client index being displayed to.
menu - Menu resource identifier.
item - Item being drawn.
<return> - ITEM_IGNORE to use the default functionality. ITEM_ENABLED to
explicitly enable or ITEM_DISABLED to explicitly disable. |
menu_additem | Adds an menu to a menu. |
menu_pages | Returns the number of pages in a menu. |
menu_items | Returns the number of items in a menu. |
menu_display | Displays a menu to one client. This should never be called from a handler
when the item is less than 0 (i.e. calling this from a cancelled menu will
result in an error).
Starting with 1.8.3 this allows to specify a menu timeout similar to the
show_menu native. If the menu exists on the client past the timeout *any*
further action will send the MENU_TIMEOUT status code to the menu handler.
That includes actions which would otherwise send MENU_EXIT, such as the
client selecting an item or disconnecting and calling menu_cancel or
menu_destroy on a live menu. |
menu_find_id | Given a page on a menu and a keypress on that page, returns the item id selected.
If the item is less than 0, a special option was chosen (such as MENU_EXIT). |
menu_item_getinfo | Retrieves info about a menu item. |
menu_item_setname | Sets an item's display text. |
menu_item_setcmd | Sets an item's info string. |
menu_item_setcall | Sets an item's callback. |
menu_destroy | Destroys a menu. Player menus will be cancelled (although may still linger
on the HUD), and future attempts to access the menu resource will result in
an error.
This must be called if you create menus dynamically, otherwise you will
leak memory. For normal dynamic menus, you will destroy the menu in the
handler function (remembering to handle the case of a menu being cancelled,
it must still be destroyed). |
player_menu_info | Returns information about a menu (if any) the client is currently viewing.
If newmenu is valid, then the menu will refer to the menuid associated with
the title. If newmenu is not valid, and the menu is valid, then the player
is viewing a menu displayed with show_menu().
Both may be invalid if the player is not viewing a menu. |
menu_addblank | Adds a blank line to a menu.
When using slot=1 this might break your menu. To achieve this functionality
menu_addblank2 should be used. |
menu_addtext | Adds a text line to a menu. Only available in amxmodx 1.8.1 and above.
When using slot=1 this might break your menu. To achieve this functionality
menu_addtext2 should be used. |
menu_addblank2 | Adds a blank line to a menu, always shifting the numbering down.
This will add a special item to create a blank line. It will affect the menu
item count and pagination. These items can be modified later but will ignore
access and item callback results.
Only available in 1.8.3 and above. |
menu_addtext2 | Adds a text line to a menu, always shifting the numbering down.
This will add a special item to create a blank line. It will affect the menu
item count and pagination. These items can be modified later but will ignore
access and item callback results.
Only available in 1.8.3 and above. |
menu_setprop | Sets a menu property. |
menu_cancel | Cancels a player's menu, effectively forcing the player to select MENU_EXIT.
The menu will still exist on their screen but any results are invalidated,
and the callback is invoked. |