OverlayPosition

Methods
7
Fields
10

Getting one

OverlayPosition.valueOf(…)
OverlayPosition.DETACHED
OverlayPosition.DYNAMIC

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(OverlayPosition)numberThis ordinal less other's.
equals(any)booleanWhether other is this constant. == answers the same.
values(){OverlayPosition}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)OverlayPositionvalueOf(name): the constant named name; any other name is an error.

Fields

FieldTypeDescription
DETACHEDOverlayPositionDETACHED: ordinal 0.
DYNAMICOverlayPositionDYNAMIC: ordinal 1.
TOP_LEFTOverlayPositionTOP_LEFT: ordinal 2.
TOP_CENTEROverlayPositionTOP_CENTER: ordinal 3.
TOP_RIGHTOverlayPositionTOP_RIGHT: ordinal 4.
BOTTOM_LEFTOverlayPositionBOTTOM_LEFT: ordinal 5.
BOTTOM_RIGHTOverlayPositionBOTTOM_RIGHT: ordinal 6.
ABOVE_CHATBOX_RIGHTOverlayPositionABOVE_CHATBOX_RIGHT: ordinal 7.
CANVAS_TOP_RIGHTOverlayPositionCANVAS_TOP_RIGHT: ordinal 8.
TOOLTIPOverlayPositionTOOLTIP: ordinal 9.

Returned by

MethodReturnsDescription
Overlay.getPositionOverlayPositionThe position.
Overlay.getPreferredPositionOverlayPosition?The preferred position, or nil.
OverlayPositionClass.valueOfOverlayPositionvalueOf(name): the constant named name; any other name is an error.
OverlayPositionClass.values{OverlayPosition}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

values

values: () -> {OverlayPosition}

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) -> OverlayPosition

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