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

Merge pull request #159 from Bottinator22/main

Browse Source 
Documentation for renderer
This commit is contained in:
Bottinator22 2024-12-28 21:24:14 -08:00 committed by GitHub
commit fbae5b2223
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 39 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
doc/lua/openstarbound.md
View File

@ -564,3 +564,42 @@ teleportOut<br>
#### `List<Json>` player.teamMembers()
Returns an array, each entry being a table with `name`, `uuid`, `entity`, `healthPercentage` and `energyPercentage`
---
# Renderer
The new renderer table is accessible from almost every clientside script and allows configuring shaders.
---
#### `void` renderer.setPostProcessGroupEnabled(String group, bool enabled, [bool save])
Enables or disables a post process shader group. If save is true, this change is saved to configuration as well.
---
#### `bool` renderer.postProcessGroupEnabled(String group)
Returns true if the specified post process group is enabled.
---
#### `Json` renderer.postProcessGroups()
Returns every post process group. Identical to grabbing them from client.config with root.assetJson.
---
#### `Json` renderer.setEffectParameter(String effectName, String parameterName, RenderEffectParameter value)
Sets the specified scriptable parameter of the specified shader effect to the provided value.
This is accessed from the shader as a uniform and must be defined in the effect's configuration.
---
#### `RenderEffectParameter` renderer.getEffectParameter(String effectName, String parameterName)
Returns the specified scriptable parameter of the specified shader effect.
---