Skip to content

CommandInfo

Brian edited this page Jun 11, 2015 · 1 revision

This structure is used to set up commands.

Structure

  • syntax - A string that hints how the command is used.
  • onRun - A function that gets called with the player and a table of arguments passed when the command is ran. Note that you can return a string to notify the player. If the string starts with an ampersand (@) then the string will be translated.
  • onCheckAccess - An optional callback to determine if the player can use a command.
  • adminOnly - A boolean to determine if the player must be an administrator to use the command. This can be overriden by the onCheckAccess callback.
  • superAdminOnly - Same as the above, except the player must be a super administrator.
  • group - Either a string or a table of strings that determine allowed usergroups.