Interface GeneralConfig

public interface GeneralConfig

  • Method Details

    • storageType

      Nameable storageType()
      Defined the used storage type.
      Returns:
      name of storage type

    • isPreviewDefault

      boolean isPreviewDefault()
      Defines if the preview should be enabled by default.
      Returns:
      true when preview should be enabled

    • isShowNameDefault

      boolean isShowNameDefault()
      Defined if names should be always shown by default
      Returns:
      true when names should be shown by default

    • defaultNameChannel

      MessageChannel defaultNameChannel()
      The default channel for brush messages. One of MessageChannel
      Returns:
      the message channel implementation

    • previewRefreshInterval

      int previewRefreshInterval()
      The refresh interval for each player of the rendering preview.
      Returns:
      the refresh interval in ticks

    • maxRenderMs

      int maxRenderMs()
      The max amount of ms, which can be used by the renderer in one tick (50 ms)
      Returns:
      the amount in ms

    • renderDistance

      int renderDistance()
      The max distance of the render origin and the brush owner
      Returns:
      the distance in blocks

    • renderDistanceSquared

      double renderDistanceSquared()
      The max distance of the render origin and the brush owner
      Returns:
      the distance in blocks

    • maxRenderSize

      int maxRenderSize()
      The max render size. This is the size of the schematic based on the bounds including air blocks.

      See maxEffectiveRenderSize() for the size without air blocks

      Returns:
      the max render size in blocks

    • isOutOfRenderRange

      default boolean isOutOfRenderRange(Location origin, Location other)
      Checks whether two locations are too far apart to render a preview. Locations in different worlds are always out of range.
      Parameters:
      origin - the first location
      other - the second location
      Returns:
      true if the locations are in different worlds or further apart than renderDistance()

    • maxEffectiveRenderSize

      int maxEffectiveRenderSize()
      The max effective render size. This is the size of a schematic excluding air blocks
      Returns:
      the effective render size in blocks

    • pasteBreak

      int pasteBreak()

    • previewResync

      int previewResync()
      The interval in which every preview is sent again completely, to repair blocks the client lost without notice.
      Returns:
      the interval in seconds, 0 if previews are never resent completely

    • language

      String language()

    • editor

      EditorType editor()
      Editor shown to players who did not choose one.
      Returns:
      editor type