From 060fdb655039e735cc731aa28dbbd4f821d897c1 Mon Sep 17 00:00:00 2001
From: Bottinator22 <59987380+Bottinator22@users.noreply.github.com>
Date: Sat, 8 Feb 2025 13:09:52 -0800
Subject: move new interface bindings to their own file (also minor formatting
 changes)

---
 doc/lua/openstarbound/interface.md | 63 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 63 insertions(+)
 create mode 100644 doc/lua/openstarbound/interface.md

(limited to 'doc/lua')

diff --git a/doc/lua/openstarbound/interface.md b/doc/lua/openstarbound/interface.md
new file mode 100644
index 0000000..1214865
--- /dev/null
+++ b/doc/lua/openstarbound/interface.md
@@ -0,0 +1,63 @@
+---
+# Interface
+
+The interface table contains bindings which allow scripts to display a message at the bottom of the screen, among other things.
+
+---
+
+#### `void` interface.queueMessage(`String` message, [`float` cooldown, [`float` springState]])
+
+Queues a message popup at the bottom of the screen with an optional **cooldown** and **springState**.
+
+---
+
+#### `void` interface.setHudVisible(`bool` visible)
+
+Sets the HUD's visibility.
+
+#### `bool` interface.hudVisible()
+
+Returns the HUD's visibility.
+
+#### `PaneId` interface.bindRegisteredPane(`string` paneName)
+Binds a registered pane (defined in `/source/frontend/StarMainInterfaceTypes`) to a Lua value, which can then call widget functions on that pane.
+<details><summary><b>Panes</b></summary>
+EscapeDialog<br>
+Inventory<br>
+Codex<br>
+Cockpit<br>
+Tech<br>
+Songbook<br>
+Ai<br>
+Popup<br>
+Confirmation<br>
+JoinRequest<br>
+Options<br>
+QuestLog<br>
+ActionBar<br>
+TeamBar<br>
+StatusPane<br>
+Chat<br>
+WireInterface<br>
+PlanetText<br>
+RadioMessagePopup<br>
+CraftingPlain<br>
+QuestTracker<br>
+MmUpgrade<br>
+Collections<br>
+</details>
+
+#### `void` interface.displayRegisteredPane(`string` paneName)
+Displays a registered pane.
+
+---
+
+#### `?` interface.bindCanvas()
+TODO
+
+---
+
+#### `int` interface.scale()
+Returns the scale used for interfaces.
+
+---
-- 
cgit v1.2.3