Skip to main content

PlayLevelSoundAtPositionEvent

Struct PlayLevelSoundAtPositionEvent 

pub struct PlayLevelSoundAtPositionEvent<'a> {
    pub level: LevelRef,
    pub position: [f64; 3],
    pub sound: &'a mut Identifier,
    pub source: &'a mut SoundSource,
    pub volume: f32,
    pub pitch: f32,
    pub original_volume: f32,
    pub original_pitch: f32,
    pub cancelled: bool,
}
Expand description

What Hooks::play_level_sound_at_position is told. Each field is that hook’s argument of the same name, described in the hook’s doc.

Fields§

§level: LevelRef§position: [f64; 3]§sound: &'a mut Identifier§source: &'a mut SoundSource§volume: f32§pitch: f32§original_volume: f32§original_pitch: f32§cancelled: bool

Whether the event is cancelled: by the game or an earlier listener, or by this one setting it. Only a listener that receives cancelled events (#[listener(receive_cancelled)]) sees true, and setting it back to false lets the game’s behaviour run.

Auto Trait Implementations§

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> 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, 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.