Query parameters that control the PhET-iO framework, and how it interfaces with the PhET-iO Simulation. This is not
an object defined in the global scope, but rather it serves as documentation about available query parameters.
Members
(static, nullable) phetioConsoleLog :string
Specify the format of the log of the PhET-iO event stream to the console. Possible options:
- json: emit json to the console
- colorized: emit formatted, human readable logging to the console.
- null: default, no logging to the console.
Type:
- string
(static) phetioEmitDeltas :boolean
Emits the state to the data stream (like phetioEmitStates), but only if the delta of the the current state is different
from the previous state. Emit only the pieces that have changed in the state, rather than the entire object each
time.
Type:
- boolean
(static) phetioEmitEmptyDeltas :boolean
When emitting deltas (see phetioEmitDeltas), emit deltas that are empty, to simplify playback from data streams.
Type:
- boolean
(static) phetioEmitHighFrequencyEvents :flag
If turned to false, the event stream will skip events tagged as high frequency in the simulation.
Type:
- flag
(static) phetioEmitInputEvents :flag
Emit the input events such as pointer moves, presses, releases, dt values and window resizing events
to support playback in a live simulation.
Type:
- flag
(static) phetioEmitStates :flag
When running a simulation, emit the state of the simulation to the data stream at the end of every X
frames (see phetioEmitStatesInterval). If the state has not changed from the last emitted state, then a new state
will not be emitted until the next time the state is different.
Type:
- flag
(static) phetioEmitStatesInterval :number
Sets the frame rate of emitting states. Only if phetioEmitStates is enabled. This parameter acts as a maximum
to the number of states that will be emitted, because identical, back to back states will not be emitted.
Type:
- number
(static) phetioStandalone :flag
Causes a phet-io simulation to launch, even without a wrapper's "go-ahead" step. This allows you to run a PhET-iO
Simulation that is not embedded in a wrapper iframe.
Type:
- flag
(static) phetioThrowSimErrors :flag
This will throw an internal sim error instead of passing it back out of the sim through PostMessage. This is a
handy parameter for testing and debugging, but should not be used in production.
Type:
- flag