Table of Contents

Class Generic6DOFJoint3D

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

Inheritance
Generic6DOFJoint3D

Remarks

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

angular_limit_x/damping

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/damping : float = 1.0

Property Value

float

Remarks

angular_limit_x/enabled

If true, rotation across the X axis is limited.

var angular_limit_x/enabled : bool = true

Property Value

bool

Remarks

angular_limit_x/erp

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/erp : float = 0.5

Property Value

float

Remarks

angular_limit_x/force_limit

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

var angular_limit_x/force_limit : float = 0.0

Property Value

float

Remarks

angular_limit_x/lower_angle

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

var angular_limit_x/lower_angle : float = 0.0

Property Value

float

Remarks

angular_limit_x/restitution

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

var angular_limit_x/restitution : float = 0.0

Property Value

float

Remarks

angular_limit_x/softness

The speed of all rotations across the X axis.

var angular_limit_x/softness : float = 0.5

Property Value

float

Remarks

angular_limit_x/upper_angle

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

var angular_limit_x/upper_angle : float = 0.0

Property Value

float

Remarks

angular_limit_y/damping

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

var angular_limit_y/damping : float = 1.0

Property Value

float

Remarks

angular_limit_y/enabled

If true, rotation across the Y axis is limited.

var angular_limit_y/enabled : bool = true

Property Value

bool

Remarks

angular_limit_y/erp

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/erp : float = 0.5

Property Value

float

Remarks

angular_limit_y/force_limit

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

var angular_limit_y/force_limit : float = 0.0

Property Value

float

Remarks

angular_limit_y/lower_angle

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

var angular_limit_y/lower_angle : float = 0.0

Property Value

float

Remarks

angular_limit_y/restitution

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

var angular_limit_y/restitution : float = 0.0

Property Value

float

Remarks

angular_limit_y/softness

The speed of all rotations across the Y axis.

var angular_limit_y/softness : float = 0.5

Property Value

float

Remarks

angular_limit_y/upper_angle

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

var angular_limit_y/upper_angle : float = 0.0

Property Value

float

Remarks

angular_limit_z/damping

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

var angular_limit_z/damping : float = 1.0

Property Value

float

Remarks

angular_limit_z/enabled

If true, rotation across the Z axis is limited.

var angular_limit_z/enabled : bool = true

Property Value

bool

Remarks

angular_limit_z/erp

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/erp : float = 0.5

Property Value

float

Remarks

angular_limit_z/force_limit

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

var angular_limit_z/force_limit : float = 0.0

Property Value

float

Remarks

angular_limit_z/lower_angle

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

var angular_limit_z/lower_angle : float = 0.0

Property Value

float

Remarks

angular_limit_z/restitution

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

var angular_limit_z/restitution : float = 0.0

Property Value

float

Remarks

angular_limit_z/softness

The speed of all rotations across the Z axis.

var angular_limit_z/softness : float = 0.5

Property Value

float

Remarks

angular_limit_z/upper_angle

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

var angular_limit_z/upper_angle : float = 0.0

Property Value

float

Remarks

angular_motor_x/enabled

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

var angular_motor_x/enabled : bool = false

Property Value

bool

Remarks

angular_motor_x/force_limit

Maximum acceleration for the motor at the X axis.

var angular_motor_x/force_limit : float = 300.0

Property Value

float

Remarks

angular_motor_x/target_velocity

Target speed for the motor at the X axis.

var angular_motor_x/target_velocity : float = 0.0

Property Value

float

Remarks

angular_motor_y/enabled

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

var angular_motor_y/enabled : bool = false

Property Value

bool

Remarks

angular_motor_y/force_limit

Maximum acceleration for the motor at the Y axis.

var angular_motor_y/force_limit : float = 300.0

Property Value

float

Remarks

angular_motor_y/target_velocity

Target speed for the motor at the Y axis.

var angular_motor_y/target_velocity : float = 0.0

Property Value

float

Remarks

angular_motor_z/enabled

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

var angular_motor_z/enabled : bool = false

Property Value

bool

Remarks

angular_motor_z/force_limit

Maximum acceleration for the motor at the Z axis.

var angular_motor_z/force_limit : float = 300.0

Property Value

float

Remarks

angular_motor_z/target_velocity

Target speed for the motor at the Z axis.

var angular_motor_z/target_velocity : float = 0.0

Property Value

float

Remarks

angular_spring_x/damping 

var angular_spring_x/damping : float = 0.0

Property Value

float

Remarks

angular_spring_x/enabled 

var angular_spring_x/enabled : bool = false

Property Value

bool

Remarks

angular_spring_x/equilibrium_point 

var angular_spring_x/equilibrium_point : float = 0.0

Property Value

float

Remarks

angular_spring_x/stiffness 

var angular_spring_x/stiffness : float = 0.0

Property Value

float

Remarks

angular_spring_y/damping 

var angular_spring_y/damping : float = 0.0

Property Value

float

Remarks

angular_spring_y/enabled 

var angular_spring_y/enabled : bool = false

Property Value

bool

Remarks

angular_spring_y/equilibrium_point 

var angular_spring_y/equilibrium_point : float = 0.0

Property Value

float

Remarks

angular_spring_y/stiffness 

var angular_spring_y/stiffness : float = 0.0

Property Value

float

Remarks

angular_spring_z/damping 

var angular_spring_z/damping : float = 0.0

Property Value

float

Remarks

angular_spring_z/enabled 

var angular_spring_z/enabled : bool = false

Property Value

bool

Remarks

angular_spring_z/equilibrium_point 

var angular_spring_z/equilibrium_point : float = 0.0

Property Value

float

Remarks

angular_spring_z/stiffness 

var angular_spring_z/stiffness : float = 0.0

Property Value

float

Remarks

linear_limit_x/damping

The amount of damping that happens at the X motion.

var linear_limit_x/damping : float = 1.0

Property Value

float

Remarks

linear_limit_x/enabled

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

var linear_limit_x/enabled : bool = true

Property Value

bool

Remarks

linear_limit_x/lower_distance

The minimum difference between the pivot points' X axis.

var linear_limit_x/lower_distance : float = 0.0

Property Value

float

Remarks

linear_limit_x/restitution

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

var linear_limit_x/restitution : float = 0.5

Property Value

float

Remarks

linear_limit_x/softness

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

var linear_limit_x/softness : float = 0.7

Property Value

float

Remarks

linear_limit_x/upper_distance

The maximum difference between the pivot points' X axis.

var linear_limit_x/upper_distance : float = 0.0

Property Value

float

Remarks

linear_limit_y/damping

The amount of damping that happens at the Y motion.

var linear_limit_y/damping : float = 1.0

Property Value

float

Remarks

linear_limit_y/enabled

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

var linear_limit_y/enabled : bool = true

Property Value

bool

Remarks

linear_limit_y/lower_distance

The minimum difference between the pivot points' Y axis.

var linear_limit_y/lower_distance : float = 0.0

Property Value

float

Remarks

linear_limit_y/restitution

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

var linear_limit_y/restitution : float = 0.5

Property Value

float

Remarks

linear_limit_y/softness

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

var linear_limit_y/softness : float = 0.7

Property Value

float

Remarks

linear_limit_y/upper_distance

The maximum difference between the pivot points' Y axis.

var linear_limit_y/upper_distance : float = 0.0

Property Value

float

Remarks

linear_limit_z/damping

The amount of damping that happens at the Z motion.

var linear_limit_z/damping : float = 1.0

Property Value

float

Remarks

linear_limit_z/enabled

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

var linear_limit_z/enabled : bool = true

Property Value

bool

Remarks

linear_limit_z/lower_distance

The minimum difference between the pivot points' Z axis.

var linear_limit_z/lower_distance : float = 0.0

Property Value

float

Remarks

linear_limit_z/restitution

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

var linear_limit_z/restitution : float = 0.5

Property Value

float

Remarks

linear_limit_z/softness

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

var linear_limit_z/softness : float = 0.7

Property Value

float

Remarks

linear_limit_z/upper_distance

The maximum difference between the pivot points' Z axis.

var linear_limit_z/upper_distance : float = 0.0

Property Value

float

Remarks

linear_motor_x/enabled

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/enabled : bool = false

Property Value

bool

Remarks

linear_motor_x/force_limit

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

var linear_motor_x/force_limit : float = 0.0

Property Value

float

Remarks

linear_motor_x/target_velocity

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

var linear_motor_x/target_velocity : float = 0.0

Property Value

float

Remarks

linear_motor_y/enabled

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/enabled : bool = false

Property Value

bool

Remarks

linear_motor_y/force_limit

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

var linear_motor_y/force_limit : float = 0.0

Property Value

float

Remarks

linear_motor_y/target_velocity

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

var linear_motor_y/target_velocity : float = 0.0

Property Value

float

Remarks

linear_motor_z/enabled

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/enabled : bool = false

Property Value

bool

Remarks

linear_motor_z/force_limit

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

var linear_motor_z/force_limit : float = 0.0

Property Value

float

Remarks

linear_motor_z/target_velocity

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

var linear_motor_z/target_velocity : float = 0.0

Property Value

float

Remarks

linear_spring_x/damping 

var linear_spring_x/damping : float = 0.01

Property Value

float

Remarks

linear_spring_x/enabled 

var linear_spring_x/enabled : bool = false

Property Value

bool

Remarks

linear_spring_x/equilibrium_point 

var linear_spring_x/equilibrium_point : float = 0.0

Property Value

float

Remarks

linear_spring_x/stiffness 

var linear_spring_x/stiffness : float = 0.01

Property Value

float

Remarks

linear_spring_y/damping 

var linear_spring_y/damping : float = 0.01

Property Value

float

Remarks

linear_spring_y/enabled 

var linear_spring_y/enabled : bool = false

Property Value

bool

Remarks

linear_spring_y/equilibrium_point 

var linear_spring_y/equilibrium_point : float = 0.0

Property Value

float

Remarks

linear_spring_y/stiffness 

var linear_spring_y/stiffness : float = 0.01

Property Value

float

Remarks

linear_spring_z/damping 

var linear_spring_z/damping : float = 0.01

Property Value

float

Remarks

linear_spring_z/enabled 

var linear_spring_z/enabled : bool = false

Property Value

bool

Remarks

linear_spring_z/equilibrium_point 

var linear_spring_z/equilibrium_point : float = 0.0

Property Value

float

Remarks

linear_spring_z/stiffness 

var linear_spring_z/stiffness : float = 0.01

Property Value

float

Remarks

Methods

get_flag_x(int)

Qualifiers: const

bool get_flag_x(int flag)

Parameters

flag int

get_flag_y(int)

Qualifiers: const

bool get_flag_y(int flag)

Parameters

flag int

get_flag_z(int)

Qualifiers: const

bool get_flag_z(int flag)

Parameters

flag int

get_param_x(int)

Qualifiers: const

float get_param_x(int param)

Parameters

param int

get_param_y(int)

Qualifiers: const

float get_param_y(int param)

Parameters

param int

get_param_z(int)

Qualifiers: const

float get_param_z(int param)

Parameters

param int

set_flag_x(int, bool) 

void set_flag_x(int flag, bool value)

Parameters

flag int
value bool

set_flag_y(int, bool) 

void set_flag_y(int flag, bool value)

Parameters

flag int
value bool

set_flag_z(int, bool) 

void set_flag_z(int flag, bool value)

Parameters

flag int
value bool

set_param_x(int, float) 

void set_param_x(int param, float value)

Parameters

param int
value float

set_param_y(int, float) 

void set_param_y(int param, float value)

Parameters

param int
value float

set_param_z(int, float) 

void set_param_z(int param, float value)

Parameters

param int
value float