GetRadioChannel: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Change See Also template)
 
(37 intermediate revisions by 20 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
Function returns ID of currently played station.
The function is used to retrieve the ID of the current radio channel.


==Example==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int getRadioChannel ( )            
int getRadioChannel ( )
</syntaxhighlight>  
</syntaxhighlight>  


===Returns===
===Returns===
Function returns ID of currently played station.
Returns the ID of the radio channel.
{{SoundID}}
{{SoundID}}


==Example==
==Example==
That function show on chat, what station you listening.
This example prints out the name of your current radio station to the chat box.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addCommandHandler ( "getradio",
addCommandHandler("getradio", function ()
    function ()
local radio = getRadioChannelName(getRadioChannel())
        outputChatBox ( "You are currently listening " .. getRadioChannelName ( getRadioChannel() ) .. "!" )
outputChatBox("You're currently listening to "..radio.."!")
    end
end)
)
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Audio_functions|client}}


{{Client_audio_functions}}
[[ar:getRadioChannel]]
[[AR:getRadioChannel]]
[[de:getRadioChannel]]
[[hu:getRadioChannel]]
[[pl:getRadioChannel]]
[[ro:getRadioChannel]]
[[ru:GetRadioChannel]]
[[PT-BR:GetRadioChannel]]

Latest revision as of 22:11, 6 September 2024

The function is used to retrieve the ID of the current radio channel.

Syntax

int getRadioChannel ( )

Returns

Returns the ID of the radio channel.

  • 0: Radio Off
  • 1: Playback FM
  • 2: K-Rose
  • 3: K-DST
  • 4: Bounce FM
  • 5: SF-UR
  • 6: Radio Los Santos
  • 7: Radio X
  • 8: CSR 103.9
  • 9: K-Jah West
  • 10: Master Sounds 98.3
  • 11: WCTR
  • 12: User Track Player

Example

This example prints out the name of your current radio station to the chat box.

addCommandHandler("getradio", function ()
	local radio = getRadioChannelName(getRadioChannel())
	outputChatBox("You're currently listening to "..radio.."!")
end)

See Also