Skip to Content
EffectsShockwave

Shockwave

This is a parent class used to define the raycasting behavior of ring, line, and debris effects.

Summary

Attributes

RayDirection : Vector3

The direction and magnitude of the raycast from the origin attachment.

RayCollisionGroup : string

The collision group used for raycasting.

FilterTag : string

The tag used to create a part filter for raycasting.

FilterType : Enum

Defines the nature of the part filter used for raycasting.

IgnoreWater : boolean

When true, rays will ignore water terrain.

IgnoreCanCollide : boolean

When true, rays will ignore the ‘CanCollide’ property of parts.

Attributes

RayDirection

Vector3

The direction and magnitude of the raycast from the origin attachment.

RayCollisionGroup

string

The collision group used for raycasting. Parts with collision groups that cannot collide with the ray’s collision group are ignored.

FilterTag

string

The tag used to create a part filter for raycasting. The nature of the filter changes based on the ‘FilterType’ attribute.

FilterType

Enum

Defines the nature of the part filter used for raycasting.

  • Exclude - all parts inside the filter are ignored by the ray.
  • Include - only parts inside the filter can be hit by the ray.      

IgnoreWater

boolean

When true, rays will ignore water terrain.

IgnoreCanCollide

boolean

When true, rays will ignore the ‘CanCollide’ property of parts.

Last updated on