API reference
API reference
UIComponent Class
Extends Component<TComponent, TState>
The base class for a UI panel, and the scripting component to attach to a UI Gizmo. It inherits the methods and properties from its parent Component class, with some UI-specialized additions.
Signature
export declare abstract class UIComponent<TComponent = ComponentWithConstructor<Record<string, unknown>>, TState extends SerializableState = SerializableState> extends Component<TComponent, TState>
Examples
class Welcome extends UIComponent {
initializeUI() {
return Text({text: 'Welcome to my World'});
}
}Remarks
For information about usage, see the Custom UI Examples tutorial.
Properties
panelHeight
[readonly]
|
The height of the panel, in pixels. You can't change the value after the panel is initialized.
Signature
protected readonly panelHeight: number; Remarks Default value: 500. |
panelWidth
[readonly]
|
The width of the UI panel, in pixels. You can't change the value after the panel is initialized.
Signature
protected readonly panelWidth: number; Remarks Default value: 500. |
Methods
initializeUI()
abstract
|
Defines the UI and sets up necessary event subscriptions. This method is called before the UIComponent.start() method when the component is started.
Signature
abstract initializeUI(): UINode; Returns Remarks This method must return a valid UINode. |
start() |
A default start implementation for classes that inherit from UIComponent.
Signature
start(): void; Returns void |
Programs
My Creations
Privacy & Legal
Programs
My Creations
Privacy & Legal
Programs
My Creations
Privacy & Legal
© 2025 Meta