OneShot.Modding.Models

Mod

[Serializable]
public class Mod

Read Only

Overview

the class which holds mod data like items, assets, etc.

Properties

modConfig

public ModConfiguration modConfig { get; }

loaded ModConfiguration

---

MOD_ID

Constant

[ReadOnly, ShowInInspector] public string MOD_ID { get; }

mods id for identifying

---

MOD_FOLDER

Constant

[ReadOnly, ShowInInspector] public string MOD_FOLDER { get; }

loaded ModConfiguration

---

private modItems[]

[SerializeField] private List<ModItem> modItems = new List<ModItem>();

what ModItems the mod has loaded

---

assetLoader

public AssetLoader assetLoader { get; }

mod's asset loader

---

private itemLoader

private ItemLoader itemLoader { get; }

mod's item loader

Constructors

Mod(string modFolder)

Core Triggered Only

public Mod(string modFolder)

creates the mod and initializes required stuff

Parameters

modFolder

location of where the mod is, eg. {GAME_FOLDER}/mods/examplemod/

Methods

Load()

Core Triggered Only Awaitable

public async Awaitable Load()

loads the mod