API

Interfejs

Formularze, które wypełnia gracz, i elementy na ekranie: paski bossa i panel boczny. Wszystko to działa dla każdego klienta, niezależnie od tego, czy ma zainstalowany Crafting.

Formularze

Formularz ma tytuł, tekst treści, pola i przyciski. Deklarujesz go w pliku w ui/ i wyświetlasz tam, gdzie potrzebujesz (polecenie, zdarzenie, użycie przedmiotu):

ui/shop.craftCraftScript
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")}") }
    })
}
commands/shop.craftCraftScript
import { open_shop } from "/ui/shop"

command shop describe "Buy rubies" {
    if player == null { return "Players only" }
    open_shop(player)
}
Pole Zapis Odczyt
Tekst { text: "note", label: "Notatka", default: "" } r.text("note")
Przełącznik { toggle: "gift", label: "To prezent", default: false } r.toggle("gift")
Suwak { slider: "amount", label: "Ilość", min: 1, max: 64, step: 1, default: 8 } r.number("amount")
Wybór { choice: "color", label: "Kolor", options: ["red", "blue"], default: "red" } r.choice("color")
  • Klucz każdego pola używa małych liter, cyfr i _. label to to, co widzi gracz; jeśli go brakuje, używany jest klucz.
  • buttons to lista { id, label } albo samych id. Formularz bez przycisków dostaje przycisk „OK”.
  • W odpowiedzi r.button to id naciśniętego przycisku albo null, jeśli gracz zamknął formularz (Esc). r.values to mapa ze wszystkimi polami.
  • Odpowiedź trafia do funkcji, którą przekazujesz do show_form; reszta serwera działa dalej, gdy gracz się zastanawia.

W Kotlinie

ui/ShopForm.ktKotlin
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) z body, text(key, label, default, maxLength), toggle(key, label, default), slider(key, label, min, max, step, default), choice(key, label, options, default) i button(id, label). player.showForm(form) { r -> … } otrzymuje FormResponse z button, values oraz text, toggle, number, choice.

Paski bossa

Pasek u góry ekranu, z tytułem, kolorem, postępem i stylem. Użyj go do odliczania, wydarzenia na serwerze albo zdrowia czegoś:

events/countdown.craftCraftScript
const TIMER = server.boss_bar("rubies:countdown", "&cRubinowa gorączka", "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 = "&cRubinowa gorączka: {left}s"
    if left == 0 { TIMER.remove() }
}
Składowa Co robi
server.boss_bar(id, title?, color?, style?) Tworzy pasek albo zwraca istniejący o tym id. Jedno id na pasek: przeładowanie moda go nie duplikuje.
bar.progress Od 0 do 1.
bar.title Tekst, z kolorami &.
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) Kto go widzi. bar.players ich wymienia.
bar.remove() Usuwa go dla wszystkich i zwalnia id.

W Kotlinie: Crafting.server?.bossBar("rubies:countdown", "Time", BarColor.RED, BarStyle.SEGMENTS_10), z tymi samymi właściwościami w camelCase.

Panel boczny

Lista do 15 wierszy po prawej stronie ekranu, inna dla każdego gracza. Wywołaj ją ponownie, żeby ją zaktualizować:

events/welcome.craftCraftScript
import { visits } from "/lib/storage"

on join {
    player.set_sidebar("&6Rubiny", [
        "&fWizyty: &e{visits(player)}",
        "&fRubiny: &c{player.inventory.count("rubies:ruby")}"
    ])
}
  • player.set_sidebar(title, lines) wyświetla lub aktualizuje panel; widzi go tylko ten gracz. Kolory przez &.
  • player.clear_sidebar() go usuwa.
  • W Kotlinie: player.setSidebar(title, lines) i player.clearSidebar().

Klawisze moda

Mod może dodawać własne klawisze. Deklarujesz je przez key, a reagujesz przez on key, które uruchamia się na serwerze dla gracza, który go nacisnął. e.key to id z przestrzenią nazw moda (dashmod:dash).

content/keys.craftCraftScript
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) }
}

Klawisze są w Opcje > Sterowanie > Przypisanie klawiszy, w sekcji nazwanej od moda. Gracze mogą je zmieniać, a ich wybór jest zapamiętywany. default to nazwa klawisza, np. "R", "G", "F6" lub "LEFT_ALT".

Gracze muszą mieć w swojej grze zainstalowane Crafting, żeby mieć te klawisze. W Kotlinie: ContentBuilder.key("dash", label = "Dash", default = "R") i Crafting.events.on<PlayerKeyEvent> { e -> … }.

Warto wiedzieć

  • Formularze, paski i panel boczny są widoczne dla każdego klienta Minecraft Java 26.3, z Craftingiem lub bez. Mod serwera może z nich korzystać bez instalowania czegokolwiek przez kogokolwiek.
  • Tytuły, pasek akcji i wiadomości na czacie opisano na stronie Świat i gracze.
  • Własne ekrany z własnym układem (menu, ekwipunki maszyn) jeszcze nie istnieją; zobacz plan rozwoju.