Class ModAPI

Namespace

Ceres.Gameplay.Mod

Assembly

Ceres.Gameplay.dll

public static class ModAPI

Inheritance

object

ModAPI

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Fields

LoadingPath

Default mod loading directory path.

public static readonly string LoadingPath

Field Value

string

Properties

Initialized

Event when mod api is initialized.

public static ReadOnlyReactiveProperty<bool> Initialized { get; }

Property Value

ReadOnlyReactiveProperty<bool>

Refresh

Event when any mod info state is changed.

public static Observable<Unit> Refresh { get; }

Property Value

Observable<Unit>

Methods

DeleteMod(ModInfo)

Delete mod on next launch

public static void DeleteMod(ModInfo modInfo)

Parameters

modInfo ModInfo

DeleteModFromDisk(ModInfo)

Delete mod files from disk, is not safe when is already initialized, recommend to use DeleteMod(ModInfo) to delete mod on next launcher

public static void DeleteModFromDisk(ModInfo modInfo)

Parameters

modInfo ModInfo

EnabledMod(ModInfo, bool)

Enable mod on next launch

public static void EnabledMod(ModInfo modInfo, bool isEnabled)

Parameters

modInfo ModInfo

isEnabled bool

GetAllInfos()

Get all enabled mod infos

public static List<ModInfo> GetAllInfos()

Returns

List<ModInfo>

GetModState(ModInfo)

Get mod state

public static ModStatus GetModState(ModInfo modInfo)

Parameters

modInfo ModInfo

Returns

ModStatus

Initialize(ModConfig, IModLoader)

Initialize api and load all mods

public static UniTask Initialize(ModConfig modConfig, IModLoader modLoader = null)

Parameters

modConfig ModConfig

modLoader IModLoader

Returns

UniTask

LoadModInfo(string)

Load ModInfo from path

public static UniTask<ModInfo> LoadModInfo(string modInfoPath)

Parameters

modInfoPath string

Returns

UniTask<ModInfo>

UnZipAll(string, bool)

Unzip all zip files from path

public static void UnZipAll(string path, bool allDirectories)

Parameters

path string

The root directory path

allDirectories bool

Whether to search all directories

UnZipAllAsync(string, bool)

Unzip all zip files from path asynchronously using multithreading

public static UniTask UnZipAllAsync(string path, bool allDirectories)

Parameters

path string

The root directory path

allDirectories bool

Whether to search all directories

Returns

UniTask