Class Palette

Provides pre-defined color values for drawing operations.

Index

Constructors

Accessors

colors paletteIndex

Methods

nextPalette someColor

Constructors

constructor

new Palette(paletteIndex?: number): Palette
Constructs a new palette.
Parameters
- paletteIndex: number = 0
  The index of the pre-defined palette to use.
Returns Palette
- Defined in source/graphics/palette.ts:438

Accessors

colors

get colors(): readonly number[]
Retrieve the 24bit color values of the currently selected palette.

Returns readonly number[]
The colors in the palette.
- Defined in source/graphics/palette.ts:430

paletteIndex

get paletteIndex(): number
Retrieve the index of the currently selected, pre-defined palette values.

Returns number
The index of the currently selected, pre-defined palette values.

See
PALETTES
- Defined in source/graphics/palette.ts:422

Methods

nextPalette

nextPalette(): this
Uses the next pre-defined color value set for this palette.

Returns this
This instance.
- Defined in source/graphics/palette.ts:446

someColor

someColor(randomInstance?: Random): number
Retrieve a random color from the palette.
Parameters
- randomInstance: Random = random
  The PRNG to use. Ideally, supply your own.
Returns number
A random color from the palette.
- Defined in source/graphics/palette.ts:459