ScreenLayer.AlwaysOnTop Property
Gets or sets a flag that tells whether the screen layer shall always appear on top of other layers, including selection/hover/high-priority visualizations.
Syntax
public System.Boolean AlwaysOnTop { get; set; }Property Value
Default: true
A flag that tells whether the screen layer shall always appear on top of other layers, including selection/hover/high-priority visualizations.
Remarks
Things that affect the drawing order in 2D, by increasing strength:
The Layer order.
AlwaysOnTop.
In other words, usually the layer order determines the drawing order, but a high rendering priority will override it, and a hover visualizer will override the rendering priority, and a selection visualizer will overwrite the hover visualizer, and an always-on-top layer will overwrite the selection visualizer.
There can be more than one layer with AlwaysOnTop = True, and if they overlap they cannot all be on top: the "always" is hyperbole in that case.
Limitations
If a ScreenLayer with AlwaysOnTop = True is under a LayerSet, then the ScreenLayer will ignore LayerSet properties that normally should modify its appearance, like the Opacity and Effects of the LayerSet. It is still possible to use opacity and effects on an always-on-top ScreenLayer, but they have to be attached directly to the ScreenLayer. On the other hand, the ScreenLayer will always respect LayerSet properties that can disable it completely, like the Enabled, MinScale, MaxScale and Condition of the LayerSet.
Migration
The default value of this property is True, but it was not available before Carmenta Engine 5.16. So when an older configuration file is used in runtime or opened in Carmenta Studio, every ScreenLayer will automatically get AlwaysOnTop = False, to preserve the old behavior.
Platforms
Windows, Linux, Android