Interface CollisionItem Beta

Describes a collision event between an item and another object.

Hierarchy

  • Collision

Properties

collidePoints: CollidePoint[]

Describes information of the collision point(s). If the collided object is touching with its surface or edge, it will be represented as multiple collision points.

handle: null | ItemHandle | PlayerHandle

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

If the collided object is an item, returns ItemHandle.
If the collided object is a player, returns PlayerHandle.
If the collided 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.

impulse: Vector3

The total amount of impulse generated from the collision.

object: HitObject

Describes the collided object.

Deprecated

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

relativeVelocity: Vector3

The relative velocity of the collided object as seen from the item.

Generated using TypeDoc