PathFollow3D

Documentation

Overview

Package PathFollow3D provides methods for working with PathFollow3D object instances.

Index

• func CorrectPosture(transform Transform3D.BasisOrigin, ...) Transform3D.BasisOrigin
• type Advanced
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AsNode() Node.Instance
  • func (self Instance) AsNode3D() Node3D.Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsPathFollow3D() Instance
  • func (self Instance) CubicInterp() bool
  • func (self Instance) HOffset() Float.X
  • func (self Instance) Loop() bool
  • func (self Instance) Progress() Float.X
  • func (self Instance) ProgressRatio() Float.X
  • func (self Instance) RotationMode() gdclass.PathFollow3DRotationMode
  • func (self Instance) SetCubicInterp(value bool)
  • func (self Instance) SetHOffset(value Float.X)
  • func (self Instance) SetLoop(value bool)
  • func (self Instance) SetProgress(value Float.X)
  • func (self Instance) SetProgressRatio(value Float.X)
  • func (self Instance) SetRotationMode(value gdclass.PathFollow3DRotationMode)
  • func (self Instance) SetTiltEnabled(value bool)
  • func (self Instance) SetUseModelFront(value bool)
  • func (self Instance) SetVOffset(value Float.X)
  • func (self Instance) TiltEnabled() bool
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) UseModelFront() bool
  • func (self Instance) VOffset() Float.X
  • func (self Instance) Virtual(name string) reflect.Value
• type RotationMode

Functions

func CorrectPosture

func CorrectPosture(transform Transform3D.BasisOrigin, rotation_mode gdclass.PathFollow3DRotationMode) Transform3D.BasisOrigin

Correct the [param transform]. [param rotation_mode] implicitly specifies how posture (forward, up and sideway direction) is calculated.

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

type Instance

type Instance [1]gdclass.PathFollow3D

This node takes its parent [Path3D], and returns the coordinates of a point within it, given a distance from the first vertex. It is useful for making other nodes follow a path, without coding the movement pattern. For that, the nodes must be children of this node. The descendant nodes will then move accordingly when setting the [member progress] in this node.

var Nil Instance

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

func New

func New() 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) AsPathFollow3D

func (self Instance) AsPathFollow3D() Instance

func (Instance) CubicInterp

func (self Instance) CubicInterp() bool

func (Instance) HOffset

func (self Instance) HOffset() Float.X

func (Instance) Loop

func (self Instance) Loop() bool

func (Instance) Progress

func (self Instance) Progress() Float.X

func (Instance) ProgressRatio

func (self Instance) ProgressRatio() Float.X

func (Instance) RotationMode

func (self Instance) RotationMode() gdclass.PathFollow3DRotationMode

func (Instance) SetCubicInterp

func (self Instance) SetCubicInterp(value bool)

func (Instance) SetHOffset

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

func (Instance) SetLoop

func (self Instance) SetLoop(value bool)

func (Instance) SetProgress

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

func (Instance) SetProgressRatio

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

func (Instance) SetRotationMode

func (self Instance) SetRotationMode(value gdclass.PathFollow3DRotationMode)

func (Instance) SetTiltEnabled

func (self Instance) SetTiltEnabled(value bool)

func (Instance) SetUseModelFront

func (self Instance) SetUseModelFront(value bool)

func (Instance) SetVOffset

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

func (Instance) TiltEnabled

func (self Instance) TiltEnabled() bool

func (*Instance) UnsafePointer

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

func (Instance) UseModelFront

func (self Instance) UseModelFront() bool

func (Instance) VOffset

func (self Instance) VOffset() Float.X

func (Instance) Virtual

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

type RotationMode

type RotationMode = gdclass.PathFollow3DRotationMode //gd:PathFollow3D.RotationMode

const (
	/*Forbids the PathFollow3D to rotate.*/
	RotationNone RotationMode = 0
	/*Allows the PathFollow3D to rotate in the Y axis only.*/
	RotationY RotationMode = 1
	/*Allows the PathFollow3D to rotate in both the X, and Y axes.*/
	RotationXy RotationMode = 2
	/*Allows the PathFollow3D to rotate in any axis.*/
	RotationXyz RotationMode = 3
	/*Uses the up vector information in a [Curve3D] to enforce orientation. This rotation mode requires the [Path3D]'s [member Curve3D.up_vector_enabled] property to be set to [code]true[/code].*/
	RotationOriented RotationMode = 4
)