SimInfo¶

Under Construction

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

Overview¶

Return an object of data about the simulation and the browser much of the code was largely copied and expanded on from SimTroubleshootPage.html in the website repo. Note that key names in the info object are used by the PhET-iO API, do not change without great consideration.

@author Michael Kauzmann (PhET Interactive Simulations)

Class SimInfo¶

import { SimInfo } from 'scenerystack/sim';

Constructor¶

new SimInfo( sim : Sim )¶

Instance Methods¶

Instance Properties¶

info : SimInfoState¶

(readonly)

Static Properties¶

SimInfoIO : IOType¶

Type ScreenState¶

import type { ScreenState } from 'scenerystack/sim';

name: string
phetioID?: string

Type SimInfoState¶

import type { SimInfoState } from 'scenerystack/sim';

simName: string
screens: ScreenState[]
repoName: string
screenPropertyValue: string
wrapperMetadata: null | Record<string, IntentionalAny>
dataStreamVersion: string
phetioCommandProcessorProtocol: string
simVersion: string | null
randomSeed: number | null
url: string | null
userAgent: string | null
window: string | null
referrer: string | null
language: string | null
pixelRatio: string | null
isWebGLSupported: boolean | null
checkIE11StencilSupport: boolean | null
flags: string | null

Source Code¶

See the source for SimInfo.ts in the joist repository.