Top menu manager. More...
#include <public/extensions/ITopMenus.h>
Inherits SourceMod::SMInterface.
Collaboration diagram for SourceMod::ITopMenuManager:
Public Member Functions | |
| virtual const char * | GetInterfaceName ()=0 |
| Must return a string defining the interface's unique name. | |
| virtual unsigned int | GetInterfaceVersion ()=0 |
| Must return an integer defining the interface's version. | |
| virtual bool | IsVersionCompatible (unsigned int version) |
| Must return whether the requested version number is backwards compatible. Note: This can be overridden for breaking changes or custom versioning. | |
| virtual ITopMenu * | CreateTopMenu (ITopMenuObjectCallbacks *callbacks)=0 |
| Creates a new top-level menu. | |
| virtual void | DestroyTopMenu (ITopMenu *topmenu)=0 |
| Destroys a top-level menu. | |
Detailed Description
Top menu manager.
Definition at line 284 of file ITopMenus.h.
Member Function Documentation
| virtual bool SourceMod::ITopMenuManager::IsVersionCompatible | ( | unsigned int | version | ) | [inline, virtual] |
Must return whether the requested version number is backwards compatible. Note: This can be overridden for breaking changes or custom versioning.
- Parameters:
-
version Version number to compare against.
- Returns:
- True if compatible, false otherwise.
Reimplemented from SourceMod::SMInterface.
Definition at line 289 of file ITopMenus.h.
| virtual ITopMenu* SourceMod::ITopMenuManager::CreateTopMenu | ( | ITopMenuObjectCallbacks * | callbacks | ) | [pure virtual] |
Creates a new top-level menu.
- Parameters:
-
callbacks Callbacks for the title text. The object_id for the title will always be 0.
- Returns:
- A new ITopMenu pointer.
| virtual void SourceMod::ITopMenuManager::DestroyTopMenu | ( | ITopMenu * | topmenu | ) | [pure virtual] |
Destroys a top-level menu.
- Parameters:
-
topmenu Pointer to an ITopMenu.
The documentation for this class was generated from the following file:
- public/extensions/ITopMenus.h
