UMod Namespace

Exception thrown while accessing invalid mod directories.

Exception thrown when a mod path is not valid.

Mod class that allows developers to trigger messages that get sent to the mod as well as access running mod hosts. See also the ModBehaviour component for mono behaviour functionality with added mod events and methods.

Exception that is thrown when a mod file cannot be loaded.

Allows developers to request assets loads from any running mod host. Allows pre-compiled mod assets to be loaded at runtime for any running ModHost that contains an asset with the specified name.

An awaitable object that is returned by async operations so you can wait for completion in a coroutine as well as access progress and status information.

An awaitable object that is returned by async operations so you can wait for completion in a coroutine as well as access progress and status information.

The mod behaviour class is a substitue for the mono behaviour class that provides additional information to the developer. By default all public members of the inheriting class will be exposed to modders. The developer must inherit from this class if they want to support inheritance.

Responsible for accessing and parsing the applications command line in order to locate the specified command line token. Allows support for command line launching from the UMod Exporter for quick mod testing.

Helper class used to manage a local directory where mods are located. Helps developers to manage a specific directory where mods should be installed.

A serializable refernce to a shared game asset which can be used in mod scripts to reference specific shared game assets.

The main mod component that provides access to loading and running a user created mod.

An exception that is thrown when there is a mod loading error.

Contains useful error information for a mod load attempts.

Exception thrown when invalid calls are made to the API when a mod has been loaded but noy yet activated.

Exception thrown when invalid calls are made t the API when a mod has not been loaded.

Exception thrown when a requested feature is not supported.

Provides a base class for modded scripts that allows access to the uMod API. Modders should inherit from this class when they require access to the uMod API but do not need the behaviour of the MonoBehaviour component. See also ModScriptBehaviour for identical functionality with MonoBehaviour base class.

Provides the same functionality as the mono behaviour class but adds access to the modding interface for ease of use. Provides similar functionality to the ModScript class but also inherits from MonoBehaviour. Modders should inherit from this class to access the uMod API.

Exception thrown when host security is breached.

Used to access the current version of uMod.

Basic interface for the UMod api and allows for mod events to raised. Most mod scripts should inherit this class.

Represents an asset included in a mod.

Represents common asset data for assets included in a mod

Interface exposed to the modder for loading content from the mod package. Modders should make use of this interface where the mod type includes asset prefabs.

The base interface for requesting actions from modded content. This interface is passed to the IMod interface when 'onModLoaded' is called.

Interface exposed to the developer.

Represents mod name information including the mod version.

Allows primitive data types to be stored persistently inbetween mod loads. This is useful if the mod needs to store settings or other persistent information. Most games will disallow access to System.IO by default and as a result this interface is usually the only way to create persistent data. The interface is designed to mimic Unity's PlayerPres class as close as possible with a couple of extra features.

Represents a reference to another mod that the current mod depends upon.

Represents references to other mods that this mod depends upon.

Represents a special scene asset included in a mod.

Interface exposed to the modder for loading scene content from the mod package. Modders may want to make use of this interface if their mod contains scene assets.

Get the security polivy for the mod.

Used to indicate the type of error that occurred while loading a mod

Used to indicate the current loading state of the mod host