| BackgroundMusic Class |
A component that plays background music.
Note: having multiple active background music components will just override each other.
Inheritance HierarchySystemObject
GeonBit.ECS.ComponentsIComponent
GeonBit.ECS.ComponentsBaseComponent
GeonBit.ECS.Components.SoundBackgroundMusic
GeonBit.ECS.ComponentsIComponent
GeonBit.ECS.ComponentsBaseComponent
GeonBit.ECS.Components.SoundBackgroundMusic
Namespace: GeonBit.ECS.Components.Sound
Assembly: GeonBit (in GeonBit.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
public class BackgroundMusic : BaseComponent
The BackgroundMusic type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | BackgroundMusic |
Create the Background Music component.
|
Properties| Name | Description | |
|---|---|---|
 | _GameObject |
Get the game object this component is attached to.
(Inherited from BaseComponent.) |
| Enabled |
Is this component currently enabled.
(Inherited from BaseComponent.) |
| IsActiveMusic |
Return if this background music component is the currently active background music.
|
| IsPlaying |
Return if this background music object is the music currently playing and not paused.
|
| IsRepeating |
If true will play this music in a loop.
|
| MusicAssetPath |
The background music asset path.
|
| Name |
Get / set the name of this component.
(Inherited from IComponent.) |
| Volume |
Background music volume.
|
Methods| Name | Description | |
|---|---|---|
| Clone |
Clone this background music component.
(Overrides BaseComponentClone.) |
| CollisionEnd |
Called when this physical body stop colliding with another body.
(Inherited from BaseComponent.) |
| CollisionProcess |
Called while this physical body is colliding with another body.
(Inherited from BaseComponent.) |
| CollisionStart |
Called when this physical body start colliding with another body.
(Inherited from BaseComponent.) |
| Destroy |
Destroy this component.
(Inherited from BaseComponent.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| FixedUpdate |
Just like Update(), but called every constant amount of time regardless of FPS and Vsync.
(Inherited from BaseComponent.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetImplementedFrameBasedEvents |
Get a list of frame-based events this component implements.
(Inherited from BaseComponent.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| HasMethodImplemented |
Return if this component has a method implemented.
(Inherited from BaseComponent.) |
| Heartbeat |
An event that triggers every X miliseconds (defined per GameObject instance).
(Inherited from BaseComponent.) |
| Pause |
Pause the background music (will affect only if currently playing this music).
|
| Play |
Play the background music (will replace currently playing music).
|
| RemoveFromParent |
Remove this component from parent.
(Inherited from BaseComponent.) |
| Resume |
Resume the music (will affect only if currently playing this music).
|
| SendMessage |
Send message to this component.
(Inherited from BaseComponent.) |
| Stop |
Stop the background music.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Update |
Update this component (called every frame parent is active).
(Inherited from BaseComponent.) |
Fields| Name | Description | |
|---|---|---|
 | AsDebug |
If true, it means this component was added to its parent in debug mode.
(Inherited from BaseComponent.) |
| PlayOnSpawn |
If true, will play this music immediately on spawn event.
|
See Also