TextLine

public HorizontalAlignment Alignment { get; set; }

Sets text alignment within the line as if the line was horizontal.

public TextServer.Direction Direction { get; set; }

Text writing direction.

public string EllipsisChar { get; set; }

Ellipsis character used for text clipping.

public TextServer.JustificationFlag Flags { get; set; }

Line alignment rules. For more info see TextServer.

public TextServer.Orientation Orientation { get; set; }

Text orientation.

public bool PreserveControl { get; set; }

If set to true text will display control characters.

public bool PreserveInvalid { get; set; }

If set to true text will display invalid characters.

public TextServer.OverrunBehavior TextOverrunBehavior { get; set; }

The clipping behavior when the text exceeds the text line's set width.

public float Width { get; set; }

Text line width.

public bool AddObject(Variant key, Vector2 size, InlineAlignment inlineAlign = InlineAlignment.Center, int length = 1, float baseline = 0f);

Adds inline object to the text buffer, key must be unique. In the text, object is represented as length object replacement characters.

public bool AddString(string text, Font font, int fontSize, string language = "", Variant meta = default);

Adds text span and font to draw it.

public void Clear();

Clears text line (removes text and inline objects).

public void Draw(Rid canvas, Vector2 pos, Color? color);

Draw text into a canvas item at a given position, with color. pos specifies the top left corner of the bounding box. If oversampling is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used.

public void Draw(Rid canvas, Vector2 pos, Color? color = default, float oversampling = 0f);

Draw text into a canvas item at a given position, with color. pos specifies the top left corner of the bounding box. If oversampling is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used.

public void DrawOutline(Rid canvas, Vector2 pos, int outlineSize, Color? color);

Draw text into a canvas item at a given position, with color. pos specifies the top left corner of the bounding box. If oversampling is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used.

public void DrawOutline(Rid canvas, Vector2 pos, int outlineSize = 1, Color? color = default, float oversampling = 0f);

Draw text into a canvas item at a given position, with color. pos specifies the top left corner of the bounding box. If oversampling is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used.

public TextLine Duplicate();

Duplicates this TextLine.

public TextServer.Direction GetInferredDirection();

Returns the text writing direction inferred by the BiDi algorithm.

public float GetLineAscent();

Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical).

public float GetLineDescent();

Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical).

public float GetLineUnderlinePosition();

Returns pixel offset of the underline below the baseline.

public float GetLineUnderlineThickness();

Returns thickness of the underline.

public float GetLineWidth();

Returns width (for horizontal layout) or height (for vertical) of the text.

public Rect2 GetObjectRect(Variant key);

Returns bounding rectangle of the inline object.

public Reckfell.Collections.Array GetObjects();

Returns array of inline objects.

public Rid GetRid();

Returns TextServer buffer RID.

public Vector2 GetSize();

Returns size of the bounding box of the text.

public bool HasObject(Variant key);

Returns true if an object with key is embedded in this line.

public int HitTest(float coords);

Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position.

public bool ResizeObject(Variant key, Vector2 size, InlineAlignment inlineAlign = InlineAlignment.Center, float baseline = 0f);

Sets new size and alignment of embedded object.

public void SetBidiOverride(Reckfell.Collections.Array @override);

Overrides BiDi for the structured text. Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately.

public void TabAlign(ReadOnlySpan<float> tabStops);

Aligns text to the given tab-stops.

public void TabAlign(float[] tabStops);

Aligns text to the given tab-stops.