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

Summary

Variable Summary Table

VariablesDescription
integer FACEwhen the vertex of the 2D object is actually getting collid
integer VERTEX

Actions Summary Table

ActionsDescription
Clear()This action reset this CollisionIdentifier2D.
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns a CompareResult.
Equals(Libraries.Game.Collision.CollisionIdentifier2D other)This action is used to compare between identifiers to see if they are equal.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
Flip()This action flips the A object with the B object.
GetHashCode()This action gets the hash code for an object.
GetIndexA()This action gets the group index of object A.
GetIndexB()This action gets the group index of object B.
GetTypeA()This action returns whether object A is colliding with its edge or vertex.
GetTypeB()This action returns whether object B is colliding with its edge or vertex.
Set(Libraries.Game.Collision.CollisionIdentifier2D other)This action sets the current CollisionIdentifier2D using another CollisionIdentifier2D.
SetIndexA(integer indexA)This action sets the group index of object A.
SetIndexB(integer indexB)This action sets the group index of object B.
SetTypeA(integer typeA)This action sets whether object A is colliding with its edge or vertex.
SetTypeB(integer typeB)This action sets whether object B is colliding with its edge or vertex.

Actions Documentation

Clear()

This action reset this CollisionIdentifier2D.

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.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.

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.

Flip()

This action flips the A object with the B object.

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.

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

SetIndexB(integer indexB)

This action sets the group index of object B.

Parameters

SetTypeA(integer typeA)

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

Parameters

SetTypeB(integer typeB)

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

Parameters