Essentials/Essentials/src/net/ess3/api/IEssentials.java

46 lines
1.5 KiB
Java

package net.ess3.api;
import com.earth2me.essentials.items.CustomItemResolver;
import net.ess3.provider.PotionMetaProvider;
import net.ess3.provider.SpawnEggProvider;
import java.util.Collection;
/**
* This interface exposes certain extra methods implemented in the main class that are not implemented in {@link com.earth2me.essentials.IEssentials}.
* External plugins should use this class instead of {@link com.earth2me.essentials.Essentials} or {@link com.earth2me.essentials.IEssentials} where possible.
*/
public interface IEssentials extends com.earth2me.essentials.IEssentials {
/**
* Get a list of players who are vanished.
*
* @return A list of players who are vanished
*/
Collection<String> getVanishedPlayersNew();
/**
* Get the spawn egg provider for the current platform.
*
* @return The current active spawn egg provider
*/
SpawnEggProvider getSpawnEggProvider();
/**
* Get the potion meta provider for the current platform.
*
* @return The current active potion meta provider
*/
PotionMetaProvider getPotionMetaProvider();
/**
* Get the {@link CustomItemResolver} that is currently in use.
*
* <b>Note: external plugins should generally avoid using this. If you want to add custom items from your plugin,
* you probably want to implement your own {@link net.ess3.api.IItemDb.ItemResolver}.</b>
*
* @return
*/
CustomItemResolver getCustomItemResolver();
}