Open Asterune
RaycastParams

RaycastParams

Configures filtering and collision behavior for ray and shape casts.

Behavior

RaycastParams configures filtering and collision behavior for ray and shape casts.

Summary

Constructors1
Functions1
  • RaycastParams.new(): RaycastParams

    Creates a mutable set of spatial-query options.

Members7
Properties6
Methods1

Constructors

new

RaycastParams.new(): RaycastParams

Creates a mutable set of spatial-query options.

Properties

BruteForceAllSlow

RaycastParams.BruteForceAllSlow: boolean

Whether to use the slower exhaustive query path instead of the normal spatial acceleration structure.

CollisionGroup

RaycastParams.CollisionGroup: string

The collision group used to filter query candidates.

FilterDescendantsInstances

RaycastParams.FilterDescendantsInstances: table

The Instances whose descendants are included or excluded by FilterType.

FilterType

RaycastParams.FilterType: EnumItem

Whether the descendant filter includes or excludes the specified hierarchies.

IgnoreWater

RaycastParams.IgnoreWater: boolean

Whether the cast ignores water.

RespectCanCollide

RaycastParams.RespectCanCollide: boolean

Whether the query uses collision eligibility rather than query eligibility.

Methods

AddToFilter

RaycastParams:AddToFilter(instances: Instance | { Instance }): ()

Appends an Instance or array of Instances to the descendant filter.

Operators

__tostring · __type