Index · Object → Node → Node3D → Joint3D → Generic6DOFJoint3D

Generic6DOFJoint3D

A physics joint that allows for complex movement and rotation between two 3D physics bodies.

Class Description

The Generic6DOFJoint3D (6 Degrees Of Freedom) joint allows for implementing custom types of joints by locking the rotation and translation of certain axes.

The first 3 DOF represent the linear motion of the physics bodies and the last 3 DOF represent the angular motion of the physics bodies. Each axis can be either locked, or limited.

Properties

var angular_limit_x/damping: float = 1.0

The amount of rotational damping across the X axis.

The lower, the longer an impulse from one side takes to travel to the other side.

var angular_limit_x/enabled: bool = true

If true, rotation across the X axis is limited.

var angular_limit_x/erp: float = 0.5

When rotating across the X axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower.

var angular_limit_x/force_limit: float = 0.0

The maximum amount of force that can occur, when rotating around the X axis.

var angular_limit_x/lower_angle: float = 0.0

The minimum rotation in negative direction to break loose and rotate around the X axis.

var angular_limit_x/restitution: float = 0.0

The amount of rotational restitution across the X axis. The lower, the more restitution occurs.

var angular_limit_x/softness: float = 0.5

The speed of all rotations across the X axis.

var angular_limit_x/upper_angle: float = 0.0

The minimum rotation in positive direction to break loose and rotate around the X axis.

var angular_limit_y/damping: float = 1.0

The amount of rotational damping across the Y axis. The lower, the more damping occurs.

var angular_limit_y/enabled: bool = true

If true, rotation across the Y axis is limited.

var angular_limit_y/erp: float = 0.5

When rotating across the Y axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower.

var angular_limit_y/force_limit: float = 0.0

The maximum amount of force that can occur, when rotating around the Y axis.

var angular_limit_y/lower_angle: float = 0.0

The minimum rotation in negative direction to break loose and rotate around the Y axis.

var angular_limit_y/restitution: float = 0.0

The amount of rotational restitution across the Y axis. The lower, the more restitution occurs.

var angular_limit_y/softness: float = 0.5

The speed of all rotations across the Y axis.

var angular_limit_y/upper_angle: float = 0.0

The minimum rotation in positive direction to break loose and rotate around the Y axis.

var angular_limit_z/damping: float = 1.0

The amount of rotational damping across the Z axis. The lower, the more damping occurs.

var angular_limit_z/enabled: bool = true

If true, rotation across the Z axis is limited.

var angular_limit_z/erp: float = 0.5

When rotating across the Z axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower.

var angular_limit_z/force_limit: float = 0.0

The maximum amount of force that can occur, when rotating around the Z axis.

var angular_limit_z/lower_angle: float = 0.0

The minimum rotation in negative direction to break loose and rotate around the Z axis.

var angular_limit_z/restitution: float = 0.0

The amount of rotational restitution across the Z axis. The lower, the more restitution occurs.

var angular_limit_z/softness: float = 0.5

The speed of all rotations across the Z axis.

var angular_limit_z/upper_angle: float = 0.0

The minimum rotation in positive direction to break loose and rotate around the Z axis.

var angular_motor_x/enabled: bool = false

If true, a rotating motor at the X axis is enabled.

var angular_motor_x/force_limit: float = 300.0

Maximum acceleration for the motor at the X axis.

var angular_motor_x/target_velocity: float = 0.0

Target speed for the motor at the X axis.

var angular_motor_y/enabled: bool = false

If true, a rotating motor at the Y axis is enabled.

var angular_motor_y/force_limit: float = 300.0

Maximum acceleration for the motor at the Y axis.

var angular_motor_y/target_velocity: float = 0.0

Target speed for the motor at the Y axis.

var angular_motor_z/enabled: bool = false

If true, a rotating motor at the Z axis is enabled.

var angular_motor_z/force_limit: float = 300.0

Maximum acceleration for the motor at the Z axis.

var angular_motor_z/target_velocity: float = 0.0

Target speed for the motor at the Z axis.

var angular_spring_x/damping: float = 0.0
var angular_spring_x/enabled: bool = false
var angular_spring_x/equilibrium_point: float = 0.0
var angular_spring_x/stiffness: float = 0.0
var angular_spring_y/damping: float = 0.0
var angular_spring_y/enabled: bool = false
var angular_spring_y/equilibrium_point: float = 0.0
var angular_spring_y/stiffness: float = 0.0
var angular_spring_z/damping: float = 0.0
var angular_spring_z/enabled: bool = false
var angular_spring_z/equilibrium_point: float = 0.0
var angular_spring_z/stiffness: float = 0.0
var linear_limit_x/damping: float = 1.0

The amount of damping that happens at the X motion.

var linear_limit_x/enabled: bool = true

If true, the linear motion across the X axis is limited.

var linear_limit_x/lower_distance: float = 0.0

The minimum difference between the pivot points' X axis.

var linear_limit_x/restitution: float = 0.5

The amount of restitution on the X axis movement. The lower, the more momentum gets lost.

var linear_limit_x/softness: float = 0.7

A factor applied to the movement across the X axis. The lower, the slower the movement.

var linear_limit_x/upper_distance: float = 0.0

The maximum difference between the pivot points' X axis.

var linear_limit_y/damping: float = 1.0

The amount of damping that happens at the Y motion.

var linear_limit_y/enabled: bool = true

If true, the linear motion across the Y axis is limited.

var linear_limit_y/lower_distance: float = 0.0

The minimum difference between the pivot points' Y axis.

var linear_limit_y/restitution: float = 0.5

The amount of restitution on the Y axis movement. The lower, the more momentum gets lost.

var linear_limit_y/softness: float = 0.7

A factor applied to the movement across the Y axis. The lower, the slower the movement.

var linear_limit_y/upper_distance: float = 0.0

The maximum difference between the pivot points' Y axis.

var linear_limit_z/damping: float = 1.0

The amount of damping that happens at the Z motion.

var linear_limit_z/enabled: bool = true

If true, the linear motion across the Z axis is limited.

var linear_limit_z/lower_distance: float = 0.0

The minimum difference between the pivot points' Z axis.

var linear_limit_z/restitution: float = 0.5

The amount of restitution on the Z axis movement. The lower, the more momentum gets lost.

var linear_limit_z/softness: float = 0.7

A factor applied to the movement across the Z axis. The lower, the slower the movement.

var linear_limit_z/upper_distance: float = 0.0

The maximum difference between the pivot points' Z axis.

var linear_motor_x/enabled: bool = false

If true, then there is a linear motor on the X axis. It will attempt to reach the target velocity while staying within the force limits.

var linear_motor_x/force_limit: float = 0.0

The maximum force the linear motor can apply on the X axis while trying to reach the target velocity.

var linear_motor_x/target_velocity: float = 0.0

The speed that the linear motor will attempt to reach on the X axis.

var linear_motor_y/enabled: bool = false

If true, then there is a linear motor on the Y axis. It will attempt to reach the target velocity while staying within the force limits.

var linear_motor_y/force_limit: float = 0.0

The maximum force the linear motor can apply on the Y axis while trying to reach the target velocity.

var linear_motor_y/target_velocity: float = 0.0

The speed that the linear motor will attempt to reach on the Y axis.

var linear_motor_z/enabled: bool = false

If true, then there is a linear motor on the Z axis. It will attempt to reach the target velocity while staying within the force limits.

var linear_motor_z/force_limit: float = 0.0

The maximum force the linear motor can apply on the Z axis while trying to reach the target velocity.

var linear_motor_z/target_velocity: float = 0.0

The speed that the linear motor will attempt to reach on the Z axis.

var linear_spring_x/damping: float = 0.01
var linear_spring_x/enabled: bool = false
var linear_spring_x/equilibrium_point: float = 0.0
var linear_spring_x/stiffness: float = 0.01
var linear_spring_y/damping: float = 0.01
var linear_spring_y/enabled: bool = false
var linear_spring_y/equilibrium_point: float = 0.0
var linear_spring_y/stiffness: float = 0.01
var linear_spring_z/damping: float = 0.01
var linear_spring_z/enabled: bool = false
var linear_spring_z/equilibrium_point: float = 0.0
var linear_spring_z/stiffness: float = 0.01
Inherited from Joint3D (4)
var node_a: NodePath = NodePath("")
var node_b: NodePath = NodePath("")
Inherited from Node3D (17)
var position: Vector3 = Vector3(0, 0, 0)
var rotation: Vector3 = Vector3(0, 0, 0)
var rotation_order: EulerOrder = 2
var scale: Vector3 = Vector3(1, 1, 1)
var top_level: bool = false
var transform: Transform3D = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)
var visibility_parent: NodePath = NodePath("")
var visible: bool = true
Inherited from Node (14)
var owner: Node

Methods

func get_flag_x(flag: Generic6DOFJoint3D.Flag) -> bool
func get_flag_y(flag: Generic6DOFJoint3D.Flag) -> bool
func get_flag_z(flag: Generic6DOFJoint3D.Flag) -> bool
func get_param_x(param: Generic6DOFJoint3D.Param) -> float
func get_param_y(param: Generic6DOFJoint3D.Param) -> float
func get_param_z(param: Generic6DOFJoint3D.Param) -> float
func set_flag_x(flag: Generic6DOFJoint3D.Flag, value: bool) -> void
func set_flag_y(flag: Generic6DOFJoint3D.Flag, value: bool) -> void
func set_flag_z(flag: Generic6DOFJoint3D.Flag, value: bool) -> void
func set_param_x(param: Generic6DOFJoint3D.Param, value: float) -> void
func set_param_y(param: Generic6DOFJoint3D.Param, value: float) -> void
func set_param_z(param: Generic6DOFJoint3D.Param, value: float) -> void
Inherited from Joint3D (1)
func get_rid() -> RID
Inherited from Node3D (37)
func add_gizmo(gizmo: Node3DGizmo) -> void
func clear_gizmos() -> void
func force_update_transform() -> void
func get_gizmos() -> Node3DGizmo[]
func global_rotate(axis: Vector3, angle: float) -> void
func global_scale(scale: Vector3) -> void
func global_translate(offset: Vector3) -> void
func hide() -> void
func look_at(target: Vector3, up: Vector3 = Vector3(0, 1, 0), use_model_front: bool = false) -> void
func look_at_from_position(position: Vector3, target: Vector3, up: Vector3 = Vector3(0, 1, 0), use_model_front: bool = false) -> void
func orthonormalize() -> void
func rotate(axis: Vector3, angle: float) -> void
func rotate_object_local(axis: Vector3, angle: float) -> void
func rotate_x(angle: float) -> void
func rotate_y(angle: float) -> void
func rotate_z(angle: float) -> void
func scale_object_local(scale: Vector3) -> void
func set_disable_scale(disable: bool) -> void
func set_identity() -> void
func set_notify_local_transform(enable: bool) -> void
func set_notify_transform(enable: bool) -> void
func set_subgizmo_selection(gizmo: Node3DGizmo, id: int, transform: Transform3D) -> void
func show() -> void
func to_global(local_point: Vector3) -> Vector3
func to_local(global_point: Vector3) -> Vector3
func translate(offset: Vector3) -> void
func translate_object_local(offset: Vector3) -> void
func update_gizmos() -> void
Inherited from Node (106)
func _enter_tree() -> void
func _exit_tree() -> void
func _input(event: InputEvent) -> void
func _physics_process(delta: float) -> void
func _process(delta: float) -> void
func _ready() -> void
func _shortcut_input(event: InputEvent) -> void
func _unhandled_input(event: InputEvent) -> void
func _unhandled_key_input(event: InputEvent) -> void
func add_child(node: Node, force_readable_name: bool = false, internal: Node.InternalMode = 0) -> void
func add_sibling(sibling: Node, force_readable_name: bool = false) -> void
func add_to_group(group: StringName, persistent: bool = false) -> void
func atr(message: String, context: StringName = "") -> String
func atr_n(message: String, plural_message: StringName, n: int, context: StringName = "") -> String
func can_process() -> bool
func duplicate(flags: int = 15) -> Node
func find_child(pattern: String, recursive: bool = true, owned: bool = true) -> Node
func find_children(pattern: String, type: String = "", recursive: bool = true, owned: bool = true) -> Node[]
func find_parent(pattern: String) -> Node
func get_child(idx: int, include_internal: bool = false) -> Node
func get_child_count(include_internal: bool = false) -> int
func get_children(include_internal: bool = false) -> Node[]
func get_groups() -> StringName[]
func get_index(include_internal: bool = false) -> int
func get_node(path: NodePath) -> Node
func get_orphan_node_ids() -> int[]
func get_parent() -> Node
func get_path() -> NodePath
func get_path_to(node: Node, use_unique_path: bool = false) -> NodePath
func get_window() -> Window
func has_node(path: NodePath) -> bool
func is_ancestor_of(node: Node) -> bool
func is_greater_than(node: Node) -> bool
func is_in_group(group: StringName) -> bool
func move_child(child_node: Node, to_index: int) -> void
func notify_deferred_thread_group(what: int) -> void
func notify_thread_safe(what: int) -> void
func print_orphan_nodes() -> void
func print_tree() -> void
func print_tree_pretty() -> void
func propagate_call(method: StringName, args: Array = [], parent_first: bool = false) -> void
func propagate_notification(what: int) -> void
func queue_free() -> void
func remove_child(node: Node) -> void
func remove_from_group(group: StringName) -> void
func reparent(new_parent: Node, keep_global_transform: bool = true) -> void
func replace_by(node: Node, keep_groups: bool = false) -> void
func request_ready() -> void
func rpc(method: StringName) -> Error
func rpc_config(method: StringName, config: Variant) -> void
func rpc_id(peer_id: int, method: StringName) -> Error
func set_deferred_thread_group(property: StringName, value: Variant) -> void
func set_display_folded(fold: bool) -> void
func set_editable_instance(node: Node, is_editable: bool) -> void
func set_multiplayer_authority(id: int, recursive: bool = true) -> void
func set_physics_process(enable: bool) -> void
func set_physics_process_internal(enable: bool) -> void
func set_process(enable: bool) -> void
func set_process_input(enable: bool) -> void
func set_process_internal(enable: bool) -> void
func set_process_shortcut_input(enable: bool) -> void
func set_process_unhandled_input(enable: bool) -> void
func set_scene_instance_load_placeholder(load_placeholder: bool) -> void
func set_thread_safe(property: StringName, value: Variant) -> void
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Node3D (1)
Inherited from Node (11)
signal child_entered_tree(node: Node)
signal child_exiting_tree(node: Node)
signal ready()
signal renamed()
signal replacing_by(node: Node)
signal tree_entered()
signal tree_exited()
signal tree_exiting()
Inherited from Object (2)

Enums & Constants

enum Param
PARAM_LINEAR_LOWER_LIMIT = 0

The minimum difference between the pivot points' axes.

PARAM_LINEAR_UPPER_LIMIT = 1

The maximum difference between the pivot points' axes.

PARAM_LINEAR_LIMIT_SOFTNESS = 2

A factor applied to the movement across the axes. The lower, the slower the movement.

PARAM_LINEAR_RESTITUTION = 3

The amount of restitution on the axes' movement. The lower, the more momentum gets lost.

PARAM_LINEAR_DAMPING = 4

The amount of damping that happens at the linear motion across the axes.

PARAM_LINEAR_MOTOR_TARGET_VELOCITY = 5

The velocity the linear motor will try to reach.

PARAM_LINEAR_MOTOR_FORCE_LIMIT = 6

The maximum force the linear motor will apply while trying to reach the velocity target.

PARAM_LINEAR_SPRING_STIFFNESS = 7
PARAM_LINEAR_SPRING_DAMPING = 8
PARAM_LINEAR_SPRING_EQUILIBRIUM_POINT = 9
PARAM_ANGULAR_LOWER_LIMIT = 10

The minimum rotation in negative direction to break loose and rotate around the axes.

PARAM_ANGULAR_UPPER_LIMIT = 11

The minimum rotation in positive direction to break loose and rotate around the axes.

PARAM_ANGULAR_LIMIT_SOFTNESS = 12

The speed of all rotations across the axes.

PARAM_ANGULAR_DAMPING = 13

The amount of rotational damping across the axes. The lower, the more damping occurs.

PARAM_ANGULAR_RESTITUTION = 14

The amount of rotational restitution across the axes. The lower, the more restitution occurs.

PARAM_ANGULAR_FORCE_LIMIT = 15

The maximum amount of force that can occur, when rotating around the axes.

PARAM_ANGULAR_ERP = 16

When rotating across the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower.

PARAM_ANGULAR_MOTOR_TARGET_VELOCITY = 17

Target speed for the motor at the axes.

PARAM_ANGULAR_MOTOR_FORCE_LIMIT = 18

Maximum acceleration for the motor at the axes.

PARAM_ANGULAR_SPRING_STIFFNESS = 19
PARAM_ANGULAR_SPRING_DAMPING = 20
PARAM_ANGULAR_SPRING_EQUILIBRIUM_POINT = 21
PARAM_MAX = 22

Represents the size of the Param enum.

enum Flag
FLAG_ENABLE_LINEAR_LIMIT = 0

If enabled, linear motion is possible within the given limits.

FLAG_ENABLE_ANGULAR_LIMIT = 1

If enabled, rotational motion is possible within the given limits.

FLAG_ENABLE_LINEAR_SPRING = 3
FLAG_ENABLE_ANGULAR_SPRING = 2
FLAG_ENABLE_MOTOR = 4

If enabled, there is a rotational motor across these axes.

FLAG_ENABLE_LINEAR_MOTOR = 5

If enabled, there is a linear motor across these axes.

FLAG_MAX = 6

Represents the size of the Flag enum.