Sound (functions)

From PMDOWiki
Revision as of 19:15, 26 November 2025 by Imbion (talk | contribs) (Created page with "{{Cleanup}} == SOUND:PlaySE(System.String) == Plays a sound effect === Arguments === * <code>name</code>: Sound file name, relative to the Content/SE folder == SOUND:PlayBattleSE(System.String) == Plays a sound effect specifically from the Battle/ subdirectory === Arguments === * <code>name</code>: Sound file name, relative to the Content/SE/Battle folder == SOUND:WaitSE == Plays a sound effect, and waits for it to complete before continuing. === Example...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
This article is in need of cleanup to increase its quality. You can help PMDO Wiki by improving it.


SOUND:PlaySE(System.String)

Plays a sound effect


Arguments

  • name: Sound file name, relative to the Content/SE folder

SOUND:PlayBattleSE(System.String)

Plays a sound effect specifically from the Battle/ subdirectory


Arguments

  • name: Sound file name, relative to the Content/SE/Battle folder

SOUND:WaitSE

Plays a sound effect, and waits for it to complete before continuing.


Example


SOUND:WaitSE("Battle/Hit")

SOUND:LoopSE(System.String)

Plays a continuous sound effect


Arguments

  • name: Sound file name, relative to the Content/SE folder

SOUND:LoopBattleSE(System.String)

Plays a continuous sound effect


Arguments

  • name: Sound file name, relative to the Content/SE/Battle folder

SOUND:StopSE(System.String)

Stops a continuous sound effect


Arguments

  • name: Sound file name, relative to the Content/SE folder

SOUND:StopBattleSE(System.String)

Stops a continuous sound effect


Arguments

  • name: Sound file name, relative to the Content/SE/Battle folder

SOUND:FadeInSE(System.String,System.Int32)

Plays a continuous sound effect, fading in over a specified amount of time


Arguments

  • name: Sound file name, relative to the Content/SE folder
  • fadeTime: Time in frames for the sound to fade in

SOUND:FadeInBattleSE(System.String,System.Int32)

Plays a continuous sound effect, fading in over a specified amount of time


Arguments

  • name: Sound file name, relative to the Content/SE/Battle folder
  • fadeTime: Time in frames for the sound to fade in

SOUND:FadeOutSE(System.String,System.Int32)

Stops a continuous sound effect, fading out over a specified amount of time


Arguments

  • name: Sound file name, relative to the Content/SE folder
  • fadeTime: Time in frames for the sound to fade out

SOUND:FadeOutBattleSE(System.String,System.Int32)

Stops a continuous sound effect, fading out over a specified amount of time


Arguments

  • name: Sound file name, relative to the Content/SE/Battle folder
  • fadeTime: Time in frames for the sound to fade out

SOUND:PlayFanfare(System.String)

Plays a sound effect that temporarily mutes the music for its duration


Arguments

  • name: Sound file name, relative to the Content/SE folder

SOUND:WaitFanfare

Plays a sound effect that temporarily mutes the music for its duration. This function waits for the sound to complete before continuing.


Example


SOUND:WaitFanfare("Battle/LevelUp")

SOUND:PlayBGM(System.String,System.Boolean,System.Int32)

Plays a song, replacing the current one.


Arguments

  • name: The file name of the song, relative to the Content/Music folder.
  • fade: Whether to fade the old song out, or start a new one.
  • fadeTime: The amount of time, in frames, to fade out the old song.

SOUND:StopBGM

Stops playing the current song.


SOUND:FadeOutBGM(System.Int32)

Fades out the current song.


Arguments

  • fadeTime: The amount of time, in frames, to fade out the song.

SOUND:SetBGMVolume(System.Single)

Sets the current volume of the song.


Arguments

  • val: A float value between 0 and 1

SOUND:GetCurrentSong

Gets the currently playing song. If the current song is fading out, gets the next song to be played.


Returns

The filename of the song, relative to the Content/Music folder