Kotlin 介面對照表
plugin world匯入以下主機介面。Kotlin 在 pumpkin 中提供這些介面;例如,WIT boss-bar 會變為 pumpkin.BossBar。每個 WIT 連結都會開啟其源定義。
| WIT 定義 | 生成的 Kotlin 名稱空間 | 用途 |
|---|---|---|
logging | Logging | 伺服器日誌記錄。 |
gui | Gui | GUI 資源及其物品欄。 |
scoreboard | Scoreboard | 記分板資源。 |
server | Server | 全域伺服器和玩家查詢。 |
text | Text | 文字元件。 |
command | Command | 指令樹、傳送者、引數、執行和建議。commands 管理回呼 ID。 |
context | Context | Context.Context 註冊、伺服器存取和插件資料資料夾。 |
i18n | I18n | 翻譯和區域設定支援。 |
scheduler | Scheduler | 延遲/重複任務和取消。PumpkinPlugin.tasks 管理兩種回呼形式。 |
world | World | 世界、方塊、實體、區塊和生成。自訂 AI 和生成器會回呼到 PumpkinPlugin。 |
entity | Entity | 在整個 API 中提供的實體相關型別。 |
boss-bar | BossBar | Boss 欄型別和資源。 |
forms | Forms | 基岩版表單。 |
java-dialogs | JavaDialogs | Java 版對話方塊。 |
status-effect | StatusEffect | 狀態效果型別和實例。 |
block-entity | BlockEntity | 方塊實體型別和資源。 |
ipc | Ipc | 向另一個插件傳送訊息;傳入訊息使用 handleIpcMessage。 |
attributes | Attributes | 實體屬性和修飾符。 |
player | Player | 玩家資源和操作,包括物品欄存取。 |
advancement | Advancement | 進度定義和進展。 |
recipe | Recipe | 配方定義和註冊。 |
inventory | Inventory | 物品欄和玩家物品欄資源操作。 |
datapack | Datapack | 資料包檢查和管理。 |
enchantments | Enchantments | 附魔型別。 |
damage-types | DamageTypes | 傷害型別。 |
screens | Screens | 介面和容器型別。 |
statistics | Statistics | 玩家統計類別和型別。 |
display | Display | 展示實體和互動實體。 |
game-rules | GameRules | 遊戲規則定義和值。 |
game-events | GameEvents | 遊戲事件型別。 |
potions | Potions | 藥水型別。 |
entity-statuses | EntityStatuses | 實體狀態和動畫型別。 |
WIT 名稱對應的 Kotlin 定義
生成的 Kotlin 名稱和型別遵循 WIT 定義:
| WIT | Kotlin |
|---|---|
context 資源 context | Context.Context;在手寫 API 中也別名為 PluginContext |
inventory 資源 inventory | Inventory.Inventory |
event 變體 event | Event.Event |
world 資源 world | World.World |
u8、u16、u32、u64 | UByte、UShort、UInt、ULong |
s32、bool、string | Int、Boolean、String |
list<u8>、option<T> | List<UByte>、可空的 T? |
result<T, E> | 生成的呼叫邊界處為 Kotlin Result<T> |
WIT register-event-with-handle 變為 context.registerEventWithHandle(handlerId, eventType, priority, blocking),並返回一個 ULong。WIT get-item: func(slot: u32) -> option<item-stack> 變為 inventory.getItem(slot: UInt): ItemStack.ItemStack?。IDE 自動完成會顯示你的 API 版本中的成員。
以下操作將生成的 WIT 呼叫與 Kotlin 註冊 API 連線起來:
| WIT 操作 | 生成的 Kotlin 呼叫 | Kotlin API |
|---|---|---|
context.register-event-with-handle 和 unregister-event | context.registerEventWithHandle(id, type, priority, blocking) 和 context.unregisterEvent(registrationId) | events.listen(...) 和 EventSubscription.unregister() |
command.execute-with-handler-id 和 context.register-command | 先呼叫 command.executeWithHandlerId(id),再呼叫 context.registerCommand(command, permission) | commands.register(...) |
command-node.suggest-with-handler-id | node.suggestWithHandlerId(id) | commands.onSuggestions(...) |
scheduler.schedule-delayed-task | Scheduler.scheduleDelayedTask(id, delayTicks) | tasks.afterTicks(...) |
scheduler.schedule-repeating-task 和 cancel-task | Scheduler.scheduleRepeatingTask(id, delayTicks, periodTicks) 和 Scheduler.cancelTask(taskId) | tasks.everyTicks(...) 和 ScheduledTask.cancel() |
mob.add-custom-ai-goal | mob.addCustomAiGoal(priority, goalId) | aiGoals.register(...) |
world.set-chunk-generator | world.setChunkGenerator(generatorId) | chunkGenerators.set(...) |
ipc.send-ipc-message | Ipc.sendIpcMessage(recipient, message) | 傳出 IPC;接收方使用 ipc.onMessage(...) |
Kotlin API 會為其註冊方法分配處理器 ID。透過生成的綁定直接呼叫時,需要自行管理這些 ID。
共享型別介面
這些介面定義主機匯入和插件匯出使用的型別。它們不是 plugin world 中單獨的匯入:
| WIT 定義 | Kotlin 名稱空間 |
|---|---|
common、uuid | Common、Uuid |
biomes、sounds、particles | Biomes、Sounds、Particles |
java-packets、bedrock-packets | JavaPackets、BedrockPackets |
item-stack、data-components | ItemStack、DataComponents |
permission、event、metadata、entity-types | Permission、Event、Metadata、EntityTypes |
Inventory.Inventory.getItem 和 setItem 等資源方法不需要回呼或處理器 ID。回呼參考介紹了需要它們的操作。