Animations.reset Contract 2.0.0 · package sha256
a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e· generated fromconfigurator-runtime.d.tsbyservices/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.reset
reset(target?: string | Part, options?: C & SignalOption): Promise<Report>;Every clip of target (or of all nodes and items) back to its first frame, stopped; each one's next toggle plays forward. Fires 'animation:stopped' once for each clip that was playing or paused (through a tx, when the commit is shown), so a count of started minus ended clips returns to 0; 1.x's resetAll() fired nothing. Through a tx: staged.
Default: target every loaded node and item
Through Session:
| Option | Type | Default | What it does |
|---|---|---|---|
actor |
Actor |
the expectGroup's actor when one is given, else 'app' |
Who made the write. |
dryRun |
boolean |
false | Runs and reports, then rolls back by design ('dry-run'). |
expectGroup |
HistoryGroup |
undefined | A guard, checked at the call: this write belongs to the undo group you are running. |
expectRevision |
number |
undefined (no check) | If-match on session.revision. |
origin |
string |
null | Your tag, echoed unchanged in Report.origin and cause.origin. |
signal |
AbortSignal |
undefined | Cancels this call; the member's JSDoc says what an abort does. |
supersede |
boolean |
false (the write is queued behind the transaction and applies after it closes) | While a transaction is open: roll it back (it resolves 'superseded'); the writes queued behind it apply in call order, then this one, which supersedes an… |
undo |
'rebase' | (string & {}) |
a recorded-state change gets one step labelled 'Change'; a look-only write gets none; the session's first model (cause 'load') gets none, whatever the label: it is the floor of history | An undo label makes this write one undo step. |
Through Tx:
| Option | Type | Default | What it does |
|---|---|---|---|
signal |
AbortSignal |
undefined | Cancels this call; the member's JSDoc says what an abort does. |
Refused here (typed never, so passing one fails to compile): actor, checkpoint, dryRun, expectGroup, expectRevision, origin, supersede, undo.
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
txthe 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'.
| Rule | Result |
|---|---|
| 1. Neutral name | pass: reset names no product |
| 2. A precedent | pass: model-viewer (ar, camera-orbit, auto-rotate) (row G18); Unity Animator.Rebind (row G18); Unity AnimationClip.SampleAnimation (row G36); glTF 2.0 animations (row K64); Unity Animation.Play (row K64) |
| 3. Two apps, or labs | pass: 9 apps (ledger: app-04c2774145, app-0c773a4ee3, app-4762caacdc, app-b362a81c85, app-f3598fad77, app-f9a32142f1, app-fb16dd1985, app-fd09090420; fleet cross-check: app-04c2774145, app-0c773a4ee3, app-4762caacdc, app-b362a81c85, app-bcb7ef21da, app-f9a32142f1, app-fd09090420) |
| 4. The cheaper fix first | decided per need in Appendix B: rows G18, G36, K64 at tier stable (a member only where no rule, data, asset or app code serves the need) |