Struct gdnative::api::Particles

pub struct Particles { /* fields omitted */ }

core class Particles inherits GeometryInstance (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.

Particles is a reference-only type. Persistent references can only exist in the unsafe Ref<Particles> 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

Particles inherits methods from:

• GeometryInstance
• VisualInstance
• Spatial
• 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 Particles

Constants

pub const DRAW_ORDER_INDEX: i64

pub const DRAW_ORDER_LIFETIME: i64

pub const DRAW_ORDER_VIEW_DEPTH: i64

pub const MAX_DRAW_PASSES: i64

impl Particles

pub fn new() -> Ref<Particles, 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_aabb(&self) -> Aabb

Returns the axis-aligned bounding box that contains all the particles that are active in the current frame.

pub fn amount(&self) -> i64

Number of particles to emit.

pub fn draw_order(&self) -> DrawOrder

Particle draw order. Uses [enum DrawOrder] values.

pub fn draw_pass_mesh(&self, pass: i64) -> Option<Ref<Mesh, Shared>>

[Mesh] that is drawn for the fourth draw pass.

pub fn draw_passes(&self) -> i64

The number of draw passes when rendering particles.

pub fn explosiveness_ratio(&self) -> f64

Time ratio between each emission. If [code]0[/code], particles are emitted continuously. If [code]1[/code], all particles are emitted simultaneously.

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 one_shot(&self) -> bool

If [code]true[/code], only [code]amount[/code] particles will be emitted.

pub fn pre_process_time(&self) -> f64

Amount of time to preprocess the particles before animation starts. Lets you start the animation some time after particles have started emitting.

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 randomness ratio.

pub fn speed_scale(&self) -> f64

Speed scaling ratio. A value of [code]0[/code] can be used to pause the particles.

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_aabb(&self) -> Aabb

The [AABB] that determines the area of the world part of which needs to be visible on screen for the particle system to be active.
			[b]Note:[/b] If the [ParticlesMaterial] in use is configured to cast shadows, you may want to enlarge this AABB to ensure the shadow is updated when particles are off-screen.

pub fn is_emitting(&self) -> bool

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

pub fn restart(&self)

Restarts the particle emission, clearing existing particles.

pub fn set_amount(&self, amount: i64)

Number of particles to emit.

pub fn set_draw_order(&self, order: i64)

Particle draw order. Uses [enum DrawOrder] values.

pub fn set_draw_pass_mesh(&self, pass: i64, mesh: impl AsArg<Mesh>)

[Mesh] that is drawn for the fourth draw pass.

pub fn set_draw_passes(&self, passes: i64)

The number of draw passes when rendering particles.

pub fn set_emitting(&self, emitting: bool)

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

pub fn set_explosiveness_ratio(&self, ratio: f64)

Time ratio between each emission. If [code]0[/code], particles are emitted continuously. If [code]1[/code], all particles are emitted simultaneously.

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_one_shot(&self, enable: bool)

If [code]true[/code], only [code]amount[/code] particles will be emitted.

pub fn set_pre_process_time(&self, secs: f64)

Amount of time to preprocess the particles before animation starts. Lets you start the animation some time after particles have started emitting.

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 randomness ratio.

pub fn set_speed_scale(&self, scale: f64)

Speed scaling ratio. A value of [code]0[/code] can be used to pause the particles.

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_aabb(&self, aabb: Aabb)

The [AABB] that determines the area of the world part of which needs to be visible on screen for the particle system to be active.
			[b]Note:[/b] If the [ParticlesMaterial] in use is configured to cast shadows, you may want to enlarge this AABB to ensure the shadow is updated when particles are off-screen.

Methods from Deref<Target = GeometryInstance>

pub const FLAG_DRAW_NEXT_FRAME_IF_VISIBLE: i64

pub const FLAG_MAX: i64

pub const FLAG_USE_BAKED_LIGHT: i64

pub const SHADOW_CASTING_SETTING_DOUBLE_SIDED: i64

pub const SHADOW_CASTING_SETTING_OFF: i64

pub const SHADOW_CASTING_SETTING_ON: i64

pub const SHADOW_CASTING_SETTING_SHADOWS_ONLY: i64

pub fn cast_shadows_setting(&self) -> ShadowCastingSetting

The selected shadow casting flag. See [enum ShadowCastingSetting] for possible values.

pub fn extra_cull_margin(&self) -> f64

The extra distance added to the GeometryInstance's bounding box ([AABB]) to increase its cull box.

pub fn flag(&self, flag: i64) -> bool

If [code]true[/code], this GeometryInstance will be used when baking lights using a [GIProbe] or [BakedLightmap].

pub fn lod_max_distance(&self) -> f64

The GeometryInstance's max LOD distance.
			[b]Note:[/b] This property currently has no effect.

pub fn lod_max_hysteresis(&self) -> f64

The GeometryInstance's max LOD margin.
			[b]Note:[/b] This property currently has no effect.

pub fn lod_min_distance(&self) -> f64

The GeometryInstance's min LOD distance.
			[b]Note:[/b] This property currently has no effect.

pub fn lod_min_hysteresis(&self) -> f64

The GeometryInstance's min LOD margin.
			[b]Note:[/b] This property currently has no effect.

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

The material override for the whole geometry.
			If a material is assigned to this property, it will be used instead of any material set in any material slot of the mesh.

pub fn set_cast_shadows_setting(&self, shadow_casting_setting: i64)

The selected shadow casting flag. See [enum ShadowCastingSetting] for possible values.

pub fn set_custom_aabb(&self, aabb: Aabb)

Overrides the bounding box of this node with a custom one. To remove it, set an [AABB] with all fields set to zero.

pub fn set_extra_cull_margin(&self, margin: f64)

The extra distance added to the GeometryInstance's bounding box ([AABB]) to increase its cull box.

pub fn set_flag(&self, flag: i64, value: bool)

If [code]true[/code], this GeometryInstance will be used when baking lights using a [GIProbe] or [BakedLightmap].

pub fn set_lod_max_distance(&self, mode: f64)

The GeometryInstance's max LOD distance.
			[b]Note:[/b] This property currently has no effect.

pub fn set_lod_max_hysteresis(&self, mode: f64)

The GeometryInstance's max LOD margin.
			[b]Note:[/b] This property currently has no effect.

pub fn set_lod_min_distance(&self, mode: f64)

The GeometryInstance's min LOD distance.
			[b]Note:[/b] This property currently has no effect.

pub fn set_lod_min_hysteresis(&self, mode: f64)

The GeometryInstance's min LOD margin.
			[b]Note:[/b] This property currently has no effect.

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

The material override for the whole geometry.
			If a material is assigned to this property, it will be used instead of any material set in any material slot of the mesh.

Trait Implementations

impl Debug for Particles

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

Formats the value using the given formatter.

impl Deref for Particles

type Target = GeometryInstance

The resulting type after dereferencing.

fn deref(&self) -> &GeometryInstance

Dereferences the value.

impl DerefMut for Particles

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

Mutably dereferences the value.

impl GodotObject for Particles

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 Particles

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

impl QueueFree for Particles

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<GeometryInstance> for Particles

impl SubClass<Node> for Particles

impl SubClass<Object> for Particles

impl SubClass<Spatial> for Particles

impl SubClass<VisualInstance> for Particles