Libraries.Game.Collision.CollisionIdentifier2D Documentation

This class identifies the two objects' shapes that are involved in a collision and what type of collision is involved (vertex with vertex collision, vertex with face collision, face with face collision). This class is used internally by BroadphaseCollision2D and by CollisionPoint2D.

Inherits from: Libraries.Language.Object

Variables Table

VariablesDescription
integer FACEwhen the vertex of the 2D object is actually getting collided
integer VERTEXwhen the vertex of the 2D object is actually getting collided

Actions Documentation

Clear()

This action reset this CollisionIdentifier2D.

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.

Parameters

Return

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

Example

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

Equals(Libraries.Game.Collision.CollisionIdentifier2D other)

This action is used to compare between identifiers to see if they are equal.

Parameters

Return

boolean: true if they are equal, false if they are not equal.

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Parameters

Return

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

Example

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

Flip()

This action flips the A object with the B object.

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

GetIndexA()

This action gets the group index of object A.

Return

integer: the group index of object A.

GetIndexB()

This action gets the group index of object B.

Return

integer: the group index of object B.

GetTypeA()

This action returns whether object A is colliding with its edge or vertex.

Return

integer: the type of collision.

GetTypeB()

This action returns whether object B is colliding with its edge or vertex.

Return

integer: the type of collision.

Set(Libraries.Game.Collision.CollisionIdentifier2D other)

This action sets the current CollisionIdentifier2D using another CollisionIdentifier2D.

Parameters

SetIndexA(integer indexA)

This action sets the group index of object A.

Parameters

  • integer indexA

SetIndexB(integer indexB)

This action sets the group index of object B.

Parameters

  • integer indexB: The group index of object B.

SetTypeA(integer typeA)

This action sets whether object A is colliding with its edge or vertex.

Parameters

  • integer typeA: The type of collision.

SetTypeB(integer typeB)

This action sets whether object B is colliding with its edge or vertex.

Parameters

  • integer typeB: The type of collision.