HingeJoint3D

Documentation

Overview

Package HingeJoint3D provides methods for working with HingeJoint3D object instances.

Index

• type Advanced
• type Any
• type Flag
• type Instance
  • func New() Instance
  • func (self Instance) AsHingeJoint3D() 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) GetFlag(flag gdclass.HingeJoint3DFlag) bool
  • func (self Instance) GetParam(param gdclass.HingeJoint3DParam) Float.X
  • func (self Instance) SetFlag(flag gdclass.HingeJoint3DFlag, enabled bool)
  • func (self Instance) SetParam(param gdclass.HingeJoint3DParam, 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
	AsHingeJoint3D() Instance
}

type Flag

type Flag = gdclass.HingeJoint3DFlag //gd:HingeJoint3D.Flag

const (
	/*If [code]true[/code], the hinges maximum and minimum rotation, defined by [member angular_limit/lower] and [member angular_limit/upper] has effects.*/
	FlagUseLimit Flag = 0
	/*When activated, a motor turns the hinge.*/
	FlagEnableMotor Flag = 1
	/*Represents the size of the [enum Flag] enum.*/
	FlagMax Flag = 2
)

type Instance

type Instance [1]gdclass.HingeJoint3D

A physics joint that restricts the rotation of a 3D physics body around an axis relative to another physics body. For example, Body A can be a [StaticBody3D] representing a door hinge that a [RigidBody3D] rotates around.

var Nil Instance

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

func New

func New() Instance

func (Instance) AsHingeJoint3D

func (self Instance) AsHingeJoint3D() 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) GetFlag

func (self Instance) GetFlag(flag gdclass.HingeJoint3DFlag) bool

Returns the value of the specified flag.

func (Instance) GetParam

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

Returns the value of the specified parameter.

func (Instance) SetFlag

func (self Instance) SetFlag(flag gdclass.HingeJoint3DFlag, enabled bool)

If [code]true[/code], enables the specified flag.

func (Instance) SetParam

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

Sets the value of the specified parameter.

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.HingeJoint3DParam //gd:HingeJoint3D.Param

const (
	/*The speed with which the two bodies get pulled together when they move in different directions.*/
	ParamBias Param = 0
	/*The maximum rotation. Only active if [member angular_limit/enable] is [code]true[/code].*/
	ParamLimitUpper Param = 1
	/*The minimum rotation. Only active if [member angular_limit/enable] is [code]true[/code].*/
	ParamLimitLower Param = 2
	/*The speed with which the rotation across the axis perpendicular to the hinge gets corrected.*/
	ParamLimitBias     Param = 3
	ParamLimitSoftness Param = 4
	/*The lower this value, the more the rotation gets slowed down.*/
	ParamLimitRelaxation Param = 5
	/*Target speed for the motor.*/
	ParamMotorTargetVelocity Param = 6
	/*Maximum acceleration for the motor.*/
	ParamMotorMaxImpulse Param = 7
	/*Represents the size of the [enum Param] enum.*/
	ParamMax Param = 8
)