mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-08 17:28:58 +00:00
classref: Sync with current master branch (2e7fc81)
This commit is contained in:
Godot Organization
@@ -108,19 +108,19 @@ Methods
|
||||
.. table::
|
||||
:widths: auto
|
||||
|
||||
+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AABB<class_AABB>` | :ref:`capture_aabb<class_GPUParticles3D_method_capture_aabb>` **(** **)** |const| |
|
||||
+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`convert_from_particles<class_GPUParticles3D_method_convert_from_particles>` **(** :ref:`Node<class_Node>` particles **)** |
|
||||
+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`emit_particle<class_GPUParticles3D_method_emit_particle>` **(** :ref:`Transform3D<class_Transform3D>` xform, :ref:`Vector3<class_Vector3>` velocity, :ref:`Color<class_Color>` color, :ref:`Color<class_Color>` custom, :ref:`int<class_int>` flags **)** |
|
||||
+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Mesh<class_Mesh>` | :ref:`get_draw_pass_mesh<class_GPUParticles3D_method_get_draw_pass_mesh>` **(** :ref:`int<class_int>` pass **)** |const| |
|
||||
+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`restart<class_GPUParticles3D_method_restart>` **(** **)** |
|
||||
+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_draw_pass_mesh<class_GPUParticles3D_method_set_draw_pass_mesh>` **(** :ref:`int<class_int>` pass, :ref:`Mesh<class_Mesh>` mesh **)** |
|
||||
+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AABB<class_AABB>` | :ref:`capture_aabb<class_GPUParticles3D_method_capture_aabb>`\ (\ ) |const| |
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`convert_from_particles<class_GPUParticles3D_method_convert_from_particles>`\ (\ particles\: :ref:`Node<class_Node>`\ ) |
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`emit_particle<class_GPUParticles3D_method_emit_particle>`\ (\ xform\: :ref:`Transform3D<class_Transform3D>`, velocity\: :ref:`Vector3<class_Vector3>`, color\: :ref:`Color<class_Color>`, custom\: :ref:`Color<class_Color>`, flags\: :ref:`int<class_int>`\ ) |
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Mesh<class_Mesh>` | :ref:`get_draw_pass_mesh<class_GPUParticles3D_method_get_draw_pass_mesh>`\ (\ pass\: :ref:`int<class_int>`\ ) |const| |
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`restart<class_GPUParticles3D_method_restart>`\ (\ ) |
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| |void| | :ref:`set_draw_pass_mesh<class_GPUParticles3D_method_set_draw_pass_mesh>`\ (\ pass\: :ref:`int<class_int>`, mesh\: :ref:`Mesh<class_Mesh>`\ ) |
|
||||
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. rst-class:: classref-section-separator
|
||||
|
||||
@@ -135,7 +135,7 @@ Signals
|
||||
|
||||
.. rst-class:: classref-signal
|
||||
|
||||
**finished** **(** **)**
|
||||
**finished**\ (\ )
|
||||
|
||||
Emitted when all active particles have finished processing. When :ref:`one_shot<class_GPUParticles3D_property_one_shot>` is disabled, particles will process continuously, so this is never emitted.
|
||||
|
||||
@@ -330,8 +330,8 @@ Property Descriptions
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_amount** **(** :ref:`int<class_int>` value **)**
|
||||
- :ref:`int<class_int>` **get_amount** **(** **)**
|
||||
- |void| **set_amount**\ (\ value\: :ref:`int<class_int>`\ )
|
||||
- :ref:`int<class_int>` **get_amount**\ (\ )
|
||||
|
||||
The number of particles to emit in one emission cycle. The effective emission rate is ``(amount * amount_ratio) / lifetime`` particles per second. Higher values will increase GPU requirements, even if not all particles are visible at a given time or if :ref:`amount_ratio<class_GPUParticles3D_property_amount_ratio>` is decreased.
|
||||
|
||||
@@ -349,8 +349,8 @@ The number of particles to emit in one emission cycle. The effective emission ra
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_amount_ratio** **(** :ref:`float<class_float>` value **)**
|
||||
- :ref:`float<class_float>` **get_amount_ratio** **(** **)**
|
||||
- |void| **set_amount_ratio**\ (\ value\: :ref:`float<class_float>`\ )
|
||||
- :ref:`float<class_float>` **get_amount_ratio**\ (\ )
|
||||
|
||||
The ratio of particles that should actually be emitted. If set to a value lower than ``1.0``, this will set the amount of emitted particles throughout the lifetime to ``amount * amount_ratio``. Unlike changing :ref:`amount<class_GPUParticles3D_property_amount>`, changing :ref:`amount_ratio<class_GPUParticles3D_property_amount_ratio>` while emitting does not affect already-emitted particles and doesn't cause the particle system to restart. :ref:`amount_ratio<class_GPUParticles3D_property_amount_ratio>` can be used to create effects that make the number of emitted particles vary over time.
|
||||
|
||||
@@ -368,8 +368,8 @@ The ratio of particles that should actually be emitted. If set to a value lower
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_collision_base_size** **(** :ref:`float<class_float>` value **)**
|
||||
- :ref:`float<class_float>` **get_collision_base_size** **(** **)**
|
||||
- |void| **set_collision_base_size**\ (\ value\: :ref:`float<class_float>`\ )
|
||||
- :ref:`float<class_float>` **get_collision_base_size**\ (\ )
|
||||
|
||||
The base diameter for particle collision in meters. If particles appear to sink into the ground when colliding, increase this value. If particles appear to float when colliding, decrease this value. Only effective if :ref:`ParticleProcessMaterial.collision_mode<class_ParticleProcessMaterial_property_collision_mode>` is :ref:`ParticleProcessMaterial.COLLISION_RIGID<class_ParticleProcessMaterial_constant_COLLISION_RIGID>` or :ref:`ParticleProcessMaterial.COLLISION_HIDE_ON_CONTACT<class_ParticleProcessMaterial_constant_COLLISION_HIDE_ON_CONTACT>`.
|
||||
|
||||
@@ -387,8 +387,8 @@ The base diameter for particle collision in meters. If particles appear to sink
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_draw_order** **(** :ref:`DrawOrder<enum_GPUParticles3D_DrawOrder>` value **)**
|
||||
- :ref:`DrawOrder<enum_GPUParticles3D_DrawOrder>` **get_draw_order** **(** **)**
|
||||
- |void| **set_draw_order**\ (\ value\: :ref:`DrawOrder<enum_GPUParticles3D_DrawOrder>`\ )
|
||||
- :ref:`DrawOrder<enum_GPUParticles3D_DrawOrder>` **get_draw_order**\ (\ )
|
||||
|
||||
Particle draw order. Uses :ref:`DrawOrder<enum_GPUParticles3D_DrawOrder>` values.
|
||||
|
||||
@@ -406,8 +406,8 @@ Particle draw order. Uses :ref:`DrawOrder<enum_GPUParticles3D_DrawOrder>` values
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_draw_pass_mesh** **(** :ref:`int<class_int>` pass, :ref:`Mesh<class_Mesh>` mesh **)**
|
||||
- :ref:`Mesh<class_Mesh>` **get_draw_pass_mesh** **(** :ref:`int<class_int>` pass **)** |const|
|
||||
- |void| **set_draw_pass_mesh**\ (\ pass\: :ref:`int<class_int>`, mesh\: :ref:`Mesh<class_Mesh>`\ )
|
||||
- :ref:`Mesh<class_Mesh>` **get_draw_pass_mesh**\ (\ pass\: :ref:`int<class_int>`\ ) |const|
|
||||
|
||||
:ref:`Mesh<class_Mesh>` that is drawn for the first draw pass.
|
||||
|
||||
@@ -423,8 +423,8 @@ Particle draw order. Uses :ref:`DrawOrder<enum_GPUParticles3D_DrawOrder>` values
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_draw_pass_mesh** **(** :ref:`int<class_int>` pass, :ref:`Mesh<class_Mesh>` mesh **)**
|
||||
- :ref:`Mesh<class_Mesh>` **get_draw_pass_mesh** **(** :ref:`int<class_int>` pass **)** |const|
|
||||
- |void| **set_draw_pass_mesh**\ (\ pass\: :ref:`int<class_int>`, mesh\: :ref:`Mesh<class_Mesh>`\ )
|
||||
- :ref:`Mesh<class_Mesh>` **get_draw_pass_mesh**\ (\ pass\: :ref:`int<class_int>`\ ) |const|
|
||||
|
||||
:ref:`Mesh<class_Mesh>` that is drawn for the second draw pass.
|
||||
|
||||
@@ -440,8 +440,8 @@ Particle draw order. Uses :ref:`DrawOrder<enum_GPUParticles3D_DrawOrder>` values
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_draw_pass_mesh** **(** :ref:`int<class_int>` pass, :ref:`Mesh<class_Mesh>` mesh **)**
|
||||
- :ref:`Mesh<class_Mesh>` **get_draw_pass_mesh** **(** :ref:`int<class_int>` pass **)** |const|
|
||||
- |void| **set_draw_pass_mesh**\ (\ pass\: :ref:`int<class_int>`, mesh\: :ref:`Mesh<class_Mesh>`\ )
|
||||
- :ref:`Mesh<class_Mesh>` **get_draw_pass_mesh**\ (\ pass\: :ref:`int<class_int>`\ ) |const|
|
||||
|
||||
:ref:`Mesh<class_Mesh>` that is drawn for the third draw pass.
|
||||
|
||||
@@ -457,8 +457,8 @@ Particle draw order. Uses :ref:`DrawOrder<enum_GPUParticles3D_DrawOrder>` values
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_draw_pass_mesh** **(** :ref:`int<class_int>` pass, :ref:`Mesh<class_Mesh>` mesh **)**
|
||||
- :ref:`Mesh<class_Mesh>` **get_draw_pass_mesh** **(** :ref:`int<class_int>` pass **)** |const|
|
||||
- |void| **set_draw_pass_mesh**\ (\ pass\: :ref:`int<class_int>`, mesh\: :ref:`Mesh<class_Mesh>`\ )
|
||||
- :ref:`Mesh<class_Mesh>` **get_draw_pass_mesh**\ (\ pass\: :ref:`int<class_int>`\ ) |const|
|
||||
|
||||
:ref:`Mesh<class_Mesh>` that is drawn for the fourth draw pass.
|
||||
|
||||
@@ -474,8 +474,8 @@ Particle draw order. Uses :ref:`DrawOrder<enum_GPUParticles3D_DrawOrder>` values
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_draw_passes** **(** :ref:`int<class_int>` value **)**
|
||||
- :ref:`int<class_int>` **get_draw_passes** **(** **)**
|
||||
- |void| **set_draw_passes**\ (\ value\: :ref:`int<class_int>`\ )
|
||||
- :ref:`int<class_int>` **get_draw_passes**\ (\ )
|
||||
|
||||
The number of draw passes when rendering particles.
|
||||
|
||||
@@ -491,8 +491,8 @@ The number of draw passes when rendering particles.
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_skin** **(** :ref:`Skin<class_Skin>` value **)**
|
||||
- :ref:`Skin<class_Skin>` **get_skin** **(** **)**
|
||||
- |void| **set_skin**\ (\ value\: :ref:`Skin<class_Skin>`\ )
|
||||
- :ref:`Skin<class_Skin>` **get_skin**\ (\ )
|
||||
|
||||
.. container:: contribute
|
||||
|
||||
@@ -510,8 +510,8 @@ The number of draw passes when rendering particles.
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_emitting** **(** :ref:`bool<class_bool>` value **)**
|
||||
- :ref:`bool<class_bool>` **is_emitting** **(** **)**
|
||||
- |void| **set_emitting**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||||
- :ref:`bool<class_bool>` **is_emitting**\ (\ )
|
||||
|
||||
If ``true``, particles are being emitted. :ref:`emitting<class_GPUParticles3D_property_emitting>` can be used to start and stop particles from emitting. However, if :ref:`one_shot<class_GPUParticles3D_property_one_shot>` is ``true`` setting :ref:`emitting<class_GPUParticles3D_property_emitting>` to ``true`` will not restart the emission cycle until after all active particles finish processing. You can use the :ref:`finished<class_GPUParticles3D_signal_finished>` signal to be notified once all active particles finish processing.
|
||||
|
||||
@@ -527,8 +527,8 @@ If ``true``, particles are being emitted. :ref:`emitting<class_GPUParticles3D_pr
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_explosiveness_ratio** **(** :ref:`float<class_float>` value **)**
|
||||
- :ref:`float<class_float>` **get_explosiveness_ratio** **(** **)**
|
||||
- |void| **set_explosiveness_ratio**\ (\ value\: :ref:`float<class_float>`\ )
|
||||
- :ref:`float<class_float>` **get_explosiveness_ratio**\ (\ )
|
||||
|
||||
Time ratio between each emission. If ``0``, particles are emitted continuously. If ``1``, all particles are emitted simultaneously.
|
||||
|
||||
@@ -544,8 +544,8 @@ Time ratio between each emission. If ``0``, particles are emitted continuously.
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_fixed_fps** **(** :ref:`int<class_int>` value **)**
|
||||
- :ref:`int<class_int>` **get_fixed_fps** **(** **)**
|
||||
- |void| **set_fixed_fps**\ (\ value\: :ref:`int<class_int>`\ )
|
||||
- :ref:`int<class_int>` **get_fixed_fps**\ (\ )
|
||||
|
||||
The particle system's frame rate is fixed to a value. For example, 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.
|
||||
|
||||
@@ -561,8 +561,8 @@ The particle system's frame rate is fixed to a value. For example, changing the
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_fractional_delta** **(** :ref:`bool<class_bool>` value **)**
|
||||
- :ref:`bool<class_bool>` **get_fractional_delta** **(** **)**
|
||||
- |void| **set_fractional_delta**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||||
- :ref:`bool<class_bool>` **get_fractional_delta**\ (\ )
|
||||
|
||||
If ``true``, results in fractional delta calculation which has a smoother particles display effect.
|
||||
|
||||
@@ -578,8 +578,8 @@ If ``true``, results in fractional delta calculation which has a smoother partic
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_interp_to_end** **(** :ref:`float<class_float>` value **)**
|
||||
- :ref:`float<class_float>` **get_interp_to_end** **(** **)**
|
||||
- |void| **set_interp_to_end**\ (\ value\: :ref:`float<class_float>`\ )
|
||||
- :ref:`float<class_float>` **get_interp_to_end**\ (\ )
|
||||
|
||||
Causes all the particles in this node to interpolate towards the end of their lifetime.
|
||||
|
||||
@@ -597,8 +597,8 @@ Causes all the particles in this node to interpolate towards the end of their li
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_interpolate** **(** :ref:`bool<class_bool>` value **)**
|
||||
- :ref:`bool<class_bool>` **get_interpolate** **(** **)**
|
||||
- |void| **set_interpolate**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||||
- :ref:`bool<class_bool>` **get_interpolate**\ (\ )
|
||||
|
||||
Enables particle interpolation, which makes the particle movement smoother when their :ref:`fixed_fps<class_GPUParticles3D_property_fixed_fps>` is lower than the screen refresh rate.
|
||||
|
||||
@@ -614,8 +614,8 @@ Enables particle interpolation, which makes the particle movement smoother when
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_lifetime** **(** :ref:`float<class_float>` value **)**
|
||||
- :ref:`float<class_float>` **get_lifetime** **(** **)**
|
||||
- |void| **set_lifetime**\ (\ value\: :ref:`float<class_float>`\ )
|
||||
- :ref:`float<class_float>` **get_lifetime**\ (\ )
|
||||
|
||||
The amount of time each particle will exist (in seconds). The effective emission rate is ``(amount * amount_ratio) / lifetime`` particles per second.
|
||||
|
||||
@@ -631,8 +631,8 @@ The amount of time each particle will exist (in seconds). The effective emission
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_use_local_coordinates** **(** :ref:`bool<class_bool>` value **)**
|
||||
- :ref:`bool<class_bool>` **get_use_local_coordinates** **(** **)**
|
||||
- |void| **set_use_local_coordinates**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||||
- :ref:`bool<class_bool>` **get_use_local_coordinates**\ (\ )
|
||||
|
||||
If ``true``, particles use the parent node's coordinate space (known as local coordinates). This will cause particles to move and rotate along the **GPUParticles3D** node (and its parents) when it is moved or rotated. If ``false``, particles use global coordinates; they will not move or rotate along the **GPUParticles3D** node (and its parents) when it is moved or rotated.
|
||||
|
||||
@@ -648,8 +648,8 @@ If ``true``, particles use the parent node's coordinate space (known as local co
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_one_shot** **(** :ref:`bool<class_bool>` value **)**
|
||||
- :ref:`bool<class_bool>` **get_one_shot** **(** **)**
|
||||
- |void| **set_one_shot**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||||
- :ref:`bool<class_bool>` **get_one_shot**\ (\ )
|
||||
|
||||
If ``true``, only the number of particles equal to :ref:`amount<class_GPUParticles3D_property_amount>` will be emitted.
|
||||
|
||||
@@ -665,8 +665,8 @@ If ``true``, only the number of particles equal to :ref:`amount<class_GPUParticl
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_pre_process_time** **(** :ref:`float<class_float>` value **)**
|
||||
- :ref:`float<class_float>` **get_pre_process_time** **(** **)**
|
||||
- |void| **set_pre_process_time**\ (\ value\: :ref:`float<class_float>`\ )
|
||||
- :ref:`float<class_float>` **get_pre_process_time**\ (\ )
|
||||
|
||||
Amount of time to preprocess the particles before animation starts. Lets you start the animation some time after particles have started emitting.
|
||||
|
||||
@@ -682,8 +682,8 @@ Amount of time to preprocess the particles before animation starts. Lets you sta
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_process_material** **(** :ref:`Material<class_Material>` value **)**
|
||||
- :ref:`Material<class_Material>` **get_process_material** **(** **)**
|
||||
- |void| **set_process_material**\ (\ value\: :ref:`Material<class_Material>`\ )
|
||||
- :ref:`Material<class_Material>` **get_process_material**\ (\ )
|
||||
|
||||
:ref:`Material<class_Material>` for processing particles. Can be a :ref:`ParticleProcessMaterial<class_ParticleProcessMaterial>` or a :ref:`ShaderMaterial<class_ShaderMaterial>`.
|
||||
|
||||
@@ -699,8 +699,8 @@ Amount of time to preprocess the particles before animation starts. Lets you sta
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_randomness_ratio** **(** :ref:`float<class_float>` value **)**
|
||||
- :ref:`float<class_float>` **get_randomness_ratio** **(** **)**
|
||||
- |void| **set_randomness_ratio**\ (\ value\: :ref:`float<class_float>`\ )
|
||||
- :ref:`float<class_float>` **get_randomness_ratio**\ (\ )
|
||||
|
||||
Emission randomness ratio.
|
||||
|
||||
@@ -716,8 +716,8 @@ Emission randomness ratio.
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_speed_scale** **(** :ref:`float<class_float>` value **)**
|
||||
- :ref:`float<class_float>` **get_speed_scale** **(** **)**
|
||||
- |void| **set_speed_scale**\ (\ value\: :ref:`float<class_float>`\ )
|
||||
- :ref:`float<class_float>` **get_speed_scale**\ (\ )
|
||||
|
||||
Speed scaling ratio. A value of ``0`` can be used to pause the particles.
|
||||
|
||||
@@ -733,8 +733,8 @@ Speed scaling ratio. A value of ``0`` can be used to pause the particles.
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_sub_emitter** **(** :ref:`NodePath<class_NodePath>` value **)**
|
||||
- :ref:`NodePath<class_NodePath>` **get_sub_emitter** **(** **)**
|
||||
- |void| **set_sub_emitter**\ (\ value\: :ref:`NodePath<class_NodePath>`\ )
|
||||
- :ref:`NodePath<class_NodePath>` **get_sub_emitter**\ (\ )
|
||||
|
||||
Path to another **GPUParticles3D** node that will be used as a subemitter (see :ref:`ParticleProcessMaterial.sub_emitter_mode<class_ParticleProcessMaterial_property_sub_emitter_mode>`). Subemitters can be used to achieve effects such as fireworks, sparks on collision, bubbles popping into water drops, and more.
|
||||
|
||||
@@ -752,8 +752,8 @@ Path to another **GPUParticles3D** node that will be used as a subemitter (see :
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_trail_enabled** **(** :ref:`bool<class_bool>` value **)**
|
||||
- :ref:`bool<class_bool>` **is_trail_enabled** **(** **)**
|
||||
- |void| **set_trail_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||||
- :ref:`bool<class_bool>` **is_trail_enabled**\ (\ )
|
||||
|
||||
If ``true``, enables particle trails using a mesh skinning system. Designed to work with :ref:`RibbonTrailMesh<class_RibbonTrailMesh>` and :ref:`TubeTrailMesh<class_TubeTrailMesh>`.
|
||||
|
||||
@@ -773,8 +773,8 @@ If ``true``, enables particle trails using a mesh skinning system. Designed to w
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_trail_lifetime** **(** :ref:`float<class_float>` value **)**
|
||||
- :ref:`float<class_float>` **get_trail_lifetime** **(** **)**
|
||||
- |void| **set_trail_lifetime**\ (\ value\: :ref:`float<class_float>`\ )
|
||||
- :ref:`float<class_float>` **get_trail_lifetime**\ (\ )
|
||||
|
||||
The amount of time the particle's trail should represent (in seconds). Only effective if :ref:`trail_enabled<class_GPUParticles3D_property_trail_enabled>` is ``true``.
|
||||
|
||||
@@ -790,8 +790,8 @@ The amount of time the particle's trail should represent (in seconds). Only effe
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_transform_align** **(** :ref:`TransformAlign<enum_GPUParticles3D_TransformAlign>` value **)**
|
||||
- :ref:`TransformAlign<enum_GPUParticles3D_TransformAlign>` **get_transform_align** **(** **)**
|
||||
- |void| **set_transform_align**\ (\ value\: :ref:`TransformAlign<enum_GPUParticles3D_TransformAlign>`\ )
|
||||
- :ref:`TransformAlign<enum_GPUParticles3D_TransformAlign>` **get_transform_align**\ (\ )
|
||||
|
||||
.. container:: contribute
|
||||
|
||||
@@ -809,8 +809,8 @@ The amount of time the particle's trail should represent (in seconds). Only effe
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_visibility_aabb** **(** :ref:`AABB<class_AABB>` value **)**
|
||||
- :ref:`AABB<class_AABB>` **get_visibility_aabb** **(** **)**
|
||||
- |void| **set_visibility_aabb**\ (\ value\: :ref:`AABB<class_AABB>`\ )
|
||||
- :ref:`AABB<class_AABB>` **get_visibility_aabb**\ (\ )
|
||||
|
||||
The :ref:`AABB<class_AABB>` that determines the node's region which needs to be visible on screen for the particle system to be active. :ref:`GeometryInstance3D.extra_cull_margin<class_GeometryInstance3D_property_extra_cull_margin>` is added on each of the AABB's axes. Particle collisions and attraction will only occur within this area.
|
||||
|
||||
@@ -831,7 +831,7 @@ Method Descriptions
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`AABB<class_AABB>` **capture_aabb** **(** **)** |const|
|
||||
:ref:`AABB<class_AABB>` **capture_aabb**\ (\ ) |const|
|
||||
|
||||
Returns the axis-aligned bounding box that contains all the particles that are active in the current frame.
|
||||
|
||||
@@ -843,7 +843,7 @@ Returns the axis-aligned bounding box that contains all the particles that are a
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **convert_from_particles** **(** :ref:`Node<class_Node>` particles **)**
|
||||
|void| **convert_from_particles**\ (\ particles\: :ref:`Node<class_Node>`\ )
|
||||
|
||||
Sets this node's properties to match a given :ref:`CPUParticles3D<class_CPUParticles3D>` node.
|
||||
|
||||
@@ -855,7 +855,7 @@ Sets this node's properties to match a given :ref:`CPUParticles3D<class_CPUParti
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **emit_particle** **(** :ref:`Transform3D<class_Transform3D>` xform, :ref:`Vector3<class_Vector3>` velocity, :ref:`Color<class_Color>` color, :ref:`Color<class_Color>` custom, :ref:`int<class_int>` flags **)**
|
||||
|void| **emit_particle**\ (\ xform\: :ref:`Transform3D<class_Transform3D>`, velocity\: :ref:`Vector3<class_Vector3>`, color\: :ref:`Color<class_Color>`, custom\: :ref:`Color<class_Color>`, flags\: :ref:`int<class_int>`\ )
|
||||
|
||||
Emits a single particle. Whether ``xform``, ``velocity``, ``color`` and ``custom`` are applied depends on the value of ``flags``. See :ref:`EmitFlags<enum_GPUParticles3D_EmitFlags>`.
|
||||
|
||||
@@ -869,7 +869,7 @@ The default ParticleProcessMaterial will overwrite ``color`` and use the content
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`Mesh<class_Mesh>` **get_draw_pass_mesh** **(** :ref:`int<class_int>` pass **)** |const|
|
||||
:ref:`Mesh<class_Mesh>` **get_draw_pass_mesh**\ (\ pass\: :ref:`int<class_int>`\ ) |const|
|
||||
|
||||
Returns the :ref:`Mesh<class_Mesh>` that is drawn at index ``pass``.
|
||||
|
||||
@@ -881,7 +881,7 @@ Returns the :ref:`Mesh<class_Mesh>` that is drawn at index ``pass``.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **restart** **(** **)**
|
||||
|void| **restart**\ (\ )
|
||||
|
||||
Restarts the particle emission, clearing existing particles.
|
||||
|
||||
@@ -893,7 +893,7 @@ Restarts the particle emission, clearing existing particles.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
void **set_draw_pass_mesh** **(** :ref:`int<class_int>` pass, :ref:`Mesh<class_Mesh>` mesh **)**
|
||||
|void| **set_draw_pass_mesh**\ (\ pass\: :ref:`int<class_int>`, mesh\: :ref:`Mesh<class_Mesh>`\ )
|
||||
|
||||
Sets the :ref:`Mesh<class_Mesh>` that is drawn at index ``pass``.
|
||||
|
||||
@@ -904,3 +904,4 @@ Sets the :ref:`Mesh<class_Mesh>` that is drawn at index ``pass``.
|
||||
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
||||
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|
||||
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
|
||||
.. |void| replace:: :abbr:`void (No return value.)`
|
||||
|
||||
Reference in New Issue
Block a user