TextParagraph

public HorizontalAlignment Alignment { get; set; }

Paragraph horizontal alignment.

public TextServer.LineBreakFlag BreakFlags { get; set; }

Line breaking rules. For more info see TextServer.

public string CustomPunctuation { get; set; }

Custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.

public TextServer.Direction Direction { get; set; }

Text writing direction.

public string EllipsisChar { get; set; }

Ellipsis character used for text clipping.

public TextServer.JustificationFlag JustificationFlags { get; set; }

Line fill alignment rules.

public float LineSpacing { get; set; }

Additional vertical spacing between lines (in pixels), spacing is added to line descent. This value can be negative.

public int MaxLinesVisible { get; set; }

Limits the lines of text shown.

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 paragraph's set width.

public float Width { get; set; }

Paragraph 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 paragraph (removes text and inline objects).

public void ClearDropcap();

Removes dropcap.

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

Draw all lines of the text and drop cap 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, Color? dcColor = default, float oversampling = 0f);

Draw all lines of the text and drop cap 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 DrawDropcap(Rid canvas, Vector2 pos, Color? color);

Draw drop cap 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 DrawDropcap(Rid canvas, Vector2 pos, Color? color = default, float oversampling = 0f);

Draw drop cap 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 DrawDropcapOutline(Rid canvas, Vector2 pos, int outlineSize, Color? color);

Draw drop cap outline 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 DrawDropcapOutline(Rid canvas, Vector2 pos, int outlineSize = 1, Color? color = default, float oversampling = 0f);

Draw drop cap outline 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 DrawLine(Rid canvas, Vector2 pos, int line, Color? color);

Draw single line of 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 DrawLine(Rid canvas, Vector2 pos, int line, Color? color = default, float oversampling = 0f);

Draw single line of 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 DrawLineOutline(Rid canvas, Vector2 pos, int line, int outlineSize, Color? color);

Draw outline of the single line of 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 DrawLineOutline(Rid canvas, Vector2 pos, int line, int outlineSize = 1, Color? color = default, float oversampling = 0f);

Draw outline of the single line of 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, Color? dcColor);

Draw outlines of all lines of the text and drop cap 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, Color? dcColor = default, float oversampling = 0f);

Draw outlines of all lines of the text and drop cap 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 TextParagraph Duplicate();

Duplicates this TextParagraph.

public int GetDropcapLines();

Returns number of lines used by dropcap.

public Rid GetDropcapRid();

Returns drop cap text buffer RID.

public Vector2 GetDropcapSize();

Returns drop cap bounding box size.

public TextServer.Direction GetInferredDirection();

Returns the text writing direction inferred by the BiDi algorithm.

public float GetLineAscent(int line);

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

public int GetLineCount();

Returns number of lines in the paragraph.

public float GetLineDescent(int line);

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

public Rect2 GetLineObjectRect(int line, Variant key);

Returns bounding rectangle of the inline object.

public Reckfell.Collections.Array GetLineObjects(int line);

Returns array of inline objects in the line.

public Vector2I GetLineRange(int line);

Returns character range of the line.

public Rid GetLineRid(int line);

Returns TextServer line buffer RID.

public Vector2 GetLineSize(int line);

Returns size of the bounding box of the line of text. Returned size is rounded up.

public float GetLineUnderlinePosition(int line);

Returns pixel offset of the underline below the baseline.

public float GetLineUnderlineThickness(int line);

Returns thickness of the underline.

public float GetLineWidth(int line);

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

public Vector2 GetNonWrappedSize();

Returns the size of the bounding box of the paragraph, without line breaks.

public Vector2I GetRange();

Returns the character range of the paragraph.

public Rid GetRid();

Returns TextServer full string buffer RID.

public Vector2 GetSize();

Returns the size of the bounding box of the paragraph.

public bool HasObject(Variant key);

Returns true if an object with key is embedded in this shaped text buffer.

public int HitTest(Vector2 coords);

Returns caret character offset at the specified coordinates. 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 bool SetDropcap(string text, Font font, int fontSize, Rect2? dropcapMargins = default, string language = "");

Sets drop cap, overrides previously set drop cap. Drop cap (dropped capital) is a decorative element at the beginning of a paragraph that is larger than the rest of the text.

public void TabAlign(ReadOnlySpan<float> tabStops);

Aligns paragraph to the given tab-stops.

public void TabAlign(float[] tabStops);

Aligns paragraph to the given tab-stops.