API
Interface
Formulários que o jogador preenche e elementos na tela: barras de chefe e uma barra lateral. Tudo isso funciona para qualquer cliente, tenha ele o Crafting instalado ou não.
Formulários
Um formulário tem um título, um texto, campos e botões. Você o declara em um arquivo em ui/ e o exibe onde precisar (um comando, um evento, ao usar um item):
import { give_rubies } from "/lib/rewards"
const SHOP = form("Ruby shop", {
body: "Rubies cost 10 emeralds each.",
fields: [
{ slider: "amount", label: "Rubies", min: 1, max: 16, default: 1 },
{ toggle: "gift", label: "Wrap as a gift" },
{ choice: "pouch", label: "Pouch", options: ["leather", "silk"] },
{ text: "note", label: "Note" }
],
buttons: [{ id: "buy", label: "Buy" }, "cancel"]
})
fun open_shop(p: Player) {
p.show_form(SHOP, fun(r) {
if r.button != "buy" { return } // closed with Esc or cancelled
let n = int(r.number("amount") ?? 1)
if p.inventory.count("minecraft:emerald") < n * 10 { p.send("&cNot enough emeralds"); return }
give_rubies(p, n)
if r.toggle("gift") { p.send("&dWrapped in {r.choice("pouch")}: {r.text("note")}") }
})
}import { open_shop } from "/ui/shop"
command shop describe "Buy rubies" {
if player == null { return "Players only" }
open_shop(player)
}| Campo | Escrito como | Lido com |
|---|---|---|
| Texto | { text: "note", label: "Nota", default: "" } |
r.text("note") |
| Interruptor | { toggle: "gift", label: "É um presente", default: false } |
r.toggle("gift") |
| Controle deslizante | { slider: "amount", label: "Quantidade", min: 1, max: 64, step: 1, default: 8 } |
r.number("amount") |
| Escolha | { choice: "color", label: "Cor", options: ["red", "blue"], default: "red" } |
r.choice("color") |
- A chave de cada campo usa letras minúsculas, dígitos e
_.labelé o que o jogador vê; se faltar, a chave é usada. buttonsé uma lista de{ id, label }ou só de ids. Um formulário sem botões recebe um botão “OK”.- Na resposta,
r.buttoné o id do botão pressionado, ounullse o jogador fechou o formulário (Esc).r.valuesé um mapa com todos os campos. - A resposta chega na função que você passa para
show_form; o resto do servidor continua rodando enquanto o jogador decide.
Em Kotlin
package com.example.rubies.ui
object ShopForm {
private val form = Form("Ruby shop").apply {
body = "Rubies cost 10 emeralds each."
slider("amount", "Rubies", 1.0, 16.0, default = 1.0)
toggle("gift", "Wrap as a gift")
choice("pouch", "Pouch", listOf("leather", "silk"))
text("note", "Note")
button("buy", "Buy")
button("cancel", "Cancel")
}
fun show(player: Player) = player.showForm(form) { r ->
if (r.button != "buy") return@showForm // closed with Esc or cancelled
val n = (r.number("amount") ?: 1.0).toInt()
if (player.inventory.count(Identifier.parse("minecraft:emerald")) < n * 10) { player.send("&cNot enough emeralds"); return@showForm }
player.give(ItemStack.of(Items.RUBY, n))
if (r.toggle("gift") == true) player.send("&dWrapped in ${r.choice("pouch")}: ${r.text("note")}")
}
}Form(title) com body, text(key, label, default, maxLength), toggle(key, label, default), slider(key, label, min, max, step, default), choice(key, label, options, default) e button(id, label). player.showForm(form) { r -> … } recebe um FormResponse com button, values e text, toggle, number, choice.
Barras de chefe
Uma barra no topo da tela, com título, cor, progresso e estilo. Use-a para um cronômetro, um evento do servidor ou a vida de algo:
const TIMER = server.boss_bar("rubies:countdown", "&cCorrida dos rubis", "red", "segments_10")
let left = 60
on join { TIMER.show(player) }
every 1 second {
left = max(0, left - 1)
TIMER.progress = left / 60
TIMER.title = "&cCorrida dos rubis: {left}s"
if left == 0 { TIMER.remove() }
}| Membro | O que faz |
|---|---|
server.boss_bar(id, title?, color?, style?) |
Cria a barra ou retorna a que já existe com esse id. Um id por barra: recarregar o mod não a duplica. |
bar.progress |
De 0 a 1. |
bar.title |
O texto, com cores &. |
bar.color |
pink, blue, red, green, yellow, purple, white. |
bar.style |
solid, segments_6, segments_10, segments_12, segments_20. |
bar.show(player), bar.hide(player) |
Quem a vê. bar.players os lista. |
bar.remove() |
Remove-a para todos e libera o id. |
Em Kotlin: Crafting.server?.bossBar("rubies:countdown", "Tempo", BarColor.RED, BarStyle.SEGMENTS_10), com as mesmas propriedades em camelCase.
Barra lateral
Uma lista de até 15 linhas no lado direito da tela, diferente para cada jogador. Chame de novo para atualizá-la:
import { visits } from "/lib/storage"
on join {
player.set_sidebar("&6Rubis", [
"&fVisitas: &e{visits(player)}",
"&fRubis: &c{player.inventory.count("rubies:ruby")}"
])
}player.set_sidebar(title, lines)a exibe ou atualiza; só esse jogador a vê. Cores com&.player.clear_sidebar()a remove.- Em Kotlin:
player.setSidebar(title, lines)eplayer.clearSidebar().
Teclas de um mod
Um mod pode adicionar teclas próprias. Declaram-se com key e reage-se com on key, que é executado no servidor para o jogador que a carregou. e.key é o id com o espaço de nomes do mod (dashmod:dash).
key "dash" { label: "Dash", default: "R" }
key "heal" { label: "Second wind", default: "G" }
on key(e) {
let p = e.player
if e.key == "dashmod:dash" && !p.has_cooldown("minecraft:feather") {
let d = p.direction
p.velocity = vector(d.x * 1.6, 0.35, d.z * 1.6)
p.set_cooldown("minecraft:feather", 2)
}
if e.key == "dashmod:heal" { p.heal(6) }
}As teclas aparecem em Opções > Controlos > Atribuição de teclas, numa secção com o nome do mod. Os jogadores podem alterá-las e a escolha deles é mantida. default é o nome de uma tecla, como "R", "G", "F6" ou "LEFT_ALT".
Os jogadores precisam de ter o Crafting instalado no jogo para ter as teclas. Em Kotlin: ContentBuilder.key("dash", label = "Dash", default = "R") e Crafting.events.on<PlayerKeyEvent> { e -> … }.
Bom saber
- Formulários, barras e a barra lateral aparecem em qualquer cliente do Minecraft Java 26.3, com ou sem Crafting. Um mod de servidor pode usá-los sem que ninguém instale nada.
- Títulos, a barra de ação e as mensagens de chat estão em O mundo e os jogadores.
- Telas personalizadas com layout próprio (menus, inventários de máquinas) ainda não existem; veja o roteiro.