Search Results for

    Show / Hide Table of Contents

    Class DewMod

    Manages everything about mods.

    Inheritance
    object
    DewMod
    Namespace: Global
    Assembly: Dew.Core.dll
    Syntax
    public static class DewMod

    Fields

    allJsonOverrideItemsLocal

    All JSON override items from local mods.

    Declaration
    public static List<JsonOverrideItem> allJsonOverrideItemsLocal
    Field Value
    Type Description
    System.Collections.Generic.List<T><JsonOverrideItem>

    allMods

    All mods that are either subscribed by the user or in mods directory. Contains both enabled and disabled mods.

    Declaration
    public static List<ModItem> allMods
    Field Value
    Type Description
    System.Collections.Generic.List<T><ModItem>

    currentJsonOverrideProcessorsFromServer

    GUID to processor map of current JSON overrides, received from the server.

    Declaration
    public static Dictionary<string, SafeAction<GameObject>> currentJsonOverrideProcessorsFromServer
    Field Value
    Type Description
    System.Collections.Generic.Dictionary<TKey, TValue><string, SafeAction<UnityEngine.GameObject>>

    currentJsonOverrideProcessorsLocal

    GUID to processor map of current JSON overrides, from this machine. This will not be applied when playing co-op as a client.

    Declaration
    public static Dictionary<string, SafeAction<GameObject>> currentJsonOverrideProcessorsLocal
    Field Value
    Type Description
    System.Collections.Generic.Dictionary<TKey, TValue><string, SafeAction<UnityEngine.GameObject>>

    jsonOverrideTargets

    Original values of JSON override targets. This acts as a whitelist for overrides.

    Declaration
    public static Dictionary<string, Dictionary<string, string>> jsonOverrideTargets
    Field Value
    Type Description
    System.Collections.Generic.Dictionary<TKey, TValue><string, System.Collections.Generic.Dictionary<TKey, TValue><string, string>>

    loadedInstances

    Currently alive mod instances.

    Declaration
    public static List<LoadedModInstance> loadedInstances
    Field Value
    Type Description
    System.Collections.Generic.List<T><LoadedModInstance>

    onModLoadEnded

    Declaration
    public static SafeAction onModLoadEnded
    Field Value
    Type Description
    SafeAction

    onModLoadStarted

    Declaration
    public static SafeAction onModLoadStarted
    Field Value
    Type Description
    SafeAction

    Properties

    isAutoReloadEnabled

    Declaration
    public static bool isAutoReloadEnabled { get; }
    Property Value
    Type Description
    bool

    isGameplayAltered

    Has the game's gameplay been modified by mods? When this is true, a mod icon will be shown on your lobby when you host a game.

    Declaration
    public static bool isGameplayAltered { get; }
    Property Value
    Type Description
    bool

    isLoadingMod

    Declaration
    public static bool isLoadingMod { get; }
    Property Value
    Type Description
    bool

    Methods

    BuildJsonOverrideOriginal(string)

    Declaration
    public static void BuildJsonOverrideOriginal(string typeName)
    Parameters
    Type Name Description
    string typeName

    BuildJsonOverrideOriginalsFull()

    Declaration
    public static void BuildJsonOverrideOriginalsFull()

    CreateItem()

    Declaration
    public static UniTask<CreateItemResult_t> CreateItem()
    Returns
    Type Description
    Cysharp.Threading.Tasks.UniTask<T><CreateItemResult_t>

    DeleteItem(PublishedFileId_t)

    Declaration
    public static UniTask<DeleteItemResult_t> DeleteItem(PublishedFileId_t id)
    Parameters
    Type Name Description
    Steamworks.PublishedFileId_t id
    Returns
    Type Description
    Cysharp.Threading.Tasks.UniTask<T><DeleteItemResult_t>

    DisableAutoReload()

    Declaration
    public static void DisableAutoReload()

    EnableAutoReload()

    Declaration
    public static void EnableAutoReload()

    EndRegisterJsonOverride()

    Declaration
    public static void EndRegisterJsonOverride()

    GetAllLocalModDirectories()

    Declaration
    public static List<string> GetAllLocalModDirectories()
    Returns
    Type Description
    System.Collections.Generic.List<T><string>

    GetSortedModsList(List<ModItem>)

    Declaration
    public static List<ModItem> GetSortedModsList(List<ModItem> list)
    Parameters
    Type Name Description
    System.Collections.Generic.List<T><ModItem> list
    Returns
    Type Description
    System.Collections.Generic.List<T><ModItem>

    Load(string)

    Declaration
    public static void Load(string id)
    Parameters
    Type Name Description
    string id

    OpenConfigWindow(LoadedModInstance)

    Declaration
    public static void OpenConfigWindow(LoadedModInstance mod)
    Parameters
    Type Name Description
    LoadedModInstance mod

    Refresh()

    Declaration
    public static void Refresh()

    RegisterJsonOverride(JsonOverrideItem, bool)

    Declaration
    public static void RegisterJsonOverride(JsonOverrideItem item, bool isFromServer = false)
    Parameters
    Type Name Description
    JsonOverrideItem item
    bool isFromServer

    RegisterJsonOverride(string)

    Declaration
    public static void RegisterJsonOverride(string path)
    Parameters
    Type Name Description
    string path

    RegisterJsonOverridesInDirectory(string)

    Declaration
    public static void RegisterJsonOverridesInDirectory(string dir)
    Parameters
    Type Name Description
    string dir

    ReloadFromActiveMods()

    Declaration
    public static void ReloadFromActiveMods()

    StartRegisterJsonOverride(bool)

    You must call this before registering any overrides.

    Declaration
    public static void StartRegisterJsonOverride(bool willRegisterAcrossMultipleFrames = false)
    Parameters
    Type Name Description
    bool willRegisterAcrossMultipleFrames

    UpdateItem(PublishedFileId_t, ModItem)

    Declaration
    public static UniTask<SubmitItemUpdateResult_t> UpdateItem(PublishedFileId_t id, ModItem item)
    Parameters
    Type Name Description
    Steamworks.PublishedFileId_t id
    ModItem item
    Returns
    Type Description
    Cysharp.Threading.Tasks.UniTask<T><SubmitItemUpdateResult_t>
    In This Article
    Back to top Shape of Dreams API Documentation