PathFollow2D Properties

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.

The override to the default MultiplayerAPI. Set to null to use the default SceneTree one.

When a scene is instanced from a file, its topmost node contains the filename from which it was loaded.

Global position.

Global rotation in radians.

Global rotation in degrees.

Global scale.

Global Transform2D.

The node's offset along the curve.

The rendering layers in which this CanvasItem responds to Light2D nodes.

How far to look ahead of the curve to calculate the tangent if the node is rotating. E.g. shorter lookaheads will lead to faster rotations.

If true, any offset outside the path's length will wrap around, instead of stopping at the ends. Use it for cyclic paths.

The material applied to textures on this CanvasItem.

The color applied to textures on this CanvasItem.

The MultiplayerAPI instance associated with this node. Either the CustomMultiplayer, or the default SceneTree one (if inside tree).

The name of the node. This name is unique among the siblings (other child nodes from the same parent). When set to an existing name, the node will be automatically renamed.

Note: Auto-generated names might include the @ character, which is reserved for unique names when using AddChild(Node, Boolean). When setting the name manually, any @ will be removed.

The distance along the path in pixels.

The node owner. A node can have any other node as owner (as long as it is a valid parent, grandparent, etc. ascending in the tree). When saving a node (using PackedScene), all the nodes it owns will be saved with it. This allows for the creation of complex SceneTrees, with instancing and subinstancing.

Pause mode. How the node will behave if the SceneTree is paused.

Position, relative to the node's parent.

The node's priority in the execution order of the enabled processing callbacks (i.e. , and their internal counterparts). Nodes whose process priority value is lower will have their processing callbacks executed first.

If true, this node rotates to follow the path, making its descendants rotate.

Rotation in radians, relative to the node's parent.

Rotation in degrees, relative to the node's parent.

The node's scale. Unscaled value: (1, 1).

The color applied to textures on this CanvasItem. This is not inherited by children CanvasItems.

If true, the object draws behind its parent.

If true, the object draws on top of its parent.

Local Transform2D.

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 offset within the path, as the offset supplied is multiplied internally by the path's length.

If true, the parent CanvasItem's Material property is used as this one's material.

If true, this CanvasItem is drawn. The node is only visible if all of its antecedents are visible as well (in other words, IsVisibleInTree must return true).

Note: For controls that inherit Popup, the correct way to make them visible is to call one of the multiple popup*() functions instead.

The node's offset perpendicular to the curve.

If true, the node's Z index is relative to its parent's Z index. If this node's Z index is 2 and its parent's effective Z index is 3, then this node's effective Z index will be 2 + 3 = 5.

Z index. Controls the order in which the nodes render. A node with a higher Z index will display in front of others.