name
name: (OverlayPosition) -> stringThe constant's name as declared.
OverlayPosition.valueOf(…)
OverlayPosition.DETACHED
OverlayPosition.DYNAMIC| 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(OverlayPosition) | number | This ordinal less other's. |
equals(any) | boolean | Whether 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) | OverlayPosition | valueOf(name): the constant named name; any other name is an error. |
| Field | Type | Description |
|---|---|---|
DETACHED | OverlayPosition | DETACHED: ordinal 0. |
DYNAMIC | OverlayPosition | DYNAMIC: ordinal 1. |
TOP_LEFT | OverlayPosition | TOP_LEFT: ordinal 2. |
TOP_CENTER | OverlayPosition | TOP_CENTER: ordinal 3. |
TOP_RIGHT | OverlayPosition | TOP_RIGHT: ordinal 4. |
BOTTOM_LEFT | OverlayPosition | BOTTOM_LEFT: ordinal 5. |
BOTTOM_RIGHT | OverlayPosition | BOTTOM_RIGHT: ordinal 6. |
ABOVE_CHATBOX_RIGHT | OverlayPosition | ABOVE_CHATBOX_RIGHT: ordinal 7. |
CANVAS_TOP_RIGHT | OverlayPosition | CANVAS_TOP_RIGHT: ordinal 8. |
TOOLTIP | OverlayPosition | TOOLTIP: ordinal 9. |
| Method | Returns | Description |
|---|---|---|
Overlay.getPosition | OverlayPosition | The position. |
Overlay.getPreferredPosition | OverlayPosition? | The preferred position, or nil. |
OverlayPositionClass.valueOf | OverlayPosition | valueOf(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. |
namename: (OverlayPosition) -> stringThe constant's name as declared.
ordinalordinal: (OverlayPosition) -> numberThe constant's 0-based position in values().
toStringtoString: (OverlayPosition) -> stringname(); tostring(c) answers the same.
compareTocompareTo: (OverlayPosition, OverlayPosition) -> numberThis ordinal less other's.
equalsequals: (OverlayPosition, any) -> booleanWhether other is this constant. == answers the same.
valuesvalues: () -> {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.
valueOfvalueOf: (string) -> OverlayPositionvalueOf(name): the constant named name; any other name is an error.