Skip to main content

Developer Documentation

Information​

The exports noted below can be used in any other script that you have in your config. You can handle channels and permissions / access to the channels via these exports.\ You can find further exports in either mumble-voip's or pma-voice's README's.

Exports List (Clientsided)​

HasAccess​

local access = exports["zerio-radio"]:HasAccess(frequency<number>)

This export takes a single parameter, which is the radio frequency to check. It returns a boolean (true or false) depending on if the local player has access to the channel or not.

ChangeChannel​

local changed = exports["zerio-radio"]:ChangeChannel(frequency<number>)

This export takes a single parameter, which is the radio frequency to join. It returns a boolean (true or false) depending on if the player successfully joined the channel. If false is return, you can sefely assume that the player didnt join the channel and most likely doesnt have access to it.

This export is exactly the same as what is used in the radio, so notifications and access checking is included.

Exports List (Serversided)​

DoesChannelExist​

local exists = exports["zerio-radio"]:DoesChannelExist(frequency<number>)

This export takes a single parameter, which is the radio frequency to check. It returns a boolean (true or false) depending on if the channel exists or not.

CreateChannel​

local created = exports["zerio-radio"]:CreateChannel(frequency<number>, data<table>)

This export takes 3 parameters, the frequency / channel number and the actual radio data. The data parameter should be the same structure as it is in the config.lua of zerio-radio.\ The export returns a boolean (true or false) depending on if the channel was successfully created. If the channel isnt successfully created, an warning with further info will be shown in your server console.

RemoveChannel​

local removed = exports["zerio-radio"]:RemoveChannel(frequency<number>)

This export only takes one parameter, which is the frequency to remove.\ The export returns a boolean (true or false) depending on if the channel was successfully removed. If false is returned then you may assume that the channel doesnt exist.

GiveAccessToChannel​

local success = exports["zerio-radio"]:GiveAccessToChannel(frequency<number>, value<string>)

This export takes 2 parameters, the frequency of the channel and the value which should be whitelisted, such as the discord role, identifier etc (depends on the channel).\ The export returns a boolean (true or false) depending on if the access was successfully added. If false is returned, you may assume that the channel doesnt exist.

RemoveAccessFromChannel​

local removed = exports["zerio-radio"]:RemoveAccessFromChannel(frequency<number>, value<string>)

This export takes 2 parameters, the frequency of the channel and the value which should be removed access from the channel, such as the discord role, identifier etc (depends on the channel).\ The export returns a boolean (true or false) depending on if the access was successfully added. If false is returned, you may assume that the channel doesnt exist.