Mod Class

Base class for mods loaded by a IModLoader.

Inheritance Hierarchy

Namespace: Kit.Modding
Assembly: Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0

Syntax

public abstract class Mod

The Mod type exposes the following members.

Properties

	Name	Description
	Group	The ModGroup this mod belong to.
	Metadata	The mod's metadata.
	Name
	ScriptDispatcher	The ScriptDispatcher associated with this mod.
	ScriptEnv	The scripting environment associated with this mod.

Methods

	Name	Description
	ExecuteScripts	Execute the scripts in the mod.
	ExecuteScriptsAsync	Execute the scripts in the mod asynchronously.
	Exists	Returns whether a file exists.
	FindFiles	Find files based on a path.
	Load(String)	Load a resource.
	Load(Type, String)	Load a resource.
	Load(ResourceFolder, String)	Load a resource.
	Load(Type, ResourceFolder, String)	Load a resource.
	LoadT(String)	Load a resource.
	LoadT(ResourceFolder, String)	Load a resource.
	LoadAsync(String)	Load a resource asynchronously.
	LoadAsync(Type, String)	Load a resource asynchronously.
	LoadAsync(ResourceFolder, String)	Load a resource asynchronously.
	LoadAsync(Type, ResourceFolder, String)	Load a resource asynchronously.
	LoadAsyncT(String)	Load a resource asynchronously.
	LoadAsyncT(ResourceFolder, String)	Load a resource asynchronously.
	LoadEx	Load a resource.
	LoadExAsync	Load a resource asynchronously.
	ReadBytes	Read the contents of a file in binary-mode.
	ReadBytesAsync	Read the contents of a file asynchronously in binary-mode.
	ReadText	Read the contents of a file in text-mode.
	ReadTextAsync	Read the contents of a file asynchronously in text-mode.
	Unload	Unload the mod.

Fields

	Name	Description
	GCInterval	Garbage collector interval for the Lua environment of the mod.