TopMenu objects are used for constructing multi-layer menus. Currently, they support at most two levels. The first level of items are called "categories".
| Name | Description |
|---|---|
| AddCategory | Adds a category to a TopMenu. |
| AddItem | Adds an item to a TopMenu category. |
| Display | Displays a TopMenu to a client. |
| DisplayCategory | Displays a TopMenu category to a client. |
| FindCategory | Finds a category's topobj ID in a TopMenu. |
| FromHandle | Returns a TopMenu handle from a generic handle. If the given handle is a TopMenu, the handle is simply casted back. Otherwise, an error is raised. |
| GetInfoString | Retrieves the info string of a top menu item. |
| GetObjName | Retrieves the name string of a top menu item. |
| LoadConfig | Re-sorts the items in a TopMenu via a configuration file. |
| Remove | Removes an topobj from a TopMenu. |
| TopMenu | Creates a new TopMenu. |
| Name | Type | Description |
|---|---|---|
| CacheTitles | bool | Set the menu title caching behavior of the TopMenu. By default titles are cached to reduce overhead. If you need dynamic menu titles which change each time the menu is displayed to a user, set this to false. |
This documentation was generated automatically using pawn-docgen written by xPaw for AlliedMods.