BanIt Documentation

Thank you for taking interest in BanIt! The following is the documentation on how to use it.

(you can get the module here [this is the real one, it has been brought to my attention there are fake ones, please use this real one]:

and for an up-to-date version, check this out:

)

Example Unban script

local BanIt = require(6451678459)

BanIt.Unban("Ty_Scripts")

Yep… it’s that simple!

BanIt.ServerBan(string playerToBan, string (optional) reason)

ServerBan works by banning players from the server, but not from the game. Takes 2 parameters: playerToBan (required) and reason (optional).
Troubleshooting

  • Make sure that playerToBan is a string containing only the username of the user being banned.
  • Make sure you aren’t calling ServerBan multiple times at once, or Unban functions may not work.

BanIt.Ban(string playerToBan, string (optional) reason)

Ban works by banning players from the entire game until Unban is called. Takes 2 parameters: playerToBan (required) and reason (optional).
Troubleshooting

  • Make sure that playerToBan is a string containing only the username of the user being banned.
  • Make sure you aren’t calling Ban multiple times at once, or Unban functions may not work.

BanIt.ServerUnban (string playerToUnban)

ServerUnban works by unbanning the player from a ServerBan, not by unbanning a Banned player from that server only. Takes just one required parameter: playerToUnban.
Troubleshooting

  • Make sure that playerToBan is a string containing only the username of the user being banned.
  • Make sure you did not ban the player multiple times, or you will have to run Unban multiple times.

BanIt.Unban(string playerToUnban)

Unban works by unbanning a player from a Ban. It does not unban a player from a ServerBan.
Troubleshooting

  • Make sure that playerToBan is a string containing only the username of the user being banned.
  • Make sure you did not ban the player multiple times, or you will have to run Unban multiple times.

BanIt.TimedBan(string playerToBan, number length, string type)

TimedBan works by having a number and type input into it, like so:

BanIt.TimedBan("Ty_Scripts", 2, "days")

Accepted types are:

  • seconds
  • minutes
  • hours
  • days

Troubleshooting

  • Make sure that playerToBan is a string containing only the username of the user being banned .
  • Make sure a type is input along with the length–it is required!

BanIt.TimedUnban(string playerToBan)

Unbans a timed ban player.

BanIt.ShadowBan(string playerToBan)

ShadowBan lets the player play the game for 45 seconds, albeit with low WalkSpeed and JumpPower, then kicks them with a phony yet convincing error message.
For troubleshooting, see troubleshooting for BanIt.Ban.

BanIt.ShadowUnban(string playerToUnban)

Unbans a user from a ShadowBan.

BanIt.SetUnbannable(string playerToSave)

Makes a user unable to be banned.

BanIt.SetBannable(string playerToRisk)

Makes a user able to be banned.

BanIt.GroupBan(int groupId)

Makes a group’s members banned. Sorry, but this has to use groupId rather than name for now, this may change in the future!

BanIt.GroupUnban(int groupId)

Makes a group’s members unbanned. Sorry, but this has to use groupId rather than name for now, this may change in the future!

BanIt.RankBan(int groupId, string roleName)

Makes a group’s specific role’s members banned. Sorry, but this has to use groupId rather than name for now, this may change in the future!

BanIt.RankUnban(int groupId, string roleName)

Makes a group’s specific role’s members unanned. Sorry, but this has to use groupId rather than name for now, this may change in the future!

Potentially more coming soon… :eyes: Make sure to suggest changes at BanIt - Simple ban module for anyone!

3 Likes