PlacementPose
Defined in: client/api.d.ts:2690
Where a placement is aimed, and what it is aimed at.
Properties
Section titled “Properties”distance
Section titled “distance”distance:
number
Defined in: client/api.d.ts:2714
How far the aim point is from the camera, in metres.
normal
Section titled “normal”normal:
Vector3
Defined in: client/api.d.ts:2704
The surface normal under the aim, as a unit vector. Straight up when nothing was hit.
onSurface
Section titled “onSurface”onSurface:
boolean
Defined in: client/api.d.ts:2719
Whether the aim actually met something. False when the ray left the level, and the preview is standing at the fallback distance in mid-air.
position
Section titled “position”position:
Vector3
Defined in: client/api.d.ts:2694
Where the preview stands, in world-space metres.
rotation
Section titled “rotation”rotation:
Quaternion
Defined in: client/api.d.ts:2699
Which way it faces, including whatever the surface and the rotate keys added.
surface
Section titled “surface”surface:
string
Defined in: client/api.d.ts:2709
The game’s own name for what is underfoot – mat_dirt, mat_stone. Empty when nothing was hit.