CreateSound3D: Difference between revisions
From Onset Developer Wiki
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{Info|Function|Client|1.0}} | {{Info|Function|Client|1.0}} | ||
{{FuncDescription| | {{FuncDescription|Plays a local audio file or over http. Also supports playing .pls network streams. Sound is played in 3D world space.}} | ||
{{FuncSyntax|CreateSound3D(SoundFile, x, y, z, radius)}} | {{FuncSyntax|CreateSound3D(SoundFile, x, y, z, radius)}} | ||
{{FuncParameters}} | {{FuncParameters}} | ||
{{FuncParam|SoundFile| | {{FuncParam|SoundFile|The path to the file to play. Or a HTTP network stream or file.}} | ||
{{FuncParam|x| | {{FuncParam|x|Location X coordinate}} | ||
{{FuncParam|y| | {{FuncParam|y|Location Y coordinate}} | ||
{{FuncParam|z| | {{FuncParam|z|Location Z coordinate}} | ||
{{FuncParam|radius| | {{FuncParam|radius|The radius to where the sound will be heard from.}} | ||
{{FuncReturnValue| | {{FuncReturnValue|Returns '''true''' on success.}} | ||
== Example == | == Example == | ||
Revision as of 11:36, 23 October 2019
Description
Plays a local audio file or over http. Also supports playing .pls network streams. Sound is played in 3D world space.
Syntax
CreateSound3D(SoundFile, x, y, z, radius)
Parameters
- SoundFile
The path to the file to play. Or a HTTP network stream or file. - x
Location X coordinate - y
Location Y coordinate - z
Location Z coordinate - radius
The radius to where the sound will be heard from.
Return Value
- Returns true on success.
Example
__EDIT_ME__
See also
__EDIT_ME__
