Button Preview Settings

Settings for the Button Preview Box on the Region Map.

Table of Contents

Function of the Setting

The Button Preview Settings Section includes various Settings to change the behavior of the Button Preview Box on the Region Map. Which is used to tell you which Actions are available on the current position and mode on the Region Map.
It allows you to:

  • Change the Position of the Preview.
  • Change the Opacity.
  • Add an Offset to the Text Position.
  • Change the Text Color.
  • Edit the time interval between each action display.

ButtonBoxPosition

Use this Setting to change the Position of the Button Preview on the Region Map.


Example v3.0.0+ (Essentials v21.1+)

1
ButtonBoxPosition = 3

Example ≤ v2.7.0 (Essentials v20.1)

1
BUTTON_BOX_POSITION = 3

Possible Values

  • 1 = displayed on the Top Left.
  • 2 = displayed on the Bottom Left.
  • 3 = displayed on the Top Right.
  • 4 = displayed on the Bottom Right.
  • nil = not displayed at all.

ButtonBoxOpacity

Use this Setting to change the Opacity of the Button Preview when the cursor is partly or completely behind it on the Region Map. This keeps the Cursor visible in case the Player would have lost sight of it.


Example v3.0.0+ (Essentials v21.1+)

1
ButtonBoxOpacity = 50

Example ≤ v2.7.0 (Essentials v20.1)

1
BUTTON_BOX_OPACITY = 50

Possible Values

  • 50 = There'll be 50% opacity when the cursor is behind the Button Preview.

ButtonBoxTextOffset

Use these Settings to add a small offset to the X and/or Y Position of the Button Preview Text on the Region Map.


Example v3.0.0+ (Essentials v21.1+)

1
ButtonBoxTextOffsetX = 0
2
ButtonBoxTextOffsetY = 0

Example ≤ v2.7.0 (Essentials v20.1)

1
BUTTON_BOX_TEXT_OFFSET_X = 0
2
BUTTON_BOX_TEXT_OFFSET_Y = 0

Possible Values

The offset value may as well be nagative as postive depending on your needs. Only round numbers are allowed.

ButtonBoxTextColor

Use these Settings to change the main and shadow color of the Button Preview Text on the Region Map/


Example v3.0.0+ (Essentials v21.1+)

1
ButtonBoxTextMain = Color.new(248, 248, 248)
2
ButtonBoxTextShadow = Color.new(0, 0, 0)

Example ≤ v2.7.0 (Essentials v20.1)

1
BUTTON_BOX_TEXT_MAIN = Color.new(248, 248, 248)
2
BUTTON_BOX_TEXT_SHADOW = Color.new(0, 0, 0)

Possible Values

The 3 arguments passed to Color.new() must have a value between 0 and 255 and represent Red, Green and Blue respectivly.

ButtonPreviewTimeChange

Use this Setting to change the time interval between each Action change on the Button Preview.


Example v3.0.0+ (Essentials v21.1+)

1
ButtonPreviewTimeChange = 3

Example ≤ v2.7.0 (Essentials v20.1)

1
BUTTON_PREVIEW_TIME_CHANGE = 3

Possible Values

  • 3 = The action displayed will change every 3 seconds.