Skip to main content

Unity

Modio.Unity​

TypeDescription
ImageCacheTexture2D
ModioAPIUnityClient
ModioImageTexture2DExtensions
ModioPreInitializer
ModioUnity
ModioUnityLogger
ModioUnityMultiplatformAuthResolver
ModioUnitySettings
ModioUnitySettingsExtensions
ModioUnityThreadSync
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
Property​

bool UseUnityClient​

[ModioDebugMenu(ShowInSettingsMenu = true, ShowInBrowserMenu = false)] public static bool UseUnityClient

get set

Method​

SetBasePath​

public void SetBasePath(string value)

SetUserAgent​

public void SetUserAgent(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, bool allowReauth

GetJson​

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

Dispose​

public void Dispose()

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

ModioUnity​

public static class ModioUnity
Method​

SetUpModioForUnity​

public static void SetUpModioForUnity()

ModioUnityLogger​

public class ModioUnityLogger : IModioLogHandler
Method​

LogHandler​

public void LogHandler(LogLevel logLevel, object message)

ModioUnityMultiplatformAuthResolver​

public class ModioUnityMultiplatformAuthResolver : ModioMultiplatformAuthResolver, IExternalAvatarProviderService<Texture2D>
Property​

bool IsSupportedPlatform​

public static bool IsSupportedPlatform
Method​

TryGetAvatarImage​

public Task<(Error error, Texture2D image)> TryGetAvatarImage()

ModioUnitySettings​

[CreateAssetMenu(fileName = "config.asset", menuName = "Modio/v3/config")] public class ModioUnitySettings : ScriptableObject
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

Method​

InvokeOnChanged​

public void InvokeOnChanged()

LoadSettings​

[ExcludeFromCodeCoverage] public static ModioUnitySettings LoadSettings()

ModioUnitySettingsExtensions​

public static class ModioUnitySettingsExtensions
Method​

GetOrAddPlatformSetting​

public static T GetOrAddPlatformSetting<T>(this ModioUnitySettings unitySettings) where T : IModioServiceSettings

ModioUnityThreadSync​

public static class ModioUnityThreadSync
Property​

SynchronizationContext SynchronizationContext​

public static SynchronizationContext SynchronizationContext

get

Method​

InitializeThreadSync​

public static void InitializeThreadSync()

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;

Returns a value based on Application.persistentDataPath

Method​

GetUserPath​

public Task<string> GetUserPath()

Path to the local user app data folder;

Typically returns Application.persistentDataPath

UnityWebBrowserHandler​

public class UnityWebBrowserHandler : IWebBrowserHandler
Method​

OpenUrl​

public void OpenUrl(string url)

Modio.Unity.Settings​

TypeDescription
UnityMonetizationSettings

UnityMonetizationSettings​

[Serializable] public class UnityMonetizationSettings : MonetizationSettings
Field​

Sprite CurrencyIcon​

Sprite CurrencyIcon