Skip to main content

Unity

Modio.Unity​

TypeDescription
ImageCacheTexture2D
ModioAPIUnityClient
ModioAndroidSettings
ModioImageTexture2DExtensions
ModioPreInitializer
ModioUnityLogger
ModioUnitySettings
UnityRootPathProviderProvides a default root path for non-windows Unity platforms.
UnityWebBrowserHandler

ImageCacheTexture2D​

public class ImageCacheTexture2D : BaseImageCache<Texture2D>
Field​

ImageCacheTexture2D Instance​

ImageCacheTexture2D Instance = new ImageCacheTexture2D()

ModioAPIUnityClient​

public class ModioAPIUnityClient : IModioAPIInterface
Method​

SetBasePath​

public void SetBasePath(string value)

AddDefaultPathParameter​

public void AddDefaultPathParameter(string key, string value)

RemoveDefaultPathParameter​

public void RemoveDefaultPathParameter(string key)

AddDefaultParameter​

public void AddDefaultParameter(string value)

RemoveDefaultParameter​

public void RemoveDefaultParameter(string value)

ResetConfiguration​

public void ResetConfiguration()

DownloadFile​

public async Task<(Error, Stream)> DownloadFile(string url, CancellationToken token

SetDefaultHeader​

public void SetDefaultHeader(string name, string value)

RemoveDefaultHeader​

public void RemoveDefaultHeader(string name)

GetJson​

public Task<(Error error, T? result)> GetJson<T>(ModioAPIRequest request) where T : struct

GetJson​

public Task<(Error error, JToken)> GetJson(ModioAPIRequest request)

Dispose​

public void Dispose()

ModioAndroidSettings​

[Serializable]  public class ModioAndroidSettings : IModioServiceSettings

ModioImageTexture2DExtensions​

public static class ModioImageTexture2DExtensions
Method​

DownloadAsTexture2D​

public static Task<(Error error, Texture2D texture)> DownloadAsTexture2D(this ImageReference imageReference)

DownloadAsTexture2D​

public static Task<(Error error, Texture2D texture)> DownloadAsTexture2D<TResolution>(  this ModioImageSource<TResolution> imageSource,  TResolution resolution  ) where TResolution : Enum

ModioPreInitializer​

public class ModioPreInitializer : MonoBehaviour

ModioUnityLogger​

public class ModioUnityLogger : IModioLogHandler
Method​

LogHandler​

public void LogHandler(LogLevel logLevel, object message)

ModioUnitySettings​

[CreateAssetMenu(fileName
Field​

string DefaultResourceName​

string DefaultResourceName = "mod.io/v3_config"

string DefaultResourceNameOverride​

string DefaultResourceNameOverride = "mod.io/v3_config_local"
Property​

ModioSettings Settings​

public ModioSettings Settings

get

UnityRootPathProvider​

public class UnityRootPathProvider : IModioRootPathProvider

Provides a default root path for non-windows Unity platforms.

Property​

string Path​

public string Path

Path to the shared public folder;

Typically returns "C:\Users\Public"

string UserPath​

public string UserPath

Path to the local user app data folder;

Typically returns "C:\Users&lt;UserName>\AppData\Roaming"

UnityWebBrowserHandler​

public class UnityWebBrowserHandler : IWebBrowserHandler
Method​

OpenUrl​

public void OpenUrl(string url)

Modio.Unity.Settings​

TypeDescription
ModioComponentUISettings

ModioComponentUISettings​

[Serializable]  public class ModioComponentUISettings : IModioServiceSettings
Field​

bool ShowMonetizationUI​

bool ShowMonetizationUI

bool ShowEnableModToggle​

bool ShowEnableModToggle

bool FallbackToEmailAuthentication​

bool FallbackToEmailAuthentication