SetSound3DLocation: Difference between revisions

From Onset Developer Wiki
(Created page with "{{Info|Function|Client|1.0}} {{FuncDescription|Sets the location of a 3d sound.}} {{FuncSyntax|SetSound3DLocation(sound, x, y, z])}} {{FuncParameters}} {{FuncParam|sound|Th...")
 
No edit summary
 
(2 intermediate revisions by 2 users not shown)
Line 3: Line 3:
{{FuncDescription|Sets the location of a 3d sound.}}
{{FuncDescription|Sets the location of a 3d sound.}}


{{FuncSyntax|SetSound3DLocation(sound, x, y, z])}}
{{FuncSyntax|SetSound3DLocation(sound, x, y, z)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|sound|The sound identifier.}}
{{FuncParam|sound|The sound identifier.}}
{{FuncParam|x|__EDIT_ME__}}
{{FuncParam|x|The X axis}}
{{FuncParam|y|__EDIT_ME__}}
{{FuncParam|y|The Y axis}}
{{FuncParam|z|__EDIT_ME__}}
{{FuncParam|z|The Z axis}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns '''true''' on success.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
SetSound3DLocation(soundId, x, y, z)
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
{{SoundFunctions}}

Latest revision as of 18:40, 30 August 2020

SetSound3DLocation

Type: Function
Context: Client
Introduced: v1.0

Description

Sets the location of a 3d sound.

Syntax

SetSound3DLocation(sound, x, y, z)

Parameters

  • sound
    The sound identifier.
  • x
    The X axis
  • y
    The Y axis
  • z
    The Z axis

Return Value

  • Returns true on success.

Example

SetSound3DLocation(soundId, x, y, z)

See also