From 6352e8e3196f78388b6c771073f9e03eaa612673 Mon Sep 17 00:00:00 2001
From: Kae <80987908+Novaenia@users.noreply.github.com>
Date: Tue, 20 Jun 2023 14:33:09 +1000
Subject: everything everywhere

all at once
---
 doc/lua/commandprocessor.md | 7 +++++++
 1 file changed, 7 insertions(+)
 create mode 100644 doc/lua/commandprocessor.md

(limited to 'doc/lua/commandprocessor.md')

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."
-- 
cgit v1.2.3