Overlay Nausea

Overlays a texture sprite on the screen of the player, with the alpha component of the color being the intensity of the color and stretch factor of the texture.

Type ID: kaya:overlay/nausea

Info

This HUD element type blends the colors to the texture additively. It also treats black pixels in the texture as transparent.

Tip

Custom overlay textures must be placed in the assets/<namespace>/textures/overlay/sprites directory of a resource pack to be recognized and used properly.

Format

Field	Type	Default	Description
sprite	Sprite or Identifier		The sprite definition or ID of the overlay to render. If an ID is specified, it will implicitly use the kaya:textures/atlas/overlay.png atlas.
color	Color	optional	The color to blend to the colors of the texture sprite.
render_phase	Render Phase		Determines when the overlay should be rendered.
should_render	Boolean Provider	true	Determines whether the overlay should render.
hide_with_hud	Boolean Provider	true	Determines whether the overlay should hide alongside the HUD. (e.g: when pressing F1)
visible_in_third_person	Boolean Provider	true	Determines whether the overlay should be visible when in third person.

Example

{
    "type": "kaya:overlay/nausea",
    "sprite": "example:nausea_overlay"/*(1)!*/,
    "color": "#32c5ff9d",
    "render_phase": "below_hud",
    "hide_with_hud": false
}

This example renders a light blue and slightly transparent overlay that doesn't hide when the HUD is hidden.

1. The location for the texture file in a resource pack is assets/example/textures/overlay/sprites/nausea_overlay.png

History

Minecraft	Mod	Changelog
1.21.5	0.1.0	Added the type.