Libraries.Interface.Events.CollisionListener2D Documentation

This class' actions are meant to be overwritten during a game simulation which allows the programers to control what happens when a collision begins. This class is used in CollisionEvent2D, which keep track of when collision happens and when collision stop

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
BeginCollision(Libraries.Interface.Events.CollisionEvent2D collision)
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
FinishCollision(Libraries.Interface.Events.CollisionEvent2D collision)
GetHashCode()This action gets the hash code for an object.

Actions Documentation

BeginCollision(Libraries.Interface.Events.CollisionEvent2D collision)

Parameters

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.

Example Code

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

Parameters

Return

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

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(

Parameters

Return

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

FinishCollision(Libraries.Interface.Events.CollisionEvent2D collision)

Parameters

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.