PlaySoundFrontEnd: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
|||
(22 intermediate revisions by 11 users not shown) | |||
Line 2: | Line 2: | ||
__NOTOC__ | __NOTOC__ | ||
This function plays a frontend sound for the specified player. | This function plays a frontend sound for the specified player. | ||
{{Note|These sounds can be disabled with [[setWorldSoundEnabled]] so if these sounds stop working you should check if you're disabling the sounds.}} | |||
{{Note|These sounds don't work when [[fadeCamera]] has been used to make the screen black.}} | |||
== | ==Syntax== | ||
<section name="Server" class="server" show="true"> | <section name="Server" class="server" show="true"> | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool playSoundFrontEnd ( player thePlayer, int sound ) | bool playSoundFrontEnd ( player thePlayer, int sound ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{New feature/item|3.0141|1.4.0|6987|{{OOP||[[player]]:playSoundFrontEnd}}}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''thePlayer:''' | *'''thePlayer:''' the [[player]] you want the sound to play for. | ||
*'''sound:''' | *'''sound:''' a whole [[int]] specifying the sound id to play. Valid values are: | ||
{{Sounds}} | {{Sounds}} | ||
</section> | </section> | ||
Line 17: | Line 20: | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool playSoundFrontEnd ( int sound ) | bool playSoundFrontEnd ( int sound ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{New feature/item|3.0141|1.4.0|6987|{{OOP||[[Sound]].playFrontEnd}}}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''sound:''' | *'''sound:''' a whole [[int]] specifying the sound id to play. Valid values are: | ||
{{Sounds}} | {{Sounds}} | ||
</section> | </section> | ||
=== | ===Returns=== | ||
Returns ''true'' if the sound was successfully played, ''false'' otherwise. | |||
== | ==Example== | ||
<section name="server" class="server" show="true"> | <section name="server" class="server" show="true"> | ||
This example plays a sound when a player spawns. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function onPlayerSpawn ( theSpawnpoint, theTeam ) | function onPlayerSpawn ( theSpawnpoint, theTeam ) | ||
playSoundFrontEnd ( source, 16 ) | playSoundFrontEnd ( source, 16 ) | ||
end | end | ||
addEventHandler ( "onPlayerSpawn", | addEventHandler ( "onPlayerSpawn", root, onPlayerSpawn ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | </section> | ||
<section name="client" class="client" show="true"> | <section name="client" class="client" show="true"> | ||
This example plays a sound when the player types the command '/sound'. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function onSoundEvent ( ) | function onSoundEvent ( ) | ||
Line 47: | Line 51: | ||
</section> | </section> | ||
== | ==See Also== | ||
{{Client_audio_functions}} | {{Client_audio_functions}} | ||
[[hu:playSoundFrontEnd]] | |||
[[de:playSoundFrontEnd]] | [[de:playSoundFrontEnd]] | ||
[[ | [[ar:playSoundFrontEnd]] | ||
[[pt-br:playSoundFrontEnd]] |
Latest revision as of 22:58, 18 August 2021
This function plays a frontend sound for the specified player.
Syntax
Click to collapse [-]
Serverbool playSoundFrontEnd ( player thePlayer, int sound )
OOP Syntax Help! I don't understand this!
- Method: player:playSoundFrontEnd(...)
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 [+]
ClientReturns
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", root, onPlayerSpawn )
Click to collapse [-]
clientThis example plays a sound when the player types the command '/sound'.
function onSoundEvent ( ) playSoundFrontEnd ( 16 ) end addCommandHandler("sound", onSoundEvent)
See Also
- getRadioChannel
- getRadioChannelName
- getSFXStatus
- getSoundBPM
- getSoundBufferLength
- getSoundEffectParameters
- getSoundEffects
- getSoundFFTData
- getSoundLength
- getSoundLevelData
- getSoundMaxDistance
- getSoundMetaTags
- getSoundMinDistance
- getSoundPan
- getSoundPosition
- getSoundProperties
- getSoundSpeed
- getSoundVolume
- getSoundWaveData
- isSoundLooped
- isSoundPanningEnabled
- isSoundPaused
- playSFX3D
- playSFX
- playSound3D
- playSound
- setRadioChannel
- setSoundEffectEnabled
- setSoundEffectParameter
- setSoundLooped
- setSoundMaxDistance
- setSoundMinDistance
- setSoundPan
- setSoundPanningEnabled
- setSoundPaused
- setSoundPosition
- setSoundProperties
- setSoundSpeed
- setSoundVolume
- stopSound
- Shared
- playSoundFrontEnd