Defold

← Połącz treść ze swoją grą

Defold · Lua · GUI

Zacznij od jednego widocznego zdania. Ten krótki przykład odczytuje bezpośrednio rzeczywisty eksport The Harbour Key; nie jest kompletnym systemem odtwarzania dialogów. Następnie połącz dane z interfejsem swojej gry.

1 · Przygotowanie plików i sceny

Skopiuj story.json do /story/. Dodaj /story do project → custom_resources w game.project. Utwórz GUI z węzłem tekstowym dialogue, wybierz zasób czcionki i dodaj GUI do obiektu gry. Przypisz first_text.gui_script do GUI i uruchom projekt.

story.json · Opis plików eksportu

2 · Pokaż pierwszy tekst

-- first_text.gui_script: attach to a GUI containing a text node named dialogue.
function init(self)
    local raw, error = sys.load_resource("/story/story.json")
    if not raw then
        gui.set_text(gui.get_node("dialogue"), "Cannot load story.json")
        return
    end
    local ok, story = pcall(json.decode, raw)
    if not ok then
        gui.set_text(gui.get_node("dialogue"), "Invalid JSON")
        return
    end
    local locale = "en"
    local id = "fd7b61a3-8233-4ba7-8f77-b88b119a91bf"
    local content = story.content
    local translation = (content.translations[locale] or {})[id]
    local message = translation and translation.message or content.texts[id].sourceMessage
    local parts = {}
    for _, segment in ipairs(message.segments) do
        assert(segment.kind == "text", "Text-only example")
        parts[#parts + 1] = segment.text
    end
    gui.set_text(gui.get_node("dialogue"), table.concat(parts))
end

Oczekiwany wynik: „Welcome to the harbour. I am Mira.” Przy locale = "de" lub parametrze języka de: „Willkommen im Hafen. Ich bin Mira.” Jeśli język jest niedostępny, zostanie użyty tekst źródłowy. Przykład obsługuje segmenty tekstowe; celowo nie pomija po cichu znaczników podstawianych wartości.

3 · Od jednego zdania do rozmowy

Stały identyfikator tekstu powyżej służy do pierwszego testu. W grze wybierz flowRef/entryRef z story-index.json, odczytaj execution.entries[entryRef].nodeRef, a następnie execution.nodes[nodeRef]. Bieżący dialog udostępnia text.textRef i speakerRef. Dalszy przebieg zależy od typu węzła.

Imię i dialog: gui.set_text. Odpowiedzi: węzły GUI, fokus wejścia oraz gui.pick_node w on_input; przechowuj ID opcji osobno. Zakończenie: wyłącz wspólny węzeł nadrzędny GUI przez gui.set_enabled(node, false) i zwolnij fokus wejścia.

1. Continue i End: przechodzenie po połączeniach i zamykanie okna tekstu
2. Wybory: ID odpowiedzi, kolejność i dalsza ścieżka
3. Warunki i zmienne: dziesięć lub dwie sztuki złota
4. Język: te same ID, treść odczytana w innym języku
5. Polecenie: wydanie przedmiotu lub otwarcie sklepu
6. Call/Return: wywołanie pobocznej sekwencji i powrót

-- Inside a function where the decoded story table is available.
local choice = story.execution.nodes["42edfff8-b8fe-46bf-ae0d-9e2347b6e726"]
for _, option_id in ipairs(choice.optionOrder) do
    local option = choice.options[option_id]
    print(option_id, option.text.textRef)
    -- Resolve the text; retain option_id for the corresponding GUI button.
end
local branch = story.execution.nodes["c1c3c372-0a73-4cd0-851d-ede59d5709bb"]
local gold = 10 -- Repeat with 2.
local next_step = branch.whenFalse
if gold >= branch.condition.right.value.value then next_step = branch.whenTrue end
print(next_step.nodeRef)

4 · Przypisz własne obrazy

Ten dodatkowy fragment zakłada dostępność bieżącego obiektu dialogu o nazwie node i elementów interfejsu wymienionych w komentarzach. W C++ i MonoGame speakerRef został już odczytany jako SpeakerId lub speakerId. Klucz to rzeczywisty identyfikator postaci Mira; nazwę i lokalizację obrazu ustalasz w swojej grze. Wstaw linie we wskazanych miejscach.

-- Add mira.png to an atlas and register that atlas as portraits in the GUI Textures.
local portraits = { ["807b2957-7bab-4a28-83a4-1f3d1589bbc2"] = "mira" }
local portrait = gui.get_node("portrait") -- GUI Box node using the portraits texture
local animation = portraits[node.speakerRef]
gui.set_enabled(portrait, animation ~= nil)
if animation then gui.play_flipbook(portrait, hash(animation)) end

Odczytuj imiona przez content.characters[speakerRef].nameTextRef tak samo jak tekst dialogu. Jeśli brakuje przypisanego obrazu, ukryj poprzedni portret lub pokaż obraz zastępczy. Wybór obrazu nie zależy od języka.

Użyj odwołań do obrazów z pełnego eksportu

5 · Dołącz pliki do gry

custom_resources dołącza surowy JSON do pakietu. Tablice Lua zaczynają się od 1: przechodź po optionOrder za pomocą ipairs. Mapy ID w JSON odczytuj przez table[id]. Obrazy dodaj do GUI przez zasoby atlasów.

Sprawdź wynik

1. Powitania po angielsku i niemiecku wyświetlają się poprawnie; dla niedostępnego języka pojawia się tekst angielski.
2. Po dodaniu obsługi przebiegu sprawdź obie odpowiedzi, 10 i 2 sztuki złota, powrót z pobocznej sekwencji oraz End.
3. Uruchom zbudowaną grę poza folderem projektu. Pliki JSON, czcionki i portrety muszą być dostępne także tam.

Oficjalna dokumentacja

Dokumentacja API i konfiguracji użytych w tej instrukcji:

• Wczytaj dane JSON
• Zasoby systemowe
• GUI API