Difference between revisions of "SetRadioChannel"

From Multi Theft Auto: Wiki
m (Example)
Line 1: Line 1:
 
__NOTOC__  
 
__NOTOC__  
 
{{Client function}}
 
{{Client function}}
This function sets the currently active radio channel.
+
This function sets the currently active radio channel.
 +
 
 +
This only works inside vehicles.
  
 
==Syntax==  
 
==Syntax==  

Revision as of 18:49, 5 August 2009

This function sets the currently active radio channel.

This only works inside vehicles.

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.

Click to collapse [-]
Client
addCommandHandler ( "setradio",
    function ( command, stationID )
        local result = setRadioChannel ( tonumber( stationID ) )
        if result then -- if we had a valid ID
            outputChatBox ( "Changed your radio station to " .. getRadioChannelName ( tonumber ( stationID ) ) .. "!" )
        else
            outputChatBox ( "Invalid radio station ID, valid ones are 0-12." )
        end
    end
)

See Also