PlaySound: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
| Line 3: | Line 3: | ||
Plays a specified sound for the local player. | Plays a specified sound for the local player. | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">sound | <syntaxhighlight lang="lua">sound playSound ( string sound, [ bool looped ] )</syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''sound:''' Name of the sound you want to play. (sent to client via file xml tag in meta) | *'''sound:''' Name of the sound you want to play. (sent to client via file xml tag in meta) | ||
===Optional Arguments=== | ===Optional Arguments=== | ||
| Line 16: | Line 15: | ||
===Returns=== | ===Returns=== | ||
Returns a sound element if the sound was successfully played, ''false'' otherwise. | Returns a sound element if the sound was successfully played, ''false'' otherwise. | ||
==Example== | ==Example== | ||
Revision as of 19:37, 26 December 2008
Plays a specified sound for the local player.
Syntax
sound playSound ( string sound, [ bool looped ] )
Required Arguments
- sound: Name of the sound you want to play. (sent to client via file xml tag in meta)
Optional Arguments
NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.
- looped: True if looped, False otherwise.
Returns
Returns a sound element if the sound was successfully played, false otherwise.
Example
TODO
Click to collapse [-]
Client--TODO
See Also