ICoherentUIGTPlugin Class Reference

Inheritance diagram for ICoherentUIGTPlugin:

Public Member Functions
virtual TSharedPtr< SCoherentUIGTLoadingScreenWidget >	SetupLoadingScreen (const FCoherentUIGTLoadingScreenSettings &Settings)=0

Static Public Member Functions
static ICoherentUIGTPlugin &	Get ()
static bool	IsAvailable ()

Static Public Attributes
static COHERENTUIGTPLUGIN_API FOnLicenseKey	OnLicenseKey

Detailed Description

The public interface to this module. In most cases, this interface is only public to sibling modules within this plugin.

Member Function Documentation

Get()

static ICoherentUIGTPlugin& ICoherentUIGTPlugin::Get ( )

inlinestatic

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.

Returns

Returns singleton instance, loading the module on demand if needed

IsAvailable()

static bool ICoherentUIGTPlugin::IsAvailable ( )

inlinestatic

Checks to see if this module is loaded and ready. It is only valid to call Get() if IsAvailable() returns true.

Returns

True if the module is loaded and ready to use

SetupLoadingScreen()

virtual TSharedPtr<SCoherentUIGTLoadingScreenWidget> ICoherentUIGTPlugin::SetupLoadingScreen ( const FCoherentUIGTLoadingScreenSettings &  Settings )

pure virtual

Creates the loading screen slate widget and sets up the loading screen.

Parameters

Settings

the settings for the loading screen

Returns

Shared pointer to the Slate widget or nullptr if GT is not in async mode

Member Data Documentation

OnLicenseKey

COHERENTUIGTPLUGIN_API FOnLicenseKey ICoherentUIGTPlugin::OnLicenseKey

static

This is an alternative way for setting up the license key. Use this delegate to bind your own function that returns the license key. A convenient place to do it is the StartupModule method of your GameModule class.