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

summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSilverSokolova <80606782+SilverSokolova@users.noreply.github.com>2024-12-11 00:18:08 -0600
committerGitHub <noreply@github.com>2024-12-11 00:18:08 -0600
commit341a9a3556cf47c21a6d1776d66f0708b873de01 (patch)
tree7d248d22c2d969788a89584f919aec55127c4d4e /doc
parent65741d697277e3b5e2f4d8c2d77d06316ec6948c (diff)
Update openstarbound.md
Diffstat (limited to 'doc')
-rw-r--r--doc/lua/openstarbound.md80
1 files changed, 77 insertions, 3 deletions
diff --git a/doc/lua/openstarbound.md b/doc/lua/openstarbound.md
index d520705..4d948bf 100644
--- a/doc/lua/openstarbound.md
+++ b/doc/lua/openstarbound.md
@@ -78,9 +78,11 @@ With metadata: Returns a table, key/value being source path/metadata.
#### `Image` root.assetImage(`String` image)
-#### `Json` root.assetFrames(`String` path)
+Returns an image.
-*TODO*
+#### `Json` root.assetFrames(`String` imagePath)
+
+Returns an array containing a `file` (the frames file used for the image) and `frames` (the frame data of the image).
#### `JsonArray` root.assetPatches(`String` asset)
@@ -132,7 +134,7 @@ Sets the HUD's visibility.
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 functions on that pane.
+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>
@@ -173,6 +175,74 @@ Returns the scale used for interfaces.
---
+# World
+
+The world table now contains extra bindings.
+
+---
+
+#### `bool` world.isServer()
+
+Returns whether the script is running on the server or client.
+
+---
+
+#### `bool` world.isClient()
+
+Returns whether the script is running on the server or client.
+
+---
+
+The following additional world bindings are available only for scripts running on the client.
+
+---
+
+#### `entityId` world.mainPlayer()
+
+Returns the entity ID of the player hosting the world.
+
+---
+
+#### `Vec2F` world.entityAimPosition(`entityId` entityId)
+
+Returns the current cursor aim position of the specified entity.
+
+---
+
+#### `bool` world.inWorld()
+
+Returns whether any players are in the world.
+
+---
+
+The following additional world bindings are available only for scripts running on the server.
+
+---
+
+#### `void` world.setExpiryTime(`float` expiryTime)
+
+Sets the amount of time to persist a ephemeral world when it is inactive.
+
+---
+
+#### `string` world.id()
+
+Returns a `String` representation of the world's id.
+
+---
+
+#### `?` world.callScriptContext(`?` ?)
+
+TODO
+
+---
+
+#### `?` world.sendPacket(`?` ?)
+
+?
+
+---
+
# Player
The player table now contains bindings which contains functions to save/load, access and modify the player's identity, mode, aim, emote and more.
@@ -490,3 +560,7 @@ teleportIn<br>
teleportOut<br>
</details>
---
+
+#### `List<Json>` player.teamMembers()
+
+Returns an array, each entry being a table with `name`, `uuid`, `entity`, `healthPercentage` and `energyPercentage`