LiteMod.java
1.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
/*
* This file is part of LiteLoader.
* Copyright (C) 2012-16 Adam Mummery-Smith
* All Rights Reserved.
*/
package com.mumfrey.liteloader;
import java.io.File;
import com.mumfrey.liteloader.api.Listener;
import com.mumfrey.liteloader.modconfig.Exposable;
/**
* Base interface for mods
*
* @author Adam Mummery-Smith
*/
public interface LiteMod extends Exposable, Listener
{
/**
* Get the mod version string
*
* @return the mod version as a string
*/
public abstract String getVersion();
/**
* Do startup stuff here, minecraft is not fully initialised when this
* function is called so mods <b>must not</b> interact with minecraft in any
* way here.
*
* @param configPath Configuration path to use
*/
public abstract void init(File configPath);
/**
* Called when the loader detects that a version change has happened since
* this mod was last loaded.
*
* @param version new version
* @param configPath Path for the new version-specific config
* @param oldConfigPath Path for the old version-specific config
*/
public abstract void upgradeSettings(String version, File configPath, File oldConfigPath);
}