Downloads

installMod

installMod(mod_id:Int):Void

Adds the corresponding mod to download queue to be installed locally.

SDK documentation: modioInstallMod

API documentation: n/a

Function parameters

Name	Type	Description
mod_id	Int	Mod's unique identifier.

uninstallMod

uninstallMod(mod_id:Int):Void

Removes the corresponding mod from the local storage.

SDK documentation: modioUninstallMod

API documentation: n/a

Function parameters

Name	Type	Description
mod_id	Int	Mod's unique identifier.

pauseDownloads

pauseDownloads():Void

Pauses the current downloads. The state of the download queue is stored to it can be continued even after the mod.io SDK is shutdown.

SDK documentation: modioPauseDownloads

API documentation: n/a

resumeDownloads

resumeDownloads():Void

Resumes the downloads after a pause.

SDK documentation: modioResumeDownloads

API documentation: n/a

prioritizeDownload

prioritizeDownload(mod_id:Int):Void

Puts the corresponding mod download to the front of the download queue.

SDK documentation: modioPrioritizeModDownload

API documentation: n/a

Function parameters

Name	Type	Description
mod_id	Int	Mod's unique identifier.

setDownloadListener

setDownloadListener(callback:(response_code:Int, mod_id:Int)):Void

Registers a function to be called every time a mod is installed.

SDK documentation: modioSetDownloadListener

API documentation: n/a

Name	Type	Description
callback	(response_code:Int, mod_id:Int)	Function called once the process finished.

getModDownloadQueue

getModDownloadQueue():Array<Dynamic>

Returns an array of QueuedModDownload object which represents the mods that are currently queued to be installed.

SDK documentation: modioGetModDownloadQueueCount and modioGetModDownloadQueue

API documentation: n/a

getInstalledMods

getInstalledMods():Array<Dynamic>

Returns an array of InstalledMod object which represents the mods that are locally installed.

SDK documentation: modioGetAllInstalledModsCount and modioGetAllInstalledMods

API documentation: n/a

getModState

getModState(mod_id:Int):Int

Returns the state of the corresponding mod, see Mod state.

SDK documentation: modioGetModState

API documentation: n/a