HingeJoint

Inherits: Joint < Spatial < Node < Object

A hinge between two 3D bodies.

Description

A HingeJoint normally uses the Z axis of body A as the hinge axis, another axis can be specified when adding it manually though.

Methods

boolget_flag ( Flag flag ) const
floatget_param ( Param param ) const
voidset_flag ( Flag flag, bool enabled )
voidset_param ( Param param, float value )

Enumerations

enum Param:

  • PARAM_BIAS = 0 — The speed with which the two bodies get pulled together when they move in different directions.
  • PARAM_LIMIT_UPPER = 1 — The maximum rotation. Only active if angular_limit/enable is true.
  • PARAM_LIMIT_LOWER = 2 — The minimum rotation. Only active if angular_limit/enable is true.
  • PARAM_LIMIT_BIAS = 3 — The speed with which the rotation across the axis perpendicular to the hinge gets corrected.
  • PARAM_LIMIT_SOFTNESS = 4
  • PARAM_LIMIT_RELAXATION = 5 — The lower this value, the more the rotation gets slowed down.
  • PARAM_MOTOR_TARGET_VELOCITY = 6 — Target speed for the motor.
  • PARAM_MOTOR_MAX_IMPULSE = 7 — Maximum acceleration for the motor.
  • PARAM_MAX = 8 — Represents the size of the Param enum.

enum Flag:

  • FLAG_USE_LIMIT = 0 — If true, the hinges maximum and minimum rotation, defined by angular_limit/lower and angular_limit/upper has effects.
  • FLAG_ENABLE_MOTOR = 1 — When activated, a motor turns the hinge.
  • FLAG_MAX = 2 — Represents the size of the Flag enum.

Property Descriptions

Default0.3
Setterset_param(value)
Getterget_param()

The speed with which the rotation across the axis perpendicular to the hinge gets corrected.


  • bool angular_limit/enable
Defaultfalse
Setterset_flag(value)
Getterget_flag()

If true, the hinges maximum and minimum rotation, defined by angular_limit/lower and angular_limit/upper has effects.


  • float angular_limit/lower
Default-90.0

The minimum rotation. Only active if angular_limit/enable is true.


  • float angular_limit/relaxation
Default1.0
Setterset_param(value)
Getterget_param()

The lower this value, the more the rotation gets slowed down.


  • float angular_limit/softness
Default0.9
Setterset_param(value)
Getterget_param()

  • float angular_limit/upper
Default90.0

The maximum rotation. Only active if angular_limit/enable is true.


Defaultfalse
Setterset_flag(value)
Getterget_flag()

When activated, a motor turns the hinge.


Default1.0
Setterset_param(value)
Getterget_param()

Maximum acceleration for the motor.


  • float motor/target_velocity
Default1.0
Setterset_param(value)
Getterget_param()

Target speed for the motor.


Default0.3
Setterset_param(value)
Getterget_param()

The speed with which the two bodies get pulled together when they move in different directions.

Method Descriptions



  • void set_flag ( Flag flag, bool enabled )

Doc ID missing

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 1970-01-01 at 00:00:00. It’s the English Stable version because it’s what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.