Navigation
API > API/Plugins > API/Plugins/SteamShared
| Name | FSteamSharedModule |
| Type | class |
| Header File | /Engine/Plugins/Runtime/Steam/SteamShared/Source/SteamShared/Public/SteamSharedModule.h |
| Include Path | #include "SteamSharedModule.h" |
Syntax
class FSteamSharedModule : public ISteamSharedModule
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSteamSharedModule() |
SteamSharedModule.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FSteamSharedModule() |
SteamSharedModule.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bForceLoadSteamClientDll | bool | If we force loaded the steamclient dlls due to launch flags | SteamSharedModule.h | |
| SteamClientObserver | TWeakPtr< class FSteamClientInstanceHandler > | Object that holds the refcounted pointer that's given out | SteamSharedModule.h | |
| SteamDLLHandle | void * | Handle to the STEAM API dll | SteamSharedModule.h | |
| SteamServerDLLHandle | void * | Handle to the STEAM dedicated server support dlls | SteamSharedModule.h | |
| SteamServerObserver | TWeakPtr< class FSteamServerInstanceHandler > | SteamSharedModule.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AreSteamDllsLoaded() |
Are the Steamworks Dlls loaded | SteamSharedModule.h | |
bool CanLoadClientDllsOnServer() |
Checks if we can load client dlls on dedicated server instances. | SteamSharedModule.h | |
FString GetSteamModulePath() |
The path to where the Steam binaries are stored, for use in debugging. | SteamSharedModule.h | |
bool IsLoadingServerClientDlls () |
If the module will be loading the client dlls for the dedicated server instance. | SteamSharedModule.h | |
TSharedPtr< class FSteamServerInstanceHandler > ObtainSteamServerInstanceHandle () |
Initializes Steam Server API and provides a handler that will keep the API valid for the lifetime of the the object. | SteamSharedModule.h | |
virtual void ShutdownModule() |
SteamSharedModule.h | ||
virtual void StartupModule() |
SteamSharedModule.h | ||
virtual bool SupportsDynamicReloading() |
Due to the loading of the DLLs and how the Steamworks API is initialized, we cannot support dynamic reloading. | SteamSharedModule.h |
Overridden from ISteamSharedModule
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TSharedPtr< class FSteamClientInstanceHandler > ObtainSteamClientInstanceHandle () |
Initializes Steam Client API and provides a handler that will keep the API valid for the lifetime of the the object. | SteamSharedModule.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FSteamSharedModule & Get () |
Singleton-like access to this module's interface. | SteamSharedModule.h | |
static bool IsAvailable () |
Checks to see if this module is loaded and ready. | SteamSharedModule.h |