TinyLifeWeb/docs/api/TinyLife.Music.yml

529 lines
17 KiB
YAML
Raw Permalink Normal View History

2022-10-18 13:03:11 +02:00
### YamlMime:ManagedReference
items:
- uid: TinyLife.Music
commentId: T:TinyLife.Music
id: Music
parent: TinyLife
children:
2023-10-25 14:35:54 +02:00
- TinyLife.Music.Duck(System.TimeSpan,System.Single)
2022-10-18 13:03:11 +02:00
- TinyLife.Music.Register(Microsoft.Xna.Framework.Media.Song,TinyLife.Music.Occasion[])
langs:
- csharp
- vb
name: Music
nameWithType: Music
fullName: TinyLife.Music
type: Class
source:
remote:
path: TinyLife/Music.cs
2023-12-06 13:25:52 +01:00
branch: main
2022-10-18 13:03:11 +02:00
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: Music
path: ../TinyLife/Music.cs
startLine: 15
assemblies:
- Tiny Life
namespace: TinyLife
2024-01-07 16:53:47 +01:00
summary: This class handles the game's in-game music. To register new music tracks for being selected, use <xref href="TinyLife.Music.Register(Microsoft.Xna.Framework.Media.Song%2cTinyLife.Music.Occasion%5b%5d)" data-throw-if-not-resolved="false"></xref>.
2022-10-18 13:03:11 +02:00
example: []
syntax:
content: public static class Music
content.vb: Public Module Music
inheritance:
- System.Object
inheritedMembers:
- System.Object.Equals(System.Object)
- System.Object.Equals(System.Object,System.Object)
- System.Object.GetHashCode
- System.Object.GetType
- System.Object.MemberwiseClone
- System.Object.ReferenceEquals(System.Object,System.Object)
- System.Object.ToString
- uid: TinyLife.Music.Register(Microsoft.Xna.Framework.Media.Song,TinyLife.Music.Occasion[])
commentId: M:TinyLife.Music.Register(Microsoft.Xna.Framework.Media.Song,TinyLife.Music.Occasion[])
id: Register(Microsoft.Xna.Framework.Media.Song,TinyLife.Music.Occasion[])
parent: TinyLife.Music
langs:
- csharp
- vb
2023-03-30 18:07:55 +02:00
name: Register(Song, params Occasion[])
nameWithType: Music.Register(Song, params Music.Occasion[])
fullName: TinyLife.Music.Register(Microsoft.Xna.Framework.Media.Song, params TinyLife.Music.Occasion[])
2022-10-18 13:03:11 +02:00
type: Method
source:
remote:
path: TinyLife/Music.cs
2023-12-06 13:25:52 +01:00
branch: main
2022-10-18 13:03:11 +02:00
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: Register
path: ../TinyLife/Music.cs
2023-10-25 14:35:54 +02:00
startLine: 45
2022-10-18 13:03:11 +02:00
assemblies:
- Tiny Life
namespace: TinyLife
2024-01-07 16:53:47 +01:00
summary: >-
Registers a new music track to be played at the given <code class="paramref">occasions</code>.
The music track will be added to the music pool and randomly selected for playing.
2022-10-18 13:03:11 +02:00
example: []
syntax:
content: public static void Register(Song song, params Music.Occasion[] occasions)
parameters:
- id: song
type: Microsoft.Xna.Framework.Media.Song
description: The song to play.
- id: occasions
type: TinyLife.Music.Occasion[]
description: The occasions that this song should be allowed to play on.
content.vb: Public Shared Sub Register(song As Song, ParamArray occasions As Music.Occasion())
overload: TinyLife.Music.Register*
exceptions:
- type: System.ArgumentException
commentId: T:System.ArgumentException
2024-01-07 16:53:47 +01:00
description: Thrown if <code class="paramref">occasions</code> is empty.
2023-03-30 18:07:55 +02:00
nameWithType.vb: Music.Register(Song, ParamArray Music.Occasion())
fullName.vb: TinyLife.Music.Register(Microsoft.Xna.Framework.Media.Song, ParamArray TinyLife.Music.Occasion())
name.vb: Register(Song, ParamArray Occasion())
2023-10-25 14:35:54 +02:00
- uid: TinyLife.Music.Duck(System.TimeSpan,System.Single)
commentId: M:TinyLife.Music.Duck(System.TimeSpan,System.Single)
id: Duck(System.TimeSpan,System.Single)
parent: TinyLife.Music
langs:
- csharp
- vb
name: Duck(TimeSpan, float)
nameWithType: Music.Duck(TimeSpan, float)
fullName: TinyLife.Music.Duck(System.TimeSpan, float)
type: Method
source:
remote:
path: TinyLife/Music.cs
2023-12-06 13:25:52 +01:00
branch: main
2023-10-25 14:35:54 +02:00
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: Duck
path: ../TinyLife/Music.cs
startLine: 63
assemblies:
- Tiny Life
namespace: TinyLife
2024-01-07 16:53:47 +01:00
summary: >-
Reduces the volume of the currently playing music to the given <code class="paramref">duckVolume</code> for the given amount of <code class="paramref">time</code>.
This is useful when playing a sound effect that is considered more important than the music.
2023-10-25 14:35:54 +02:00
example: []
syntax:
content: public static void Duck(TimeSpan time, float duckVolume)
parameters:
- id: time
type: System.TimeSpan
description: The amount of time to duck for.
- id: duckVolume
type: System.Single
description: The volume to duck the music to, which is automatically multiplied by <xref href="TinyLife.Options.MusicVolume" data-throw-if-not-resolved="false"></xref>.
content.vb: Public Shared Sub Duck(time As TimeSpan, duckVolume As Single)
overload: TinyLife.Music.Duck*
nameWithType.vb: Music.Duck(TimeSpan, Single)
fullName.vb: TinyLife.Music.Duck(System.TimeSpan, Single)
name.vb: Duck(TimeSpan, Single)
2022-10-18 13:03:11 +02:00
references:
- uid: TinyLife.Music.Register(Microsoft.Xna.Framework.Media.Song,TinyLife.Music.Occasion[])
commentId: M:TinyLife.Music.Register(Microsoft.Xna.Framework.Media.Song,TinyLife.Music.Occasion[])
isExternal: true
2024-01-07 16:53:47 +01:00
href: TinyLife.Music.html#TinyLife_Music_Register_Microsoft_Xna_Framework_Media_Song_TinyLife_Music_Occasion___
2023-03-30 18:07:55 +02:00
name: Register(Song, params Occasion[])
nameWithType: Music.Register(Song, params Music.Occasion[])
fullName: TinyLife.Music.Register(Microsoft.Xna.Framework.Media.Song, params TinyLife.Music.Occasion[])
nameWithType.vb: Music.Register(Song, ParamArray Music.Occasion())
fullName.vb: TinyLife.Music.Register(Microsoft.Xna.Framework.Media.Song, ParamArray TinyLife.Music.Occasion())
name.vb: Register(Song, ParamArray Occasion())
spec.csharp:
- uid: TinyLife.Music.Register(Microsoft.Xna.Framework.Media.Song,TinyLife.Music.Occasion[])
name: Register
2024-01-07 16:53:47 +01:00
href: TinyLife.Music.html#TinyLife_Music_Register_Microsoft_Xna_Framework_Media_Song_TinyLife_Music_Occasion___
2023-03-30 18:07:55 +02:00
- name: (
- uid: Microsoft.Xna.Framework.Media.Song
name: Song
isExternal: true
- name: ','
- name: " "
- name: params
- name: " "
- uid: TinyLife.Music.Occasion
name: Occasion
2024-01-07 16:53:47 +01:00
href: TinyLife.Music.Occasion.html
2023-03-30 18:07:55 +02:00
- name: '['
- name: ']'
- name: )
spec.vb:
- uid: TinyLife.Music.Register(Microsoft.Xna.Framework.Media.Song,TinyLife.Music.Occasion[])
name: Register
2024-01-07 16:53:47 +01:00
href: TinyLife.Music.html#TinyLife_Music_Register_Microsoft_Xna_Framework_Media_Song_TinyLife_Music_Occasion___
2023-03-30 18:07:55 +02:00
- name: (
- uid: Microsoft.Xna.Framework.Media.Song
name: Song
isExternal: true
- name: ','
- name: " "
- name: ParamArray
- name: " "
- uid: TinyLife.Music.Occasion
name: Occasion
2024-01-07 16:53:47 +01:00
href: TinyLife.Music.Occasion.html
2023-03-30 18:07:55 +02:00
- name: (
- name: )
- name: )
2022-10-18 13:03:11 +02:00
- uid: TinyLife
commentId: N:TinyLife
2024-01-07 16:53:47 +01:00
href: TinyLife.html
2022-10-18 13:03:11 +02:00
name: TinyLife
nameWithType: TinyLife
fullName: TinyLife
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object
name: object
nameWithType: object
fullName: object
nameWithType.vb: Object
fullName.vb: Object
name.vb: Object
2022-10-18 13:03:11 +02:00
- uid: System.Object.Equals(System.Object)
commentId: M:System.Object.Equals(System.Object)
parent: System.Object
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
name: Equals(object)
nameWithType: object.Equals(object)
fullName: object.Equals(object)
nameWithType.vb: Object.Equals(Object)
fullName.vb: Object.Equals(Object)
name.vb: Equals(Object)
2022-10-18 13:03:11 +02:00
spec.csharp:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
2022-10-18 13:03:11 +02:00
- name: (
- uid: System.Object
2023-03-30 18:07:55 +02:00
name: object
2022-10-18 13:03:11 +02:00
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object
2022-10-18 13:03:11 +02:00
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
2022-10-18 13:03:11 +02:00
- name: (
- uid: System.Object
name: Object
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object
2022-10-18 13:03:11 +02:00
- name: )
- uid: System.Object.Equals(System.Object,System.Object)
commentId: M:System.Object.Equals(System.Object,System.Object)
parent: System.Object
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
name: Equals(object, object)
nameWithType: object.Equals(object, object)
fullName: object.Equals(object, object)
nameWithType.vb: Object.Equals(Object, Object)
fullName.vb: Object.Equals(Object, Object)
name.vb: Equals(Object, Object)
2022-10-18 13:03:11 +02:00
spec.csharp:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
2022-10-18 13:03:11 +02:00
- name: (
- uid: System.Object
2023-03-30 18:07:55 +02:00
name: object
2022-10-18 13:03:11 +02:00
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
2022-10-18 13:03:11 +02:00
- uid: System.Object
2023-03-30 18:07:55 +02:00
name: object
2022-10-18 13:03:11 +02:00
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object
2022-10-18 13:03:11 +02:00
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
2022-10-18 13:03:11 +02:00
- name: (
- uid: System.Object
name: Object
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
2022-10-18 13:03:11 +02:00
- uid: System.Object
name: Object
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object
2022-10-18 13:03:11 +02:00
- name: )
- uid: System.Object.GetHashCode
commentId: M:System.Object.GetHashCode
parent: System.Object
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
2022-10-18 13:03:11 +02:00
name: GetHashCode()
2023-03-30 18:07:55 +02:00
nameWithType: object.GetHashCode()
fullName: object.GetHashCode()
nameWithType.vb: Object.GetHashCode()
fullName.vb: Object.GetHashCode()
2022-10-18 13:03:11 +02:00
spec.csharp:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
2022-10-18 13:03:11 +02:00
- name: (
- name: )
spec.vb:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
2022-10-18 13:03:11 +02:00
- name: (
- name: )
- uid: System.Object.GetType
commentId: M:System.Object.GetType
parent: System.Object
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
2022-10-18 13:03:11 +02:00
name: GetType()
2023-03-30 18:07:55 +02:00
nameWithType: object.GetType()
fullName: object.GetType()
nameWithType.vb: Object.GetType()
fullName.vb: Object.GetType()
2022-10-18 13:03:11 +02:00
spec.csharp:
- uid: System.Object.GetType
name: GetType
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
2022-10-18 13:03:11 +02:00
- name: (
- name: )
spec.vb:
- uid: System.Object.GetType
name: GetType
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
2022-10-18 13:03:11 +02:00
- name: (
- name: )
- uid: System.Object.MemberwiseClone
commentId: M:System.Object.MemberwiseClone
parent: System.Object
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
2022-10-18 13:03:11 +02:00
name: MemberwiseClone()
2023-03-30 18:07:55 +02:00
nameWithType: object.MemberwiseClone()
fullName: object.MemberwiseClone()
nameWithType.vb: Object.MemberwiseClone()
fullName.vb: Object.MemberwiseClone()
2022-10-18 13:03:11 +02:00
spec.csharp:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
2022-10-18 13:03:11 +02:00
- name: (
- name: )
spec.vb:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
2022-10-18 13:03:11 +02:00
- name: (
- name: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
parent: System.Object
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
name: ReferenceEquals(object, object)
nameWithType: object.ReferenceEquals(object, object)
fullName: object.ReferenceEquals(object, object)
nameWithType.vb: Object.ReferenceEquals(Object, Object)
fullName.vb: Object.ReferenceEquals(Object, Object)
name.vb: ReferenceEquals(Object, Object)
2022-10-18 13:03:11 +02:00
spec.csharp:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
2022-10-18 13:03:11 +02:00
- name: (
- uid: System.Object
2023-03-30 18:07:55 +02:00
name: object
2022-10-18 13:03:11 +02:00
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
2022-10-18 13:03:11 +02:00
- uid: System.Object
2023-03-30 18:07:55 +02:00
name: object
2022-10-18 13:03:11 +02:00
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object
2022-10-18 13:03:11 +02:00
- name: )
spec.vb:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
2022-10-18 13:03:11 +02:00
- name: (
- uid: System.Object
name: Object
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
2022-10-18 13:03:11 +02:00
- uid: System.Object
name: Object
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object
2022-10-18 13:03:11 +02:00
- name: )
- uid: System.Object.ToString
commentId: M:System.Object.ToString
parent: System.Object
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
2022-10-18 13:03:11 +02:00
name: ToString()
2023-03-30 18:07:55 +02:00
nameWithType: object.ToString()
fullName: object.ToString()
nameWithType.vb: Object.ToString()
fullName.vb: Object.ToString()
2022-10-18 13:03:11 +02:00
spec.csharp:
- uid: System.Object.ToString
name: ToString
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
2022-10-18 13:03:11 +02:00
- name: (
- name: )
spec.vb:
- uid: System.Object.ToString
name: ToString
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
2022-10-18 13:03:11 +02:00
- name: (
- name: )
- uid: System
commentId: N:System
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system
2022-10-18 13:03:11 +02:00
name: System
nameWithType: System
fullName: System
- uid: System.ArgumentException
commentId: T:System.ArgumentException
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.argumentexception
name: ArgumentException
nameWithType: ArgumentException
fullName: System.ArgumentException
2022-10-18 13:03:11 +02:00
- uid: TinyLife.Music.Register*
commentId: Overload:TinyLife.Music.Register
2024-01-07 16:53:47 +01:00
href: TinyLife.Music.html#TinyLife_Music_Register_Microsoft_Xna_Framework_Media_Song_TinyLife_Music_Occasion___
2022-10-18 13:03:11 +02:00
name: Register
nameWithType: Music.Register
fullName: TinyLife.Music.Register
- uid: Microsoft.Xna.Framework.Media.Song
commentId: T:Microsoft.Xna.Framework.Media.Song
parent: Microsoft.Xna.Framework.Media
isExternal: true
name: Song
nameWithType: Song
fullName: Microsoft.Xna.Framework.Media.Song
- uid: TinyLife.Music.Occasion[]
isExternal: true
2024-01-07 16:53:47 +01:00
href: TinyLife.Music.Occasion.html
2023-03-30 18:07:55 +02:00
name: Occasion[]
2022-10-18 13:03:11 +02:00
nameWithType: Music.Occasion[]
fullName: TinyLife.Music.Occasion[]
nameWithType.vb: Music.Occasion()
fullName.vb: TinyLife.Music.Occasion()
2023-03-30 18:07:55 +02:00
name.vb: Occasion()
2022-10-18 13:03:11 +02:00
spec.csharp:
- uid: TinyLife.Music.Occasion
2023-03-30 18:07:55 +02:00
name: Occasion
2024-01-07 16:53:47 +01:00
href: TinyLife.Music.Occasion.html
2023-03-30 18:07:55 +02:00
- name: '['
- name: ']'
2022-10-18 13:03:11 +02:00
spec.vb:
- uid: TinyLife.Music.Occasion
2023-03-30 18:07:55 +02:00
name: Occasion
2024-01-07 16:53:47 +01:00
href: TinyLife.Music.Occasion.html
2023-03-30 18:07:55 +02:00
- name: (
- name: )
2022-10-18 13:03:11 +02:00
- uid: Microsoft.Xna.Framework.Media
commentId: N:Microsoft.Xna.Framework.Media
isExternal: true
name: Microsoft.Xna.Framework.Media
nameWithType: Microsoft.Xna.Framework.Media
fullName: Microsoft.Xna.Framework.Media
2023-03-30 18:07:55 +02:00
spec.csharp:
- uid: Microsoft
name: Microsoft
isExternal: true
- name: .
- uid: Microsoft.Xna
name: Xna
isExternal: true
- name: .
- uid: Microsoft.Xna.Framework
name: Framework
isExternal: true
- name: .
- uid: Microsoft.Xna.Framework.Media
name: Media
isExternal: true
spec.vb:
- uid: Microsoft
name: Microsoft
isExternal: true
- name: .
- uid: Microsoft.Xna
name: Xna
isExternal: true
- name: .
- uid: Microsoft.Xna.Framework
name: Framework
isExternal: true
- name: .
- uid: Microsoft.Xna.Framework.Media
name: Media
isExternal: true
2023-10-25 14:35:54 +02:00
- uid: TinyLife.Options.MusicVolume
commentId: F:TinyLife.Options.MusicVolume
2024-01-07 16:53:47 +01:00
href: TinyLife.Options.html#TinyLife_Options_MusicVolume
2023-10-25 14:35:54 +02:00
name: MusicVolume
nameWithType: Options.MusicVolume
fullName: TinyLife.Options.MusicVolume
- uid: TinyLife.Music.Duck*
commentId: Overload:TinyLife.Music.Duck
2024-01-07 16:53:47 +01:00
href: TinyLife.Music.html#TinyLife_Music_Duck_System_TimeSpan_System_Single_
2023-10-25 14:35:54 +02:00
name: Duck
nameWithType: Music.Duck
fullName: TinyLife.Music.Duck
- uid: System.TimeSpan
commentId: T:System.TimeSpan
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.timespan
name: TimeSpan
nameWithType: TimeSpan
fullName: System.TimeSpan
- uid: System.Single
commentId: T:System.Single
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.single
name: float
nameWithType: float
fullName: float
nameWithType.vb: Single
fullName.vb: Single
name.vb: Single