PinJoint2D

package
v0.0.0-...-20ed0ac Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 19, 2025 License: MIT Imports: 27 Imported by: 0

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

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 Any

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

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

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]) AsJoint2D

func (self *Extension[T]) AsJoint2D() Joint2D.Instance

func (*Extension[T]) AsNode

func (self *Extension[T]) AsNode() Node.Instance

func (*Extension[T]) AsNode2D

func (self *Extension[T]) AsNode2D() Node2D.Instance

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsPinJoint2D

func (self *Extension[T]) AsPinJoint2D() Instance

type ID

type ID Object.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.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

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 New

func New() Instance

func (Instance) AngularLimitEnabled

func (self Instance) AngularLimitEnabled() bool

If true, the pin maximum and minimum rotation, defined by AngularLimitLower and AngularLimitUpper are applied.

func (Instance) AngularLimitLower

func (self Instance) AngularLimitLower() Float.X

The minimum rotation. Only active if AngularLimitEnabled is true.

func (Instance) AngularLimitUpper

func (self Instance) AngularLimitUpper() Float.X

The maximum rotation. Only active if AngularLimitEnabled is true.

func (Instance) AsCanvasItem

func (self Instance) AsCanvasItem() CanvasItem.Instance

func (Instance) AsJoint2D

func (self Instance) AsJoint2D() Joint2D.Instance

func (Instance) AsNode

func (self Instance) AsNode() Node.Instance

func (Instance) AsNode2D

func (self Instance) AsNode2D() Node2D.Instance

func (Instance) AsObject

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

func (Instance) AsPinJoint2D

func (self Instance) AsPinJoint2D() Instance

func (Instance) ID

func (self Instance) ID() ID

func (Instance) MotorEnabled

func (self Instance) MotorEnabled() bool

When activated, a motor turns the pin.

func (Instance) MotorTargetVelocity

func (self Instance) MotorTargetVelocity() Float.X

Target speed for the motor. In radians per second.

func (Instance) SetAngularLimitEnabled

func (self Instance) SetAngularLimitEnabled(value bool)

SetAngularLimitEnabled sets the property returned by [IsAngularLimitEnabled].

func (Instance) SetAngularLimitLower

func (self Instance) SetAngularLimitLower(value Float.X)

SetAngularLimitLower sets the property returned by [GetAngularLimitLower].

func (Instance) SetAngularLimitUpper

func (self Instance) SetAngularLimitUpper(value Float.X)

SetAngularLimitUpper sets the property returned by [GetAngularLimitUpper].

func (Instance) SetMotorEnabled

func (self Instance) SetMotorEnabled(value bool)

SetMotorEnabled sets the property returned by [IsMotorEnabled].

func (Instance) SetMotorTargetVelocity

func (self Instance) SetMotorTargetVelocity(value Float.X)

SetMotorTargetVelocity sets the property returned by [GetMotorTargetVelocity].

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) SetSoftness

func (self Instance) SetSoftness(value Float.X)

SetSoftness sets the property returned by [GetSoftness].

func (Instance) Softness

func (self Instance) Softness() Float.X

The higher this value, the more the bond to the pinned partner can flex.

func (Instance) Virtual

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL