# `Hit`

> 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 { Hit } from '@holostep-configurators/runtime-client/contract';` · stable · since 2.0.0 · section 6. Queries, rules and parts

A hit, on the session's input (so its part takes commit options). [`normal`](Hit.normal.md) is the world face normal. Observed (stamped [`frame`](Hit.frame.md)).

## Members

| Member | Kind | Summary |
| --- | --- | --- |
| <a id="part"></a>[`part`](Hit.part.md) | property | The part hit, bound to the session. |
| <a id="point"></a>[`point`](Hit.point.md) | property | World point, metres. |
| <a id="normal"></a>[`normal`](Hit.normal.md) | property | World face normal, unit length. |
| <a id="distance"></a>[`distance`](Hit.distance.md) | property | Metres from the ray origin. |
| <a id="uv"></a>[`uv?`](Hit.uv.md) | property | TEXCOORD_0 at the hit. |
| <a id="instanceindex"></a>[`instanceIndex?`](Hit.instanceIndex.md) | property | Index into an instanced item. |
| <a id="frame"></a>[`frame`](Hit.frame.md) | property | The drawn frame the hit was computed against. |

## Declaration

```ts
export interface Hit {
  readonly part: Part<CommitOptions>;
  readonly point: ReadonlyPoint3;
  readonly normal: ReadonlyPoint3;
  readonly distance: number;
  readonly uv?: Point2;
  readonly instanceIndex?: number;
  readonly frame: number;
}
```

## Generic-API test (spec 3.1)

| Rule | Result |
| --- | --- |
| 1. Neutral name | pass: `Hit` names no product |
| 2. A precedent | pass: [Pointer events](https://developer.mozilla.org/en-US/docs/Web/API/Pointer_events) (row `K46`) |
| 3. Two apps, or labs | pass: 5 apps (ledger: app-b4ae2fce25, app-ddfb017681, app-fc306ec3dc; fleet cross-check: app-b4ae2fce25, app-ddfb017681, app-e61a0b42ad, app-fc07850558, app-fc306ec3dc) |
| 4. The cheaper fix first | decided per need in Appendix B: rows `K46` at tier stable (a member only where no rule, data, asset or app code serves the need) |