FSteamSharedModule

Windows
MacOS
Linux

Inheritance Hierarchy

IModuleInterface

FSteamSharedModule

References

Module

SteamShared

Header

/Engine/Plugins/Runtime/Steam/SteamShared/Source/SteamShared/Public/SteamSharedModule.h

Include

#include "SteamSharedModule.h"

Syntax

class FSteamSharedModule : public IModuleInterface

Constructors

Name Description

Public function

FSteamSharedModule()

Destructors

Name Description

Public function Virtual

~FSteamSharedModule()

Functions

Name Description

Public function Const

bool

 

AreSteamDllsLoaded()

Are the Steamworks Dlls loaded

Public function Const

bool

 

CanLoadClientDllsOnServer()

Checks if we can load client dlls on dedicated server instances.

Public function Static

FSteamShared ...

 

Get()

Singleton-like access to this module's interface.

Public function Const

FString

 

GetSteamModulePath()

The path to where the Steam binaries are stored, for use in debugging.

Public function Static

bool

 

IsAvailable()

Checks to see if this module is loaded and ready.

Public function Const

bool

 

IsLoadingServerClientDlls()

If the module will be loading the client dlls for the dedicated server instance.

Public function

TSharedPtr < ...

 

ObtainSteamClientInstanceHandle()

Initializes Steam Client API and provides a handler that will keep the API valid for the lifetime of the the object.

Public function

TSharedPtr < ...

 

ObtainSteamServerInstanceHandle()

Initializes Steam Server API and provides a handler that will keep the API valid for the lifetime of the the object.

Overridden from IModuleInterface

Name Description

Public function Virtual

void

 

ShutdownModule()

Called before the module is unloaded, right before the module object is destroyed.

Public function Virtual

void

 

StartupModule()

Called right after the module DLL has been loaded and the module object has been created Load dependent modules here, and they will be guaranteed to be available during ShutdownModule.

Public function Virtual

bool

 

SupportsDynamicReloading()

Due to the loading of the DLLs and how the Steamworks API is initialized, we cannot support dynamic reloading.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback