Formes de résultat

Ce que répondent les services de PlayerVox OverCrow : la forme de chaque résultat et de chaque mise à jour d’abonnement. Le SDK exporte pour chaque forme un type TypeScript du même nom : la logique n’a donc jamais à les décrire à la main.

declare module "@overcrow/sdk" {
  interface WidgetState {
    /** The latest state, or `null` while it is unknown. */
    stopwatch: Stopwatch | null;
    /** The buttons take input only in Interactive mode. */
    interactive: boolean;
  }
}

Le widget Chronomètre garde dans son état la dernière valeur Stopwatch, et la vue en lit les membres :

      <elapsed class="value" base={state.stopwatch.elapsedMs} at={state.stopwatch.at} running={state.stopwatch.running} format="hh:mm:ss.cc"/>

Lire une forme

• Une forme est un enregistrement exact : chaque membre est présent, et un membre sans valeur vaut null ; il n’est jamais absent.
• « texte ou null » signifie que le membre peut valoir null : testez-le avant de l’afficher.
• Un entier est inférieur à 2^53 : il est donc exact en JavaScript. Les temps sont en millisecondes : « Millisecondes Unix » compte depuis 1970 en UTC, comme Date.now().
• Un membre accompagné de offsetMinutes est un horodatage à mettre en forme avec ce décalage UTC ; voir heure, dates et nombres.
• Un identifiant asset: est une image que PlayerVox OverCrow détient pour le widget : liez-le au src d’une image ou d’un avatar, ou dessinez-le sur un canvas. Ce n’est pas une URL, et ses octets ne peuvent pas être lus.
• Un abonnement dont la forme est « … ou null » livre null quand il n’y a rien à afficher : pas de jeu actif, pas de lecteur multimédia.

La référence des services indique quel service donne quelle forme.

Formes

HttpResponse

Réponse de http.fetch. { status, contentType } ou { status, asset }

GameEvent

Un événement de jeu. { event, at }

Session

Durée de la session du jeu actif. { elapsedMs, at }

Telemetry

Ressources utilisées par le jeu actif. { cpu, ram, cpuTemperature, gpuTemperature, sources }

Fps

Fréquence d’images du jeu actif. { fps, stale, status }

Stopwatch

Le chronomètre manuel. { running, elapsedMs, at, shortcuts }

Media

Le lecteur multimédia courant. { player, title, artists, playing, canPrevious, canPlayPause, canNext, cover }

NoteItem

Une entrée de liste de tâches. { id, text, checked }

Note

Une note. { id, title, body, items }

Notes

Le document de notes de l’utilisateur. { active, notes }

CreatedNote

Réponse de notes.create. { note }

Score

Note PlayerVox du jeu actif. { state, name, score, grade, ratingsCount, criteria }

Rating

La note PlayerVox que l’utilisateur a donnée au jeu actif. { gameplay, art, tech, review, publishedAt, offsetMinutes }

RatingState

La note que l’utilisateur a lui-même donnée au jeu actif, avec son état. { state, name, offline, rating }

Review

Un avis de joueur. { id, author, grade, score, text, original, hidden, publishedAt, offsetMinutes }

ReviewsState

Les avis des joueurs sur le jeu actif : ce qu’il faut lire, non les avis eux-mêmes. { state, revision, offline }

ReviewsPage

Une page d’avis de joueurs. { gameName, items, page, totalPages, count }

JournalSession

Une session du journal. { id, startedAt, offsetMinutes, durationMs, source }

JournalState

Le journal du jeu actif. { revision, notice }

JournalPage

Une page du journal du jeu. { gameName, items, page, next, previous }

ChatFragment

Une portion de texte ou une emote d’un message de chat. { text } ou { emote, alt }

ChatMessage

Un message de chat. { id, author, color, badges, fragments, reply, deleted, receivedAt }

TwitchChat

État du chat Twitch. { account, channel, joinState, failure, favorites, canSend, generation, reset, messages, removed, skipped }