Animations.play ​

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.

Method of Animations · stable · since 2.0.0 · called as session.animations.play

play(target: string | Part, clip: string, options?: C & PlayOptions): Promise<Report>;

Plays a clip (look-only; a newer play of the same clip on that part takes it over). Outcome: 'committed' when it ends or holds its last frame; with loop: true, once it has started. Through a tx: 'deferred', and it starts when the commit is shown. Fires 'animation:started' when the clip was neither playing nor paused (a takeover or a resume fires nothing), and 'animation:finished' when it ends. A play on a clip that is playing or paused continues from its current time in the asked direction, and the play it takes over resolves 'committed': a toggle mid-way turns round instead of jumping (Web Animations Animation.reverse()). Any other play starts at the clip's start, or at its end with reverse; stop it first to restart a playing clip. A stop, a reset, an exclusive play, a new asset version or the node's removal that ends a pending play resolves it 'committed' then (through a tx, when that commit is shown; spec 6.3). Errors: rejects HoloInputError on invalid input (toggle with reverse: true); AbortError when signal aborts first. A clip the target doesn't hold, a target whose GLB isn't loaded yet, or an unknown nodeId is not invalid input: it resolves matched: 0, changes nothing and records 'target-unmatched' with didYouMean from list(target) (1.x returned false and warned with the clip names). So await the scene write that loads the node before playing its clips.

Options ​

Through Session:

Through Tx:

Refused here (typed never, so passing one fails to compile): actor, checkpoint, dryRun, expectGroup, expectRevision, origin, supersede, undo.

Abort (signal) ​

This call is a write (SignalOption.signal, the kinds of call).

A write: before the commit point it rolls back and rejects AbortError; after it, no effect, except that a running camera move stops where the last frame drew it (CameraMoveOptions).

Through a tx the commit point is the transaction's: aborting a write still loading rejects AbortError and stages nothing (catch it: unobserved, it rolls the transaction back, spec section 6.1, O6); aborting one already staged unstages it, its paths keeping the latest other write to them as after a failed savepoint (O7), and its Promise stays resolved 'staged'.

Example ​

Imports: values (has, validate, the Holo*Error classes, the pure helpers) from @holostep-configurators/runtime-client, types from @holostep-configurators/runtime-client/contract, /math and /testing names from those entries; boot from the runtime module the root's loadRuntimeAtFloor resolves to. A type your page defines is your app's: declare it there, never import it from the package.

Compiled under the contract's strict settings (examples/declaration/14-Animations.play.ts):

import type { Session } from '@holostep-configurators/runtime-client/contract';
declare const session: Session;
declare const signal: AbortSignal;
declare const bedId: string;
declare const fanId: string;
// resolves when the clip ends: open, then closed
await session.animations.play(bedId, 'open', { toggle: true });
// open-ended: resolves once started
await session.animations.play(fanId, 'spin', { loop: true });

Generic-API test (spec 3.1) ​