PlaySoundFrontEnd: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 3: Line 3:
This function plays a frontend sound for the specified player.
This function plays a frontend sound for the specified player.


==Example==  
==Syntax==  
<section name="Server" class="server" show="true">
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Line 10: Line 10:


===Required Arguments===  
===Required Arguments===  
*'''thePlayer:''' The ([[player]]) what you want to play..
*'''thePlayer:''' The [[player]] you want the sound to play for.
*'''sound:''' Sound ID [[int]] what you want to play. Correct values is:
*'''sound:''' A whole [[int]] specifying the sound id to play. Valid values are:
{{Sounds}}
{{Sounds}}
</section>
</section>
Line 20: Line 20:


===Required Arguments===  
===Required Arguments===  
*'''sound:''' Sound ID [[int]] what you want to play. Correct values is:
*'''sound:''' A whole [[int]] specifying the sound id to play. Valid values are:
{{Sounds}}
{{Sounds}}
</section>
</section>


===Returns===
===Returns===
Function returns ''true'' if the sound was played correctly, ''false'' otherwise.
Returns ''true'' if the sound was successfully played, ''false'' otherwise.


==Example==
==Example==
<section name="server" class="server" show="true">
<section name="server" class="server" show="true">
That function play a sound on player spawn.
This example plays a sound when a player spawns.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function onPlayerSpawn ( theSpawnpoint, theTeam )
function onPlayerSpawn ( theSpawnpoint, theTeam )
Line 38: Line 38:
</section>
</section>
<section name="client" class="client" show="true">
<section name="client" class="client" show="true">
That function play a sound when player type '/sound'.
This example plays a sound when the player types the command '/sound'.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function onSoundEvent ( )
function onSoundEvent ( )

Revision as of 06:45, 24 May 2013

This function plays a frontend sound for the specified player.

Syntax

Click to collapse [-]
Server
bool playSoundFrontEnd ( player thePlayer, int sound )

Required Arguments

  • thePlayer: The player you want the sound to play for.
  • sound: A whole int specifying the sound id to play. Valid values are:
    • 0 - 20 Selection sounds
    • 27 - 30 Bullet sounds
    • 32 - 33 Selection sounds
    • 34 Radio static
    • 35 Stop Radio static
    • 37 - 38 Tick
    • 40 Selection sounds
    • 41 - 42 Tick (no ammo)
    • 43 - 45 Race countdown
    • 46 Repair
    • 47 White noise static
    • 48 Stop White noise static
    • 49 Static short
    • 101 Countdown/selection
Click to expand [+]
Client

Returns

Returns true if the sound was successfully played, false otherwise.

Example

Click to collapse [-]
server

This example plays a sound when a player spawns. 

function onPlayerSpawn ( theSpawnpoint, theTeam )
    playSoundFrontEnd ( source, 16 )
end
addEventHandler ( "onPlayerSpawn", getRootElement(), onPlayerSpawn )
Click to collapse [-]
client

This example plays a sound when the player types the command '/sound'. 

function onSoundEvent ( )
    playSoundFrontEnd ( 16 )
end
addCommandHandler("sound", onSoundEvent)

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/PlaySoundFrontEnd?oldid=36084"