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

208 lines
5.2 KiB
YAML
Raw Permalink Normal View History

2025-04-16 19:20:36 -04:00
### YamlMime:ManagedReference
items:
2025-04-16 19:57:54 -04:00
- uid: Music.AudioManager
commentId: T:Music.AudioManager
2025-04-16 19:20:36 -04:00
id: AudioManager
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.AudioManager.Instance
- Music.AudioManager.PlaySound(System.String)
- Music.AudioManager.soundEffects
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: AudioManager
nameWithType: AudioManager
2025-04-16 19:57:54 -04:00
fullName: Music.AudioManager
2025-04-16 19:20:36 -04:00
type: Class
source:
id: AudioManager
path: ''
2025-04-19 12:59:07 -04:00
startLine: 1205
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: "\nThis class manages the playback of sound effects in the game.\nIt provides functionality to play specific sounds by name and ensures a singleton instance for global access.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: 'public class AudioManager : MonoBehaviour'
content.vb: Public Class AudioManager Inherits MonoBehaviour
inheritance:
- System.Object
2025-04-16 19:57:54 -04:00
- uid: Music.AudioManager.soundEffects
commentId: F:Music.AudioManager.soundEffects
2025-04-16 19:20:36 -04:00
id: soundEffects
2025-04-16 19:57:54 -04:00
parent: Music.AudioManager
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: soundEffects
nameWithType: AudioManager.soundEffects
2025-04-16 19:57:54 -04:00
fullName: Music.AudioManager.soundEffects
2025-04-16 19:20:36 -04:00
type: Field
source:
id: soundEffects
path: ''
2025-04-19 12:59:07 -04:00
startLine: 1210
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 all sound effects managed by the AudioManager.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public List<SoundEffect> soundEffects
return:
2025-04-16 19:57:54 -04:00
type: Global.List{Music.SoundEffect}
2025-04-16 19:20:36 -04:00
content.vb: Public soundEffects As List(Of SoundEffect)
2025-04-16 19:57:54 -04:00
- uid: Music.AudioManager.Instance
commentId: F:Music.AudioManager.Instance
2025-04-16 19:20:36 -04:00
id: Instance
2025-04-16 19:57:54 -04:00
parent: Music.AudioManager
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: Instance
nameWithType: AudioManager.Instance
2025-04-16 19:57:54 -04:00
fullName: Music.AudioManager.Instance
2025-04-16 19:20:36 -04:00
type: Field
source:
id: Instance
path: ''
2025-04-19 12:59:07 -04:00
startLine: 1215
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 singleton instance of the <xref href=\"Music.AudioManager\" data-throw-if-not-resolved=\"false\"></xref> class.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public static AudioManager Instance
return:
2025-04-16 19:57:54 -04:00
type: Music.AudioManager
2025-04-16 19:20:36 -04:00
content.vb: Public Shared Instance As AudioManager
2025-04-16 19:57:54 -04:00
- uid: Music.AudioManager.PlaySound(System.String)
commentId: M:Music.AudioManager.PlaySound(System.String)
2025-04-16 19:20:36 -04:00
id: PlaySound(System.String)
2025-04-16 19:57:54 -04:00
parent: Music.AudioManager
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: PlaySound(string)
nameWithType: AudioManager.PlaySound(string)
2025-04-16 19:57:54 -04:00
fullName: Music.AudioManager.PlaySound(string)
2025-04-16 19:20:36 -04:00
type: Method
source:
id: PlaySound
path: ''
2025-04-19 12:59:07 -04:00
startLine: 1252
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: "\nPlays a sound effect by its name.\n"
remarks: "\nIf the sound name is &quot;Punch,&quot; it plays multiple punch-related sound effects.\nIf the sound is not found, a warning is logged to the console.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public void PlaySound(string soundName)
parameters:
- id: soundName
type: System.String
2025-04-18 20:11:19 -04:00
description: The name of the sound effect to play.
2025-04-16 19:20:36 -04:00
content.vb: Public Sub PlaySound(soundName As String)
2025-04-16 19:57:54 -04:00
overload: Music.AudioManager.PlaySound*
2025-04-16 19:20:36 -04:00
nameWithType.vb: AudioManager.PlaySound(String)
2025-04-16 19:57:54 -04:00
fullName.vb: Music.AudioManager.PlaySound(String)
2025-04-16 19:20:36 -04:00
name.vb: PlaySound(String)
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: Global.List{Music.SoundEffect}
commentId: '!:Global.List{Music.SoundEffect}'
2025-04-16 19:20:36 -04:00
definition: Global.List`1
name: List<SoundEffect>
nameWithType: List<SoundEffect>
2025-04-16 19:57:54 -04:00
fullName: List<Music.SoundEffect>
2025-04-16 19:20:36 -04:00
nameWithType.vb: List(Of SoundEffect)
2025-04-16 19:57:54 -04:00
fullName.vb: List(Of Music.SoundEffect)
2025-04-16 19:20:36 -04:00
name.vb: List(Of SoundEffect)
spec.csharp:
- uid: Global.List`1
name: List
isExternal: true
- name: <
2025-04-16 19:57:54 -04:00
- uid: Music.SoundEffect
2025-04-16 19:20:36 -04:00
name: SoundEffect
- 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.SoundEffect
2025-04-16 19:20:36 -04:00
name: SoundEffect
- 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: )
2025-04-16 19:57:54 -04:00
- uid: Music.AudioManager
commentId: T:Music.AudioManager
parent: Music
2025-04-16 19:20:36 -04:00
name: AudioManager
nameWithType: AudioManager
2025-04-16 19:57:54 -04:00
fullName: Music.AudioManager
- uid: Music.AudioManager.PlaySound*
commentId: Overload:Music.AudioManager.PlaySound
2025-04-16 19:20:36 -04:00
name: PlaySound
nameWithType: AudioManager.PlaySound
2025-04-16 19:57:54 -04:00
fullName: Music.AudioManager.PlaySound
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