nut.command.parse - brianhang/nutscript2 GitHub Wiki

Description

foundCommand = nut.command.parse(speaker, message)

This server function determines which command is being ran and runs the command from the given message.

Parameters

Name Description
speaker The Player that is speaking.
message A string containing what client spoke.

Side Effects

  • A command is ran if matched.
  • The CommandRan hook is called if the command ran and succeeded.
  • The CommandFailed hook is called if the command ran and failed.
  • CommandParsed is called after the parsing and running is done.

Errors

  • message is not a string

Returns

Name Description
foundCommand true if a command was found and the message should be ignored.