PlayOptions ​

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.

Interface · import type { PlayOptions } from '@holostep-configurators/runtime-client/contract'; · stable · since 2.0.0 · section 14. Animations

The member options of animations.play. They pass through a tx.

Members ​

Member Kind Summary
loop? property true (open-ended) or a repeat count: a whole number from 1, the plays in all, after which the clip ends (anything else rejects HoloInputError('invalid-input')).
reverse? property Play towards the start: from the end, or from where a playing or paused clip is (see play).
speed? property Playback rate; 1 is authored speed.
toggle? property Play the opposite direction of the last play; on a playing or paused clip it turns round where the clip is (see play).

Inherited from SignalOption: signal.

Declaration ​

ts
export interface PlayOptions extends SignalOption {
  loop?: boolean | number;
  reverse?: boolean;
  speed?: number;
  toggle?: boolean;
}

Generic-API test (spec 3.1) ​

Rule Result
1. Neutral name pass: PlayOptions names no product
2. A precedent not recorded: no ledger row (coverage.json) names this member or its owner
3. Two apps, or labs not recorded: no ledger row names this member or its owner
4. The cheaper fix first not recorded per member (Appendix B decides it per need)