Class: LayerRegistry

Named layer registry (Unity-style). Layers are integers 0-31 used as bit positions in a 32-bit culling mask. Names are optional but improve readability — LayerRegistry.GetByName('UI') reads better than the magic number 5.

Built-in layers: 0 — Default 1 — Background 2 — World 3 — Foreground 4 — Overlay 5 — UI 6 — Debug

Layers 7-31 are free for application use. Register your own with LayerRegistry.Register.

Constructors

Constructor

new LayerRegistry(): LayerRegistry;

Returns

LayerRegistry

Properties

Property	Modifier	Type	Default value	Description
AllLayers	readonly	number	undefined	Mask matching all layers.
Background	readonly	number	1	-
Debug	readonly	number	6	-
Default	readonly	number	0	-
Foreground	readonly	number	3	-
NoLayers	readonly	number	0	Mask matching no layers.
Overlay	readonly	number	4	-
UI	readonly	number	5	-
World	readonly	number	2	-

Methods

GetAll()

static GetAll(): object[];

Every named layer, by index.

Returns

object[]

---

GetByName()

static GetByName(name): number;

Parameters

Parameter	Type
name	string

Returns

number

---

GetName()

static GetName(index): string | undefined;

Parameters

Parameter	Type
index	number

Returns

string | undefined

---

MaskExcept()

static MaskExcept(...layers): number;

Inverse of MaskOf — all layers except the given ones.

Parameters

Parameter	Type
...layers	(string | number)[]

Returns

number

---

MaskOf()

static MaskOf(...layers): number;

Build a culling mask from a list of layer indices or names.

Parameters

Parameter	Type
...layers	(string | number)[]

Returns

number

---

Register()

static Register(index, name): void;

Parameters

Parameter	Type
index	number
name	string

Returns

void

---

SetName()

static SetName(index, name): void;

Lenient counterpart to Register for tools that own the names (the editor's project settings): replaces whatever was there, and null clears the slot. Built-ins can be renamed too — the index is what entities and masks store, not the name.

Parameters

Parameter	Type
index	number
name	string | null

Returns

void