PlaySoundFrontEnd: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
__NOTOC__ | {{Server client function}} | ||
__NOTOC__ | |||
This function plays a frontend sound for the specified player. | This function plays a frontend sound for the specified player. | ||
==Usage== | ==Usage== | ||
Both server | Both server side and client side. '''thePlayer''' argument isn't used in the client side version of this function. | ||
==Syntax== | ==Syntax== | ||
Line 16: | Line 17: | ||
===Returns=== | ===Returns=== | ||
Returns ''true'' if the sound was successfully played , ''false'' otherwise. | Returns ''true'' if the sound was successfully played, ''false'' otherwise. | ||
==Example== | ==Example== | ||
This example plays a sound when a player spawns | <section name="server" class="server" show="true"> | ||
This example plays a sound when a player spawns. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function onPlayerSpawn ( | function onPlayerSpawn ( theSpawnpoint, theTeam ) | ||
playSoundFrontEnd ( source, 16 ) | |||
end | end | ||
addEventHandler ( "onPlayerSpawn", getElementRoot(), onPlayerSpawn ) | addEventHandler ( "onPlayerSpawn", getElementRoot(), onPlayerSpawn ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | |||
<section name="client" class="client" show="true"> | |||
This example plays a sound when the server triggers the onSoundEvent client event. | |||
<syntaxhighlight lang="lua"> | |||
function onSoundEvent ( ) | |||
playSoundFrontEnd ( 16 ) | |||
end | |||
addEvent ( "onSoundEvent" ) | |||
addEventHandler ( "onSoundEvent", getElementRoot(), onSoundEvent ) | |||
</syntaxhighlight> | |||
</section> | |||
==See Also== | ==See Also== | ||
{{Audio_functions}} | {{Audio_functions}} |
Revision as of 18:55, 16 August 2007
This function plays a frontend sound for the specified player.
Usage
Both server side and client side. thePlayer argument isn't used in the client side version of this function.
Syntax
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
Returns
Returns true if the sound was successfully played, false otherwise.
Example
Click to collapse [-]
serverThis example plays a sound when a player spawns.
function onPlayerSpawn ( theSpawnpoint, theTeam ) playSoundFrontEnd ( source, 16 ) end addEventHandler ( "onPlayerSpawn", getElementRoot(), onPlayerSpawn )
Click to collapse [-]
clientThis example plays a sound when the server triggers the onSoundEvent client event.
function onSoundEvent ( ) playSoundFrontEnd ( 16 ) end addEvent ( "onSoundEvent" ) addEventHandler ( "onSoundEvent", getElementRoot(), onSoundEvent )
See Also