Struct gdnative::api::Particles2D

pub struct Particles2D { /* fields omitted */ }

core class Particles2D inherits Node2D (unsafe).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine.

Particles2D is a reference-only type. Persistent references can only exist in the unsafe Ref<Particles2D> form.

In the cases where Rust code owns an object of this type, for example if the object was just created on the Rust side and not passed to the engine yet, ownership should be either given to the engine or the object must be manually destroyed using Ref::free, or Ref::queue_free if it is a Node.

Class hierarchy

Particles2D inherits methods from:

• Node2D
• CanvasItem
• Node
• Object

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl Particles2D

Constants

pub const DRAW_ORDER_INDEX: i64

pub const DRAW_ORDER_LIFETIME: i64

impl Particles2D

pub fn new() -> Ref<Particles2D, Unique>

Creates a new instance of this object.

Because this type is not reference counted, the lifetime of the returned object is not automatically managed.

Immediately after creation, the object is owned by the caller, and can be passed to the engine (in which case the engine will be responsible for destroying the object) or destroyed manually using Ref::free, or preferably Ref::queue_free if it is a Node.

pub fn capture_rect(&self) -> Rect<f32, UnknownUnit>

Returns a rectangle containing the positions of all existing particles.

pub fn amount(&self) -> i64

Number of particles emitted in one emission cycle.

pub fn draw_order(&self) -> DrawOrder

Particle draw order. Uses [enum DrawOrder] values.

pub fn explosiveness_ratio(&self) -> f64

How rapidly particles in an emission cycle are emitted. If greater than [code]0[/code], there will be a gap in emissions before the next cycle begins.

pub fn fixed_fps(&self) -> i64

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.

pub fn fractional_delta(&self) -> bool

If [code]true[/code], results in fractional delta calculation which has a smoother particles display effect.

pub fn lifetime(&self) -> f64

Amount of time each particle will exist.

pub fn normal_map(&self) -> Option<Ref<Texture, Shared>>

Normal map to be used for the [member texture] property.
			[b]Note:[/b] Godot expects the normal map to use X+, Y-, and Z+ coordinates. See [url=http://wiki.polycount.com/wiki/Normal_Map_Technical_Details#Common_Swizzle_Coordinates]this page[/url] for a comparison of normal map coordinates expected by popular engines.

pub fn one_shot(&self) -> bool

If [code]true[/code], only one emission cycle occurs. If set [code]true[/code] during a cycle, emission will stop at the cycle's end.

pub fn pre_process_time(&self) -> f64

Particle system starts as if it had already run for this many seconds.

pub fn process_material(&self) -> Option<Ref<Material, Shared>>

[Material] for processing particles. Can be a [ParticlesMaterial] or a [ShaderMaterial].

pub fn randomness_ratio(&self) -> f64

Emission lifetime randomness ratio.

pub fn speed_scale(&self) -> f64

Particle system's running speed scaling ratio. A value of [code]0[/code] can be used to pause the particles.

pub fn texture(&self) -> Option<Ref<Texture, Shared>>

Particle texture. If [code]null[/code], particles will be squares.

pub fn use_local_coordinates(&self) -> bool

If [code]true[/code], particles use the parent node's coordinate space. If [code]false[/code], they use global coordinates.

pub fn visibility_rect(&self) -> Rect<f32, UnknownUnit>

Editor visibility helper.

pub fn is_emitting(&self) -> bool

If [code]true[/code], particles are being emitted.

pub fn restart(&self)

Restarts all the existing particles.

pub fn set_amount(&self, amount: i64)

Number of particles emitted in one emission cycle.

pub fn set_draw_order(&self, order: i64)

Particle draw order. Uses [enum DrawOrder] values.

pub fn set_emitting(&self, emitting: bool)

If [code]true[/code], particles are being emitted.

pub fn set_explosiveness_ratio(&self, ratio: f64)

How rapidly particles in an emission cycle are emitted. If greater than [code]0[/code], there will be a gap in emissions before the next cycle begins.

pub fn set_fixed_fps(&self, fps: i64)

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.

pub fn set_fractional_delta(&self, enable: bool)

If [code]true[/code], results in fractional delta calculation which has a smoother particles display effect.

pub fn set_lifetime(&self, secs: f64)

Amount of time each particle will exist.

pub fn set_normal_map(&self, texture: impl AsArg<Texture>)

Normal map to be used for the [member texture] property.
			[b]Note:[/b] Godot expects the normal map to use X+, Y-, and Z+ coordinates. See [url=http://wiki.polycount.com/wiki/Normal_Map_Technical_Details#Common_Swizzle_Coordinates]this page[/url] for a comparison of normal map coordinates expected by popular engines.

pub fn set_one_shot(&self, secs: bool)

If [code]true[/code], only one emission cycle occurs. If set [code]true[/code] during a cycle, emission will stop at the cycle's end.

pub fn set_pre_process_time(&self, secs: f64)

Particle system starts as if it had already run for this many seconds.

pub fn set_process_material(&self, material: impl AsArg<Material>)

[Material] for processing particles. Can be a [ParticlesMaterial] or a [ShaderMaterial].

pub fn set_randomness_ratio(&self, ratio: f64)

Emission lifetime randomness ratio.

pub fn set_speed_scale(&self, scale: f64)

Particle system's running speed scaling ratio. A value of [code]0[/code] can be used to pause the particles.

pub fn set_texture(&self, texture: impl AsArg<Texture>)

Particle texture. If [code]null[/code], particles will be squares.

pub fn set_use_local_coordinates(&self, enable: bool)

If [code]true[/code], particles use the parent node's coordinate space. If [code]false[/code], they use global coordinates.

pub fn set_visibility_rect(&self, visibility_rect: Rect<f32, UnknownUnit>)

Editor visibility helper.

Methods from Deref<Target = Node2D>

pub fn apply_scale(&self, ratio: Vector2D<f32, UnknownUnit>)

Multiplies the current scale by the [code]ratio[/code] vector.

pub fn get_angle_to(&self, point: Vector2D<f32, UnknownUnit>) -> f64

Returns the angle between the node and the [code]point[/code] in radians.

pub fn global_position(&self) -> Vector2D<f32, UnknownUnit>

Global position.

pub fn global_rotation(&self) -> f64

Global rotation in radians.

pub fn global_rotation_degrees(&self) -> f64

Global rotation in degrees.

pub fn global_scale(&self) -> Vector2D<f32, UnknownUnit>

Global scale.

pub fn position(&self) -> Vector2D<f32, UnknownUnit>

Position, relative to the node's parent.

pub fn get_relative_transform_to_parent(
    &self,
    parent: impl AsArg<Node>
) -> Transform2D<f32, UnknownUnit, UnknownUnit>

Returns the [Transform2D] relative to this node's parent.

pub fn rotation(&self) -> f64

Rotation in radians, relative to the node's parent.

pub fn rotation_degrees(&self) -> f64

Rotation in degrees, relative to the node's parent.

pub fn scale(&self) -> Vector2D<f32, UnknownUnit>

The node's scale. Unscaled value: [code](1, 1)[/code].

pub fn z_index(&self) -> i64

Z index. Controls the order in which the nodes render. A node with a higher Z index will display in front of others.

pub fn global_translate(&self, offset: Vector2D<f32, UnknownUnit>)

Adds the [code]offset[/code] vector to the node's global position.

pub fn is_z_relative(&self) -> bool

If [code]true[/code], the node's Z index is relative to its parent's Z index. If this node's Z index is 2 and its parent's effective Z index is 3, then this node's effective Z index will be 2 + 3 = 5.

pub fn look_at(&self, point: Vector2D<f32, UnknownUnit>)

Rotates the node so it points towards the [code]point[/code], which is expected to use global coordinates.

pub fn move_local_x(&self, delta: f64, scaled: bool)

Applies a local translation on the node's X axis based on the [method Node._process]'s [code]delta[/code]. If [code]scaled[/code] is [code]false[/code], normalizes the movement.

Default Arguments

• scaled - false

pub fn move_local_y(&self, delta: f64, scaled: bool)

Applies a local translation on the node's Y axis based on the [method Node._process]'s [code]delta[/code]. If [code]scaled[/code] is [code]false[/code], normalizes the movement.

Default Arguments

• scaled - false

pub fn rotate(&self, radians: f64)

Applies a rotation to the node, in radians, starting from its current rotation.

pub fn set_global_position(&self, position: Vector2D<f32, UnknownUnit>)

Global position.

pub fn set_global_rotation(&self, radians: f64)

Global rotation in radians.

pub fn set_global_rotation_degrees(&self, degrees: f64)

Global rotation in degrees.

pub fn set_global_scale(&self, scale: Vector2D<f32, UnknownUnit>)

Global scale.

pub fn set_global_transform(
    &self,
    xform: Transform2D<f32, UnknownUnit, UnknownUnit>
)

Global [Transform2D].

pub fn set_position(&self, position: Vector2D<f32, UnknownUnit>)

Position, relative to the node's parent.

pub fn set_rotation(&self, radians: f64)

Rotation in radians, relative to the node's parent.

pub fn set_rotation_degrees(&self, degrees: f64)

Rotation in degrees, relative to the node's parent.

pub fn set_scale(&self, scale: Vector2D<f32, UnknownUnit>)

The node's scale. Unscaled value: [code](1, 1)[/code].

pub fn set_transform(&self, xform: Transform2D<f32, UnknownUnit, UnknownUnit>)

Local [Transform2D].

pub fn set_z_as_relative(&self, enable: bool)

If [code]true[/code], the node's Z index is relative to its parent's Z index. If this node's Z index is 2 and its parent's effective Z index is 3, then this node's effective Z index will be 2 + 3 = 5.

pub fn set_z_index(&self, z_index: i64)

Z index. Controls the order in which the nodes render. A node with a higher Z index will display in front of others.

pub fn to_global(
    &self,
    local_point: Vector2D<f32, UnknownUnit>
) -> Vector2D<f32, UnknownUnit>

Transforms the provided local position into a position in global coordinate space. The input is expected to be local relative to the [Node2D] it is called on. e.g. Applying this method to the positions of child nodes will correctly transform their positions into the global coordinate space, but applying it to a node's own position will give an incorrect result, as it will incorporate the node's own transformation into its global position.

pub fn to_local(
    &self,
    global_point: Vector2D<f32, UnknownUnit>
) -> Vector2D<f32, UnknownUnit>

Transforms the provided global position into a position in local coordinate space. The output will be local relative to the [Node2D] it is called on. e.g. It is appropriate for determining the positions of child nodes, but it is not appropriate for determining its own position relative to its parent.

pub fn translate(&self, offset: Vector2D<f32, UnknownUnit>)

Translates the node by the given [code]offset[/code] in local coordinates.

Trait Implementations

impl Debug for Particles2D

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for Particles2D

type Target = Node2D

The resulting type after dereferencing.

fn deref(&self) -> &Node2D

Dereferences the value.

impl DerefMut for Particles2D

fn deref_mut(&mut self) -> &mut Node2D

Mutably dereferences the value.

impl GodotObject for Particles2D

type RefKind = ManuallyManaged

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for Particles2D

fn construct() -> Ref<Particles2D, Unique>

impl QueueFree for Particles2D

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<CanvasItem> for Particles2D

impl SubClass<Node> for Particles2D

impl SubClass<Node2D> for Particles2D

impl SubClass<Object> for Particles2D