Skip to content

User Interface

The Screen UI system maps 2D coordinates to the viewport, overlaying the 3D world. All UI nodes support strict positional offsets, precise scaling, and hierarchical nesting.

UIText

Standard textual readout interface.

  • Content: The string rendered.
  • Font: Target typeface (TrebuchetMSBold, TrebuchetMS).
  • FontSize: Screen-space point size.
  • TextColor / BackgroundColor: The active color schemes.
  • OverallTransparency / BackgroundTransparency: Independent alpha controls.
  • Position / Size / Rotation: Standard 2D transform data.

UIButton

Inherits all properties of UIText, while actively capturing MouseButton1Click, MouseButtonDown, MouseButtonUp, MouseEnter, and MouseLeave signals.

It additionally supports state-driven visual modifications: * HoverTextColor * HoverBackgroundColor * HoverTransparency * HoverBgTransparency

UIImage

Renders fetched asset images.

  • ImageId: Connects to the Web API to fetch the required decal.
  • ImageColor: Tint applied over the image.
  • Transparency: Alpha modifier.
  • ScaleFreely: If false, maintains aspect ratio centered inside the boundaries. If true, explicitly stretches to fill the Size parameter.