Render Windows

RenderWindow is just a wrapper around a BrowserWindow, so you can use all the same methods like .show(), etc

Options

When creating the RenderWindow, you may pass in extra options:

interface RenderWindowConstructorOptions extends BrowserWindowConstructorOptions {
	layer?: number; // default: 0
	createForeground?: boolean; // default: true
	hasInput?: boolean; // default: true
	hasInputBlock?: boolean; // default: true
	hasCursorOverride?: boolean; // default: true
}

Here’s a comprehensive list of additional methods we provide on the RenderWindow:

Layer

Manage the stacking layer of an individual window. This is the same concept as z-index in web browsers.

getLayer(): number;
setLayer(layer: number): void;

Input

Allow or disallow the window to receive input (e.g. mouse hover, clicks, etc)

getInput(): boolean;
setInput(input: boolean): void;

Input Block

Blocks input from passing through to the game.

getInputBlock(): boolean;
setInputBlock(input: boolean): void;

Cursor Override

Forces the cursor to show when over the window

getCursorOverride(): boolean;
setCursorOverride(input: boolean): void;

Overlay Windows

Global Window Events

Get Started

Essentials

Windows

Keybinds

Notices

Feature Flags

Event & Log Tracking

Logging

Deployment

Ads

Advanced

Extras

Options

Layer

Input

Input Block

Cursor Override

​Options

​Layer

​Input

​Input Block

​Cursor Override

Options

Layer

Input

Input Block

Cursor Override