Custos:Server

Information

These are Custos class server side functions.

Group Functions

• Custos.CreateGroup([string]group id, [string]group name, [table]color object, [string]group parent, [table]group permissions, [integer]immunity)

  Creates a group, groups are automatically saved to the database when the server shuts down.

• Custos.CreateDefaultGroups()

  Adds the default groups.

• Custos.LoadGroups()

  Loads all the groups from the database.

• Custos.UnloadGroups()

  Saves all groups to the database then clears the group table.

• Custos.ReloadGroups()

  Reloads all groups.

• Custos.SaveGroups()

  Saves every group to the database.

• Custos.CheckGroupPerm([string]group id, [string]permission)

  Checks if the specified group has access to a permission.

• Custos.AddGroupPerm([string]group id, [string]permission)

  Adds the specified group permission to the group's table.

• Custos.RemoveGroupPerm([string]group id, [string]permission)

  Removes the specified group permission from the group.

• Custos.GetGroupPerms([string]group id)

  Returns the specified group's permission table.

• Custos.GetGroupImmunity([string]group id)

  Returns the specified group's immunity integer.

• Custos.GetGroupDisplay([string]group id)

  Returns the specified group's display name.

• Custos.GetGroupParent([string]group id)

  Returns the specified group's parent group.

• Custos.GetGroupColor([string]group id)

  Returns the specified group's Color object.

User Functions

• Custos.LoadUsers()

  Loads all users from the database.

• Custos.SaveUsers()

  Saves all users to the database.

• Custos.AddUser(player, [string]group id)

  Adds player to a user group.

• Custos.UnloadUsers()

  Saves all users to the database and unloads the user table.

• Custos.ReloadUsers()

  Reloads all users.

Other Functions

• Custos.WriteLog([string]log prefix, [string]body)

  Writes to the log file.

• Custos.FindPlayer(string, player, [boolean]unrestricted)

  Finds and returns selected player's object from a player's partial name.

• Custos.AddConCommand([string]name, [callback], [string]permission, [string]help)

  Creates a console command restricted by a permission.

• Custos.AddChatCommand([string]name, [string]console command)

  Creates a chat command that runs a console command.

• Custos.RemoveChatCommand([string]chat command)

  Removes a chat command.

• Custos.Query([string]query, ...)

  Runs a safe SQL query.