Category:Sound Effects Functions

From NWN Lexicon
Jump to navigationJump to search

Sound Effects Function Category

Sound Effect related functions.



Functions

Name Brief Description

AmbientSoundChangeDay

Changes the ambient daytime soundtrack of an area.

AmbientSoundChangeNight

Modify an Area's nighttime soundtrack.

AmbientSoundPlay

Starts the ambient soundtrack of an area playing.

AmbientSoundSetDayVolume

Change the volume of the ambient daytime soundtrack in an area.

AmbientSoundSetNightVolume

Change the volume of an area's ambient nighttime soundtrack

AmbientSoundStop

Stops ambient sounds playing in an area.

ApplyPrismaticEffect

Applies a prismatic effect on a creature.

GetDialogSoundLength

Retrieves the length of a wave (audio) file in seconds.

GetFootstepType

Determine the footstep type of the creature specified.

GetStrRefSoundDuration

Determine the duration of a sound attached to a string reference.

PlayDragonBattleCry

Makes a dragon sound its battle cry.

PlaySound

Plays a sound on the client machine.

PlaySoundByStrRef

Plays a sound associated with a string reference (StrRef).

PlaySpeakSoundByStrRef

Do a call to both SpeakStringByStrRef and PlaySoundByStrRef at the same time.

SetFootstepType

Sets the footstep type of the creature specified.

SoundObjectPlay

Play a sound object.

SoundObjectSetPosition

Sets the position of a sound object relative to the player(s).

SoundObjectSetVolume

This function will set the volume of a placed sound object, great for creating mood effects.

SoundObjectStop

Stops a sound object from playing.