Libraries.Interface.Events.CollisionEvent Documentation

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

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
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 a CompareResult.
Contains(Libraries.Interface.Item2D item)This action tests if either of the Items involved in this collision are the same as the given Item.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
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.
SetCollision(Libraries.Interface.Item2D i1, Libraries.Interface.Item2D i2)This action sets the two items that are involved in this collision.

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 a CompareResult. The compare result is either larger if this hash code is larger than the object passed as a parameter, smaller, or equal.

Example Code

use Libraries.Language.Support.CompareResult
        Object o
        Object t
        CompareResult result = o:Compare(t)

Parameters

Return

Libraries.Language.Support.CompareResult: The Compare result, Smaller, Equal, or Larger.

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.

Example Code

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

Parameters

Return

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

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.

Example Code

Object o
        integer hash = o:GetHashCode()

Return

integer: The integer hash code of the object.

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

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

Parameters