Unreal Plugin API Reference

Classes

ModioCommonTypesLibrary

Utility functions for working with mod.io types

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object

ModioCreateModLibrary

Utility functions for creating mod and mod file parameters

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object

ModioErrorCodeLibrary

Utility functions for working with error codes

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object

ModioErrorConditionLibrary

Utility functions for checking error conditions

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object

ModioExampleLibrary

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object

ModioImageLibrary

Utility functions for loading and managing images

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object

ModioModCollectionInfoListLibrary

Utility functions for accessing and managing lists of mod information

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object

ModioModCollectionLibrary

Utility functions for accessing and managing mod collection data

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object

ModioModDependenciesLibrary

Utility functions for accessing and managing mod dependencies

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object

ModioModInfoListLibrary

Utility functions for accessing and managing lists of mod information

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object

ModioModProgressInfoLibrary

Utility functions for accessing and managing mod operation progress

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object

ModioModTagOptionsLibrary

Utility functions for accessing and managing mod tag options

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object

ModioMultiplayerSubsystem

ModioMultiplayerSubsystem is a thin wrapper around the mod.io Multiplayer SDK Library, wrapping all the functions available in the SDK's public header modio/detail/ModioSDKMultiplayerLibrary.h. This subsystem also converts mod.io Multiplayer SDK types to unreal-friendly types and caches some expensive operations.

Inheritance Hierarchy

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

Experimental Feature

This class is part of an experimental feature and is subject to change.

RegisterClientModsWithServerAsync

Adds the provided Mods to the Server's list of client mods. Intended to be called on the server. Once complete it is expected to propagate the server's list of client mods back to all clients to ensure syncronization

Experimental Feature

This function is part of an experimental feature and is subject to change.

nd_img_ModioMultiplayerSubsystem_K2_RegisterClientModsWithServerAsync.png

void K2_RegisterClientModsWithServerAsync(TArray<FModioModID> ModIDs, FAddClientModsDelegate Callback)

Parameters


`Target`	`ModioMultiplayerSubsystem`
`ModIDs`	a list of mods that the joining client has
`Callback`	callback upon completion of adding the mods to the Server's list.

Error Values


NetworkError	Couldn't connect to the mod.io servers

InstallOrUpdateServerModsAsync

Gets and/or updates all of the indicated mods for this server, assuming you have provided a valid S2S token. Is called automatically by InitialalizeModioServerAsync() depending on UpdateModsOnInit state.

Experimental Feature

This function is part of an experimental feature and is subject to change.

nd_img_ModioMultiplayerSubsystem_K2_InstallOrUpdateServerModsAsync.png

void K2_InstallOrUpdateServerModsAsync(TArray<FModioModID> Mods, FOnErrorOnlyDelegate Callback)

Parameters


`Target`	`ModioMultiplayerSubsystem`
`Mods`	the mods to get or update
`Callback`	callback executed upon completion of all mods

InitializeServerAsync

Initializes the SDK in the context of a dedicated server. Loads the state of all mods installed on the system. Loads or gets all mods indicated in the initialization param, optionally updating to the latest versions.

Experimental Feature

This function is part of an experimental feature and is subject to change.

nd_img_ModioMultiplayerSubsystem_K2_InitializeServerAsync.png

void K2_InitializeServerAsync(FModioServerInitializeOptions ServerOptions, FOnErrorOnlyDelegate OnInitComplete)

Parameters


`Target`	`ModioMultiplayerSubsystem`
`ServerOptions`
`On Init Complete`

Error Values


`NetworkError`	Couldn't connect to mod.io servers
`FilesystemError`	Couldn't create the user data or common data folders
`ConfigurationError`	`InitializeOptions` contains an invalid value. Inspect `ec.value()` to determine what was incorrect
`SDKAlreadyInitialized`	SDK already initialized

GetRegisteredClientMods

Returns the full list of mods that have been registered with the server via AddClientModsToServerAsync

Experimental Feature

This function is part of an experimental feature and is subject to change.

nd_img_ModioMultiplayerSubsystem_K2_GetRegisteredClientMods.png

TSet<FModioModID> K2_GetRegisteredClientMods()

Parameters


`Target`	`ModioMultiplayerSubsystem`

Returns

A TSet of ModIDs representing the Mods registered with the server.

ClearRegisteredClientMods

Clears the server's list of client mods. Intended only to be called when the Server can safely flush its list of client mods, if you want to minimize the number of mods you send to clients/remove mods no longer needed.

Experimental Feature

This function is part of an experimental feature and is subject to change.

nd_img_ModioMultiplayerSubsystem_K2_ClearRegisteredClientMods.png

void K2_ClearRegisteredClientMods()

Parameters


`Target`	`ModioMultiplayerSubsystem`

ModioPlatformHelpersLibrary

Blueprint library which contains a variety of Platform-based helpers for mapping initialization functionality (ie Auth, Portal, Platform etc) based off Platform.

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object

ModioPortalInterface

Interface for objects that provide portal/platform specific implementations

Inheritance Hierarchy

-> Interface-> Object

Should Show SKUInformation

bool ShouldShowSKUInformation()

Parameters


`Target`	`ModioPortalInterface`

Returns

true if the UI should show SKU information, false otherwise

Sanitize File Path

FString SanitizeFilePath(FString FilePath)

Request Store Purchase

bool RequestStorePurchase(FString SKU, FStorePurchaseDelegate Callback)

Request SKUMappings

void RequestSKUMappings(FSKUMappingsRequestedDelegate Callback)

Request Open Store

EModioOpenStoreResult RequestOpenStore(FString SKU, FStoreClosedDelegate Callback)

Request Entitlement Params

void RequestEntitlementParams(TMap<FString,FString> Params, FEntitlementParamsRequestedDelegate Callback)

Parameters


`Target`	`ModioPortalInterface`
`Params`	can provide additional parameters for login
`Callback`	will be called with the entitlement parameters

Request Auth Token

void RequestAuthToken(TMap<FString,FString> Params, FAuthTokenRequestedDelegate Callback)

Parameters


`Target`	`ModioPortalInterface`
`Params`	can provide additional parameters for login
`Callback`	will be called with the auth token

Prepare Filesystem to Use Path

bool PrepareFilesystemToUsePath(FString UgcPath)

Notify Store Browsing

void NotifyStoreBrowsing(bool bEnabled)

Parameters


`Target`	`ModioPortalInterface`
`bEnabled`	whether the store is being browsed or not

Initialize Platform

void InitializePlatform()

Get Extended Initialization Params

TMap<FString,FString> GetExtendedInitializationParams()

Get Extended Auth Params

TMap<FString,FString> GetExtendedAuthParams()

ModioPresetFilterParamsLibrary

Blueprint library for working with preset filter parameters

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object

ModioReportLibrary

Utility library for creating content reports within the mod.io platform. This class contains methods for reporting various types of content (e.g., game, user, or mod).

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object

ModioSDKLibrary

A utility class providing various helper functions for mod.io SDK integration in Unreal Engine.

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object

ModioStorageInfoLibrary

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object

ModioSubmissionExtensionLibrary

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object

SubmitModChangesAsync

Edits the parameters of a mod, by updating any fields set in the Params object to match the passed-in values. Fields left empty on the Params object will not be updated. This method also accepts a Png binary file for uploading a new logo.

nd_img_ModioSubmissionExtensionLibrary_K2_SubmitModChangesFromMemoryAsync.png

void K2_SubmitModChangesFromMemoryAsync(FModioModID Mod, FModioEditModParams Params, TArray<uint8> PngData, FOnGetModInfoDelegate Callback)

Requirements

initialized-sdk
authenticated-user
no-rate-limiting

Parameters


`Target`	`ModioSubmissionExtensionLibrary`
`Mod`	The ID of the mod you wish to edit
`Params`	Descriptor containing the fields that should be altered.
`PngData`
`Callback`	The callback invoked when the changes have been submitted, containing an optional updated ModInfo object if the edits were performed successfully

Error Values


GenericError::SDKNotInitialized	SDK not initialized
UserDataError::InvalidUser	No authenticated user
NetworkError	Couldn't connect to mod.io servers
InvalidArgsError	Some fields in Params did not pass validation

ModioSubsystem

ModioSubsystem is a thin wrapper around the mod.io SDK, wrapping all the functions available in the SDK's public header modio/ModioSDK.h. This subsystem also converts mod.io SDK types to unreal-friendly types and caches some expensive operations.

Inheritance Hierarchy

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

Set Log Level

Sets the global logging level.

void SetLogLevel(EModioLogLevel UnrealLogLevel)

Parameters


`Target`	`ModioSubsystem`
`UnrealLogLevel`	Determines which messages to include in the log output. Messages with a log level below the specified value will not be displayed.

Run Pending Handlers

Runs any pending mod.io work on the calling thread and invokes any callbacks passed to asynchronous operations.

void RunPendingHandlers()

Parameters


`Target`	`ModioSubsystem`

Query User Subscriptions

Fetches the local view of the user's subscribed mods, including mods that are subscribed but not yet installed

TMap<FModioModID,FModioModCollectionEntry> QueryUserSubscriptions()

Parameters


`Target`	`ModioSubsystem`

Returns

TMap<FModioModID, FModioModCollectionEntry> providing information about the subscribed mods

Query User Purchased Mods

Returns the user's purchased mods. FetchUserPurchasesAsync must be called first to populate the cache.

TMap<FModioModID,FModioModInfo> QueryUserPurchasedMods()

Requirements

initialized-sdk
authenticated-user
no-rate-limiting

Parameters


`Target`	`ModioSubsystem`

Returns

A TMap<FModioModID, FModioModInfo> of all purchases a user has made.

Query User Installations

Fetches the subset of the user's subscribed mods that are installed and ready for loading

TMap<FModioModID,FModioModCollectionEntry> QueryUserInstallations(bool bIncludeOutdatedMods)

Parameters


`Target`	`ModioSubsystem`
`bIncludeOutdatedMods`	Include subscribed mods that are installed but have an updated version on the server that has not yet been installed

Returns

TMap<FModioModID, FModioModCollectionEntry> providing information about the subscribed mods

Query System Installations

Fetches all mods installed on the system, including those installed by other users.

TMap<FModioModID,FModioModCollectionEntry> QuerySystemInstallations()

Parameters


`Target`	`ModioSubsystem`

Returns

A TMap<FModioModID, FModioModCollectionEntry> of all mods installed on the system, including those installed by other users.

Prioritize Transfer for Mod

Cancels or suspends the current mod update, installation, or upload, and begins processing a pending operation for the specified mod ID

FModioErrorCode PrioritizeTransferForMod(FModioModID ModToPrioritize)

Requirements

initialized-sdk
authenticated-user

Parameters


`Target`	`ModioSubsystem`
`ModToPrioritize`	The ID for the mod to prioritize

Returns

Error code indicating the status of the prioritization request. Will be empty if the prioritization was successful or if the mod was already being processed

Error Values


`InvalidArgsError`	The supplied mod ID is invalid or not present in the list of pending operations

Kill Background Thread

Kills the background thread if it is running

void KillBackgroundThread()

Parameters


`Target`	`ModioSubsystem`

VerifyUserAuthenticationAsync

Queries the server to verify the state of the currently authenticated user if there is one present

void K2_VerifyUserAuthenticationAsync(FOnErrorOnlyDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting
authenticated-user

Parameters


`Target`	`ModioSubsystem`
`Callback`	Callback invoked with the results of the verification process. An empty `ModioErrorCode` indicates successful verification i.e. the mod.io server was contactable and the user's authentication remains valid.

Error Values


`NetworkError`	Couldn't connect to mod.io servers
`SDKNotInitialized`	SDK not initialized
`UserNotAuthenticatedError`	No authenticated user

UnsubscribeFromModCollectionAsync

Sends a request to the mod.io server to remove the specified mod collection to the user's list of subscriptions.

void K2_UnsubscribeFromModCollectionAsync(FModioModCollectionID ModCollectionToUnsubscribeFrom, FOnErrorOnlyDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting
authenticated-user
management-enabled

Parameters


`Target`	`ModioSubsystem`
`ModCollectionToUnsubscribeFrom`	Mod Collection ID of the mod collection requiring unsubscription.
`Callback`	Callback providing a status code to indicate if the unsubscription was successful.

Error Values


NetworkError	Couldn't connect to mod.io servers
EntityNotFoundError	Specified mod collection does not exist or was deleted

UnsubscribeFromModAsync

Sends a request to the mod.io server to remove the specified mod from the user's list of subscriptions. If no other local users are subscribed to the specified mod this function will also mark the mod for uninstallation by the SDK.

void K2_UnsubscribeFromModAsync(FModioModID ModToUnsubscribeFrom, FOnErrorOnlyDelegate OnUnsubscribeComplete)

Requirements

initialized-sdk
authenticated-user
no-rate-limiting

Parameters


`Target`	`ModioSubsystem`
`ModToUnsubscribeFrom`	Mod ID of the mod requiring unsubscription.
`On Unsubscribe Complete`	Callback invoked when the unsubscription request is completed.

Error Values


`NetworkError`	Couldn't connect to mod.io servers
`SDKNotInitialized`	SDK not initialized
`EntityNotFoundError`	Specified mod does not exist or was deleted
`UserNotAuthenticatedError`	No authenticated user
`InvalidArgsError`	The supplied mod ID is invalid

UnmuteUserAsync

Unmute a user. This allows mod.io to display mods authored by the now unmuted user when performing searches.

void K2_UnmuteUserAsync(FModioUserID UserID, FOnErrorOnlyDelegate Callback)

Requirements

authenticated-user
initialized-sdk

Parameters


`Target`	`ModioSubsystem`
`UserID`	ID of the user to unmute
`Callback`	Callback providing a status code indicating success or failure of unmuting the user.

Error Values


`SDKNotInitialized`	SDK not initialized
`UserNotAuthenticatedError`	No authenticated user
`InvalidArgsError`	The supplied user ID is invalid

UnfollowUserAsync

Unfollows the given user for the currently authenticated user.

void K2_UnfollowUserAsync(FModioUserID UserId, FOnErrorOnlyDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting
user-authenticated

Parameters


`Target`	`ModioSubsystem`
`UserId`	The UserID of the user that should be unfollowed.
`Callback`	a callback invoked upon completion, indicating if the request was successful.

Error Values


GenericError::SDKNotInitialized	SDK not initialized
UserDataError::InvalidUser	User not authenticated
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
NetworkError	Couldn't connect to mod.io servers

UnfollowModCollectionAsync

Sends a request to the mod.io server to remove the specified mod collection to the user's list of followed collections.

void K2_UnfollowModCollectionAsync(FModioModCollectionID ModCollectionToUnfollow, FOnErrorOnlyDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting
authenticated-user
management-enabled
mod-not-pending-uninstall

Parameters


`Target`	`ModioSubsystem`
`ModCollectionToUnfollow`	Mod Collection ID of the mod collection to unfollow.
`Callback`	Callback invoked when the unfollow request is completed.

Error Values


NetworkError	Couldn't connect to mod.io servers
EntityNotFoundError	Specified mod collection does not exist or was deleted

SubscribeToModCollectionAsync

Sends a request to the mod.io server to add the specified mod collection to the user's list of subscriptions.

void K2_SubscribeToModCollectionAsync(FModioModCollectionID ModCollectionToSubscribeTo, FOnErrorOnlyDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting
authenticated-user
management-enabled
mod-not-pending-uninstall

Parameters


`Target`	`ModioSubsystem`
`ModCollectionToSubscribeTo`	Mod Collection ID of the mod collection requiring a subscription.
`Callback`	Callback providing a status code to indicate if the subscription was successful.

Error Values


NetworkError	Couldn't connect to mod.io servers
EntityNotFoundError	Specified mod collection does not exist or was deleted

SubscribeToModAsync

Sends a request to the mod.io server to add the specified mod to the user's list of subscriptions, and marks the mod for local installation by the SDK

void K2_SubscribeToModAsync(FModioModID ModToSubscribeTo, bool IncludeDependencies, FOnErrorOnlyDelegate OnSubscribeComplete)

Requirements

initialized-sdk
authenticated-user
no-rate-limiting

Parameters


`Target`	`ModioSubsystem`
`ModToSubscribeTo`	Mod ID of the mod requiring a subscription.
`IncludeDependencies`	Subscribe to all dependencies as well.
`On Subscribe Complete`	Callback invoked when the subscription request is completed.

Error Values


`NetworkError`	Couldn't connect to mod.io servers
`SDKNotInitialized`	SDK not initialized
`EntityNotFoundError`	Specified mod does not exist or was deleted
`UserNotAuthenticatedError`	No authenticated user
`InvalidArgsError`	The supplied mod ID is invalid

SubmitNewSourceFileForMod

Queues the upload of source files for a modfile to defined platforms. This function takes a Modio::CreateSourceFileParams struct that defines the options needed to upload the source files. The files present in the root folder defined in the params will be compressed to a .zip archive and uploaded.

void K2_SubmitNewSourceFileForMod(FModioModID Mod, FModioCreateSourceFileParams Params)

Requirements

initialized-sdk
no-rate-limiting
authenticated-user
management-enabled

Parameters


`Target`	`ModioSubsystem`
`Mod`	The mod to upload source files for
`Params`	Descriptor containing information regarding the modfile

Error Values


GenericError::BadParameter	The supplied mod ID is invalid

SubmitNewModFileForMod

Queues the upload of a new modfile release for the specified mod using the submitted parameters. This function takes an ModioCreateModFileParams object to specify the path to the root folder of the new modfile. The plugin will compress the folder's contents into a .zip archive and queue the result for upload. When the upload completes, a mod management event will be triggered. Note the plugin is also responsible for decompressing the archive upon its installation at a later point in time.

Experimental Feature

This function is part of an experimental feature and is subject to change.

nd_img_ModioSubsystem_K2_SubmitNewModFileForMod.png

void K2_SubmitNewModFileForMod(FModioModID Mod, FModioCreateModFileParams Params)

Requirements

initialized-sdk
authenticated-user
no-rate-limiting

Parameters


`Target`	`ModioSubsystem`
`Mod`	The ID of the mod you are submitting a file for
`Params`	Information about the mod file being created, including the root path of the directory that will be archived

Error Values


`UserNotAuthenticatedError`	No authenticated user
`InvalidArgsError`	The supplied mod ID is invalid

SubmitNewModAsync

Requests the creation of a new mod on the server with the specified parameters

Experimental Feature

This function is part of an experimental feature and is subject to change.

nd_img_ModioSubsystem_K2_SubmitNewModAsync.png

void K2_SubmitNewModAsync(FModioModCreationHandle Handle, FModioCreateModParams Params, FOnSubmitNewModDelegate Callback)

Requirements

initialized-sdk
authenticated-user
no-rate-limiting

Parameters


`Target`	`ModioSubsystem`
`Handle`	The `ModioModCreationHandle` for this submission. Once this method invokes your callback indicating success, the `ModioModCreationHandle` is invalid for the rest of the session. You should request a new one for the next submission attempt.
`Params`	Information about the new mod to create
`Callback`	Callback providing a status code and an optional `ModioModID` for the newly created mod

Error Values


`NetworkError`	Couldn't connect to mod.io servers
`SDKNotInitialized`	SDK not initialized
`InvalidArgsError`	Some fields in `Params` did not pass validation
`UserNotAuthenticatedError`	No authenticated user

SubmitModRatingAsync

Submits a rating for a mod on behalf of the current user. Submit a neutral rating to effectively clear a rating already submitted by a user. Submitting other values will overwrite any existing rating submitted by this user.

void K2_SubmitModRatingAsync(FModioModID Mod, EModioRating Rating, FOnErrorOnlyDelegate Callback)

Requirements

initialized-sdk
authenticated-user
no-rate-limiting

Parameters


`Target`	`ModioSubsystem`
`Mod`	The mod the user is rating
`Rating`	The rating the user wishes to submit
`Callback`	Callback providing a status code indicating success or failure of the rating submission

Error Values


`NetworkError`	Couldn't connect to mod.io servers
`SDKNotInitialized`	SDK not initialized
`EntityNotFoundError`	Specified mod does not exist or was deleted
`UserNotAuthenticatedError`	No authenticated user
`InvalidArgsError`	The supplied mod ID is invalid

SubmitModCollectionRatingAsync

Submits a rating for a mod collection on behalf of the current user. Submit a neutral rating to effectively clear a rating already submitted by a user. Submitting other values will overwrite any existing rating submitted by this user.

void K2_SubmitModCollectionRatingAsync(FModioModCollectionID ModCollectionId, EModioRating Rating, FOnErrorOnlyDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting
authenticated-user

Parameters


`Target`	`ModioSubsystem`
`ModCollectionId`	The mod collection the user is rating
`Rating`	The rating the user wishes to submit
`Callback`	Callback providing a status code indicating success or failure of the rating submission

Error Values


NetworkError	Couldn't connect to mod.io servers
EntityNotFoundError	Specified mod collection does not exist or was deleted

SubmitModChangesAsync

Edits the parameters of a mod by updating any fields set in the Params object to match the passed-in values. Fields left empty on the Params object will not be updated.

void K2_SubmitModChangesAsync(FModioModID Mod, FModioEditModParams Params, FOnGetModInfoDelegate Callback)

Requirements

initialized-sdk
authenticated-user
no-rate-limiting

Parameters


`Target`	`ModioSubsystem`
`Mod`	The ID of the mod you wish to edit
`Params`	Descriptor containing the fields that should be altered.
`Callback`	The callback invoked when the changes have been submitted containing an optional updated `ModioModInfo` object if the edits were performed successfully

Error Values


`NetworkError`	Couldn't connect to mod.io servers
`SDKNotInitialized`	SDK not initialized
`InvalidArgsError`	Some fields in `Params` did not pass validation
`UserNotAuthenticatedError`	No authenticated user
`InvalidArgsError`	The supplied mod ID is invalid

ShutdownAsync

Cancels any running internal operations, frees SDK resources, and invokes any pending callbacks with an OperationCanceled error category. This function will NOT block while the deinitialization occurs.

void K2_ShutdownAsync(FOnErrorOnlyDelegate OnShutdownComplete)

Parameters


`Target`	`ModioSubsystem`
`On Shutdown Complete`	Callback invoked when the plugin is shut down and calling `RunPendingHandlers` is no longer required

SetLanguage

Set language to get corresponding data from the server

void K2_SetLanguage(EModioLanguage Locale)

Parameters


`Target`	`ModioSubsystem`
`Locale`	Language to set

RequestEmailAuthCodeAsync

Begins email authentication for the current session by requesting a one-time code be sent to the specified email address.

void K2_RequestEmailAuthCodeAsync(FModioEmailAddress EmailAddress, FOnErrorOnlyDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting
no-authenticated-user

Parameters


`Target`	`ModioSubsystem`
`EmailAddress`	The email address to send the code to
`Callback`	Callback providing a status code indicating the outcome of the request

Error Values


`NetworkError`	Couldn't connect to mod.io servers
`SDKNotInitialized`	SDK not initialized
`UserAlreadyAuthenticatedError`	Current user is already authenticated. De-authenticate the current user with `ClearUserDataAsync`, and re-initialize the SDK by calling `ShutdownAsync` then `InitializeAsync`.

ReportContentAsync

Sends a content report to mod.io. When using this function, please inform your users that if they provide their contact name or details in the Report parameter, this data may be shared with the person responsible for the content being reported. For more information on what data in a report will be shared with whom, please see our website's report form.

void K2_ReportContentAsync(FModioReportParams Report, FOnErrorOnlyDelegate Callback)

Requirements

initialized-sdk

Parameters


`Target`	`ModioSubsystem`
`Report`	Information about the content being reported and a description of the report.
`Callback`	Callback providing a status code to indicate successful submission of the report.

Error Values


`NetworkError`	Couldn't connect to mod.io servers
`InvalidArgsError`	Required information in the report did not pass validation
`InvalidArgsError`	The mod ID, game ID, or user ID supplied to `Report` is invalid

RemoveFromTempModSet

Remove mods from a temp mod set. Every temp mod specified by ModIds will be uninstalled unless the user is already subscribed.

FModioErrorCode K2_RemoveFromTempModSet(TArray<FModioModID> ModIds)

Requirements

initialized-sdk
mod-management-enabled
temp-mod-set-initialized

Parameters


`Target`	`ModioSubsystem`
`ModIds`	TArray of `ModioModID`s to remove as temp mods

Returns

Error code indicating the status of the TempModSet. Will be empty if it was successful

Error Values


`SDKNotInitialized`	SDK not initialized
`ModManagementDisabled`	Mod management not enabled
`TempModSetNotInitialized`	`TempModSet` not initialized

RefreshUserEntitlementsAsync

Requests mod.io refresh the available entitlements for the current user purchased through the portal and currently authenticated.

void K2_RefreshUserEntitlementsAsync(FModioEntitlementParams Params, FOnRefreshUserEntitlementsDelegate Callback)

Requirements

initialized-sdk
authenticated-user
no-rate-limiting

Parameters


`Target`	`ModioSubsystem`
`Params`	Additional parameters.
`Callback`	Callback providing an error code indicating success or failure of the refresh operation.

QueryUserProfile

Fetches the currently authenticated mod.io user profile if there is one

FModioOptionalUser K2_QueryUserProfile()

Parameters


`Target`	`ModioSubsystem`

Returns

ModioOptionalUser object containing profile information

QueryTempModSet

Query every system and temp mod in TempModSet

TMap<FModioModID,FModioModCollectionEntry> K2_QueryTempModSet()

Parameters


`Target`	`ModioSubsystem`

Returns

TMap using ModioModID as keys and ModioModCollectionEntry objects providing information about mods in TempModSet

QueryStorageInfo

Fetches storage related information, including total availability and how much is being consumed by mod installations.

FModioStorageInfo K2_QueryStorageInfo()

Parameters


`Target`	`ModioSubsystem`

Returns

An FModioStorageInfo structure containing storage information

QueryCurrentModUpdate

Provides progress information for a mod installation or update operation if one is currently in progress.

FModioOptionalModProgressInfo K2_QueryCurrentModUpdate()

Parameters


`Target`	`ModioSubsystem`

Returns

ModioOptionalModProgressInfo object containing information regarding the progress of the installation operation.

PurchaseModWithEntitlementAsync

Attempts to purchase a specified mod by consuming an existing, un-consumed entitlement that the user has from the current portal. Purchasing a mod will add a subscription to it. If the user does not have an existing entitlement, the purchase will fail. It is recommended to call GetAvailableUserEntitlementsAsync to query if the current user has an available entitlement prior to this call.

void K2_PurchaseModWithEntitlementAsync(FModioModID ModID, FModioEntitlementParams EntitlementParams, FOnPurchaseModDelegate Callback)

Requirements

initialized-sdk
authenticated-user
no-rate-limiting

Parameters


`Target`	`ModioSubsystem`
`ModID`	ID of the mod to purchase
`EntitlementParams`	Portal-specific additional parameters
`Callback`	Callback invoked with purchase information once the purchase is completed.

PurchaseModAsync

Purchases a mod for the current player

void K2_PurchaseModAsync(FModioModID ModID, FModioUnsigned64 ExpectedPrice, FOnPurchaseModDelegate Callback)

Requirements

initialized-sdk
authenticated-user
no-rate-limiting

Parameters


`Target`	`ModioSubsystem`
`ModID`	ID of the mod to purchase
`ExpectedPrice`	The price the user is expected to pay for the mod, generally `ModioModInfo.Price`. This ensures that there is consistency between the displayed price and the price in the backend. If there is a mismatch, the purchase will fail.
`Callback`	Callback invoked with purchase information once the purchase is completed.

PreviewExternalUpdatesAsync

Retrieve a list of updates between the users local mod state, and the server-side state. This allows you to identify which mods will be modified by the next call to FetchExternalUpdatesAsync in order to perform any content management (such as unloading files) that might be required.

void K2_PreviewExternalUpdatesAsync(FOnPreviewExternalUpdatesDelegate OnPreviewDone)

Parameters


`Target`	`ModioSubsystem`
`On Preview Done`	Callback invoked when the external state has been retrieved. It contains a dictionary with ModID as keys and change maps as values. Empty when there are no differences between local and the mod.io API service

MuteUserAsync

Mute a user. This will prevent mod.io from returning mods authored by the muted user. when performing searches.

void K2_MuteUserAsync(FModioUserID UserID, FOnErrorOnlyDelegate Callback)

Requirements

authenticated-user
initialized-sdk

Parameters


`Target`	`ModioSubsystem`
`UserID`	ID of the User to mute
`Callback`	Callback providing a status code indicating success or failure of muting the user.

Error Values


`SDKNotInitialized`	SDK not initialized
`UserNotAuthenticatedError`	No authenticated user
`InvalidArgsError`	The supplied user ID is invalid

MetricsSessionStartAsync

Start a metrics play session

Premium Feature

This function requires the Metrics premium feature. Sign up to one of our advanced service tiers to activate it, or contact us at developers@mod.io for more information.

nd_img_ModioSubsystem_K2_MetricsSessionStartAsync.png

void K2_MetricsSessionStartAsync(FModioMetricsSessionParams Params, FOnErrorOnlyDelegate Callback)

Parameters


`Target`	`ModioSubsystem`
`Params`	`ModioMetricsSessionParams` struct containing information of what and how to start a metrics session
`Callback`	Callback providing an error code indicating success or failure of the session start operation

Error Values


`SDKNotInitialized`	SDK not initialized
`RateLimited`	Too many frequent calls to the API. Wait some time and try again.
`InvalidUser`	No authenticated user
`SessionNotInitialized`	Metrics session has not yet been initialized
`SessionIsActive`	Metrics session is currently active and running
`BadParameter`	One or more values in the Metric Session Parameters are invalid

MetricsSessionSendHeartbeatOnceAsync

Sends a single heartbeat to the mod.io server to indicate a session is still active

Premium Feature

This function requires the Metrics premium feature. Sign up to one of our advanced service tiers to activate it, or contact us at developers@mod.io for more information.

nd_img_ModioSubsystem_K2_MetricsSessionSendHeartbeatOnceAsync.png

void K2_MetricsSessionSendHeartbeatOnceAsync(FOnErrorOnlyDelegate Callback)

Parameters


`Target`	`ModioSubsystem`
`Callback`	Callback providing an error code indicating success or failure of the session heartbeat operation

Error Values


`SDKNotInitialized`	SDK not initialized
`InvalidUser`	No authenticated user
`SessionNotInitialized`	Metrics session has not yet been initialized
`SessionIsNotActive`	Metrics session is not currently running. Call `MetricsSessionStartAsync` before attempting to sending a heartbeat.

MetricsSessionSendHeartbeatAtIntervalAsync

Sends a constant heartbeat at a given interval to the mod.io server to indicate a session is still active

void K2_MetricsSessionSendHeartbeatAtIntervalAsync(FModioUnsigned64 IntervalSeconds, FOnErrorOnlyDelegate Callback)

Parameters


`Target`	`ModioSubsystem`
`IntervalSeconds`	The frequency in seconds to send a heartbeat to the mod.io server
`Callback`	Callback providing an error code indicating success or failure of the session heartbeat operation

Error Values


`SDKNotInitialized`	SDK not initialized
`InvalidUser`	No authenticated user
`SessionNotInitialized`	Metrics session has not yet been initialized
`SessionIsNotActive`	Metrics session is not currently running. Call `MetricsSessionStartAsync` before attempting to sending a heartbeat.

MetricsSessionEndAsync

Ends a metrics play session

Premium Feature

This function requires the Metrics premium feature. Sign up to one of our advanced service tiers to activate it, or contact us at developers@mod.io for more information.

nd_img_ModioSubsystem_K2_MetricsSessionEndAsync.png

void K2_MetricsSessionEndAsync(FOnErrorOnlyDelegate Callback)

Parameters


`Target`	`ModioSubsystem`
`Callback`	Callback providing an error code indicating success or failure of the session end operation

Error Values


`SDKNotInitialized`	SDK not initialized
`RateLimited`	Too many frequent calls to the API. Wait some time and try again.
`InvalidUser`	No authenticated user
`SessionNotInitialized`	Metrics session has not yet been initialized
`SessionIsNotActive`	Metrics session is not currently running. Call `MetricsSessionStartAsync` before attempting to end a session.

ListUserGamesAsync

Provides a list of games for the current user that match the parameters specified in the filter

void K2_ListUserGamesAsync(FModioFilterParams Filter, FOnListUserGamesDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting
authenticated-user

Parameters


`Target`	`ModioSubsystem`
`Filter`	`ModioFilterParams` object containing any filters that should be applied to the query
`Callback`	Callback invoked with a status code and an optional `ModioGameInfoList` providing game profiles

Error Values


`NetworkError`	Couldn't connect to mod.io servers
`UserNotAuthenticatedError`	No authenticated user
`SDKNotInitialized`	SDK not initialized

ListUserFollowedModCollectionsAsync

Provides a list of followed mod collections for the current game, that match the parameters specified in the filter.

void K2_ListUserFollowedModCollectionsAsync(FModioFilterParams Filter, FOnListFollowedModCollectionsDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting

Parameters


`Target`	`ModioSubsystem`
`Filter`	`FModioFilterParams` object containing any filters that should be applied to the query.
`Callback`	Callback providing a status code and an optional `FModioModCollectionInfoList` object with the mod collection's extended information.

Error Values


NetworkError	Couldn't connect to mod.io servers

ListUserCreatedModsAsync

Provides a list of mods that the user has submitted or is a team member of for the current game, applying the parameters specified in the filter.

void K2_ListUserCreatedModsAsync(FModioFilterParams Filter, FOnListUserCreatedModsDelegate Callback)

Requirements

authenticated-user
initialized-sdk
no-rate-limiting

Parameters


`Target`	`ModioSubsystem`
`Filter`	Filter to apply when listing the user's created mods.
`Callback`	Callback invoked when the call succeeds, or when an error occurs.

Error Values


`NetworkError`	Couldn't connect to mod.io servers
`SDKNotInitialized`	SDK not initialized
`RateLimited`	Too many frequent calls to the API. Wait some time and try again.

ListModCollectionsAsync

Provides a list of mod collections for the current game, that match the parameters specified in the filter.

void K2_ListModCollectionsAsync(FModioFilterParams Filter, FOnListModCollectionsDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting

Parameters


`Target`	`ModioSubsystem`
`Filter`	`ModioFilterParams` object containing any filters that should be applied to the query.
`Callback`	Callback invoked with a status code and an optional `FModioModCollectionInfoList` providing mod collection profiles.

Error Values


`NetworkError`	Couldn't connect to mod.io servers
`SDKNotInitialized`	SDK not initialized

ListAllModsAsync

Provides a list of mods for the current game that match the parameters specified in the filter

void K2_ListAllModsAsync(FModioFilterParams Filter, FOnListAllModsDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting

Parameters


`Target`	`ModioSubsystem`
`Filter`	`ModioFilterParams` object containing any filters that should be applied to the query
`Callback`	Callback invoked with a status code and an optional `ModioModInfoList` providing mod profiles

Error Values


`NetworkError`	Couldn't connect to mod.io servers
`SDKNotInitialized`	SDK not initialized

InitTempModSet

Install every temp mod specified by ModIds if not already installed.

FModioErrorCode K2_InitTempModSet(TArray<FModioModID> ModIds)

Requirements

initialized-sdk
mod-management-enabled

Parameters


`Target`	`ModioSubsystem`
`ModIds`	TArray of `ModioModID`s to install as temp mods

Returns

Error code indicating the status of the TempModSet. Will be empty if it was successful

Error Values


`SDKNotInitialized`	SDK not initialized
`ModManagementDisabled`	Mod management not enabled

InitializeAsync

Initializes the SDK for the given user. Loads the state of mods installed on the system as well as the set of mods the specified user has installed on this device

void K2_InitializeAsync(FModioInitializeOptions InitializeOptions, FOnErrorOnlyDelegate OnInitComplete)

Parameters


`Target`	`ModioSubsystem`
`InitializeOptions`	Parameters to the function packed as a struct where all members needs to be initialized for the call to succeed
`On Init Complete`	Callback which will be invoked with the result of initialization

Error Values


`NetworkError`	Couldn't connect to mod.io servers
`FilesystemError`	Couldn't create the user data or common data folders
`ConfigurationError`	InitializeOptions contains an invalid value - inspect `ec.value()` to determine what was incorrect
`SDKAlreadyInitialized`	SDK already initialized

GetUserWalletBalanceAsync

Gets the users current wallet balance. This will also create a wallet for a user if one does not exist. You should ensure this is called prior to calling PurchaseModAsync purchase will fail.

void K2_GetUserWalletBalanceAsync(FOnGetUserWalletBalanceDelegate Callback)

Requirements

initialized-sdk
authenticated-user
no-rate-limiting

Parameters


`Target`	`ModioSubsystem`
`Callback`	Callback invoked with the users wallet balance

GetUserRatingsAsync

Provides a list of mod ratings for the current user

Experimental Feature

This function is part of an experimental feature and is subject to change.

nd_img_ModioSubsystem_K2_GetUserRatingsAsync.png

void K2_GetUserRatingsAsync(FOnGetUserModRatingsDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting
user-authenticated

Parameters


`Target`	`ModioSubsystem`
`Callback`	Callback invoked with a status code and an optional UserModRatingList providing ratings for each

Error Values


GenericError::SDKNotInitialized	SDK not initialized
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
NetworkError	Couldn't connect to mod.io servers

GetUserMediaAsync (Avatar)

Downloads the avatar of the currently authenticated user. Will only perform a download if there is no local cache of the avatar or if that cached copy is out-of-date.

nd_img_ModioSubsystem_K2_GetUserMediaAvatarAsync.png

void K2_GetUserMediaAvatarAsync(EModioAvatarSize AvatarSize, FOnGetMediaDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting
authenticated-user

Parameters


`Target`	`ModioSubsystem`
`AvatarSize`	Parameter specifying the size of avatar image to download
`Callback`	Callback providing a status code for the download and an optional path to the downloaded image

Error Values


`NetworkError`	Couldn't connect to mod.io servers
`SDKNotInitialized`	SDK not initialized
`UserNotAuthenticatedError`	No authenticated user

GetUserFollowingAsync

Gets a list of users that the given user is following

void K2_GetUserFollowingAsync(FModioUserID UserId, FOnGetFollowsDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting
user-authenticated

Parameters


`Target`	`ModioSubsystem`
`UserId`	the UserID of the user you are querying.
`Callback`	a Callback invoked with a status code and optional User List containing the list of followers

Error Values


GenericError::SDKNotInitialized	SDK not initialized
UserDataError::InvalidUser	User not authenticated
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
NetworkError	Couldn't connect to mod.io servers

GetUserFollowersAsync

Gets the list of followers for the given user.

void K2_GetUserFollowersAsync(FModioUserID UserId, FOnGetFollowsDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting
user-authenticated

Parameters


`Target`	`ModioSubsystem`
`UserId`	the UserID of the user who's followers you are getting
`Callback`	a Callback invoked with a status code and optional User List containing the list of followers

Error Values


GenericError::SDKNotInitialized	SDK not initialized
UserDataError::InvalidUser	User not authenticated
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
NetworkError	Couldn't connect to mod.io servers

GetUserDelegationTokenAsync

Get a user delegation token that can be used for S2S service calls

void K2_GetUserDelegationTokenAsync(FOnGetUserDelegationTokenDelegate Callback)

Requirements

initialized-sdk
authenticated-user
no-rate-limiting

Parameters


`Target`	`ModioSubsystem`
`Callback`	Callback invoked with purchase information once the purchase is completed.

GetTermsOfUseAsync

This function retrieves the information required for a game to display the mod.io terms of use to a player who wishes to create a mod.io account

void K2_GetTermsOfUseAsync(FOnGetTermsOfUseDelegate Callback)

Requirements

initialized-sdk

Parameters


`Target`	`ModioSubsystem`
`Callback`	Callback invoked with the terms of use data once retrieved from the server

Error Values


`NetworkError`	Couldn't connect to mod.io servers
`SDKNotInitialized`	SDK not initialized

GetMutedUsersAsync

List all the users that have been muted by the current user.

void K2_GetMutedUsersAsync(FOnMuteUsersDelegate Callback)

Requirements

authenticated-user
initialized-sdk

Parameters


`Target`	`ModioSubsystem`
`Callback`	Callback providing a status code indicating success or failure of the operation, and an optional containing a list of muted users if successful.

Error Values


`SDKNotInitialized`	SDK not initialized
`UserNotAuthenticatedError`	No authenticated user

GetModTagOptionsAsync

Fetches the available tags used on mods for the current game. These tags can them be used in conjunction with the FilterParams passed to ListAllModsAsync Will be cached when first received

void K2_GetModTagOptionsAsync(FOnGetModTagOptionsDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting

Parameters


`Target`	`ModioSubsystem`
`Callback`	Callback providing a status code and an optional `ModioModTagOptions` object containing the available tags

Error Values


`NetworkError`	Couldn't connect to mod.io servers
`SDKNotInitialized`	SDK not initialized

GetModMediaAsync (Logo)

Downloads the logo for the specified mod. Will use existing file if it is already present on disk

nd_img_ModioSubsystem_K2_GetModMediaLogoAsync.png

void K2_GetModMediaLogoAsync(FModioModID ModId, EModioLogoSize LogoSize, FOnGetMediaDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting

Parameters


`Target`	`ModioSubsystem`
`ModId`	Mod ID for use in logo retrieval
`LogoSize`	Parameter indicating the size of logo that's required
`Callback`	Callback providing a status code and an optional path object pointing to the location of the downloaded image

Error Values


`NetworkError`	Couldn't connect to mod.io servers
`SDKNotInitialized`	SDK not initialized
`EntityNotFoundError`	Specified mod media does not exist or was deleted
`InsufficientSpace`	Not enough space for the file
`InvalidArgsError`	The supplied mod ID is invalid

GetModMediaAsync (Gallery Image)

Get a gallery image for the specified mod ID. If it already exists on disk the file will be reused unless it is outdated

nd_img_ModioSubsystem_K2_GetModMediaGalleryImageAsync.png

void K2_GetModMediaGalleryImageAsync(FModioModID ModId, EModioGallerySize GallerySize, int32 Index, FOnGetMediaDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting

Parameters


`Target`	`ModioSubsystem`
`ModId`	The mod you want to retrieve an image for
`GallerySize`	Size of the image you want to retrieve
`Index`	The zero-based index of the image you want to retrieve
`Callback`	Callback containing a status code and an Optional containing a path to the image file on disk

Error Values


`NetworkError`	Couldn't connect to mod.io servers
`SDKNotInitialized`	SDK not initialized
`EntityNotFoundError`	Specified mod media does not exist or was deleted
`InsufficientSpace`	Not enough space for the file
`InvalidArgsError`	The supplied mod ID is invalid

GetModMediaAsync (Avatar)

Downloads the creator avatar for a specified mod. Will use existing file if it is already present on disk and not outdated

nd_img_ModioSubsystem_K2_GetModMediaAvatarAsync.png

void K2_GetModMediaAvatarAsync(FModioModID ModId, EModioAvatarSize AvatarSize, FOnGetMediaDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting

Parameters


`Target`	`ModioSubsystem`
`ModId`	ID of the mod the creator avatar will be retrieved for
`AvatarSize`	Parameter indicating the size of avatar image that's required
`Callback`	Callback providing a status code and an optional path object pointing to the location of the downloaded image

Error Values


`NetworkError`	Couldn't connect to mod.io servers
`SDKNotInitialized`	SDK not initialized
`EntityNotFoundError`	Specified mod media does not exist or was deleted
`InsufficientSpace`	Not enough space for the file
`InvalidArgsError`	The supplied mod ID is invalid

GetModInfoAsync

Fetches detailed information about the specified mod, including description and file metadata for the most recent release

void K2_GetModInfoAsync(FModioModID ModId, FOnGetModInfoDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting

Parameters


`Target`	`ModioSubsystem`
`ModId`	Mod ID of the mod to fetch data
`Callback`	Callback providing a status code and an optional `ModioModInfo` object with the mod's extended information

Error Values


`NetworkError`	Couldn't connect to mod.io servers
`SDKNotInitialized`	SDK not initialized
`EntityNotFoundError`	Specified mod does not exist or was deleted
`InvalidArgsError`	The supplied mod ID is invalid

GetModDependenciesAsync

For a given Mod ID, fetches a list of any mods that the creator has marked as dependencies

Experimental Feature

This function is part of an experimental feature and is subject to change.

nd_img_ModioSubsystem_K2_GetModDependenciesAsync.png

void K2_GetModDependenciesAsync(FModioModID ModID, bool Recursive, FOnGetModDependenciesDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting

Parameters


`Target`	`ModioSubsystem`
`ModID`	The mod to retrieve dependencies for
`Recursive`	Fetches dependencies recursively up to a depth of 5
`Callback`	Callback providing a status code and an optional `ModioModTagOptions` object containing the available tags

Error Values


`NetworkError`	Couldn't connect to mod.io servers
`SDKNotInitialized`	SDK not initialized
`InvalidArgsError`	The supplied mod ID is invalid

GetModCreationHandle

Gets a new mod handle for use with SubmitNewModAsync.

Experimental Feature

This function is part of an experimental feature and is subject to change.

nd_img_ModioSubsystem_K2_GetModCreationHandle.png

FModioModCreationHandle K2_GetModCreationHandle()

Parameters


`Target`	`ModioSubsystem`

GetModCollectionModsAsync

Get a list of Mods contained within the specified mod collection.

void K2_GetModCollectionModsAsync(FModioModCollectionID ModCollectionId, FOnGetModCollectionModsDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting

Parameters


`Target`	`ModioSubsystem`
`ModCollectionId`	Mod Collection ID of the mod collection to fetch data.
`Callback`	Callback providing a status code and an optional `FModioModCollectionInfoList` object with the mod collection's extended information.

Error Values


NetworkError	Couldn't connect to mod.io servers
EntityNotFoundError	Specified mod collection does not exist or was deleted

GetModCollectionMediaAsync (Logo)

Downloads the logo for the specified mod collection. Will use existing file if it is already present on disk.

nd_img_ModioSubsystem_K2_GetModCollectionLogoAsync.png

void K2_GetModCollectionLogoAsync(FModioModCollectionID ModCollectionId, EModioLogoSize LogoSize, FOnGetModCollectionMediaDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting

Parameters


`Target`	`ModioSubsystem`
`ModCollectionId`	Mod Collection ID for use in logo retrieval.
`LogoSize`	Parameter indicating the size of logo that's required.
`Callback`	Callback providing a status code and an optional path object pointing to the location of the downloaded image

Error Values


NetworkError	Couldn't connect to mod.io servers
EntityNotFoundError	Specified mod collection media does not exist or was deleted

GetModCollectionInfoAsync

Fetches detailed information about the specified mod collection, including description and file metadata for the most recent release.

void K2_GetModCollectionInfoAsync(FModioModCollectionID ModCollectionId, FOnGetModCollectionInfoDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting

Parameters


`Target`	`ModioSubsystem`
`ModCollectionId`	Mod Collection ID of the mod collection to fetch data.
`Callback`	Callback providing a status code and an optional `FModioModCollectionInfo` object with the mod collection's extended information.

Error Values


NetworkError	Couldn't connect to mod.io servers
EntityNotFoundError	Specified mod collection does not exist or was deleted

GetModCollectionMediaAsync (Avatar)

Downloads the creator avatar for a specified mod collection. Will use existing file if it is already present on disk and not outdated.

nd_img_ModioSubsystem_K2_GetModCollectionAvatarAsync.png

void K2_GetModCollectionAvatarAsync(FModioModCollectionID ModCollectionId, EModioAvatarSize AvatarSize, FOnGetModCollectionMediaDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting

Parameters


`Target`	`ModioSubsystem`
`ModCollectionId`	Mod Collection ID for use in creator avatar retrieval.
`AvatarSize`	Parameter indicating the size of avatar image that's required.
`Callback`	Callback providing a status code and an optional path object pointing to the location of the downloaded image

Error Values


NetworkError	Couldn't connect to mod.io servers
EntityNotFoundError	Specified mod collection media does not exist or was deleted

GetLanguage

Get the currently applied language

EModioLanguage K2_GetLanguage()

Parameters


`Target`	`ModioSubsystem`

Returns

Current language

GetGameInfoAsync

Fetches detailed information about the specified game

void K2_GetGameInfoAsync(FModioGameID GameID, FOnGetGameInfoDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting

Parameters


`Target`	`ModioSubsystem`
`GameID`	Game ID of the game data to fetch
`Callback`	Callback providing a status code and an optional `ModioGameInfo` object with the game's extended information

Error Values


`SDKNotInitialized`	SDK not initialized
`NetworkError`	Couldn't connect to mod.io servers
`EntityNotFoundError`	Specified game does not exist
`InvalidArgsError`	The supplied game ID is invalid

GetAvailableUserEntitlementsAsync

void K2_GetAvailableUserEntitlementsAsync(FModioEntitlementParams Params, FOnGetAvailableUserEntitlementsDelegate Callback)

Requirements

initialized-sdk
authenticated-user
no-rate-limiting

Parameters


`Target`	`ModioSubsystem`
`Params`
`Callback`	Callback providing an error code indicating success or failure of the retrieval operation

ForceUninstallModAsync

Forcibly uninstalls a mod from the system. This can be used when the host application requires additional space for other mods. The current user must not be subscribed to the mod to force uninstall. To remove a mod the current user is subscribed to, first use UnsubscribeFromModAsync. If the mod does not uninstall (due to a different user on the same system remaining subscribed), ForceUninstallModAsync can be called next.

void K2_ForceUninstallModAsync(FModioModID ModToRemove, FOnErrorOnlyDelegate Callback)

Parameters


`Target`	`ModioSubsystem`
`ModToRemove`	The mod ID to force uninstall.
`Callback`	Callback invoked indicating success or failure of the uninstallation.

Error Values


`SDKNotInitialized`	SDK not initialized
`UserNotAuthenticatedError`	No authenticated user
ApiErrorRefSuccess	User is still subscribed to the specified mod
`InvalidArgsError`	The supplied mod ID is invalid

FollowUserAsync

Follows the given user for the currently authenticated user.

void K2_FollowUserAsync(FModioUserID UserId, FOnErrorOnlyDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting
user-authenticated

Parameters


`Target`	`ModioSubsystem`
`UserId`	The UserID of the user that should be followed.
`Callback`	a callback invoked upon completion, indicating if the request was successful.

Error Values


GenericError::SDKNotInitialized	SDK not initialized
UserDataError::InvalidUser	User not authenticated
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
NetworkError	Couldn't connect to mod.io servers

FollowModCollectionAsync

Sends a request to the mod.io server to add the specified mod collection to the user's list of followed collections.

void K2_FollowModCollectionAsync(FModioModCollectionID ModCollectionToFollow, FOnFollowModCollectionDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting
authenticated-user
management-enabled
mod-not-pending-uninstall

Parameters


`Target`	`ModioSubsystem`
`ModCollectionToFollow`	Mod Collection ID of the mod collection requiring a subscription.
`Callback`	Callback invoked when the follow request is completed.

Error Values


NetworkError	Couldn't connect to mod.io servers
EntityNotFoundError	Specified mod collection does not exist or was deleted

FetchUserPurchasesAsync

Fetches the user's purchases. This populates a runtime cache of purchase information that can be accessed using QueryUserPurchasedMods.

void K2_FetchUserPurchasesAsync(FOnFetchUserPurchasesDelegate Callback)

Requirements

initialized-sdk
authenticated-user
no-rate-limiting

Parameters


`Target`	`ModioSubsystem`
`Callback`	Callback invoked once the call has been completed.

FetchExternalUpdatesAsync

Synchronises the local list of the current user's subscribed mods with the server. Any mods that have been externally subscribed will be automatically marked for installation, and mods that have been externally removed from the user's subscriptions may be uninstalled if no other local users have a current subscription.

void K2_FetchExternalUpdatesAsync(FOnErrorOnlyDelegate OnFetchDone)

Parameters


`Target`	`ModioSubsystem`
`On Fetch Done`	Callback invoked when the external state has been retrieved and merged with the local data

EnableModManagement

Enables the automatic management of installed mods on the system based on the user's subscriptions.

FModioErrorCode K2_EnableModManagement(FOnModManagementDelegate Callback)

Parameters


`Target`	`ModioSubsystem`
`Callback`	This callback handler will be invoked with a `ModioModManagementEvent` for each mod operation performed by the SDK

Returns

An error code indicating success or failure of enabling mod management. Note that this is independent of error codes for mod management events. Inspect the Callback for information on each mod management event.

Error Values


`SDKNotInitialized`	SDK not initialized
`ModManagementAlreadyEnabled`	Mod management was already enabled. The mod management callback has not been changed.

DeleteModDependenciesAsync

Deletes dependencies from a specified mod, unlinking it from other mods that are no longer required.

void K2_DeleteModDependenciesAsync(FModioModID ModID, TArray<FModioModID> Dependencies, FOnErrorOnlyDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting
authenticated-user

Parameters


`Target`	`ModioSubsystem`
`ModID`	The mod to delete dependencies from
`Dependencies`	List of mod IDs to delete as dependencies
`Callback`	Callback providing a status code to indicate if the dependencies were deleted successfully

Error Values


GenericError::SDKNotInitialized	SDK not initialized
UserDataError::InvalidUser	No authenticated user
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
GenericError::BadParameter	The supplied mod ID is invalid
NetworkError	Couldn't connect to mod.io servers
EntityNotFoundError	Specified mod could not be found

CloseTempModSet

Uninstall every temp mod unless the user is subscribed.

FModioErrorCode K2_CloseTempModSet()

Requirements

initialized-sdk
mod-management-enabled
temp-mod-set-initialized

Parameters


`Target`	`ModioSubsystem`

Returns

Error code indicating the status of the TempModSet. Will be empty if it was successful

Error Values


`SDKNotInitialized`	SDK not initialized
`ModManagementDisabled`	Mod management not enabled
`TempModSetNotInitialized`	`TempModSet` not initialized

ClearUserDataAsync

De-authenticates the current mod.io user for the current session, and clears all user-specific data stored on the current device. Any subscribed mods that are installed but do not have other local users subscribed will be uninstalled

void K2_ClearUserDataAsync(FOnErrorOnlyDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting
authenticated-user

Parameters


`Target`	`ModioSubsystem`
`Callback`	Callback providing a status code indicating the outcome of clearing the user data. Error codes returned by this function are informative only - it will always succeed.

Error Values


`SDKNotInitialized`	SDK not initialized
`UserNotAuthenticatedError`	No authenticated user

AuthenticateUserExternalAsync

Uses platform-specific authentication to associate a mod.io user account with the current platform user

void K2_AuthenticateUserExternalAsync(FModioAuthenticationParams User, EModioAuthenticationProvider Provider, FOnErrorOnlyDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting
no-authenticated-user

Parameters


`Target`	`ModioSubsystem`
`User`	Authentication payload data to submit to the provider
`Provider`	The provider to use to perform the authentication
`Callback`	Callback invoked once the authentication request has been made

Error Values


`NetworkError`	Couldn't connect to mod.io servers
`ConfigurationError`	The SDK's configuration is not valid
`InvalidArgsError`	The arguments passed to the function have failed validation
`UserTermsOfUseError`	The user has not yet accepted the mod.io Terms of Use
`SDKNotInitialized`	SDK not initialized
`UserAlreadyAuthenticatedError`	Current user is already authenticated. De-authenticate the current user with `ClearUserDataAsync`, and re-initialize the SDK by calling `ShutdownAsync` followed by `InitializeAsync`.

AuthenticateUserEmailAsync

Completes email authentication for the current session by submitting the one-time code sent to the user's email address

void K2_AuthenticateUserEmailAsync(FModioEmailAuthCode AuthenticationCode, FOnErrorOnlyDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting
no-authenticated-user

Parameters


`Target`	`ModioSubsystem`
`AuthenticationCode`	User's authentication code
`Callback`	Callback providing a status code indicating if authentication was successful or not

Error Values


`NetworkError`	Couldn't connect to mod.io servers
`SDKNotInitialized`	SDK not initialized
`UserAlreadyAuthenticatedError`	Current user is already authenticated. De-authenticate the current user with `ClearUserDataAsync`, and re-initialize the SDK by calling `ShutdownAsync` then `InitializeAsync`.

ArchiveModAsync

Archives a mod. This mod will no longer be able to be viewed or retrieved via the SDK, but it will still exist should you choose to restore it at a later date. Archiving is restricted to team managers and administrators only. Note that restoration and permanent deletion of a mod is possible only via web interface.

void K2_ArchiveModAsync(FModioModID Mod, FOnErrorOnlyDelegate Callback)

Requirements

authenticated-user
initialized-sdk
no-rate-limiting

Parameters


`Target`	`ModioSubsystem`
`Mod`	The mod to be archived.
`Callback`	Callback providing a status code indicating success or failure of archiving the mod.

Error Values


`InsufficientPermissions`	The authenticated user does not have permission to archive this mod. This action is restricted to team managers and administrators only.
`NetworkError`	Couldn't connect to mod.io servers
`SDKNotInitialized`	SDK not initialized
`EntityNotFoundError`	Specified mod does not exist or was deleted
`InvalidArgsError`	The supplied mod ID is invalid

AddToTempModSet

Add mods to a Temp Mod Set. Every temp mod specified by ModIds will be installed if not already installed.

FModioErrorCode K2_AddToTempModSet(TArray<FModioModID> ModIds)

Requirements

initialized-sdk
mod-management-enabled
temp-mod-set-initialized

Parameters


`Target`	`ModioSubsystem`
`ModIds`	TArray of `ModioModID`s to install as temp mods

Returns

Error code indicating the status of the TempModSet. Will be empty if it was successful

Error Values


`SDKNotInitialized`	SDK not initialized
`ModManagementDisabled`	Mod management not enabled
`TempModSetNotInitialized`	`TempModSet` not initialized

AddModDependenciesAsync

Adds dependencies to a specified mod, linking it with other mods that are required for it to function

void K2_AddModDependenciesAsync(FModioModID ModID, TArray<FModioModID> Dependencies, FOnErrorOnlyDelegate Callback)

Requirements

initialized-sdk
no-rate-limiting
authenticated-user

Parameters


`Target`	`ModioSubsystem`
`ModID`	The mod to add dependencies to
`Dependencies`	List of mod dependencies to add
`Callback`	Callback providing a status code to indicate if the dependencies were added successfully

Error Values


GenericError::SDKNotInitialized	SDK not initialized
UserDataError::InvalidUser	No authenticated user
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
GenericError::BadParameter	The supplied mod ID is invalid
NetworkError	Couldn't connect to mod.io servers
EntityNotFoundError	Specified mod could not be found

Is Using Background Thread

Returns if the background thread is being used or not

bool IsUsingBackgroundThread()

Parameters


`Target`	`ModioSubsystem`

Is Mod Management Busy

Checks if the automatic management process is currently installing or removing mods

bool IsModManagementBusy()

Parameters


`Target`	`ModioSubsystem`

Returns

True if automatic management is currently performing an operation

Get Storage Quota

Get the storage quota for a given EModioStorageLocation if one has been set.

FModioOptionalUInt64 GetStorageQuota(EModioStorageLocation Location)

Parameters


`Target`	`ModioSubsystem`
`Location`	The type of storage to get the quota for. *

Returns

FModioOptionalUInt64 of the storage quota in bytes for the specified EModioStorageLocation. Empty if no quota is set.

Get Last Validation Error

If the last request to the mod.io servers returned a validation failure, this function returns extended information describing the fields that failed validation.

TArray<FModioValidationError> GetLastValidationError()

Requirements

initialized-sdk

Parameters


`Target`	`ModioSubsystem`

Returns

Collection of ModioValidationError objects, or empty collection if there were no validation failures

Get Current Portal

EModioPortal GetCurrentPortal() const

Disable Mod Management

Disables automatic installation or uninstallation of mods based on the user's subscriptions. Allows currently processing installation to complete. Will cancel any pending operations when called.

void DisableModManagement()

Parameters


`Target`	`ModioSubsystem`

ModioTokenPackLibrary

Blueprint function library for interacting with ModioTokenPack objects

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object

ModioUIEnumLocalizationLibrary

Utility functions for UI enum localization in mod.io

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object

ModioUILocalizationLibrary

Utility functions for UI localization in mod.io

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object

ModioUnsigned64Library

Library class for operations on FModioUnsigned64

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object

ModioUserListLibrary

Utility functions for accessing and managing lists of user information

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object

Structs

ModioEntitlementList

Strong type struct to wrap multiple Entitlement indexed by a paged result

ModioEntitlement

Information related to a SKU entitlement

Variables


`FString`	`SkuId`	Id of the Sku the entitlement is for
`EModioEntitlementType`	`EntitlementType`	The type of the entitlement

ModioPagedResult

Strong type struct to acknowledge the position of a result relative to the API endpoint's results

Variables


`int32`	`PageIndex`	The index of this page
`int32`	`PageSize`	The amount of results allowed to be displayed within a page
`int32`	`PageCount`	The total amount of pages
`int32`	`TotalResultCount`	The total amount of results
`int32`	`ResultCount`	The amount of results for this page

ModioGameInfoList

Strong type struct to wrap multiple GameInfo indexed by a paged result

ModioGameInfo

Full game profile with extended information

Variables


`FModioGameID`	`GameID`	Unique Game ID
`FDateTime`	`DateAdded`	Unix timestamp of date the game was registered
`FDateTime`	`DateUpdated`	Unix timestamp of date the game was updated
`FDateTime`	`DateLive`	Unix timestamp of date the game was set live
`FString`	`UgcName`	Word used to describe user-generated content (mods, items, add-ons etc)
`FModioIcon`	`Icon`	Contains media URLs to the icon for the game
`FModioLogo`	`Logo`	Contains media URLs to the logo for the game
`FModioHeaderImage`	`HeaderImage`	Contains media URLs to the preview header image for the game
`FString`	`Name`	Name of the game
`FString`	`Summary`	Summary of the game's mod support
`FString`	`Instructions`	A guide about creating and uploading mods for this game to mod.io
`FString`	`InstructionsUrl`	Link to a mod.io guide, modding wiki, or a page where modders can learn how to make and submit mods to this game's profile
`FString`	`ProfileUrl`	URL to the game
`FModioTheme`	`Theme`	Theme color values for the game
`FModioGameStats`	`Stats`	Numerous aggregate stats for the game
`TArray<FModioOtherUrl>`	`OtherUrls`	Creator defined URLs to share
`TArray<EModioModfilePlatform>`	`Platforms`	Platforms that are supported by this title
`bool`	`bAllowNegativeRatings`	Whether or not the game allows negative ratings
`EGameMonetizationFlags`	`GameMonetizationOptions`	Monetization options for the game
`EGameMaturityFlags`	`GameMaturityOptions`	Maturity options for the game
`FString`	`VirtualTokenName`	Name of the Virtual Tokens for this game
`TArray<FModioGamePlatform>`	`PlatformSupport`	Platforms that are supported by this title
`TArray<FModioModTagInfo>`	`TagOptions`	Tags available for this game
`TArray<FModioPlacement>`	`Placements`	Placements available for this game
`EModioGameCloudCookingStatus`	`CloudCookingStatus`	Cloud Cooking status for this game

ModioPlacement

Placements of a game to represent dynamic mod view

Variables


`int64`	`ID`	Unique placement id
`EModioPlacementType`	`Type`	Placement type
`FString`	`Name`	Placement name
`FString`	`NameLocalized`	Placement name localized
`FModioFilterParams`	`Filters`	Structured filter describing the mods this placement should display
`int64`	`DisplayPosition`	Placement's display position
`int64`	`Total`	Total number in the placement to show
`EModioPlacementSize`	`Size`	Placement's display size
`bool`	`bEnabled`	Placement's enabled status

ModioFilterParams

Class storing a set of filter parameters for use in ListAllModsAsync

ModioModTagInfo

Metadata about a group of tags that can be used for filtering mods

Variables


`FString`	`TagGroupName`	Raw unlocalized tag group name
`TArray<FString>`	`TagGroupValues`	Valid raw unlocalized tag values this group contains
`TMap<FString,FText>`	`TagGroupNameLocalizationData`	Culture code -> localized tag category name mapping for all configured languages
`TArray<FModioModTagLocalizationData>`	`TagGroupValueLocalizationData`	Localization data for this tag category's values in all configured languages
`bool`	`bAllowMultipleSelection`	True if multiple tags from the group can be used simultaneously
`bool`	`bHidden`	True if only visible by admins
`bool`	`bLocked`	True if only editable by admins

ModioLocalizedTagCategory

Struct containing pre-localized display strings for a tag group

Variables


`FString`	`GroupName`	Localized display string for this tag category's name
`TArray<FString>`	`Tags`	Localized display strings for all valid values in this tag category

ModioModTagLocalizationData

Localization data for an individual tag value

Variables


`FString`	`Tag`	The original raw unlocalized tag value used by the REST API
`TMap<FString,FText>`	`Translations`	Culture code -> Localized tag value string mapping for all configured languages.

ModioGamePlatform

Details about a platform that a Game supports

Variables


`EModioModfilePlatform`	`Platform`	A platform supported by a title
`bool`	`Locked`	Whether or not this platform is locked from having files submitted to it by players
`bool`	`Moderated`	Whether or not this platform's file submissions are moderated

ModioOtherUrl

Strong type struct representing creator defined urls to share

Variables


`FString`	`Label`	Label of the link you are sharing
`FString`	`Url`	The URL to be associated with the label

ModioGameStats

Numerous aggregate stats for the game

Variables


`FModioGameID`	`GameID`	Unique game id
`int64`	`ModCountTotal`	Available mod count for the game
`int64`	`ModDownloadsToday`	Mods downloaded today for the game
`int64`	`ModDownloadsTotal`	Total mods downloaded for the game
`int64`	`ModDownloadsDailyAverage`	Average mods downloaded on a daily basis
`int64`	`ModSubscribersTotal`	Number of total users who have subscribed to the mods for the game
`int64`	`DateExpires`	Unix timestamp until this game's statistics are considered stale

ModioGameID

Strong type struct to wrap a GameID to uniquely identify a single game in mod.io

ModioTheme

Theme color values for the game

Variables


`FString`	`Primary`	The primary hex color code
`FString`	`Dark`	The dark hex color code
`FString`	`Light`	The light hex color code
`FString`	`Success`	The success hex color code
`FString`	`Warning`	The warning hex color code
`FString`	`Danger`	The danger hex color code

ModioHeaderImage

Contains media URLs to the preview header image for the game

Variables


`FString`	`Filename`	Header image filename including extension
`FString`	`Original`	URL to the full-sized header image

ModioLogo

Contains media URLs to the logo for the game

Variables


`FString`	`Filename`	Logo filename including extension.
`FString`	`Original`	URL to the full-sized logo.
`FString`	`Thumb320x180`	URL to the small logo thumbnail.
`FString`	`Thumb640x360`	URL to the medium logo thumbnail.
`FString`	`Thumb1280x720`	URL to the large logo thumbnail.

ModioIcon

Contains media URLs to the icon for the game

Variables


`FString`	`Filename`	Icon filename including extension
`FString`	`Original`	URL to the full-sized icon
`FString`	`Thumb64x64`	URL to the small icon thumbnail
`FString`	`Thumb128x128`	URL to the medium icon thumbnail
`FString`	`Thumb256x256`	URL to the large icon thumbnail

ModioModCollectionInfoList

Strong type struct to wrap multiple ModCollectionInfo indexed by a paged result

ModioModCollectionInfo

Information about a given mod collection

Variables


`FModioModCollectionID`	`Id`	The unique ID of the collection.
`FModioGameID`	`GameId`	The unique ID of the game the collection belongs to.
`FString`	`GameName`	the game name
`EModioModServerSideStatus`	`CollectionStatus`	The current ModStatus on the server: Accepted, NotAccepted, or Deleted.
`EModioObjectVisibilityFlags`	`Visibility`	The mod collection's visibility status. Defaults to Public (1)
`FModioUser`	`ProfileSubmittedBy`	Information on the user who submitted the collection
`FString`	`Category`	Chosen category of the collection
`FDateTime`	`ProfileDateAdded`	Unix timestamp of the date the mod was registered
`FDateTime`	`ProfileDateUpdated`	Unix timestamp of the date the mod was updated
`FDateTime`	`ProfileDateLive`	Unix timestamp of the date the mod was marked live
`bool`	`Incomplete`	boolean to indicate whether the collection contains hidden mods
`EModioMaturityFlags`	`ProfileMaturityOption`	Maturity options flagged by the mod developer. This is only relevant if the parent game allows collections to be labeled as mature. The value of this field will default to None unless the parent game allows to flag mature content.
`FModioUnsigned64`	`FileSize`	Size of collection in bytes
`FModioUnsigned64`	`FileSizeUncompressed`	Size of the uncompressed collection in bytes
`TArray<EModioModfilePlatform>`	`Platforms`	Supported platform for this collection
`TArray<FString>`	`Tags`	Tags this mod collection has set
`FModioModCollectionStats`	`Stats`	Stats and rating information for the mod collection.
`FModioLogo`	`Logo`	Media data related to the mod collection logo
`FString`	`ProfileName`	Name of the mod collection
`FString`	`ProfileNameId`	Name id of the mod collection
`FString`	`ProfileSummary`	Summary of the mod collection
`FString`	`ProfileDescription`	Detailed description in HTML format
`FString`	`ProfileDescriptionPlaintext`	Detailed description in plaintext format

ModioModCollectionStats

Contains download stats and ratings for a mod collection

Variables


`int64`	`DownloadsToday`	Number of mod collection downloads today.
`int64`	`DownloadsTotal`	Number of total mod collection downloads.
`int64`	`DownloadsUnique`	Number of unique mod collection downloads.
`int64`	`RatingTotal30Days`	Number of rating over 30 days.
`int64`	`RatingPositive30Days`	Number of positive ratings over 30 days.
`int64`	`RatingNegative30Days`	Number of negative ratings over 30 days.
`int64`	`RatingTotal`	Number of times this mod collection has been rated.
`int64`	`RatingPositive`	Number of positive ratings.
`int64`	`RatingNegative`	Number of negative ratings.
`int64`	`NumberOfComments`	Number of comments.
`int64`	`NumberOfFollowers`	Number of followers.
`int64`	`NumberOfMods`	Number of mods in the collection.

ModioUnsigned64

Trivial Blueprint-compatible wrapper around an unsigned 64-bit integer

ModioUser

Object representing a mod.io user profile information

Variables


`FModioUserID`	`UserId`	User's unique ID
`FString`	`Username`	Name chosen by the user
`FDateTime`	`DateOnline`	Unix timestamp of the last time the user was online
`FString`	`ProfileUrl`	URL of the user's mod.io profile
`FString`	`DisplayNamePortal`	Display name of this User for the given Portal, if their account is linked

ModioUserID

Strong type struct to wrap a UserID which uniquely identifies a user in mod.io

ModioModCollectionID

Strong type struct to wrap a ModCollectionID to uniquely identify collections of user-generated content.

ModioModInfoList

Strong type struct to wrap multiple ModInfo indexed by a paged result

ModioModInfo

Full mod profile including current release information, media links, and stats

Variables


`FModioModID`	`ModId`	Unique Mod ID
`FString`	`ProfileName`	Name of the mod
`FString`	`ProfileSummary`	Summary of the mod
`FString`	`ProfileDescription`	Detailed description in HTML format
`FString`	`ProfileDescriptionPlaintext`	Detailed description in plaintext
`FString`	`ProfileURL`	URL to the mod profile
`FModioUser`	`ProfileSubmittedBy`	Information on the user who submitted the mod
`FDateTime`	`ProfileDateAdded`	Unix timestamp of the date the mod was registered
`FDateTime`	`ProfileDateUpdated`	Unix timestamp of the date the mod was updated
`FDateTime`	`ProfileDateLive`	Unix timestamp of the date the mod was marked live
`EModioMaturityFlags`	`ProfileMaturityOption`	Flags for maturity options. Maturity options are flagged by the mod developer. This is only relevant if the parent game allows mods to be labeled as mature.
`EModioModCommunityOptionsFlags`	`CommunityOptions`	Community options for the mod
`bool`	~~`bVisible_DEPRECATED`~~	Deprecated as of 2023.6 release. Please use `EModioObjectVisibilityFlags Visibility` instead.
`EModioObjectVisibilityFlags`	`Visibility`	Enum parameter to signal the backend if the mod to upload would be publicly visible. Default value is Public
`bool`	`Dependencies`	If this mod has any dependencies
`FString`	`MetadataBlob`	Stored property to the metadata string
`FModioFileMetadata`	`FileInfo`	Information about the mod's most recent public release
`TArray<FModioMetadata>`	`MetadataKvp`	Arbitrary key-value metadata set for this mod
`TArray<FModioModTag>`	`Tags`	Tags this mod has set
`int32`	`NumGalleryImages`	Number of images in the mod's media gallery
`FModioYoutubeURLList`	`YoutubeURLs`	List of youtube links provided by the creator of the mod
`FModioSketchfabURLList`	`SketchfabURLs`	List of sketchfab links provided by the creator of the mod
`FModioModStats`	`Stats`	Stats and rating information for the mod
`EModioModServerSideStatus`	`ModStatus`	Status of the mod
`FModioUnsigned64`	`Price`	Price of this mod
`TArray<FModioModMonetizationSKU>`	`SKUMappings`

ModioModMonetizationSKU

Variables


`int64`	`Id`
`FString`	`SKUName`
`FString`	`Portal`

ModioModStats

Contains download stats and ratings for a mod

Variables


`int64`	`PopularityRankPosition`	Current rank of the mod.
`int64`	`PopularityRankTotalMods`	Number of ranking spots the current rank is measured against.
`int64`	`DownloadsTotal`	Number of total mod downloads.
`int64`	`SubscribersTotal`	Number of total users who have subscribed to the mod.
`int64`	`RatingTotal`	Number of times this mod has been rated.
`int64`	`RatingPositive`	Number of positive ratings.
`int64`	`RatingNegative`	Number of negative ratings.
`int64`	`RatingPercentagePositive`	Number of positive ratings, divided by the total ratings to determine its percentage score.
`float`	`RatingWeightedAggregate`	Overall rating of this item calculated using the Wilson score confidence interval. This column is good to sort on, as it will order items based on number of ratings and will place items with many positive ratings above those with a higher score but fewer ratings. We actually get a double back from the server, but it's converted to a float for blueprint support
`FString`	`RatingDisplayText`	Textual representation of the rating in format: Overwhelmingly Positive -> Very Positive -> Positive -> Mostly Positive -> Mixed -> Negative -> Mostly Negative -> Very Negative -> Overwhelmingly Negative -> Unrated

ModioSketchfabURLList

Struct to store links and metadata associated to Sketchfab URLs for Blueprint

ModioYoutubeURLList

Struct to store links and metadata associated to YouTube URLs for Blueprint

ModioModTag

Strong type struct to wrap a Mod tag

Variables


`FString`	`Tag`	A string that represents a mod tag
`FText`	`TagLocalized`	A localized tag string

ModioMetadata

Strong type struct to represent key-value pairs for mod metadata

Variables


`FString`	`Key`	Key of the metadata
`FString`	`Value`	Value of the metadata

ModioFileMetadata

Metadata for a release archive for a mod

Variables


`FModioFileMetadataID`	`MetadataId`	Unique modfile id.
`FModioModID`	`ModId`	Unique mod id.
`FDateTime`	`DateAdded`	Unix timestamp of date file was added.
`EModioVirusScanStatus`	`CurrentVirusScanStatus`	Current virus scan status of the file. For newly added files that have yet to be scanned this field will change frequently until a scan is complete
`EModioVirusStatus`	`CurrentVirusStatus`	Was a virus detected?
`FModioUnsigned64`	`Filesize`	Size of the file in bytes.
`FModioUnsigned64`	`FilesizeUncompressed`	Total size of all files in the mod after installation.
`FString`	`Filename`	Filename including extension.
`FString`	`Version`	Release version this file represents.
`FString`	`Changelog`	Changelog for the file.
`FString`	`MetadataBlob`	Metadata stored by the game developer for this file.

ModioModID

Strong type struct to wrap a ModID to uniquely identify user-generated content

ModioFileMetadataID

Strong type struct to store the associated metadata to a mod file

ModioModTagOptions

Strong type struct to wrap multiple ModTagInfo indexed by a paged result

ModioTokenPackList

Strong type struct to wrap multiple TokenPacks indexed by a paged result

ModioTokenPack

A wrapper type around the Unreal Engine type FOnlineStoreOffer, representing a platform-agnostic store offer/product, e.g a Premium Currency pack.

ModioUserList

Strong type struct to wrap multiple Users indexed by a paged result

ModioUserModRatingList

Strong type struct to wrap multiple user ratings indexed by a paged result

Variables


`FModioPagedResult`	`PagedResult`	A paged result property
`TArray<FModioUserModRating>`	`InternalList`	Internal array of user ratings

ModioUserModRating

Variables


`FModioGameID`	`GameId`
`FModioModID`	`ModId`
`EModioRating`	`Rating`

ModioErrorCode

Wrapper around Modio::ErrorCode

ModioEntitlementParams

Simple struct to encapsulate portal-specific data required when consuming entitlements

ModioOptionalModCollectionInfo

Struct to wrap ModCollectionInfo into an optional parameter

ModioOptionalEntitlementList

Struct to wrap EntitlementList into an optional parameter

ModioOptionalUserList

Struct to wrap UserList into an optional parameter

ModioOptionalGameInfo

Strong type struct to store an optional GameInfo parameter

ModioOptionalImage

Strong type struct to wrap Image data as an optional value

ModioOptionalModInfoList

Struct to wrap ModInfoList into an optional parameter

ModioOptionalModDependencyList

Strong type struct to wrap a ModDependencyList data as an optional value

ModioOptionalModInfo

Strong type struct to store an optional ModInfo parameter

ModioOptionalModTagOptions

Strong type struct that wraps mod tag options in an optional value

ModioOptionalTerms

Struct to store an optional value for the terms of service

ModioOptionalUserModRatingList

Struct to wrap UserModRatingList into an optional parameter

ModioOptionalUInt64

Strong type struct to wrap uint64 as an optional value

ModioOptionalModCollectionInfoList

Struct to wrap ModCollectionInfoList into an optional parameter

ModioOptionalGameInfoList

Struct to wrap GameInfoList into an optional parameter

ModioModManagementEvent

Simple struct representing the outcome of a mod management operation

Variables


`FModioModID`	`ID`	ID for the mod that the event occurred on
`EModioModManagementEventType`	`Event`	What type of event occurred
`FModioErrorCode`	`Status`	Empty if operation completed successfully, truthy/contains error code if operation failed

ModioOptionalModChangeMap

Strong type struct to wrap a ModChangeMap as an optional value

ModioOptionalTransactionRecord

Struct to store an optional value for the transaction record

ModioOptionalEntitlementConsumptionStatusList

Optional class representing a list of entitlement consumption statuses that may be a page from a larger set of results

ModioOptionalModID

Strong type struct to wrap ModID as an optional value

ModioAuthenticationParams

Struct to encapsulate data passed to external authentication systems * This struct is used to store authentication parameters required by various external authentication providers. These parameters are used to authenticate users with external systems (e.g., Xbox, Steam, Google, etc.).

Variables


`FString`	`AuthToken`	Stored property of the authentication token This token is required for authentication with the external provider.
`FString`	`UserEmail`	Stored property of the user email This is the email address of the user, which is used for authentication purposes in certain external systems.
`bool`	`bUserHasAcceptedTerms`	Boolean that signals if the user has accepted the terms of service This flag is used to indicate whether the user has agreed to the terms of service required by the external authentication provider.
`TMap<FString,FString>`	`ExtendedParameters`	Stored property of extended parameters required by some providers This map holds additional key-value pairs for authentication that might be required by specific authentication providers. These could include things like additional credentials or metadata.

ModioCreateModFileParams

Strong type for the parameters needed to create a mod file

Variables


`FString`	`PathToModRootDirectory`	The file system path that references the directory with the mod files. The plugin will compress the contents of this path into a .zip archive.

ModioCreateModParams

Strong type for the parameters needed to create a mod file

Variables


`FString`	`PathToLogoFile`	The file system path to the file used as the mod logo
`FString`	`Name`	The name for the mod to create
`FString`	`Summary`	Brief description for the mod to create

ModioCreateSourceFileParams

Strong type for the parameters needed to create a mod file

Variables


`FString`	`PathToModRootDirectory`	Path to a directory to treat as the root of the mod source. The SDK will compress all contents of this folder into a .zip archive, with a relative path based on this directory. This directory will not be created itself, the contents will exist at the top level of the archive.

ModioEditModParams

Struct type to specify the fields to update for a mod

ModioOptionalEntitlement

Strong type struct to store an optional Entitlement parameter

ModioEntitlementWalletBalance

Updated wallet balance from the sync entitlements call

Variables


`FModioUnsigned64`	`Balance`	The updated balance of the wallet

ModioOptionalEntitlementWalletBalance

Optional updated wallet balance from the sync entitlements call

ModioEntitlementConsumptionVirtualCurrencyDetails

Further details about a Virtual Currency entitlement that was consumed

Variables


`int32`	`TokensAllocated`	Amount of tokens that were issued for this specific entitlement consumption

EntitlementConsumptionStatus

The result of an entitlement's consumption

Variables


`FString`	`TransactionId`	ID of the transaction to redeem this entitlement
`EModioEntitlementConsumptionState`	`TransactionState`	State of the transaction
`FString`	`SkuId`	ID of the SKU that we attempted to consume
`bool`	`EntitlementConsumed`	Whether this entitlement was consumed or not
`EModioEntitlementType`	`EntitlementType`	Type of Entitlement that was consumed
`FModioEntitlementConsumptionVirtualCurrencyDetails`	`VirtualCurrencyDetails`	Details about virtual currency entitlement consumption

ModioEntitlementConsumptionStatusList

Class representing a list of entitlement consumption statuses that may be a page from a larger set of results

Variables


`FModioPagedResult`	`PagedResult`	Stored property for a paged result, which provides context on the entitlement consumption status list
`TArray<FEntitlementConsumptionStatus>`	`InternalList`	Stored property for the dependency list
`FModioOptionalEntitlementWalletBalance`	`WalletBalance`	Updated wallet balance from syncing entitlements

ModioInitializeOptions

Struct type to store the initialization options used by the mod.io SDK

Variables


`FModioGameID`	`GameId`	The mod.io-provided ID for the game
`FModioApiKey`	`ApiKey`	The mod.io-provided API key for your application or game
`EModioEnvironment`	`GameEnvironment`	The mod.io environment you want to run the SDK on
`EModioPortal`	`PortalInUse`	The portal your title is running through
`TMap<FString,FString>`	`ExtendedInitializationParameters`	Extended platform-specific initialization parameters. Refer to the platform documentation for valid keys and their values. Unrecognized values will be ignored
`bool`	`bUseBackgroundThread`	Set mod.io to run with background thread

ModioApiKey

Strong type struct to wrap an ApiKey, used to communicate with the mod.io service

ModioModChangeMap

Strong type struct to wrap mod change information

Variables


`TMap<FModioModID,EModioModChangeType>`	`Changes`	A map representing mod change types for each mod ID

ModioModCreationHandle

Struct type to store the handle when a new mod is created

ModioModProgressInfo

Strong type struct representing the progress of a mod installation or update

Variables


`FModioModID`	`ID`	The mod ID of the mod being processed

ModioOptionalModProgressInfo

Struct strong type to wrap an optional value for the ModProgressInfo

ModioServerInitializeOptions

Struct type to store the initialization options used by the mod.io SDK in the context of a dedicated server

Experimental Feature

This class is part of an experimental feature and is subject to change.

Variables


`FModioInitializeOptions`	`BaseOptions`	The base initialize options required in any Mod.io initialization context.
`FString`	`ModsDirectory`	The directory where mods should be stored on this Server
`FString`	`Token`	The S2S token for this Server
`TArray<FModioModID>`	`Mods`	What mods this Server will use.

StorageInfoKey

Composite key for looking up storage metrics by location and usage type. * Combines an EModioStorageLocation (where the data lives) with an EModioStorageUsage (whether reporting consumed vs. available space). Implements equality and hashing so it can be used as a key in hashed containers (e.g., TMap).

Variables


`EModioStorageLocation`	`Location`
`EModioStorageUsage`	`Usage`

ModioStorageInfo

Strongly-typed container for storage space metrics (consumed/available) across storage locations. * Stores storage values (in bytes) keyed by EModioStorageLocation and EModioStorageUsage, and provides convenience accessors via GetSpace(...) to query the recorded amount for a given key.

ModioLink

Strong type struct to store links and metadata associated with a mod

Variables


`FString`	`Text`	The user-facing text for the link
`FString`	`URL`	The actual URL for the link
`bool`	`bRequired`	Is displaying this link mandatory?

ModioTerms

Struct with the strings to display to a user when showing the terms of use and the reference URLs to mod.io user account page

Variables


`FString`	`AgreeButtonText`	Text to display on the affirmative/OK button
`FString`	`DisagreeButtonText`	Text to display on the negative/cancel button
`FModioLink`	`WebsiteLink`	Link to the mod.io website
`FModioLink`	`TermsLink`	Link to the mod.io terms of use
`FModioLink`	`PrivacyLink`	Link to the mod.io Privacy Policy
`FModioLink`	`RefundLink`	Link to the mod.io Refund Policy
`FModioLink`	`ManageLink`	Link to the mod.io Manage User Account page
`FModioLink`	`MonetizationLink`	Link to the mod.io Monetization Policy
`FString`	`TermsText`	The plaintext version of the mod.io terms of use

ModioOptionalTokenPack

Strong type struct to store an optional TokenPack parameter

ModioOptionalUser

Struct wrapper for an optional ModioUser

ModioValidationError

Wrapper struct containing information about a field validation error

Variables


`FString`	`FieldName`	String description of the field that failed validation
`FString`	`ValidationFailureDescription`	String description of the validation failure

ModioGuid

Strong type struct to wrap a Guid, used to communicate with the mod.io metrics service

ModioOptionalGuid

Strong type struct to wrap Guid as an optional value

ModioEmailAddress

Strong type struct to wrap an email address

ModioEmailAuthCode

Strong type struct to wrap the code sent to the email address to obtain an authentication token

ModioMetricsSessionParams

Simple struct to store metric session specific parameters

ModioTokenPackID

Strong type struct to wrap Token Pack ID

ModioPresetFilterParams

Helper struct for named preset filter parameters

Variables


`FText`	`PresetName`	Preset name
`TArray<FString>`	`Tags`	List of tags to filter on
`TArray<FString>`	`ExcludedTags`	List of tags to exclude from filtering
`EModioSortDirection`	`Direction`	Sorting direction (default is ascending)
`EModioSortFieldType`	`SortField`	Field to use for sorting (default is ID)
`EModioRevenueFilterType`	`RevenueField`	Field to use for revenue (default is FreeAndPaid)
`TSoftClassPtr<UWidget>`	`TileWidgetClass`	Field to use for the widget class (default is nullptr)
`int64`	`Count`	Number of results to return

ModioImageWrapper

Strong type struct to wrap image data returned by the mod.io API

Variables


`FString`	`ImagePath`	The path on disk to the image

ModioModCollectionEntry

Struct representing a mod which is installed locally

ModioModDependency

Basic reference data about a dependency relationship to another mod

Experimental Feature

This class is part of an experimental feature and is subject to change.

Variables


`FModioModID`	`ModID`	The ID of the mod dependency
`FString`	`ModName`	The name of the mod dependency
`FDateTime`	`DateAdded`	Unix timestamp of the date the mod was registered
`FDateTime`	`DateUpdated`	Unix timestamp of the date the mod was updated
`uint8`	`DependencyDepth`	The level at which this dependency sits. When greater than zero (0), it means that this dependency relies on additional dependencies.
`FModioLogo`	`Logo`	Media data related to the mod logo
`FModioFileMetadata`	`FileInfo`	Information about the mod's most recent public release
`EModioModServerSideStatus`	`Status`	The current ModStatus on the server: Accepted, NotAccepted, or Deleted.
`EModioObjectVisibilityFlags`	`Visibility`	The visibility status of the mod, default to Public

ModioModDependencyList

Strong type struct to wrap multiple ModDependency indexed by a paged result

Experimental Feature

This class is part of an experimental feature and is subject to change.

Variables


`FModioPagedResult`	`PagedResult`	Stored property for a paged result, which provides context on the dependency list
`TArray<FModioModDependency>`	`InternalList`	Stored property for the dependency list
`FModioUnsigned64`	`TotalFilesize`	Total size of all the dependency files in bytes.
`FModioUnsigned64`	`TotalFilesizeUncompressed`	Total size of the uncompressed dependency files in bytes.

ModioReportParams

Struct type to store the parameters used to report a mod

ModioOptionalTokenPackList

Struct to wrap ModInfoList into an optional parameter

ModioTransactionRecord

Contains information about a successful transaction for a mod

Variables


`FModioModID`	`AssociatedModID`	The mod the purchase was for
`FModioUnsigned64`	`Price`	The price the mod was purchased for
`FModioUnsigned64`	`UpdatedUserWalletBalance`	The updated balance in the user's wallet after the transaction

ModioCreateModFileMemoryParams

Variables


`TArray<uint8>`	`ModMemory`

Functions

Get Localized Text for Enum by Name

Returns the localized string table FText for a given enum value's FName. Only works with enums registered via ModioUI::RegisterEnumAsLocalizable.

FText GetLocalizedTextForEnumByName(FName EnumName)

Parameters


`EnumName`	The `FName` of the given enum value to fetch its localized string

Returns

Localized FText for the specified enum value, or a dummy FText if not found

FileSizeToText (Unsigned64)

Converts an Unsigned64 filesize to a human-readable string with the appropriate unit. * The function attempts to display the size in the largest unit that will have an integral part > 0, or in the specified unit if Unit is set to something other than Largest.

nd_img_ModioUIEnumLocalizationLibrary_FileSizeUnsigned64_ToText.png

FText FileSizeUnsigned64_ToText(FModioUnsigned64 FileSize, int32 MinDecimals, int32 MaxDecimals, EFileSizeUnit Unit, bool bIncludeUnitName)

Parameters


`FileSize`	The filesize in bytes to convert to human-readable format
`MinDecimals`	The minimum number of decimals to display for the filesize
`MaxDecimals`	The maximum number of decimals to display for the filesize
`Unit`	The unit to display the filesize in (defaults to the largest appropriate unit)
`bIncludeUnitName`	Whether or not to include the unit name in the result

Returns

An FText formatted with the specified filesize and unit

Get Localized Text from Default Table by Key

Returns the localized string table Text for a given string key

FText GetLocalizedTextFromDefaultTableByKey(FString StringKey)

Parameters


`StringKey`	The key to look up in the string table

Returns

Localized FText for the specified key, or StringKey itself if not found

Get Total Progress

Retrieve the total amount of progress required for a specified state

FModioUnsigned64 GetTotalProgress(FModioModProgressInfo Info, EModioModProgressState State)

Parameters


`Info`	The progress struct to query
`State`	The state to query total progress for

Returns

An FModioUnsigned64 representing the total progress in bytes

Get Current State

Get the current state of the mod operation

EModioModProgressState GetCurrentState(FModioModProgressInfo Info)

Parameters


`Info`	The progress struct to query

Returns

An EModioModProgressState indicating the current state of the mod operation

Get Current Progress

Retrieve the progress value for a specified state If the state has completed, CurrentProgress will equal TotalProgress. For example, if a mod is currently in the Extracting state, querying progress for the Downloading state will return a value equal to the total download size because the download is complete.

FModioUnsigned64 GetCurrentProgress(FModioModProgressInfo Info, EModioModProgressState State)

Parameters


`Info`	The progress struct to query
`State`	The state to query progress information for

Returns

An FModioUnsigned64 representing the current progress in bytes

Get Space by Key

Returns the recorded storage space for a given storage location and usage type

FModioUnsigned64 GetSpaceByKey(FModioStorageInfo Info, FStorageInfoKey StorageKey)

Parameters


`Info`
`StorageKey`	Where the storage has been written to and what type of usage to query

Returns

Total storage space in bytes

Get Space

Returns the recorded storage space for a given storage location and usage type

FModioUnsigned64 GetSpace(FModioStorageInfo Info, EModioStorageLocation Location, EModioStorageUsage Usage)

Parameters


`Info`
`Location`	Where the storage has been written to
`Usage`	The type of storage usage recorded

Returns

Total storage space in bytes

Is Purchasable

Check if the token pack is purchasable

bool IsPurchasable(FModioTokenPack In)

Parameters


`In`	The token pack to check if it is purchasable

Returns

True if the token pack is purchasable, false otherwise

Get Title

Get the title of the token pack

FText GetTitle(FModioTokenPack In)

Parameters


`In`	The token pack to retrieve the title from

Returns

The title text of the token pack

Get Regular Price

Get the regular price of the token pack

FText GetRegularPrice(FModioTokenPack In)

Parameters


`In`	The token pack to retrieve the regular price from

Returns

The regular price text of the token pack

Get Numeric Price

Get the numeric price of the token pack

int64 GetNumericPrice(FModioTokenPack In)

Parameters


`In`	The token pack to retrieve the numeric price from

Returns

The numeric price of the token pack

Get Modio Id

Get the Modio ID for this token pack

FModioTokenPackID GetModioId(FModioTokenPack In)

Parameters


`In`	The token pack to retrieve the Modio ID from

Returns

The Modio ID of the token pack

Get Long Description

Get the long description of the token pack

FText GetLongDescription(FModioTokenPack In)

Parameters


`In`	The token pack to retrieve the long description from

Returns

The long description text of the token pack

Get Id

Get the ID of the token pack

FString GetId(FModioTokenPack In)

Parameters


`In`	The token pack to retrieve the ID from

Returns

The ID of the token pack

Get Fields

Get any dynamic fields associated with the token pack

TMap<FString,FString> GetFields(FModioTokenPack In)

Parameters


`In`	The token pack to retrieve dynamic fields from

Returns

A map of dynamic fields for the token pack

Get Display Price

Get the display price of the token pack

FText GetDisplayPrice(FModioTokenPack In)

Parameters


`In`	The token pack to retrieve the display price from

Returns

The display price text of the token pack

Get Description

Get the description of the token pack

FText GetDescription(FModioTokenPack In)

Parameters


`In`	The token pack to retrieve the description from

Returns

The description text of the token pack

ModioUnsigned64 - ModioUnsigned64

Subtracts one FModioUnsigned64 from another

nd_img_ModioUnsigned64Library_Subtract.png

FModioUnsigned64 Subtract(FModioUnsigned64 LHS, FModioUnsigned64 RHS)

Parameters


`LHS`
`RHS`

Percentage Unsigned 64

Calculates the percentage of one FModioUnsigned64 value in relation to another

float Percentage_Unsigned64(FModioUnsigned64 LHS, FModioUnsigned64 RHS)

Parameters


`LHS`
`RHS`

ModioUnsigned64 != ModioUnsigned64

Compares two FModioUnsigned64 values for inequality

nd_img_ModioUnsigned64Library_NotEqualTo.png

bool NotEqualTo(FModioUnsigned64 LHS, FModioUnsigned64 RHS)

Parameters


`LHS`
`RHS`

Make from Components

Creates an FModioUnsigned64 from two 32-bit components

FModioUnsigned64 MakeFromComponents(int32 High, int32 Low)

Parameters


`High`
`Low`

ModioUnsigned64 < ModioUnsigned64

Compares two FModioUnsigned64 values to see if the left-hand side is less than the right-hand side

nd_img_ModioUnsigned64Library_LessThan.png

bool LessThan(FModioUnsigned64 LHS, FModioUnsigned64 RHS)

Parameters


`LHS`
`RHS`

ModioUnsigned64 > 0

Checks if FModioUnsigned64 is greater than zero

nd_img_ModioUnsigned64Library_GreaterThanZero.png

bool GreaterThanZero(FModioUnsigned64 In)

Parameters


`In`

ModioUnsigned64 > ModioUnsigned64

Compares two FModioUnsigned64 values to see if the left-hand side is greater than the right-hand side

nd_img_ModioUnsigned64Library_GreaterThan.png

bool GreaterThan(FModioUnsigned64 LHS, FModioUnsigned64 RHS)

Parameters


`LHS`
`RHS`

ModioUnsigned64 == ModioUnsigned64

Compares two FModioUnsigned64 values for equality

nd_img_ModioUnsigned64Library_EqualTo.png

bool EqualTo(FModioUnsigned64 LHS, FModioUnsigned64 RHS)

Parameters


`LHS`
`RHS`

ModioUnsigned64 / ModioUnsigned64

Divides two FModioUnsigned64 values and returns the result as a float

nd_img_ModioUnsigned64Library_DivideToFloat.png

float DivideToFloat(FModioUnsigned64 LHS, FModioUnsigned64 RHS)

Parameters


`LHS`
`RHS`

ModioUnsigned64 / float

Divides an FModioUnsigned64 by a float and returns the result as a float

nd_img_ModioUnsigned64Library_DivideFloat.png

float DivideFloat(FModioUnsigned64 LHS, float RHS)

Parameters


`LHS`
`RHS`

ModioUnsigned64 / ModioUnsigned64 (truncate)

Divides two FModioUnsigned64 values (truncate result)

nd_img_ModioUnsigned64Library_Divide.png

FModioUnsigned64 Divide(FModioUnsigned64 LHS, FModioUnsigned64 RHS)

Parameters


`LHS`
`RHS`

Break to Components

Breaks a FModioUnsigned64 into two components: high and low 32-bits

void BreakToComponents(FModioUnsigned64 In, int32 High, int32 Low)

Parameters


`In`
`High`
`Low`

ModioUnsigned64 + ModioUnsigned64

Adds two FModioUnsigned64 values together

FModioUnsigned64 Add(FModioUnsigned64 LHS, FModioUnsigned64 RHS)

Parameters


`LHS`
`RHS`

Get Users

Retrieve the list of users from the user list

TArray<FModioUser> GetUsers(FModioUserList UserList)

Parameters


`UserList`	The user list to retrieve the Users from

Returns

An array of FModioUser objects representing the Users in the list

Get Paged Result

Retrieve paged result information for a user list

FModioPagedResult GetPagedResult(FModioUserList UserList)

Parameters


`UserList`	The user list to retrieve paged result information from

Returns

An FModioPagedResult containing metadata about the paginated data

Set Session Identifier

Changes the session identifier for the provided set of ModioInitializeOptions

FModioInitializeOptions SetSessionIdentifier(FModioInitializeOptions Options, FString SessionIdentifier)

Parameters


`Options`	The template `ModioInitializeOptions`
`SessionIdentifier`	The new session id to use

Returns

New ModioInitializeOptions object with the session identifier set to the desired value

Set Session Id

Changes the session identifier for the provided Metrics Session parameters

FModioMetricsSessionParams SetSessionId(FModioMetricsSessionParams Params, FModioGuid Id)

Parameters


`Params`	The template Metrics Session parameters
`Id`	The intended Guid to store in the Metrics Session parameters

Set Portal

Changes the portal for the provided set of ModioInitializeOptions

FModioInitializeOptions SetPortal(FModioInitializeOptions Options, EModioPortal PortalToUse)

Parameters


`Options`	The template `ModioInitializeOptions`
`PortalToUse`	The new portal to use

Returns

New ModioInitializeOptions object with the portal set to the desired value

Set Game Id

Changes the game id for the provided set of ModioInitializeOptions

FModioInitializeOptions SetGameId(FModioInitializeOptions Options, int64 GameId)

Parameters


`Options`	The template `ModioInitializeOptions`
`GameId`	The new game id to use

Returns

New ModioInitializeOptions object with the game id set to the desired value

Set Game Environment

Changes the game environment for the provided set of ModioInitializeOptions

FModioInitializeOptions SetGameEnvironment(FModioInitializeOptions Options, EModioEnvironment GameEnvironment)

Parameters


`Options`	The template `ModioInitializeOptions`
`GameEnvironment`	The new environment to use

Returns

New ModioInitializeOptions object with the game environment set to the desired value

Set Extended Initialization Parameters

Sets extended initialization parameters for the provided set of ModioInitializeOptions

FModioInitializeOptions SetExtendedInitializationParameters(FModioInitializeOptions Options, TMap<FString,FString> ExtendedParameters)

Parameters


`Options`	The template `ModioInitializeOptions`
`ExtendedParameters`	The new extended parameters to use (will overwrite existing values)

Returns

New ModioInitializeOptions object with the extended parameters set to the desired value

Set Background Thread

Changes the background thread usage for the provided set of ModioInitializeOptions

FModioInitializeOptions SetBackgroundThread(FModioInitializeOptions Options, bool bUseBackgroundThread)

Parameters


`Options`	The template `ModioInitializeOptions`
`bUseBackgroundThread`	Whether to use a background thread

Returns

New ModioInitializeOptions object with the background thread usage set to the desired value

Set API Key

Changes the API key for the provided set of ModioInitializeOptions

FModioInitializeOptions SetAPIKey(FModioInitializeOptions Options, FString APIKey)

Parameters


`Options`	The template `ModioInitializeOptions`
`APIKey`	The new API key to use

Returns

New ModioInitializeOptions object with the API key set to the desired value

ModioModID != ModioModID

Compares two mod IDs to check whether they're not equal

nd_img_ModioCommonTypesLibrary_NotEqualTo.png

bool NotEqualTo(FModioModID A, FModioModID B)

Parameters


`A`
`B`

Make Server Initialize Options

Make ModioServerInitializeOptions. Should only be used in conjunction with InitializeServerAsync.

FModioServerInitializeOptions MakeServerInitializeOptions(FModioInitializeOptions BaseOptions, FString ModsDirectory, FString Token, TArray<FModioModID> Mods)

Parameters


`BaseOptions`
`ModsDirectory`	The directory to store modfiles on this server.
`Token`	The S2S token for this Server.
`Mods`	The mods this server should load and use.

Make Metrics Session Params

Create Metrics Session parameters

FModioMetricsSessionParams MakeMetricsSessionParams(TArray<FModioModID> Ids)

Parameters


`Ids`	The list of mods to store within the Metrics Session parameters

Make Initialize Options

Make ModioInitializeOptions. Should only be used in conjunction with InitializeAsync.

FModioInitializeOptions MakeInitializeOptions(int64 GameId, FString APIKey, EModioEnvironment GameEnvironment, EModioPortal PortalInUse, bool bUseBackgroundThread)

Parameters


`GameId`	A positive integer that maps to your game. This can be found in the admin section of your game's page at https://mod.io/
`APIKey`	The API key for your game. This can be found in the admin section of your game's page at https://mod.io/
`GameEnvironment`	The environment your game has been set up on: test or live.
`PortalInUse`	The `EModioPortal` representing the store or service your game is being
`bUseBackgroundThread`	Whether to run the mod.io SDK on a background thread. Defaults to `true`. distributed through. Defaults to `EModioPortal::None`.

Make Guid

Create a Guid from a string

FModioGuid MakeGuid(FString Guid)

Parameters


`Guid`	A string to wrap within a Guid struct

Make Game Id

Create a game id from a integer. Should only be used in conjunction with InitializeAsync

FModioGameID MakeGameId(int64 GameId)

Parameters


`GameId`	A positive integer that maps to your game

Make Entitlement Params

Create entitlement parameters

FModioEntitlementParams MakeEntitlementParams(TMap<FString,FString> ExtendedParameters)

Parameters


`ExtendedParameters`	A map to store extended parameters required by some portals

Make Auth Params

Creates a ModioAuthenticationParams object

FModioAuthenticationParams MakeAuthParams(FString AuthToken, FString EmailAddress, bool bHasAcceptedTOS)

Parameters


`AuthToken`	Authentication provider-supplied OAuth token
`EmailAddress`	User email address, can be left blank
`bHasAcceptedTOS`	Has the user been shown the Terms of Service and accepted the Terms of Service?

Returns

The constructed ModioAuthenticationParams object for use with AuthenticateUserExternalAsync

Make Api Key

Create an ApiKey id from a string. Should only be used in conjunction with InitializeAsync

FModioApiKey MakeApiKey(FString ApiKey)

Parameters


`ApiKey`	The api key from your settings panel on mod.io

Get Raw Value from Mod ID

Retrieves the raw underlying value from an ModioModID. ModioModIDs are intended as opaque types, so use with care.

int64 GetRawValueFromModID(FModioModID In)

Parameters


`In`	The `ModioModID` to retrieve the value for

Returns

The underlying value

Get Raw Value from Mod Collection ID

Retrieves the raw underlying value from an ModioModCollectionID. ModioModCollectionIDs are intended as opaque types, so use with care.

int64 GetRawValueFromModCollectionID(FModioModCollectionID In)

Parameters


`In`	The `ModioModCollectionID` to retrieve the value for

Returns

The underlying value

ModioModCollectionID == ModioModCollectionID

Compares two mod Collection IDs to check whether they're equal

nd_img_ModioCommonTypesLibrary_EqualToModCollectionID.png

bool EqualToModCollectionID(FModioModCollectionID A, FModioModCollectionID B)

Parameters


`A`
`B`

ModioModID == ModioModID

Compares two mod IDs to check whether they're equal

nd_img_ModioCommonTypesLibrary_EqualTo.png

bool EqualTo(FModioModID A, FModioModID B)

Parameters


`A`
`B`

Set Version String

Sets the version string of the mod file

void SetVersionString(FModioCreateModFileParams In, FString Version)

Parameters


`In`	The mod file creation parameters to modify
`Version`	The version string of the mod file

Set Tags

Sets tags for the mod

void SetTags(FModioCreateModParams In, TArray<FString> Tags)

Parameters


`In`	The mod creation parameters to modify
`Tags`	The tags for the mod

Set Source File Version String

Sets the version string of the source file

void SetSourceFileVersionString(FModioCreateSourceFileParams In, FString Version)

Parameters


`In`	The source file creation parameters to modify
`Version`	The version string of the source file

Set Source File Platforms

Sets the source file platforms of the source file

void SetSourceFilePlatforms(FModioCreateSourceFileParams In, TArray<EModioModfilePlatform> Platforms)

Parameters


`In`	The source file creation parameters to modify
`Platforms`	The source file platforms of the source file

Set Source File Metadata Blob

Sets the source file metadata blob of the source file

void SetSourceFileMetadataBlob(FModioCreateSourceFileParams In, FString MetadataBlob)

Parameters


`In`	The source file creation parameters to modify
`MetadataBlob`	The source file metadata blob of the source file

Set Source File Changelog String

Sets the changelog string of the source file

void SetSourceFileChangelogString(FModioCreateSourceFileParams In, FString Changelog)

Parameters


`In`	The source file creation parameters to modify
`Changelog`	The changelog string of the source file

Set Modfile Platforms

Sets the mod file platforms of the mod file

void SetModfilePlatforms(FModioCreateModFileParams In, TArray<EModioModfilePlatform> Platforms)

Parameters


`In`	The mod file creation parameters to modify
`Platforms`	The mod file platforms of the mod file

Set Mod File Metadata Blob

Sets the mod file metadata blob of the mod file

void SetModFileMetadataBlob(FModioCreateModFileParams In, FString MetadataBlob)

Parameters


`In`	The mod file creation parameters to modify
`MetadataBlob`	The mod file metadata blob of the mod file

Set Metadata Blob

void SetMetadataBlob(FModioCreateModParams In, FString MetadataBlob)

Set Maturity Flags

Sets the metadata blob of the mod

void SetMaturityFlags(FModioCreateModParams In, EModioMaturityFlags MaturityFlags)

Parameters


`In`	The mod creation parameters to modify
`MaturityFlags`

Set Mark as Active Release

Sets the MarkAsActiveRelease flag of the mod file

void SetMarkAsActiveRelease(FModioCreateModFileParams In, bool bMarkAsActiveRelease)

Parameters


`In`	The mod file creation parameters to modify
`bMarkAsActiveRelease`	The MarkAsActiveRelease flag of the mod file

Set Initial Visibility DEPRECATED

void SetInitialVisibility_DEPRECATED(FModioCreateModParams In, bool InitialVisibility)

Set Initial Visibility

Sets the initial visibility of the mod

void SetInitialVisibility(FModioCreateModParams In, EModioObjectVisibilityFlags InitialVisibility)

Parameters


`In`	The mod creation parameters to modify
`InitialVisibility`	The initial visibility of the mod

Set Homepage URL

Sets the homepage URL of the mod

void SetHomepageURL(FModioCreateModParams In, FString HomepageURL)

Parameters


`In`	The mod creation parameters to modify
`HomepageURL`	The homepage URL of the mod

Set Description

Sets the description of the mod

void SetDescription(FModioCreateModParams In, FString Description)

Parameters


`In`	The mod creation parameters to modify
`Description`	The description of the mod

Set Community Options Flags

void SetCommunityOptionsFlags(FModioCreateModParams In, EModioModCommunityOptionsFlags CommunityOptionsFlags)

Set Changelog String

Sets the changelog string of the mod file

void SetChangelogString(FModioCreateModFileParams In, FString Changelog)

Parameters


`In`	The mod file creation parameters to modify
`Changelog`	The changelog string of the mod file

Reconstruct Error

Helper method to reconstruct a mod.io error passed via code that cannot reference mod.io types

FModioErrorCode ReconstructError(int32 Value, int32 Category)

Parameters


`Value`	The numeric value of the code
`Category`	The category ID (populated by native code)

IsError

Checks if an error code contains a error

bool IsErrorAsExec(FModioErrorCode Error)

Parameters


`Error`

Returns

true if the error code is an error

Get Value

Get underlying error code for an FModioErrorCode.

int32 GetValue(FModioErrorCode Error)

Parameters


`Error`

Returns

The underlying error code. 0 represents no error.

Get Message

Get the textual representation of the error

FString GetMessage(FModioErrorCode Error)

Parameters


`Error`

Returns

An FString message describing the error

Error Code Matches

Checks if the passed-in ErrorCode matches the specified error condition

bool ErrorCodeMatches(FModioErrorCode ErrorCode, EModioErrorCondition Condition)

Parameters


`ErrorCode`	The code to check
`Condition`	The error condition to check against

Returns

True if the code matches the condition

Load Async

Load the texture into memory asynchronously. If it's already in memory, it will be returned immediately.

void LoadAsync(FModioImageWrapper Image, FOnLoadImageDelegate OnImageLoaded)

Parameters


`Image`	The image to load
`On Image Loaded`	Called when the image has been loaded

Get Texture

Get the texture if it has been loaded by any FModioImage instance

UTexture2DDynamic* GetTexture(FModioImageWrapper Image)

Parameters


`Image`	The image to get the texture from

Returns

The texture if it has been loaded, otherwise nullptr

Get State

Get the current state of the image

EModioImageState GetState(FModioImageWrapper Image)

Parameters


`Image`	The image to get the state of

Returns

The state of the image

Get Logo Size

If the logo size is EModioLogoSize::Original, the original logo size is returned. Otherwise, the thumbnail size of the logo is returned.

FVector2D GetLogoSize(UTexture* Logo, EModioLogoSize LogoSize)

Parameters


`Logo`	If null and `EModioLogoSize::Original` is passed, (0, 0) is returned.
`LogoSize`	The size of the logo to return

Returns

Dimensions of the logo when displayed in a 1:1 pixel ratio

Get Gallery Size

If the gallery image size is EModioGallerySize::Original, the original gallery image size is returned. Otherwise, the thumbnail size of the gallery image is returned.

FVector2D GetGallerySize(UTexture* GalleryImage, EModioGallerySize GallerySize)

Parameters


`GalleryImage`	If null and EModioGallerySize::Original is passed, (0, 0) is returned.
`GallerySize`	The size of the gallery image to return

Returns

Dimensions of the gallery image when displayed in a 1:1 pixel ratio

Get Avatar Size

If the avatar size is EModioAvatarSize::Original, the original avatar size is returned. Otherwise, the thumbnail size of the avatar is returned.

FVector2D GetAvatarSize(UTexture* Avatar, EModioAvatarSize AvatarSize)

Parameters


`Avatar`	If null and EModioAvatarSize::Original is passed, (0, 0) is returned.
`AvatarSize`	The size of the avatar to return

Returns

Dimensions of the avatar when displayed in a 1:1 pixel ratio

Get Paged Result

Retrieve paged result information for a mod collection info list

FModioPagedResult GetPagedResult(FModioModCollectionInfoList ModCollectionInfoList)

Parameters


`ModCollectionInfoList`	The mod collection info list to retrieve paged result information from

Returns

An FModioPagedResult containing metadata about the paginated data

Get Collections

Retrieve the list of mod collections from the mod collection info list

TArray<FModioModCollectionInfo> GetCollections(FModioModCollectionInfoList ModCollectionInfoList)

Parameters


`ModCollectionInfoList`	The mod collection info list to retrieve the mod collections from

Returns

An array of FModioModCollectionInfo objects representing the mod collections in the list

Get Path

Get the installation path for a mod on disk

FString GetPath(FModioModCollectionEntry Entry)

Parameters


`Entry`	The mod collection entry to retrieve the installation path from

Returns

A FString representing the path to the mod's installation folder. If the mod is not yet installed, this path may not exist. Use GetModState to check the mod's status before accessing files.

Get Mod State

Get the current state of a mod within the collection

EModioModState GetModState(FModioModCollectionEntry Entry)

Parameters


`Entry`	The mod collection entry to retrieve the state from

Returns

An EModioModState enum representing the current state of the mod

Get Mod Profile

Get the profile information of a mod

FModioModInfo GetModProfile(FModioModCollectionEntry Entry)

Parameters


`Entry`	The mod collection entry to retrieve the profile information from

Returns

An FModioModInfo structure containing the mod's profile data

Get ID

Retrieve the Mod ID from the mod collection entry

FModioModID GetID(FModioModCollectionEntry Entry)

Parameters


`Entry`	The mod collection entry to retrieve the ID from

Returns

A FModioModID representing the ID of the mod

Get Total Filesize Uncompressed

Get the total size of all uncompressed dependency files in bytes

FModioUnsigned64 GetTotalFilesizeUncompressed(FModioModDependencyList DependencyList)

Parameters


`DependencyList`	The dependency list to calculate the total uncompressed file size for

Returns

An int64 representing the total size of all uncompressed dependency files in bytes

Get Total Filesize

Get the total size of all dependency files in bytes

FModioUnsigned64 GetTotalFilesize(FModioModDependencyList DependencyList)

Parameters


`DependencyList`	The dependency list to calculate the total file size for

Returns

An int64 representing the total size of all dependency files in bytes

Get Paged Result

Retrieve paged result information for a dependency list

FModioPagedResult GetPagedResult(FModioModDependencyList DependencyList)

Parameters


`DependencyList`	The dependency list to retrieve paged result information from

Returns

An FModioPagedResult containing metadata about the paginated data

Get Dependencies

Retrieve the list of mod dependencies from the dependency list

TArray<FModioModDependency> GetDependencies(FModioModDependencyList DependencyList)

Parameters


`DependencyList`	The dependency list to retrieve mod dependencies from

Returns

An array of FModioModDependency representing the dependencies of a mod

Get Paged Result

Retrieve paged result information for a mod info list

FModioPagedResult GetPagedResult(FModioModInfoList ModInfoList)

Parameters


`ModInfoList`	The mod info list to retrieve paged result information from

Returns

An FModioPagedResult containing metadata about the paginated data

Get Mods

Retrieve the list of mods from the mod info list

TArray<FModioModInfo> GetMods(FModioModInfoList ModInfoList)

Parameters


`ModInfoList`	The mod info list to retrieve the mods from

Returns

An array of FModioModInfo objects representing the mods in the list

Get Tags

Retrieve the tags from a mod tag options list

TArray<FModioModTagInfo> GetTags(FModioModTagOptions ModTags)

Parameters


`ModTags`	The mod tag options list to retrieve tags from

Returns

An array of FModioModTagInfo representing the tags available for a mod

Get Paged Result

Retrieve paged result information for a mod tag options list

FModioPagedResult GetPagedResult(FModioModTagOptions ModTags)

Parameters


`ModTags`	The mod tag options list to retrieve paged result information from

Returns

An FModioPagedResult containing metadata about the paginated data

Get Default Portal for Current Platform

Get the default portal for the platform the game is running on.

EModioPortal GetDefaultPortalForCurrentPlatform()

Parameters

Returns

EModioPortal of the portal to use

Get Default Auth Provider for Current Platform

Get the default Authentication Provider for the current platform the game is running on

EModioAuthenticationProvider GetDefaultAuthProviderForCurrentPlatform()

Parameters

Returns

EModioAuthenticationProvider to use for authentication calls

Get Current Platform

Gets the current platform that the game is running on

EModioPlatformName GetCurrentPlatform()

Parameters

Returns

EModioPlatformName of the current platform

Make Report for User

Creates a content report for a user.

FModioReportParams MakeReportForUser(FModioUserID User, EModioReportType Type, FString ReportDescription, FString ReporterName, FString ReporterContact)

Parameters


`User`	The ID of the User being reported
`Type`	The nature of the content report (e.g., abuse, inappropriate behavior)
`ReportDescription`	A description of why the content is being reported
`ReporterName`	Name of the submitting user. Recommended for DMCA reports, but may be empty
`ReporterContact`	Contact details of the submitting user. Recommended for DMCA reports, but may be empty

Returns

A struct containing the report parameters

Make Report for Mod

Creates a content report for a mod.

FModioReportParams MakeReportForMod(FModioModID Mod, EModioReportType Type, FString ReportDescription, FString ReporterName, FString ReporterContact)

Parameters


`Mod`	The ID of the content being reported (mod)
`Type`	The nature of the content report (e.g., abuse, inappropriate content)
`ReportDescription`	A description of why the content is being reported
`ReporterName`	Name of the submitting user. Recommended for DMCA reports, but may be empty
`ReporterContact`	Contact details of the submitting user. Recommended for DMCA reports, but may be empty

Returns

A struct containing the report parameters

Make Report for Game

Creates a content report for a game.

FModioReportParams MakeReportForGame(FModioGameID Game, EModioReportType Type, FString ReportDescription, FString ReporterName, FString ReporterContact)

Parameters


`Game`	The ID of the game being reported
`Type`	The nature of the content report (e.g., abuse, inappropriate content)
`ReportDescription`	A description of why the content is being reported
`ReporterName`	Name of the submitting user. Recommended for DMCA reports, but may be empty
`ReporterContact`	Contact details of the submitting user. Recommended for DMCA reports, but may be empty

Returns

A struct containing the report parameters

Round Number String

Round a number string based on the file size or speed.

FText RoundNumberString(FText inputText)

Parameters


`inputText`	The text representing the input number.

Returns

The rounded number string.

Get Percent (integer64/integer64)

Calculate the percentage between two int64 values.

nd_img_ModioSDKLibrary_Pct_Int64Int64.png

float Pct_Int64Int64(int64 Dividend, int64 Divisor)

Parameters


`Dividend`	The numerator of the percentage calculation.
`Divisor`	The denominator of the percentage calculation.

Returns

The floating-point result of Dividend/Divisor.

Is Valid Security Code Format

Check if the supplied string has the format of a valid mod.io security code.

bool IsValidSecurityCodeFormat(FString String)

Parameters


`String`	The string to check.

Returns

True if the string matches the mod.io security code format.

Is Valid Email Address Format

Validate if the supplied email address has a valid format.

bool IsValidEmailAddressFormat(FString String)

Parameters


`String`	The email address to validate.

Returns

True if the email address is valid.

BytesGreaterThan (Filesize)

nd_img_ModioSDKLibrary_IsFilesizeGreaterThanUnit.png

bool IsFilesizeGreaterThanUnit(FModioUnsigned64 FileSize, EFileSizeUnit Unit)

Parameters


`FileSize`
`Unit`

Get Time Span as String

Get the time span between the present and a specified past date as a string.

FString GetTimeSpanAsString(FString PastDateString)

Parameters


`PastDateString`	The past date to compare against the current time.

Returns

The time span as a string (e.g., "2 days ago").

Get Shortened Number as String

Shorten a large number for better readability.

FString GetShortenedNumberAsString(int64 Number)

Parameters


`Number`	The large number to shorten.

Returns

The shortened number as a string.

Get Project Initialize Options for Session Id

Get the options needed to initialize the mod.io SDK specified in the project settings.

FModioInitializeOptions GetProjectInitializeOptionsForSessionId(FString SessionId)

Parameters


`SessionId`	The session ID to initialize the project with.

Returns

The mod.io initialization options for the provided session ID.

Get Project Game Id

Get the game ID specified in the mod.io project settings.

FModioGameID GetProjectGameId()

Parameters

Returns

The project game ID.

Get Project Environment

Get the environment specified in the mod.io project settings.

EModioEnvironment GetProjectEnvironment()

Parameters

Returns

The project environment type (e.g., production, staging).

Get Project Api Key

Get the API key specified in the mod.io project settings.

FModioApiKey GetProjectApiKey()

Parameters

Returns

The project API key.

GetPreviousSize

Get the previous file size unit from the current unit.

EFileSizeUnit GetPreviousSize(EFileSizeUnit Unit, bool WrapAround)

Parameters


`Unit`	The current file size unit.
`WrapAround`	Whether to wrap around to the largest unit if the current unit is the smallest.

Returns

The previous file size unit.

GetNextSize

Get the next file size unit from the current unit.

EFileSizeUnit GetNextSize(EFileSizeUnit Unit, bool WrapAround)

Parameters


`Unit`	The current file size unit.
`WrapAround`	Whether to wrap around to the smallest unit if the current unit is the largest.

Returns

The next file size unit.

Get Monetization Purchase Category

Get the purchase category ID for the store overlay UI for a given portal.

FString GetMonetizationPurchaseCategory(EModioPortal Portal)

Parameters


`Portal`	The mod.io portal.

Returns

The purchase category ID as a string, or empty if not defined.

Get Language Code String

Get the language code string (ISO 639-1 format) for localization purposes.

FString GetLanguageCodeString(EModioLanguage Language)

Parameters


`Language`	The language enum to convert.

Returns

The language code as a string (e.g., "en", "fr", "de").

Get Language Code from String

Convert a language code string to the corresponding language enum.

EModioLanguage GetLanguageCodeFromString(FString LanguageCode)

Parameters


`LanguageCode`	The language code string (e.g., "en", "fr", "de").

Returns

The corresponding language enum.

GetDesiredFileSizeUnit (FModioUnsigned64)

Get the appropriate file size unit based on the file size in bytes.

nd_img_ModioSDKLibrary_GetDesiredFileSizeUnit_Unsigned64.png

EFileSizeUnit GetDesiredFileSizeUnit_Unsigned64(FModioUnsigned64 FileSize)

Parameters


`FileSize`	The file size in bytes as a FModioUnsigned64.

Returns

The desired file size unit.

Get Default Session Id Windows

Get the session ID for Windows to initialize the SDK.

FString GetDefaultSessionIdWindows()

Parameters

Returns

The Windows session ID, or an empty string if the platform is not Windows.

ToString (EFileSizeUnit)

Convert a file size unit to a human-readable string.

nd_img_ModioSDKLibrary_FileSizeUnit_ToString.png

FString FileSizeUnit_ToString(EFileSizeUnit Unit)

Parameters


`Unit`	The file size unit to convert.

Returns

A formatted string representing the file size unit.

ToString (ModioUnsigned64)

Convert a file size to a human-readable string with the appropriate unit.

nd_img_ModioSDKLibrary_Filesize_ToString_Unsigned64.png

FText Filesize_ToString_Unsigned64(FModioUnsigned64 FileSize, int32 MinDecimals, int32 MaxDecimals, EFileSizeUnit Unit, bool bIncludeUnitName)

Parameters


`FileSize`	The file size in bytes as a FModioUnsigned64.
`MinDecimals`	Minimum number of decimal places to show.
`MaxDecimals`	Maximum number of decimal places to show.
`Unit`	The unit to use (e.g., bytes, KB, MB). If 'Largest', the unit will automatically scale to the largest possible unit.
`bIncludeUnitName`	Whether to include the unit name (e.g., "MB").

Returns

A formatted string representing the file size.

ToBytes (Filesize)

Returns the byte size of the given FilesizeUnit (e.g EFileSizeUnit::KB returns 1024)

nd_img_ModioSDKLibrary_Filesize_ToBytes.png

FModioUnsigned64 Filesize_ToBytes(EFileSizeUnit FileSizeUnit)

Parameters


`FileSizeUnit`	The unit to convert to a byte value

Returns

The byte value of the given unit.

GetDefaultModInstallationDirectory

Returns the default mod installation directory for this game and platform, ignoring overrides and without requiring the SDK to be initialized.

FString K2_GetDefaultModInstallationDirectory(FModioGameID GameID)

Parameters


`GameID`	The `ModioGameID` of the game we're fetching the default mod installation directory for.

Returns

The default mod installation directory for the specified game on the current platform

To Filter Params

Converts a preset filter into a concrete set of filter parameters that can be passed to the mod.io plugin

FModioFilterParams ToFilterParams(FModioPresetFilterParams Preset)

Parameters


`Preset`	The preset to convert

Returns

The converted filter params

List User Subscription Async

Runs a filter over the user's subscription list

void ListUserSubscriptionAsync(FModioFilterParams FilterParams, FOnListAllModsDelegate Callback)

Parameters


`FilterParams`	The filters to use on the user's subscription list
`Callback`	Called when mod list has been processed

Get Logo Thumbnail Size

Get the project specified logo thumbnail size

EModioLogoSize GetLogoThumbnailSize()

Parameters

Get Logo Full Size

Get the project specified logo full size

EModioLogoSize GetLogoFullSize()

Parameters

Get Avatar Thumbnail Size

Get the project specified avatar thumbnail size

EModioAvatarSize GetAvatarThumbnailSize()

Parameters

SubmitNewModFromMemoryAsync

Submit a new mod, with its logo data coming from an in-memory buffer rather than a file.

void K2_SubmitNewModFromMemoryAsync(FModioModCreationHandle Handle, FModioCreateModParams Params, TArray<uint8> PngData, FOnSubmitNewModDelegate Callback)

Parameters


`Handle`	Mod creation handle
`Params`	Parameters to use when creating the mod
`PngData`	In-memory buffer, representative of a PNG file to be used for upload
`Callback`	Callback once operation has completed

SubmitNewModFileForModFromMemory

Queues the upload of a new mod file release for the specified mod, using the submitted parameters. This upload method accepts a block of memory TArray<uint8> rather than a file path. The upload's progress can be tracked in the same way as downloads; when completed, a Mod Management Event will be triggered with the result code for the upload.

void K2_SubmitNewModFileForModFromMemory(UModioSubsystem* Target, FModioModID Mod, FModioCreateModFileMemoryParams Params)

Requirements

initialized-sdk
authenticated-user

Parameters


`Target`	`UModioSubsystem*`
`Mod`	The ID of the mod you are submitting a file for
`Params`	Information about the mod file being created, including the memory that will be uploaded as a mod

LoadModFileToMemory

Loads an installed mod file into memory.

bool K2_LoadModFileToMemory(UModioSubsystem* Target, FModioModID ModId, TArray<uint8> ModData)

Requirements

initialized-sdk
authenticated-user

Parameters


`Target`	`UModioSubsystem*`
`ModId`
`Mod Data`	A byte array of the mod that has been loaded

Enums

EModioEntitlementType

Type of entitlement that was consumed


`VirtualCurrency`
`SKU`

EModioGameCloudCookingStatus

Cloud Cooking status for this game


`Disabled`
`Initializing`
`Initialized`
`Finalizing`
`Enabled`
`ActionRequired`
`TearingDown`

EModioPlacementSize

Size of the placement to display


`Small`
`Medium`	(default)
`Large`

EModioPlacementType

Type of the placement


`Filters`

EModioModfilePlatform

Enum representing the platform(s) that a modfile is enabled for


`Windows`
`Mac`
`Linux`
`Android`
`iOS`
`XboxOne`
`XboxSeriesX`
`PS4`
`PS5`
`Switch`
`Switch2`
`Oculus`
`Source`
`WindowsServer`
`LinuxServer`

EGameMaturityFlags

Maturity options for a game


`None`	Don't allow mature content in mods (default)
`MatureModsAllowed`	This game allows mods containing mature content
`MatureAudiencesOnly`	This game is for mature audiences only

EGameMonetizationFlags

Monetization properties of a game


`None`	None set (default)
`Monetization`	Monetization is enabled
`Marketplace`	Marketplace is enabled
`PartnerProgram`	Partner Program is enabled

EModioMaturityFlags

Enum representing mature content that a mod may contain


`None`	No maturity
`Alcohol`	Content contains alcohol references
`Drugs`	Content contains drug references
`Violence`	Content contains violence references
`Explicit`	Content contains sexual references

EModioObjectVisibilityFlags

Enum representing whether or not a mod is visible to users


`Hidden`	Mod is concealed from users
`Public`	Mod is openly available

EModioModServerSideStatus

Enum representing a mod's server-side status


`NotAccepted`
`Accepted`
`Deleted`

EModioVirusStatus

If the file has been found to be malicious or not


`NoThreat`
`Malicious`
`PotentiallyHarmful`

EModioVirusScanStatus

Current state of the scanned file


`NotScanned`
`ScanComplete`
`InProgress`
`TooLargeToScan`
`FileNotFound`
`ErrorScanning`

EModioModCommunityOptionsFlags

Enum representing community options for a mod Unreal's Enum class flags don't support uint32, so we use uint8 for bitmask handling


`None`	No community options
`EnableComments`	Comments are enabled
`EnablePreviews`	Enable Previews
`EnablePreviewURLs`	Enable Preview URLs
`AllowDependencies`	Allow mod dependencies

EModioRating

Enumerator with the rating a mod can receive


`Neutral`	A neutral rating
`Positive`	A positive rating
`Negative`	A negative rating

EModioModManagementEventType

What type of event occurred


`Installed`	Mod installation to local storage completed
`Uninstalled`	Mod uninstallation from local storage completed
`Updated`	Mod local installation updated to latest version
`Uploaded`	Mod file was uploaded
`BeginInstall`	Mod download and installation has started
`BeginUninstall`	Mod uninstallation has started
`BeginUpdate`	Mod download and update has started
`BeginUpload`	Mod upload has started

EModioAuthenticationProvider

Simple struct to encapsulate data passed to external authentication systems


`XboxLive`
`Steam`
`GoG`
`Itch`
`Switch`
`Switch2`
`Discord`
`PS`	Deprecated as of 2026.9 release. Please use PS
`Epic`
`Oculus`
`OpenID`
`GoogleIDToken`
`GoogleServerSideToken`

EModioEntitlementConsumptionState

State of an entitlement consumption transaction


`Failed`
`Pending`
`Fulfilled`
`ConsumeLimitExceeded`

EModioErrorCondition


`NoError`
`NetworkError`	When this condition is true, the error code represents a connection or HTTP error between the client and the mod.io server.
`ConfigurationError`	When this condition is true, the error code indicates the SDK's configuration is not valid - the game ID or API key are incorrect or the game has been deleted.
`InvalidArgsError`	When this condition is true, the error code indicates the arguments passed to the function have failed validation or were otherwise invalid.
`FilesystemError`	When this condition is true, the error code indicates a permission or IO error when accessing local filesystem data.
`InternalError`	When this condition is true, the error code represents an internal SDK error - please inform mod.io of the error code value.
`ApiErrorRefSuccess`	When this condition is true, the error ref returned by the API indicates an implicit success because the operation has already been performed (ie a no-op is success).
`EntityNotFoundError`	When this condition is true, the error code indicates that a specified game, mod, user, media file or mod file was not found.
`UserTermsOfUseError`	When this condition is true, the error code indicates that the user has not yet accepted the mod.io Terms of Use.
`SubmitReportError`	When this condition is true, the error code indicates that a report for the specified content could not be submitted.
`UserNotAuthenticatedError`	When this condition is true, the error code indicates that a user is not authenticated.
`SDKNotInitialized`	When this condition is true, the error code indicates that the SDK has not been initialized.
`UserAlreadyAuthenticatedError`	When this condition is true, the error code indicates that the user is already authenticated.
`SystemError`	When this condition is true, the error code indicates that a low-level system error occurred outside of mod.io SDK control.
`OperationCanceled`	When this condition is true, the error code indicates that the asynchronous operation was cancelled before it completed.
`ModManagementDisabled`	When this condition is true, the error code indicates that Mod Management has not been enabled.
`RateLimited`	Too many requests made to the mod.io API within the rate-limiting window. Please wait and try again.
`ModBeingProcessed`	The specified mod's files are currently being updated by the SDK. Please try again later.
`InsufficientSpace`	There is insufficient space to install the mod. Please free up space and try again.
`SDKAlreadyInitialized`	When this condition is true, the error code indicates that the SDK has already been initialized.
`ModManagementAlreadyEnabled`	When this condition is true, the error code indicates that Mod Management has already been enabled.
`InsufficientPermissions`	When this condition is true, the error code indicates that the current user does not have the required permissions for this operation.
`EmailLoginCodeInvalid`	The email login code is incorrect, has expired, or has already been used.
`AlreadySubscribed`	The specified mod is already subscribed to.
`InstallOrUpdateCancelled`	The current mod installation or update was cancelled.
`UploadCancelled`	The current modfile upload was cancelled.
`TempModSetNotInitialized`	TempModSet need to be initialized first, call InitTempModSet.
`MonetizationOperationError`	An error occurred while performing a monetization operation.
`MonetizationPlatformAuthInvalid`	Platform auth failure when performing a monetization operation. The platform auth parameters may be invalid or expired.
`PaymentTransactionFailed`	The transaction requires a payment but it could not be fulfilled. Please retry with funds on the wallet
`IncorrectPrice`	The display price for the mod is out-of-date or incorrect. Please retry with the correct display price.
`ItemAlreadyOwned`	The authenticated user already has acquired this item
`ParentalControlRestrictions`	Parental control restrictions prevent this account from accessing UGC.
`MetricsSessionNotInitialized`	Metrics session has not yet been initialized. Ensure that you have a metrics secret key set for your project.
`MetricsSessionAlreadyInitialized`	Metrics session has already been been initialized.
`MetricsSessionIsActive`	Metrics session has been started.
`MetricsSessionIsNotActive`	Metrics session has not been started. Please call MetricsSessionStartAsync.
`MetricsSessionHasNoMods`	No mods have been added to the session.
`PremiumFeatureNotAvailable`	This premium feature is not available for your project.
`EmailExchangeCodeAlreadyRedeemed`	The email security code has already been redeemed.
`ModDependenciesNotAllowed`	Cannot add a dependency because the target mod has not opted in to dependencies.
`ModCannotAddDependencyMonetized`	Cannot add a dependency because the mod is monetized.
`ModIsDependency`	Cannot turn off mod dependencies when the mod is currently a dependency for other mods.
`ModCannotAllowDependencyMonetized`	This mod cannot allow dependencies because it is monetized.
`ModCannotDeleteDependency`	This mod is a dependency of other mods and cannot be deleted.
`RequestInProgress`	The asynchronous operation is already running. Please wait for it to complete before calling it again
`InvalidZipFile`	The zip file submitted is invalid.
`CloudCookingDisabled`	Cloud Cooking is disabled for this game.
`AlreadySubscribedToUser`	The authenticated user is already subscribed to the user.
`CannotSubscribeToSelf`	You cannot subscribe to yourself.

EModioImageState

Enumerator to represent the possible states the image data can be, from hard drive to corrupted


`OnDisc`	Image data is located on hard drive
`LoadingIntoMemory`	Image data is transferring to a memory location
`InMemory`	Image data is located in memory
`Corrupted`	Image data is not readable

EModioModProgressState

Enum representing the possible states of mod progress


`Initializing`	Download information is being retrieved from mod.io servers
`Downloading`	Mod archive is downloading from mod.io servers
`Extracting`	Mod archive is downloaded and now extracting
`Compressing`	Mod archive is being compressed from files on disk
`Uploading`	Mod archive is uploading to mod.io servers

EModioOpenStoreResult

Enumerator of potential results on attempting to open a native platform store


`Success`	Store opened successfully *
`FailedInactive`	Monetization not active *
`FailedUnsupportedPlatform`	The current platform does not support a native store *
`FailedStoreNotLoaded`	The current platform has not loaded the store skus yet *
`FailedStoreEmpty`	The current platform has no products in the store *
`FailedUnknown`	Failed to open for an unknown reason *

EModioStorageLocation

Identifies the backing location used to store data.


`Local`
`Cache`

EModioStorageUsage

Indicates how a storage amount should be interpreted when reporting disk usage. * Use Consumed for space already used by mod.io data, and Available for free space that can be used for downloads/installs.


`Consumed`
`Available`

EModioEnvironment

Enum representing which environment the game is deployed to: Test or Live.


`Test`	Test (private) environment
`Live`	Live (public) environment

EModioPortal

Enum representing the store or service your game is being distributed through


`None`
`Apple`
`EpicGamesStore`
`GOG`
`Google`
`Itchio`
`Nintendo`
`PS`	Deprecated as of 2026.9 release. Please use PS
`Steam`
`XboxLive`

EModioPlatformName

Enum representing a named platform that the plugin is running on.


`Windows`
`Mac`
`Linux`
`PS4`
`PS5`
`XBoxOne`
`XSX`
`Switch`
`Switch2`
`Unknown`
`Android`
`iOS`

EModioLogoSize

Enum representing mod logo sizes


`Thumb320`	320x180px
`Thumb640`	640x360px
`Thumb1280`	1280x720px
`Original`	Original Size

EModioAvatarSize

Enum representing avatar image sizes


`Original`	Original Size
`Thumb50`	50x50px Thumbnail
`Thumb100`	100x100px Thumbnail

EModioGallerySize

Enum for the standard size a gallery image can use


`Original`	Original Size
`Thumb320`	320x180px Thumbnail
`Thumb1280`	1280x720 Thumbnail

EModioLogLevel

Degree of severity for the log output


`Trace`	Detailed low-level debugging output. Not intended for general use
`Detailed`	Detailed but not low-level. Generally useful for some mid-level information for debugging.
`Info`	Informational output containing status messages
`Warning`	Warnings about incorrect plugin usage, timeouts
`Error`	Only errors

EModioLanguage

Enum representing the languages mod.io supports responses in


`English`
`Bulgarian`
`French`
`German`
`Italian`
`Polish`
`Portuguese`
`PortugueseBrazilian`
`Hungarian`
`Japanese`
`Korean`
`Russian`
`Spanish`
`Thai`
`ChineseSimplified`
`ChineseTraditional`
`Turkish`
`Ukrainian`
`Arabic`
`Czech`

EModioModChangeType

Enum representing the types of changes that can occur to a mod in the user's list


`Added`	The user's list has a new mod to synchronize
`Removed`	The user's list must remove a mod to synchronize
`Updated`	The user's list must update a mod to synchronize

EFileSizeUnit

Enumerator with the possible memory measurement units


`Largest`	Will take the largest one that becomes a number larger than 1 (i.e, 1300mb becomes 1.3gb)
`B`	A single byte
`KB`	Kilobytes
`MB`	Megabytes
`GB`	Gigabytes

EModioSortFieldType

Enum indicating which field should be used to sort the results


`ID`	Use mod ID (default)
`DownloadsToday`	Use number of downloads in last 24 (exposed in REST API as "popular")
`SubscriberCount`	Use number of subscribers
`Rating`	Use mod rating
`DateMarkedLive`	Use date mod was marked live
`DateUpdated`	Use date mod was last updated
`DownloadsTotal`	Use downloads total
`Alphabetical`	Use mod name

EModioSortDirection

Enum indicating which direction sorting should be applied


`Ascending`	(default)
`Descending`	Sort in descending order

EModioRevenueFilterType

Enum indicating filtering options based off revenue type


`Free`	Return only free mods
`Paid`	Return only paid mods
`FreeAndPaid`	Return both free and paid mods
`FreeAndPaidWeighted`	Return both free and paid mods at game specified weighting

EModioFilterTimespan

Enum indicating the duration from which results should be included


`Today`
`Week`	(default)
`Month`
`ThreeMonths`
`Year`
`AllTime`

EModioModState

Enum representing the current state of a mod


`InstallationPending`	The mod is pending installation. This state is not saved.
`Installed`	The mod is installed.
`UpdatePending`	The mod is pending an update. This state is saved as installed.
`Downloading`	The mod is downloading as part of the installation process. This state is not saved.
`Extracting`	The mod is extracting as part of the installation process. This state is not saved.
`UninstallPending`	The mod is pending uninstallation. This state is saved as installed.

EModioReportType

Enumeration for the type of report that a mod can receive


`Generic`	A generic mod report
`DMCA`	Digital Millennium Copyright Act mod report
`NotWorking`	Not working mod report
`RudeContent`	Rude content mod report
`IllegalContent`	Illegal content mod report
`StolenContent`	Stolen content mod report
`FalseInformation`	False information mod report
`Other`	Other type of mod report

Classes
Structs
Functions
Enums

Classes​

ModioCommonTypesLibrary​

Inheritance Hierarchy​

ModioCreateModLibrary​

Inheritance Hierarchy​

ModioErrorCodeLibrary​

Inheritance Hierarchy​

ModioErrorConditionLibrary​

Inheritance Hierarchy​

ModioExampleLibrary​

Inheritance Hierarchy​

ModioImageLibrary​

Inheritance Hierarchy​

ModioModCollectionInfoListLibrary​

Inheritance Hierarchy​

ModioModCollectionLibrary​

Inheritance Hierarchy​

ModioModDependenciesLibrary​

Inheritance Hierarchy​

ModioModInfoListLibrary​

Inheritance Hierarchy​

ModioModProgressInfoLibrary​

Inheritance Hierarchy​

ModioModTagOptionsLibrary​

Inheritance Hierarchy​

ModioMultiplayerSubsystem​

Inheritance Hierarchy​

RegisterClientModsWithServerAsync​

Parameters​

Error Values​

InstallOrUpdateServerModsAsync​

Parameters​

InitializeServerAsync​

Parameters​

Error Values​

GetRegisteredClientMods​

Parameters​

Returns​

ClearRegisteredClientMods​

Parameters​

ModioPlatformHelpersLibrary​

Inheritance Hierarchy​

ModioPortalInterface​

Inheritance Hierarchy​

Should Show SKUInformation​

Parameters​

Returns​

Sanitize File Path​

Request Store Purchase​

Request SKUMappings​

Request Open Store​

Request Entitlement Params​

Parameters​

Request Auth Token​

Parameters​

Prepare Filesystem to Use Path​

Notify Store Browsing​

Parameters​

Initialize Platform​

Get Extended Initialization Params​

Get Extended Auth Params​

ModioPresetFilterParamsLibrary​

Inheritance Hierarchy​

ModioReportLibrary​

Inheritance Hierarchy​

ModioSDKLibrary​

Inheritance Hierarchy​

ModioStorageInfoLibrary​

Inheritance Hierarchy​

ModioSubmissionExtensionLibrary​

Inheritance Hierarchy​

SubmitModChangesAsync​

Requirements​

Parameters​

Error Values​

ModioSubsystem​

Inheritance Hierarchy​

Set Log Level​

Parameters​

Run Pending Handlers​

Classes

ModioCommonTypesLibrary

Inheritance Hierarchy

ModioCreateModLibrary

Inheritance Hierarchy

ModioErrorCodeLibrary

Inheritance Hierarchy

ModioErrorConditionLibrary

Inheritance Hierarchy

ModioExampleLibrary

Inheritance Hierarchy

ModioImageLibrary

Inheritance Hierarchy

ModioModCollectionInfoListLibrary

Inheritance Hierarchy

ModioModCollectionLibrary

Inheritance Hierarchy

ModioModDependenciesLibrary

Inheritance Hierarchy

ModioModInfoListLibrary

Inheritance Hierarchy

ModioModProgressInfoLibrary

Inheritance Hierarchy

ModioModTagOptionsLibrary

Inheritance Hierarchy

ModioMultiplayerSubsystem

Inheritance Hierarchy

RegisterClientModsWithServerAsync

Parameters

Error Values

InstallOrUpdateServerModsAsync

Parameters

InitializeServerAsync

Parameters

Error Values

GetRegisteredClientMods

Parameters

Returns

ClearRegisteredClientMods

Parameters

ModioPlatformHelpersLibrary

Inheritance Hierarchy

ModioPortalInterface

Inheritance Hierarchy

Should Show SKUInformation

Parameters

Returns

Sanitize File Path

Request Store Purchase

Request SKUMappings

Request Open Store

Request Entitlement Params

Parameters

Request Auth Token

Parameters

Prepare Filesystem to Use Path

Notify Store Browsing

Parameters

Initialize Platform

Get Extended Initialization Params

Get Extended Auth Params

ModioPresetFilterParamsLibrary

Inheritance Hierarchy

ModioReportLibrary

Inheritance Hierarchy

ModioSDKLibrary

Inheritance Hierarchy

ModioStorageInfoLibrary

Inheritance Hierarchy

ModioSubmissionExtensionLibrary

Inheritance Hierarchy

SubmitModChangesAsync

Requirements

Parameters

Error Values

ModioSubsystem

Inheritance Hierarchy

Set Log Level

Parameters

Run Pending Handlers