From 54b8f83b8507b56e0a4ecbb5a666c928c6ded1a9 Mon Sep 17 00:00:00 2001 From: Bottinator22 <59987380+Bottinator22@users.noreply.github.com> Date: Sat, 28 Dec 2024 21:23:16 -0800 Subject: [PATCH] Documentation for renderer --- doc/lua/openstarbound.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/doc/lua/openstarbound.md b/doc/lua/openstarbound.md index 4d948bf..f4eff06 100644 --- a/doc/lua/openstarbound.md +++ b/doc/lua/openstarbound.md @@ -564,3 +564,42 @@ teleportOut
#### `List` 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. + +---