OverlayLayer

Methods
7
Fields
5

Getting one

OverlayLayer.valueOf(…)
OverlayLayer.MANUAL
OverlayLayer.ABOVE_SCENE

Methods

MethodReturnsDescription
name()stringThe constant's name as declared.
ordinal()numberThe constant's 0-based position in values().
toString()stringname(); tostring(c) answers the same.
compareTo(OverlayLayer)numberThis ordinal less other's.
equals(any)booleanWhether 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)OverlayLayervalueOf(name): the constant named name; any other name is an error.

Fields

FieldTypeDescription
MANUALOverlayLayerMANUAL: ordinal 0.
ABOVE_SCENEOverlayLayerABOVE_SCENE: ordinal 1.
UNDER_WIDGETSOverlayLayerUNDER_WIDGETS: ordinal 2.
ABOVE_WIDGETSOverlayLayerABOVE_WIDGETS: ordinal 3.
ALWAYS_ON_TOPOverlayLayerALWAYS_ON_TOP: ordinal 4.

Returned by

MethodReturnsDescription
Overlay.getLayerOverlayLayerThe layer.
OverlayLayerClass.valueOfOverlayLayervalueOf(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.

Method details

equals

equals: (OverlayLayer, any) -> boolean

Whether other is this constant. == answers the same.

values

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

valueOf: (string) -> OverlayLayer

valueOf(name): the constant named name; any other name is an error.