2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-03-31 00:22:57 +08:00
<class name= "GPUParticles3D" inherits= "GeometryInstance3D" version= "4.0" >
2017-09-13 04:42:36 +08:00
<brief_description >
2017-10-04 03:30:32 +08:00
3D particle emitter.
2017-09-13 04:42:36 +08:00
</brief_description>
<description >
2020-03-31 00:22:57 +08:00
3D particle node used to create a variety of particle systems and effects. [GPUParticles3D] features an emitter that generates some number of particles at a given rate.
2017-10-04 03:30:32 +08:00
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.
2017-09-13 04:42:36 +08:00
</description>
<tutorials >
2020-08-05 20:43:40 +08:00
<link title= "Controlling thousands of fish with Particles" > https://docs.godotengine.org/en/latest/tutorials/3d/vertex_animation/controlling_thousands_of_fish.html</link>
2020-10-01 16:34:47 +08:00
<link title= "Third Person Shooter Demo" > https://godotengine.org/asset-library/asset/678</link>
2017-09-13 04:42:36 +08:00
</tutorials>
<methods >
<method name= "capture_aabb" qualifiers= "const" >
2017-11-17 10:09:00 +08:00
<return type= "AABB" >
2017-09-13 04:42:36 +08:00
</return>
<description >
2019-06-22 07:04:47 +08:00
Returns the axis-aligned bounding box that contains all the particles that are active in the current frame.
2017-09-13 04:42:36 +08:00
</description>
</method>
2020-09-11 18:22:10 +08:00
<method name= "emit_particle" >
<return type= "void" >
</return>
2020-05-03 16:27:36 +08:00
<argument index= "0" name= "xform" type= "Transform3D" >
2020-09-11 18:22:10 +08:00
</argument>
<argument index= "1" name= "velocity" type= "Vector3" >
</argument>
<argument index= "2" name= "color" type= "Color" >
</argument>
<argument index= "3" name= "custom" type= "Color" >
</argument>
<argument index= "4" name= "flags" type= "int" >
</argument>
<description >
</description>
</method>
2019-06-27 22:10:09 +08:00
<method name= "get_draw_pass_mesh" qualifiers= "const" >
<return type= "Mesh" >
</return>
<argument index= "0" name= "pass" type= "int" >
</argument>
<description >
2019-10-30 16:09:26 +08:00
Returns the [Mesh] that is drawn at index [code]pass[/code].
2019-06-27 22:10:09 +08:00
</description>
</method>
2017-09-13 04:42:36 +08:00
<method name= "restart" >
<return type= "void" >
</return>
<description >
2019-06-04 08:57:57 +08:00
Restarts the particle emission, clearing existing particles.
2017-09-13 04:42:36 +08:00
</description>
</method>
2019-06-27 22:10:09 +08:00
<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 >
2019-10-30 16:09:26 +08:00
Sets the [Mesh] that is drawn at index [code]pass[/code].
2019-06-27 22:10:09 +08:00
</description>
</method>
2017-09-13 04:42:36 +08:00
</methods>
<members >
2019-06-29 18:38:01 +08:00
<member name= "amount" type= "int" setter= "set_amount" getter= "get_amount" default= "8" >
2017-10-04 03:30:32 +08:00
Number of particles to emit.
2017-09-13 04:42:36 +08:00
</member>
2020-10-12 16:57:54 +08:00
<member name= "collision_base_size" type= "float" setter= "set_collision_base_size" getter= "get_collision_base_size" default= "0.01" >
</member>
2020-03-31 00:22:57 +08:00
<member name= "draw_order" type= "int" setter= "set_draw_order" getter= "get_draw_order" enum= "GPUParticles3D.DrawOrder" default= "0" >
2019-12-07 06:09:20 +08:00
Particle draw order. Uses [enum DrawOrder] values.
2017-09-13 04:42:36 +08:00
</member>
2019-07-16 02:42:47 +08:00
<member name= "draw_pass_1" type= "Mesh" setter= "set_draw_pass_mesh" getter= "get_draw_pass_mesh" >
2018-06-03 09:45:30 +08:00
[Mesh] that is drawn for the first draw pass.
2017-09-13 04:42:36 +08:00
</member>
2019-06-30 03:22:15 +08:00
<member name= "draw_pass_2" type= "Mesh" setter= "set_draw_pass_mesh" getter= "get_draw_pass_mesh" >
2018-06-03 09:45:30 +08:00
[Mesh] that is drawn for the second draw pass.
2017-09-13 04:42:36 +08:00
</member>
2019-06-30 03:22:15 +08:00
<member name= "draw_pass_3" type= "Mesh" setter= "set_draw_pass_mesh" getter= "get_draw_pass_mesh" >
2018-06-03 09:45:30 +08:00
[Mesh] that is drawn for the third draw pass.
2017-09-13 04:42:36 +08:00
</member>
2019-06-30 03:22:15 +08:00
<member name= "draw_pass_4" type= "Mesh" setter= "set_draw_pass_mesh" getter= "get_draw_pass_mesh" >
2018-06-03 09:45:30 +08:00
[Mesh] that is drawn for the fourth draw pass.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "draw_passes" type= "int" setter= "set_draw_passes" getter= "get_draw_passes" default= "1" >
2018-06-03 09:45:30 +08:00
The number of draw passes when rendering particles.
2017-09-13 04:42:36 +08:00
</member>
2021-05-01 16:56:32 +08:00
<member name= "draw_skin" type= "Skin" setter= "set_skin" getter= "get_skin" >
</member>
2020-09-04 16:43:11 +08:00
<member name= "emitting" type= "bool" setter= "set_emitting" getter= "is_emitting" default= "true" >
2019-06-29 21:24:23 +08:00
If [code]true[/code], particles are being emitted.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "explosiveness" type= "float" setter= "set_explosiveness_ratio" getter= "get_explosiveness_ratio" default= "0.0" >
2019-06-29 21:24:23 +08:00
Time ratio between each emission. If [code]0[/code], particles are emitted continuously. If [code]1[/code], all particles are emitted simultaneously.
2017-09-13 04:42:36 +08:00
</member>
2021-05-01 16:56:32 +08:00
<member name= "fixed_fps" type= "int" setter= "set_fixed_fps" getter= "get_fixed_fps" default= "30" >
2019-06-14 08:13:37 +08:00
The particle system's frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the simulation of the particle system itself.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "fract_delta" type= "bool" setter= "set_fractional_delta" getter= "get_fractional_delta" default= "true" >
2019-06-29 21:24:23 +08:00
If [code]true[/code], results in fractional delta calculation which has a smoother particles display effect.
2017-09-13 04:42:36 +08:00
</member>
2021-05-01 16:56:32 +08:00
<member name= "interpolate" type= "bool" setter= "set_interpolate" getter= "get_interpolate" default= "true" >
</member>
2019-06-29 18:38:01 +08:00
<member name= "lifetime" type= "float" setter= "set_lifetime" getter= "get_lifetime" default= "1.0" >
2019-06-29 21:24:23 +08:00
Amount of time each particle will exist.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "local_coords" type= "bool" setter= "set_use_local_coordinates" getter= "get_use_local_coordinates" default= "true" >
2019-06-29 21:24:23 +08:00
If [code]true[/code], particles use the parent node's coordinate space. If [code]false[/code], they use global coordinates.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "one_shot" type= "bool" setter= "set_one_shot" getter= "get_one_shot" default= "false" >
2019-06-29 21:24:23 +08:00
If [code]true[/code], only [code]amount[/code] particles will be emitted.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "preprocess" type= "float" setter= "set_pre_process_time" getter= "get_pre_process_time" default= "0.0" >
2018-06-03 09:45:30 +08:00
Amount of time to preprocess the particles before animation starts. Lets you start the animation some time after particles have started emitting.
2017-09-13 04:42:36 +08:00
</member>
2019-07-16 02:42:47 +08:00
<member name= "process_material" type= "Material" setter= "set_process_material" getter= "get_process_material" >
2017-10-04 03:30:32 +08:00
[Material] for processing particles. Can be a [ParticlesMaterial] or a [ShaderMaterial].
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "randomness" type= "float" setter= "set_randomness_ratio" getter= "get_randomness_ratio" default= "0.0" >
2019-06-29 21:24:23 +08:00
Emission randomness ratio.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "speed_scale" type= "float" setter= "set_speed_scale" getter= "get_speed_scale" default= "1.0" >
2019-06-29 21:24:23 +08:00
Speed scaling ratio. A value of [code]0[/code] can be used to pause the particles.
2017-09-13 04:42:36 +08:00
</member>
2020-09-11 18:22:10 +08:00
<member name= "sub_emitter" type= "NodePath" setter= "set_sub_emitter" getter= "get_sub_emitter" default= "NodePath("")" >
</member>
2021-05-20 22:25:06 +08:00
<member name= "trail_enabled" type= "bool" setter= "set_trail_enabled" getter= "is_trail_enabled" default= "false" >
2021-05-01 16:56:32 +08:00
</member>
<member name= "trail_length_secs" type= "float" setter= "set_trail_length" getter= "get_trail_length" default= "0.3" >
</member>
<member name= "transform_align" type= "int" setter= "set_transform_align" getter= "get_transform_align" enum= "GPUParticles3D.TransformAlign" default= "0" >
</member>
2019-09-25 01:45:03 +08:00
<member name= "visibility_aabb" type= "AABB" setter= "set_visibility_aabb" getter= "get_visibility_aabb" default= "AABB(-4, -4, -4, 8, 8, 8)" >
2021-01-16 23:13:33 +08:00
The [AABB] that determines the node's region which needs to be visible on screen for the particle system to be active.
Grow the box if particles suddenly appear/disappear when the node enters/exits the screen. The [AABB] can be grown via code or with the [b]Particles → Generate AABB[/b] editor tool.
2017-09-13 04:42:36 +08:00
</member>
</members>
<constants >
2017-11-25 06:16:30 +08:00
<constant name= "DRAW_ORDER_INDEX" value= "0" enum= "DrawOrder" >
2017-10-04 03:30:32 +08:00
Particles are drawn in the order emitted.
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "DRAW_ORDER_LIFETIME" value= "1" enum= "DrawOrder" >
2017-10-04 03:30:32 +08:00
Particles are drawn in order of remaining lifetime.
2017-09-13 04:42:36 +08:00
</constant>
2021-05-20 22:25:06 +08:00
<constant name= "DRAW_ORDER_REVERSE_LIFETIME" value= "2" enum= "DrawOrder" >
</constant>
<constant name= "DRAW_ORDER_VIEW_DEPTH" value= "3" enum= "DrawOrder" >
2017-10-04 03:30:32 +08:00
Particles are drawn in order of depth.
2017-09-13 04:42:36 +08:00
</constant>
2020-09-11 18:22:10 +08:00
<constant name= "EMIT_FLAG_POSITION" value= "1" enum= "EmitFlags" >
</constant>
<constant name= "EMIT_FLAG_ROTATION_SCALE" value= "2" enum= "EmitFlags" >
</constant>
<constant name= "EMIT_FLAG_VELOCITY" value= "4" enum= "EmitFlags" >
</constant>
<constant name= "EMIT_FLAG_COLOR" value= "8" enum= "EmitFlags" >
</constant>
<constant name= "EMIT_FLAG_CUSTOM" value= "16" enum= "EmitFlags" >
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "MAX_DRAW_PASSES" value= "4" >
2018-06-03 09:45:30 +08:00
Maximum number of draw passes supported.
2017-09-13 04:42:36 +08:00
</constant>
2021-05-01 16:56:32 +08:00
<constant name= "TRANSFORM_ALIGN_DISABLED" value= "0" enum= "TransformAlign" >
</constant>
<constant name= "TRANSFORM_ALIGN_Z_BILLBOARD" value= "1" enum= "TransformAlign" >
</constant>
<constant name= "TRANSFORM_ALIGN_Y_TO_VELOCITY" value= "2" enum= "TransformAlign" >
</constant>
<constant name= "TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY" value= "3" enum= "TransformAlign" >
</constant>
2017-09-13 04:42:36 +08:00
</constants>
</class>
