PlayOptions.toggle ​

Contract 2.0.0 · package sha256 a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e · generated from configurator-runtime.d.ts by services/onsite-scripter/scripts/build-contract-docs.mjs; edit the source, not this file.

Property of PlayOptions · stable · since 2.0.0

ts
toggle?: boolean;

Play the opposite direction of the last play; on a playing or paused clip it turns round where the clip is (see play). stop, reset and a new asset version clear the last direction, so the next toggle plays forward, as 1.x's resetAnimations() did. With reverse: true the call rejects HoloInputError('invalid-input'), because the two name different directions.

Default: false

Generic-API test (spec 3.1) ​

Rule Result
1. Neutral name pass: toggle names no product
2. A precedent pass: glTF 2.0 animations (row K64); Unity Animation.Play (row K64)
3. Two apps, or labs pass: 5 apps (ledger: app-0c773a4ee3, app-b362a81c85, app-f3598fad77, app-fb16dd1985, app-fd09090420)
4. The cheaper fix first decided per need in Appendix B: rows K64 at tier stable (a member only where no rule, data, asset or app code serves the need)