普特莫斯维基 (Purtmars Wikipedia 📖)

“Chemdah 开发者文档:组件”的版本间的差异

来自Purtmars Wikipedia —— 普特莫斯维基
(建立内容为“{{:Chemdah 开发者文档目录}} = 组件 = 所有任务组件均通过扩展方法获取。 <div style="margin-top: -18px"></div> == 自动化 == 在 '''ink.pt…”的新页面)
 
第3行: 第3行:
 
所有任务组件均通过扩展方法获取。
 
所有任务组件均通过扩展方法获取。
 
<div style="margin-top: -18px"></div>
 
<div style="margin-top: -18px"></div>
== 自动化 ==
+
== 自动化(addon:automation) ==
在 '''ink.ptms.chemdah.core.quest.addon.MetaAutomation''' 中提供了以下扩展方法获取任务自动化组件。
+
在 '''ink.ptms.chemdah.core.quest.addon.MetaAutomation$Companion''' 中提供了以下扩展方法获取任务自动化组件。
 
<syntaxhighlight lang="kotlin" line="line">
 
<syntaxhighlight lang="kotlin" line="line">
 
/**
 
/**
第22行: 第22行:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
== 组队 ==
+
== 组队(addon:party) ==
在 '''ink.ptms.chemdah.core.quest.addon.MetaParty''' 中提供了以下扩展方法获取任务组队组件。
+
在 '''ink.ptms.chemdah.core.quest.addon.MetaParty$Companion''' 中提供了以下扩展方法获取任务组队组件。
 
<syntaxhighlight lang="kotlin" line="line">
 
<syntaxhighlight lang="kotlin" line="line">
 +
/**
 +
* 获取可能存在的 Party 扩展
 +
*/
 
fun QuestContainer.party(): AddonParty?
 
fun QuestContainer.party(): AddonParty?
 
</syntaxhighlight>
 
</syntaxhighlight>
第34行: 第37行:
 
  * 需要在任务下配置
 
  * 需要在任务下配置
 
  */
 
  */
val share = Boolean
+
val share: Boolean
  
 
/**
 
/**
第40行: 第43行:
 
  * 需要在任务下配置
 
  * 需要在任务下配置
 
  */
 
  */
val shareOnlyLeader = Boolean
+
val shareOnlyLeader: Boolean
  
 
/**
 
/**
第46行: 第49行:
 
  * 需要在条目下配置
 
  * 需要在条目下配置
 
  */
 
  */
val canContinue = Boolean
+
val canContinue: Boolean
 +
</syntaxhighlight>
 +
 
 +
== 进度(addon:stats) ==
 +
在 '''ink.ptms.chemdah.core.quest.addon.MetaStats$Companion''' 中提供了以下扩展方法获取任务进度组件。
 +
<syntaxhighlight lang="kotlin" line="line">
 +
/**
 +
* 获取可能存在的 Stats 扩展
 +
*/
 +
fun Task.stats()
 +
 
 +
/**
 +
* 通过可能存在的 Stats 扩展展示条目进度
 +
*/
 +
fun Task.statsDisplay(profile: PlayerProfile): CompletableFuture<BossBar?>
 +
 
 +
/**
 +
* 获取条目进度
 +
* 并通过可能存在的 Stats 扩展
 +
*/
 +
fun Task.getProgress(profile: PlayerProfile): CompletableFuture<Progress>
 +
 
 +
/**
 +
* 隐藏任务进度
 +
*/
 +
fun Quest.hiddenStats(profile: PlayerProfile)
 +
 
 +
/**
 +
* 隐藏条目进度
 +
*/
 +
fun Task.hiddenStats(profile: PlayerProfile)
 +
 
 +
/**
 +
* 刷新任务进度(仅持续显示的)
 +
*/
 +
fun Quest.refreshStats(profile: PlayerProfile)
 +
 
 +
/**
 +
* 刷新条目进度
 +
*/
 +
fun Task.refreshStats(profile: PlayerProfile)
 +
</syntaxhighlight>
 +
 
 +
== 追踪(addon:track) ==
 +
在 '''ink.ptms.chemdah.core.quest.addon.MetaStats$Companion''' 中提供了以下扩展方法获取任务进度组件。
 +
<syntaxhighlight lang="kotlin" line="line">
 +
/**
 +
* 任务允许被追踪
 +
*/
 +
fun QuestContainer.allowTracked(): Boolean
 +
 
 +
/**
 +
* 获取可能存在的 Track 扩展
 +
*/
 +
fun QuestContainer.track(): AddonTrack?
 +
 
 +
/**
 +
* 当前任务追踪
 +
*/
 +
var PlayerProfile.trackQuest: Template?
 +
 
 +
/**
 +
* 删除任务追踪(Navigation)
 +
*/
 +
fun Player.cancelTrackingNavigation()
 +
 
 +
/**
 +
* 创建或更新任务追踪(Navigation)
 +
*/
 +
fun Player.refreshTrackingNavigation()
 +
 
 +
/**
 +
* 删除任务追踪(Scoreboard)
 +
*/
 +
fun Player.cancelTrackingScoreboard(quest: Template?)
 +
 
 +
/**
 +
* 创建或刷新任务追踪(Scoreboard)
 +
*/
 +
fun Player.refreshTrackingScoreboard()
 +
</syntaxhighlight>
 +
 
 +
== 任务纵览(addon:ui)==
 +
在 '''ink.ptms.chemdah.core.quest.addon.MetaUI$Companion''' 中提供了以下扩展方法获取任务纵览组件。
 +
<syntaxhighlight lang="kotlin" line="line">
 +
/**
 +
* 获取可能存在的 UI 扩展
 +
*/
 +
fun Template.ui(): AddonUI?
 +
</syntaxhighlight>
 +
 
 +
在 '''ink.ptms.chemdah.core.quest.addon.MetaUI''' 中提供了以下开放方法获取任务组队纵览配置。
 +
<syntaxhighlight lang="kotlin" line="line">
 +
/**
 +
* 持续在 UI 中显示
 +
* 启用后则可能显示为 can-start 或 cannot-start
 +
*/
 +
val visibleStart: Boolean
 +
 
 +
/**
 +
* 任务完成后显示为 complete 已完成状态
 +
*/
 +
val visibleComplete: Boolean
 +
 
 +
/**
 +
* 显示图标
 +
*/
 +
val icon: String
 +
 
 +
/**
 +
* 显示介绍
 +
*/
 +
val description: List<String>
 
</syntaxhighlight>
 
</syntaxhighlight>

2021年5月6日 (四) 23:45的版本

目录

组件

所有任务组件均通过扩展方法获取。

自动化(addon:automation)

ink.ptms.chemdah.core.quest.addon.MetaAutomation$Companion 中提供了以下扩展方法获取任务自动化组件。

/**
 * 任务是否自动接受
 */
fun Template.isAutoAccept(): Boolean

/**
 * 任务自动化计划
 */
fun Template.plan(): Plan?

/**
 * 任务自动化组
 */
fun Template.planGroup(): String?

组队(addon:party)

ink.ptms.chemdah.core.quest.addon.MetaParty$Companion 中提供了以下扩展方法获取任务组队组件。

/**
 * 获取可能存在的 Party 扩展
 */
fun QuestContainer.party(): AddonParty?

ink.ptms.chemdah.core.quest.addon.MetaParty 中提供了以下开放方法获取任务组队组件配置。

/**
 * 是否分享这个任务
 * 需要在任务下配置
 */
val share: Boolean

/**
 * 是否只有队长可以给队员共享这个任务
 * 需要在任务下配置
 */
val shareOnlyLeader: Boolean

/**
 * 队员是否可以替你进行这个条目
 * 需要在条目下配置
 */
val canContinue: Boolean

进度(addon:stats)

ink.ptms.chemdah.core.quest.addon.MetaStats$Companion 中提供了以下扩展方法获取任务进度组件。

/**
 * 获取可能存在的 Stats 扩展
 */
fun Task.stats()

/**
 * 通过可能存在的 Stats 扩展展示条目进度
 */
fun Task.statsDisplay(profile: PlayerProfile): CompletableFuture

/**
 * 获取条目进度
 * 并通过可能存在的 Stats 扩展
 */
fun Task.getProgress(profile: PlayerProfile): CompletableFuture

/**
 * 隐藏任务进度
 */
fun Quest.hiddenStats(profile: PlayerProfile)

/**
 * 隐藏条目进度
 */
fun Task.hiddenStats(profile: PlayerProfile)

/**
 * 刷新任务进度(仅持续显示的)
 */
fun Quest.refreshStats(profile: PlayerProfile)

/**
 * 刷新条目进度
 */
fun Task.refreshStats(profile: PlayerProfile)

追踪(addon:track)

ink.ptms.chemdah.core.quest.addon.MetaStats$Companion 中提供了以下扩展方法获取任务进度组件。

/**
 * 任务允许被追踪
 */
fun QuestContainer.allowTracked(): Boolean

/**
 * 获取可能存在的 Track 扩展
 */
fun QuestContainer.track(): AddonTrack?

/**
 * 当前任务追踪
 */
var PlayerProfile.trackQuest: Template?

/**
 * 删除任务追踪(Navigation)
 */
fun Player.cancelTrackingNavigation()

/**
 * 创建或更新任务追踪(Navigation)
 */
fun Player.refreshTrackingNavigation()

/**
 * 删除任务追踪(Scoreboard)
 */
fun Player.cancelTrackingScoreboard(quest: Template?)

/**
 * 创建或刷新任务追踪(Scoreboard)
 */
fun Player.refreshTrackingScoreboard()

任务纵览(addon:ui)

ink.ptms.chemdah.core.quest.addon.MetaUI$Companion 中提供了以下扩展方法获取任务纵览组件。

/**
 * 获取可能存在的 UI 扩展
 */
fun Template.ui(): AddonUI?

ink.ptms.chemdah.core.quest.addon.MetaUI 中提供了以下开放方法获取任务组队纵览配置。

/**
 * 持续在 UI 中显示
 * 启用后则可能显示为 can-start 或 cannot-start
 */
val visibleStart: Boolean

/**
 * 任务完成后显示为 complete 已完成状态
 */
val visibleComplete: Boolean

/**
 * 显示图标
 */
val icon: String

/**
 * 显示介绍
 */
val description: List