FollowOptions.offset ​

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 FollowOptions · stable · since 2.0.0

ts
offset?: 'rest' | 'current' | 'none';

'rest': keep the offset the two parts have in their rest poses (safe to call any time). 'current': keep today's offset. 'none': snap to the target.

Default: 'rest'

Generic-API test (spec 3.1) ​

Rule Result
1. Neutral name pass: offset names no product
2. A precedent pass: Unity Animations.ParentConstraint (offsets) (row G6); Unity Animations.ParentConstraint (row K56); Babylon.js TransformNode.attachToBone (row K56)
3. Two apps, or labs pass: 2 apps (ledger: app-c1384707fc, app-f9a32142f1)
4. The cheaper fix first decided per need in Appendix B: rows G6, K56 at tier stable (a member only where no rule, data, asset or app code serves the need)