| SoundEffect Class |
A sound effect you can attach to a GameObject and constantly play or play on demand.
Inheritance HierarchySystemObject
GeonBit.ECS.ComponentsIComponent
GeonBit.ECS.ComponentsBaseComponent
GeonBit.ECS.Components.SoundSoundEffect
GeonBit.ECS.ComponentsIComponent
GeonBit.ECS.ComponentsBaseComponent
GeonBit.ECS.Components.SoundSoundEffect
Namespace: GeonBit.ECS.Components.Sound
Assembly: GeonBit (in GeonBit.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
public class SoundEffect : BaseComponent
The SoundEffect type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoundEffect(SoundEffect) |
Create the Sound Effect component.
|
| SoundEffect(String) |
Create the Sound Effect component.
|
Properties| Name | Description | |
|---|---|---|
 | _GameObject |
Get the game object this component is attached to.
(Inherited from BaseComponent.) |
| Duration |
Get sound duration.
|
| Enabled |
Is this component currently enabled.
(Inherited from BaseComponent.) |
| IsLooped |
If true will play this sound in a loop.
|
| IsPaused |
Is the sound currently paused?
|
| IsPlaying |
Is the sound currently playing?
|
| IsStopped |
Is the sound currently stopped?
|
| Name |
Get / set the name of this component.
(Inherited from IComponent.) |
| Pan |
Pan effect.
|
| Pitch |
Pitch effect.
|
| Volume |
Sound effect volume.
|
Methods| Name | Description | |
|---|---|---|
| Clone |
Clone this sound effect.
(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.) |
| Enable3D |
Enable 3d sound effects with emitter and listeners.
|
| 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 sound effect.
|
| Play |
Play the sound effect.
|
| RemoveFromParent |
Remove this component from parent.
(Inherited from BaseComponent.) |
| SendMessage |
Send message to this component.
(Inherited from BaseComponent.) |
| Stop |
Stop the sound effect.
|
| 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.) |
 | DefaultListener |
A default listener to use for 3D sound effects that have no listener and don't use the camera as default.
|
| DefaultListenerForward |
Default 'Forward' vector to use for 3D sound effect listeners.
|
| DefaultListenerUp |
Default 'Up' vector to use for 3D sound effect listeners.
|
| DistanceFadeFactor |
If a listener object is set, this factor will determine how much the volume will decrease per distance unit.
|
| Listener |
Optional Game Object you can set as the "listener" source for 3d sounds.
If set, will decrease volume as the distance grows between this sound effect and the object.
|
| PlayOnSpawn |
If true, will play this sound effect immediately on spawn event.
|
| UseCameraAsListener |
If true, 'Listener' object will always be the currently active camera.
|
See Also