Api Sandbox SceneTraceResult
struct

SceneTraceResult

public sealed struct SceneTraceResult

Properties

Name Type Description
Distance Single The distance between start and end positions.

Methods

static SceneTraceResult From(Scene scene, PhysicsTraceResult r)
static SceneTraceResult From(Scene scene, Result r)

Fields

Name Type Description
Scene Scene
Hit Boolean Whether the trace hit something or not
StartedSolid Boolean Whether the trace started in a solid
StartPosition Vector3 The start position of the trace
EndPosition Vector3 The end or hit position of the trace
HitPosition Vector3 The hit position of the trace. Requires Boolean).
Normal Vector3 The hit surface normal (direction vector)
Fraction Single A fraction [0..1] of where the trace hit between the start and the original end positions
GameObject GameObject The GameObject that was hit
Component Component The Component that was hit
Collider Collider The Collider that was hit
Body PhysicsBody The physics object that was hit, if any
Shape PhysicsShape The physics shape that was hit, if any
Surface Surface The physical properties of the hit surface
Bone Int32 The id of the hit bone (either from hitbox or physics shape)
Direction Vector3 The direction of the trace ray
Triangle Int32 The triangle index hit, if we hit a mesh physics shape
Tags String[] The tags that the hit shape had
Hitbox Hitbox The hitbox that we hit
Assembly: Sandbox.Engine Namespace: Sandbox Full Name: Sandbox.SceneTraceResult