Documentation
¶
Overview ¶
A physics joint that attaches two 2D physics bodies at a single point, allowing them to freely rotate. For example, a RigidBody2D can be attached to a StaticBody2D to create a pendulum or a seesaw.
Index ¶
- type Advanced
- type Any
- type Extension
- func (self *Extension[T]) AsCanvasItem() CanvasItem.Instance
- func (self *Extension[T]) AsJoint2D() Joint2D.Instance
- func (self *Extension[T]) AsNode() Node.Instance
- func (self *Extension[T]) AsNode2D() Node2D.Instance
- func (self *Extension[T]) AsObject() [1]gd.Object
- func (self *Extension[T]) AsPinJoint2D() Instance
- type ID
- type Instance
- func (self Instance) AngularLimitEnabled() bool
- func (self Instance) AngularLimitLower() Float.X
- func (self Instance) AngularLimitUpper() Float.X
- func (self Instance) AsCanvasItem() CanvasItem.Instance
- func (self Instance) AsJoint2D() Joint2D.Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsNode2D() Node2D.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsPinJoint2D() Instance
- func (self Instance) ID() ID
- func (self Instance) MotorEnabled() bool
- func (self Instance) MotorTargetVelocity() Float.X
- func (self Instance) SetAngularLimitEnabled(value bool)
- func (self Instance) SetAngularLimitLower(value Float.X)
- func (self Instance) SetAngularLimitUpper(value Float.X)
- func (self Instance) SetMotorEnabled(value bool)
- func (self Instance) SetMotorTargetVelocity(value Float.X)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetSoftness(value Float.X)
- func (self Instance) Softness() Float.X
- 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
func (*Extension[T]) AsCanvasItem ¶
func (self *Extension[T]) AsCanvasItem() CanvasItem.Instance
func (*Extension[T]) AsPinJoint2D ¶
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.PinJoint2D
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) AngularLimitEnabled ¶
If true, the pin maximum and minimum rotation, defined by AngularLimitLower and AngularLimitUpper are applied.
func (Instance) AngularLimitLower ¶
The minimum rotation. Only active if AngularLimitEnabled is true.
func (Instance) AngularLimitUpper ¶
The maximum rotation. Only active if AngularLimitEnabled is true.
func (Instance) AsCanvasItem ¶
func (self Instance) AsCanvasItem() CanvasItem.Instance
func (Instance) AsPinJoint2D ¶
func (Instance) MotorEnabled ¶
When activated, a motor turns the pin.
func (Instance) MotorTargetVelocity ¶
Target speed for the motor. In radians per second.
func (Instance) SetAngularLimitEnabled ¶
SetAngularLimitEnabled sets the property returned by [IsAngularLimitEnabled].
func (Instance) SetAngularLimitLower ¶
SetAngularLimitLower sets the property returned by [GetAngularLimitLower].
func (Instance) SetAngularLimitUpper ¶
SetAngularLimitUpper sets the property returned by [GetAngularLimitUpper].
func (Instance) SetMotorEnabled ¶
SetMotorEnabled sets the property returned by [IsMotorEnabled].
func (Instance) SetMotorTargetVelocity ¶
SetMotorTargetVelocity sets the property returned by [GetMotorTargetVelocity].
func (Instance) SetSoftness ¶
SetSoftness sets the property returned by [GetSoftness].