Work in progress

Godot documentation is being updated to reflect the latest changes in version 4.0. Some documentation pages may still state outdated information. This banner will tell you if you're reading one of such pages.

The contents of this page are up to date. If you can still find outdated information, please open an issue.

LabelSettings¶

Inherits: Resource < RefCounted < Object

Collection of common settings to customize label text.

Description¶

LabelSettings is a resource that can be assigned to a Label node to customize it. It will take priority over the properties defined in theme. The resource can be shared between multiple labels and swapped on the fly, so it's convenient and flexible way to setup text style.

Properties¶

Font	font
Color	font_color	`Color(1, 1, 1, 1)`
int	font_size	`16`
float	line_spacing	`3.0`
Color	outline_color	`Color(1, 1, 1, 1)`
int	outline_size	`0`
Color	shadow_color	`Color(0, 0, 0, 0)`
Vector2	shadow_offset	`Vector2(1, 1)`
int	shadow_size	`1`

Property Descriptions¶

Font font

void set_font ( Font value )
Font get_font ( )

Font used for the text.

Color font_color = Color(1, 1, 1, 1)

void set_font_color ( Color value )
Color get_font_color ( )

Color of the text.

int font_size = 16

void set_font_size ( int value )
int get_font_size ( )

Size of the text.

float line_spacing = 3.0

void set_line_spacing ( float value )
float get_line_spacing ( )

Vertical space between lines when the text is multiline.

Color outline_color = Color(1, 1, 1, 1)

void set_outline_color ( Color value )
Color get_outline_color ( )

The color of the outline.

int outline_size = 0

void set_outline_size ( int value )
int get_outline_size ( )

Text outline size.

Color shadow_color = Color(0, 0, 0, 0)

void set_shadow_color ( Color value )
Color get_shadow_color ( )

Color of the shadow effect. If alpha is 0, no shadow will be drawn.

Vector2 shadow_offset = Vector2(1, 1)

void set_shadow_offset ( Vector2 value )
Vector2 get_shadow_offset ( )

Offset of the shadow effect, in pixels.

int shadow_size = 1

void set_shadow_size ( int value )
int get_shadow_size ( )

Size of the shadow effect.