f7f6115f76
- Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
103 lines
5.1 KiB
XML
103 lines
5.1 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
||
<class name="StyleBoxTexture" inherits="StyleBox" category="Core" version="3.2">
|
||
<brief_description>
|
||
Texture-based nine-patch [StyleBox].
|
||
</brief_description>
|
||
<description>
|
||
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>
|
||
<methods>
|
||
<method name="set_expand_margin_all">
|
||
<return type="void">
|
||
</return>
|
||
<argument index="0" name="size" type="float">
|
||
</argument>
|
||
<description>
|
||
</description>
|
||
</method>
|
||
<method name="set_expand_margin_individual">
|
||
<return type="void">
|
||
</return>
|
||
<argument index="0" name="size_left" type="float">
|
||
</argument>
|
||
<argument index="1" name="size_top" type="float">
|
||
</argument>
|
||
<argument index="2" name="size_right" type="float">
|
||
</argument>
|
||
<argument index="3" name="size_bottom" type="float">
|
||
</argument>
|
||
<description>
|
||
</description>
|
||
</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>
|
||
<member name="axis_stretch_vertical" type="int" setter="set_v_axis_stretch_mode" getter="get_v_axis_stretch_mode" enum="StyleBoxTexture.AxisStretchMode">
|
||
</member>
|
||
<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 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 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 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 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 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 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 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 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">
|
||
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>
|
||
<signal name="texture_changed">
|
||
<description>
|
||
</description>
|
||
</signal>
|
||
</signals>
|
||
<constants>
|
||
<constant name="AXIS_STRETCH_MODE_STRETCH" value="0" enum="AxisStretchMode">
|
||
</constant>
|
||
<constant name="AXIS_STRETCH_MODE_TILE" value="1" enum="AxisStretchMode">
|
||
</constant>
|
||
<constant name="AXIS_STRETCH_MODE_TILE_FIT" value="2" enum="AxisStretchMode">
|
||
</constant>
|
||
</constants>
|
||
</class>
|