SetRadioChannel: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
Line 16: Line 16:
Returns ''true'' if channel was set successfully, ''false'' otherwise.
Returns ''true'' if channel was set successfully, ''false'' otherwise.


==Example==  
==Example==
This example adds a command ''setradio'' which can be used to change the current radio station by ID.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addCommandHandler ( "setradio",
addCommandHandler ( "setradio",

Revision as of 20:19, 25 March 2009

This function sets the currently active radio channel.

Syntax

bool setRadioChannel ( int ID )             

Required Arguments

  • ID: The ID of the radio station you want to play.
  • 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 true if channel was set successfully, false otherwise.

Example

This example adds a command setradio which can be used to change the current radio station by ID.

addCommandHandler ( "setradio",
    function ( command, stationID )
        setRadioChannel ( tonumber( stationID ) )
        outputChatBox ( "You set your radio station to: " .. stationID )
    end
)

See Also