Skip to content

Decal Registry

earthwise edited this page Jan 1, 2025 · 4 revisions

sorbet helper wiki - Decal Registry

Table of Contents

Note

see the everest wiki page for the Decal Registry if you're unfamiliar!

<sorbetHelper_lightCover>

makes decals block/cover up any light touching them

has the following variables:

  • alpha(float) - the strength of the light cover. defaults to 1.0
  • maximumDepth(int) - the maximum (farthest from the camera) depth a decal can have while being affected. defaults to -1 to only affect decals above madeline
  • minimumDepth(int) - the minimum (closest to the camera) depth a decal can have while being affected. defaults to uncapped.

by default only affects decals placed above the player (so that, e.g. you don't need to worry about background decals unintentionally blocking light in front), but the depth requirements can be changed via the aforementioned minimumDepth and maximumDepth variables if wanted for whatever reason

examples:

<sorbetHelper_lightCover/>
<sorbetHelper_lightCover alpha="0.7"/>
<sorbetHelper_lightCover maximumDepth="100"/>

also available in controller form as the Light Cover Controller


Note

while kinda similar in theory, this is different from the everest built-in <lightOcclude> attribute
instead of defining an arbitrary rectangle that light cannot enter, this exactly covers the decal's sprite, and only "covers up" the light while still letting it pass by

<sorbetHelper_styleground>

allows decals to be drawn as part of a styleground layer!

has the following variables:

  • (required) rendererTag(string) - a styleground tag used to match with an Entity As Styleground Renderer styleground in the map.
  • maximumDepth(int) - the maximum (farthest from the camera) depth a decal can have while being affected. defaults to uncapped.
  • minimumDepth(int) - the minimum (closest to the camera) depth a decal can have while being affected. defaults to uncapped.

Note

will not work correctly if either the rendererTag variable or matching renderer itself is missing!!

examples:

<sorbetHelper_styleground rendererTag="clouds_bg"/>
<sorbetHelper_styleground rendererTag="decals_fg" maximumDepth="-1000"/>

also available in controller form as the Entity As Styleground Controller

Clone this wiki locally