Server Wrapper
Please take a note of where your server API wrapper is located, this guide will assume that the wrapper is in ServerScriptService.
Setting Up
Setting up is pretty simple. Just require the script and call .init().
- Create a
Script - Paste the following code:
local ServerScriptService = game:GetService("ServerScriptService") local serverAPI = require(ServerScriptService:WaitForChild("Radio System Server API")).init() - Hit 'Play', check for any errors.
It Errors
- Try debugging it yourself.
- If you can not figure out why, feel free to create a support thread.
- Remember, be patient, and please understand that the API is meant to be used by those who know how to program.
API Reference
cleanup
The most important function of them all Call this function once you are done with the API, it will clean up all connections for you.
() -> nil
Example Usage
serverAPI:cleanup()
ScriptConnection
Our version of a RBXMScriptConnection, it just provides a way to disconnect from a function.
Methods
disconnect()- Disconnects the function
Example Usage
local connection = ...
task.wait(10)
connection:disconnect()
receivedClientMessage
Calls the function whenever we receieve a message from a player.
(
func: (player: Player, message: string, channelId: number) -> nil
) -> ScriptConnection
Parameters
func: (player: Player, message: string, channelId: number) -> nil- a function that accepts a Player, string, number as its parameters and returns nil.
Example Usage
local connection = serverAPI:clientMessageRecieved(function(player: Player, message: string, channelId: number)
print(player, message, channelId)
end)
task.wait(10)
connection:disconnect()
receivedClientMessage
Calls the function whenever a player tries to use the voice channel.
(
func: (player: Player, channelId: number) -> nil
) -> ScriptConnection
Parameters
func: (player: Player, channelId: number) -> nil- a function that accepts a Player and number as its parameters and returns nil.
Example Usage
serverAPI:clientMessageRecieved(function(player: Player, channelId: number)
print(player, channelId)
end)
receivedPanic
Calls the function whenever a player successfully uses the panic button.
(
func: (player: Player, channelId: number) -> nil
) -> ScriptConnection
Parameters
func: (player: Player, channelId: number) -> nil- a function that accepts a Player and number as its parameters and returns nil.
Example Usage
serverAPI:receivedPanic(function(player: Player, channelId: number)
print(player, channelId)
end)
authorizedClient
Calls the function whenever the server sends authorized channels to a client.
(
func: (player: Player, authorizedChannels: {number}) -> nil
) -> ScriptConnection
Parameters
func: (player: Player, authorizedChannels: {number}) -> nil- a function that accepts a Player and table as its parameters and returns nil.
Example Usage
serverAPI:clientMessageRecieved(function(player: Player, authorizedChannels: {number})
print(player, authorizedChannels)
end)
channelAddPlayer
Calls the function whenever a channel adds a player to itself.
(
func: (id: number, player: Player) -> nil
) -> ScriptConnection
Parameters
func: (id: number, player: Player) -> nil- a function that accepts a numbe and Player as its parameters and returns nil.
Example Usage
serverAPI:clientMessageRecieved(function(id: number, player: Player)
print(id, player)
end)
channelRemovePlayer
Calls the function whenever a channel removes a player to itself.
(
func: (id: number, player: Player) -> nil
) -> ScriptConnection
Parameters
func: (id: number, player: Player) -> nil- a function that accepts a numbe and Player as its parameters and returns nil.
Example Usage
serverAPI:clientMessageRecieved(function(id: number, player: Player)
print(id, player)
end)
createSystemMessage
Creates a system message in the specified channel. System messages are not currently stored in channel history.
(
channelId: number,
message: {
text: string,
headerText: string?,
backgroundColor3: Color3?,
icon: string?,
iconColor3: Color3?,
iconRounded: boolean?,
sideText: string?,
sideAccent: Color3?,
}
) -> nil
Parameters
channelId: number- the channel id to send the message tomessage: ...- the message data to send
Example Usage
serverAPI:createSystemMessage(1, {
text = "Hello, World!",
sideText = "test",
})
activatePlayersVoice
Attempts to activate/deactivate a players voice communications
(
channelId: number,
player: Player
) -> nil
Parameters
channelId: number- the channel id to useplayer: Player- the player to attempt this on
Example Usage
serverAPI:activatePlayersVoice(1, game.Players.parker02311)