Struct TraceResult

Namespace: SwiftlyS2.Shared.Trace

Assembly: SwiftlyS2.CS2.dll

public struct TraceResult

Inherited Members

• object.Equals(object?)
• object.Equals(object?, object?)
• object.GetHashCode()
• object.GetType()
• object.ReferenceEquals(object?, object?)
• object.ToString()

Constructors

TraceResult()

public TraceResult()

Properties

BodyTransform

The transformation matrix of the body that was hit.

public readonly CTransform BodyTransform { get; }

• CTransform

Contents

The contents mask of the surface or volume that was hit.

public readonly ulong Contents { get; }

• ulong

DidHit

Returns true if the trace hit something (either the trace fraction is less than 1.0 or the start position was in solid).

public bool DidHit { get; }

• bool

Direction

Calculates the normalized direction vector of the trace from start to end.

public Vector Direction { get; }

• Vector

Distance

Calculates the total distance traveled from the start position to the end position.

public float Distance { get; }

• float

EndPos

The ending position of the trace.

public readonly Vector EndPos { get; }

• Vector

Entity

The entity that was hit by the trace, if applicable. Null if nothing or a static surface was hit.

public readonly CEntityInstance? Entity { get; }

• CEntityInstance?

ExactHitPoint

Indicates whether the exact hit point was calculated for this trace result.

public readonly bool ExactHitPoint { get; }

• bool

Fraction

The fraction of the trace distance traveled before hitting something (0.0 = start, 1.0 = end, > 1.0 = no hit).

public readonly float Fraction { get; }

• float

HitBox

Information about the hitbox that was hit by the trace, if applicable.

public readonly HitBoxTrace? HitBox { get; }

• HitBoxTrace?

HitNormal

The surface normal of the point where the trace hit.

public readonly Vector HitNormal { get; }

• Vector

HitOffset

The distance from the trace start position to the hit point along the trace direction.

public readonly float HitOffset { get; }

• float

HitPoint

The exact point in 3D space where the trace hit a surface or entity.

public readonly Vector HitPoint { get; }

• Vector

HitboxBoneIndex

The bone index of the hitbox that was hit, if applicable.

public readonly short HitboxBoneIndex { get; }

• short

RayType

The type of ray that was used for this trace.

public readonly RayType_t RayType { get; }

• RayType_t

ShapeAttributes

The collision attributes of the shape that was hit.

public readonly TraceCollisionAttributes ShapeAttributes { get; }

• TraceCollisionAttributes

StartInSolid

Indicates whether the starting position of the trace was already inside a solid object.

public readonly bool StartInSolid { get; }

• bool

StartPos

The starting position of the trace.

public readonly Vector StartPos { get; }

• Vector

SurfaceProperties

The physical surface properties of the surface that was hit by the trace.

public readonly PhysSurfacePropertiesTrace? SurfaceProperties { get; }

• PhysSurfacePropertiesTrace?

Triangle

The triangle index of the surface that was hit, if applicable.

public readonly int Triangle { get; }

• int

Methods

HitEntity<T>(out T?)

public bool HitEntity<T>(out T? entity) where T : class, ISchemaClass<T>

• entity T?

• bool

• T

HitEntity<T>()

public bool HitEntity<T>() where T : class, ISchemaClass<T>

• bool

• T

HitEntityByDesignerName<T>(string, out T?, NameMatchType)

public bool HitEntityByDesignerName<T>(string designerName, out T? outEntity, NameMatchType matchType = NameMatchType.StartsWith) where T : class, ISchemaClass<T>

• designerName string
• outEntity T?
• matchType NameMatchType

• bool

• T

HitEntityByDesignerName<T>(string, NameMatchType)

public bool HitEntityByDesignerName<T>(string designerName, NameMatchType matchType = NameMatchType.StartsWith) where T : class, ISchemaClass<T>

• designerName string
• matchType NameMatchType

• bool

• T

HitPlayer(out IPlayer?)

public bool HitPlayer(out IPlayer? player)

• player IPlayer?

• bool

HitPlayer()

public bool HitPlayer()

• bool

ToString()

Returns the fully qualified type name of this instance.

public override string ToString()

• string — The fully qualified type name.