1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
<?xml version="1.0" encoding="UTF-8" ?>
<class name="TextureButton" inherits="BaseButton" category="Core" version="3.0-alpha">
<brief_description>
Texture-based button. Supports Pressed, Hover, Disabled and Focused states.
</brief_description>
<description>
[code]TextureButton[/code] has the same functionality as [Button], except it uses sprites instead of Godot's [Theme] resource. It is faster to create, but it doesn't support localization like more complex Controls.
The Normal state's texture is required. Others are optional.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="get_click_mask" qualifiers="const">
<return type="BitMap">
</return>
<description>
</description>
</method>
<method name="get_disabled_texture" qualifiers="const">
<return type="Texture">
</return>
<description>
</description>
</method>
<method name="get_expand" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="get_focused_texture" qualifiers="const">
<return type="Texture">
</return>
<description>
</description>
</method>
<method name="get_hover_texture" qualifiers="const">
<return type="Texture">
</return>
<description>
</description>
</method>
<method name="get_normal_texture" qualifiers="const">
<return type="Texture">
</return>
<description>
</description>
</method>
<method name="get_pressed_texture" qualifiers="const">
<return type="Texture">
</return>
<description>
</description>
</method>
<method name="get_stretch_mode" qualifiers="const">
<return type="int" enum="TextureButton.StretchMode">
</return>
<description>
</description>
</method>
<method name="set_click_mask">
<return type="void">
</return>
<argument index="0" name="mask" type="BitMap">
</argument>
<description>
</description>
</method>
<method name="set_disabled_texture">
<return type="void">
</return>
<argument index="0" name="texture" type="Texture">
</argument>
<description>
</description>
</method>
<method name="set_expand">
<return type="void">
</return>
<argument index="0" name="p_expand" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_focused_texture">
<return type="void">
</return>
<argument index="0" name="texture" type="Texture">
</argument>
<description>
</description>
</method>
<method name="set_hover_texture">
<return type="void">
</return>
<argument index="0" name="texture" type="Texture">
</argument>
<description>
</description>
</method>
<method name="set_normal_texture">
<return type="void">
</return>
<argument index="0" name="texture" type="Texture">
</argument>
<description>
</description>
</method>
<method name="set_pressed_texture">
<return type="void">
</return>
<argument index="0" name="texture" type="Texture">
</argument>
<description>
</description>
</method>
<method name="set_stretch_mode">
<return type="void">
</return>
<argument index="0" name="p_mode" type="int" enum="TextureButton.StretchMode">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="expand" type="bool" setter="set_expand" getter="get_expand">
If [code]true[/code] the texture stretches to the edges of the node's bounding rectangle using the [member stretch_mode]. If [code]false[/code] the texture will not scale with the node. Default value: [code]false[/code].
</member>
<member name="stretch_mode" type="int" setter="set_stretch_mode" getter="get_stretch_mode" enum="TextureButton.StretchMode">
Controls the texture's behavior when you resize the node's bounding rectangle, [b]only if[/b] [member expand] is [code]true[/code]. Set it to one of the [code]STRETCH_*[/code] constants. See the constants to learn more.
</member>
<member name="texture_click_mask" type="BitMap" setter="set_click_mask" getter="get_click_mask">
Pure black and white [Bitmap] image to use for click detection. On the mask, white pixels represent the button's clickable area. Use it to create buttons with curved shapes.
</member>
<member name="texture_disabled" type="Texture" setter="set_disabled_texture" getter="get_disabled_texture">
Texture to display when the node is disabled. See [member BaseButton.disabled].
</member>
<member name="texture_focused" type="Texture" setter="set_focused_texture" getter="get_focused_texture">
Texture to display when the node has mouse or keyboard focus.
</member>
<member name="texture_hover" type="Texture" setter="set_hover_texture" getter="get_hover_texture">
Texture to display when the mouse hovers the node.
</member>
<member name="texture_normal" type="Texture" setter="set_normal_texture" getter="get_normal_texture">
Texture to display by default, when the node is [b]not[/b] in the disabled, focused, hover or pressed state.
</member>
<member name="texture_pressed" type="Texture" setter="set_pressed_texture" getter="get_pressed_texture">
Texture to display on mouse down over the node, if the node has keyboard focus and the player presses the enter key or if the player presses the [member BaseButton.shortcut] key.
</member>
</members>
<constants>
<constant name="STRETCH_SCALE" value="0">
Scale to fit the node's bounding rectangle.
</constant>
<constant name="STRETCH_TILE" value="1">
Tile inside the node's bounding rectangle.
</constant>
<constant name="STRETCH_KEEP" value="2">
The texture keeps its original size and stays in the bounding rectangle's top-left corner.
</constant>
<constant name="STRETCH_KEEP_CENTERED" value="3">
The texture keeps its original size and stays centered in the node's bounding rectangle.
</constant>
<constant name="STRETCH_KEEP_ASPECT" value="4">
Scale the texture to fit the node's bounding rectangle, but maintain the texture's aspect ratio.
</constant>
<constant name="STRETCH_KEEP_ASPECT_CENTERED" value="5">
Scale the texture to fit the node's bounding rectangle, center it, and maintain its aspect ratio.
</constant>
<constant name="STRETCH_KEEP_ASPECT_COVERED" value="6">
Scale the texture so that the shorter side fits the bounding rectangle. The other side clips to the node's limits.
</constant>
</constants>
</class>
|