ClipInfo.exclusiveWith ​

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 ClipInfo · stable · since 2.0.0 · called as session.animations.list(target).exclusiveWith

readonly exclusiveWith: readonly string[];

The same model's clips that animate a node or joint this one does, in glTF order: a play of one of them returns this clip to frame 0 first (see Animations), firing no event when it is held at its end. Clips it doesn't name play beside it.

Default: [] (it shares no node with another clip)

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-ClipInfo.exclusiveWith.ts):

import type { Session } from '@holostep-configurators/runtime-client/contract';
declare const session: Session;
declare const signal: AbortSignal;
// A door button keeps its own state; a play of a clip that shares the door's nodes closes it.
let doorOpen = false;
session.on('animation:finished', ({ clip }) => void (clip === 'DoorOpen' && (doorOpen = true)), {
  signal,
});
export async function playClip(clip: string): Promise<void> {
  const door = session.animations.list('cabinet').find((c) => c.clip === 'DoorOpen');
  if (door?.exclusiveWith.includes(clip)) doorOpen = false; // back at frame 0
  await session.animations.play('cabinet', clip);
}
export const isDoorOpen = (): boolean => doorOpen;

Generic-API test (spec 3.1) ​