blob: 9e6aa1a270677695e98263f1b3609c64ef72aedd (
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
|
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpriteBase3D" inherits="GeometryInstance" category="Core" version="3.0-beta">
<brief_description>
2D Sprite node in 3D environment.
</brief_description>
<description>
A node that displays 2D texture information in a 3D environment.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="get_alpha_cut_mode" qualifiers="const">
<return type="int" enum="SpriteBase3D.AlphaCutMode">
</return>
<description>
</description>
</method>
<method name="get_axis" qualifiers="const">
<return type="int" enum="Vector3.Axis">
</return>
<description>
</description>
</method>
<method name="get_draw_flag" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="flag" type="int" enum="SpriteBase3D.DrawFlags">
</argument>
<description>
</description>
</method>
<method name="get_item_rect" qualifiers="const">
<return type="Rect2">
</return>
<description>
</description>
</method>
<method name="get_modulate" qualifiers="const">
<return type="Color">
</return>
<description>
</description>
</method>
<method name="get_offset" qualifiers="const">
<return type="Vector2">
</return>
<description>
</description>
</method>
<method name="get_opacity" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_pixel_size" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="is_centered" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_flipped_h" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_flipped_v" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="set_alpha_cut_mode">
<return type="void">
</return>
<argument index="0" name="mode" type="int" enum="SpriteBase3D.AlphaCutMode">
</argument>
<description>
</description>
</method>
<method name="set_axis">
<return type="void">
</return>
<argument index="0" name="axis" type="int" enum="Vector3.Axis">
</argument>
<description>
</description>
</method>
<method name="set_centered">
<return type="void">
</return>
<argument index="0" name="centered" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_draw_flag">
<return type="void">
</return>
<argument index="0" name="flag" type="int" enum="SpriteBase3D.DrawFlags">
</argument>
<argument index="1" name="enabled" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_flip_h">
<return type="void">
</return>
<argument index="0" name="flip_h" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_flip_v">
<return type="void">
</return>
<argument index="0" name="flip_v" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_modulate">
<return type="void">
</return>
<argument index="0" name="modulate" type="Color">
</argument>
<description>
</description>
</method>
<method name="set_offset">
<return type="void">
</return>
<argument index="0" name="offset" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="set_opacity">
<return type="void">
</return>
<argument index="0" name="opacity" type="float">
</argument>
<description>
</description>
</method>
<method name="set_pixel_size">
<return type="void">
</return>
<argument index="0" name="pixel_size" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="alpha_cut" type="int" setter="set_alpha_cut_mode" getter="get_alpha_cut_mode" enum="SpriteBase3D.AlphaCutMode">
</member>
<member name="axis" type="int" setter="set_axis" getter="get_axis" enum="Vector3.Axis">
The direction in which the front of the texture faces.
</member>
<member name="centered" type="bool" setter="set_centered" getter="is_centered">
If [code]true[/code] texture will be centered. Default value: [code]true[/code].
</member>
<member name="double_sided" type="bool" setter="set_draw_flag" getter="get_draw_flag">
If [code]true[/code] texture can be seen from the back as well, if [code]false[/code], it is invisible when looking at it from behind. 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="modulate" type="Color" setter="set_modulate" getter="get_modulate">
A color value that gets multiplied on, could be used for mood-coloring or to simulate the color of light.
</member>
<member name="offset" type="Vector2" setter="set_offset" getter="get_offset">
The texture's drawing offset.
</member>
<member name="opacity" type="float" setter="set_opacity" getter="get_opacity">
The objects visibility on a scale from [code]0[/code] fully invisible to [code]1[/code] fully visible.
</member>
<member name="pixel_size" type="float" setter="set_pixel_size" getter="get_pixel_size">
The size of one pixel's width on the Sprite to scale it in 3D.
</member>
<member name="shaded" type="bool" setter="set_draw_flag" getter="get_draw_flag">
If [code]true[/code] the [Light] in the [Environment] has effects on the Sprite. Default value: [code]false[/code].
</member>
<member name="transparent" type="bool" setter="set_draw_flag" getter="get_draw_flag">
If [code]true[/code] the texture's transparency and the opacity are used to make those parts of the Sprite invisible. Default value: [code]true[/code].
</member>
</members>
<constants>
<constant name="FLAG_TRANSPARENT" value="0">
If set, the texture's transparency and the opacity are used to make those parts of the Sprite invisible.
</constant>
<constant name="FLAG_SHADED" value="1">
If set, the Light in the Environment has effects on the Sprite.
</constant>
<constant name="FLAG_DOUBLE_SIDED" value="2">
If set, texture can be seen from the back as well, if not, it is invisible when looking at it from behind.
</constant>
<constant name="FLAG_MAX" value="3">
Used internally to mark the end of the Flags section.
</constant>
<constant name="ALPHA_CUT_DISABLED" value="0">
</constant>
<constant name="ALPHA_CUT_DISCARD" value="1">
</constant>
<constant name="ALPHA_CUT_OPAQUE_PREPASS" value="2">
</constant>
</constants>
</class>
|