name
name: (OverlayLayer) -> stringThe constant's name as declared.
OverlayLayer.valueOf(…)
OverlayLayer.MANUAL
OverlayLayer.ABOVE_SCENE| Method | Returns | Description |
|---|---|---|
name() | string | The constant's name as declared. |
ordinal() | number | The constant's 0-based position in values(). |
toString() | string | name(); tostring(c) answers the same. |
compareTo(OverlayLayer) | number | This ordinal less other's. |
equals(any) | boolean | Whether other is this constant. == answers the same. |
values() | {OverlayLayer} | Every constant in ordinal order, as a 1-based array: the same frozen array every values() call, so table.clone it before changing it. |
valueOf(string) | OverlayLayer | valueOf(name): the constant named name; any other name is an error. |
| Field | Type | Description |
|---|---|---|
MANUAL | OverlayLayer | MANUAL: ordinal 0. |
ABOVE_SCENE | OverlayLayer | ABOVE_SCENE: ordinal 1. |
UNDER_WIDGETS | OverlayLayer | UNDER_WIDGETS: ordinal 2. |
ABOVE_WIDGETS | OverlayLayer | ABOVE_WIDGETS: ordinal 3. |
ALWAYS_ON_TOP | OverlayLayer | ALWAYS_ON_TOP: ordinal 4. |
| Method | Returns | Description |
|---|---|---|
Overlay.getLayer | OverlayLayer | The layer. |
OverlayLayerClass.valueOf | OverlayLayer | valueOf(name): the constant named name; any other name is an error. |
OverlayLayerClass.values | {OverlayLayer} | Every constant in ordinal order, as a 1-based array: the same frozen array every values() call, so table.clone it before changing it. |
namename: (OverlayLayer) -> stringThe constant's name as declared.
ordinalordinal: (OverlayLayer) -> numberThe constant's 0-based position in values().
toStringtoString: (OverlayLayer) -> stringname(); tostring(c) answers the same.
compareTocompareTo: (OverlayLayer, OverlayLayer) -> numberThis ordinal less other's.
equalsequals: (OverlayLayer, any) -> booleanWhether other is this constant. == answers the same.
valuesvalues: () -> {OverlayLayer}Every constant in ordinal order, as a 1-based array: the same frozen array every values() call, so table.clone it before changing it.
valueOfvalueOf: (string) -> OverlayLayervalueOf(name): the constant named name; any other name is an error.