Documentation
¶
Overview ¶
Abstract base class for all joints in 3D physics. 3D joints bind together two physics bodies (NodeA and NodeB) and apply a constraint. If only one body is defined, it is attached to a fixed StaticBody3D without collision shapes.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AsJoint3D() Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsNode3D() Node3D.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) ExcludeNodesFromCollision() bool
- func (self Instance) GetRid() RID.Joint3D
- func (self Instance) ID() ID
- func (self Instance) NodeA() string
- func (self Instance) NodeB() string
- func (self Instance) SetExcludeNodesFromCollision(value bool)
- func (self Instance) SetNodeA(value string)
- func (self Instance) SetNodeB(value string)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetSolverPriority(value int)
- func (self Instance) SolverPriority() int
- func (self Instance) Virtual(name string) reflect.Value
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
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 ¶
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) ExcludeNodesFromCollision ¶
If true, the two bodies bound together do not collide with each other.
func (Instance) GetRid ¶
Returns the joint's internal Resource.ID from the PhysicsServer3D.
func (Instance) NodeA ¶
Path to the first node (A) attached to the joint. The node must inherit PhysicsBody3D.
If left empty and NodeB is set, the body is attached to a fixed StaticBody3D without collision shapes.
func (Instance) NodeB ¶
Path to the second node (B) attached to the joint. The node must inherit PhysicsBody3D.
If left empty and NodeA is set, the body is attached to a fixed StaticBody3D without collision shapes.
func (Instance) SetExcludeNodesFromCollision ¶
SetExcludeNodesFromCollision sets the property returned by [GetExcludeNodesFromCollision].
func (Instance) SetSolverPriority ¶
SetSolverPriority sets the property returned by [GetSolverPriority].
func (Instance) SolverPriority ¶
The priority used to define which solver is executed first for multiple joints. The lower the value, the higher the priority.
Source Files