Difference between revisions of "LlSound"

From Second Life Wiki
Jump to navigation Jump to search
m (LSL llSound moved to LlSound: removing prefix)
m (Replaced old <LSL> block with <source lang="lsl2">)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{LSL_Function
{{LSL_Function
|inject-2={{LSL_Function/inventory|sound|uuid=true|type=sound|volume=volume}}
|func_id=85|func_sleep=0.0|func_energy=10.0
|func_id=85|func_sleep=0.0|func_energy=10.0
|func=llSound
|func=llSound
|p1_type=string|p1_name=sound|p1_desc=inventory name or [[UUID]]
|p1_type=string|p1_name=sound
|p2_type=float|p2_name=volume|p2_desc=between 0.0 (silent) and 1.0 (loud) (0.0 &lt;&#61; '''volume''' &lt;&#61; 1.0)
|p2_type=float|p2_name=volume
|inventory=sound
|p3_type=integer|p3_name=queue|p3_desc=boolean, whether or not to queue the song ({{LSLG|TRUE}}) or interrupt the playing song ({{LSLG|FALSE}}).
|p3_type=integer|p3_name=queue|p3_desc=boolean, weather or not to queue the song ({{LSLG|TRUE}}) or interrupt the playing song ({{LSLG|FALSE}}).
|p4_type=integer|p4_name=loop|p4_desc=boolean, whether or not to loop the song.
|p4_type=integer|p4_name=loop|p4_desc=boolean, weather or not to loop the song.
|func_footnote
|func_footnote
|func_desc=Plays '''sound''' at '''volume''' and whether it should '''loop''' or not.
|func_desc=Plays {{LSLP|sound}} at {{LSLP|volume}} and whether it should {{LSLP|loop}} or not.
|return_text
|return_text
|spec
|spec
|caveats
|caveats
|constants
|constants
|examples
|examples=<source lang="lsl2">
default
{
    state_entry()
    {
        llSound("sound",1.0,TRUE,FALSE);
        //Plays the sound once.
    }
}
</source>
|helpers
|helpers
|also_functions
|also_functions
Line 20: Line 29:
|also_articles
|also_articles
|notes
|notes
|permission
|negative_index
|deprecated=llPlaySound
|deprecated=llPlaySound
|cat1=Sound
|cat1=Sound

Latest revision as of 11:46, 22 January 2015

Emblem-important.png Deprecated
(This function has been deprecated, please use llPlaySound instead.)

Summary

Function: llSound( string sound, float volume, integer queue, integer loop );
0.0 Forced Delay
10.0 Energy

Plays sound at volume and whether it should loop or not.

• string sound a sound in the inventory of the prim this script is in or a UUID of a sound
• float volume between 0.0 (silent) and 1.0 (loud) (0.0 <= volume <= 1.0)
• integer queue boolean, whether or not to queue the song (TRUE) or interrupt the playing song (FALSE).
• integer loop boolean, whether or not to loop the song.

Caveats

  • This function has been deprecated, please use llPlaySound instead.
  • If sound is missing from the prim's inventory and it is not a UUID or it is not a sound then an error is shouted on DEBUG_CHANNEL.
  • If sound is a UUID then there are no new asset permissions consequences for the object.
    • The resulting object develops no new usage restrictions that might have occurred if the asset had been placed in the prims inventory.

Examples

default
{
    state_entry()
    {
        llSound("sound",1.0,TRUE,FALSE);
        //Plays the sound once.
    }
}

Deep Notes

Signature

function void llSound( string sound, float volume, integer queue, integer loop );