Skip to main content

Sound

Struct Sound 

Source
pub struct Sound {
Show 13 fields pub name: &'static str, pub allow_random_repeat: Option<bool>, pub audible_distance_modifier: Option<f64>, pub filename: Option<&'static str>, pub max_speed: Option<f64>, pub max_volume: Option<f64>, pub min_speed: Option<f64>, pub min_volume: Option<f64>, pub preload: Option<bool>, pub priority: Option<i64>, pub speed: Option<f64>, pub speed_smoothing_window_size: Option<i64>, pub volume: Option<f64>,
}
Expand description

Minimal SoundPrototype for data.extend.

Specifies a sound that can be used with SoundPath at runtime.

type = "sound" is injected by the Lua generator.

Fields§

§name: &'static str

Name of the sound. Can be used as a SoundPath at runtime.

§allow_random_repeat: Option<bool>

Prototype property allow_random_repeat.

§audible_distance_modifier: Option<f64>

Modifies how far a sound can be heard. Must be between 0 and 1 inclusive.

§filename: Option<&'static str>

Supported sound file formats are .ogg (Vorbis and Opus) and .wav.

Only loaded, and mandatory if variations is not defined.

§max_speed: Option<f64>

Must be >= min_speed.

Only loaded if variations is not defined. Only loaded, and mandatory if min_speed is defined.

§max_volume: Option<f64>

Only loaded if variations is not defined.

Only loaded if min_volume is defined.

Must be >= min_volume.

§min_speed: Option<f64>

Must be >= 1 / 64.

Only loaded if both variations and speed are not defined.

§min_volume: Option<f64>

Only loaded if variations and volume are not defined.

Must be >= 0.

§preload: Option<bool>

Only loaded if variations is not defined.

§priority: Option<i64>

Sounds with higher priority will replace a sound with lower priority if the maximum sounds limit is reached.

0 is the highest priority, 255 is the lowest priority.

§speed: Option<f64>

Speed must be >= 1 / 64. This sets both min and max speeds.

Only loaded if variations is not defined.

§speed_smoothing_window_size: Option<i64>

Prototype property speed_smoothing_window_size.

§volume: Option<f64>

Only loaded if variations is not defined.

This sets both min and max volumes.

Must be >= 0.

Trait Implementations§

Source§

impl Clone for Sound

Source§

fn clone(&self) -> Sound

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for Sound

Source§

impl Debug for Sound

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Sound

Source§

fn default() -> Sound

Returns the “default value” for a type. Read more
Source§

impl PartialEq for Sound

Source§

fn eq(&self, other: &Sound) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Sound

Auto Trait Implementations§

§

impl Freeze for Sound

§

impl RefUnwindSafe for Sound

§

impl Send for Sound

§

impl Sync for Sound

§

impl Unpin for Sound

§

impl UnsafeUnpin for Sound

§

impl UnwindSafe for Sound

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.