Interface OverlapItem Beta

Describes an overlap between an item and another object.

Hierarchy

  • Overlap

Properties

Properties

handle: null | ItemHandle | PlayerHandle

Returns a handle that describes the overlapping object, or null.

If the overlapping object is an item, returns ItemHandle.
If the overlapping object is a player, returns PlayerHandle.
If the overlapping object is not an item or a player, returns null.

Refer Handles in the top page of Script Reference to know how to handle this value.

object: HitObject

Describes the overlapping object.

Deprecated

Overlap.object is deprecated. Please use Overlap.handle instead.

Describes which part of the item is overlapping.

Generated using TypeDoc