ISMSearchModule¶
Module: SMSearch
#include <ISMSearchModule.h>
Inherits from IModuleInterface
Description¶
The public interface to this module
Public Functions¶
| Name | |
|---|---|
| ISMSearchModule & | Get() |
| bool | IsAvailable() |
| virtual TSharedPtr< ISMSearch > | GetSearchInterface() const =0 |
| virtual const FName & | GetSearchTabName() const =0 |
Public Functions Documentation¶
function Get¶
Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
Return: Returns singleton instance, loading the module on demand if needed
function IsAvailable¶
Checks to see if this module is loaded and ready. It is only valid to call Get() if IsAvailable() returns true.
Return: True if the module is loaded and ready to use
function GetSearchInterface¶
Return the search interface.
function GetSearchTabName¶
Return the tab name the search UI uses.