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 stops.
Inherits from: Libraries.Language.Object
Summary
Actions Summary Table
Actions | Description |
---|---|
BeginCollision(Libraries.Interface.Events.CollisionEvent2D collision) | |
Compare(Libraries.Language.Object object) | This action compares two object hash codes and returns a CompareResult. |
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 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
- Libraries.Language.Object: The object to compare to.
Return
Libraries.Language.Support.CompareResult: 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(t)
Parameters
- Libraries.Language.Object: The to be compared.
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.