Documentation
¶
Overview ¶
This node takes its parent Path2D, 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 Progress in this node.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AsCanvasItem() CanvasItem.Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsNode2D() Node2D.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsPathFollow2D() Instance
- func (self Instance) CubicInterp() bool
- func (self Instance) HOffset() Float.X
- func (self Instance) ID() ID
- func (self Instance) Loop() bool
- func (self Instance) Progress() Float.X
- func (self Instance) ProgressRatio() Float.X
- func (self Instance) Rotates() bool
- func (self Instance) SetCubicInterp(value bool)
- func (self Instance) SetHOffset(value Float.X)
- func (self Instance) SetLoop(value bool)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetProgress(value Float.X)
- func (self Instance) SetProgressRatio(value Float.X)
- func (self Instance) SetRotates(value bool)
- func (self Instance) SetVOffset(value Float.X)
- func (self Instance) VOffset() 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]) AsPathFollow2D ¶
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.PathFollow2D
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) AsCanvasItem ¶
func (self Instance) AsCanvasItem() CanvasItem.Instance
func (Instance) AsPathFollow2D ¶
func (Instance) CubicInterp ¶
If true, the position between two cached points is interpolated cubically, and linearly otherwise.
The points along the Curve2D of the Path2D are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough.
There are two answers to this problem: either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations.
func (Instance) Loop ¶
If true, any offset outside the path's length will wrap around, instead of stopping at the ends. Use it for cyclic paths.
func (Instance) Progress ¶
The distance along the path, in pixels. Changing this value sets this node's position to a point within the path.
func (Instance) ProgressRatio ¶
The distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last). This is just another way of expressing the progress within the path, as the offset supplied is multiplied internally by the path's length.
It can be set or get only if the PathFollow2D is the child of a Path2D which is part of the scene tree, and that this Path2D has a Curve2D with a non-zero length. Otherwise, trying to set this field will print an error, and getting this field will return 0.0.
func (Instance) Rotates ¶
If true, this node rotates to follow the path, with the +X direction facing forward on the path.
func (Instance) SetCubicInterp ¶
SetCubicInterp sets the property returned by [GetCubicInterpolation].
func (Instance) SetHOffset ¶
SetHOffset sets the property returned by [GetHOffset].
func (Instance) SetProgress ¶
SetProgress sets the property returned by [GetProgress].
func (Instance) SetProgressRatio ¶
SetProgressRatio sets the property returned by [GetProgressRatio].
func (Instance) SetRotates ¶
SetRotates sets the property returned by [IsRotating].
func (Instance) SetVOffset ¶
SetVOffset sets the property returned by [GetVOffset].
Source Files