This documentation is for a prerelease version of O3DE. Click here to switch to the latest release, or select a version from the dropdown.

Version:

LyShine Component

A UI component for the LyShine (UI 2.0) system. Use it to create custom UI elements that work within the UiCanvas framework: buttons, health bars, inventory slots, and other interactive UI elements. The wizard adds the LyShine gem dependency for you automatically.

The wizard with LyShine UI Component selected

What you’ll fill in:

FieldWhat it does
Add Bus InterfaceOn by default. Generates a companion EBus interface header so other components can talk to this one.
Add Editor Comp.Only shown if your gem has an Editor module. Generates an EditorComponent wrapper so this component shows up and can be edited in the Editor’s Entity Inspector.

Fill in a Component Name. Pick the Gem you’re adding it to. Then select Create. This component appears only in the LyShine UI Editor, in the Add Component menu of the Element Inspector.

For the full generated file list, process commands, and template.json schema, see LyShine Component in the Developer Guide.