Libraries.Game.Collision.CollisionEdge3D Documentation
This class represents a node to a doubly linked list of collision edges for 3D objects. The doubly linked list is used for every 3D objects that are collidable and have collided. So an Item3D object will have a head to a CollisionEdge3D doubly linked list.
Inherits from: Libraries.Language.Object
Summary
Actions Summary Table
Actions | Description |
---|---|
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 "Item3D other" object and the current Item3D object is represented in. |
GetHashCode() | This action gets the hash code for an object. |
GetNext() | This action gets the next node of the doubly linked list. |
GetOther() | This action gets the Item3D object that the Item3D 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.CollisionEvent3D collision) | This action sets the collision event that the "Item3D other" object and the current Item3D object is represented in. |
SetNext(Libraries.Game.Collision.CollisionEdge3D next) | This action sets the next node of the doubly linked list. |
SetOther(Libraries.Interface.Item3D other) | This action sets the Item3D object that the Item3D object that has the head of this CollisionEdge3D doubly linked list is colliding with. |
SetPrevious(Libraries.Game.Collision.CollisionEdge3D 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
- 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.
GetCollision()
This action gets the collision event that the "Item3D other" object and the current Item3D object is represented in.
Return
Libraries.Interface.Events.CollisionEvent3D: the collision event that records which object is colliding.
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 gets the next node of the doubly linked list.
Return
Libraries.Game.Collision.CollisionEdge3D: the next node of the doubly linked list.
GetOther()
This action gets the Item3D object that the Item3D object that has the head of this CollisionEdge3D doubly linked list is colliding with.
Return
Libraries.Interface.Item3D: the other 3D object in the collision.
GetPrevious()
This action gets the previous node of the doubly linked list.
Return
Libraries.Game.Collision.CollisionEdge3D: the previous node of the doubly linked list.
SetCollision(Libraries.Interface.Events.CollisionEvent3D collision)
This action sets the collision event that the "Item3D other" object and the current Item3D object is represented in.
Parameters
- Libraries.Interface.Events.CollisionEvent3D: The collision event that records which object is colliding.
SetNext(Libraries.Game.Collision.CollisionEdge3D next)
This action sets the next node of the doubly linked list.
Parameters
- Libraries.Game.Collision.CollisionEdge3D: The next node of the doubly linked list.
SetOther(Libraries.Interface.Item3D other)
This action sets the Item3D object that the Item3D object that has the head of this CollisionEdge3D doubly linked list is colliding with.
Parameters
- Libraries.Interface.Item3D: The other 3D object in the collision.
SetPrevious(Libraries.Game.Collision.CollisionEdge3D previous)
This action sets the previous node of the doubly linked list.
Parameters
- Libraries.Game.Collision.CollisionEdge3D: The previous node of the doubly linked list.