com.germ.germplugin.api

Class GermSrcManager

java.lang.Object

com.germ.germplugin.api.GermSrcManager

public class GermSrcManager
extends java.lang.Object

萌芽资源文件管理器

负责管理所有类型的资源文件，包括GUI、动画、特效、实体、物品等

提供资源文件的注册、删除、重载和查询功能

Since:

2019/10/16

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GermSrcManager.RegisterType 注册类型枚举
static class	GermSrcManager.SrcData 资源文件数据容器 包含资源文件的所有元数据信息

Constructor Summary

Constructors

Constructor and Description
GermSrcManager()

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getCacheUrls() 获取所有缓存URL
static GermSrcManager	getGermSrcManager() 获取资源文件管理器实例
java.lang.String	getScriptFromYamlIndex(java.lang.String yamlIndex) 根据YAML索引名获取脚本内容
@Nullable org.bukkit.configuration.file.YamlConfiguration	getSrc(java.lang.String yamlName, RootType rootType) 根据文件名获取资源文件
@Nullable org.bukkit.configuration.file.YamlConfiguration	getSrcFromYamlIndex(java.lang.String yamlIndex, RootType rootType) 根据YAML索引名获取资源文件
java.util.Set<GermSrcManager.SrcData>	getSrcSets() 获取所有资源文件数据
java.util.Set<GermSrcManager.SrcData>	getSrcSets(RootType rootType) 获取指定类型的资源文件数据
void	registerSrc(@Nullable java.io.File ymlFile, @NotNull org.bukkit.configuration.file.YamlConfiguration yamlConfiguration, @NotNull RootType rootType, @NotNull java.lang.String yamlIndex) 注册资源文件配置（带文件路径）
void	registerSrc(GermAnimationPart<?> srcPart, java.lang.String yamlIndex) 注册动画资源文件
void	registerSrc(GermEffectPart<?> srcPart, java.lang.String yamlIndex) 注册特效资源文件
void	registerSrc(GermEntityPart<?> srcPart, java.lang.String yamlIndex) 注册实体资源文件
void	registerSrc(GermItemPart<?> srcPart, java.lang.String yamlIndex) 注册物品资源文件 应该在服务器启动时调用，注册后会在玩家进入服务器时发送数据给玩家
void	registerSrc(@NotNull org.bukkit.configuration.file.YamlConfiguration yamlConfiguration, @NotNull RootType rootType, @NotNull java.lang.String yamlIndex) 注册资源文件配置
void	registerSrcFolder(RootType rootType, java.io.File dirFile) 注册一个资源文件文件夹 萌芽重载时会自动读取这个文件夹中的资源文件 你应该在JavaPlugin的onLoad方法中注册
void	reloadRegister() 重新加载并注册所有资源文件 清除旧的文件资源文件数据，触发重载前事件， 并行加载所有类型的资源文件，最后触发重载后事件
void	removeSrc(java.lang.String yamlIndex, RootType rootType) 删除注册过的资源文件

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GermSrcManager

public GermSrcManager()

Method Detail

getGermSrcManager

public static GermSrcManager getGermSrcManager()

获取资源文件管理器实例

Returns:

资源文件管理器单例

getCacheUrls

public java.util.Set<java.lang.String> getCacheUrls()

获取所有缓存URL

Returns:

缓存URL集合

getSrcSets

public java.util.Set<GermSrcManager.SrcData> getSrcSets()

获取所有资源文件数据

Returns:

资源文件数据集合

getSrcSets

public java.util.Set<GermSrcManager.SrcData> getSrcSets(RootType rootType)

获取指定类型的资源文件数据

Parameters:

rootType - 根类型

Returns:

指定类型的资源文件数据集合

removeSrc

public void removeSrc(java.lang.String yamlIndex,
                      RootType rootType)

删除注册过的资源文件

Parameters:

yamlIndex - 资源文件索引名

rootType - 根类型

getSrc

@Nullable
public @Nullable org.bukkit.configuration.file.YamlConfiguration getSrc(java.lang.String yamlName,
                                                                                   RootType rootType)

根据文件名获取资源文件

Parameters:

yamlName - YAML文件名

rootType - 根类型

Returns:

资源文件配置，如果未找到则返回null

getSrcFromYamlIndex

@Nullable
public @Nullable org.bukkit.configuration.file.YamlConfiguration getSrcFromYamlIndex(java.lang.String yamlIndex,
                                                                                                RootType rootType)

根据YAML索引名获取资源文件

Parameters:

yamlIndex - YAML索引名

rootType - 根类型

Returns:

资源文件配置，如果未找到则返回null

getScriptFromYamlIndex

public java.lang.String getScriptFromYamlIndex(java.lang.String yamlIndex)

根据YAML索引名获取脚本内容

Parameters:

yamlIndex - YAML索引名

Returns:

脚本内容，如果未找到则返回null

reloadRegister

public void reloadRegister()

重新加载并注册所有资源文件

清除旧的文件资源文件数据，触发重载前事件， 并行加载所有类型的资源文件，最后触发重载后事件

registerSrc

public void registerSrc(GermItemPart<?> srcPart,
                        java.lang.String yamlIndex)

注册物品资源文件

应该在服务器启动时调用，注册后会在玩家进入服务器时发送数据给玩家

Parameters:

srcPart - 构建的物品数据体

yamlIndex - 资源文件索引名，删除时使用的键

registerSrc

public void registerSrc(GermEntityPart<?> srcPart,
                        java.lang.String yamlIndex)

注册实体资源文件

Parameters:

srcPart - 构建的实体数据体

yamlIndex - 资源文件索引名

registerSrc

public void registerSrc(GermAnimationPart<?> srcPart,
                        java.lang.String yamlIndex)

注册动画资源文件

Parameters:

srcPart - 构建的动画数据体

yamlIndex - 资源文件索引名

registerSrc

public void registerSrc(GermEffectPart<?> srcPart,
                        java.lang.String yamlIndex)

注册特效资源文件

Parameters:

srcPart - 构建的特效数据体

yamlIndex - 资源文件索引名

registerSrcFolder

public void registerSrcFolder(RootType rootType,
                              java.io.File dirFile)

注册一个资源文件文件夹

萌芽重载时会自动读取这个文件夹中的资源文件

你应该在JavaPlugin的onLoad方法中注册

Parameters:

rootType - 根类型

dirFile - 文件夹路径

Throws:

java.lang.IllegalArgumentException - 如果文件夹不存在或不是目录

registerSrc

public void registerSrc(@NotNull
                        @NotNull org.bukkit.configuration.file.YamlConfiguration yamlConfiguration,
                        @NotNull
                        @NotNull RootType rootType,
                        @NotNull
                        @NotNull java.lang.String yamlIndex)

注册资源文件配置

Parameters:

yamlConfiguration - YAML配置对象

rootType - 根类型

yamlIndex - 资源文件索引名

registerSrc

public void registerSrc(@Nullable
                        @Nullable java.io.File ymlFile,
                        @NotNull
                        @NotNull org.bukkit.configuration.file.YamlConfiguration yamlConfiguration,
                        @NotNull
                        @NotNull RootType rootType,
                        @NotNull
                        @NotNull java.lang.String yamlIndex)

注册资源文件配置（带文件路径）

Parameters:

ymlFile - YAML文件路径，可为null

yamlConfiguration - YAML配置对象

rootType - 根类型

yamlIndex - 资源文件索引名