Skip to content

GameInfoDialog

Overview

GameInfoDialog shows descriptions for the levels of a game. Each description is on a separate line. If the simulation supports the gameLevels query parameter (see getGameLevelsSchema.ts) the caller can optionally provide options.gameLevels to control which descriptions are visible.

@author Chris Malley (PixelZoom, Inc.)

Class GameInfoDialog

import { GameInfoDialog } from 'scenerystack/sim';

Constructor

new GameInfoDialog( levelDescriptions : ( string | TReadOnlyProperty<string> )[], providedOptions? : GameInfoDialogOptions )

Instance Methods

dispose()

Type GameInfoDialogOptions

import type { GameInfoDialogOptions } from 'scenerystack/sim';
  • gameLevels: number[]
    Game levels whose descriptions should be visible in the dialog. Levels are numbered starting from 1. Set this to the value of the gameLevels query parameter, a required query parameter. See getGameLevelsSchema.ts and example use in WaveGameInfoDialog.
  • descriptionTextOptions?: StrictOmit<RichTextOptions, "tandem">
    Options for the description text nodes
  • vBoxOptions?: StrictOmit<VBoxOptions, "children" | "maxWidth">
    Options for the layout (VBox)
  • maxContentWidth?: number
    constrains the width of the Dialog's content and title
  • & DialogOptions

Source Code

See the source for GameInfoDialog.ts in the vegas repository.