TraceParamsBuilder
Class TraceParamsBuilder
Namespace: SwiftlyS2.Shared.Trace
Assembly: SwiftlyS2.CS2.dll
Fluent builder for TraceParams.
public sealed class TraceParamsBuilderInheritance
Inherited Members
- object.Equals(object?)
- object.Equals(object?, object?)
- object.GetHashCode()
- object.GetType()
- object.ReferenceEquals(object?, object?)
- object.ToString()
Constructors
TraceParamsBuilder()
public TraceParamsBuilder()TraceParamsBuilder(TraceParams?)
public TraceParamsBuilder(TraceParams? seed)- seed TraceParams?
Methods
Build()
public TraceParams Build()ForceHitEverything(bool)
Force the trace to hit everything.
public TraceParamsBuilder ForceHitEverything(bool enabled = true)- enabled bool
HitSolid(bool)
Whether the trace should report solid hits.
public TraceParamsBuilder HitSolid(bool enabled = true)- enabled bool
HitSolidRequiresGenerateContacts(bool)
Whether the trace should report hits requiring contact generation.
public TraceParamsBuilder HitSolidRequiresGenerateContacts(bool enabled = true)- enabled bool
HitTrigger(bool)
Whether the trace should report trigger hits.
public TraceParamsBuilder HitTrigger(bool enabled = true)- enabled bool
IgnoreDisabledPairs(bool)
Whether disabled collision pairs should be ignored.
public TraceParamsBuilder IgnoreDisabledPairs(bool enabled = true)- enabled bool
IgnoreEntities(IEnumerable<CEntityInstance>)
Entities that should be ignored by the trace.
public TraceParamsBuilder IgnoreEntities(IEnumerable<CEntityInstance> entities)- entities IEnumerable<CEntityInstance>
IgnoreEntity(CEntityInstance)
Entities that should be ignored by the trace.
public TraceParamsBuilder IgnoreEntity(CEntityInstance entity)- entity CEntityInstance
IgnoreIfBothInteractWithHitboxes(bool)
Whether hitboxes should be ignored when both sides interact with hitboxes.
public TraceParamsBuilder IgnoreIfBothInteractWithHitboxes(bool enabled = true)- enabled bool
IgnoreOwner(CEntityInstance)
Entity owners that should be ignored by the trace.
public TraceParamsBuilder IgnoreOwner(CEntityInstance owner)- owner CEntityInstance
IgnoreOwners(IEnumerable<CEntityInstance>)
Entity owners that should be ignored by the trace.
public TraceParamsBuilder IgnoreOwners(IEnumerable<CEntityInstance> owners)- owners IEnumerable<CEntityInstance>
InteractAs(MaskTrace)
Interaction mask for "as" behavior.
public TraceParamsBuilder InteractAs(MaskTrace flags)- flags MaskTrace
InteractExclude(MaskTrace)
Interaction mask to exclude.
public TraceParamsBuilder InteractExclude(MaskTrace flags)- flags MaskTrace
InteractWith(MaskTrace)
Interaction mask to include.
public TraceParamsBuilder InteractWith(MaskTrace flags)- flags MaskTrace
RemoveInteractAs(MaskTrace)
Interaction mask for "as" behavior.
public TraceParamsBuilder RemoveInteractAs(MaskTrace flags)- flags MaskTrace
RemoveInteractExclude(MaskTrace)
Interaction mask to exclude.
public TraceParamsBuilder RemoveInteractExclude(MaskTrace flags)- flags MaskTrace
RemoveInteractWith(MaskTrace)
Interaction mask to include.
public TraceParamsBuilder RemoveInteractWith(MaskTrace flags)- flags MaskTrace
WithCapsuleRay(Vector, Vector, float)
public TraceParamsBuilder WithCapsuleRay(Vector centerA, Vector centerB, float radius)WithCollisionGroup(CollisionGroup)
Collision group used by the trace.
public TraceParamsBuilder WithCollisionGroup(CollisionGroup collisionGroup)- collisionGroup CollisionGroup
WithDetailLayers(ushort, byte)
Included detail layers and target detail layer used by native query shape attributes.
public TraceParamsBuilder WithDetailLayers(ushort includedDetailLayers, byte targetDetailLayer = 0)WithHierarchyIds(params ushort[])
Optional hierarchy ids used by the native query shape attributes (max 2 values used).
public TraceParamsBuilder WithHierarchyIds(params ushort[] hierarchyIds)- hierarchyIds ushort[]
WithHullRay(Vector, Vector)
public TraceParamsBuilder WithHullRay(Vector mins, Vector maxs)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)WithIterateEntities(bool)
Indicates whether entity iteration is enabled for custom filtering.
public TraceParamsBuilder WithIterateEntities(bool iterateEntities)- iterateEntities bool
WithLineRay(Vector, float)
public TraceParamsBuilder WithLineRay(Vector startOffset, float radius = 0)WithLineRay()
public TraceParamsBuilder WithLineRay()WithObjectQuery(RnQueryObjectSet)
Which object groups should be included by the query.
public TraceParamsBuilder WithObjectQuery(RnQueryObjectSet objectQuery)- objectQuery RnQueryObjectSet
WithRay(in Ray_t)
public TraceParamsBuilder WithRay(in Ray_t ray)- ray Ray_t
WithShouldHitEntity(Func<CEntityInstance, bool>?)
Optional callback to decide whether an entity should be hit.
public TraceParamsBuilder WithShouldHitEntity(Func<CEntityInstance, bool>? shouldHitEntity)- shouldHitEntity Func<CEntityInstance, bool>?
WithSphereRay(Vector, float)
public TraceParamsBuilder WithSphereRay(Vector center, float radius)