Skip to main content

HudItem

Provides properties and functions to interact with an HudItems in the world.

Properties

id

The ID of the hud element. This property is read-only.

position

The position of the item on-screen.

size

The size of the item.

anchorMin

The min anchor of the item.

anchorMax

The max anchor of the item.

pivot

The pivot of the item.

fontStyle

Font style of the item.

fontSize

Font size of the item.

foregroundColor

Foreground color of the item.

backgroundColor

Background color of the item.

borderColor

Border color of the item.

borderRounded

Indicates whether the item has a rounded border.

borderRadius

Radius values for rounding individual item corners. Starts from the top-left and goes clockwise.

borderWidth

Width of outline around the item.

anchor

The anchors of the item. Sets both min and max anchors.

textColor

The text color of the item. This will override foregroundColor property.

text

The text content of the item.

name

The name of the item.

isVisible

Controls visibility of the item for each specific player.