blob: 7996adab5188b9fcb2a8a0266dbc723c60693903 (
plain)
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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
|
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Sprite" inherits="Node2D" category="Core" version="3.0-alpha">
<brief_description>
General purpose Sprite node.
</brief_description>
<description>
A node that displays a 2D texture. The texture displayed can be a region from a larger atlas texture, or a frame from a sprite sheet animation.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="get_frame" qualifiers="const">
<return type="int">
</return>
<description>
Return the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1.
</description>
</method>
<method name="get_hframes" qualifiers="const">
<return type="int">
</return>
<description>
Return the amount of horizontal frames. See [method set_hframes].
</description>
</method>
<method name="get_normal_map" qualifiers="const">
<return type="Texture">
</return>
<description>
</description>
</method>
<method name="get_offset" qualifiers="const">
<return type="Vector2">
</return>
<description>
Return sprite draw offset.
</description>
</method>
<method name="get_region_rect" qualifiers="const">
<return type="Rect2">
</return>
<description>
Return the region rect to read from.
</description>
</method>
<method name="get_texture" qualifiers="const">
<return type="Texture">
</return>
<description>
Return the base texture for the sprite.
</description>
</method>
<method name="get_vframes" qualifiers="const">
<return type="int">
</return>
<description>
Return the amount of vertical frames. See [method set_vframes].
</description>
</method>
<method name="is_centered" qualifiers="const">
<return type="bool">
</return>
<description>
Return if the sprite is centered at the local origin.
</description>
</method>
<method name="is_flipped_h" qualifiers="const">
<return type="bool">
</return>
<description>
Return true if the sprite is flipped horizontally.
</description>
</method>
<method name="is_flipped_v" qualifiers="const">
<return type="bool">
</return>
<description>
Return true if the sprite is flipped vertically.
</description>
</method>
<method name="is_region" qualifiers="const">
<return type="bool">
</return>
<description>
Return if the sprite reads from a region.
</description>
</method>
<method name="is_region_filter_clip_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="set_centered">
<return type="void">
</return>
<argument index="0" name="centered" type="bool">
</argument>
<description>
Set whether the sprite should be centered on the origin.
</description>
</method>
<method name="set_flip_h">
<return type="void">
</return>
<argument index="0" name="flip_h" type="bool">
</argument>
<description>
Set true to flip the sprite horizontally.
</description>
</method>
<method name="set_flip_v">
<return type="void">
</return>
<argument index="0" name="flip_v" type="bool">
</argument>
<description>
Set true to flip the sprite vertically.
</description>
</method>
<method name="set_frame">
<return type="void">
</return>
<argument index="0" name="frame" type="int">
</argument>
<description>
Set the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1.
</description>
</method>
<method name="set_hframes">
<return type="void">
</return>
<argument index="0" name="hframes" type="int">
</argument>
<description>
Set the amount of horizontal frames and converts the sprite into a sprite-sheet. This is useful for animation.
</description>
</method>
<method name="set_normal_map">
<return type="void">
</return>
<argument index="0" name="normal_map" type="Texture">
</argument>
<description>
</description>
</method>
<method name="set_offset">
<return type="void">
</return>
<argument index="0" name="offset" type="Vector2">
</argument>
<description>
Set the sprite draw offset, useful for setting rotation pivots.
</description>
</method>
<method name="set_region">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
Set the sprite as a sub-region of a bigger texture. Useful for texture-atlases.
</description>
</method>
<method name="set_region_filter_clip">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_region_rect">
<return type="void">
</return>
<argument index="0" name="rect" type="Rect2">
</argument>
<description>
Set the region rect to read from.
</description>
</method>
<method name="set_texture">
<return type="void">
</return>
<argument index="0" name="texture" type="Texture">
</argument>
<description>
Set the base texture for the sprite.
</description>
</method>
<method name="set_vframes">
<return type="void">
</return>
<argument index="0" name="vframes" type="int">
</argument>
<description>
Set the amount of vertical frames and converts the sprite into a sprite-sheet. This is useful for animation.
</description>
</method>
</methods>
<members>
<member name="centered" type="bool" setter="set_centered" getter="is_centered">
If [code]true[/code] texture is centered. Default value: [code]true[/code].
</member>
<member name="flip_h" type="bool" setter="set_flip_h" getter="is_flipped_h">
If [code]true[/code] texture is flipped horizontally. Default value: [code]false[/code].
</member>
<member name="flip_v" type="bool" setter="set_flip_v" getter="is_flipped_v">
If [code]true[/code] texture is flipped vertically. Default value: [code]false[/code].
</member>
<member name="frame" type="int" setter="set_frame" getter="get_frame">
Current frame to display from sprite sheet. [member vframes] or [member hframes] must be greater than 1.
</member>
<member name="hframes" type="int" setter="set_hframes" getter="get_hframes">
The number of collumns in the sprite sheet.
</member>
<member name="normal_map" type="Texture" setter="set_normal_map" getter="get_normal_map">
The normal map gives depth to the Sprite.
</member>
<member name="offset" type="Vector2" setter="set_offset" getter="get_offset">
The texture's drawing offset.
</member>
<member name="region_enabled" type="bool" setter="set_region" getter="is_region">
If [code]true[/code] texture is cut from a larger atlas texture. See [code]region_rect[/code]. Default value: [code]false[/code].
</member>
<member name="region_filter_clip" type="bool" setter="set_region_filter_clip" getter="is_region_filter_clip_enabled">
If [code]true[/code] the outermost pixels get blurred out.
</member>
<member name="region_rect" type="Rect2" setter="set_region_rect" getter="get_region_rect">
The region of the atlas texture to display. [member region_enabled] must be [code]true[/code].
</member>
<member name="texture" type="Texture" setter="set_texture" getter="get_texture">
[Texture] object to draw.
</member>
<member name="vframes" type="int" setter="set_vframes" getter="get_vframes">
The number of rows in the sprite sheet.
</member>
</members>
<signals>
<signal name="frame_changed">
<description>
Emitted when the [member frame] changes.
</description>
</signal>
<signal name="texture_changed">
<description>
Emitted when the [member texture] changes.
</description>
</signal>
</signals>
<constants>
</constants>
</class>
|