Channel

This section refers to the channel object.

Properties

Warning

Any property that starts with the character _ is not meant to be changed

---

RayParams

Channel.RayParams: RaycastParams

RaycastParams tied to the Channel. All properties of the RaycastParams can be changed in runtime excluding FilterDescendantsInstances

Methods

Warning

Any method that starts with the character _ is not meant to be called.

---

Cast

Channel:Cast(Origin: Vector3, Direction: Vector3, WorldRoot: WorldRoot?): RaycastResult?

Casts a ray with the given origin and direction at the specified WorldRoot using the Channel's filter. If no WorldRoot is provided, then Workspace will be used instead.

Info

This method can be run in parallel.

Blockcast

Channel:Blockcast(BlockOrigin: CFrame, Size: Vector3, Direction: Vector3, WorldRoot: WorldRoot?): RaycastResult?

Casts a block shape in a given direction at the specified WorldRoot using the Channel's filter. If no WorldRoot is provided, then Workspace will be used instead. For more info on how Blockcasts work visit this page

Info

This method can be run in parallel.

Spherecast

Channel:Spherecast(Origin: Vector3, Radius: number, Direction: Vector3, WorldRoot: WorldRoot?): RaycastResult?

Casts a spherical shape in a given direction at the specified WorldRoot using the Channel's filter. If no WorldRoot is provided, then Workspace will be used instead. For more info on how Spherecasts work visit this page

Info

This method can be run in parallel.

Shapecast

Channel:Shapecast(Part: BasePart, Direction: Vector3, WorldRoot: WorldRoot?): RaycastResult?

Casts the 3D shape in a given direction at the specified WorldRoot using the Channel's filter. If no WorldRoot is provided, then Workspace will be used instead. For more info on how Shapecasts work visit this page

Info

This method can be run in parallel.

Destroy

Channel:Destroy()

Destroys a channel by cleaning up references and disconnecting events. After :Destroy is called, the corresponding FilterDescendantsInstances will no longer be actively maintained and the channel should no longer be used.

AddToFilter

Channel:AddToFilter(ToAdd: Instance | string )

Adds an instance or collection service tag to the FilterDescendantsInstances. This method protects you from adding duplicate entries.

Info

This method can be run in parallel when adding instances.

RemoveFromFilter

Channel:RemoveFromFilter(ToRemove: Instance | string )

Removes an Instance or collection service tag from the FilterDescendantsInstances. This method will not error if you try to remove a tag/instance that does not exist.

Info

This method can be run in parallel when removing instances.

ForceUpdateFilter

Channel:ForceUpdateFilter()

Forcefully updates the Channel's filter instead of waiting for the next module update at the "end" of a frame.