Skip to content

Configuration

Jump to bottom
Adam edited this page Apr 2, 2022 · 1 revision

General

spacing

Type: integer
Default: 10
Description: The number of blocks before a new highlight element is added to a boundary.
Note: Smaller numbers will yield more distinct boundaries, but may be too visually cluttered.

viewDistance

Type: integer
Default: 150
Description: The distance at which an element will be sent to the player.
Note: For type GLOWING_ENTITY, the client may not render entities at a certain distance depending on settings. Clients may wish to increase their entity view distance (Options -> Video Settings -> Entity Distance slider). Supposedly the slider is a percentage of a 160 block radius, but in practice the render distance appears much shorter.

displaySeconds

Type: integer
Default: 60
Description: The number of seconds the elements will be visualized for.
Note: Unlike GP's visualizations, GPBHB's visualizations do not disappear when interacted with.

type

Type: HighlightType enum constants (Options: DEBUG_BLOCK, GLOWING_ENTITY; source)
Default: GLOWING_ENTITY
Description: The type of highlight element to use.
Note:

  • DEBUG_BLOCK is an unofficial undocumented client feature and may be removed in future versions. While it accepts full RGBA colors, it only renders the green and alpha elements.
  • GLOWING_ENTITY is limited to Minecraft team colors (legacy chat colors). An effort is made to match the closest legacy color from the RGBA color when using this mode, but results may vary. For a guarantee, use exact colors as defined on the wiki: https://minecraft.fandom.com/wiki/Formatting_codes#Color_codes
  • Depending on adapter used, certain highlight types are not available. PacketEvents1 does not have the capacity to send entity data, so only DEBUG_BLOCK is available when using it. PacketEvents2 does not have the capacity to send custom payloads, so only GLOWING_ENTITY is available when using it.

style

Type: HighlightStyle enum constants (Options: FLAT, SNAP_TO_SURFACE; source)
Default: FLAT
Description: The style of visualization used.
Note:

  • FLAT is a flat display below the user that does not conform to terrain.
  • SNAP_TO_SURFACE attempts to snap to nearby surfaces (similar to how GP's display works), but is often very visually cluttered and confusing. This style may be removed or changed in the future.

Colors

Colors are configured in full RGBA but may appear differently depending on type. See notes for each type for particulars. Each color is configured via a section found at the path colors.<VisualizationType>.<VisualizationElementType>. The section has fields red, green, blue, and alpha (saturation/lack of transparency), all of which are integers constrained between 0 and 255. Fields that are not declared will default to 255, full color and no transparency.

<VisualizationType>: name of enum constant provided by GriefPrevention. (Options: CLAIM, ADMIN_CLAIM, SUBDIVISION, INITIALIZE_ZONE, CONFLICT_ZONE, NATURE_RESTORATION_ZONE; source)
<VisualizationElementType>: name of enum constant (Options: CORNER, SIDE; source)

For example, to declare the color of player claim boundaries, use the VisualizationType CLAIM. This will then have subsections CORNER and SIDE, each of which will have the RGBA fields.

colors:
  CLAIM:
    # Minecraft gold
    CORNER:
      red: 255
      green: 170
      blue: 0
      alpha: 255
    # Minecraft yellow
    SIDE:
      red: 255
      green: 255
      blue: 85
      alpha: 255
Clone this wiki locally