PlayOptions

interface PlayOptions

How play is asked to run a scene.

devtools/src/cutscene.ts:59

Members

holdreadonly

hold?: boolean

Keep the last frame on stage rather than restoring the player on it.

On the final frame the director parks the playhead there, pauses the clock and reports the scene ended while status() stays live and sample keeps answering with that frame; stop restores as it always does. Off, the final frame restores the player and returns null, which is what a driver's ir.play and every measurement want. A seek away from a held end clears the outcome; the clock stays paused until a resume, as after any pause.