Skip to content

OopsDialog

Under Construction

This documentation is auto-generated, and is a work in progress. Please see the source code at https://github.com/phetsims/scenery-phet/blob/main/js/OopsDialog.ts for the most up-to-date information.

Overview

OopsDialog is displayed when some limitation of the simulation is encountered. So named because the message typically begins with 'Oops!', so that's how people referred to it. See https://github.com/phetsims/equality-explorer/issues/48

@author Chris Malley (PixelZoom, Inc.)

Class OopsDialog

import { OopsDialog } from 'scenerystack/sim';

Constructor

new OopsDialog( messageString : string | ReadOnlyProperty<string>, providedOptions? : OopsDialogOptions )

Instance Methods

dispose()

Static Properties

OopsDialogIO : IOType

(readonly)

Type OopsDialogOptions

import type { OopsDialogOptions } from 'scenerystack/sim';
  • iconNode?: Node
    Icon that will be placed to the right of the image. If not provided, then a PhET Girl image is used. If provided, the caller is responsible for all aspects of the icon, including scale.
  • iconPosition?: "left" | "right"
    Position of optional icon, relative to message text.
  • richTextOptions?: RichTextOptions
    Passed to RichText node that displays messageString
  • & DialogOptions

Source Code

See the source for OopsDialog.ts in the scenery-phet repository.