CreateSound3D: Difference between revisions

From Onset Developer Wiki
No edit summary
No edit summary
Line 12: Line 12:
{{FuncParam|radius|The radius to where the sound will be heard from.}}
{{FuncParam|radius|The radius to where the sound will be heard from.}}


{{FuncReturnValue|Returns '''true''' on success.}}
{{FuncReturnValue|Returns the sound identifier. Returns '''false''' on error. Once the playback has finished the sound identifier will be destroyed automatically.}}


== Example ==
== Example ==

Revision as of 11:37, 23 October 2019

CreateSound3D

Type: Function
Context: Client
Introduced: v1.0

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 the sound identifier. Returns false on error. Once the playback has finished the sound identifier will be destroyed automatically.

Example

__EDIT_ME__

See also

__EDIT_ME__