Struct TraceParams

Namespace: SwiftlyS2.Shared.Trace

Assembly: SwiftlyS2.CS2.dll

Unified parameters for shape tracing APIs. This combines trace shape and filter settings in one object.

public struct TraceParams

Inherited Members

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

Constructors

TraceParams()

public TraceParams()

Properties

Collision

Collision group used by the trace.

public CollisionGroup Collision { get; set; }

• CollisionGroup

EntitiesToIgnore

Entities that should be ignored by the trace.

public List<CEntityInstance> EntitiesToIgnore { get; set; }

• List<CEntityInstance>

ForceHitEverything

Force the trace to hit everything.

public bool ForceHitEverything { get; set; }

• bool

HierarchyIds

Optional hierarchy ids used by the native query shape attributes (max 2 values used).

public List<ushort> HierarchyIds { get; set; }

• List<ushort>

HitSolid

Whether the trace should report solid hits.

public bool HitSolid { get; set; }

• bool

HitSolidRequiresGenerateContacts

Whether the trace should report hits requiring contact generation.

public bool HitSolidRequiresGenerateContacts { get; set; }

• bool

HitTrigger

Whether the trace should report trigger hits.

public bool HitTrigger { get; set; }

• bool

IgnoreIfBothInteractWithHitboxes

Whether hitboxes should be ignored when both sides interact with hitboxes.

public bool IgnoreIfBothInteractWithHitboxes { get; set; }

• bool

IncludedDetailLayers

Included detail layers used by native query shape attributes.

public ushort IncludedDetailLayers { get; set; }

• ushort

InteractAs

Interaction mask for "as" behavior.

public MaskTrace InteractAs { get; set; }

• MaskTrace

InteractExclude

Interaction mask to exclude.

public MaskTrace InteractExclude { get; set; }

• MaskTrace

InteractWith

Interaction mask to include.

public MaskTrace InteractWith { get; set; }

• MaskTrace

IterateEntities

Indicates whether entity iteration is enabled for custom filtering.

public bool IterateEntities { get; set; }

• bool

ObjectQuery

Which object groups should be included by the query.

public RnQueryObjectSet ObjectQuery { get; set; }

• RnQueryObjectSet

OwnersToIgnore

Entity owners that should be ignored by the trace.

public List<CEntityInstance> OwnersToIgnore { get; set; }

• List<CEntityInstance>

Ray

The ray definition used for tracing shape.

public Ray_t Ray { get; set; }

• Ray_t

ShouldHitEntity

Optional callback to decide whether an entity should be hit.

public Func<CEntityInstance, bool>? ShouldHitEntity { get; set; }

• Func<CEntityInstance, bool>?

ShouldIgnoreDisabledPairs

Whether disabled collision pairs should be ignored.

public bool ShouldIgnoreDisabledPairs { get; set; }

• bool

TargetDetailLayer

Target detail layer used by native query shape attributes.

public byte TargetDetailLayer { get; set; }

• byte

Methods

Builder()

Creates a new fluent builder.

public static TraceParamsBuilder Builder()

• TraceParamsBuilder

Builder(TraceParams?)

Creates a new fluent builder seeded from an existing parameters object.

public static TraceParamsBuilder Builder(TraceParams? seed)

• seed TraceParams?

• TraceParamsBuilder

Clone()

Creates a deep copy of the current parameters.

public TraceParams Clone()

• TraceParams

DefaultLine()

Creates a default parameters instance suitable for most line traces.

public static TraceParams DefaultLine()

• TraceParams