# `Input.raycast`

> 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 [`Input`](Input.md) · stable · since 2.0.0 · called as `session.input.raycast`

```ts
raycast(ray: Ray, options?: RaycastOptions): Promise<Hit[]>;
```

Observed. Every hit along the ray, nearest first, with world face normals.

## Options

Through [`Session`](Session.md):

| Option | Type | Default | What it does |
| --- | --- | --- | --- |
| `includeHidden` | `boolean` | false | Hidden parts can be hit too. |
| `maxDistance` | `number` | Infinity | Metres. |
| `query` | `Query` | every pickable part | The parts that can be hit, whatever their `pickable` (as `includeHidden` opts hidden parts in); connector planes never. |

## Generic-API test (spec 3.1)

| Rule | Result |
| --- | --- |
| 1. Neutral name | pass: `raycast` names no product |
| 2. A precedent | pass: [Unity Physics.RaycastAll](https://docs.unity3d.com/ScriptReference/Physics.RaycastAll.html) (row `G13`); [Unity Physics.Raycast](https://docs.unity3d.com/ScriptReference/Physics.Raycast.html) (row `K43`) |
| 3. Two apps, or labs | pass: 9 apps (ledger: app-b362a81c85, app-b4ae2fce25, app-ddfb017681, app-fc07850558, app-fc306ec3dc; fleet cross-check: app-04c2774145, app-37356bf09f, app-4762caacdc, app-e61a0b42ad, app-fc306ec3dc) |
| 4. The cheaper fix first | decided per need in Appendix B: rows `G13`, `K43` at tier stable (a member only where no rule, data, asset or app code serves the need) |