Struct ParticleProcessMaterial

#[repr(C)]
pub struct ParticleProcessMaterial { /* private fields */ }

Godot class ParticleProcessMaterial.

Inherits Material.

Related symbols:

• particle_process_material: sidecar module with related enum/flag types
• IParticleProcessMaterial: virtual methods

See also Godot docs for ParticleProcessMaterial.

Construction

This class is reference-counted. You can create a new instance using ParticleProcessMaterial::new_gd().

Implementations

impl ParticleProcessMaterial

pub fn set_direction(&mut self, degrees: Vector3)

pub fn get_direction(&self) -> Vector3

pub fn set_inherit_velocity_ratio(&mut self, ratio: f64)

pub fn get_inherit_velocity_ratio(&mut self) -> f64

pub fn set_spread(&mut self, degrees: f32)

pub fn get_spread(&self) -> f32

pub fn set_flatness(&mut self, amount: f32)

pub fn get_flatness(&self) -> f32

pub fn set_param(&mut self, param: Parameter, value: Vector2)

pub fn get_param(&self, param: Parameter) -> Vector2

pub fn set_param_min(&mut self, param: Parameter, value: f32)

pub fn get_param_min(&self, param: Parameter) -> f32

pub fn set_param_max(&mut self, param: Parameter, value: f32)

pub fn get_param_max(&self, param: Parameter) -> f32

pub fn set_param_texture( &mut self, param: Parameter, texture: impl AsObjectArg<Texture2D>, )

pub fn get_param_texture(&self, param: Parameter) -> Option<Gd<Texture2D>>

pub fn set_color(&mut self, color: Color)

pub fn get_color(&self) -> Color

pub fn set_color_ramp(&mut self, ramp: impl AsObjectArg<Texture2D>)

pub fn get_color_ramp(&self) -> Option<Gd<Texture2D>>

pub fn set_alpha_curve(&mut self, curve: impl AsObjectArg<Texture2D>)

pub fn get_alpha_curve(&self) -> Option<Gd<Texture2D>>

pub fn set_emission_curve(&mut self, curve: impl AsObjectArg<Texture2D>)

pub fn get_emission_curve(&self) -> Option<Gd<Texture2D>>

pub fn set_color_initial_ramp(&mut self, ramp: impl AsObjectArg<Texture2D>)

pub fn get_color_initial_ramp(&self) -> Option<Gd<Texture2D>>

pub fn set_velocity_limit_curve(&mut self, curve: impl AsObjectArg<Texture2D>)

pub fn get_velocity_limit_curve(&self) -> Option<Gd<Texture2D>>

pub fn set_particle_flag(&mut self, particle_flag: ParticleFlags, enable: bool)

pub fn get_particle_flag(&self, particle_flag: ParticleFlags) -> bool

pub fn set_velocity_pivot(&mut self, pivot: Vector3)

pub fn get_velocity_pivot(&mut self) -> Vector3

pub fn set_emission_shape(&mut self, shape: EmissionShape)

pub fn get_emission_shape(&self) -> EmissionShape

pub fn set_emission_sphere_radius(&mut self, radius: f32)

pub fn get_emission_sphere_radius(&self) -> f32

pub fn set_emission_box_extents(&mut self, extents: Vector3)

pub fn get_emission_box_extents(&self) -> Vector3

pub fn set_emission_point_texture( &mut self, texture: impl AsObjectArg<Texture2D>, )

pub fn get_emission_point_texture(&self) -> Option<Gd<Texture2D>>

pub fn set_emission_normal_texture( &mut self, texture: impl AsObjectArg<Texture2D>, )

pub fn get_emission_normal_texture(&self) -> Option<Gd<Texture2D>>

pub fn set_emission_color_texture( &mut self, texture: impl AsObjectArg<Texture2D>, )

pub fn get_emission_color_texture(&self) -> Option<Gd<Texture2D>>

pub fn set_emission_point_count(&mut self, point_count: i32)

pub fn get_emission_point_count(&self) -> i32

pub fn set_emission_ring_axis(&mut self, axis: Vector3)

pub fn get_emission_ring_axis(&self) -> Vector3

pub fn set_emission_ring_height(&mut self, height: f32)

pub fn get_emission_ring_height(&self) -> f32

pub fn set_emission_ring_radius(&mut self, radius: f32)

pub fn get_emission_ring_radius(&self) -> f32

pub fn set_emission_ring_inner_radius(&mut self, inner_radius: f32)

pub fn get_emission_ring_inner_radius(&self) -> f32

pub fn set_emission_shape_offset(&mut self, emission_shape_offset: Vector3)

pub fn get_emission_shape_offset(&self) -> Vector3

pub fn set_emission_shape_scale(&mut self, emission_shape_scale: Vector3)

pub fn get_emission_shape_scale(&self) -> Vector3

pub fn get_turbulence_enabled(&self) -> bool

pub fn set_turbulence_enabled(&mut self, turbulence_enabled: bool)

pub fn get_turbulence_noise_strength(&self) -> f32

pub fn set_turbulence_noise_strength(&mut self, turbulence_noise_strength: f32)

pub fn get_turbulence_noise_scale(&self) -> f32

pub fn set_turbulence_noise_scale(&mut self, turbulence_noise_scale: f32)

pub fn get_turbulence_noise_speed_random(&self) -> f32

pub fn set_turbulence_noise_speed_random( &mut self, turbulence_noise_speed_random: f32, )

pub fn get_turbulence_noise_speed(&self) -> Vector3

pub fn set_turbulence_noise_speed(&mut self, turbulence_noise_speed: Vector3)

pub fn get_gravity(&self) -> Vector3

pub fn set_gravity(&mut self, accel_vec: Vector3)

pub fn set_lifetime_randomness(&mut self, randomness: f64)

pub fn get_lifetime_randomness(&self) -> f64

pub fn get_sub_emitter_mode(&self) -> SubEmitterMode

pub fn set_sub_emitter_mode(&mut self, mode: SubEmitterMode)

pub fn get_sub_emitter_frequency(&self) -> f64

pub fn set_sub_emitter_frequency(&mut self, hz: f64)

pub fn get_sub_emitter_amount_at_end(&self) -> i32

pub fn set_sub_emitter_amount_at_end(&mut self, amount: i32)

pub fn get_sub_emitter_amount_at_collision(&self) -> i32

pub fn set_sub_emitter_amount_at_collision(&mut self, amount: i32)

pub fn get_sub_emitter_keep_velocity(&self) -> bool

pub fn set_sub_emitter_keep_velocity(&mut self, enable: bool)

pub fn set_attractor_interaction_enabled(&mut self, enabled: bool)

pub fn is_attractor_interaction_enabled(&self) -> bool

pub fn set_collision_mode(&mut self, mode: CollisionMode)

pub fn get_collision_mode(&self) -> CollisionMode

pub fn set_collision_use_scale(&mut self, radius: bool)

pub fn is_collision_using_scale(&self) -> bool

pub fn set_collision_friction(&mut self, friction: f32)

pub fn get_collision_friction(&self) -> f32

pub fn set_collision_bounce(&mut self, bounce: f32)

pub fn get_collision_bounce(&self) -> f32

Methods from Deref<Target = Material>

pub const RENDER_PRIORITY_MAX: i32 = 127i32

pub const RENDER_PRIORITY_MIN: i32 = -128i32

pub fn set_next_pass(&mut self, next_pass: impl AsObjectArg<Material>)

pub fn get_next_pass(&self) -> Option<Gd<Material>>

pub fn set_render_priority(&mut self, priority: i32)

pub fn get_render_priority(&self) -> i32

pub fn inspect_native_shader_code(&mut self)

pub fn create_placeholder(&self) -> Option<Gd<Resource>>

Methods from Deref<Target = Resource>

pub fn set_path(&mut self, path: GString)

pub fn take_over_path(&mut self, path: GString)

pub fn get_path(&self) -> GString

pub fn set_name(&mut self, name: GString)

pub fn get_name(&self) -> GString

pub fn get_rid(&self) -> Rid

pub fn set_local_to_scene(&mut self, enable: bool)

pub fn is_local_to_scene(&self) -> bool

pub fn get_local_scene(&self) -> Option<Gd<Node>>

pub fn setup_local_to_scene(&mut self)

pub fn set_scene_unique_id(&mut self, id: GString)

pub fn get_scene_unique_id(&self) -> GString

pub fn emit_changed(&mut self)

pub fn duplicate(&self) -> Option<Gd<Resource>>

To set the default parameters, use Self::duplicate_ex and its builder methods. See the book for detailed usage instructions.

pub fn duplicate_ex<'a>(&'a self) -> ExDuplicate<'a>

Methods from Deref<Target = RefCounted>

pub fn get_reference_count(&self) -> i32

Methods from Deref<Target = Object>

pub fn get_class(&self) -> GString

pub fn is_class(&self, class: GString) -> bool

pub fn set(&mut self, property: StringName, value: &Variant)

pub fn get(&self, property: StringName) -> Variant

pub fn set_indexed(&mut self, property_path: NodePath, value: &Variant)

pub fn get_indexed(&self, property_path: NodePath) -> Variant

pub fn get_property_list(&self) -> Array<Dictionary>

pub fn get_method_list(&self) -> Array<Dictionary>

pub fn property_can_revert(&self, property: StringName) -> bool

pub fn property_get_revert(&self, property: StringName) -> Variant

pub fn set_script(&mut self, script: &Variant)

pub fn get_script(&self) -> Variant

pub fn set_meta(&mut self, name: StringName, value: &Variant)

pub fn remove_meta(&mut self, name: StringName)

pub fn get_meta(&self, name: StringName) -> Variant

To set the default parameters, use Self::get_meta_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_meta_ex<'a>(&'a self, name: StringName) -> ExGetMeta<'a>

pub fn has_meta(&self, name: StringName) -> bool

pub fn get_meta_list(&self) -> Array<StringName>

pub fn add_user_signal(&mut self, signal: GString)

To set the default parameters, use Self::add_user_signal_ex and its builder methods. See the book for detailed usage instructions.

pub fn add_user_signal_ex<'a>( &'a mut self, signal: GString, ) -> ExAddUserSignal<'a>

pub fn has_user_signal(&self, signal: StringName) -> bool

pub fn remove_user_signal(&mut self, signal: StringName)

pub fn emit_signal(&mut self, signal: StringName, varargs: &[Variant]) -> Error

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_emit_signal( &mut self, signal: StringName, varargs: &[Variant], ) -> Result<Error, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call(&mut self, method: StringName, varargs: &[Variant]) -> Variant

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call( &mut self, method: StringName, varargs: &[Variant], ) -> Result<Variant, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call_deferred( &mut self, method: StringName, varargs: &[Variant], ) -> Variant

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call_deferred( &mut self, method: StringName, varargs: &[Variant], ) -> Result<Variant, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn set_deferred(&mut self, property: StringName, value: &Variant)

pub fn callv( &mut self, method: StringName, arg_array: &Array<Variant>, ) -> Variant

pub fn has_method(&self, method: StringName) -> bool

pub fn get_method_argument_count(&self, method: StringName) -> i32

pub fn has_signal(&self, signal: StringName) -> bool

pub fn get_signal_list(&self) -> Array<Dictionary>

pub fn get_signal_connection_list( &self, signal: StringName, ) -> Array<Dictionary>

pub fn get_incoming_connections(&self) -> Array<Dictionary>

pub fn connect(&mut self, signal: StringName, callable: Callable) -> Error

To set the default parameters, use Self::connect_ex and its builder methods. See the book for detailed usage instructions.

pub fn connect_ex<'a>( &'a mut self, signal: StringName, callable: Callable, ) -> ExConnect<'a>

pub fn disconnect(&mut self, signal: StringName, callable: Callable)

pub fn is_connected(&self, signal: StringName, callable: Callable) -> bool

pub fn set_block_signals(&mut self, enable: bool)

pub fn is_blocking_signals(&self) -> bool

pub fn notify_property_list_changed(&mut self)

pub fn set_message_translation(&mut self, enable: bool)

pub fn can_translate_messages(&self) -> bool

pub fn tr(&self, message: StringName) -> GString

To set the default parameters, use Self::tr_ex and its builder methods. See the book for detailed usage instructions.

pub fn tr_ex<'a>(&'a self, message: StringName) -> ExTr<'a>

pub fn tr_n( &self, message: StringName, plural_message: StringName, n: i32, ) -> GString

To set the default parameters, use Self::tr_n_ex and its builder methods. See the book for detailed usage instructions.

pub fn tr_n_ex<'a>( &'a self, message: StringName, plural_message: StringName, n: i32, ) -> ExTrN<'a>

pub fn is_queued_for_deletion(&self) -> bool

pub fn cancel_free(&mut self)

pub fn notify(&mut self, what: ObjectNotification)

⚠️ Sends a Godot notification to all classes inherited by the object.

Triggers calls to on_notification(), and depending on the notification, also to Godot’s lifecycle callbacks such as ready().

Starts from the highest ancestor (the Object class) and goes down the hierarchy. See also Godot docs for Object::notification().

Panics

If you call this method on a user-defined object while holding a GdRef or GdMut guard on the instance, you will encounter a panic. The reason is that the receiving virtual method on_notification() acquires a GdMut lock dynamically, which must be exclusive.

pub fn notify_reversed(&mut self, what: ObjectNotification)

⚠️ Like Self::notify(), but starts at the most-derived class and goes up the hierarchy.

See docs of that method, including the panics.

Trait Implementations

impl Bounds for ParticleProcessMaterial

type Memory = MemRefCounted

Defines the memory strategy of the static type.

type Declarer = DeclEngine

Whether this class is a core Godot class provided by the engine, or declared by the user as a Rust struct.

impl Debug for ParticleProcessMaterial

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

Formats the value using the given formatter.

impl Deref for ParticleProcessMaterial

type Target = Material

The resulting type after dereferencing.

fn deref(&self) -> &<ParticleProcessMaterial as Deref>::Target

Dereferences the value.

impl DerefMut for ParticleProcessMaterial

fn deref_mut(&mut self) -> &mut <ParticleProcessMaterial as Deref>::Target

Mutably dereferences the value.

impl GodotClass for ParticleProcessMaterial

const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene

Initialization level, during which this class should be initialized with Godot.

type Base = Material

The immediate superclass of T. This is always a Godot engine class.

fn class_name() -> ClassName

The name of the class, under which it is registered in Godot.

fn inherits<U>() -> bool

where U: GodotClass,

Returns whether Self inherits from U.

impl GodotDefault for ParticleProcessMaterial

impl Inherits<Material> for ParticleProcessMaterial

impl Inherits<Object> for ParticleProcessMaterial

impl Inherits<RefCounted> for ParticleProcessMaterial

impl Inherits<Resource> for ParticleProcessMaterial