blob: 4e070f67fd5081c220861551a18ae2603562e645 (
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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
|
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Particles" inherits="GeometryInstance" category="Core" version="3.0-alpha">
<brief_description>
3D particle emitter.
</brief_description>
<description>
3D particle node used to create a variety of particle systems and effects. [code]Particles[/code] features an emitter that generates some number of particles at a given rate.
Use the [code]process_material[/code] property to add a [ParticlesMaterial] to configure particle appearance and behavior. Alternatively, you can add a [ShaderMaterial] which will be applied to all particles.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="capture_aabb" qualifiers="const">
<return type="Rect3">
</return>
<description>
</description>
</method>
<method name="get_amount" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_draw_order" qualifiers="const">
<return type="int" enum="Particles.DrawOrder">
</return>
<description>
</description>
</method>
<method name="get_draw_pass_mesh" qualifiers="const">
<return type="Mesh">
</return>
<argument index="0" name="pass" type="int">
</argument>
<description>
</description>
</method>
<method name="get_draw_passes" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_explosiveness_ratio" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_fixed_fps" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_fractional_delta" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="get_lifetime" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_one_shot" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="get_pre_process_time" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_process_material" qualifiers="const">
<return type="Material">
</return>
<description>
</description>
</method>
<method name="get_randomness_ratio" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_speed_scale" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_use_local_coordinates" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="get_visibility_aabb" qualifiers="const">
<return type="Rect3">
</return>
<description>
</description>
</method>
<method name="is_emitting" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="restart">
<return type="void">
</return>
<description>
</description>
</method>
<method name="set_amount">
<return type="void">
</return>
<argument index="0" name="amount" type="int">
</argument>
<description>
</description>
</method>
<method name="set_draw_order">
<return type="void">
</return>
<argument index="0" name="order" type="int" enum="Particles.DrawOrder">
</argument>
<description>
</description>
</method>
<method name="set_draw_pass_mesh">
<return type="void">
</return>
<argument index="0" name="pass" type="int">
</argument>
<argument index="1" name="mesh" type="Mesh">
</argument>
<description>
</description>
</method>
<method name="set_draw_passes">
<return type="void">
</return>
<argument index="0" name="passes" type="int">
</argument>
<description>
</description>
</method>
<method name="set_emitting">
<return type="void">
</return>
<argument index="0" name="emitting" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_explosiveness_ratio">
<return type="void">
</return>
<argument index="0" name="ratio" type="float">
</argument>
<description>
</description>
</method>
<method name="set_fixed_fps">
<return type="void">
</return>
<argument index="0" name="fps" type="int">
</argument>
<description>
</description>
</method>
<method name="set_fractional_delta">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_lifetime">
<return type="void">
</return>
<argument index="0" name="secs" type="float">
</argument>
<description>
</description>
</method>
<method name="set_one_shot">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_pre_process_time">
<return type="void">
</return>
<argument index="0" name="secs" type="float">
</argument>
<description>
</description>
</method>
<method name="set_process_material">
<return type="void">
</return>
<argument index="0" name="material" type="Material">
</argument>
<description>
</description>
</method>
<method name="set_randomness_ratio">
<return type="void">
</return>
<argument index="0" name="ratio" type="float">
</argument>
<description>
</description>
</method>
<method name="set_speed_scale">
<return type="void">
</return>
<argument index="0" name="scale" type="float">
</argument>
<description>
</description>
</method>
<method name="set_use_local_coordinates">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_visibility_aabb">
<return type="void">
</return>
<argument index="0" name="aabb" type="Rect3">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="amount" type="int" setter="set_amount" getter="get_amount">
Number of particles to emit.
</member>
<member name="draw_order" type="int" setter="set_draw_order" getter="get_draw_order" enum="Particles.DrawOrder">
Particle draw order. Uses [code]DRAW_ORDER_*[/code] values. Default value: [code]DRAW_ORDER_INDEX[/code].
</member>
<member name="draw_pass_1" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh">
</member>
<member name="draw_pass_2" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh">
</member>
<member name="draw_pass_3" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh">
</member>
<member name="draw_pass_4" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh">
</member>
<member name="draw_passes" type="int" setter="set_draw_passes" getter="get_draw_passes">
</member>
<member name="emitting" type="bool" setter="set_emitting" getter="is_emitting">
If [code]true[/code] particles are being emitted. Default value: [code]true[/code].
</member>
<member name="explosiveness" type="float" setter="set_explosiveness_ratio" getter="get_explosiveness_ratio">
Time ratio between each emission. If [code]0[/code] particles are emitted continuously. If [code]1[/code] all particles are emitted simultaneously. Default value: [code]0[/code].
</member>
<member name="fixed_fps" type="int" setter="set_fixed_fps" getter="get_fixed_fps">
</member>
<member name="fract_delta" type="bool" setter="set_fractional_delta" getter="get_fractional_delta">
</member>
<member name="lifetime" type="float" setter="set_lifetime" getter="get_lifetime">
Amount of time each particle will exist. Default value: [code]1[/code].
</member>
<member name="local_coords" type="bool" setter="set_use_local_coordinates" getter="get_use_local_coordinates">
If [code]true[/code] particles use the parent node's coordinate space. If [code]false[/code] they use global coordinates. Default value: [code]true[/code].
</member>
<member name="one_shot" type="bool" setter="set_one_shot" getter="get_one_shot">
If [code]true[/code] only [code]amount[/code] particles will be emitted. Default value: [code]false[/code].
</member>
<member name="preprocess" type="float" setter="set_pre_process_time" getter="get_pre_process_time">
</member>
<member name="process_material" type="Material" setter="set_process_material" getter="get_process_material">
[Material] for processing particles. Can be a [ParticlesMaterial] or a [ShaderMaterial].
</member>
<member name="randomness" type="float" setter="set_randomness_ratio" getter="get_randomness_ratio">
Emission randomness ratio. Default value: [code]0[/code].
</member>
<member name="speed_scale" type="float" setter="set_speed_scale" getter="get_speed_scale">
Speed scaling ratio. Default value: [code]1[/code].
</member>
<member name="visibility_aabb" type="Rect3" setter="set_visibility_aabb" getter="get_visibility_aabb">
</member>
</members>
<constants>
<constant name="DRAW_ORDER_INDEX" value="0">
Particles are drawn in the order emitted.
</constant>
<constant name="DRAW_ORDER_LIFETIME" value="1">
Particles are drawn in order of remaining lifetime.
</constant>
<constant name="DRAW_ORDER_VIEW_DEPTH" value="2">
Particles are drawn in order of depth.
</constant>
<constant name="MAX_DRAW_PASSES" value="4" enum="">
</constant>
</constants>
</class>
|