Index · Object → Node → Node3D → Joint3D → SliderJoint3D

SliderJoint3D

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

Class Description

A physics joint that restricts the movement of a 3D physics body along an axis relative to another physics body. For example, Body A could be a StaticBody3D representing a piston base, while Body B could be a RigidBody3D representing the piston head, moving up and down.

Properties

var angular_limit/damping: float = 0.0

The amount of damping of the rotation when the limit is surpassed.

A lower damping value allows a rotation initiated by body A to travel to body B slower.

var angular_limit/lower_angle: float = 0.0

The lower limit of rotation in the slider.

var angular_limit/restitution: float = 0.7

The amount of restitution of the rotation when the limit is surpassed.

Does not affect damping.

var angular_limit/softness: float = 1.0

A factor applied to the all rotation once the limit is surpassed.

Makes all rotation slower when between 0 and 1.

var angular_limit/upper_angle: float = 0.0

The upper limit of rotation in the slider.

var angular_motion/damping: float = 1.0

The amount of damping of the rotation in the limits.

var angular_motion/restitution: float = 0.7

The amount of restitution of the rotation in the limits.

var angular_motion/softness: float = 1.0

A factor applied to the all rotation in the limits.

var angular_ortho/damping: float = 1.0

The amount of damping of the rotation across axes orthogonal to the slider.

var angular_ortho/restitution: float = 0.7

The amount of restitution of the rotation across axes orthogonal to the slider.

var angular_ortho/softness: float = 1.0

A factor applied to the all rotation across axes orthogonal to the slider.

var linear_limit/damping: float = 1.0

The amount of damping that happens once the limit defined by linear_limit/lower_distance and linear_limit/upper_distance is surpassed.

var linear_limit/lower_distance: float = -1.0

The minimum difference between the pivot points on their X axis before damping happens.

var linear_limit/restitution: float = 0.7

The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost.

var linear_limit/softness: float = 1.0

A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement.

var linear_limit/upper_distance: float = 1.0

The maximum difference between the pivot points on their X axis before damping happens.

var linear_motion/damping: float = 0.0

The amount of damping inside the slider limits.

var linear_motion/restitution: float = 0.7

The amount of restitution inside the slider limits.

var linear_motion/softness: float = 1.0

A factor applied to the movement across the slider axis as long as the slider is in the limits. The lower, the slower the movement.

var linear_ortho/damping: float = 1.0

The amount of damping when movement is across axes orthogonal to the slider.

var linear_ortho/restitution: float = 0.7

The amount of restitution when movement is across axes orthogonal to the slider.

var linear_ortho/softness: float = 1.0

A factor applied to the movement across axes orthogonal to the slider.

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_param(param: SliderJoint3D.Param) -> float

Returns the value of the given parameter.

func set_param(param: SliderJoint3D.Param, value: float) -> void

Assigns value to the given parameter.

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_LIMIT_UPPER = 0

Constant for accessing linear_limit/upper_distance. The maximum difference between the pivot points on their X axis before damping happens.

PARAM_LINEAR_LIMIT_LOWER = 1

Constant for accessing linear_limit/lower_distance. The minimum difference between the pivot points on their X axis before damping happens.

PARAM_LINEAR_LIMIT_SOFTNESS = 2

Constant for accessing linear_limit/softness. A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement.

PARAM_LINEAR_LIMIT_RESTITUTION = 3

Constant for accessing linear_limit/restitution. The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost.

PARAM_LINEAR_LIMIT_DAMPING = 4

Constant for accessing linear_limit/damping. The amount of damping once the slider limits are surpassed.

PARAM_LINEAR_MOTION_SOFTNESS = 5

Constant for accessing linear_motion/softness. A factor applied to the movement across the slider axis as long as the slider is in the limits. The lower, the slower the movement.

PARAM_LINEAR_MOTION_RESTITUTION = 6

Constant for accessing linear_motion/restitution. The amount of restitution inside the slider limits.

PARAM_LINEAR_MOTION_DAMPING = 7

Constant for accessing linear_motion/damping. The amount of damping inside the slider limits.

PARAM_LINEAR_ORTHOGONAL_SOFTNESS = 8

Constant for accessing linear_ortho/softness. A factor applied to the movement across axes orthogonal to the slider.

PARAM_LINEAR_ORTHOGONAL_RESTITUTION = 9

Constant for accessing linear_motion/restitution. The amount of restitution when movement is across axes orthogonal to the slider.

PARAM_LINEAR_ORTHOGONAL_DAMPING = 10

Constant for accessing linear_motion/damping. The amount of damping when movement is across axes orthogonal to the slider.

PARAM_ANGULAR_LIMIT_UPPER = 11

Constant for accessing angular_limit/upper_angle. The upper limit of rotation in the slider.

PARAM_ANGULAR_LIMIT_LOWER = 12

Constant for accessing angular_limit/lower_angle. The lower limit of rotation in the slider.

PARAM_ANGULAR_LIMIT_SOFTNESS = 13

Constant for accessing angular_limit/softness. A factor applied to the all rotation once the limit is surpassed.

PARAM_ANGULAR_LIMIT_RESTITUTION = 14

Constant for accessing angular_limit/restitution. The amount of restitution of the rotation when the limit is surpassed.

PARAM_ANGULAR_LIMIT_DAMPING = 15

Constant for accessing angular_limit/damping. The amount of damping of the rotation when the limit is surpassed.

PARAM_ANGULAR_MOTION_SOFTNESS = 16

Constant for accessing angular_motion/softness. A factor applied to the all rotation in the limits.

PARAM_ANGULAR_MOTION_RESTITUTION = 17

Constant for accessing angular_motion/restitution. The amount of restitution of the rotation in the limits.

PARAM_ANGULAR_MOTION_DAMPING = 18

Constant for accessing angular_motion/damping. The amount of damping of the rotation in the limits.

PARAM_ANGULAR_ORTHOGONAL_SOFTNESS = 19

Constant for accessing angular_ortho/softness. A factor applied to the all rotation across axes orthogonal to the slider.

PARAM_ANGULAR_ORTHOGONAL_RESTITUTION = 20

Constant for accessing angular_ortho/restitution. The amount of restitution of the rotation across axes orthogonal to the slider.

PARAM_ANGULAR_ORTHOGONAL_DAMPING = 21

Constant for accessing angular_ortho/damping. The amount of damping of the rotation across axes orthogonal to the slider.

PARAM_MAX = 22

Represents the size of the Param enum.