Unity v2 Plugin 0.1
mod management for Unity projects
ModIO Namespace Reference

Classes

struct  BuildSettings
 Build-specific configuration values. More...
 
class  CreationToken
 
struct  DownloadReference
 Used in ModIOUnity.DownloadTexture() to get the Texture. (DownloadReference is serializable with Unity's JsonUtility) More...
 
struct  InstalledMod
 
class  ModfileDetails
 
struct  ModId
 
class  ModIOUnity
 Main interface for the mod.io Unity plugin. More...
 
class  ModIOUnityAsync
 
struct  ModPage
 
struct  ModProfile
 
class  ModProfileDetails
 Use this class to fill out the details of a Mod Profile that you'd like to create or edit. If you're submitting this via CreateModProfile you must assign values to logo, name and summary, otherwise the submission will be rejected (All fields except modId are optional if submitting this via EditModProfile) More...
 
struct  ModStats
 
class  ProgressHandle
 A ProgressHandle can only be used to monitor the progress of an operation and cannot be used to cancel or suspend ongoing operations. The OperationType enum field specifies what type of operation this handle is for. The Progress field can be used to get the percentage (0.0 - 1.0) of the progress. The Completed and Failed fields can be used to determine if the operation is complete and whether or not it failed. More...
 
class  Report
 Used in conjunction with ModIOUnity.Report() to send a report to the mod.io server for a specific mod. More...
 
struct  Result
 Struct returned from ModIO callbacks to inform the caller if the operation succeeded. More...
 
class  ResultAnd
 Convenience wrapper for essentially a Tuple. More...
 
class  SearchFilter
 Used to build a filter that is sent with requests for retrieving mods. More...
 
struct  ServerSettings
 Describes the server settings to use for the ModIO Plugin. More...
 
struct  SubscribedMod
 
struct  Tag
 
struct  TagCategory
 
struct  TermsHash
 
struct  TermsOfUse
 
struct  TermsOfUseLink
 
struct  UserProfile
 

Enumerations

enum  AuthenticationServiceProvider {
  Steam , Epic , GOG , Itchio ,
  Oculus , Xbox , Switch , Discord ,
  Google
}
 
enum  AvatarSize { Original , Thumbnail_50x50 , Thumbnail_100x100 }
 
enum  ContentWarnings {
  None = 0x00 , Alcohol = 0x01 , Drugs = 0x02 , Violence = 0x04 ,
  Explicit = 0x08
}
 
enum  LogLevel {
  None = -1 , Error = 0 , Warning = 1 , Message = 2 ,
  Verbose
}
 
enum  ModManagementEventType {
  InstallStarted , Installed , InstallFailed , DownloadStarted ,
  Downloaded , DownloadFailed , UninstallStarted , Uninstalled ,
  UninstallFailed , UpdateStarted , Updated , UpdateFailed
}
 
enum  ModManagementOperationType {
  None_AlreadyInstalled , None_ErrorOcurred , Install , Download ,
  Uninstall , Update , Upload
}
 
enum  ModRating { Positive = 1 , Negative = -1 , None = 0 }
 
enum  ModStatus { Accepted , NotAccepted , Deleted }
 
enum  OculusDevice { Rift , Quest }
 
enum  ReportType {
  Generic = 0 , DMCA = 1 , NotWorking = 2 , RudeContent = 3 ,
  IllegalContent = 4 , StolenContent = 5 , FalseInformation = 6 , Other = 7
}
 
enum  SortModsBy {
  Name , Rating , Popular , Downloads ,
  Subscribers , DateSubmitted
}
 
enum  SubscribedModStatus {
  Installed , WaitingToDownload , WaitingToInstall , WaitingToUpdate ,
  WaitingToUninstall , Downloading , Installing , Uninstalling ,
  Updating , ProblemOccurred , None
}
 
enum  UserPortal {
  None = 0 , Apple , Discord , EpicGamesStore ,
  GOG , Google , itchio , Nintendo ,
  Oculus , PlayStationNetwork , Steam , XboxLive
}
 Values representing the valid User Portals that mod.io works with.
 

Functions

delegate void LogMessageDelegate (LogLevel logLevel, string logMessage)
 Logging delegate that can be assigned via ModIOUnity.SetLogMessageDelegate.
 
delegate void ModManagementEventDelegate (ModManagementEventType eventType, ModId modId)
 A delegate that gets invoked each time a new ModManagement event happens (download, install, subscribe, etc)