View

Related: GUI System

A view is a container for UI within comet.

`mount()`

Mount a ui element or component tree to the viewport.

mount(method: ((root: Instance) => (() => void)) | Instance): void;

You can mount any ui framwork you'd like with a story-like api.

this.view.mount((root) => {
	const unmount = createReactTree(root);
	return () => unmount()
}))

Alternatively, you can also directly mount an instance.

this.view.mount(new Instance("Frame"))

Bind a callback to be invoked when the view is opened or closed.

this.onClose(cb: () => void): void
this.onOpen(cb: () => void): void

Set the visibility of the window.

this.setVisible(state: boolean): void

Link a toolbar button to the visibility of the view.

this.linkButton(button: Button): void

Returns the viewport size, but only will only function as expected in viewport mode.

this.getViewportSize(): Vector2