getVertexX
getVertexX: (SceneTileModel) -> {number}Each vertex's x, in local units (the tile's x * 128 plus the vertex's offset into the tile: 0, 32, 64, 96 or 128).
scene:tileAt(…):getSceneTileModel()| Method | Returns | Description |
|---|---|---|
getVertexX() | {number} | Each vertex's x, in local units (the tile's x * 128 plus the vertex's offset into the tile: 0, 32, 64, 96 or 128). |
getVertexY() | {number} | Each vertex's height (the corner heights, or two corners' averaged; more negative is higher). |
getVertexZ() | {number} | Each vertex's z (the scene's y), in local units, as getVertexX. |
getFaceX() | {number} | Each face's first vertex, a 0-based index into the vertex arrays (add 1 to index the Luau tables). |
getFaceY() | {number} | Each face's second vertex (getFaceX). |
getFaceZ() | {number} | Each face's third vertex (getFaceX). |
getTriangleColorA() | {number} | Each face's colour at its first vertex: the underlay's or the overlay's HSL (by the face) with the vertex's lightness in its low 7 bits; 12… |
getTriangleColorB() | {number} | Each face's colour at its second vertex (getTriangleColorA). |
getTriangleColorC() | {number} | Each face's colour at its third vertex (getTriangleColorA). |
getTriangleTextureId() | {number}? | Each face's texture id: the overlay's texture for an overlay face, -1 for an underlay face; nil when the tile has no texture. |
getShape() | number | The overlay's shape, 2..12 (shapes 0 and 1 are flat paints, getSceneTilePaint). |
getRotation() | number | The overlay's rotation, 0..3 (quarter turns). |
getModelUnderlay() | number | The underlay's minimap colour, 24-bit RGB (the palette's, at the client's brightness when the region loaded), 0 when the tile has no underl… |
getModelOverlay() | number | The overlay's minimap colour, 24-bit RGB, at least 1 (1 when the overlay has no colour). |
isFlat() | boolean | Whether the tile's four corners are at one height. |
equals(any) | boolean | Whether other equals this SceneTileModel, as == answers it (false for a value of another class). |
| Method | Returns | Description |
|---|---|---|
Tile.getSceneTileModel | SceneTileModel? | Its tile model, a SceneTileModel: the floor of a tile whose overlay has a shape (a slope, a corner or an edge piece), with its vertices,… |
getVertexXgetVertexX: (SceneTileModel) -> {number}Each vertex's x, in local units (the tile's x * 128 plus the vertex's offset into the tile: 0, 32, 64, 96 or 128).
getVertexYgetVertexY: (SceneTileModel) -> {number}Each vertex's height (the corner heights, or two corners' averaged; more negative is higher).
getVertexZgetVertexZ: (SceneTileModel) -> {number}Each vertex's z (the scene's y), in local units, as getVertexX.
getFaceXgetFaceX: (SceneTileModel) -> {number}Each face's first vertex, a 0-based index into the vertex arrays (add 1 to index the Luau tables).
getFaceYgetFaceY: (SceneTileModel) -> {number}Each face's second vertex (getFaceX).
getFaceZgetFaceZ: (SceneTileModel) -> {number}Each face's third vertex (getFaceX).
getTriangleColorAgetTriangleColorA: (SceneTileModel) -> {number}Each face's colour at its first vertex: the underlay's or the overlay's HSL (by the face) with the vertex's lightness in its low 7 bits; 12345678 for a colour the client does not draw.
getTriangleColorBgetTriangleColorB: (SceneTileModel) -> {number}Each face's colour at its second vertex (getTriangleColorA).
getTriangleColorCgetTriangleColorC: (SceneTileModel) -> {number}Each face's colour at its third vertex (getTriangleColorA).
getTriangleTextureIdgetTriangleTextureId: (SceneTileModel) -> {number}?Each face's texture id: the overlay's texture for an overlay face, -1 for an underlay face; nil when the tile has no texture.
getShapegetShape: (SceneTileModel) -> numberThe overlay's shape, 2..12 (shapes 0 and 1 are flat paints, getSceneTilePaint).
getRotationgetRotation: (SceneTileModel) -> numberThe overlay's rotation, 0..3 (quarter turns).
getModelUnderlaygetModelUnderlay: (SceneTileModel) -> numberThe underlay's minimap colour, 24-bit RGB (the palette's, at the client's brightness when the region loaded), 0 when the tile has no underlay colour.
getModelOverlaygetModelOverlay: (SceneTileModel) -> numberThe overlay's minimap colour, 24-bit RGB, at least 1 (1 when the overlay has no colour).
isFlatisFlat: (SceneTileModel) -> booleanWhether the tile's four corners are at one height.
equalsequals: (SceneTileModel, any) -> booleanWhether other equals this SceneTileModel, as == answers it (false for a value of another class).