Line2D

Inherits: Node2D < CanvasItem < Node < Object

Category: Core

Brief Description

A 2D line.

Member Functions

void add_point ( Vector2 position )
int get_point_count ( ) const
Vector2 get_point_position ( int i ) const
void remove_point ( int i )
void set_point_position ( int i, Vector2 position )

Member Variables

  • int begin_cap_mode - Controls the style of the line’s first point. Use LINE_CAP\_\* constants. Default value: LINE_CAP_NONE.
  • Color default_color - The line’s color. Will not be used if a gradient is set.
  • int end_cap_mode - Controls the style of the line’s last point. Use LINE_CAP\_\* constants. Default value: LINE_CAP_NONE.
  • Gradient gradient - The gradient is drawn through the whole line from start to finish. The default color will not be used if a gradient is set.
  • int joint_mode - The style for the points inbetween the start and the end.
  • PoolVector2Array points - The points that form the lines. The line is drawn between every point set in this array.
  • int round_precision - The smoothness of the rounded joints and caps. This is only used if a cap or joint is set as round.
  • float sharp_limit - The direction difference in radians between vector points. This value is only used if joint mode is set to LINE_JOINT_SHARP.
  • Texture texture - The texture used for the line’s texture. Uses texture_mode for drawing style.
  • int texture_mode - The style to render the texture on the line. Use LINE_TEXTURE\_\* constants. Default value: LINE_TEXTURE_NONE.
  • float width - The line’s width.

Numeric Constants

  • LINE_JOINT_SHARP = 0 — The line’s joints will be pointy. If sharp_limit is greater than the rotation of a joint, it becomes a bevel joint instead.
  • LINE_JOINT_BEVEL = 1 — The line’s joints will be bevelled/chamfered.
  • LINE_JOINT_ROUND = 2 — The line’s joints will be rounded.
  • LINE_CAP_NONE = 0 — Don’t have a line cap.
  • LINE_CAP_BOX = 1 — Draws the line cap as a box.
  • LINE_CAP_ROUND = 2 — Draws the line cap as a circle.
  • LINE_TEXTURE_NONE = 0 — Takes the left pixels of the texture and renders it over the whole line.
  • LINE_TEXTURE_TILE = 1 — Tiles the texture over the line. The texture need to be imported with Repeat Enabled for it to work properly.

Description

A line through several points in 2D space.

Member Function Description

  • void add_point ( Vector2 position )

Add a point at the position. Appends the point at the end of the line.

  • int get_point_count ( ) const

Returns the Line2D’s amount of points.

Returns point i‘s position.

  • void remove_point ( int i )

Remove the point at index i from the line.

  • void set_point_position ( int i, Vector2 position )

Overwites the position in point i with the supplied position.