Feel  3.16
The best way to improve your game's feel and make it extra juicy
MoreMountains.Tools.MMSMPlaylist Class Reference
Inheritance diagram for MoreMountains.Tools.MMSMPlaylist:

Public Types

enum  PlayModes { PlayModes.PlayForever, PlayModes.PlayOnce, PlayModes.PlayXTimes }
 
enum  PlayOrders { PlayOrders.Normal, PlayOrders.ReverseOrder, PlayOrders.Random, PlayOrders.RandomUnique }
 

Public Member Functions

virtual void Initialization ()
 On init, we initialize all our songs More...
 
virtual int PickNextIndex (int direction, int currentSongIndex, ref int queuedSongIndex)
 Picks the index of the next song to play, returns the index of the song, or -2 if the end of the playlist's been reached, and -1 if the player should go idle More...
 
virtual void ResetPlayCount ()
 Resets the playlist's play count and the playcount of all songs More...
 

Public Attributes

MMSoundManager.MMSoundManagerTracks Track = MMSoundManager.MMSoundManagerTracks.Music
 the sound manager track on which to play this playlist's songs More...
 
PlayOrders PlayOrder = PlayOrders.Normal
 the order in which to play songs (top to bottom, bottom to top, random, or random while trying to maintain playcount across songs More...
 
bool RandomizeOrderSeed = true
 if this is true, random seed will be randomized by the system clock More...
 
PlayModes PlayMode = PlayModes.PlayForever
 whether to play this playlist forever, only once, or play songs until total playcount reaches MaxAmountOfPlays More...
 
int MaxAmountOfPlays = 10
 when in PlayXTimes mode, the max amount of plays before this playlist ends More...
 
MMSMPlaylist NextPlaylist
 a playlist to switch to when reaching the end of this playlist More...
 
List< MMSMPlaylistSongSongs
 the list of songs to play on this playlist More...
 
int PlayCount
 the total number of times songs in this playlist have been played More...
 

Protected Member Functions

virtual void OnValidate ()
 On Validate we initialize our options More...
 

Protected Attributes

List< int > _randomUniqueCandidates
 

Member Enumeration Documentation

◆ PlayModes

Enumerator
PlayForever 
PlayOnce 
PlayXTimes 

◆ PlayOrders

Enumerator
Normal 
ReverseOrder 
Random 
RandomUnique 

Member Function Documentation

◆ Initialization()

virtual void MoreMountains.Tools.MMSMPlaylist.Initialization ( )
virtual

On init, we initialize all our songs

◆ OnValidate()

virtual void MoreMountains.Tools.MMSMPlaylist.OnValidate ( )
protectedvirtual

On Validate we initialize our options

◆ PickNextIndex()

virtual int MoreMountains.Tools.MMSMPlaylist.PickNextIndex ( int  direction,
int  currentSongIndex,
ref int  queuedSongIndex 
)
virtual

Picks the index of the next song to play, returns the index of the song, or -2 if the end of the playlist's been reached, and -1 if the player should go idle

Parameters
direction
Returns
-2 : end of playlist -1 : go to idle 0+ : next index to play in the playlist

◆ ResetPlayCount()

virtual void MoreMountains.Tools.MMSMPlaylist.ResetPlayCount ( )
virtual

Resets the playlist's play count and the playcount of all songs

Member Data Documentation

◆ _randomUniqueCandidates

List<int> MoreMountains.Tools.MMSMPlaylist._randomUniqueCandidates
protected

◆ MaxAmountOfPlays

int MoreMountains.Tools.MMSMPlaylist.MaxAmountOfPlays = 10

when in PlayXTimes mode, the max amount of plays before this playlist ends

◆ NextPlaylist

MMSMPlaylist MoreMountains.Tools.MMSMPlaylist.NextPlaylist

a playlist to switch to when reaching the end of this playlist

◆ PlayCount

int MoreMountains.Tools.MMSMPlaylist.PlayCount

the total number of times songs in this playlist have been played

◆ PlayMode

PlayModes MoreMountains.Tools.MMSMPlaylist.PlayMode = PlayModes.PlayForever

whether to play this playlist forever, only once, or play songs until total playcount reaches MaxAmountOfPlays

◆ PlayOrder

PlayOrders MoreMountains.Tools.MMSMPlaylist.PlayOrder = PlayOrders.Normal

the order in which to play songs (top to bottom, bottom to top, random, or random while trying to maintain playcount across songs

◆ RandomizeOrderSeed

bool MoreMountains.Tools.MMSMPlaylist.RandomizeOrderSeed = true

if this is true, random seed will be randomized by the system clock

◆ Songs

List<MMSMPlaylistSong> MoreMountains.Tools.MMSMPlaylist.Songs

the list of songs to play on this playlist

◆ Track

the sound manager track on which to play this playlist's songs


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