Button

A clickable UI element, with a different look for each state.

Work in progress

In game UI is still in development

A button needs a Widget on the same entity, under a Canvas. Each state (normal, hovered, clicked and disabled) can have its own texture and tint. A Lua Script on the entity receives OnPressed(), OnReleased(), OnHovered() and OnUnHovered().

Scene file

Saved as a <Button> element inside the entity's <Entity> element. Attributes that are left out keep their default. See Scene Files for how values like vectors, colours and file paths are written.

<Button>
    <NormalTexture Filepath="UI/Button.png" FilterMethod="0" WrapMethod="0"/>
    <HoveredTexture Filepath="UI/ButtonHover.png" FilterMethod="0" WrapMethod="0"/>
    <NormalTint R="1" G="1" B="1" A="1"/>
    <HoveredTint R="1" G="1" B="1" A="1"/>
    <ClickedTint R="0.8" G="0.8" B="0.8" A="1"/>
    <DisabledTint R="0.5" G="0.5" B="0.5" A="1"/>
</Button>

Name	Where	Type	Default
NormalTexture HoveredTexture ClickedTexture DisabledTexture	children, optional	texture: Filepath, FilterMethod, WrapMethod	none
NormalTint HoveredTint ClickedTint DisabledTint	child R G B A	float, 0-1	white

Lua scripting

Properties

• ClickedTint (Colour): Tint applied to the clicked state's texture
• DisabledTint (Colour): Tint applied to the disabled state's texture
• HoveredTint (Colour): Tint applied to the hovered state's texture
• NormalTint (Colour): Tint applied to the normal state's texture