godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2026-01-05 06:11:29 +03:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation for StyleBox.

Browse Source 
I want to just say that the terms used by style boxes are all over the place and quite confusing.
It's even worse internally.
This commit is contained in:
Pieter-Jan Briers
2019-02-06 17:18:02 +01:00
committed by Rémi Verschelde
parent 69a75d26ea
commit d7ae3b8b61
2 changed files with 33 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
doc/classes/StyleBoxTexture.xml
View File

@@ -42,28 +42,49 @@
<member name="draw_center" type="bool" setter="set_draw_center" getter="is_draw_center_enabled">
</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>
<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>
<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>
<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>
<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.
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.
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.
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.
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">
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">
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">
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">
The texture to use when drawing this style box.
</member>
</members>
<signals>