Package org.geysermc.geyser.api.bedrock.camera

Interface CameraFade

public interface CameraFade
Represents a coloured fade overlay on the camera.

Can be sent with CameraData.sendCameraFade(CameraFade), or with a CameraPosition instruction.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    CameraFade.Builder
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static CameraFade.Builder
    builder()
    Creates a Builder for CameraFade
    Color
    color()
    Gets the color overlay of the camera.
    float
    fadeHoldSeconds()
    Gets the seconds the overlay is held.
    float
    fadeInSeconds()
    Gets the seconds it takes to fade in.
    float
    fadeOutSeconds()
    Gets the seconds it takes to fade out.

  • Method Details

    • color

      Color color()
      Gets the color overlay of the camera. Bedrock uses an RGB color system.
      Returns:
      the color of the fade

    • fadeInSeconds

      float fadeInSeconds()
      Gets the seconds it takes to fade in. All fade times combined must take at least 0.5 seconds, and at most 30 seconds.
      Returns:
      the seconds it takes to fade in

    • fadeHoldSeconds

      float fadeHoldSeconds()
      Gets the seconds the overlay is held. All fade times combined must take at least 0.5 seconds, and at most 30 seconds.
      Returns:
      the seconds the overlay is held

    • fadeOutSeconds

      float fadeOutSeconds()
      Gets the seconds it takes to fade out. All fade times combined must take at least 0.5 seconds, and at most 30 seconds.
      Returns:
      the seconds it takes to fade out

    • builder

      static CameraFade.Builder builder()
      Creates a Builder for CameraFade
      Returns:
      a CameraFade Builder