HingeJoint3D — C# API

A physics joint that restricts the rotation of a 3D physics body around an axis relative to another physics body.

class HingeJoint3DReckfellSharpInherits Joint3D

A physics joint that restricts the rotation of a 3D physics body around an axis relative to another physics body.

A physics joint that restricts the rotation of a 3D physics body around an axis relative to another physics body. For example, Body A can be a StaticBody3D representing a door hinge that a RigidBody3D rotates around.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

HingeJoint3DConstructor

# HingeJoint3D

C#
public HingeJoint3D();

Methods4

GetFlagbool

# GetFlag

C#
public bool GetFlag(HingeJoint3D.Flag flag);

Returns the value of the specified flag.

Parameters
Name	Type	Default
`flag`	`HingeJoint3D.Flag`	—

Returns bool

GetParamfloat

# GetParam

C#
public float GetParam(HingeJoint3D.Param param);

Returns the value of the specified parameter.

Parameters
Name	Type	Default
`param`	`HingeJoint3D.Param`	—

Returns float

SetFlagvoid

# SetFlag

C#
public void SetFlag(HingeJoint3D.Flag flag, bool enabled);

If true, enables the specified flag.

Parameters
Name	Type	Default
`flag`	`HingeJoint3D.Flag`	—
`enabled`	`bool`	—

SetParamvoid

# SetParam

C#
public void SetParam(HingeJoint3D.Param param, float value);

Sets the value of the specified parameter.

Parameters
Name	Type	Default
`param`	`HingeJoint3D.Param`	—
`value`	`float`	—

HingeJoint3D.Flag

Value	Description
`EnableMotor = 1`	When activated, a motor turns the hinge.
`Max = 2`	Represents the size of the `HingeJoint3D.Flag` enum.
`UseLimit = 0`	If `true`, the hinges maximum and minimum rotation, defined by `angular_limit/lower` and `angular_limit/upper` has effects.

HingeJoint3D.Param

Value	Description
`Bias = 0`	The speed with which the two bodies get pulled together when they move in different directions.
`LimitBias = 3`	The speed with which the rotation across the axis perpendicular to the hinge gets corrected.
`LimitLower = 2`	The minimum rotation. Only active if `angular_limit/enable` is `true`.
`LimitRelaxation = 5`	The lower this value, the more the rotation gets slowed down.
`LimitSoftness = 4`	Deprecated API Marked with Obsolete in the installed SDK. Original SDK message: This property is never used by the engine and is kept for compatibility purpose.
`LimitUpper = 1`	The maximum rotation. Only active if `angular_limit/enable` is `true`.
`Max = 8`	Represents the size of the `HingeJoint3D.Param` enum.
`MotorMaxImpulse = 7`	Maximum acceleration for the motor.
`MotorTargetVelocity = 6`	Target speed for the motor.