Skip to content

K.Admin ​

Functions ​

K.Admin.LevelOf ​

lua
K.Admin.LevelOf(player: Player?): number

Server: LevelOf(player). Client: LevelOf() for yourself. 0 means a regular player.

K.Admin.CanAffect ​

lua
K.Admin.CanAffect(admin: Player, target: Player): boolean

True if admin may use commands on target: themselves, or someone with a lower level.

K.Admin.Role ​

lua
K.Admin.Role(name: string, options: { Level: number, Users: { number }?, Group: number?, MinRank: number? })

A group of people with a level. Members are listed by user id, or by group rank.

K.Admin.Command ​

lua
K.Admin.Command(name: string, options: { Level: number?, Args: { string }?, Description: string?, Run: (Player, ...any) -> string? })

Adds a command. Run(admin, ...arguments) can return a message for the admin.

K.Admin.Run ​

lua
K.Admin.Run(...: any): (boolean, string?)

Server: Run(player, "/kick bob") -> (ran, message). Client: Run("/kick bob") asks the server.

K.Admin.Ban ​

lua
K.Admin.Ban(target: Player | number, options: { Minutes: number?, Reason: string?, By: Player? }?): boolean

Bans a player (or user id) from every server, for Minutes or forever. Yields. Uses Roblox's ban system (which also catches alt accounts) when it's available.

K.Admin.Unban ​

lua
K.Admin.Unban(userId: number): boolean

Lifts a ban. Yields.

K.Admin.BanReason ​

lua
K.Admin.BanReason(userId: number): string?

The reason if Corode's own ban list has this user banned right now, otherwise nil. Yields. That list is only used when Roblox's ban system was unavailable; bans made through Roblox's system are enforced (and lifted in the Creator Dashboard) by Roblox itself.

Events ​

K.Admin.Used ​

Server: fires with (admin, commandName, arguments) after every command that ran.

Generated from src/Corode/Admin.luau.

Corode 0.13.0 · MIT License