swiftlys2/docs/api/ai/
API Reference Trace

TraceParamsBuilder

Class
Namespace: SwiftlyS2.Shared.Trace · Assembly: SwiftlyS2.CS2.dll
public sealed class TraceParamsBuilder
Inherits object

Fluent builder for TraceParams.

View source

Constructors

TraceParamsBuilder()

public TraceParamsBuilder()

TraceParamsBuilder(TraceParams?)

public TraceParamsBuilder(TraceParams? seed)
Parameters

Methods

Build()

public TraceParams Build()

ForceHitEverything(bool)

Force the trace to hit everything.

public TraceParamsBuilder ForceHitEverything(bool enabled = true)
Parameters

HitSolid(bool)

Whether the trace should report solid hits.

public TraceParamsBuilder HitSolid(bool enabled = true)
Parameters

HitSolidRequiresGenerateContacts(bool)

Whether the trace should report hits requiring contact generation.

public TraceParamsBuilder HitSolidRequiresGenerateContacts(bool enabled = true)
Parameters

HitTrigger(bool)

Whether the trace should report trigger hits.

public TraceParamsBuilder HitTrigger(bool enabled = true)
Parameters

IgnoreDisabledPairs(bool)

Whether disabled collision pairs should be ignored.

public TraceParamsBuilder IgnoreDisabledPairs(bool enabled = true)
Parameters

IgnoreEntities(IEnumerable<CEntityInstance>)

Entities that should be ignored by the trace.

public TraceParamsBuilder IgnoreEntities(IEnumerable<CEntityInstance> entities)
Parameters

IgnoreEntity(CEntityInstance)

Entities that should be ignored by the trace.

public TraceParamsBuilder IgnoreEntity(CEntityInstance entity)
Parameters

IgnoreIfBothInteractWithHitboxes(bool)

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

public TraceParamsBuilder IgnoreIfBothInteractWithHitboxes(bool enabled = true)
Parameters

IgnoreOwner(CEntityInstance)

Entity owners that should be ignored by the trace.

public TraceParamsBuilder IgnoreOwner(CEntityInstance owner)
Parameters

IgnoreOwners(IEnumerable<CEntityInstance>)

Entity owners that should be ignored by the trace.

public TraceParamsBuilder IgnoreOwners(IEnumerable<CEntityInstance> owners)
Parameters

InteractAs(MaskTrace)

Interaction mask for "as" behavior.

public TraceParamsBuilder InteractAs(MaskTrace flags)
Parameters

InteractExclude(MaskTrace)

Interaction mask to exclude.

public TraceParamsBuilder InteractExclude(MaskTrace flags)
Parameters

InteractWith(MaskTrace)

Interaction mask to include.

public TraceParamsBuilder InteractWith(MaskTrace flags)
Parameters

RemoveInteractAs(MaskTrace)

Interaction mask for "as" behavior.

public TraceParamsBuilder RemoveInteractAs(MaskTrace flags)
Parameters

RemoveInteractExclude(MaskTrace)

Interaction mask to exclude.

public TraceParamsBuilder RemoveInteractExclude(MaskTrace flags)
Parameters

RemoveInteractWith(MaskTrace)

Interaction mask to include.

public TraceParamsBuilder RemoveInteractWith(MaskTrace flags)
Parameters

WithCapsuleRay(Vector, Vector, float)

public TraceParamsBuilder WithCapsuleRay(Vector centerA, Vector centerB, float radius)
Parameters

WithCollisionGroup(CollisionGroup)

Collision group used by the trace.

public TraceParamsBuilder WithCollisionGroup(CollisionGroup collisionGroup)
Parameters

WithDetailLayers(ushort, byte)

Included detail layers and target detail layer used by native query shape attributes.

public TraceParamsBuilder WithDetailLayers(ushort includedDetailLayers, byte targetDetailLayer = 0)
Parameters
  • includedDetailLayersushort
  • targetDetailLayerbyteoptional

WithHierarchyIds(params ushort[])

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

public TraceParamsBuilder WithHierarchyIds(params ushort[] hierarchyIds)
Parameters

WithHullRay(Vector, Vector)

public TraceParamsBuilder WithHullRay(Vector mins, Vector maxs)
Parameters

WithInteraction(MaskTrace, MaskTrace, MaskTrace)

Interaction mask to include/exclude and interaction mask for "as" behavior.

public TraceParamsBuilder WithInteraction(MaskTrace interactWith, MaskTrace interactExclude = MaskTrace.Empty, MaskTrace interactAs = MaskTrace.Empty)
Parameters

WithIterateEntities(bool)

Indicates whether entity iteration is enabled for custom filtering.

public TraceParamsBuilder WithIterateEntities(bool iterateEntities)
Parameters

WithLineRay(Vector, float)

public TraceParamsBuilder WithLineRay(Vector startOffset, float radius = 0)
Parameters

WithLineRay()

public TraceParamsBuilder WithLineRay()

WithObjectQuery(RnQueryObjectSet)

Which object groups should be included by the query.

public TraceParamsBuilder WithObjectQuery(RnQueryObjectSet objectQuery)
Parameters

WithRay(in Ray_t)

public TraceParamsBuilder WithRay(in Ray_t ray)
Parameters

WithShouldHitEntity(Func<CEntityInstance, bool>?)

Optional callback to decide whether an entity should be hit.

public TraceParamsBuilder WithShouldHitEntity(Func<CEntityInstance, bool>? shouldHitEntity)
Parameters

WithSphereRay(Vector, float)

public TraceParamsBuilder WithSphereRay(Vector center, float radius)
Parameters