A Demo Project for the UnrealEngineSDK
Loading...
Searching...
No Matches
IDlgSystemModule Class Referenceabstract

#include <IDlgSystemModule.h>

Inheritance diagram for IDlgSystemModule:
[legend]

Public Member Functions

virtual ~IDlgSystemModule ()
 
virtual void DisplayDialogueDataWindow ()=0
 
virtual FTabSpawnerEntry * GetDialogueDataDisplaySpawnEntry ()=0
 
virtual TSharedRef< SWidget > GetDialogueDataDisplayWindow ()=0
 
virtual void RegisterConsoleCommands (const TWeakObjectPtr< const UObject > &WorldContextObjectPtr)=0
 
virtual void UnregisterConsoleCommands ()=0
 

Static Public Member Functions

static IDlgSystemModuleGet ()
 
static bool IsAvailable ()
 

Detailed Description

Interface for the DlgSystem module.

Definition at line 18 of file IDlgSystemModule.h.

Constructor & Destructor Documentation

◆ ~IDlgSystemModule()

virtual IDlgSystemModule::~IDlgSystemModule ( )
inlinevirtual

Definition at line 44 of file IDlgSystemModule.h.

Member Function Documentation

◆ DisplayDialogueDataWindow()

virtual void IDlgSystemModule::DisplayDialogueDataWindow ( )
pure virtual

Implemented in FDlgSystemModule.

◆ Get()

static IDlgSystemModule & IDlgSystemModule::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

Definition at line 28 of file IDlgSystemModule.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetDialogueDataDisplaySpawnEntry()

virtual FTabSpawnerEntry * IDlgSystemModule::GetDialogueDataDisplaySpawnEntry ( )
pure virtual

Implemented in FDlgSystemModule.

Here is the caller graph for this function:

◆ GetDialogueDataDisplayWindow()

virtual TSharedRef< SWidget > IDlgSystemModule::GetDialogueDataDisplayWindow ( )
pure virtual

Implemented in FDlgSystemModule.

◆ IsAvailable()

static bool IDlgSystemModule::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

Definition at line 38 of file IDlgSystemModule.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ RegisterConsoleCommands()

virtual void IDlgSystemModule::RegisterConsoleCommands ( const TWeakObjectPtr< const UObject > & WorldContextObjectPtr)
pure virtual

Registers all the console commands.

Parameters
WorldConextObjectPtr- The reference actor for the World. Without this the runtime module won't know how to get the UWorld.

Implemented in FDlgSystemModule.

Here is the caller graph for this function:

◆ UnregisterConsoleCommands()

virtual void IDlgSystemModule::UnregisterConsoleCommands ( )
pure virtual

Implemented in FDlgSystemModule.

Here is the caller graph for this function:

The documentation for this class was generated from the following file: