Package io.github.thebusybiscuit.slimefun4.api

Interface SlimefunAddon

All Known Implementing Classes:

Slimefun

public interface SlimefunAddon

This is a very basic interface that will be used to identify the Plugin that registered a SlimefunItem. It will also contain some utility methods such as getBugTrackerURL() to provide some context when bugs arise. It is recommended to implement this interface if you are developing an Addon.

Author:

TheBusyBiscuit

Method Summary

Modifier and Type	Method	Description
String	getBugTrackerURL()	This method returns a link to the Bug Tracker of this SlimefunAddon
JavaPlugin	getJavaPlugin()	This method returns the instance of JavaPlugin that this SlimefunAddon refers to.
default Logger	getLogger()	This method returns the Logger of this addon, it defaults to the Logger of the JavaPlugin provided by getJavaPlugin()
default String	getName()	This method returns the name of this addon, it defaults to the name of the JavaPlugin provided by getJavaPlugin()
default String	getPluginVersion()	This method returns the version of this addon, it defaults to the version of the JavaPlugin provided by getJavaPlugin()
default boolean	hasDependency(String dependency)	This method checks whether the given String is the name of a dependency of this SlimefunAddon.

Method Details

getJavaPlugin

@Nonnull
JavaPlugin getJavaPlugin()

This method returns the instance of JavaPlugin that this SlimefunAddon refers to.

Returns:

The instance of your JavaPlugin

getBugTrackerURL

@Nullable
String getBugTrackerURL()

This method returns a link to the Bug Tracker of this SlimefunAddon

Returns:

The URL for this Plugin's Bug Tracker, or null

getName

@Nonnull
default String getName()

This method returns the name of this addon, it defaults to the name of the JavaPlugin provided by getJavaPlugin()

Returns:

The Name of this SlimefunAddon

getPluginVersion

@Nonnull
default String getPluginVersion()

This method returns the version of this addon, it defaults to the version of the JavaPlugin provided by getJavaPlugin()

Returns:

The version of this SlimefunAddon

getLogger

@Nonnull
default Logger getLogger()

This method returns the Logger of this addon, it defaults to the Logger of the JavaPlugin provided by getJavaPlugin()

Returns:

The Logger of this SlimefunAddon

hasDependency

default boolean hasDependency(@Nonnull
 String dependency)

This method checks whether the given String is the name of a dependency of this SlimefunAddon. It specifically checks whether the given String can be found in PluginDescriptionFile.getDepend() or PluginDescriptionFile.getSoftDepend()

Parameters:

dependency - The dependency to check for

Returns:

Whether this SlimefunAddon depends on the given Plugin