diff options
Diffstat (limited to 'src/main/java/gtPlusPlus/api/interfaces/IPlugin.java')
-rw-r--r-- | src/main/java/gtPlusPlus/api/interfaces/IPlugin.java | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/src/main/java/gtPlusPlus/api/interfaces/IPlugin.java b/src/main/java/gtPlusPlus/api/interfaces/IPlugin.java new file mode 100644 index 0000000000..d70a19925e --- /dev/null +++ b/src/main/java/gtPlusPlus/api/interfaces/IPlugin.java @@ -0,0 +1,41 @@ +package gtPlusPlus.api.interfaces; + +import gtPlusPlus.api.objects.Logger; + +public interface IPlugin { + + /** + * @return A {@link String} object which returns the {@link IPlugin}'s name. + */ + public String getPluginName(); + + /** + * @return A {@link String} object which returns the {@link IPlugin}'s short name. This String should only contain 4 + * Characters. + */ + public String getPluginAbbreviation(); + + /** + * @param message - A {@link String} object which holds a message to be logged to console. + */ + default void log(String message) { + Logger.INFO("[" + getPluginAbbreviation() + "] " + message); + } + + /** + * @param message - A {@link String} object which holds a warning/error message to be logged to console. + */ + default void logDebug(String message) { + Logger.WARNING("[" + getPluginAbbreviation() + "] " + message); + } + + public boolean preInit(); + + public boolean init(); + + public boolean postInit(); + + public boolean serverStart(); + + public boolean serverStop(); +} |