LamGC/ScalaBot
1
0
Fork 0
mirror of https://github.com/LamGC/ScalaBot.git synced 2025-04-30 06:37:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(extension): 补充说明 shareDataFolder.

Browse Source 
原来的说明容易产生误解, 让扩展开发者以为一个扩展一个数据目录, 所以在这块上补充了一些说明.
This commit is contained in:
LamGC 2022-03-20 11:04:07 +08:00
parent 9c2ca5103c
commit b20b25bc7b
Signed by: LamGC
GPG Key ID: 6C5AE2A913941E1D
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
scalabot-extension/src/main/java/net/lamgc/scalabot/extension/BotExtensionFactory.java
View File

@ -13,6 +13,7 @@ import java.io.File;
* 所以将通过该接口工厂来创建扩展对象. * 所以将通过该接口工厂来创建扩展对象.
* *
* @author LamGC * @author LamGC
* @since 0.0.1
*/ */
public interface BotExtensionFactory { public interface BotExtensionFactory {
@ -24,7 +25,8 @@ public interface BotExtensionFactory {
* (因为 AbilityBot 只是调用了扩展中的方法来创建了功能对象). * (因为 AbilityBot 只是调用了扩展中的方法来创建了功能对象).
* *
* @param bot 机器人对象. * @param bot 机器人对象.
* @param shareDataFolder ScalaBot App 为扩展提供的数据目录, 建议存储在数据目录中, 便于数据的存储管理. * @param shareDataFolder ScalaBot App 为扩展提供的共享数据目录, <b>同一个扩展包的 Factory</b> 接收到的共享数据目录<b>都是一样的</b>;
* 建议将数据存储在数据目录中, 便于数据的存储管理.
* @return 返回为该 Bot 对象创建的扩展对象. * @return 返回为该 Bot 对象创建的扩展对象.
*/ */
AbilityExtension createExtensionInstance(BaseAbilityBot bot, File shareDataFolder); AbilityExtension createExtensionInstance(BaseAbilityBot bot, File shareDataFolder);