Class SoundComponent

Represents a sound that can be played

Hierarchy (View Summary)

BaseComponent
- SoundComponent

Index

Constructors

Accessors

asset filePath isLoaded isLoading isPlaying uuid

Methods

getContainer load play setContainer toJson update

Constructors

constructor

new SoundComponent(props?: SoundComponentProps): SoundComponent
Parameters
- Optionalprops: SoundComponentProps
Returns SoundComponent
Overrides BaseComponent.constructor
- Defined in ecs/components/SoundComponent.ts:101

Accessors

asset

get asset(): Nullable<SoundAsset>
The asset of the sound

Returns Nullable<SoundAsset>
if the sound is fonud and loaded
- Defined in ecs/components/SoundComponent.ts:45

filePath

get filePath(): string | undefined
Returns string | undefined
the path of the file to load
- Defined in ecs/components/SoundComponent.ts:68
set filePath(path: string): void
Sets the path of the file to load. This will reset the asset and stop the sound if it was playing
Parameters
- path: string
  the path of the file to load
Returns void
- Defined in ecs/components/SoundComponent.ts:56

isLoaded

get isLoaded(): boolean
Indicates if the sound is loaded and ready to be played

Returns boolean
true if the sound is loaded and ready to be played
- Defined in ecs/components/SoundComponent.ts:80

isLoading

get isLoading(): boolean
Indicates if the sound is currently loading

Returns boolean
true if the sound is currently loading
- Defined in ecs/components/SoundComponent.ts:93

isPlaying

get isPlaying(): boolean
This readonly property aims to indicate if the sound is playing. In this first MVP It is reset to false at any update and used only to trigger the sound at the next update

Returns boolean
true if the sound is set to be played at the next update.
- Defined in ecs/components/SoundComponent.ts:31

uuid

get uuid(): string
Returns string
Inherited from BaseComponent.uuid
- Defined in ecs/components/BaseComponent.ts:13

Methods

getContainer

getContainer(): IEntity | undefined
Returns IEntity | undefined
Inherited from BaseComponent.getContainer
- Defined in ecs/components/BaseComponent.ts:17

load

load(loader: SoundLoader): void
Loads the sound asset using the given loader. This method is implemented asynchronously so to not block the engine, as soon as the sound is loaded it will be played
Parameters
- loader: SoundLoader
Returns void
- Defined in ecs/components/SoundComponent.ts:131

play

play(): void
Flags the component as playing for the next update

Returns void
- Defined in ecs/components/SoundComponent.ts:123

setContainer

setContainer(container: IEntity): void
Parameters
- container: IEntity
Returns void
Inherited from BaseComponent.setContainer
- Defined in ecs/components/BaseComponent.ts:21

toJson

toJson(): WithType<SoundComponentProps>
Returns WithType<SoundComponentProps>
Overrides BaseComponent.toJson
- Defined in ecs/components/SoundComponent.ts:146

update

update(): void
Plays the sound if loaded and flagged for playing at the next update. Flag is reset to false at the next update.

Returns void
- Defined in ecs/components/SoundComponent.ts:113