Skip to content

Class: DewMod ​

  • Namespace: Global
  • Assembly: Dew.Core.dll
csharp
public static class DewMod

Fields ​

NameDeclarationDescription
allJsonOverrideItemsLocalpublic static List<JsonOverrideItem> allJsonOverrideItemsLocalAll JSON override items from local mods.
allModspublic static List<ModItem> allModsAll mods that are either subscribed by the user or in mods directory. Contains both enabled and disabled mods.
currentJsonOverrideProcessorsFromServerpublic static Dictionary<string, SafeAction<GameObject>> currentJsonOverrideProcessorsFromServerGUID to processor map of current JSON overrides, received from the server.
currentJsonOverrideProcessorsLocalpublic static Dictionary<string, SafeAction<GameObject>> currentJsonOverrideProcessorsLocalGUID to processor map of current JSON overrides, from this machine. This will not be applied when playing co-op as a client.
jsonOverrideTargetspublic static Dictionary<string, Dictionary<string, string>> jsonOverrideTargetsOriginal values of JSON override targets. This acts as a whitelist for overrides.
loadedInstancespublic static List<LoadedModInstance> loadedInstancesCurrently alive mod instances.
onModLoadEndedpublic static SafeAction onModLoadEnded
onModLoadStartedpublic static SafeAction onModLoadStarted

Properties ​

NameDeclarationDescription
isAutoReloadEnabledpublic static bool isAutoReloadEnabled { get; }
isGameplayAlteredpublic static bool isGameplayAltered { get; }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.
isLoadingModpublic static bool isLoadingMod { get; }

Methods ​

BuildJsonOverrideOriginal(string) ​

csharp
public static void BuildJsonOverrideOriginal(string typeName)

Parameters:

NameTypeDescription
typeNamestring

BuildJsonOverrideOriginalsFull() ​

csharp
public static void BuildJsonOverrideOriginalsFull()

CreateItem() ​

csharp
public static UniTask<CreateItemResult_t> CreateItem()

Returns: Cysharp.Threading.Tasks.UniTask&lt;T&gt;&lt;CreateItemResult_t&gt;

DeleteItem(PublishedFileId_t) ​

csharp
public static UniTask<DeleteItemResult_t> DeleteItem(PublishedFileId_t id)

Parameters:

NameTypeDescription
idSteamworks.PublishedFileId_t

Returns: Cysharp.Threading.Tasks.UniTask&lt;T&gt;&lt;DeleteItemResult_t&gt;

DisableAutoReload() ​

csharp
public static void DisableAutoReload()

EnableAutoReload() ​

csharp
public static void EnableAutoReload()

EndRegisterJsonOverride() ​

csharp
public static void EndRegisterJsonOverride()

GetAllLocalModDirectories() ​

csharp
public static List<string> GetAllLocalModDirectories()

Returns: System.Collections.Generic.List&lt;T&gt;&lt;string&gt;

GetSortedModsList(List&lt;ModItem&gt;) ​

csharp
public static List<ModItem> GetSortedModsList(List<ModItem> list)

Parameters:

NameTypeDescription
listSystem.Collections.Generic.List<T><ModItem>

Returns: System.Collections.Generic.List&lt;T&gt;&lt;ModItem&gt;

Load(string) ​

csharp
public static void Load(string id)

Parameters:

NameTypeDescription
idstring

OpenConfigWindow(LoadedModInstance) ​

csharp
public static void OpenConfigWindow(LoadedModInstance mod)

Parameters:

NameTypeDescription
modLoadedModInstance

Refresh() ​

csharp
public static void Refresh()

RegisterJsonOverride(JsonOverrideItem, bool) ​

csharp
public static void RegisterJsonOverride(JsonOverrideItem item, bool isFromServer = false)

Parameters:

NameTypeDescription
itemJsonOverrideItem
isFromServerbool

RegisterJsonOverride(string) ​

csharp
public static void RegisterJsonOverride(string path)

Parameters:

NameTypeDescription
pathstring

RegisterJsonOverridesInDirectory(string) ​

csharp
public static void RegisterJsonOverridesInDirectory(string dir)

Parameters:

NameTypeDescription
dirstring

ReloadFromActiveMods() ​

csharp
public static void ReloadFromActiveMods()

StartRegisterJsonOverride(bool) ​

You must call this before registering any overrides.

csharp
public static void StartRegisterJsonOverride(bool willRegisterAcrossMultipleFrames = false)

Parameters:

NameTypeDescription
willRegisterAcrossMultipleFramesbool

UpdateItem(PublishedFileId_t, ModItem) ​

csharp
public static UniTask<SubmitItemUpdateResult_t> UpdateItem(PublishedFileId_t id, ModItem item)

Parameters:

NameTypeDescription
idSteamworks.PublishedFileId_t
itemModItem

Returns: Cysharp.Threading.Tasks.UniTask&lt;T&gt;&lt;SubmitItemUpdateResult_t&gt;

Maintained by the Shape of Dreams Modding Community