diff options
Diffstat (limited to 'doc/lua/commandprocessor.md')
| -rw-r--r-- | doc/lua/commandprocessor.md | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/lua/commandprocessor.md b/doc/lua/commandprocessor.md new file mode 100644 index 0000000..941f499 --- /dev/null +++ b/doc/lua/commandprocessor.md @@ -0,0 +1,7 @@ +The command processor has a single binding for performing admin checks, available on the *CommandProcessor* table. + +--- + +#### `String` CommandProcessor.adminCheck(`ConnectionId` connectionId, `String` actionDescription) + +Checks whether the specified connection id is authorized to perform admin actions and returns `nil` if authorization is succesful. If unauthorized, returns a `String` error message to display to the client requesting the action, which may include the specified action description, such as "Insufficient privileges to do the time warp again." |