Libraries.Game.Physics.Joints.Joint3D Documentation

This class has all of the possible joint types and blueprint actions for all 3D joints.

Inherits from: Libraries.Language.Object

Summary

Variable Summary Table

VariablesDescription
integer SixDegreesOfFreedom
integer Slider
integer Hinge
integer PointToPoint

Actions Summary Table

ActionsDescription
BuildJacobian()
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.
GetAppliedImpulse()This action returns the amount of impulse that should be applied to the items in the joints to allow them to continue to be joined.
GetEdgeA()This action returns the first JointEdge3D stored inside this Joint3D.
GetEdgeB()This action returns the second JointEdge3D stored inside this Joint3D.
GetHashCode()This action gets the hash code for an object.
GetInformation(Libraries.Game.Physics.CollisionSolverInformation3D information)
GetItemA()This action returns the first 3D item that is joined by this Joint3D.
GetItemB()This action returns the second 3D item that is joined by this Joint3D.
GetNext()This action gets you the next information about a joint (stored in another Joint3D) inside a linked list of Joint3Ds.
GetPrevious()This action gets you the previous information about a joint (stored in another Joint3D) inside a linked list of Joint3Ds.
GetType()This action returns the type of joint that you have.
InCollisionGroup()This action returns whether the items in this joint is in a collision group with other items.
SetAppliedImpulse(number impulse)This action sets the amount of impulse that should be applied to the items in the joints to allow them to continue to be joined.
SetEdgeA(Libraries.Game.Physics.Joints.JointEdge3D edgeA)This action sets the first JointEdge3D stored inside this Joint3D.
SetEdgeB(Libraries.Game.Physics.Joints.JointEdge3D edgeB)This action sets the second JointEdge3D stored inside this Joint3D.
SetInCollisionGroup(boolean flag)This action sets whether the items in this joint is in a collision group with other items.
SetItemA(Libraries.Interface.Item3D item)This action sets the first 3D item that is joined by this Joint3D.
SetItemB(Libraries.Interface.Item3D item)This action sets the second 3D item that is joined by this Joint3D.
SetNext(Libraries.Game.Physics.Joints.Joint3D next)This action lets you store another information about a joint (stored in another Joint3D) as a next link to the current Joint3D.
SetPrevious(Libraries.Game.Physics.Joints.Joint3D previous)This action lets you store another information about a joint (stored in another Joint3D) as a previous link to the current Joint3D.
SetType(integer type)This action sets the type of joint that you have.
SolveJoint(number timeStep)

Actions Documentation

BuildJacobian()

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.

GetAppliedImpulse()

This action returns the amount of impulse that should be applied to the items in the joints to allow them to continue to be joined.

Return

number: the amount of impulse that should be applied to the items.

GetEdgeA()

This action returns the first JointEdge3D stored inside this Joint3D.

Return

Libraries.Game.Physics.Joints.JointEdge3D: the first JointEdge3D stored inside this Joint3D.

GetEdgeB()

This action returns the second JointEdge3D stored inside this Joint3D.

Return

Libraries.Game.Physics.Joints.JointEdge3D: the second JointEdge3D stored inside this Joint3D.

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.

GetInformation(Libraries.Game.Physics.CollisionSolverInformation3D information)

Parameters

GetItemA()

This action returns the first 3D item that is joined by this Joint3D.

Return

Libraries.Interface.Item3D: the first 3D item that is joined by this Joint3D.

GetItemB()

This action returns the second 3D item that is joined by this Joint3D.

Return

Libraries.Interface.Item3D: the second 3D item that is joined by this Joint3D.

GetNext()

This action gets you the next information about a joint (stored in another Joint3D) inside a linked list of Joint3Ds.

Return

Libraries.Game.Physics.Joints.Joint3D: the next joint.

GetPrevious()

This action gets you the previous information about a joint (stored in another Joint3D) inside a linked list of Joint3Ds.

Return

Libraries.Game.Physics.Joints.Joint3D: the previous joint.

GetType()

This action returns the type of joint that you have.

Return

integer: the type of joint that you have.

InCollisionGroup()

This action returns whether the items in this joint is in a collision group with other items.

Return

boolean: true when the items are in a collision group, false if they are not

SetAppliedImpulse(number impulse)

This action sets the amount of impulse that should be applied to the items in the joints to allow them to continue to be joined.

Parameters

SetEdgeA(Libraries.Game.Physics.Joints.JointEdge3D edgeA)

This action sets the first JointEdge3D stored inside this Joint3D.

Parameters

SetEdgeB(Libraries.Game.Physics.Joints.JointEdge3D edgeB)

This action sets the second JointEdge3D stored inside this Joint3D.

Parameters

SetInCollisionGroup(boolean flag)

This action sets whether the items in this joint is in a collision group with other items.

Parameters

SetItemA(Libraries.Interface.Item3D item)

This action sets the first 3D item that is joined by this Joint3D.

Parameters

SetItemB(Libraries.Interface.Item3D item)

This action sets the second 3D item that is joined by this Joint3D.

Parameters

SetNext(Libraries.Game.Physics.Joints.Joint3D next)

This action lets you store another information about a joint (stored in another Joint3D) as a next link to the current Joint3D.

Parameters

SetPrevious(Libraries.Game.Physics.Joints.Joint3D previous)

This action lets you store another information about a joint (stored in another Joint3D) as a previous link to the current Joint3D.

Parameters

SetType(integer type)

This action sets the type of joint that you have. PointToPoint = 0, Hinge = 1, SixDegreesOfFreedom = 2, Slider = 3

Parameters

SolveJoint(number timeStep)

Parameters