Chemdah 开发者文档:自定义对话主题
来自Purtmars Wikipedia —— 普特莫斯维基
目录
- Chemdah
- 开始
- 基本
- 事件
- ink.ptms.chemdah.api.event.collect.ConversationEvents
- ink.ptms.chemdah.api.event.collect.ObjectiveEvents
- ink.ptms.chemdah.api.event.collect.PlayerEvents
- ink.ptms.chemdah.api.event.collect.QuestEvents
- ink.ptms.chemdah.api.event.collect.TemplateEvents
- ink.ptms.chemdah.api.event.InferEntityHookEvent
- ink.ptms.chemdah.api.event.InferItemHookEvent
- ink.ptms.chemdah.api.event.PartyHookEvent
- 对话相关
- 数据相关
- 任务相关
对话主题
注册自定义对话主题需要分别实现 Theme 与 ThemeSettings 类,在本章文档中我们会从零开始注册一个简单的聊天框对话主题。
ink.ptms.chemdah.core.conversation.theme.Theme
1 /**
2 * 注册到 ChemdahAPI 中
3 */
4 fun register(name)
5
6 /**
7 * 当配置文件被重载
8 */
9 open fun reloadConfig()
10
11 /**
12 * 是否支持告别
13 * 即结束对话时使用 talk 语句创建没有回复的对话信息
14 * 在原版 chat 对话模式中支持告别,而 chest 不支持(会被转换为 Holographic 信息)
15 */
16 open fun allowFarewell()
17
18 /**
19 * 重置会话时(即 begin 之前)
20 * 在原版 chat 对话模式中用于归位玩家所选择的回复序号,而 chest 中没有使用
21 */
22 open fun reset(session: Session): CompletableFuture<Void>
23
24 /**
25 * 会话开始之前,在原版 chat 对话模式中用于播放音效特效等
26 * 使用时必须返回 super.begin(session)
27 */
28 open fun begin(session: Session): CompletableFuture<Void>
29
30 /**
31 * 会话结束时,目前未被使用
32 */
33 open fun end(session: Session): CompletableFuture<Void>
34
35 /**
36 * 会话渲染时
37 * @param canReply 是否可以回复
38 */
39 abstract fun npcTalk(session: Session, message: List<String>, canReply: Boolean = true): CompletableFuture<Void>
实现
首先继承 ThemeSettings 类,若没有特殊需求则不需要额外读取数据。数据来源由 Theme 类决定,可自行定义。
1 class ThemeDemoSettings(root: ConfigurationSection) : ThemeSettings(root)
其次继承 Theme 类,并进行注册与配置定义。
1 class ThemeDemo : Theme<ThemeDemoSettings>() {
2
3 init {
4 // 注册 demo 对话风格到插件
5 register("demo")
6 }
7
8 /**
9 * 初始化配置文件,并将其指向 plugins/Chemdah/core/conversation.yml 文
10 */
11 override fun getConfig(): ThemeDemoSettings {
12 return ThemeDemoSettings(ConversationManager.conf.getConfigurationSection("theme-demo")!!)
13 }
14
15 override fun npcTalk(session: Session, message: List<String>, canReply: Boolean): CompletableFuture<Void> {
16 TODO("Not yet implemented")
17 }
18 }