init¶

Under Construction

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

Overview¶

Initialization of simulation contexts.

import type { InitOptions } from 'scenerystack/init';

name: string
REQUIRED VALUES The "internal" name of the simulation (e.g. 'energy-skate-park'), usually used for the npm package name
version: string
A semver string, e.g. '1.0.0'
splashDataURI: string
The URI for the splash screen data, which is a base64 encoded image (usually a PNG)
brand?: string
OPTIONS The "internal" name of the brand (e.g. 'made-with-scenerystack')
locale?: string
The initial locale. Should be one of the keys of the localeData object (see https://github.com/phetsims/babel/blob/main/localeData.json).
availableLocales?: string[]
All of the available locales for the translation (what is supported by the simulation, since it can be set by the ?locale=... query parameter, or switched dynamically if the allowLocaleSwitching below is true).
allowLocaleSwitching?: boolean
Whether the simulation allows switching locale dynamically (via the Preferences dialog, for example).
supportsDynamicLocale?: boolean
Sim Features (will document soon)
supportsInteractiveDescription?: boolean
supportsInteractiveHighlights?: boolean
supportsVoicing?: boolean
supportsPanAndZoom?: boolean
supportsSound?: boolean
colorProfiles?: string[]
supportedRegionsAndCultures?: string

See the source for init.ts in the scenerystack repository.