JVM e Android

Questa pagina è tradotta dall'inglese. Se le due versioni differiscono, fa fede la pagina in inglese. Leggi la pagina in inglese

Il player kit Kotlin funziona sulla JVM, su desktop e su Android. I giochi Java usano lo stesso kit tramite la sua facciata Java. Gli esempi seguono un gioco libGDX, il cui ciclo di rendering è il punto naturale in cui svuotare gli eventi, e le stesse chiamate si adattano a qualsiasi game loop.

Aggiungere il kit e le sue librerie native

Il kit e le sue librerie native sono artefatti separati su Maven Central, quindi aggiungili entrambi. Un gioco desktop aggiunge lingara-embed-natives-desktop, che contiene le librerie per Windows, macOS e Linux. Un modulo Android aggiunge invece lingara-embed-natives-android, un AAR. In un progetto libGDX, le librerie native desktop vanno nel modulo desktop e quelle Android nel modulo Android.

Un gioco Kotlin dipende da lingara-embed-kotlin; un gioco Java da lingara-embed-java, la facciata.

Ottenere i token dal tuo server

Il kit non conserva mai un segreto. Forniscigli la route dei token del tuo server e l’header che trasporta la sessione del giocatore, e il kit vi invia una richiesta ogni volta che ha bisogno di un token. Il tuo server emette il token con un kit server e risponde con il token e la sua scadenza.

Svuotare gli eventi nel ciclo di rendering

Il core esegue il suo I/O di rete su un proprio thread e non chiama mai il tuo codice. Nel tuo ciclo di rendering, sul thread del gioco, svuota ciò che è arrivato, al massimo 256 eventi alla volta, e gestisci ciascuno: un aggiornamento della pratica, una risposta di un NPC in streaming, un errore. In Java, ogni evento va al metodo corrispondente del tuo visitor. Chiudi il kit nella fase di dispose del tuo gioco, che arresta il core e lo libera.

Vedi Dialoghi con gli NPC e risultati della pratica per sapere cosa trasportano questi eventi.

KotlinJava

Kotlin

// The kit, and the natives for the platform: natives-desktop in a libGDX lwjgl3 module, natives-android in its android module.
implementation("com.getlingara:lingara-embed-kotlin:0.1.0-alpha.6")
implementation("com.getlingara:lingara-embed-natives-desktop:0.1.0-alpha.6")

Java

<!-- The kit, and the natives for the platform (lingara-embed-natives-android in an Android module). -->
<dependency>
  <groupId>com.getlingara</groupId>
  <artifactId>lingara-embed-java</artifactId>
  <version>0.1.0-alpha.6</version>
</dependency>
<dependency>
  <groupId>com.getlingara</groupId>
  <artifactId>lingara-embed-natives-desktop</artifactId>
  <version>0.1.0-alpha.6</version>
</dependency>

KotlinJava

Kotlin

// Your server mints the embed token; the kit POSTs {} here whenever it needs one.
private val lingara =
    LingaraEmbed.start(
        EmbedConfig(
            tokenSource =
                TokenSourceConfig.Http(
                    url = "https://my-game.example/lingara/token",
                    headers = listOf(Header("Authorization", Secret("Bearer $session"))),
                ),
            userAgentSuffix = "my-game/1.4",
        ),
    )

Java

// Your server mints the embed token; the kit POSTs {} here whenever it needs one.
lingara =
    LingaraEmbedJava.builder()
        .httpTokenSource(
            "https://my-game.example/lingara/token",
            Map.of("Authorization", "Bearer " + session))
        .userAgentSuffix("my-game/1.4")
        .build();

KotlinJava

Kotlin

// In render(), on the game thread: one crossing, at most 256 events.
fun render() {
    lingara.drain(256) { event ->
        when (event) {
            is EmbedEvent.Practice -> showPractice(event.snapshot.question?.prompt)
            is EmbedEvent.NpcTurn -> onNpcTurn(event.update)
            is EmbedEvent.Error -> println("Lingara error: ${event.error.message}")
            else -> Unit
        }
    }
}

// In dispose(): stops the core and frees it.
fun dispose() {
    lingara.close()
}

Java

// In render(), on the game thread: one crossing, at most 256 events, each to its visitor method.
void render() {
  lingara.drain(256, event -> LingaraEmbedJava.visit(event, visitor));
}

// In dispose(), or let try-with-resources do it.
@Override
public void close() {
  lingara.close();
}