Component:OverlayLayer

This is a userspace component — you cannot attach it anywhere but the userspace. Messing with the userspace can be fun, but it is not recommended as you risk messing your dash up if you don't know what you're doing.

CollapseComponent image 

File:OverlayLayerComponent.png

Overlay Layer component as seen in the Scene Inspector

The OverlayLayer component instructs the renderer to render the hierarchy it is attached to on top of everything else. In desktop mode the component also causes the hierarchy to render directly in front of the camera, mimicking a 2D user interface.

Usage

Fields Collapse

Name	Type	Description
persistent	Bool	Determines whether or not this item will be saved to the server.
UpdateOrder	Int	Controls the order in which this component is updated.
Enabled	Bool	Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.

Behavior

When enabled, OverlayLayer will tell the renderer to render the hierarchy under the slot (including the slot) on top of everything else. Internally, this is done by setting the layer of each GameObject in the hierarchy to Overlay.

Examples

OverlayLayer is used to display the dash, notification panel, and the cursor on top of everything else in userspace.

See Also

• Component:HiddenLayer