Method Maps1
SymbolDescription
TopMenuTopMenu objects are used for constructing multi-layer menus. Currently, they support at most two levels. The first level of items are called "categories".
Enumerations4
SymbolDescription
TopMenuActionActions a top menu will take on an topobj.
TopMenuObjectTop menu topobj tag for type checking.
TopMenuObjectTypeTop menu topobj types.
TopMenuPositionTop menu starting positions for display.
Type Definitions1
SymbolDescription
TopMenuHandlerTopMenu callback prototype.
Functions10
SymbolDescription
AddToTopMenuAdds an topobj to a TopMenu.
CreateTopMenuCreates a TopMenu.
DisplayTopMenuDisplays a TopMenu to a client.
DisplayTopMenuCategoryDisplays a TopMenu category to a client.
FindTopMenuCategoryFinds a category's topobj ID in a TopMenu.
GetTopMenuInfoStringRetrieves the info string of a top menu item.
GetTopMenuObjNameRetrieves the name string of a top menu item.
LoadTopMenuConfigRe-sorts the items in a TopMenu via a configuration file. The format of the configuration file should be a Valve Key-Values formatted file that SourceMod can parse. There should be one root section, and one sub-section for each category. Each sub-section's name should match the category name. Each sub-section may only contain key/value pairs in the form of: key: "item" value: Name of the item as passed to AddToTopMenu(). The TopMenu will draw items in the order declared in the configuration file. If items do not appear in the configuration file, they are sorted per-player based on how the handler function renders for that player. These items appear after the configuration sorted items.
RemoveFromTopMenuRemoves an topobj from a TopMenu. Plugins' topobjs are automatically removed all TopMenus when the given plugin unloads or pauses. In the case of unpausing, all items are restored.
SetTopMenuTitleCachingChange the menu title caching behavior of the TopMenu. By default the titles are cached to reduce overhead. If you need dynamic menu titles, which can change everytime the menu is displayed to a user, set this to false.