Class: Sound#

Hierarchy#

Handle<sound>
↳ Sound

Constructors#

constructor#

new Sound(fileName: string, looping: boolean, is3D: boolean, stopWhenOutOfRange: boolean, fadeInRate: number, fadeOutRate: number, eaxSetting: string): Sound

Creates a sound handle.

note You can only play the same sound handle once.

note You can only play the same sound filepath four times.

note You can only play 16 sounds in general.

note Sounds of the same filepath (on different sound handles) must have a delay of at least 0.1 seconds inbetween them to be played. You can overcome this by starting one earlier and then using SetSoundPosition.

Parameters:#

Name	Type	Description
`fileName`	string	The path to the file.
`looping`	boolean	Looping sounds will restart once the sound duration has finished.
`is3D`	boolean	3D Sounds can be played on particular areas of the map. They are at their loudest when the camera is close to the sound's coordinates.
`stopWhenOutOfRange`	boolean
`fadeInRate`	number	How quickly the sound fades in. The higher the number, the faster the sound fades in. Maximum number is 127.
`fadeOutRate`	number	How quickly the sound fades out. The higher the number, the faster the sound fades out. Maximum number is 127.
`eaxSetting`	string	EAX is an acronym for environmental audio extensions. In the sound editor, this corresponds to the "Effect" setting.

Returns: Sound

_{Defined in: handles/sound.ts:5}

Properties#

handle#

• Readonly handle: sound

_{Inherited from: Handle.handle
Defined in: handles/handle.ts:6}

Accessors#

dialogueSpeakerNameKey#

dialogueSpeakerNameKey(): string

Returns: string

_{Defined in: handles/sound.ts:30}

dialogueSpeakerNameKey(speakerName: string): void

Parameters:#

Name	Type
`speakerName`	string

Returns: void

_{Defined in: handles/sound.ts:34}

dialogueTextKey#

dialogueTextKey(): string

Returns: string

_{Defined in: handles/sound.ts:38}

dialogueTextKey(dialogueText: string): void

Parameters:#

Name	Type
`dialogueText`	string

Returns: void

_{Defined in: handles/sound.ts:42}

duration#

duration(): number

Returns: number

_{Defined in: handles/sound.ts:46}

duration(duration: number): void

Parameters:#

Name	Type
`duration`	number

Returns: void

_{Defined in: handles/sound.ts:50}

id#

id(): number

Get the unique ID of the handle. The ID is recycled once you destroy the object.

Returns: number

The unique ID of a handle object.

_{Defined in: handles/handle.ts:18}

loading#

loading(): boolean

Returns: boolean

_{Defined in: handles/sound.ts:54}

playing#

playing(): boolean

Returns: boolean

_{Defined in: handles/sound.ts:58}

Methods#

killWhenDone#

killWhenDone(): void

Returns: void

_{Defined in: handles/sound.ts:62}

registerStacked#

registerStacked(byPosition: boolean, rectWidth: number, rectHeight: number): void

Parameters:#

Name	Type
`byPosition`	boolean
`rectWidth`	number
`rectHeight`	number

Returns: void

_{Defined in: handles/sound.ts:66}

setChannel#

setChannel(channel: number): void

Parameters:#

Name	Type
`channel`	number

Returns: void

_{Defined in: handles/sound.ts:70}

setConeAngles#

setConeAngles(inside: number, outside: number, outsideVolume: number): void

note This call is only valid if the sound was created with 3d enabled

Parameters:#

Name	Type
`inside`	number
`outside`	number
`outsideVolume`	number

Returns: void

_{Defined in: handles/sound.ts:77}

setConeOrientation#

setConeOrientation(x: number, y: number, z: number): void

note This call is only valid if the sound was created with 3d enabled

Parameters:#

Name	Type
`x`	number
`y`	number
`z`	number

Returns: void

_{Defined in: handles/sound.ts:84}

setDistanceCutoff#

setDistanceCutoff(cutoff: number): void

Parameters:#

Name	Type
`cutoff`	number

Returns: void

_{Defined in: handles/sound.ts:88}

setDistances#

setDistances(minDist: number, maxDist: number): void

note This call is only valid if the sound was created with 3d enabled

Parameters:#

Name	Type
`minDist`	number
`maxDist`	number

Returns: void

_{Defined in: handles/sound.ts:95}

setFacialAnimationFilepath#

setFacialAnimationFilepath(animationSetFilepath: string): void

Parameters:#

Name	Type
`animationSetFilepath`	string

Returns: void

_{Defined in: handles/sound.ts:99}

setFacialAnimationGroupLabel#

setFacialAnimationGroupLabel(groupLabel: string): void

Parameters:#

Name	Type
`groupLabel`	string

Returns: void

_{Defined in: handles/sound.ts:103}

setFacialAnimationLabel#

setFacialAnimationLabel(animationLabel: string): void

Parameters:#

Name	Type
`animationLabel`	string

Returns: void

_{Defined in: handles/sound.ts:107}

setParamsFromLabel#

setParamsFromLabel(soundLabel: string): void

pplies default settings to the sound.

Parameters:#

Name	Type	Description
`soundLabel`	string	The label out of one of the SLK-files, whose settings should be used, e.g. values like volume, pitch, pitch variance, priority, channel, min distance, max distance, distance cutoff or eax.

Returns: void

_{Defined in: handles/sound.ts:115}

setPitch#

setPitch(pitch: number): void

Tones the pitch of the sound, default value is 1. Increasing it you get the chipmunk version and the sound becomes shorter, when decremented the sound becomes low-pitched and longer.

bug This native has very weird behaviour. See this for an explenation and this for a non-bugged implementation.

Parameters:#

Name	Type
`pitch`	number

Returns: void

_{Defined in: handles/sound.ts:127}

setPlayPosition#

setPlayPosition(millisecs: number): void

Must be called immediately after starting the sound

Parameters:#

Name	Type	Description
`millisecs`	number

Returns: void

_{Defined in: handles/sound.ts:135}

setPosition#

setPosition(x: number, y: number, z: number): void

note This call is only valid if the sound was created with 3d enabled

Parameters:#

Name	Type
`x`	number
`y`	number
`z`	number

Returns: void

_{Defined in: handles/sound.ts:142}

setVelocity#

setVelocity(x: number, y: number, z: number): void

note This call is only valid if the sound was created with 3d enabled

Parameters:#

Name	Type
`x`	number
`y`	number
`z`	number

Returns: void

_{Defined in: handles/sound.ts:149}

setVolume#

setVolume(volume: number): void

Sets the sounds volume

Parameters:#

Name	Type	Description
`volume`	number	Volume, between 0 and 127

Returns: void

_{Defined in: handles/sound.ts:157}

start#

start(): void

Starts the sound.

note You can only play the same sound handle once.

note You can only play 16 sounds in general.

Returns: void

_{Defined in: handles/sound.ts:168}

stop#

stop(killWhenDone: boolean, fadeOut: boolean): void

Stops the sound.

Parameters:#

Name	Type	Description
`killWhenDone`	boolean	The sound gets destroyed if true.
`fadeOut`	boolean	Turns down the volume with `fadeOutRate` as stated in constructor.

Returns: void

_{Defined in: handles/sound.ts:177}

unregisterStacked#

unregisterStacked(byPosition: boolean, rectWidth: number, rectHeight: number): void

Parameters:#

Name	Type
`byPosition`	boolean
`rectWidth`	number
`rectHeight`	number

Returns: void

_{Defined in: handles/sound.ts:181}

fromHandle#

static fromHandle(handle: sound): Sound

Parameters:#

Name	Type
`handle`	sound

Returns: Sound

_{Defined in: handles/sound.ts:185}

getFileDuration#

static getFileDuration(fileName: string): number

Parameters:#

Name	Type
`fileName`	string

Returns: number

_{Defined in: handles/sound.ts:189}