SliderJoint3D

Documentation

Overview

Package SliderJoint3D provides methods for working with SliderJoint3D object instances.

Index

• type Advanced
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AsJoint3D() Joint3D.Instance
  • func (self Instance) AsNode() Node.Instance
  • func (self Instance) AsNode3D() Node3D.Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsSliderJoint3D() Instance
  • func (self Instance) GetParam(param gdclass.SliderJoint3DParam) Float.X
  • func (self Instance) SetParam(param gdclass.SliderJoint3DParam, value Float.X)
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value
• type Param

Types

type Advanced

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any

type Any interface {
	gd.IsClass
	AsSliderJoint3D() Instance
}

type Instance

type Instance [1]gdclass.SliderJoint3D

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.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AsJoint3D

func (self Instance) AsJoint3D() Joint3D.Instance

func (Instance) AsNode

func (self Instance) AsNode() Node.Instance

func (Instance) AsNode3D

func (self Instance) AsNode3D() Node3D.Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsSliderJoint3D

func (self Instance) AsSliderJoint3D() Instance

func (Instance) GetParam

func (self Instance) GetParam(param gdclass.SliderJoint3DParam) Float.X

Returns the value of the given parameter (see [enum Param] constants).

func (Instance) SetParam

func (self Instance) SetParam(param gdclass.SliderJoint3DParam, value Float.X)

Assigns [param value] to the given parameter (see [enum Param] constants).

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value

type Param

type Param = gdclass.SliderJoint3DParam //gd:SliderJoint3D.Param

const (
	/*Constant for accessing [member linear_limit/upper_distance]. The maximum difference between the pivot points on their X axis before damping happens.*/
	ParamLinearLimitUpper Param = 0
	/*Constant for accessing [member linear_limit/lower_distance]. The minimum difference between the pivot points on their X axis before damping happens.*/
	ParamLinearLimitLower Param = 1
	/*Constant for accessing [member linear_limit/softness]. A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement.*/
	ParamLinearLimitSoftness Param = 2
	/*Constant for accessing [member linear_limit/restitution]. The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost.*/
	ParamLinearLimitRestitution Param = 3
	/*Constant for accessing [member linear_limit/damping]. The amount of damping once the slider limits are surpassed.*/
	ParamLinearLimitDamping Param = 4
	/*Constant for accessing [member 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.*/
	ParamLinearMotionSoftness Param = 5
	/*Constant for accessing [member linear_motion/restitution]. The amount of restitution inside the slider limits.*/
	ParamLinearMotionRestitution Param = 6
	/*Constant for accessing [member linear_motion/damping]. The amount of damping inside the slider limits.*/
	ParamLinearMotionDamping Param = 7
	/*Constant for accessing [member linear_ortho/softness]. A factor applied to the movement across axes orthogonal to the slider.*/
	ParamLinearOrthogonalSoftness Param = 8
	/*Constant for accessing [member linear_motion/restitution]. The amount of restitution when movement is across axes orthogonal to the slider.*/
	ParamLinearOrthogonalRestitution Param = 9
	/*Constant for accessing [member linear_motion/damping]. The amount of damping when movement is across axes orthogonal to the slider.*/
	ParamLinearOrthogonalDamping Param = 10
	/*Constant for accessing [member angular_limit/upper_angle]. The upper limit of rotation in the slider.*/
	ParamAngularLimitUpper Param = 11
	/*Constant for accessing [member angular_limit/lower_angle]. The lower limit of rotation in the slider.*/
	ParamAngularLimitLower Param = 12
	/*Constant for accessing [member angular_limit/softness]. A factor applied to the all rotation once the limit is surpassed.*/
	ParamAngularLimitSoftness Param = 13
	/*Constant for accessing [member angular_limit/restitution]. The amount of restitution of the rotation when the limit is surpassed.*/
	ParamAngularLimitRestitution Param = 14
	/*Constant for accessing [member angular_limit/damping]. The amount of damping of the rotation when the limit is surpassed.*/
	ParamAngularLimitDamping Param = 15
	/*Constant for accessing [member angular_motion/softness]. A factor applied to the all rotation in the limits.*/
	ParamAngularMotionSoftness Param = 16
	/*Constant for accessing [member angular_motion/restitution]. The amount of restitution of the rotation in the limits.*/
	ParamAngularMotionRestitution Param = 17
	/*Constant for accessing [member angular_motion/damping]. The amount of damping of the rotation in the limits.*/
	ParamAngularMotionDamping Param = 18
	/*Constant for accessing [member angular_ortho/softness]. A factor applied to the all rotation across axes orthogonal to the slider.*/
	ParamAngularOrthogonalSoftness Param = 19
	/*Constant for accessing [member angular_ortho/restitution]. The amount of restitution of the rotation across axes orthogonal to the slider.*/
	ParamAngularOrthogonalRestitution Param = 20
	/*Constant for accessing [member angular_ortho/damping]. The amount of damping of the rotation across axes orthogonal to the slider.*/
	ParamAngularOrthogonalDamping Param = 21
	/*Represents the size of the [enum Param] enum.*/
	ParamMax Param = 22
)