summaryrefslogtreecommitdiff
path: root/doc/classes/StyleBoxTexture.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/StyleBoxTexture.xml')
-rw-r--r--doc/classes/StyleBoxTexture.xml58
1 files changed, 29 insertions, 29 deletions
diff --git a/doc/classes/StyleBoxTexture.xml b/doc/classes/StyleBoxTexture.xml
index 8e55795053..e51120f269 100644
--- a/doc/classes/StyleBoxTexture.xml
+++ b/doc/classes/StyleBoxTexture.xml
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="StyleBoxTexture" inherits="StyleBox" category="Core" version="3.2">
<brief_description>
- Texture Based 3x3 scale style.
+ Texture-based nine-patch [StyleBox].
</brief_description>
<description>
- Texture Based 3x3 scale style. This stylebox performs a 3x3 scaling of a texture, where only the center cell is fully stretched. This allows for the easy creation of bordered styles.
+ Texture-based nine-patch [StyleBox], in a way similar to [NinePatchRect]. This stylebox performs a 3×3 scaling of a texture, where only the center cell is fully stretched. This makes it possible to design bordered styles regardless of the stylebox's size.
</description>
<tutorials>
</tutorials>
@@ -33,55 +33,55 @@
</method>
</methods>
<members>
- <member name="axis_stretch_horizontal" type="int" setter="set_h_axis_stretch_mode" getter="get_h_axis_stretch_mode" enum="StyleBoxTexture.AxisStretchMode">
+ <member name="axis_stretch_horizontal" type="int" setter="set_h_axis_stretch_mode" getter="get_h_axis_stretch_mode" enum="StyleBoxTexture.AxisStretchMode" default="0">
</member>
- <member name="axis_stretch_vertical" type="int" setter="set_v_axis_stretch_mode" getter="get_v_axis_stretch_mode" enum="StyleBoxTexture.AxisStretchMode">
+ <member name="axis_stretch_vertical" type="int" setter="set_v_axis_stretch_mode" getter="get_v_axis_stretch_mode" enum="StyleBoxTexture.AxisStretchMode" default="0">
</member>
- <member name="draw_center" type="bool" setter="set_draw_center" getter="is_draw_center_enabled">
+ <member name="draw_center" type="bool" setter="set_draw_center" getter="is_draw_center_enabled" default="true">
</member>
- <member name="expand_margin_bottom" type="float" setter="set_expand_margin_size" getter="get_expand_margin_size">
- Expands the bottom margin of this style box when drawing, causing it be drawn larger than requested.
+ <member name="expand_margin_bottom" type="float" setter="set_expand_margin_size" getter="get_expand_margin_size" default="0.0">
+ Expands the bottom margin of this style box when drawing, causing it to be drawn larger than requested.
</member>
- <member name="expand_margin_left" type="float" setter="set_expand_margin_size" getter="get_expand_margin_size">
- Expands the left margin of this style box when drawing, causing it be drawn larger than requested.
+ <member name="expand_margin_left" type="float" setter="set_expand_margin_size" getter="get_expand_margin_size" default="0.0">
+ Expands the left margin of this style box when drawing, causing it to be drawn larger than requested.
</member>
- <member name="expand_margin_right" type="float" setter="set_expand_margin_size" getter="get_expand_margin_size">
- Expands the right margin of this style box when drawing, causing it be drawn larger than requested.
+ <member name="expand_margin_right" type="float" setter="set_expand_margin_size" getter="get_expand_margin_size" default="0.0">
+ Expands the right margin of this style box when drawing, causing it to be drawn larger than requested.
</member>
- <member name="expand_margin_top" type="float" setter="set_expand_margin_size" getter="get_expand_margin_size">
- Expands the top margin of this style box when drawing, causing it be drawn larger than requested.
+ <member name="expand_margin_top" type="float" setter="set_expand_margin_size" getter="get_expand_margin_size" default="0.0">
+ Expands the top margin of this style box when drawing, causing it to be drawn larger than requested.
</member>
- <member name="margin_bottom" type="float" setter="set_margin_size" getter="get_margin_size">
- Increases the bottom margin of the 3x3 texture box.
- A higher value means more of the source texture is considered to be part of the bottom border of the 3x3 box.
+ <member name="margin_bottom" type="float" setter="set_margin_size" getter="get_margin_size" default="0.0">
+ Increases the bottom margin of the 3×3 texture box.
+ A higher value means more of the source texture is considered to be part of the bottom border of the 3×3 box.
This is also the value used as fallback for [member StyleBox.content_margin_bottom] if it is negative.
</member>
- <member name="margin_left" type="float" setter="set_margin_size" getter="get_margin_size">
- Increases the left margin of the 3x3 texture box.
- A higher value means more of the source texture is considered to be part of the left border of the 3x3 box.
+ <member name="margin_left" type="float" setter="set_margin_size" getter="get_margin_size" default="0.0">
+ Increases the left margin of the 3×3 texture box.
+ A higher value means more of the source texture is considered to be part of the left border of the 3×3 box.
This is also the value used as fallback for [member StyleBox.content_margin_left] if it is negative.
</member>
- <member name="margin_right" type="float" setter="set_margin_size" getter="get_margin_size">
- Increases the right margin of the 3x3 texture box.
- A higher value means more of the source texture is considered to be part of the right border of the 3x3 box.
+ <member name="margin_right" type="float" setter="set_margin_size" getter="get_margin_size" default="0.0">
+ Increases the right margin of the 3×3 texture box.
+ A higher value means more of the source texture is considered to be part of the right border of the 3×3 box.
This is also the value used as fallback for [member StyleBox.content_margin_right] if it is negative.
</member>
- <member name="margin_top" type="float" setter="set_margin_size" getter="get_margin_size">
- Increases the top margin of the 3x3 texture box.
- A higher value means more of the source texture is considered to be part of the top border of the 3x3 box.
+ <member name="margin_top" type="float" setter="set_margin_size" getter="get_margin_size" default="0.0">
+ Increases the top margin of the 3×3 texture box.
+ A higher value means more of the source texture is considered to be part of the top border of the 3×3 box.
This is also the value used as fallback for [member StyleBox.content_margin_top] if it is negative.
</member>
- <member name="modulate_color" type="Color" setter="set_modulate" getter="get_modulate">
+ <member name="modulate_color" type="Color" setter="set_modulate" getter="get_modulate" default="Color( 1, 1, 1, 1 )">
Modulates the color of the texture when this style box is drawn.
</member>
- <member name="normal_map" type="Texture" setter="set_normal_map" getter="get_normal_map">
+ <member name="normal_map" type="Texture" setter="set_normal_map" getter="get_normal_map" default="null">
The normal map to use when drawing this style box.
</member>
- <member name="region_rect" type="Rect2" setter="set_region_rect" getter="get_region_rect">
+ <member name="region_rect" type="Rect2" setter="set_region_rect" getter="get_region_rect" default="Rect2( 0, 0, 0, 0 )">
Species a sub region of the texture to use.
This is equivalent to first wrapping the texture in an [AtlasTexture] with the same region.
</member>
- <member name="texture" type="Texture" setter="set_texture" getter="get_texture">
+ <member name="texture" type="Texture" setter="set_texture" getter="get_texture" default="null">
The texture to use when drawing this style box.
</member>
</members>