ShiVa Store (Packs)
JPSound

JPSound

Huge new features for sounds

Version : 2.0

Price : $25

State : Out

Downloads

Download pack

Download extension

Changelog

v2.0

Now compatible with ShiVa 2.0.
Plugin API compiled for Mac and Linux in addition to Windows : it will provide API completion in the Script module in ShiVa Editor for each of these operating systems.
Now uses a user token instead of an email to activate

v1.1

Global volume coefficients are now clamped between 0 and 1

API

--JPSound
JPSound.activate ( sUserToken, sActivationKey )

--FUNCTIONS: Note that you can use these function using both api.function ( ) or JPSound.api_function ( ). Only the second case will have code completion.

--Master volume
nCoef = application.getGlobalVolumeCoef ( )
application.setGlobalVolumeCoef ( nCoef )

nCoef = application.getGlobalObjectsVolumeCoef ( )
application.setGlobalObjectsVolumeCoef ( nCoef )

nCoef = application.getGlobalUsersVolumeCoef ( )
application.setGlobalUsersVolumeCoef ( nCoef )

--hud
nVolume = hud.getSoundVolume ( hUser, sSoundName_or_nSoundIndex )
bYes = hud.isSoundPlaying ( hUser, sSoundName_or_nSoundIndex )
nIndex = hud.playSound ( hUser, sSoundName_or_nSoundIndex, nVolume, bLoop )
hud.setSoundVolume ( hUser, sSoundName_or_nSoundIndex, nVolume )
hud.stopSound ( hUser, sSoundName_or_nSoundIndex )

--sound
nVolume = sound.getVolume ( hObject, sSoundName_or_nSoundIndex )
bYes = sound.isPlaying ( hObject, sSoundName_or_nSoundIndex )
nIndex = sound.play ( hObject, sSoundName_or_nSoundIndex, nVolume, bLoop, nPriority )
sound.setVolume ( hObject, sSoundName_or_nSoundIndex, nVolume )
sound.stop ( hObject, sSoundName_or_nSoundIndex )

Description

JPSound adds ease of use for implementing the sounds of your games, because you can play, stop (and more) sounds just by using their name: no worries about what is the index of a sound, and no problem if you move a sound of your SoundBank to another index.

Another great feature is the possibility to play several sounds of the same name at once just by using its name: reference the sound several times in your SoundBank and JPSound will automatically play the one that is not currently playing. Very powerful for sounds that must be played repeatedly quickly, like a machine gun for instance.

JPSound has many wonderful features, here's the full list of what it has to offer:

Master sound volume.
Global volume for sounds played by objects.
Global volume for sounds played by users.
New sound.getVolume and hud.getSoundVolume functions.
Most of the functions of the 'sound' API and the hud functions related to sounds can now be called by using a sound name instead of a sound index.
Possibility to play several sounds of the same name simultaneously just by giving its name to the hud.playSound or sound.play functions