Documentation
¶
Overview ¶
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.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type 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 Param) Float.X
- func (self Instance) ID() ID
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetParam(param Param, value Float.X)
- func (self Instance) Virtual(name string) reflect.Value
- type Param
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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 Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsSliderJoint3D ¶
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
type Instance [1]gdclass.SliderJoint3D
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsSliderJoint3D ¶
type Param ¶
type Param int //gd:SliderJoint3D.Param
const ( // Constant for accessing "linear_limit/upper_distance". The maximum difference between the pivot points on their X axis before damping happens. ParamLinearLimitUpper Param = 0 // Constant for accessing "linear_limit/lower_distance". The minimum difference between the pivot points on their X axis before damping happens. ParamLinearLimitLower Param = 1 // 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. ParamLinearLimitSoftness Param = 2 // Constant for accessing "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 "linear_limit/damping". The amount of damping once the slider limits are surpassed. ParamLinearLimitDamping Param = 4 // 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. ParamLinearMotionSoftness Param = 5 // Constant for accessing "linear_motion/restitution". The amount of restitution inside the slider limits. ParamLinearMotionRestitution Param = 6 // Constant for accessing "linear_motion/damping". The amount of damping inside the slider limits. ParamLinearMotionDamping Param = 7 // Constant for accessing "linear_ortho/softness". A factor applied to the movement across axes orthogonal to the slider. ParamLinearOrthogonalSoftness Param = 8 // Constant for accessing "linear_motion/restitution". The amount of restitution when movement is across axes orthogonal to the slider. ParamLinearOrthogonalRestitution Param = 9 // Constant for accessing "linear_motion/damping". The amount of damping when movement is across axes orthogonal to the slider. ParamLinearOrthogonalDamping Param = 10 // Constant for accessing "angular_limit/upper_angle". The upper limit of rotation in the slider. ParamAngularLimitUpper Param = 11 // Constant for accessing "angular_limit/lower_angle". The lower limit of rotation in the slider. ParamAngularLimitLower Param = 12 // Constant for accessing "angular_limit/softness". A factor applied to the all rotation once the limit is surpassed. ParamAngularLimitSoftness Param = 13 // Constant for accessing "angular_limit/restitution". The amount of restitution of the rotation when the limit is surpassed. ParamAngularLimitRestitution Param = 14 // Constant for accessing "angular_limit/damping". The amount of damping of the rotation when the limit is surpassed. ParamAngularLimitDamping Param = 15 // Constant for accessing "angular_motion/softness". A factor applied to the all rotation in the limits. ParamAngularMotionSoftness Param = 16 // Constant for accessing "angular_motion/restitution". The amount of restitution of the rotation in the limits. ParamAngularMotionRestitution Param = 17 // Constant for accessing "angular_motion/damping". The amount of damping of the rotation in the limits. ParamAngularMotionDamping Param = 18 // Constant for accessing "angular_ortho/softness". A factor applied to the all rotation across axes orthogonal to the slider. ParamAngularOrthogonalSoftness Param = 19 // Constant for accessing "angular_ortho/restitution". The amount of restitution of the rotation across axes orthogonal to the slider. ParamAngularOrthogonalRestitution Param = 20 // Constant for accessing "angular_ortho/damping". The amount of damping of the rotation across axes orthogonal to the slider. ParamAngularOrthogonalDamping Param = 21 // Represents the size of the [Param] enum. ParamMax Param = 22 )
Source Files
Click to show internal directories.
Click to hide internal directories.