Worst-case scenario: the UEd Goblin wipes the map and burns down your house.

UE2:StreamPlaylist (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT2004 Object >> StreamBase >> StreamPlaylist
Package: 
Engine

Created on: 10/12/2003 A user-configured list of streaming music files.

Written by Ron Prestenback © 2003, Epic Games, Inc. All Rights Reserved

Properties[edit]

Property group 'StreamPlaylist'[edit]

bNeedSave[edit]

Type: bool

Modifiers: protected, config


Default value: True

Current[edit]

Type: int

Modifiers: protected, config


FileManager[edit]

Type: StreamInterface

Modifiers: editinline, editconst, noexport, protected


Playlist[edit]

Type: array<string>

Modifiers: protected, config


RandomPool[edit]

Type: array<int>

Modifiers: editinline, editconst, noexport, private, editconstarray, transient


Songs[edit]

Type: array<Stream>

Modifiers: editinline, editconst, noexport, protected, editconstarray


Title[edit]

Type: string

Modifiers: protected


Delegates[edit]

OnPlaylistChanged[edit]

delegate OnPlaylistChanged ()


Instance functions[edit]

AddSong[edit]

function int AddSong (string SongFileName, optional bool bSkipNotification)


AddStream[edit]

function int AddStream (int Index, Stream NewStream, optional bool bSkipNotification)


ClearPlaylist[edit]

function bool ClearPlaylist ()


CreateStream[edit]

function Stream CreateStream (string FileName)


DebugInfo[edit]

function DebugInfo ()


FindIndexByFileName[edit]

function int FindIndexByFileName (string Test)


FindIndexByFullName[edit]

function int FindIndexByFullName (string Test)


FindIndexByName[edit]

function int FindIndexByName (string Test)


FindIndexByPath[edit]

function int FindIndexByPath (string Test)


GetCurrent[edit]

function int GetCurrent ()


GetCurrentStream[edit]

function Stream GetCurrentStream ()


GetPlaylistLength[edit]

function int GetPlaylistLength ()


GetRandomSong[edit]

function string GetRandomSong ()


GetSongs[edit]

function GetSongs (out array<StreamSongArray)


GetStream[edit]

function Stream GetStream (string StreamName)


GetStreamAt[edit]

function Stream GetStreamAt (int Index)


GetTitle[edit]

function string GetTitle ()


HandleDebugExec[edit]

function bool HandleDebugExec (string Command, string Param)

Overrides: StreamBase.HandleDebugExec


InitializePlaylist[edit]

function bool InitializePlaylist (StreamInterface InManager)


InsertSong[edit]

function int InsertSong (int idx, string Path, optional bool bSkipNotification)


IsInitialized[edit]

function bool IsInitialized ()


LoadPlaylist[edit]

function bool LoadPlaylist ()


NextSong[edit]

function string NextSong (bool bMayRepeat)


PrevSong[edit]

function string PrevSong (bool bMayRepeat)


RemoveSong[edit]

function bool RemoveSong (string SongFileName, optional bool bSkipNotification)


RemoveSongAt[edit]

function bool RemoveSongAt (int idx, optional bool bSkipNotification)


ReplaceWith[edit]

function ReplaceWith (StreamPlaylist Other)


ResetRandomPool[edit]

function ResetRandomPool ()


Save[edit]

function Save ()


SetCurrent[edit]

function bool SetCurrent (int Index)


SetSongs[edit]

function bool SetSongs (array<StreamNewSongs)


SetTitle[edit]

function bool SetTitle (string NewTitle)


ValidStreamIndex[edit]

function bool ValidStreamIndex (int Index)


ValidStreamName[edit]

function bool ValidStreamName (string FileName)