Libraries.Interface.Events.CollisionEvent Documentation

The CollisionEvent class is used to represent a collision between a pair of Items.

Inherits from: Libraries.Language.Object

Actions Documentation

BeginCollision()

This action calls each colliding Item's BeginCollision action with the other Item as a parameter.

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Example

Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Contains(Libraries.Interface.Item2D item)

This action tests if either of the Items involved in this collision are the same as the given Item.

Parameters

Return

boolean:

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

Example

use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)

FinishCollision()

This action calls each colliding Item's FinishCollision action with the other Item as a parameter.

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

SetCollision(Libraries.Interface.Item2D i1, Libraries.Interface.Item2D i2)

This action sets the two items that are involved in this collision.

Parameters