Documentation for the UE5 C++ Plugin
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
FPPlatformCoreModule Class Reference

#include <PPlatformCore.h>

Inheritance diagram for FPPlatformCoreModule:
[legend]

Public Member Functions

UPPlatformCoreSettings * GetSettings () const
 
bool HandleSettingsSaved ()
 
virtual void ShutdownModule () override
 
virtual void StartupModule () override
 

Static Public Member Functions

static FPPlatformCoreModule & Get ()
 
static bool IsAvailable ()
 

Protected Attributes

UPPlatformCoreSettings * ModuleSettings
 

Detailed Description

Definition at line 9 of file PPlatformCore.h.

Member Function Documentation

◆ Get()

static FPPlatformCoreModule & FPPlatformCoreModule::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 PPlatformCore.h.

◆ GetSettings()

UPPlatformCoreSettings * FPPlatformCoreModule::GetSettings ( ) const

Getter for internal settings object to support runtime configuration changes

Definition at line 58 of file PPlatformCore.cpp.

◆ HandleSettingsSaved()

bool FPPlatformCoreModule::HandleSettingsSaved ( )

Definition at line 64 of file PPlatformCore.cpp.

Here is the caller graph for this function:

◆ IsAvailable()

static bool FPPlatformCoreModule::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 PPlatformCore.h.

◆ ShutdownModule()

void FPPlatformCoreModule::ShutdownModule ( )
overridevirtual

Definition at line 41 of file PPlatformCore.cpp.

◆ StartupModule()

void FPPlatformCoreModule::StartupModule ( )
overridevirtual

IModuleInterface implementation

Definition at line 19 of file PPlatformCore.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ ModuleSettings

UPPlatformCoreSettings* FPPlatformCoreModule::ModuleSettings
protected

Module settings

Definition at line 44 of file PPlatformCore.h.

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