Lingara Lingara Documentação Guias API Bibliotecas Aplicações Criar Incorporar Aplicação web
Idioma: Português

Godot

Esta página é uma tradução do inglês. Se as duas diferirem, a página em inglês é a correta. Ler a página em inglês

O Godot oferece duas linguagens, e o Lingara tem um kit para cada uma. Um jogo em GDScript usa o addon do Lingara. Um jogo Godot em C# usa Lingara.Embed, o mesmo pacote que um jogo Unity usa. Use um ou outro num projeto, nunca os dois. Os separadores abaixo mostram cada um.

Instalação

GDScript. Instale o addon do Lingara a partir da Godot Asset Library e, em seguida, ative-o em Project Settings, Plugins. Ao ativá-lo, é adicionado um autoload chamado Lingara, a que cada cena acede em /root/Lingara.

C#. Adicione Lingara.Embed ao seu projeto como referência de pacote. O nó de exemplo abaixo, LingaraEmbedNode, não faz parte do pacote: adicione o seu código-fonte ao projeto e coloque-o numa cena.

Obter tokens do seu servidor

Nenhum dos kits guarda um segredo. Quando o núcleo precisa de um token, pede-o ao seu próprio servidor, que emite um com um kit de servidor e responde com o token e a sua validade.

Com o addon, defina a rota de tokens do seu servidor em Project Settings e o Lingara chama-a no seu próprio thread. Se a rota precisar da sessão do jogador, defina-a antes em tempo de execução, porque as definições do projeto são distribuídas dentro da sua exportação. Ou ligue token_needed e responda por si a cada pedido. Com C#, o nó de exemplo faz um pedido à sua rota de tokens sempre que o cliente pede um token. Em qualquer dos casos, comunique uma falha com token_unavailable ou TokenUnavailable, para que as chamadas em espera falhem de imediato.

Processar os eventos em cada frame

O núcleo executa a sua E/S de rede no seu próprio thread. O autoload do addon esvazia-a uma vez por frame e emite um sinal por evento, pelo que liga os sinais de que o seu jogo precisa e nunca esvazia nada por si. O nó C# esvazia em _process, no máximo 256 eventos por frame, e volta a emitir cada um como um sinal do Godot.

Os mesmos sinais transportam as respostas de NPC em streaming (consulte Diálogo com NPC) e as atualizações da prática (consulte resultados da prática).

<PackageReference Include="Lingara.Embed" Version="0.1.0-alpha.6" />
Linguagem do exemplo de código

Godot C#

// Your own server mints the token: never put a client secret in a game. The
// continuation may run off the main thread, which the client allows.
private async Task FetchToken()
{
    try
    {
        using var response = await Http.PostAsync(TokenUrl, new StringContent("{}"));
        response.EnsureSuccessStatusCode();
        using var body = JsonDocument.Parse(await response.Content.ReadAsStringAsync());
        Client?.ProvideToken(body.RootElement.GetProperty("token").GetString(), body.RootElement.GetProperty("expires_at").GetString());
    }
    catch (Exception e) when (e is HttpRequestException || e is JsonException || e is KeyNotFoundException)
    {
        Client?.TokenUnavailable(e.Message); // fail the waiting calls now
    }
}

GDScript

# The common case: set Project Settings > lingara/token_url to your server's
# token route, which answers exactly {"token", "expires_at"}. Lingara POSTs to
# it on its own thread whenever it needs a token. If the route needs the
# player's session, set it at run time instead (never in ProjectSettings,
# which ships inside the export):
func use_my_session(session_cookie: String) -> void:
	lingara.set_token_endpoint("https://game.example.com/lingara-token", {"cookie": session_cookie})


# Or answer each token_needed yourself, with whatever login your game has.
func _on_token_needed(_request: int, _reason: String) -> void:
	var http := HTTPRequest.new()
	add_child(http)
	http.request("https://game.example.com/lingara-token", [], HTTPClient.METHOD_POST, "{}")
	var reply: Array = await http.request_completed
	http.queue_free()
	var body: Variant = JSON.parse_string((reply[3] as PackedByteArray).get_string_from_utf8())
	if reply[1] == 200 and body is Dictionary:
		lingara.provide_token(body["token"], body["expires_at"])
	else:
		lingara.token_unavailable("the token route answered %d" % reply[1])
Linguagem do exemplo de código

Godot C#

public override void _Process(double delta)
{
    if (Client == null) return;
    events.Clear();
    Client.Drain(events); // at most 256 a frame; the rest wait for the next
    foreach (var e in events)
    {
        switch (e)
        {
            case EmbedEvent.TokenNeeded _: _ = FetchToken(); break;
            case EmbedEvent.NpcTurn { Update: NpcTurnUpdate.Fragment f } t:
                EmitSignal(SignalName.NpcTurnFragment, t.Dialogue.Value, t.Request.Value, f.Text); break;
            case EmbedEvent.NpcTurn { Update: NpcTurnUpdate.Finished f } t:
                EmitSignal(SignalName.NpcTurnFinished, t.Dialogue.Value, t.Request.Value, f.Text); break;
            case EmbedEvent.Practice p: EmitSignal(SignalName.PracticeChanged, p.Session.Value, p.Snapshot.Phase.ToString()); break;
            case EmbedEvent.Failed f: EmitSignal(SignalName.Failed, f.Error.KindName, f.Error.Message, f.Error.Request?.Value ?? 0); break;
            case EmbedEvent.Log log: GD.Print($"[lingara] {log.Level} {log.Target}: {log.Message}"); break;
        }
    }
}

GDScript

# The Lingara autoload the plugin adds, reached by path and typed, so every
# call and signal below is checked against LingaraEmbed.
@onready var lingara: LingaraEmbed = get_node("/root/Lingara")

# Enable the plugin (Project > Project Settings > Plugins): it adds the
# Lingara autoload, which drains the core once per frame and emits one signal
# per event. Connect the signals your game needs; you never call drain.
func _ready() -> void:
	lingara.token_needed.connect(_on_token_needed)
	lingara.event_received.connect(_on_event)
	lingara.error_raised.connect(func(error: Dictionary) -> void: push_warning(error.message))
	lingara.practice_changed.connect(_on_practice_changed)
	lingara.practice_finished.connect(_on_practice_finished)
	mei.replied.connect(_on_mei_replied)


func _on_event(_id: String, event_type: String, _created_at: String, data: Dictionary) -> void:
	if event_type == "lesson_plan.ready":
		print("a plan is ready: ", data.get("plan_id"))