GetRadioChannelName: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Documented getRadioChannelName)
 
m (Change See Also template)
 
(20 intermediate revisions by 16 users not shown)
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string getRadioChannelName ( int ID )            
string getRadioChannelName ( int id )
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
*'''ID:''' The ID of the radio station you want to get the name of.
*'''id:''' The ID of the radio station you want to get the name of. It is a number from 0 to 12.
{{SoundID}}


===Returns===
===Returns===
Returns a string containing the station name if function successful, ''false'' otherwise.
Returns a string containing the station name if successful, ''false'' otherwise.


==Example==
==Example==
<section name="Client" class="client" show="true">
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
addCommandHandler("getradio", function()
local radio = getRadioChannelName(getRadioChannel())
outputChatBox("You're currently listening to "..radio.."!")
end)
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>


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


{{Client_audio_functions}}
[[ar:getRadioChannelName]]
[[de:getRadioChannelName]]
[[hu:getRadioChannelName]]
[[pl:getRadioChannelName]]
[[ro:getRadioChannelName]]

Latest revision as of 22:11, 6 September 2024

This function gets the given radio channel name.

Syntax

string getRadioChannelName ( int id )

Required Arguments

  • id: The ID of the radio station you want to get the name of. It is a number from 0 to 12.
  • 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

Returns

Returns a string containing the station name if successful, false otherwise.

Example

Click to collapse [-]
Client
addCommandHandler("getradio", function()
	local radio = getRadioChannelName(getRadioChannel())
	outputChatBox("You're currently listening to "..radio.."!")
end)

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/GetRadioChannelName?oldid=80324"