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 Ptr::free, or Ptr::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 Ptr::free, or preferably Ptr::queue_free if it is a Node.

pub fn capture_aabb(&self) -> Aabb

pub fn amount(&self) -> i64

pub fn draw_order(&self) -> DrawOrder

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

pub fn draw_passes(&self) -> i64

pub fn explosiveness_ratio(&self) -> f64

pub fn fixed_fps(&self) -> i64

pub fn fractional_delta(&self) -> bool

pub fn lifetime(&self) -> f64

pub fn one_shot(&self) -> bool

pub fn pre_process_time(&self) -> f64

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

pub fn randomness_ratio(&self) -> f64

pub fn speed_scale(&self) -> f64

pub fn use_local_coordinates(&self) -> bool

pub fn visibility_aabb(&self) -> Aabb

pub fn is_emitting(&self) -> bool

pub fn restart(&self)

pub fn set_amount(&self, amount: i64)

pub fn set_draw_order(&self, order: i64)

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

pub fn set_draw_passes(&self, passes: i64)

pub fn set_emitting(&self, emitting: bool)

pub fn set_explosiveness_ratio(&self, ratio: f64)

pub fn set_fixed_fps(&self, fps: i64)

pub fn set_fractional_delta(&self, enable: bool)

pub fn set_lifetime(&self, secs: f64)

pub fn set_one_shot(&self, enable: bool)

pub fn set_pre_process_time(&self, secs: f64)

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

pub fn set_randomness_ratio(&self, ratio: f64)

pub fn set_speed_scale(&self, scale: f64)

pub fn set_use_local_coordinates(&self, enable: bool)

pub fn set_visibility_aabb(&self, aabb: Aabb)

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

pub fn extra_cull_margin(&self) -> f64

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

pub fn lod_max_distance(&self) -> f64

pub fn lod_max_hysteresis(&self) -> f64

pub fn lod_min_distance(&self) -> f64

pub fn lod_min_hysteresis(&self) -> f64

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

pub fn set_cast_shadows_setting(&self, shadow_casting_setting: i64)

pub fn set_custom_aabb(&self, aabb: Aabb)

pub fn set_extra_cull_margin(&self, margin: f64)

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

pub fn set_lod_max_distance(&self, mode: f64)

pub fn set_lod_max_hysteresis(&self, mode: f64)

pub fn set_lod_min_distance(&self, mode: f64)

pub fn set_lod_min_hysteresis(&self, mode: f64)

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

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