Веб-сайт самохостера Lotigara

summaryrefslogtreecommitdiff
path: root/doc/lua/commandprocessor.md
diff options
context:
space:
mode:
authorKae <80987908+Novaenia@users.noreply.github.com>2023-06-20 14:33:09 +1000
committerKae <80987908+Novaenia@users.noreply.github.com>2023-06-20 14:33:09 +1000
commit6352e8e3196f78388b6c771073f9e03eaa612673 (patch)
treee23772f79a7fbc41bc9108951e9e136857484bf4 /doc/lua/commandprocessor.md
parent6741a057e5639280d85d0f88ba26f000baa58f61 (diff)
everything everywhere
all at once
Diffstat (limited to 'doc/lua/commandprocessor.md')
-rw-r--r--doc/lua/commandprocessor.md7
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."