.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/doc/classes/GPUParticles2D.xml. .. _class_GPUParticles2D: GPUParticles2D ============== **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`int` | :ref:`amount` | ``8`` | +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`float` | :ref:`amount_ratio` | ``1.0`` | +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`float` | :ref:`collision_base_size` | ``1.0`` | +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`DrawOrder` | :ref:`draw_order` | ``1`` | +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`bool` | :ref:`emitting` | ``true`` | +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`float` | :ref:`explosiveness` | ``0.0`` | +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`int` | :ref:`fixed_fps` | ``30`` | +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`bool` | :ref:`fract_delta` | ``true`` | +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`float` | :ref:`interp_to_end` | ``0.0`` | +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`bool` | :ref:`interpolate` | ``true`` | +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`float` | :ref:`lifetime` | ``1.0`` | +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`bool` | :ref:`local_coords` | ``false`` | +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`bool` | :ref:`one_shot` | ``false`` | +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`float` | :ref:`preprocess` | ``0.0`` | +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`Material` | :ref:`process_material` | | +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`float` | :ref:`randomness` | ``0.0`` | +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`float` | :ref:`speed_scale` | ``1.0`` | +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`NodePath` | :ref:`sub_emitter` | ``NodePath("")`` | +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`Texture2D` | :ref:`texture` | | +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`bool` | :ref:`trail_enabled` | ``false`` | +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`float` | :ref:`trail_lifetime` | ``0.3`` | +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`int` | :ref:`trail_section_subdivisions` | ``4`` | +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`int` | :ref:`trail_sections` | ``8`` | +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`Rect2` | :ref:`visibility_rect` | ``Rect2(-100, -100, 200, 200)`` | +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`capture_rect` **(** **)** |const| | +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`convert_from_particles` **(** :ref:`Node` particles **)** | +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`emit_particle` **(** :ref:`Transform2D` xform, :ref:`Vector2` velocity, :ref:`Color` color, :ref:`Color` custom, :ref:`int` flags **)** | +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`restart` **(** **)** | +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_GPUParticles2D_signal_finished: .. rst-class:: classref-signal **finished** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_GPUParticles2D_DrawOrder: .. rst-class:: classref-enumeration enum **DrawOrder**: .. _class_GPUParticles2D_constant_DRAW_ORDER_INDEX: .. rst-class:: classref-enumeration-constant :ref:`DrawOrder` **DRAW_ORDER_INDEX** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_GPUParticles2D_constant_DRAW_ORDER_LIFETIME: .. rst-class:: classref-enumeration-constant :ref:`DrawOrder` **DRAW_ORDER_LIFETIME** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_GPUParticles2D_constant_DRAW_ORDER_REVERSE_LIFETIME: .. rst-class:: classref-enumeration-constant :ref:`DrawOrder` **DRAW_ORDER_REVERSE_LIFETIME** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_GPUParticles2D_EmitFlags: .. rst-class:: classref-enumeration enum **EmitFlags**: .. _class_GPUParticles2D_constant_EMIT_FLAG_POSITION: .. rst-class:: classref-enumeration-constant :ref:`EmitFlags` **EMIT_FLAG_POSITION** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_GPUParticles2D_constant_EMIT_FLAG_ROTATION_SCALE: .. rst-class:: classref-enumeration-constant :ref:`EmitFlags` **EMIT_FLAG_ROTATION_SCALE** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_GPUParticles2D_constant_EMIT_FLAG_VELOCITY: .. rst-class:: classref-enumeration-constant :ref:`EmitFlags` **EMIT_FLAG_VELOCITY** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_GPUParticles2D_constant_EMIT_FLAG_COLOR: .. rst-class:: classref-enumeration-constant :ref:`EmitFlags` **EMIT_FLAG_COLOR** = ``8`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_GPUParticles2D_constant_EMIT_FLAG_CUSTOM: .. rst-class:: classref-enumeration-constant :ref:`EmitFlags` **EMIT_FLAG_CUSTOM** = ``16`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_GPUParticles2D_property_amount: .. rst-class:: classref-property :ref:`int` **amount** = ``8`` .. rst-class:: classref-property-setget - void **set_amount** **(** :ref:`int` value **)** - :ref:`int` **get_amount** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GPUParticles2D_property_amount_ratio: .. rst-class:: classref-property :ref:`float` **amount_ratio** = ``1.0`` .. rst-class:: classref-property-setget - void **set_amount_ratio** **(** :ref:`float` value **)** - :ref:`float` **get_amount_ratio** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GPUParticles2D_property_collision_base_size: .. rst-class:: classref-property :ref:`float` **collision_base_size** = ``1.0`` .. rst-class:: classref-property-setget - void **set_collision_base_size** **(** :ref:`float` value **)** - :ref:`float` **get_collision_base_size** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GPUParticles2D_property_draw_order: .. rst-class:: classref-property :ref:`DrawOrder` **draw_order** = ``1`` .. rst-class:: classref-property-setget - void **set_draw_order** **(** :ref:`DrawOrder` value **)** - :ref:`DrawOrder` **get_draw_order** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GPUParticles2D_property_emitting: .. rst-class:: classref-property :ref:`bool` **emitting** = ``true`` .. rst-class:: classref-property-setget - void **set_emitting** **(** :ref:`bool` value **)** - :ref:`bool` **is_emitting** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GPUParticles2D_property_explosiveness: .. rst-class:: classref-property :ref:`float` **explosiveness** = ``0.0`` .. rst-class:: classref-property-setget - void **set_explosiveness_ratio** **(** :ref:`float` value **)** - :ref:`float` **get_explosiveness_ratio** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GPUParticles2D_property_fixed_fps: .. rst-class:: classref-property :ref:`int` **fixed_fps** = ``30`` .. rst-class:: classref-property-setget - void **set_fixed_fps** **(** :ref:`int` value **)** - :ref:`int` **get_fixed_fps** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GPUParticles2D_property_fract_delta: .. rst-class:: classref-property :ref:`bool` **fract_delta** = ``true`` .. rst-class:: classref-property-setget - void **set_fractional_delta** **(** :ref:`bool` value **)** - :ref:`bool` **get_fractional_delta** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GPUParticles2D_property_interp_to_end: .. rst-class:: classref-property :ref:`float` **interp_to_end** = ``0.0`` .. rst-class:: classref-property-setget - void **set_interp_to_end** **(** :ref:`float` value **)** - :ref:`float` **get_interp_to_end** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GPUParticles2D_property_interpolate: .. rst-class:: classref-property :ref:`bool` **interpolate** = ``true`` .. rst-class:: classref-property-setget - void **set_interpolate** **(** :ref:`bool` value **)** - :ref:`bool` **get_interpolate** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GPUParticles2D_property_lifetime: .. rst-class:: classref-property :ref:`float` **lifetime** = ``1.0`` .. rst-class:: classref-property-setget - void **set_lifetime** **(** :ref:`float` value **)** - :ref:`float` **get_lifetime** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GPUParticles2D_property_local_coords: .. rst-class:: classref-property :ref:`bool` **local_coords** = ``false`` .. rst-class:: classref-property-setget - void **set_use_local_coordinates** **(** :ref:`bool` value **)** - :ref:`bool` **get_use_local_coordinates** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GPUParticles2D_property_one_shot: .. rst-class:: classref-property :ref:`bool` **one_shot** = ``false`` .. rst-class:: classref-property-setget - void **set_one_shot** **(** :ref:`bool` value **)** - :ref:`bool` **get_one_shot** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GPUParticles2D_property_preprocess: .. rst-class:: classref-property :ref:`float` **preprocess** = ``0.0`` .. rst-class:: classref-property-setget - void **set_pre_process_time** **(** :ref:`float` value **)** - :ref:`float` **get_pre_process_time** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GPUParticles2D_property_process_material: .. rst-class:: classref-property :ref:`Material` **process_material** .. rst-class:: classref-property-setget - void **set_process_material** **(** :ref:`Material` value **)** - :ref:`Material` **get_process_material** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GPUParticles2D_property_randomness: .. rst-class:: classref-property :ref:`float` **randomness** = ``0.0`` .. rst-class:: classref-property-setget - void **set_randomness_ratio** **(** :ref:`float` value **)** - :ref:`float` **get_randomness_ratio** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GPUParticles2D_property_speed_scale: .. rst-class:: classref-property :ref:`float` **speed_scale** = ``1.0`` .. rst-class:: classref-property-setget - void **set_speed_scale** **(** :ref:`float` value **)** - :ref:`float` **get_speed_scale** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GPUParticles2D_property_sub_emitter: .. rst-class:: classref-property :ref:`NodePath` **sub_emitter** = ``NodePath("")`` .. rst-class:: classref-property-setget - void **set_sub_emitter** **(** :ref:`NodePath` value **)** - :ref:`NodePath` **get_sub_emitter** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GPUParticles2D_property_texture: .. rst-class:: classref-property :ref:`Texture2D` **texture** .. rst-class:: classref-property-setget - void **set_texture** **(** :ref:`Texture2D` value **)** - :ref:`Texture2D` **get_texture** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GPUParticles2D_property_trail_enabled: .. rst-class:: classref-property :ref:`bool` **trail_enabled** = ``false`` .. rst-class:: classref-property-setget - void **set_trail_enabled** **(** :ref:`bool` value **)** - :ref:`bool` **is_trail_enabled** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GPUParticles2D_property_trail_lifetime: .. rst-class:: classref-property :ref:`float` **trail_lifetime** = ``0.3`` .. rst-class:: classref-property-setget - void **set_trail_lifetime** **(** :ref:`float` value **)** - :ref:`float` **get_trail_lifetime** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GPUParticles2D_property_trail_section_subdivisions: .. rst-class:: classref-property :ref:`int` **trail_section_subdivisions** = ``4`` .. rst-class:: classref-property-setget - void **set_trail_section_subdivisions** **(** :ref:`int` value **)** - :ref:`int` **get_trail_section_subdivisions** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GPUParticles2D_property_trail_sections: .. rst-class:: classref-property :ref:`int` **trail_sections** = ``8`` .. rst-class:: classref-property-setget - void **set_trail_sections** **(** :ref:`int` value **)** - :ref:`int` **get_trail_sections** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GPUParticles2D_property_visibility_rect: .. rst-class:: classref-property :ref:`Rect2` **visibility_rect** = ``Rect2(-100, -100, 200, 200)`` .. rst-class:: classref-property-setget - void **set_visibility_rect** **(** :ref:`Rect2` value **)** - :ref:`Rect2` **get_visibility_rect** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_GPUParticles2D_method_capture_rect: .. rst-class:: classref-method :ref:`Rect2` **capture_rect** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GPUParticles2D_method_convert_from_particles: .. rst-class:: classref-method void **convert_from_particles** **(** :ref:`Node` particles **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GPUParticles2D_method_emit_particle: .. rst-class:: classref-method void **emit_particle** **(** :ref:`Transform2D` xform, :ref:`Vector2` velocity, :ref:`Color` color, :ref:`Color` custom, :ref:`int` flags **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GPUParticles2D_method_restart: .. rst-class:: classref-method void **restart** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |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.)`