ModioUGC API Reference

Classes

ModEnabledStateProvider

Inheritance Hierarchy

-> Interface-> Object

Request Mod Enabled State Change

bool RequestModEnabledStateChange(FGenericModID ID, bool bNewEnabledState)

Parameters

Target	ModEnabledStateProvider
ID	The raw ID for the mod to enable or disable
bNewEnabledState	the new state for the mod

Returns

true if the mod's state was successfully changed, else false

Query Is Mod Enabled

bool QueryIsModEnabled(FGenericModID ModID)

Parameters

Target	ModEnabledStateProvider
ModID	the raw ID for the mod to query

Returns

true if the mod is enabled, else false

---

UGCLibrary

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object

---

UGCPackageWrapper

Inheritance Hierarchy

-> Object

---

UGCProvider

Inheritance Hierarchy

-> Interface-> Object

Is Provider Enabled

bool IsProviderEnabled()

Parameters

Target	UGCProvider

Returns

bool indicating whether the UGC provider is enabled

Initialize Provider

void InitializeProvider(FOnUGCProviderInitializedDelegate Handler)

Parameters

Target	UGCProvider
Handler	Callback for initialization success.

Get Installed UGC Paths

FModUGCPathMap GetInstalledUGCPaths()

Parameters

Target	UGCProvider

Returns

A map of installed UGC paths to their IDs.

Deinitialize Provider

void DeinitializeProvider(FOnUGCProviderDeinitializedDelegate Handler)

Parameters

Target	UGCProvider
Handler	Callback for deinitialization success.

---

UGCSubsystem

Inheritance Hierarchy

-> EngineSubsystem-> DynamicSubsystem-> Subsystem-> Object

Unmount UGC Package By Mod ID

void UnmountUGCPackageByModID(FGenericModID ModID, bool bRemoveUGCPackage)

Parameters

Target	UGCSubsystem
ModID	the ID of the package to unmount
bRemoveUGCPackage	should the package be removed from the registry altogether after unmounting? pass true for uninstallation

Unmount UGC Package

void UnmountUGCPackage(FUGCPackage Package, bool bRemoveUGCPackage)

Parameters

Target	UGCSubsystem
Package
bRemoveUGCPackage	should the package be removed from the registry altogether after unmounting? pass true for uninstallation

Unload UGCBy Mod ID

bool UnloadUGCByModID(FGenericModID ModID)

Parameters

Target	UGCSubsystem
ModID	Mod ID of the mod to remove UGC for

Unload All UGC Packages

void UnloadAllUGCPackages()

Set UGC Provider

void SetUGCProvider(TScriptInterface<IUGCProvider> InUGCProvider)

Parameters

Target	UGCSubsystem
InUGCProvider	The UGC provider to use

Set UGC Enabled State Provider

void SetUGCEnabledStateProvider(TScriptInterface<IModEnabledStateProvider> NewProvider)

Parameters

Target	UGCSubsystem
NewProvider	The new object to query via IModEnabledStateProvider

Remove UGC Changed Handler

void RemoveUGCChangedHandler(FOnUGCPackagesChangedDelegate Handler)

Parameters

Target	UGCSubsystem
Handler	Delegate to remove

Remove Mod Enabled State Change Handler

void RemoveModEnabledStateChangeHandler(FModEnabledStateChangeHandler Handler)

Parameters

Target	UGCSubsystem
Handler	Delegate to be removed from the notification list

Refresh UGC

void RefreshUGC()

Enumerate All UGC Packages

void K2_EnumerateAllUGCPackages(FUGCPackageEnumeratorDelegate Enumerator) const

Parameters

Target	UGCSubsystem
Enumerator	The bound delegate to invoke

Is UGC Feature Enabled

bool IsUGCFeatureEnabled(EUGCSubsystemFeature Feature)

Parameters

Target	UGCSubsystem
Feature	The feature to query

Returns

bool indicating the state of the specified feature

Is UPlugin Compatible

bool IsUGCCompatible(FString UPluginFilePath)

Parameters

Target	UGCSubsystem
UPluginFilePath

Is Provider Enabled

bool IsProviderEnabled()

Parameters

Target	UGCSubsystem

Returns

bool indicating whether the UGC provider is enabled

Initialize UGCProvider

void InitializeUGCProvider(FOnUGCProviderInitializedDelegate Handler)

Parameters

Target	UGCSubsystem
Handler	Callback for initialization success.

Get UGC Package By Mod ID

bool GetUGCPackageByModID(FGenericModID ModID, FUGCPackage UGCPackage) const

Parameters

Target	UGCSubsystem
ModID	the ID of the mod to get the package for
UGCPackage	the package to populate with the UGC package data

Returns

true if the package was found, false otherwise

Get Package Names From UGC Package

TArray<FName> GetPackageNamesFromUGCPackage(FUGCPackage UGCPackage) const

Parameters

Target	UGCSubsystem
UGCPackage	The UGC package to get package names from

Returns

Array of package names

Deinitialize UGCProvider

void DeinitializeUGCProvider(FOnUGCProviderDeinitializedDelegate Handler)

Parameters

Target	UGCSubsystem
Handler	Callback for deinitialization success.

Add UGC From Path

void AddUGCFromPath(FString Path)

Parameters

Target	UGCSubsystem
Path	The path to the UGC package, such as "C:\Users\Public\mod.io\6532\mods\4119758". This path must contain a .uplugin file in the root directory, and .pak file in "Content/Paks/[PLATFORM]" directory

Add UGC Changed Handler

void AddUGCChangedHandler(FOnUGCPackagesChangedDelegate Handler)

Parameters

Target	UGCSubsystem
Handler	Delegate to invoke

Add Mod Enabled State Change Handler

void AddModEnabledStateChangeHandler(FModEnabledStateChangeHandler Handler)

Parameters

Target	UGCSubsystem
Handler	Delegate to be notified

Variables

FOnUGCPackagesChangedMulticastDelegate	OnUGCPackagesChanged
FOnModEnabledStateChangeMulticastDelegate	OnModEnabledStateChanged

---

UGC_Metadata

Inheritance Hierarchy

-> PrimaryDataAsset-> DataAsset-> Object

Variables

FString	UnrealVersion
bool	bIoStoreEnabled

---

Structs

GenericModID

Variables

int64	ModID

---

UGCPackage

---

ModUGCPathMap

Variables

TMap<FString,FGenericModID>	PathToModIDMap

---

Functions

GetModID (FUGCPackage)

bool GetModID(FUGCPackage UGCPackage, FGenericModID ModID)

---

Enums

EUGCPackageMountState

EUPMS_Unmounted
EUPMS_Mounted

---

EUGCSubsystemFeature

EUSF_ModEnableDisable
EUSF_Monetization
EUSF_ModDownvote

---