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-07-09 22:14:50 -05:00 committed by GitHub
parent dd7e3c91b0
commit 661540efe2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/lua/openstarbound.md
View File

@ -76,6 +76,16 @@ Returns the asset source path of an asset, or nil if the asset doesn't exist. If
Without metadata: Returns an array with all the asset source paths. Without metadata: Returns an array with all the asset source paths.
With metadata: Returns a table, key/value being source path/metadata. With metadata: Returns a table, key/value being source path/metadata.
#### `?` root.assetImage(`String` image)
*TODO*
#### `JsonArray` root.assetPatches(`String` asset)
Returns a list of asset sources which patch the specified asset and the paths to those patches.
---
#### `Json` root.getConfiguration(`String` key) #### `Json` root.getConfiguration(`String` key)
Gets a configuration value in `/storage/starbound.config`. Gets a configuration value in `/storage/starbound.config`.
@ -96,18 +106,14 @@ Sets a configuration value in `/storage/starbound.config` by path.
*Both setters will error if you try to set `safeScripts`, as that can break Starbound's sandbox.* *Both setters will error if you try to set `safeScripts`, as that can break Starbound's sandbox.*
#### `Json` root.assetImage(`String` image) ---
*TODO*
#### `Json` root.assetPatches(`String` asset)
*TODO*
#### `JsonArray` root.allRecipes() #### `JsonArray` root.allRecipes()
Returns all recipes. Returns all recipes.
---
# Player # 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. The player table now contains bindings which contains functions to save/load, access and modify the player's identity, mode, aim, emote and more.