Scripting/Squirrel/Functions/PlaySound: Difference between revisions

From Vice City Multiplayer
Jump to navigation Jump to search
Caution icon
This wiki is using an old backup from 2020
Some information may be old/missing
(Created page with "This function will play a sound at a certain position. == Syntax == <pre>PlayGameSound( world, sound, pos )</pre> == Arguments == * ''int'' '''world''' - The world ID * ''...")
 
No edit summary
 
(8 intermediate revisions by 4 users not shown)
Line 3: Line 3:
== Syntax ==
== Syntax ==


<pre>PlayGameSound( world, sound, pos )</pre>
1
<pre>PlaySound( world, sound, pos )</pre>
2
<pre>PlaySound( world, sound, x, y, z )</pre>


== Arguments ==
== Arguments ==
Line 10: Line 13:
* ''int'' '''sound''' - The sound ID
* ''int'' '''sound''' - The sound ID
* ''[[Scripting/Squirrel/Functions/Vector|Vector]]'' '''pos''' - The position of the sound to be played at
* ''[[Scripting/Squirrel/Functions/Vector|Vector]]'' '''pos''' - The position of the sound to be played at
== Example ==
== Example ==
 
<source lang=squirrel>
{{Scripting/Needs_Example}}
function OnPlayerCommand( player,cmd , text )
{
    if ( cmd == "sound" )
    {
          PlaySound( player.UniqueWorld , 30 , player.Pos );
    }
}
</source>


=== Notes ===
=== Notes ===
 
Use [[Scripting/Squirrel/Functions/Player.UniqueWorld|Player.UniqueWorld]] to play sound for a specific player.


== Related Functions ==
== Related Functions ==


{{Scripting/Squirrel/Functions/Messages}}
{{Scripting/Squirrel/Functions/Game_Functions}}
[[Category:Scripting/Squirrel/Functions/Game_Functions]]

Latest revision as of 18:03, 30 January 2017

This function will play a sound at a certain position.

Syntax

1

PlaySound( world, sound, pos )

2

PlaySound( world, sound, x, y, z )

Arguments

  • int world - The world ID
  • int sound - The sound ID
  • Vector pos - The position of the sound to be played at

Example

function OnPlayerCommand( player,cmd , text )
{
     if ( cmd == "sound" )
     {
          PlaySound( player.UniqueWorld , 30 , player.Pos );
     }
}

Notes

Use Player.UniqueWorld to play sound for a specific player.

Related Functions