e2 docs sound - wiremod/wire GitHub Wiki

Jump to table of contents

Sound

soundPlay(String Index, Number Duration, String Path)

Plays sound from the E2 chip. soundPlay(string Index, number Duration, string Path to File) (25 ops)

soundPlay(Number Index, Number Duration, String Path)

Plays sound from the E2 chip. soundPlay(int Index, number Duration, string Path to File) (25 ops)

Entity:soundPlay(String Index, Number Duration, String Path)

Plays sound from an entity. soundPlay(string Index, number Duration, string Path to File) (25 ops)

Entity:soundPlay(Number Index, Number Duration, String Path)

Plays sound from an entity. soundPlay(int Index, number Duration, string Path to File) (25 ops)

soundPlay(String Index, Number Duration, String Path, Number Fade)

Plays sound from the E2 chip. soundPlay(string Index, number Duration, string Path to File, number FadeTime) (25 ops)

soundPlay(Number Index, Number Duration, String Path, Number Fade)

Plays sound from the E2 chip. soundPlay(int Index, number Duration, string Path to File, number FadeTime) (25 ops)

Entity:soundPlay(Number Index, Number Duration, String Path, Number Fade)

Plays sound from an entity. soundPlay(int Index, number Duration, string Path to File, number FadeTime) (25 ops)

Entity:soundPlay(String Index, Number Duration, String Path, Number Fade)

Plays sound from an entity. soundPlay(string Index, number Duration, string Path to File, number FadeTime) (25 ops)

soundStop(String Index)

Stops the sound stored at the string index and removes the entry (5 ops)

soundStop(Number Index)

Stops the sound stored at the integer index and removes the entry (5 ops)

soundStop(Number Index, Number Fadetime)

Fades the sound stored at the first input's integer index in the second input's amount of seconds and removes the entry (5 ops)

soundStop(String Index, Number Fadetime)

Fades the sound stored at the string index in the integer input's amount of seconds and removes the entry (5 ops)

soundVolume(String Index, Number Volume)

soundVolume(string Index, Volume), where Volume is a number between 0 and 1. Default Volume is 1 (5 ops)

soundVolume(Number Index, Number Volume)

soundVolume(integer Index, Volume), where Volume is a number between 0 and 1. Default Volume is 1 (5 ops)

soundVolume(String Index, Number Volume, Number Fadetime)

soundVolume(string Index, Volume, FadeTime), where Volume is a number between 0 and 1. Default Volume is 1 (5 ops)

soundVolume(Number Index, Number Volume, Number Fadetime)

soundVolume(integer Index, Volume, FadeTime), where Volume is a number between 0 and 1. Default Volume is 1 (5 ops)

soundPitch(Number Index, Number Pitch)

soundPitch(integer Index, number Pitch) Default Pitch is 100, max is 255. Pitch is scaled linearly (like frequency), rather than by octave (5 ops)

soundPitch(String Index, Number Pitch)

soundPitch(string Index, number Pitch) Default Pitch is 100, max is 255. Pitch is scaled linearly (like frequency), rather than by octave (5 ops)

soundPitch(Number Index, Number Pitch, Number Fadetime)

soundPitch(integer Index, number Pitch, number Fadetime) Default Pitch is 100, max is 255. Pitch is scaled linearly (like frequency), rather than by octave (5 ops)

soundPitch(String Index, Number Pitch, Number Fadetime)

soundPitch(string Index, number Pitch, number Fadetime) Default Pitch is 100, max is 255. Pitch is scaled linearly (like frequency), rather than by octave (5 ops)

soundPurge()

Clears the sound table and stops all sounds (5 ops)

Number = soundDuration(String Sound)

soundDuration(string Path to File) Returns the duration of the sound. Note: If the server hasn't the file it returns 60 (5000 ops)

soundDSP(Number Index, Number Dsp)

Sets the DSP effect for the sound at the index, then restarts the sound (5 ops)

soundDSP(String Index, Number Dsp)

Sets the DSP effect for the sound at the index, then restarts the sound (5 ops)

soundLevel(String Index, Number Level)

Sets the sound's level in dB, then restarts the sound. This affects how far away the sound can be heard. (5 ops)

soundLevel(Number Index, Number Level)

Sets the sound's level in dB, then restarts the sound. This affects how far away the sound can be heard. (5 ops)

Number = soundDSP(Number Index)

Returns the DSP effect for the sound at the index (default 0) (2 ops)

Number = soundDSP(String Index)

Returns the DSP effect for the sound at the index (default 0) (2 ops)

Number = soundLevel(String Index)

Returns the sound level in dB for the sound at the index (2 ops)

Number = soundLevel(Number Index)

Returns the sound level in dB for the sound at the index (2 ops)

Number = soundPitch(Number Index)

Returns the pitch of the sound at the index (2 ops)

Number = soundPitch(String Index)

Returns the pitch of the sound at the index (2 ops)

Number = soundVolume(Number Index)

Returns the volume of the sound at the index (2 ops)

Number = soundVolume(String Index)

Returns the volume of the sound at the index (2 ops)

Number = soundPlaying(Number Index)

Returns 1 if the sound at the index is playing, 0 if not (2 ops)

Number = soundPlaying(String Index)

Returns 1 if the sound at the index is playing, 0 if not (2 ops)

Entity:emitSound(String Soundname, Number Soundlevel, Number Pitchpercent, Number Volume)

Plays sound on entity. Note that one file can only be played once in a time. (20 ops)

Entity:emitSound(String Soundname, Number Soundlevel, Number Pitchpercent)

Plays sound on entity. Note that one file can only be played once in a time. (20 ops)

Entity:emitSound(String Soundname, Number Soundlevel)

Plays sound on entity. Note that one file can only be played once in a time. (20 ops)

Entity:emitSound(String Soundname)

Plays sound on entity. Note that one file can only be played once in a time. (20 ops)

Entity:emitSoundStop(String Soundname)

Stops sound played with 'emitSound' (20 ops)