ASERStudio::ASEREnv::ASERResourceMoniter Class
class ASERStudio::ASEREnv::ASERResourceMoniterASERResourceMonitor提供对ASER官方资源和项目资源的实时监视. 详情...
| 头文件： | #include <ASERResourceMoniter> |
| 自以下版本： | ASERStudio 2.4.0 |
公开成员函数
(自 ASERStudio 2.4.0 引入) | ~ASERResourceMoniter() |
(自 ASERStudio 2.4.0 引入) void | changeProjectPath(const QString &path) |
(自 ASERStudio 2.4.0 引入) QList<QPair<QString, QString>> | getASERProgramPaths() |
(自 ASERStudio 2.4.0 引入) QStringList | getBackground() |
(自 ASERStudio 2.4.0 引入) QStringList | getCharaDiff(const QString &chara) |
(自 ASERStudio 2.4.0 引入) QStringList | getCharacters() |
(自 ASERStudio 2.4.0 引入) QStringList | getMusic() |
(自 ASERStudio 2.4.0 引入) QStringList | getSoundEffect() |
(自 ASERStudio 2.4.0 引入) void | refresh(ASERStudio::ASEREnv::ASERResourceMoniter::ResourceTypes 类型别名 = ResourceType::All) |
静态公开成员
(自 ASERStudio 2.4.0 引入) QString | getASERStandardConfigPath() |
(自 ASERStudio 2.4.0 引入) ASERStudio::ASEREnv::ASERResourceMoniter * | getInstance() |
详细说明
ASERResourceMoniter是一个单例类，提供对ASER官方资源和项目资源的实时监视功能。 当项目资源发生变化时，ASERResourceMoniter会自动更新资源列表，通过相关的函数， 用户可以获取实时更新的项目中可用的资源的名称，包括背景、角色立绘、音乐和音效等。
Note: 这类实际上从2.0.0开始提供，但此前因划分到插件非API部分的YSS命名空间而未提供文档支持。 在2.4.0之前，其为ASERStudio::YSS::ResourceMoniter，提供与2.4.0版本完全等价的功能。
成员函数文档
[noexcept, since ASERStudio 2.4.0] ASERResourceMoniter::~ASERResourceMoniter()
析构函数。
这个function 从 ASERStudio 2.4.0 开始支持。
[since ASERStudio 2.4.0] void ASERResourceMoniter::changeProjectPath(const QString &path)
path 项目路径
更改当前监视的项目路径。调用此函数后，ASERResourceMoniter将开始监视新的项目路径，并更新资源列表以反映新路径下的资源。
这个function 从 ASERStudio 2.4.0 开始支持。
[since ASERStudio 2.4.0] QList<QPair<QString, QString>> ASERResourceMoniter::getASERProgramPaths()
return 当前ASERStudio程序中可用的ASER程序路径列表。每个路径包含路径和对应的版本。
ASER从3.7.12版本开始，每次启动时都会在配置文件中记录当前ASER程序的路径和版本信息。 ASERStudio通过读取这些信息，获取当前系统中可用的ASER程序路径列表。
这个function 从 ASERStudio 2.4.0 开始支持。
[static, since ASERStudio 2.4.0] QString ASERResourceMoniter::getASERStandardConfigPath()
return ASER官方资源的标准配置文件所在路径
Warning: 这个函数只在Windows平台上有效。其他平台上会返回一个无效路径。
这个function 从 ASERStudio 2.4.0 开始支持。
[since ASERStudio 2.4.0] QStringList ASERResourceMoniter::getBackground()
return 当前项目中可用的背景资源名称列表，包括项目资源和ASER官方资源。资源名称不包含文件扩展名。
这个function 从 ASERStudio 2.4.0 开始支持。
[since ASERStudio 2.4.0] QStringList ASERResourceMoniter::getCharaDiff(const QString &chara)
chara 角色名称
return 给定角色的立绘差分资源名称列表，包括项目资源和ASER官方资源。资源名称不包含文件扩展名。
这个function 从 ASERStudio 2.4.0 开始支持。
[since ASERStudio 2.4.0] QStringList ASERResourceMoniter::getCharacters()
return 当前项目中可用的角色立绘资源名称列表，包括项目资源和ASER官方资源。资源名称不包含文件扩展名。
Note: 较为特殊的是，ASERStudio未按ASE-Remake的实现分别独立处理普通角色立绘 与Spine动态立绘。因此如果动态立绘与普通立绘的名称有所重复，则动态立绘的结果将覆盖普通立绘的结果。 这是实现错误，但目前不打算修正。
这个function 从 ASERStudio 2.4.0 开始支持。
[static, since ASERStudio 2.4.0] ASERStudio::ASEREnv::ASERResourceMoniter *ASERResourceMoniter::getInstance()
return ASERResourceMoniter的单例实例
这个function 从 ASERStudio 2.4.0 开始支持。
[since ASERStudio 2.4.0] QStringList ASERResourceMoniter::getMusic()
return 当前项目中可用的音乐资源名称列表，包括项目资源和ASER官方资源。资源名称不包含文件扩展名。
这个function 从 ASERStudio 2.4.0 开始支持。
[since ASERStudio 2.4.0] QStringList ASERResourceMoniter::getSoundEffect()
return 当前项目中可用的音效资源名称列表，包括项目资源和ASER官方资源。资源名称不包含文件扩展名。
这个function 从 ASERStudio 2.4.0 开始支持。
[since ASERStudio 2.4.0] void ASERResourceMoniter::refresh(ASERStudio::ASEREnv::ASERResourceMoniter::ResourceTypes 类型别名 = ResourceType::All)
类型别名 资源类型标志
刷新资源列表。根据提供的资源类型标志，ASERResourceMoniter将检查相应类型的资源目录， 并更新资源列表以反映当前项目路径下的资源状态。
这个function 从 ASERStudio 2.4.0 开始支持。