Libraries.Game.Collision.CollisionEdge2D Documentation

This class represents a node to a doubly linked list of collision edges for 2D objects. The doubly linked list is used for every 2D objects that are collidable and have collided. So an Item2D object will have a head to a CollisionEdge2D doubly linked list.

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
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.
GetCollision()This action gets the collision event that the "Item2D other" object and the current Item2D object is represented in.
GetHashCode()This action gets the hash code for an object.
GetNext()This action sets the next node of the doubly linked list.
GetOther()This action gets the Item2D object that has the head of this CollisionEdge3D doubly linked list is colliding with.
GetPrevious()This action gets the previous node of the doubly linked list.
SetCollision(Libraries.Interface.Events.CollisionEvent2D collision)This action sets the collision event that the "Item2D other" object and the current Item2D object is represented in.
SetNext(Libraries.Game.Collision.CollisionEdge2D next)This action sets the next node of the doubly linked list.
SetOther(Libraries.Interface.Item2D other)This action sets the Item2D object that the Item2D object that has the head of this CollisionEdge3D doubly linked list is colliding with.
SetPrevious(Libraries.Game.Collision.CollisionEdge2D previous)This action sets the previous node of the doubly linked list.

Actions Documentation

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.

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.

GetCollision()

This action gets the collision event that the "Item2D other" object and the current Item2D object is represented in.

Return

Libraries.Interface.Events.CollisionEvent2D: the collision event that the "Item2D other" object and the current Item2D object is represented in.

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.

GetNext()

This action sets the next node of the doubly linked list.

Return

Libraries.Game.Collision.CollisionEdge2D: the next CollisionEdge2D.

GetOther()

This action gets the Item2D object that has the head of this CollisionEdge3D doubly linked list is colliding with.

Return

Libraries.Interface.Item2D: the Item2D object the head Item2D object is colliding with.

GetPrevious()

This action gets the previous node of the doubly linked list.

Return

Libraries.Game.Collision.CollisionEdge2D: the previous CollisionEdge2D.

SetCollision(Libraries.Interface.Events.CollisionEvent2D collision)

This action sets the collision event that the "Item2D other" object and the current Item2D object is represented in.

Parameters

SetNext(Libraries.Game.Collision.CollisionEdge2D next)

This action sets the next node of the doubly linked list.

Parameters

SetOther(Libraries.Interface.Item2D other)

This action sets the Item2D object that the Item2D object that has the head of this CollisionEdge3D doubly linked list is colliding with.

Parameters

SetPrevious(Libraries.Game.Collision.CollisionEdge2D previous)

This action sets the previous node of the doubly linked list.

Parameters