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

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.
GetHashCode()This action gets the hash code for an object.
GetJoint()This action returns the joint (Joint2D) that the joint edge represents.
GetNext()This action returns the next joint edge (JointEdge2D) in the joint graph.
GetOther()This action returns the other Item2D that the joint edge connects to.
GetPrevious()This action returns the previous joint edge (JointEdge2D) in the joint graph.
SetJoint(Libraries.Game.Physics.Joints.Joint2D newJoint)This action sets the next joint edge to be the passed Joint2D.
SetNext(Libraries.Game.Physics.Joints.JointEdge2D newNext)This action sets the next joint edge in the joint graph to be the passed JointEdge2D.
SetOther(Libraries.Interface.Item2D newOther)This action sets other, the other Item2D that the joint connects, to be the passed Joint2D.
SetPrevious(Libraries.Game.Physics.Joints.JointEdge2D newPrevious)This action sets the previous joint edge in the joint graph to be the passed JointEdge2D.

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.

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.

GetJoint()

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

Example Code

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

Return

Libraries.Game.Physics.Joints.Joint2D:

GetNext()

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

Example Code

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

Return

Libraries.Game.Physics.Joints.JointEdge2D:

GetOther()

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

Example Code

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

Return

Libraries.Interface.Item2D:

GetPrevious()

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

Example Code

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

Return

Libraries.Game.Physics.Joints.JointEdge2D:

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

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

Example Code

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

Parameters

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

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

Example Code

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

Parameters

SetOther(Libraries.Interface.Item2D newOther)

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

Example Code

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

Parameters

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

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

Example Code

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

Parameters