Files
Crash-Course/Documentation/api/Music.MusicManager.yml

296 lines
7.7 KiB
YAML
Raw Normal View History

2025-04-16 19:20:36 -04:00
### YamlMime:ManagedReference
items:
2025-04-16 19:57:54 -04:00
- uid: Music.MusicManager
commentId: T:Music.MusicManager
2025-04-16 19:20:36 -04:00
id: MusicManager
2025-04-16 19:57:54 -04:00
parent: Music
2025-04-16 19:20:36 -04:00
children:
2025-04-16 19:57:54 -04:00
- Music.MusicManager.GetActiveSceneNotTitleScreen
- Music.MusicManager.Instance
- Music.MusicManager.playlists
- Music.MusicManager.songPrefab
- Music.MusicManager.StartPlaylist
- Music.MusicManager.StartPlaylist(System.String)
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: MusicManager
nameWithType: MusicManager
2025-04-16 19:57:54 -04:00
fullName: Music.MusicManager
2025-04-16 19:20:36 -04:00
type: Class
source:
id: MusicManager
path: ''
2025-04-19 12:59:07 -04:00
startLine: 306
2025-04-16 19:20:36 -04:00
assemblies:
- cs.temp.dll
2025-04-16 19:57:54 -04:00
namespace: Music
2025-04-18 20:11:19 -04:00
summary: "\nManages the music playlists for the game.\nHandles the initialization, playback, and shuffling of music tracks based on the active scene.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: 'public class MusicManager : MonoBehaviour'
content.vb: Public Class MusicManager Inherits MonoBehaviour
inheritance:
- System.Object
2025-04-16 19:57:54 -04:00
- uid: Music.MusicManager.Instance
commentId: F:Music.MusicManager.Instance
2025-04-16 19:20:36 -04:00
id: Instance
2025-04-16 19:57:54 -04:00
parent: Music.MusicManager
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: Instance
nameWithType: MusicManager.Instance
2025-04-16 19:57:54 -04:00
fullName: Music.MusicManager.Instance
2025-04-16 19:20:36 -04:00
type: Field
source:
id: Instance
path: ''
2025-04-19 12:59:07 -04:00
startLine: 312
2025-04-16 19:20:36 -04:00
assemblies:
- cs.temp.dll
2025-04-16 19:57:54 -04:00
namespace: Music
2025-04-18 20:11:19 -04:00
summary: "\nA singleton instance of the <xref href=\"Music.MusicManager\" data-throw-if-not-resolved=\"false\"></xref> class.\nEnsures only one instance of the MusicManager exists at a time.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public static MusicManager Instance
return:
2025-04-16 19:57:54 -04:00
type: Music.MusicManager
2025-04-16 19:20:36 -04:00
content.vb: Public Shared Instance As MusicManager
2025-04-16 19:57:54 -04:00
- uid: Music.MusicManager.playlists
commentId: F:Music.MusicManager.playlists
2025-04-16 19:20:36 -04:00
id: playlists
2025-04-16 19:57:54 -04:00
parent: Music.MusicManager
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: playlists
nameWithType: MusicManager.playlists
2025-04-16 19:57:54 -04:00
fullName: Music.MusicManager.playlists
2025-04-16 19:20:36 -04:00
type: Field
source:
id: playlists
path: ''
2025-04-19 12:59:07 -04:00
startLine: 317
2025-04-16 19:20:36 -04:00
assemblies:
- cs.temp.dll
2025-04-16 19:57:54 -04:00
namespace: Music
2025-04-18 20:11:19 -04:00
summary: "\nA list of playlists available in the game.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public List<Playlist> playlists
return:
2025-04-16 19:57:54 -04:00
type: Global.List{Music.Playlist}
2025-04-16 19:20:36 -04:00
content.vb: Public playlists As List(Of Playlist)
2025-04-16 19:57:54 -04:00
- uid: Music.MusicManager.songPrefab
commentId: F:Music.MusicManager.songPrefab
2025-04-16 19:20:36 -04:00
id: songPrefab
2025-04-16 19:57:54 -04:00
parent: Music.MusicManager
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: songPrefab
nameWithType: MusicManager.songPrefab
2025-04-16 19:57:54 -04:00
fullName: Music.MusicManager.songPrefab
2025-04-16 19:20:36 -04:00
type: Field
source:
id: songPrefab
path: ''
2025-04-19 12:59:07 -04:00
startLine: 327
2025-04-16 19:20:36 -04:00
assemblies:
- cs.temp.dll
2025-04-16 19:57:54 -04:00
namespace: Music
2025-04-18 20:11:19 -04:00
summary: "\nThe prefab used to create audio sources for playing songs.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public GameObject songPrefab
return:
type: Global.GameObject
content.vb: Public songPrefab As GameObject
2025-04-16 19:57:54 -04:00
- uid: Music.MusicManager.StartPlaylist
commentId: M:Music.MusicManager.StartPlaylist
2025-04-16 19:20:36 -04:00
id: StartPlaylist
2025-04-16 19:57:54 -04:00
parent: Music.MusicManager
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: StartPlaylist()
nameWithType: MusicManager.StartPlaylist()
2025-04-16 19:57:54 -04:00
fullName: Music.MusicManager.StartPlaylist()
2025-04-16 19:20:36 -04:00
type: Method
source:
id: StartPlaylist
path: ''
2025-04-19 12:59:07 -04:00
startLine: 355
2025-04-16 19:20:36 -04:00
assemblies:
- cs.temp.dll
2025-04-16 19:57:54 -04:00
namespace: Music
2025-04-18 20:11:19 -04:00
summary: "\nStarts the music playlist for the current active scene.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public void StartPlaylist()
content.vb: Public Sub StartPlaylist()
2025-04-16 19:57:54 -04:00
overload: Music.MusicManager.StartPlaylist*
- uid: Music.MusicManager.StartPlaylist(System.String)
commentId: M:Music.MusicManager.StartPlaylist(System.String)
2025-04-16 19:20:36 -04:00
id: StartPlaylist(System.String)
2025-04-16 19:57:54 -04:00
parent: Music.MusicManager
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: StartPlaylist(string)
nameWithType: MusicManager.StartPlaylist(string)
2025-04-16 19:57:54 -04:00
fullName: Music.MusicManager.StartPlaylist(string)
2025-04-16 19:20:36 -04:00
type: Method
source:
id: StartPlaylist
path: ''
2025-04-19 12:59:07 -04:00
startLine: 379
2025-04-16 19:20:36 -04:00
assemblies:
- cs.temp.dll
2025-04-16 19:57:54 -04:00
namespace: Music
2025-04-18 20:11:19 -04:00
summary: "\nStarts the music playlist for a specific scene.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public void StartPlaylist(string scene)
parameters:
- id: scene
type: System.String
2025-04-18 20:11:19 -04:00
description: The name of the scene for which to start the playlist.
2025-04-16 19:20:36 -04:00
content.vb: Public Sub StartPlaylist(scene As String)
2025-04-16 19:57:54 -04:00
overload: Music.MusicManager.StartPlaylist*
2025-04-16 19:20:36 -04:00
nameWithType.vb: MusicManager.StartPlaylist(String)
2025-04-16 19:57:54 -04:00
fullName.vb: Music.MusicManager.StartPlaylist(String)
2025-04-16 19:20:36 -04:00
name.vb: StartPlaylist(String)
2025-04-16 19:57:54 -04:00
- uid: Music.MusicManager.GetActiveSceneNotTitleScreen
commentId: M:Music.MusicManager.GetActiveSceneNotTitleScreen
2025-04-16 19:20:36 -04:00
id: GetActiveSceneNotTitleScreen
2025-04-16 19:57:54 -04:00
parent: Music.MusicManager
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: GetActiveSceneNotTitleScreen()
nameWithType: MusicManager.GetActiveSceneNotTitleScreen()
2025-04-16 19:57:54 -04:00
fullName: Music.MusicManager.GetActiveSceneNotTitleScreen()
2025-04-16 19:20:36 -04:00
type: Method
source:
id: GetActiveSceneNotTitleScreen
path: ''
2025-04-19 12:59:07 -04:00
startLine: 444
2025-04-16 19:20:36 -04:00
assemblies:
- cs.temp.dll
2025-04-16 19:57:54 -04:00
namespace: Music
2025-04-18 20:11:19 -04:00
summary: "\nGets the name of the currently active scene, excluding the &quot;Title Screen&quot;.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public static string GetActiveSceneNotTitleScreen()
return:
type: System.String
2025-04-18 20:11:19 -04:00
description: The name of the active scene, or &quot;Title Screen&quot; if no other scene is active.
2025-04-16 19:20:36 -04:00
content.vb: Public Shared Function GetActiveSceneNotTitleScreen() As String
2025-04-16 19:57:54 -04:00
overload: Music.MusicManager.GetActiveSceneNotTitleScreen*
2025-04-16 19:20:36 -04:00
references:
2025-04-16 19:57:54 -04:00
- uid: Music
commentId: N:Music
name: Music
nameWithType: Music
fullName: Music
2025-04-16 19:20:36 -04:00
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
name: object
nameWithType: object
fullName: object
nameWithType.vb: Object
fullName.vb: Object
name.vb: Object
- uid: System
commentId: N:System
isExternal: true
name: System
nameWithType: System
fullName: System
2025-04-16 19:57:54 -04:00
- uid: Music.MusicManager
commentId: T:Music.MusicManager
parent: Music
2025-04-16 19:20:36 -04:00
name: MusicManager
nameWithType: MusicManager
2025-04-16 19:57:54 -04:00
fullName: Music.MusicManager
- uid: Global.List{Music.Playlist}
commentId: '!:Global.List{Music.Playlist}'
2025-04-16 19:20:36 -04:00
definition: Global.List`1
name: List<Playlist>
nameWithType: List<Playlist>
2025-04-16 19:57:54 -04:00
fullName: List<Music.Playlist>
2025-04-16 19:20:36 -04:00
nameWithType.vb: List(Of Playlist)
2025-04-16 19:57:54 -04:00
fullName.vb: List(Of Music.Playlist)
2025-04-16 19:20:36 -04:00
name.vb: List(Of Playlist)
spec.csharp:
- uid: Global.List`1
name: List
isExternal: true
- name: <
2025-04-16 19:57:54 -04:00
- uid: Music.Playlist
2025-04-16 19:20:36 -04:00
name: Playlist
- name: '>'
spec.vb:
- uid: Global.List`1
name: List
isExternal: true
- name: (
- name: Of
- name: " "
2025-04-16 19:57:54 -04:00
- uid: Music.Playlist
2025-04-16 19:20:36 -04:00
name: Playlist
- name: )
- uid: Global.List`1
isExternal: true
name: List<>
nameWithType: List<>
fullName: List<>
nameWithType.vb: List(Of )
fullName.vb: List(Of )
name.vb: List(Of )
spec.csharp:
- uid: Global.List`1
name: List
isExternal: true
- name: <
- name: ''
- name: '>'
spec.vb:
- uid: Global.List`1
name: List
isExternal: true
- name: (
- name: Of
- name: " "
- name: ''
- name: )
- uid: Global.GameObject
isExternal: true
name: GameObject
nameWithType: GameObject
fullName: GameObject
2025-04-16 19:57:54 -04:00
- uid: Music.MusicManager.StartPlaylist*
commentId: Overload:Music.MusicManager.StartPlaylist
2025-04-16 19:20:36 -04:00
name: StartPlaylist
nameWithType: MusicManager.StartPlaylist
2025-04-16 19:57:54 -04:00
fullName: Music.MusicManager.StartPlaylist
2025-04-16 19:20:36 -04:00
- uid: System.String
commentId: T:System.String
parent: System
isExternal: true
name: string
nameWithType: string
fullName: string
nameWithType.vb: String
fullName.vb: String
name.vb: String
2025-04-16 19:57:54 -04:00
- uid: Music.MusicManager.GetActiveSceneNotTitleScreen*
commentId: Overload:Music.MusicManager.GetActiveSceneNotTitleScreen
2025-04-16 19:20:36 -04:00
name: GetActiveSceneNotTitleScreen
nameWithType: MusicManager.GetActiveSceneNotTitleScreen
2025-04-16 19:57:54 -04:00
fullName: Music.MusicManager.GetActiveSceneNotTitleScreen