godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/StyleBoxTexture.xml

105 lines
5.0 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Remove status from hardcoded version string It has no practical use case and just generates noise for each alpha, beta, etc.
2018-02-27 12:40:43 +00:00
<class name="StyleBoxTexture" inherits="StyleBox" category="Core" version="3.1">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
Texture Based 3x3 scale style.
</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.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<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>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="axis_stretch_horizontal" type="int" setter="set_h_axis_stretch_mode" getter="get_h_axis_stretch_mode" enum="StyleBoxTexture.AxisStretchMode">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="axis_stretch_vertical" type="int" setter="set_v_axis_stretch_mode" getter="get_v_axis_stretch_mode" enum="StyleBoxTexture.AxisStretchMode">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="draw_center" type="bool" setter="set_draw_center" getter="is_draw_center_enabled">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="expand_margin_bottom" type="float" setter="set_expand_margin_size" getter="get_expand_margin_size">
Improve documentation for StyleBox. 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.
2019-02-06 16:18:02 +00:00
Expands the bottom margin of this style box when drawing, causing it be drawn larger than requested.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="expand_margin_left" type="float" setter="set_expand_margin_size" getter="get_expand_margin_size">
Improve documentation for StyleBox. 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.
2019-02-06 16:18:02 +00:00
Expands the left margin of this style box when drawing, causing it be drawn larger than requested.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="expand_margin_right" type="float" setter="set_expand_margin_size" getter="get_expand_margin_size">
Improve documentation for StyleBox. 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.
2019-02-06 16:18:02 +00:00
Expands the right margin of this style box when drawing, causing it be drawn larger than requested.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="expand_margin_top" type="float" setter="set_expand_margin_size" getter="get_expand_margin_size">
Improve documentation for StyleBox. 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.
2019-02-06 16:18:02 +00:00
Expands the top margin of this style box when drawing, causing it be drawn larger than requested.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="margin_bottom" type="float" setter="set_margin_size" getter="get_margin_size">
Improve documentation for StyleBox. 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.
2019-02-06 16:18:02 +00:00
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.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="margin_left" type="float" setter="set_margin_size" getter="get_margin_size">
Improve documentation for StyleBox. 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.
2019-02-06 16:18:02 +00:00
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.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="margin_right" type="float" setter="set_margin_size" getter="get_margin_size">
Improve documentation for StyleBox. 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.
2019-02-06 16:18:02 +00:00
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.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="margin_top" type="float" setter="set_margin_size" getter="get_margin_size">
Improve documentation for StyleBox. 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.
2019-02-06 16:18:02 +00:00
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.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="modulate_color" type="Color" setter="set_modulate" getter="get_modulate">
Improve documentation for StyleBox. 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.
2019-02-06 16:18:02 +00:00
Modulates the color of the texture when this style box is drawn.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
StyleBoxTexture: Texture instead of RES for texture and normal_map.
2018-02-22 18:27:35 +00:00
<member name="normal_map" type="Texture" setter="set_normal_map" getter="get_normal_map">
Improve documentation for StyleBox. 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.
2019-02-06 16:18:02 +00:00
The normal map to use when drawing this style box.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="region_rect" type="Rect2" setter="set_region_rect" getter="get_region_rect">
Improve documentation for StyleBox. 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.
2019-02-06 16:18:02 +00:00
Species a sub region of the texture to use.
This is equivalent to first wrapping the texture in an [AtlasTexture] with the same region.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
StyleBoxTexture: Texture instead of RES for texture and normal_map.
2018-02-22 18:27:35 +00:00
<member name="texture" type="Texture" setter="set_texture" getter="get_texture">
Improve documentation for StyleBox. 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.
2019-02-06 16:18:02 +00:00
The texture to use when drawing this style box.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
</members>
<signals>
<signal name="texture_changed">
<description>
</description>
</signal>
</signals>
<constants>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="AXIS_STRETCH_MODE_STRETCH" value="0" enum="AxisStretchMode">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="AXIS_STRETCH_MODE_TILE" value="1" enum="AxisStretchMode">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="AXIS_STRETCH_MODE_TILE_FIT" value="2" enum="AxisStretchMode">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
</constants>
</class>