FVaRestModule Class Reference

#include <VaRest.h>

Inheritance diagram for FVaRestModule:

Public Member Functions
UVaRestSettings *	GetSettings () const
virtual void	ShutdownModule () override
virtual void	StartupModule () override

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

Protected Attributes
UVaRestSettings *	ModuleSettings

Detailed Description

Definition at line 9 of file VaRest.h.

Member Function Documentation

Get()

static FVaRestModule & FVaRestModule::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 22 of file VaRest.h.

Here is the caller graph for this function:

GetSettings()

UVaRestSettings * FVaRestModule::GetSettings

(

)

const

Getter for internal settings object to support runtime configuration changes

Definition at line 48 of file VaRest.cpp.

Here is the caller graph for this function:

IsAvailable()

static bool FVaRestModule::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 32 of file VaRest.h.

ShutdownModule()

void FVaRestModule::ShutdownModule ( )

overridevirtual

Definition at line 31 of file VaRest.cpp.

StartupModule()

void FVaRestModule::StartupModule ( )

overridevirtual

IModuleInterface implementation

Definition at line 14 of file VaRest.cpp.

Here is the call graph for this function:

Member Data Documentation

ModuleSettings

UVaRestSettings* FVaRestModule::ModuleSettings

protected

Module settings

Definition at line 42 of file VaRest.h.

---

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

• SDKDemo/Plugins/UnrealEngineSDK/PixoApex/Source/VaRest/Public/VaRest.h
• SDKDemo/Plugins/UnrealEngineSDK/PixoApex/Source/VaRest/Private/VaRest.cpp