evert/osb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update openstarbound.md

Browse Source
This commit is contained in:
SilverSokolova 2024-12-11 00:18:08 -06:00 committed by GitHub
parent 65741d6972
commit 341a9a3556
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 77 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
doc/lua/openstarbound.md
View File

@ -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>
@ -171,6 +173,74 @@ TODO
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
@ -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`