Show / Hide Table of Contents

Namespace Jotunn.Utils

Classes

AssetUtils

Util functions related to loading assets at runtime.

BepInExUtils

Helper methods to access BepInEx plugin information

BoneReorder

Original code from https://github.com/GoldenJude.

ConfigFileWatcher

Watches a ConfigFile for changes and raises events when the configuration file is modified.

ConfigManagerUtils

Utility class for the BepInEx ConfigurationManager plugin, without requiring a hard dependency

ConfigurationSynchronizationEventArgs

Event args class for configuration synchronization event

DungeonGeneratorTheme

Helper class for identifying the theme of custom rooms.

GameConstants

Constants of hardcoded strings used in-game

GameConstants.GlobalKey

GlobalKey strings

GameConstants.Weather

Weather strings

GameVersions

Utility class for getting game versions

HashUtils

A util class for computing various hashes

ModCompatibility

Implementation of the mod compatibility features.

ModQuery

Utility class to query metadata about added content of any loaded mod, including non-Jötunn ones. It is disabled by default, as it unnecessary increases the loading time when not used.
Enable() has to be called anytime before FejdStartup.Awake, meaning in your plugin's Awake or Start.

ModRegistry

Utility class to query metadata about loaded Jötunn mods and their added content

ModRegistry.ModInfo

Model class holding metadata of Jötunn mods.

NetworkCompatibilityAttribute

Mod compatibility attribute

If your mod adds its own RPCs, EnforceModOnClients is likely a must (otherwise clients would just discard the messages from the server), same version you do have to determine, if your sent data changed.
If your mod adds items, you always should enforce mods on client and same version (there could be nasty side effects with different versions of an item).
If your mod is just GUI changes (for example bigger inventory, additional equip slots) there is no need to set this attribute

PatchInitAttribute

Priority attribute for PatchInitalizer.

Paths

Various Path constants used in Jötunn

ReflectionHelper

Various utility methods aiding Reflection tasks.

ReflectionHelper.Cache

Cache for Reflection tasks.

ShaderHelper

Various static utility methods for working with Shaders

SynchronizationModeAttribute

This attribute is used to determine how Jotunn should enforce synchronization of Config Entries.
Only relevant for Config Entries that have the IsAdminOnly applied.

SyncingConfigurationEventArgs

Event args class for syncing configuration event

UndoActions

Pre-defined actions to use with the UndoManager.

UndoActions.HeightUndoData

Heightmap data wrapper

UndoActions.PaintUndoData

Paint data wrapper

UndoActions.TerrainUndoData

Heightmap and Paint data collection

UndoActions.UndoCreate

"Create" action for the UndoManager. Can undo and redo ZDO creation.

UndoActions.UndoRemove

"Remove" action for the UndoManager. Can undo and redo ZDO removal.

UndoActions.UndoTerrain

"Terrain" action for the UndoManager. Can undo and redo terrain modifications.

WeightedItem<T>

Weighted item used in WeightedList<T, ItemType>

WeightedList<T, ItemType>

Like a list but stores elements in the order specified by the weight.

Interfaces

IModPrefab

Interface to match a prefab to the mod that has created it.

Enums

AdminOnlyStrictness

Enum used for telling whether AdminOnly settings for Config Entries should always be enforced or if they should only be enforced when the mod is installed on the server.

CompatibilityLevel

Determines the level of compatibility of a mod which is enforced by Jötunn. Servers disconnect clients with mods which enforce their compatibility when the version does not match as defined by the VersionStrictness attribute.

VersionStrictness

Enum used for telling whether or not the same mod version should be used by both the server and the clients. This enum is only useful with certain CompatibilityLevel values.
☀
☾
In this article
Back to top
Generated by DocFX
☀
☾