TextParagraph

Inherits: RefCounted < Object

There is currently no description for this class. Please help us by contributing one!

Properties

HorizontalAlignment

alignment

0

BitField<LineBreakFlag>

break_flags

3

String

custom_punctuation

""

Direction

direction

0

String

ellipsis_char

"…"

BitField<JustificationFlag>

justification_flags

163

int

max_lines_visible

-1

Orientation

orientation

0

bool

preserve_control

false

bool

preserve_invalid

true

OverrunBehavior

text_overrun_behavior

0

float

width

-1.0

Methods

bool

add_object ( Variant key, Vector2 size, InlineAlignment inline_align=5, int length=1, float baseline=0.0 )

bool

add_string ( String text, Font font, int font_size, String language=””, Variant meta=null )

void

clear ( )

void

clear_dropcap ( )

void

draw ( RID canvas, Vector2 pos, Color color=Color(1, 1, 1, 1), Color dc_color=Color(1, 1, 1, 1) ) const

void

draw_dropcap ( RID canvas, Vector2 pos, Color color=Color(1, 1, 1, 1) ) const

void

draw_dropcap_outline ( RID canvas, Vector2 pos, int outline_size=1, Color color=Color(1, 1, 1, 1) ) const

void

draw_line ( RID canvas, Vector2 pos, int line, Color color=Color(1, 1, 1, 1) ) const

void

draw_line_outline ( RID canvas, Vector2 pos, int line, int outline_size=1, Color color=Color(1, 1, 1, 1) ) const

void

draw_outline ( RID canvas, Vector2 pos, int outline_size=1, Color color=Color(1, 1, 1, 1), Color dc_color=Color(1, 1, 1, 1) ) const

int

get_dropcap_lines ( ) const

RID

get_dropcap_rid ( ) const

Vector2

get_dropcap_size ( ) const

float

get_line_ascent ( int line ) const

int

get_line_count ( ) const

float

get_line_descent ( int line ) const

Rect2

get_line_object_rect ( int line, Variant key ) const

Array

get_line_objects ( int line ) const

Vector2i

get_line_range ( int line ) const

RID

get_line_rid ( int line ) const

Vector2

get_line_size ( int line ) const

float

get_line_underline_position ( int line ) const

float

get_line_underline_thickness ( int line ) const

float

get_line_width ( int line ) const

Vector2

get_non_wrapped_size ( ) const

RID

get_rid ( ) const

Vector2

get_size ( ) const

int

hit_test ( Vector2 coords ) const

bool

resize_object ( Variant key, Vector2 size, InlineAlignment inline_align=5, float baseline=0.0 )

void

set_bidi_override ( Array override )

bool

set_dropcap ( String text, Font font, int font_size, Rect2 dropcap_margins=Rect2(0, 0, 0, 0), String language=”” )

void

tab_align ( PackedFloat32Array tab_stops )


Property Descriptions

HorizontalAlignment alignment = 0

There is currently no description for this property. Please help us by contributing one!


BitField<LineBreakFlag> break_flags = 3

There is currently no description for this property. Please help us by contributing one!


String custom_punctuation = ""

  • void set_custom_punctuation ( String value )

  • String get_custom_punctuation ( )

There is currently no description for this property. Please help us by contributing one!


Direction direction = 0

There is currently no description for this property. Please help us by contributing one!


String ellipsis_char = "…"

  • void set_ellipsis_char ( String value )

  • String get_ellipsis_char ( )

There is currently no description for this property. Please help us by contributing one!


BitField<JustificationFlag> justification_flags = 163

There is currently no description for this property. Please help us by contributing one!


int max_lines_visible = -1

  • void set_max_lines_visible ( int value )

  • int get_max_lines_visible ( )

There is currently no description for this property. Please help us by contributing one!


Orientation orientation = 0

There is currently no description for this property. Please help us by contributing one!


bool preserve_control = false

  • void set_preserve_control ( bool value )

  • bool get_preserve_control ( )

There is currently no description for this property. Please help us by contributing one!


bool preserve_invalid = true

  • void set_preserve_invalid ( bool value )

  • bool get_preserve_invalid ( )

There is currently no description for this property. Please help us by contributing one!


OverrunBehavior text_overrun_behavior = 0

There is currently no description for this property. Please help us by contributing one!


float width = -1.0

  • void set_width ( float value )

  • float get_width ( )

There is currently no description for this property. Please help us by contributing one!


Method Descriptions

bool add_object ( Variant key, Vector2 size, InlineAlignment inline_align=5, int length=1, float baseline=0.0 )

There is currently no description for this method. Please help us by contributing one!


bool add_string ( String text, Font font, int font_size, String language=””, Variant meta=null )

There is currently no description for this method. Please help us by contributing one!


void clear ( )

There is currently no description for this method. Please help us by contributing one!


void clear_dropcap ( )

There is currently no description for this method. Please help us by contributing one!


void draw ( RID canvas, Vector2 pos, Color color=Color(1, 1, 1, 1), Color dc_color=Color(1, 1, 1, 1) ) const

There is currently no description for this method. Please help us by contributing one!


void draw_dropcap ( RID canvas, Vector2 pos, Color color=Color(1, 1, 1, 1) ) const

There is currently no description for this method. Please help us by contributing one!


void draw_dropcap_outline ( RID canvas, Vector2 pos, int outline_size=1, Color color=Color(1, 1, 1, 1) ) const

There is currently no description for this method. Please help us by contributing one!


void draw_line ( RID canvas, Vector2 pos, int line, Color color=Color(1, 1, 1, 1) ) const

There is currently no description for this method. Please help us by contributing one!


void draw_line_outline ( RID canvas, Vector2 pos, int line, int outline_size=1, Color color=Color(1, 1, 1, 1) ) const

There is currently no description for this method. Please help us by contributing one!


void draw_outline ( RID canvas, Vector2 pos, int outline_size=1, Color color=Color(1, 1, 1, 1), Color dc_color=Color(1, 1, 1, 1) ) const

There is currently no description for this method. Please help us by contributing one!


int get_dropcap_lines ( ) const

There is currently no description for this method. Please help us by contributing one!


RID get_dropcap_rid ( ) const

There is currently no description for this method. Please help us by contributing one!


Vector2 get_dropcap_size ( ) const

There is currently no description for this method. Please help us by contributing one!


float get_line_ascent ( int line ) const

There is currently no description for this method. Please help us by contributing one!


int get_line_count ( ) const

There is currently no description for this method. Please help us by contributing one!


float get_line_descent ( int line ) const

There is currently no description for this method. Please help us by contributing one!


Rect2 get_line_object_rect ( int line, Variant key ) const

There is currently no description for this method. Please help us by contributing one!


Array get_line_objects ( int line ) const

There is currently no description for this method. Please help us by contributing one!


Vector2i get_line_range ( int line ) const

There is currently no description for this method. Please help us by contributing one!


RID get_line_rid ( int line ) const

There is currently no description for this method. Please help us by contributing one!


Vector2 get_line_size ( int line ) const

There is currently no description for this method. Please help us by contributing one!


float get_line_underline_position ( int line ) const

There is currently no description for this method. Please help us by contributing one!


float get_line_underline_thickness ( int line ) const

There is currently no description for this method. Please help us by contributing one!


float get_line_width ( int line ) const

There is currently no description for this method. Please help us by contributing one!


Vector2 get_non_wrapped_size ( ) const

There is currently no description for this method. Please help us by contributing one!


RID get_rid ( ) const

There is currently no description for this method. Please help us by contributing one!


Vector2 get_size ( ) const

There is currently no description for this method. Please help us by contributing one!


int hit_test ( Vector2 coords ) const

There is currently no description for this method. Please help us by contributing one!


bool resize_object ( Variant key, Vector2 size, InlineAlignment inline_align=5, float baseline=0.0 )

There is currently no description for this method. Please help us by contributing one!


void set_bidi_override ( Array override )

There is currently no description for this method. Please help us by contributing one!


bool set_dropcap ( String text, Font font, int font_size, Rect2 dropcap_margins=Rect2(0, 0, 0, 0), String language=”” )

There is currently no description for this method. Please help us by contributing one!


void tab_align ( PackedFloat32Array tab_stops )

There is currently no description for this method. Please help us by contributing one!