cc.carm.lib.easyplugin

类 EasyPlugin

java.lang.Object

org.bukkit.plugin.PluginBase

org.bukkit.plugin.java.JavaPlugin

cc.carm.lib.easyplugin.EasyPlugin

所有已实现的接口:

org.bukkit.command.CommandExecutor, org.bukkit.command.TabCompleter, org.bukkit.command.TabExecutor, org.bukkit.plugin.Plugin

public abstract class EasyPlugin
extends org.bukkit.plugin.java.JavaPlugin

字段概要

字段

限定符和类型	字段和说明
protected boolean	initialized
protected @NotNull EasyPluginMessageProvider	messageProvider
protected SchedulerUtils	scheduler

构造器概要

构造器

限定符	构造器和说明
	EasyPlugin()
	EasyPlugin(@NotNull EasyPluginMessageProvider messageProvider)
protected	EasyPlugin(@NotNull EasyPluginMessageProvider messageProvider, org.bukkit.plugin.java.JavaPluginLoader loader, org.bukkit.plugin.PluginDescriptionFile descriptionFile, java.io.File dataFolder, java.io.File file)
protected	EasyPlugin(org.bukkit.plugin.java.JavaPluginLoader loader, org.bukkit.plugin.PluginDescriptionFile descriptionFile, java.io.File dataFolder, java.io.File file)

方法概要

限定符和类型	方法和说明
<T extends org.bukkit.event.Event> @NotNull java.util.concurrent.CompletableFuture<T>	callAsync(T event) 在异步线程中唤起一个事件，并支持获取事件的结果。
<T extends org.bukkit.event.Event> @NotNull java.util.concurrent.CompletableFuture<T>	callSync(T event) 在主线程唤起一个事件，并支持获取事件的结果。
void	debug(java.lang.String... messages)
void	error(java.lang.String... messages)
SchedulerUtils	getScheduler()
protected abstract boolean	initialize()
boolean	isDebugging()
protected void	load()
void	log(java.lang.String... messages)
void	onDisable()
void	onEnable()
void	onLoad()
void	outputInfo() 重写以展示插件的相关信息，如插件横幅、下载地址等。
void	print(@Nullable java.lang.String prefix, java.lang.String... messages)
void	registerCommand(java.lang.String commandName, @NotNull org.bukkit.command.CommandExecutor executor)
void	registerCommand(java.lang.String commandName, @NotNull org.bukkit.command.CommandExecutor executor, @Nullable org.bukkit.command.TabCompleter tabCompleter)
void	registerListener(org.bukkit.event.Listener... listeners)
protected void	setMessageProvider(@NotNull EasyPluginMessageProvider provider)
protected void	shutdown()
<T> @NotNull java.util.concurrent.CompletableFuture<T>	supplyAsync(@NotNull java.util.function.Supplier<T> action) 在异步线程中执行一个操作，并获取操作的结果。
<T> @NotNull java.util.concurrent.CompletableFuture<T>	supplySync(@NotNull java.util.function.Supplier<T> action) 在主线程执行操作，并支持获取其结果。

从类继承的方法 org.bukkit.plugin.java.JavaPlugin

getClassLoader, getCommand, getConfig, getDataFolder, getDefaultWorldGenerator, getDescription, getFile, getLogger, getPlugin, getPluginLoader, getProvidingPlugin, getResource, getServer, getTextResource, isEnabled, isNaggable, onCommand, onTabComplete, reloadConfig, saveConfig, saveDefaultConfig, saveResource, setEnabled, setNaggable, toString

从类继承的方法 org.bukkit.plugin.PluginBase

equals, getName, hashCode

从类继承的方法 java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

字段详细资料

messageProvider

@NotNull
protected @NotNull EasyPluginMessageProvider messageProvider

scheduler

protected SchedulerUtils scheduler

initialized

protected boolean initialized

构造器详细资料

EasyPlugin

public EasyPlugin()

EasyPlugin

public EasyPlugin(@NotNull
                  @NotNull EasyPluginMessageProvider messageProvider)

EasyPlugin

protected EasyPlugin(org.bukkit.plugin.java.JavaPluginLoader loader,
                     org.bukkit.plugin.PluginDescriptionFile descriptionFile,
                     java.io.File dataFolder,
                     java.io.File file)

EasyPlugin

protected EasyPlugin(@NotNull
                     @NotNull EasyPluginMessageProvider messageProvider,
                     org.bukkit.plugin.java.JavaPluginLoader loader,
                     org.bukkit.plugin.PluginDescriptionFile descriptionFile,
                     java.io.File dataFolder,
                     java.io.File file)

方法详细资料

onLoad

public final void onLoad()

指定者:

onLoad 在接口中 org.bukkit.plugin.Plugin

覆盖:

onLoad 在类中 org.bukkit.plugin.java.JavaPlugin

onEnable

public final void onEnable()

指定者:

onEnable 在接口中 org.bukkit.plugin.Plugin

覆盖:

onEnable 在类中 org.bukkit.plugin.java.JavaPlugin

onDisable

public final void onDisable()

指定者:

onDisable 在接口中 org.bukkit.plugin.Plugin

覆盖:

onDisable 在类中 org.bukkit.plugin.java.JavaPlugin

load

protected void load()

initialize

protected abstract boolean initialize()

shutdown

protected void shutdown()

outputInfo

public void outputInfo()

重写以展示插件的相关信息，如插件横幅、下载地址等。

isDebugging

public boolean isDebugging()

getScheduler

public SchedulerUtils getScheduler()

registerListener

public void registerListener(@NotNull
                             org.bukkit.event.Listener... listeners)

registerCommand

public void registerCommand(java.lang.String commandName,
                            @NotNull
                            @NotNull org.bukkit.command.CommandExecutor executor)

registerCommand

public void registerCommand(java.lang.String commandName,
                            @NotNull
                            @NotNull org.bukkit.command.CommandExecutor executor,
                            @Nullable
                            @Nullable org.bukkit.command.TabCompleter tabCompleter)

print

public void print(@Nullable
                  @Nullable java.lang.String prefix,
                  @Nullable
                  java.lang.String... messages)

log

public void log(@Nullable
                java.lang.String... messages)

error

public void error(java.lang.String... messages)

debug

public void debug(@Nullable
                  java.lang.String... messages)

supplySync

@NotNull
public <T> @NotNull java.util.concurrent.CompletableFuture<T> supplySync(@NotNull
                                                                                  @NotNull java.util.function.Supplier<T> action)

在主线程执行操作，并支持获取其结果。

类型参数:

T - 结果类型

参数:

action - 需要执行的内容

返回:

CompletableFuture

supplyAsync

@NotNull
public <T> @NotNull java.util.concurrent.CompletableFuture<T> supplyAsync(@NotNull
                                                                                   @NotNull java.util.function.Supplier<T> action)

在异步线程中执行一个操作，并获取操作的结果。

类型参数:

T - 事件类型

参数:

action - 需要执行的内容

返回:

CompletableFuture

callSync

@NotNull
public <T extends org.bukkit.event.Event> @NotNull java.util.concurrent.CompletableFuture<T> callSync(T event)

在主线程唤起一个事件，并支持获取事件的结果。

类型参数:

T - 事件类型

参数:

event - 同步事件 (isAsync=false)

返回:

CompletableFuture

callAsync

@NotNull
public <T extends org.bukkit.event.Event> @NotNull java.util.concurrent.CompletableFuture<T> callAsync(T event)

在异步线程中唤起一个事件，并支持获取事件的结果。

类型参数:

T - 事件类型

参数:

event - 异步事件 (isAsync=true)

返回:

CompletableFuture

setMessageProvider

protected void setMessageProvider(@NotNull
                                  @NotNull EasyPluginMessageProvider provider)