Skip to content

Buttons

Ilya Maximov edited this page Jan 14, 2019 · 5 revisions

Buttons execute actions when pressed. They can open guis (custom ones as well) or for example connect to a server, open a link or load a specific world.

Properties:

  • posX : x-coordinate of the button
  • posY : y-coordinate of the button
  • width : width of the button
  • height : height of the button,
  • imageWidth : width of the button in the image (default: height),
  • imageHeight : height of the button in the image (default: width),
  • texture : (optional) a resource location that will be used as a custom texture for this button. The image has to contain a normal and a hover version of the button. This is an example for a 200x20 button.
  • text : the Text that is displayed on the button (A language key or just normal text) hoverText : the Text that is displayed on the button when the user hovers over it (A language key or just normal text)
  • normalTextColor : (optional) a rgb color integer for the normal text color of the button
  • hoverTextColor : (optional) a rgb color integer for the text color of the button when the mouse is above it
  • pressSound : (optional) a resource location that points towards the sound this button makes when pressed
  • hoverSound : (optional) a resource location that points towards the sound this button makes when hovered
  • tooltip : (optional) The Tooltip Text that will be displayed when the user hovers over this button.
  • action : (optional) what the button will do when its clicked, see Actions for more information.
  • wrappedButton : (optional) The Button ID, see Wrapped Buttons for more information.
  • alignment : (optional) see Alignment for information
  • textOffsetX/Y (optional): The Button text will be offset by this amount.