[−][src]Struct pokemon_rust::audio::Music

pub struct Music {
    storage: HashMap<String, SourceHandle>,
    changed_bgm: bool,
    active_bgm: Option<Cycle<IntoIter<SourceHandle>>>,
}

A type responsible for controlling the current background music (BGM). BGMs are played in a loop as long as they aren't changed. Internally, it contains a storage with every loaded BGM file. Files can also be preloaded to be played later.

Fields

storage: HashMap<String, SourceHandle>changed_bgm: boolactive_bgm: Option<Cycle<IntoIter<SourceHandle>>>

Methods

`impl Music`[src]

`pub fn play_bgm( &mut self, bgm: String, format: AudioFileFormat, loader: &Loader, storage: &AssetStorage<Source> )`[src]

Sets a BGM file as the active BGM.

`pub fn preload_bgm( &mut self, bgm: String, format: AudioFileFormat, loader: &Loader, storage: &AssetStorage<Source> )`[src]

Preloads a BGM for future playback.

`pub fn changed_bgm(&self) -> bool`[src]

Checks if the active BGM has been changed since the last call to next().

`pub fn next(&mut self) -> Option<SourceHandle>`[src]

Returns the active BGM, if any.

Trait Implementations

`impl Default for Music`[src]

`fn default() -> Music`[src]

Auto Trait Implementations

`impl RefUnwindSafe for Music`

`impl Send for Music`

`impl Sync for Music`

`impl Unpin for Music`

`impl UnwindSafe for Music`

Blanket Implementations

`impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where D: AdaptFrom<S, Swp, Dwp, T>, Dwp: WhitePoint, Swp: WhitePoint, T: Component + Float,` [src]

`fn adapt_into_using<M>(self, method: M) -> D where M: TransformMatrix<Swp, Dwp, T>,` [src]

`fn adapt_into(self) -> D`[src]

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T> Any for T where T: Any,`

`fn get_type_id(&self) -> TypeId`

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> Erased for T`

`impl<T> Event for T where T: Send + Sync + 'static,`

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> Into for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> Resource for T where T: Any + Send + Sync,`

`impl<T> Same<T> for T`

`type Output = T`

Should always be Self

`impl<T> SetParameter for T`

`fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where T: Parameter<Self>,`

`impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,`

`fn to_subset(&self) -> Option<SS>`

`fn is_in_subset(&self) -> bool`

`unsafe fn to_subset_unchecked(&self) -> SS`

`fn from_subset(element: &SS) -> SP`

`impl<T> Supports<T> for T`

`impl<T> TryDefault for T where T: Default,`

`fn try_default() -> Result<T, String>`

`fn unwrap_default() -> Self`

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

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

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

`fn try_into(self) -> Result<U, >::Error>`[src]

`impl<V, T> VZip<V> for T where V: MultiLane<T>,`

`fn vzip(self) -> V`

[−][src]Struct pokemon_rust::audio::Music

Fields

Methods

impl Music[src]

pub fn play_bgm( &mut self, bgm: String, format: AudioFileFormat, loader: &Loader, storage: &AssetStorage<Source>)[src]

pub fn preload_bgm( &mut self, bgm: String, format: AudioFileFormat, loader: &Loader, storage: &AssetStorage<Source>)[src]

pub fn changed_bgm(&self) -> bool[src]

pub fn next(&mut self) -> Option<SourceHandle>[src]

Trait Implementations

impl Default for Music[src]

fn default() -> Music[src]

Auto Trait Implementations

impl RefUnwindSafe for Music

impl Send for Music

impl Sync for Music

impl Unpin for Music

impl UnwindSafe for Music

Blanket Implementations

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where D: AdaptFrom<S, Swp, Dwp, T>, Dwp: WhitePoint, Swp: WhitePoint, T: Component + Float, [src]

fn adapt_into_using<M>(self, method: M) -> D where M: TransformMatrix<Swp, Dwp, T>, [src]

fn adapt_into(self) -> D[src]

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

fn type_id(&self) -> TypeId[src]

impl<T> Any for T where T: Any,

fn get_type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized, [src]

fn borrow(&self) -> &T[src]

impl<T> BorrowMut<T> for T where T: ?Sized, [src]

fn borrow_mut(&mut self) -> &mut T[src]

impl<T> Erased for T

impl<T> Event for T where T: Send + Sync + 'static,

impl<T> From<T> for T[src]

fn from(t: T) -> T[src]

impl<T, U> Into<U> for T where U: From<T>, [src]

fn into(self) -> U[src]

impl<T> Resource for T where T: Any + Send + Sync,

impl<T> Same<T> for T

type Output = T

impl<T> SetParameter for T

fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where T: Parameter<Self>,

impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

fn is_in_subset(&self) -> bool

unsafe fn to_subset_unchecked(&self) -> SS

fn from_subset(element: &SS) -> SP

impl<T> Supports<T> for T

impl<T> TryDefault for T where T: Default,

fn try_default() -> Result<T, String>

fn unwrap_default() -> Self

impl<T, U> TryFrom<U> for T where U: Into<T>, [src]

type Error = Infallible

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

impl<T, U> TryInto<U> for T where U: TryFrom<T>, [src]

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

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

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V