Libraries.Game.Physics.Joints.JointEdge2D Documentation

The JointEdge2D class is used to define edges between nodes in the joint graph. When collisions are resolved, JointEdge2D objects are used to find connected items to add to CollisionGroup2D.

Example Code

// Will fill in when this class is used in the incoming Item2D class

Inherits from: Libraries.Language.Object

Actions Documentation

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

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()

GetJoint()

This action returns the joint (Joint2D) that the joint edge represents.

Return

Libraries.Game.Physics.Joints.Joint2D:

Example

// This is the backend.... Will fill in these examples later.
package Libraries.Game.Physics.Joints
use Libraries.Interface.Item2D
Item2D item1
Item2D item2

GetNext()

This action returns the next joint edge (JointEdge2D) in the joint graph.

Return

Libraries.Game.Physics.Joints.JointEdge2D:

Example

// This is the backend.... Will fill in these examples later.
package Libraries.Game.Physics.Joints
use Libraries.Interface.Item2D
Item2D item1
Item2D item2

GetOther()

This action returns the other Item2D that the joint edge connects to.

Return

Libraries.Interface.Item2D:

Example

// This is the backend.... Will fill in these examples later.
package Libraries.Game.Physics.Joints
use Libraries.Interface.Item2D
Item2D item1
Item2D item2

GetPrevious()

This action returns the previous joint edge (JointEdge2D) in the joint graph.

Return

Libraries.Game.Physics.Joints.JointEdge2D:

Example

// This is the backend.... Will fill in these examples later.
package Libraries.Game.Physics.Joints
use Libraries.Interface.Item2D
Item2D item1
Item2D item2

SetJoint(Libraries.Game.Physics.Joints.Joint2D newJoint)

This action sets the next joint edge to be the passed Joint2D.

Parameters

Example

// This is the backend.... Will fill in these examples later.
package Libraries.Game.Physics.Joints
use Libraries.Interface.Item2D
Item2D item1
Item2D item2

SetNext(Libraries.Game.Physics.Joints.JointEdge2D newNext)

This action sets the next joint edge in the joint graph to be the passed JointEdge2D.

Parameters

Example

// This is the backend.... Will fill in these examples later.
package Libraries.Game.Physics.Joints
use Libraries.Interface.Item2D
Item2D item1
Item2D item2

SetOther(Libraries.Interface.Item2D newOther)

This action sets other, the other Item2D that the joint connects, to be the passed Joint2D.

Parameters

Example

// This is the backend.... Will fill in these examples later.
package Libraries.Game.Physics.Joints
use Libraries.Interface.Item2D
Item2D item1
Item2D item2

SetPrevious(Libraries.Game.Physics.Joints.JointEdge2D newPrevious)

This action sets the previous joint edge in the joint graph to be the passed JointEdge2D.

Parameters

Example

// This is the backend.... Will fill in these examples later.
package Libraries.Game.Physics.Joints
use Libraries.Interface.Item2D
Item2D item1
Item2D item2