SceneTilePaint

Group
player
Methods
8
Fields
None

Getting one

scene:tileAt(…):getSceneTilePaint()

Methods

MethodReturnsDescription
getSwColor()numberThe south-west corner's colour: the tile's HSL (15-bit, the overlay's when there is one) with the corner's lightness in its low 7 bits, as…
getSeColor()numberThe south-east corner's colour (getSwColor).
getNeColor()numberThe north-east corner's colour (getSwColor). The client does not draw a paint whose north-east colour is 12345678.
getNwColor()numberThe north-west corner's colour (getSwColor).
getTexture()numberThe texture id the tile is drawn with, -1 for none (always -1 for an underlay).
getRBG()numberThe tile's minimap colour, 24-bit RGB (the palette's, at the client's brightness when the region loaded), 0 for none: what the minimap fill…
isFlat()booleanWhether the tile is an overlay whose four corners are at one height: always false for an underlay.
equals(any)booleanWhether other equals this SceneTilePaint, as == answers it (false for a value of another class).

Returned by

MethodReturnsDescription
Tile.getSceneTilePaintSceneTilePaint?Its flat paint (an underlay, or an overlay covering the whole tile), a SceneTilePaint: the colour of each corner, the texture, the minima…

Method details

getSwColor

getSwColor: (SceneTilePaint) -> number

The south-west corner's colour: the tile's HSL (15-bit, the overlay's when there is one) with the corner's lightness in its low 7 bits, as the client draws it; 12345678 when the tile has no colour there (a hidden overlay).

getNeColor

getNeColor: (SceneTilePaint) -> number

The north-east corner's colour (getSwColor). The client does not draw a paint whose north-east colour is 12345678.

getTexture

getTexture: (SceneTilePaint) -> number

The texture id the tile is drawn with, -1 for none (always -1 for an underlay).

getRBG

getRBG: (SceneTilePaint) -> number

The tile's minimap colour, 24-bit RGB (the palette's, at the client's brightness when the region loaded), 0 for none: what the minimap fills the tile with.

isFlat

isFlat: (SceneTilePaint) -> boolean

Whether the tile is an overlay whose four corners are at one height: always false for an underlay.

equals

equals: (SceneTilePaint, any) -> boolean

Whether other equals this SceneTilePaint, as == answers it (false for a value of another class).