@dcl-regenesislabs/web-editor 0.3.22 → 0.3.23

package/prefabs/game-flow/scripts/game-flow.ts

@@ -19,12 +19,14 @@ import {
   advanceFlow,
   asFlowFact,
   configFromSeconds,
+  flowLabels,
   intermissionState,
   lobbyState,
   panelText,
   podiumLine,
   roundState,
   type FlowConfig,
+  type FlowLabels,
   type FlowState
 } from './pure/flow'
 
@@ -65,9 +67,46 @@ export class GameFlow {
     public boardKey: string = 'leaderboard',
     public display: '3D text' | '2D UI' = '3D text',
     /** For "2D UI": where the round timer sits on screen. */
-    public position: 'top' | 'top left' | 'top right' | 'bottom' = 'top'
+    public position: 'top' | 'top left' | 'top right' | 'bottom' = 'top',
+    /** The game's name, shown while players gather. Empty shows the lobby label. */
+    public gameTitle: string = '',
+    public lobbyLabel: string = 'LOBBY',
+    /** Shown until a round can start. */
+    public waitingLabel: string = 'Waiting for players',
+    /** After the waiting label: {present} players in, {needed} to start. */
+    public playersLabel: string = '{present}/{needed}',
+    public startingLabel: string = 'Starting',
+    /** {round} is the round number. */
+    public roundLabel: string = 'ROUND {round}',
+    public roundOverLabel: string = 'ROUND {round} OVER',
+    /** The winners line; {winners} lists them. */
+    public winnersLabel: string = 'Round over — {winners}',
+    public noWinnersLabel: string = 'Round over — nobody scored.'
   ) {}
 
+  private labelsFor: readonly string[] = []
+  private labelsCache: FlowLabels | null = null
+
+  // The 2D panel reads this every frame; rebuild only when an inspector edit changes a label.
+  private get labels(): FlowLabels {
+    const given = [
+      this.gameTitle,
+      this.lobbyLabel,
+      this.waitingLabel,
+      this.playersLabel,
+      this.startingLabel,
+      this.roundLabel,
+      this.roundOverLabel,
+      this.winnersLabel,
+      this.noWinnersLabel
+    ]
+    if (this.labelsCache !== null && given.every((value, i) => value === this.labelsFor[i])) return this.labelsCache
+    const [gameTitle, lobby, waiting, players, starting, round, roundOver, winners, noWinners] = given
+    this.labelsFor = given
+    this.labelsCache = flowLabels({ gameTitle, lobby, waiting, players, starting, round, roundOver, winners, noWinners })
+    return this.labelsCache
+  }
+
   private get config(): FlowConfig {
     return configFromSeconds(this.roundSeconds, this.countdownSeconds, this.intermissionSeconds, this.minPlayers)
   }
@@ -153,7 +192,7 @@ export class GameFlow {
   }
 
   private announcePodium(): void {
-    game.broadcast(ANNOUNCE, { text: podiumLine(game.state[this.boardKey], PODIUM_PLACES) })
+    game.broadcast(ANNOUNCE, { text: podiumLine(game.state[this.boardKey], PODIUM_PLACES, this.labels) })
   }
 
   private publish(): void {
@@ -167,7 +206,7 @@ export class GameFlow {
 
   private text(): string {
     const fact = asFlowFact(game.state[FLOW_KEY])
-    return panelText(fact, game.now(), this.endsWhen === 'timer', this.config.minPlayers)
+    return panelText(fact, game.now(), this.endsWhen === 'timer', this.config.minPlayers, this.labels)
   }
 
   private paint(): void {

package/prefabs/game-flow/scripts/pure/flow.ts

@@ -166,20 +166,76 @@ export function shortName(player: string): string {
   return player.startsWith('0x') && player.length > 10 ? `${player.slice(0, 6)}…${player.slice(-4)}` : player
 }
 
-/** The winners line broadcast to every player at the end of a round. */
-export function podiumLine(value: unknown, places: number): string {
-  const top = standingsOf(value).slice(0, Math.max(1, places))
-  if (top.length === 0) return 'Round over — nobody scored.'
-  return `Round over — ${top.map((row, i) => `${i + 1}. ${shortName(row.player)}`).join('  ')}`
+/**
+ * Every word a player reads, so a creator can write them in the game's language. `{round}`,
+ * `{present}`, `{needed}` and `{winners}` are filled in where a label names them.
+ */
+export interface FlowLabels {
+  /** The game's name while players gather; empty shows `lobby`. */
+  gameTitle: string
+  lobby: string
+  waiting: string
+  players: string
+  starting: string
+  round: string
+  roundOver: string
+  winners: string
+  noWinners: string
+}
+
+export const DEFAULT_LABELS: FlowLabels = {
+  gameTitle: '',
+  lobby: 'LOBBY',
+  waiting: 'Waiting for players',
+  players: '{present}/{needed}',
+  starting: 'Starting',
+  round: 'ROUND {round}',
+  roundOver: 'ROUND {round} OVER',
+  winners: 'Round over — {winners}',
+  noWinners: 'Round over — nobody scored.'
+}
+
+/** A cleared field falls back to English rather than a blank line; a line break would split the panel. */
+export function flowLabels(given: Partial<Record<keyof FlowLabels, unknown>>): FlowLabels {
+  const out = { ...DEFAULT_LABELS }
+  for (const key of Object.keys(DEFAULT_LABELS) as Array<keyof FlowLabels>) {
+    const value = given[key]
+    if (typeof value === 'string' && value.trim() !== '') out[key] = value.replace(/\s*\n\s*/g, ' ').trim()
+  }
+  return out
 }
 
-export function panelText(fact: FlowFact | null, nowMs: number, showClock: boolean, needed: number): string {
-  if (fact === null) return 'GAME FLOW\n--:--\nwaiting for the Multiplayer Server'
+export function fillLabel(template: string, values: Record<string, string | number>): string {
+  return template.replace(/\{(\w+)\}/g, (whole, key: string) => (key in values ? String(values[key]) : whole))
+}
+
+/** The winners line broadcast to every player at the end of a round. */
+export function podiumLine(value: unknown, places: number, labels: FlowLabels = DEFAULT_LABELS): string {
+  const top = standingsOf(value).slice(0, Math.max(1, places))
+  if (top.length === 0) return labels.noWinners
+  return fillLabel(labels.winners, { winners: top.map((row, i) => `${i + 1}. ${shortName(row.player)}`).join('  ') })
+}
+
+export function panelText(
+  fact: FlowFact | null,
+  nowMs: number,
+  showClock: boolean,
+  needed: number,
+  labels: FlowLabels = DEFAULT_LABELS
+): string {
+  const gathering = labels.gameTitle === '' ? labels.lobby : labels.gameTitle
+  // before the server's first answer nobody knows the head count yet
+  if (fact === null) return `${gathering}\n--:--\n${labels.waiting}`
+  const round = { round: fact.round }
   if (fact.phase === 'lobby') {
-    if (fact.endsAtMs === 0) return `LOBBY\n--:--\n${fact.present}/${needed} players`
-    return `LOBBY\n${formatCountdown(secondsLeft(fact, nowMs))}\nstarting`
+    if (fact.endsAtMs === 0) {
+      return `${gathering}\n--:--\n${labels.waiting} ${fillLabel(labels.players, { present: fact.present, needed })}`
+    }
+    return `${gathering}\n${formatCountdown(secondsLeft(fact, nowMs))}\n${labels.starting}`
+  }
+  if (fact.phase === 'intermission') {
+    return `${fillLabel(labels.roundOver, round)}\n${formatCountdown(secondsLeft(fact, nowMs))}`
   }
-  if (fact.phase === 'intermission') return `ROUND ${fact.round} OVER\n${formatCountdown(secondsLeft(fact, nowMs))}`
-  if (!showClock) return `ROUND ${fact.round}`
-  return `ROUND ${fact.round}\n${formatCountdown(secondsLeft(fact, nowMs))}`
+  if (!showClock) return fillLabel(labels.round, round)
+  return `${fillLabel(labels.round, round)}\n${formatCountdown(secondsLeft(fact, nowMs))}`
 }