Index · Object → RefCounted → Resource → LabelSettings

LabelSettings

Provides common settings to customize the text in a Label.

Class Description

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

Properties

var font: Font

Font used for the text.

var font_color: Color = Color(1, 1, 1, 1)

Color of the text.

var font_size: int = 16

Size of the text.

var line_spacing: float = 3.0

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

var outline_color: Color = Color(1, 1, 1, 1)

The color of the outline.

var outline_size: int = 0

Text outline size.

var paragraph_spacing: float = 0.0

Vertical space between paragraphs. Added on top of line_spacing.

var shadow_color: Color = Color(0, 0, 0, 0)

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

var shadow_offset: Vector2 = Vector2(1, 1)

Offset of the shadow effect, in pixels.

var shadow_size: int = 1

Size of the shadow effect.

var stacked_outline_count: int = 0

The number of stacked outlines.

var stacked_outline_{index}/color: Color = Color(0, 0, 0, 1)

The color of the outline at index.

Note: index is a value in the 0 .. stacked_outline_count - 1 range.

var stacked_outline_{index}/size: int = 0

The size of the outline at index.

Note: index is a value in the 0 .. stacked_outline_count - 1 range.

var stacked_shadow_count: int = 0

The number of stacked shadows.

var stacked_shadow_{index}/color: Color = Color(0, 0, 0, 1)

The color of the shadow at index.

Note: index is a value in the 0 .. stacked_shadow_count - 1 range.

var stacked_shadow_{index}/offset: Vector2 = Vector2(1, 1)

The offset of the shadow at index.

Note: index is a value in the 0 .. stacked_shadow_count - 1 range.

var stacked_shadow_{index}/outline_size: int = 0

The size of the shadow outline at index.

Note: index is a value in the 0 .. stacked_shadow_count - 1 range.

Inherited from Resource (4)

Methods

func add_stacked_outline(index: int = -1) -> void

Adds a new stacked outline to the label at the given index. If index is -1, the new stacked outline will be added at the end of the list.

func add_stacked_shadow(index: int = -1) -> void

Adds a new stacked shadow to the label at the given index. If index is -1, the new stacked shadow will be added at the end of the list.

func get_stacked_outline_color(index: int) -> Color

Returns the color of the stacked outline at index.

func get_stacked_outline_size(index: int) -> int

Returns the size of the stacked outline at index.

func get_stacked_shadow_color(index: int) -> Color

Returns the color of the stacked shadow at index.

func get_stacked_shadow_offset(index: int) -> Vector2

Returns the offset of the stacked shadow at index.

func get_stacked_shadow_outline_size(index: int) -> int

Returns the outline size of the stacked shadow at index.

func move_stacked_outline(from_index: int, to_position: int) -> void

Moves the stacked outline at index from_index to the given position to_position in the array.

func move_stacked_shadow(from_index: int, to_position: int) -> void

Moves the stacked shadow at index from_index to the given position to_position in the array.

func remove_stacked_outline(index: int) -> void

Removes the stacked outline at index index.

func remove_stacked_shadow(index: int) -> void

Removes the stacked shadow at index index.

func set_stacked_outline_color(index: int, color: Color) -> void

Sets the color of the stacked outline identified by the given index to color.

func set_stacked_outline_size(index: int, size: int) -> void

Sets the size of the stacked outline identified by the given index to size.

func set_stacked_shadow_color(index: int, color: Color) -> void

Sets the color of the stacked shadow identified by the given index to color.

func set_stacked_shadow_offset(index: int, offset: Vector2) -> void

Sets the offset of the stacked shadow identified by the given index to offset.

func set_stacked_shadow_outline_size(index: int, size: int) -> void

Sets the outline size of the stacked shadow identified by the given index to size.

Inherited from Resource (18)
func _get_rid() -> RID
func _reset_state() -> void
func _set_path_cache(path: String) -> void
func _setup_local_to_scene() -> void
func copy_from_resource(resource: Resource) -> Error
func duplicate(deep: bool = false) -> Resource
func duplicate_deep(deep_subresources_mode: Resource.DeepDuplicateMode = 1) -> Resource
func emit_changed() -> void
func get_rid() -> RID
func is_built_in() -> bool
func reset_state() -> void
func set_id_for_path(path: String, id: String) -> void
func set_path_cache(path: String) -> void
func setup_local_to_scene() -> void
func take_over_path(path: String) -> void
Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Resource (2)
signal changed()
Inherited from Object (2)