UTheCat.Jumpvalley.Core.Music.MusicGroup Class Reference

Handles a Playlist that's in the form of nodes in a scene tree.
Each MusicGroup node must have a node as a direct child named "Music" that lists the directory (folder) paths of songs in its metadata.

There are two ways to specify songs that should be played:

songs array in metadata
The metadata (as mentioned above) has an array named songs that specifies the songs to play. The array's C# type should be Godot.Collections.Array.

Incremental songN metadata entries
This method is used when no songs array is present in the metadata. Multiple metadata entries should be specified in this format:
Entry name: songN where N represents the numerical index of the song package directory starting from 1. Songs are played in numerical order.
Entry value: The absolute path to the song's directory. (The value's type must be string.) More...

Inheritance diagram for UTheCat.Jumpvalley.Core.Music.MusicGroup:

Public Member Functions
	MusicGroup (Node node)
	Creates an instance of MusicGroup to represent a specified node.
new void	Dispose ()
	Disposes of this MusicGroup, including all of the Song instances associated with it.
Public Member Functions inherited from UTheCat.Jumpvalley.Core.Music.Playlist
void	Add (Song s)
	Adds a song to the playlist.
void	Remove (Song s)
	Removes a song from the playlist. If the song that gets removed is being played, the playlist will move onto the next song if there are still songs in the playlist after removal, or the playlist will stop immediately.
void	Play ()
	This method plays the first song in the playlist (the song in index 0) if no song in the playlist is currently being played. Otherwise, the playback of the current song is resumed and the linear volume of this playlist transitions back to (LinearVolume * LocalVolumeScale).
void	StopImmediately ()
	Stops the playback of the playlist immediately, skipping the fade out transition that gradually makes the playlist inaudible.
void	Stop ()
	This method gradually transitions the playlist's volume to be inaudible, and then stops the playlist once that transition is done.
new void	Dispose ()
	Stops and disposes of this Playlist.

Static Public Attributes
static readonly string	SONG_METADATA_ENTRY_PREFIX = "song"
	The prefix of the song metadata entry name within MusicListNode
static readonly string	SONGS_META_NAME = "songs"
	Name of the metadata entry storing the songs array.
static readonly string	MUSIC_LIST_NODE_NAME = "Music"
	The name of the node that contains the list of songs as metadata.

Properties
Node	ActualNode [get]
	The actual node that the MusicGroup is handling.
Node	MusicListNode [get]
	The node that uses node metadata to list the directory paths of song packages.
List< SongPackage >	SongPackages = new List<SongPackage>() [get]
	The song packages being played by this MusicGroup
Properties inherited from UTheCat.Jumpvalley.Core.Music.Playlist
static float	NonAudibleVolume = Mathf.DbToLinear(-80f) [get]
	Lowest audio volume (in the linear form) that Godot's editor will let you set the volume of a sound to. Such volume shouldn't be audible to humans.
double	LocalVolumeScale [get, set]
	Multiplier for linear volume that's typically in the range of [0, 1] Can be used to mute or unmute the playlist without affecting the original value of LinearVolume
double	LinearVolume [get, set]
	Volume of the playlist's music in a linear fashion.
Song	CurrentSong [get]
	The song that's currently being played in this playlist.

Additional Inherited Members
Public Types inherited from UTheCat.Jumpvalley.Core.Music.Playlist
enum	SongStreamHandlingModeFlags { Disabled = 0 , AddAndRemove = 1 }
	Enumerator that specifies how a Playlist should approach opening and closing the audio streams of its Song instances. More...
Static Public Member Functions inherited from UTheCat.Jumpvalley.Core.Music.Playlist
static float	VolPercentToDecibels (float percent)
	Converts a volume percentage in the range of [0, 1] to the corresponding value in decibels and returns the result.
Public Attributes inherited from UTheCat.Jumpvalley.Core.Music.Playlist
double	TransitionTime = 0
	The number of seconds that the volume transitioning lasts when uninterrupted.
SongStreamHandlingModeFlags	SongStreamHandlingMode
	How the playlist is currently opening and closing audio streams of its songs.
Protected Member Functions inherited from UTheCat.Jumpvalley.Core.Music.Playlist
void	HandleTweenFinish (object _o, EventArgs _e)
void	OnSongChanged (SongChangedArgs args)
void	RaiseStoppedEvent ()
Protected Attributes inherited from UTheCat.Jumpvalley.Core.Music.Playlist
List< Song >	SongList = new List<Song>()
	The list of Songs being played by this playlist.
Events inherited from UTheCat.Jumpvalley.Core.Music.Playlist
EventHandler< SongChangedArgs >	SongChanged
	Called when the currently playing song changes.
EventHandler	Stopped
	Called when the playlist stops the playback of its music. If a fade transition is applied to fade out the currently playing song, this event will get called after the transition has completed.

Detailed Description

Handles a Playlist that's in the form of nodes in a scene tree.
Each MusicGroup node must have a node as a direct child named "Music" that lists the directory (folder) paths of songs in its metadata.

There are two ways to specify songs that should be played:

songs array in metadata
The metadata (as mentioned above) has an array named songs that specifies the songs to play. The array's C# type should be Godot.Collections.Array.

Incremental songN metadata entries
This method is used when no songs array is present in the metadata. Multiple metadata entries should be specified in this format:
Entry name: songN where N represents the numerical index of the song package directory starting from 1. Songs are played in numerical order.
Entry value: The absolute path to the song's directory. (The value's type must be string.)

Constructor & Destructor Documentation

MusicGroup()

UTheCat.Jumpvalley.Core.Music.MusicGroup.MusicGroup ( Node node )

inline

Creates an instance of MusicGroup to represent a specified node.

Parameters

node	The node to represent

---

The documentation for this class was generated from the following file:

• MusicGroup.cs