Skip to main content

Modio UGC API Reference

Classes​

ModEnabledStateProvider​

Inheritance Hierarchy​

-> Interface-> Object

Request Mod Enabled State Change​

nd_img_ModEnabledStateProvider_RequestModEnabledStateChange.png

bool RequestModEnabledStateChange(FGenericModID ID, bool bNewEnabledState)
Parameters​
TargetModEnabledStateProvider
IDThe raw ID for the mod to enable or disable
bNewEnabledStatethe new state for the mod
Returns​

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

Query Is Mod Enabled​

nd_img_ModEnabledStateProvider_QueryIsModEnabled.png

bool QueryIsModEnabled(FGenericModID ModID)
Parameters​
TargetModEnabledStateProvider
ModIDthe raw ID for the mod to query
Returns​

true if the mod is enabled, else false

MutatorSubsystem​

Inheritance Hierarchy​

-> GameInstanceSubsystem-> Subsystem-> Object

Register Mutator​

nd_img_MutatorSubsystem_RegisterMutator.png

bool RegisterMutator(TSubclassOf<UMutator> Type, int32 Priority, FMutatorHandle OutHandle)
Parameters​
TargetMutatorSubsystem
TypeThe class of mutator you want to register
PriorityDefines the order in which mutators are applied. Higher priority = more influence
Out HandleA handle to the create mutator

ScorePoints​

nd_img_MutatorSubsystem_Mutator_ScorePoints.png

FScorePoints_Params Mutator_ScorePoints(FScorePoints_Params Params)

PostPlayerInit​

nd_img_MutatorSubsystem_Mutator_PostPlayerInit.png

void Mutator_PostPlayerInit(FPostPlayerInit_Params Params)

PostPawnSpawned​

nd_img_MutatorSubsystem_Mutator_PostPawnSpawned.png

void Mutator_PostPawnSpawned(FPostPawnSpawned_Params Params)

ModifyDamage​

nd_img_MutatorSubsystem_Mutator_ModifyDamage.png

FModifyDamage_Params Mutator_ModifyDamage(FModifyDamage_Params Params)

EnemyWaveEnded​

nd_img_MutatorSubsystem_Mutator_EnemyWaveEnded.png

void Mutator_EnemyWaveEnded(FEnemyWaveEnded_Params Params)

Is Registered​

nd_img_MutatorSubsystem_IsRegistered.png

bool IsRegistered(TSubclassOf<UMutator> Type)
Parameters​
TargetMutatorSubsystem
Typethe type of mutator to check for

Get Mutator Class List​

nd_img_MutatorSubsystem_GetMutatorClassList.png

bool GetMutatorClassList(TArray<TSubclassOf<UMutator> > OutMutators, bool bUseCache)
Parameters​
TargetMutatorSubsystem
bUseCachewhether or not we should return the cached result or rerun the query
Out Mutatorsthe mutator class list
Returns​

Was the query successful

Get Asset​

nd_img_MutatorSubsystem_GetAsset.png

UObject* GetAsset(FGameplayTag AssetTag, UObject* DefaultValue) const
Parameters​
TargetMutatorSubsystem
AssetTagThe tag of the asset to retrieve
DefaultValueThe asset to use if no mutator is overriding it

Deregister Mutator​

nd_img_MutatorSubsystem_DeregisterMutator.png

void DeregisterMutator(FMutatorHandle Handle)
Parameters​
TargetMutatorSubsystem
Handle

UGCLibrary​

Inheritance Hierarchy​

-> BlueprintFunctionLibrary-> Object

UGCPackageWrapper​

Inheritance Hierarchy​

-> Object

UGCProvider​

Inheritance Hierarchy​

-> Interface-> Object

Is Provider Enabled​

nd_img_UGCProvider_IsProviderEnabled.png

bool IsProviderEnabled()
Parameters​
TargetUGCProvider
Returns​

bool indicating whether the UGC provider is enabled

Initialize Provider​

nd_img_UGCProvider_InitializeProvider.png

void InitializeProvider(FOnUGCProviderInitializedDelegate Handler)
Parameters​
TargetUGCProvider
HandlerCallback for initialization success.

Get Installed UGC Paths​

nd_img_UGCProvider_GetInstalledUGCPaths.png

FModUGCPathMap GetInstalledUGCPaths()
Parameters​
TargetUGCProvider
Returns​

A map of installed UGC paths to their IDs.

Deinitialize Provider​

nd_img_UGCProvider_DeinitializeProvider.png

void DeinitializeProvider(FOnUGCProviderDeinitializedDelegate Handler)
Parameters​
TargetUGCProvider
HandlerCallback for deinitialization success.

UGCSubsystem​

Inheritance Hierarchy​

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

Unmount UGC Package By Mod ID​

nd_img_UGCSubsystem_UnmountUGCPackageByModID.png

void UnmountUGCPackageByModID(FGenericModID ModID, bool bRemoveUGCPackage)
Parameters​
TargetUGCSubsystem
ModIDthe ID of the package to unmount
bRemoveUGCPackageshould the package be removed from the registry altogether after unmounting? pass true for uninstallation

Unmount UGC Package​

nd_img_UGCSubsystem_UnmountUGCPackage.png

void UnmountUGCPackage(FUGCPackage Package, bool bRemoveUGCPackage)
Parameters​
TargetUGCSubsystem
Package
bRemoveUGCPackageshould the package be removed from the registry altogether after unmounting? pass true for uninstallation

Unload UGCBy Mod ID​

nd_img_UGCSubsystem_UnloadUGCByModID.png

bool UnloadUGCByModID(FGenericModID ModID)
Parameters​
TargetUGCSubsystem
ModIDMod ID of the mod to remove UGC for

Unload All UGC Packages​

nd_img_UGCSubsystem_UnloadAllUGCPackages.png

void UnloadAllUGCPackages()

Set UGC Provider​

nd_img_UGCSubsystem_SetUGCProvider.png

void SetUGCProvider(TScriptInterface<IUGCProvider> InUGCProvider)
Parameters​
TargetUGCSubsystem
InUGCProviderThe UGC provider to use

Set UGC Enabled State Provider​

nd_img_UGCSubsystem_SetUGCEnabledStateProvider.png

void SetUGCEnabledStateProvider(TScriptInterface<IModEnabledStateProvider> NewProvider)
Parameters​
TargetUGCSubsystem
NewProviderThe new object to query via IModEnabledStateProvider

Remove UGC Changed Handler​

nd_img_UGCSubsystem_RemoveUGCChangedHandler.png

void RemoveUGCChangedHandler(FOnUGCPackagesChangedDelegate Handler)
Parameters​
TargetUGCSubsystem
HandlerDelegate to remove

Remove Mod Enabled State Change Handler​

nd_img_UGCSubsystem_RemoveModEnabledStateChangeHandler.png

void RemoveModEnabledStateChangeHandler(FModEnabledStateChangeHandler Handler)
Parameters​
TargetUGCSubsystem
HandlerDelegate to be removed from the notification list

Refresh UGC​

nd_img_UGCSubsystem_RefreshUGC.png

void RefreshUGC()

Enumerate All UGC Packages​

nd_img_UGCSubsystem_K2_EnumerateAllUGCPackages.png

void K2_EnumerateAllUGCPackages(FUGCPackageEnumeratorDelegate Enumerator) const
Parameters​
TargetUGCSubsystem
EnumeratorThe bound delegate to invoke

Is UGC Feature Enabled​

nd_img_UGCSubsystem_IsUGCFeatureEnabled.png

bool IsUGCFeatureEnabled(EUGCSubsystemFeature Feature)
Parameters​
TargetUGCSubsystem
FeatureThe feature to query
Returns​

bool indicating the state of the specified feature

Is UPlugin Compatible​

nd_img_UGCSubsystem_IsUGCCompatible.png

bool IsUGCCompatible(FString UPluginFilePath)
Parameters​
TargetUGCSubsystem
UPluginFilePath

Is Provider Enabled​

nd_img_UGCSubsystem_IsProviderEnabled.png

bool IsProviderEnabled()
Parameters​
TargetUGCSubsystem
Returns​

bool indicating whether the UGC provider is enabled

Initialize UGCProvider​

nd_img_UGCSubsystem_InitializeUGCProvider.png

void InitializeUGCProvider(FOnUGCProviderInitializedDelegate Handler)
Parameters​
TargetUGCSubsystem
HandlerCallback for initialization success.

Get UGC Package By Mod ID​

nd_img_UGCSubsystem_GetUGCPackageByModID.png

bool GetUGCPackageByModID(FGenericModID ModID, FUGCPackage UGCPackage) const
Parameters​
TargetUGCSubsystem
ModIDthe ID of the mod to get the package for
UGCPackagethe package to populate with the UGC package data
Returns​

true if the package was found, false otherwise

Get Package Names From UGC Package​

nd_img_UGCSubsystem_GetPackageNamesFromUGCPackage.png

TArray<FName> GetPackageNamesFromUGCPackage(FUGCPackage UGCPackage) const
Parameters​
TargetUGCSubsystem
UGCPackageThe UGC package to get package names from
Returns​

Array of package names

Deinitialize UGCProvider​

nd_img_UGCSubsystem_DeinitializeUGCProvider.png

void DeinitializeUGCProvider(FOnUGCProviderDeinitializedDelegate Handler)
Parameters​
TargetUGCSubsystem
HandlerCallback for deinitialization success.

Add UGC From Path​

nd_img_UGCSubsystem_AddUGCFromPath.png

void AddUGCFromPath(FString Path)
Parameters​
TargetUGCSubsystem
PathThe 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​

nd_img_UGCSubsystem_AddUGCChangedHandler.png

void AddUGCChangedHandler(FOnUGCPackagesChangedDelegate Handler)
Parameters​
TargetUGCSubsystem
HandlerDelegate to invoke

Add Mod Enabled State Change Handler​

nd_img_UGCSubsystem_AddModEnabledStateChangeHandler.png

void AddModEnabledStateChangeHandler(FModEnabledStateChangeHandler Handler)
Parameters​
TargetUGCSubsystem
HandlerDelegate to be notified
Variables​
FOnUGCPackagesChangedMulticastDelegateOnUGCPackagesChanged
FOnModEnabledStateChangeMulticastDelegateOnModEnabledStateChanged

UGC_Metadata​

Inheritance Hierarchy​

-> PrimaryDataAsset-> DataAsset-> Object

Variables​
FStringUnrealVersion
boolbIoStoreEnabled

Structs​

EnemyWaveEnded_Params​

Variables​
int32WaveNumber

ModifyDamage_Params​

Variables​
AActor*Target
AActor*Source
floatAmount

PostPawnSpawned_Params​

Variables​
APawn*Pawn

PostPlayerInit_Params​

Variables​
AController*Controller

ScorePoints_Params​

Variables​
AController*Scorer
int32Amount

GenericModID​

Variables​
int64ModID

UGCPackage​

MutatorHandle​

MutatorPriorityBucket​

ModUGCPathMap​

Variables​
TMap<FString,FGenericModID>PathToModIDMap

Functions​

GetModID (FUGCPackage)​

nd_img_UGCLibrary_GetModID.png

bool GetModID(FUGCPackage UGCPackage, FGenericModID ModID)

Enums​

EUGCPackageMountState​

EUPMS_Unmounted
EUPMS_Mounted

EUGCSubsystemFeature​

EUSF_ModEnableDisable
EUSF_Monetization
EUSF_ModDownvote