C# Class WaveEngine.Components.GameActions.PlaySoundGameAction

A game action to play a sound
Inheritance: GameAction, IUpdatableGameAction
Exibir arquivo Open project: WaveEngine/Components

Public Methods

Method Description
PlaySoundGameAction ( IGameAction parent, SoundInfo soundInfo, float volume = 1, bool loop = false ) : System

Initializes a new instance of the PlaySoundGameAction class.
PlaySoundGameAction ( SoundInfo soundInfo, Scene scene = null, float volume = 1, bool loop = false ) : System

Initializes a new instance of the PlaySoundGameAction class.
Update ( System.TimeSpan gameTime ) : void

Update the game action

Protected Methods

Method Description
PerformCancel ( ) : void

Perform cancel
PerformRun ( ) : void

Perform Run actions
PerformSkip ( ) : bool

Skip the action

Method Details

PerformCancel() protected method

Perform cancel
protected PerformCancel ( ) : void
return void

PerformRun() protected method

Perform Run actions
protected PerformRun ( ) : void
return void

PerformSkip() protected method

Skip the action
protected PerformSkip ( ) : bool
return bool

PlaySoundGameAction() public method

Initializes a new instance of the PlaySoundGameAction class.
public PlaySoundGameAction ( IGameAction parent, SoundInfo soundInfo, float volume = 1, bool loop = false ) : System
parent IGameAction The parent task.
soundInfo SoundInfo The sound info to play
volume float The sound volume
loop bool The sound loop is enabled
return System

PlaySoundGameAction() public method

Initializes a new instance of the PlaySoundGameAction class.
public PlaySoundGameAction ( SoundInfo soundInfo, Scene scene = null, float volume = 1, bool loop = false ) : System
soundInfo SoundInfo The sound info to play
scene Scene The scene.
volume float The sound volume
loop bool The sound loop is enabled
return System

Update() public method

Update the game action
public Update ( System.TimeSpan gameTime ) : void
gameTime System.TimeSpan The gameTime.
return void