SpringArm3D

Documentation

Overview

Package SpringArm3D provides methods for working with SpringArm3D object instances.

Index

• type Advanced
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AddExcludedObject(rid RID.Body3D)
  • func (self Instance) AsNode() Node.Instance
  • func (self Instance) AsNode3D() Node3D.Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsSpringArm3D() Instance
  • func (self Instance) ClearExcludedObjects()
  • func (self Instance) CollisionMask() int
  • func (self Instance) GetHitLength() Float.X
  • func (self Instance) Margin() Float.X
  • func (self Instance) RemoveExcludedObject(rid RID.Body3D) bool
  • func (self Instance) SetCollisionMask(value int)
  • func (self Instance) SetMargin(value Float.X)
  • func (self Instance) SetShape(value [1]gdclass.Shape3D)
  • func (self Instance) SetSpringLength(value Float.X)
  • func (self Instance) Shape() [1]gdclass.Shape3D
  • func (self Instance) SpringLength() Float.X
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value

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
	AsSpringArm3D() Instance
}

type Instance

type Instance [1]gdclass.SpringArm3D

[SpringArm3D] casts a ray or a shape along its Z axis and moves all its direct children to the collision point, with an optional margin. This is useful for 3rd person cameras that move closer to the player when inside a tight space (you may need to exclude the player's collider from the [SpringArm3D]'s collision check).

var Nil Instance

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

func New

func New() Instance

func (Instance) AddExcludedObject

func (self Instance) AddExcludedObject(rid RID.Body3D)

Adds the [PhysicsBody3D] object with the given [RID] to the list of [PhysicsBody3D] objects excluded from the collision check.

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) AsSpringArm3D

func (self Instance) AsSpringArm3D() Instance

func (Instance) ClearExcludedObjects

func (self Instance) ClearExcludedObjects()

Clears the list of [PhysicsBody3D] objects excluded from the collision check.

func (Instance) CollisionMask

func (self Instance) CollisionMask() int

func (Instance) GetHitLength

func (self Instance) GetHitLength() Float.X

Returns the spring arm's current length.

func (Instance) Margin

func (self Instance) Margin() Float.X

func (Instance) RemoveExcludedObject

func (self Instance) RemoveExcludedObject(rid RID.Body3D) bool

Removes the given [RID] from the list of [PhysicsBody3D] objects excluded from the collision check.

func (Instance) SetCollisionMask

func (self Instance) SetCollisionMask(value int)

func (Instance) SetMargin

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

func (Instance) SetShape

func (self Instance) SetShape(value [1]gdclass.Shape3D)

func (Instance) SetSpringLength

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

func (Instance) Shape

func (self Instance) Shape() [1]gdclass.Shape3D

func (Instance) SpringLength

func (self Instance) SpringLength() Float.X

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

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