<?xml version="1.0" encoding="UTF-8" ?>
<class name="LabelSettings" inherits="Resource" api_type="core" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
Provides common settings to customize the text in a [Label].
</brief_description>
<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 [member 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.
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_stacked_outline">
<return type="void" />
<param index="0" name="index" type="int" default="-1" />
<description>
Adds a new stacked outline to the label at the given [param index]. If [param index] is [code]-1[/code], the new stacked outline will be added at the end of the list.
</description>
</method>
<method name="add_stacked_shadow">
<return type="void" />
<param index="0" name="index" type="int" default="-1" />
<description>
Adds a new stacked shadow to the label at the given [param index]. If [param index] is [code]-1[/code], the new stacked shadow will be added at the end of the list.
</description>
</method>
<method name="get_stacked_outline_color" qualifiers="const">
<return type="Color" />
<param index="0" name="index" type="int" />
<description>
Returns the color of the stacked outline at [param index].
</description>
</method>
<method name="get_stacked_outline_size" qualifiers="const">
<return type="int" />
<param index="0" name="index" type="int" />
<description>
Returns the size of the stacked outline at [param index].
</description>
</method>
<method name="get_stacked_shadow_color" qualifiers="const">
<return type="Color" />
<param index="0" name="index" type="int" />
<description>
Returns the color of the stacked shadow at [param index].
</description>
</method>
<method name="get_stacked_shadow_offset" qualifiers="const">
<return type="Vector2" />
<param index="0" name="index" type="int" />
<description>
Returns the offset of the stacked shadow at [param index].
</description>
</method>
<method name="get_stacked_shadow_outline_size" qualifiers="const">
<return type="int" />
<param index="0" name="index" type="int" />
<description>
Returns the outline size of the stacked shadow at [param index].
</description>
</method>
<method name="move_stacked_outline">
<return type="void" />
<param index="0" name="from_index" type="int" />
<param index="1" name="to_position" type="int" />
<description>
Moves the stacked outline at index [param from_index] to the given position [param to_position] in the array.
</description>
</method>
<method name="move_stacked_shadow">
<return type="void" />
<param index="0" name="from_index" type="int" />
<param index="1" name="to_position" type="int" />
<description>
Moves the stacked shadow at index [param from_index] to the given position [param to_position] in the array.
</description>
</method>
<method name="remove_stacked_outline">
<return type="void" />
<param index="0" name="index" type="int" />
<description>
Removes the stacked outline at index [param index].
</description>
</method>
<method name="remove_stacked_shadow">
<return type="void" />
<param index="0" name="index" type="int" />
<description>
Removes the stacked shadow at index [param index].
</description>
</method>
<method name="set_stacked_outline_color">
<return type="void" />
<param index="0" name="index" type="int" />
<param index="1" name="color" type="Color" />
<description>
Sets the color of the stacked outline identified by the given [param index] to [param color].
</description>
</method>
<method name="set_stacked_outline_size">
<return type="void" />
<param index="0" name="index" type="int" />
<param index="1" name="size" type="int" />
<description>
Sets the size of the stacked outline identified by the given [param index] to [param size].
</description>
</method>
<method name="set_stacked_shadow_color">
<return type="void" />
<param index="0" name="index" type="int" />
<param index="1" name="color" type="Color" />
<description>
Sets the color of the stacked shadow identified by the given [param index] to [param color].
</description>
</method>
<method name="set_stacked_shadow_offset">
<return type="void" />
<param index="0" name="index" type="int" />
<param index="1" name="offset" type="Vector2" />
<description>
Sets the offset of the stacked shadow identified by the given [param index] to [param offset].
</description>
</method>
<method name="set_stacked_shadow_outline_size">
<return type="void" />
<param index="0" name="index" type="int" />
<param index="1" name="size" type="int" />
<description>
Sets the outline size of the stacked shadow identified by the given [param index] to [param size].
</description>
</method>
</methods>
<members>
<member name="font" type="Font" setter="set_font" getter="get_font">
[Font] used for the text.
</member>
<member name="font_color" type="Color" setter="set_font_color" getter="get_font_color" default="Color(1, 1, 1, 1)">
Color of the text.
</member>
<member name="font_size" type="int" setter="set_font_size" getter="get_font_size" default="16">
Size of the text.
</member>
<member name="line_spacing" type="float" setter="set_line_spacing" getter="get_line_spacing" default="3.0">
Additional vertical spacing between lines (in pixels), spacing is added to line descent. This value can be negative.
</member>
<member name="outline_color" type="Color" setter="set_outline_color" getter="get_outline_color" default="Color(1, 1, 1, 1)">
The color of the outline.
</member>
<member name="outline_size" type="int" setter="set_outline_size" getter="get_outline_size" default="0">
Text outline size.
</member>
<member name="paragraph_spacing" type="float" setter="set_paragraph_spacing" getter="get_paragraph_spacing" default="0.0">
Vertical space between paragraphs. Added on top of [member line_spacing].
</member>
<member name="shadow_color" type="Color" setter="set_shadow_color" getter="get_shadow_color" default="Color(0, 0, 0, 0)">
Color of the shadow effect. If alpha is [code]0[/code], no shadow will be drawn.
</member>
<member name="shadow_offset" type="Vector2" setter="set_shadow_offset" getter="get_shadow_offset" default="Vector2(1, 1)">
Offset of the shadow effect, in pixels.
</member>
<member name="shadow_size" type="int" setter="set_shadow_size" getter="get_shadow_size" default="1">
Size of the shadow effect.
</member>
<member name="stacked_outline_count" type="int" setter="set_stacked_outline_count" getter="get_stacked_outline_count" default="0">
The number of stacked outlines.
</member>
<member name="stacked_outline_{index}/color" type="Color" setter="" getter="" default="Color(0, 0, 0, 1)">
The color of the outline at [code]index[/code].
[b]Note:[/b] [code]index[/code] is a value in the [code]0 .. stacked_outline_count - 1[/code] range.
</member>
<member name="stacked_outline_{index}/size" type="int" setter="" getter="" default="0">
The size of the outline at [code]index[/code].
[b]Note:[/b] [code]index[/code] is a value in the [code]0 .. stacked_outline_count - 1[/code] range.
</member>
<member name="stacked_shadow_count" type="int" setter="set_stacked_shadow_count" getter="get_stacked_shadow_count" default="0">
The number of stacked shadows.
</member>
<member name="stacked_shadow_{index}/color" type="Color" setter="" getter="" default="Color(0, 0, 0, 1)">
The color of the shadow at [code]index[/code].
[b]Note:[/b] [code]index[/code] is a value in the [code]0 .. stacked_shadow_count - 1[/code] range.
</member>
<member name="stacked_shadow_{index}/offset" type="Vector2" setter="" getter="" default="Vector2i(1, 1)">
The offset of the shadow at [code]index[/code].
[b]Note:[/b] [code]index[/code] is a value in the [code]0 .. stacked_shadow_count - 1[/code] range.
</member>
<member name="stacked_shadow_{index}/outline_size" type="int" setter="" getter="" default="0">
The size of the shadow outline at [code]index[/code].
[b]Note:[/b] [code]index[/code] is a value in the [code]0 .. stacked_shadow_count - 1[/code] range.
</member>
</members>
</class>