Color Class Reference

Public Member Functions
	__construct ($r, $g, $b)
	getRed ()
	getBlue ()
	getGreen ()
	getColorCode ()
	__toString ()

Static Public Member Functions
static	init ()
static	getRGB ($r, $g, $b)
static	averageColor (Color ... $colors)
static	getDyeColor ($id)

Data Fields
const	COLOR_DYE_BLACK = 0
const	COLOR_DYE_RED = 1
const	COLOR_DYE_GREEN = 2
const	COLOR_DYE_BROWN = 3
const	COLOR_DYE_BLUE = 4
const	COLOR_DYE_PURPLE = 5
const	COLOR_DYE_CYAN = 6
const	COLOR_DYE_LIGHT_GRAY = 7
const	COLOR_DYE_GRAY = 8
const	COLOR_DYE_PINK = 9
const	COLOR_DYE_LIME = 10
const	COLOR_DYE_YELLOW = 11
const	COLOR_DYE_LIGHT_BLUE = 12
const	COLOR_DYE_MAGENTA = 13
const	COLOR_DYE_ORANGE = 14
const	COLOR_DYE_WHITE = 15

Static Public Attributes
static	$dyeColors = null

Constructor & Destructor Documentation

__construct()

__construct	(		$r,
			$g,
			$b
	)

Color constructor.

Parameters

$r
$g
$b

                                           {
        $this->red = $r;
        $this->green = $g;
        $this->blue = $b;
    }

Member Function Documentation

__toString()

__toString

(

)

Returns

string

                                {
        return "Color(red:" . $this->red . ", green:" . $this->green . ", blue:" . $this->blue . ")";
    }

averageColor()

static averageColor ( Color ...  $colors )

static

Parameters

Color[]

...$colors

Returns

Color

                                                         {
        $tr = 0;//total red
        $tg = 0;//green
        $tb = 0;//blue
        $count = 0;
        foreach($colors as $c){
            $tr += $c->getRed();
            $tg += $c->getGreen();
            $tb += $c->getBlue();
            ++$count;
        }
        return Color::getRGB($tr / $count, $tg / $count, $tb / $count);
    }

getBlue()

getBlue

(

)

Returns

int

                             {
        return (int) $this->blue;
    }

getColorCode()

getColorCode

(

)

Returns

int

                                  {
        return ($this->red << 16 | $this->green << 8 | $this->blue) & 0xffffff;
    }

getDyeColor()

static getDyeColor (   $id )

static

Parameters

$id

Returns

mixed|Color

                                           {
        if(isset(self::$dyeColors[$id])){
            return clone self::$dyeColors[$id];
        }
        return Color::getRGB(0, 0, 0);
    }

getGreen()

getGreen

(

)

Returns

int

                              {
        return (int) $this->green;
    }

getRed()

getRed

(

)

Returns

int

                            {
        return (int) $this->red;
    }

getRGB()

static getRGB (   $r,   $g,   $b  )

static

Parameters

$r
$g
$b

Returns

Color

                                             {
        return new Color((int) $r, (int) $g, (int) $b);
    }

init()

static init ( )

static

                                 {
        if(self::$dyeColors === null){
            self::$dyeColors = new \SplFixedArray(16); //What's the point of making a 256-long array for 16 objects?
            self::$dyeColors[self::COLOR_DYE_BLACK] = Color::getRGB(30, 27, 27);
            self::$dyeColors[self::COLOR_DYE_RED] = Color::getRGB(179, 49, 44);
            self::$dyeColors[self::COLOR_DYE_GREEN] = Color::getRGB(61, 81, 26);
            self::$dyeColors[self::COLOR_DYE_BROWN] = Color::getRGB(81, 48, 26);
            self::$dyeColors[self::COLOR_DYE_BLUE] = Color::getRGB(37, 49, 146);
            self::$dyeColors[self::COLOR_DYE_PURPLE] = Color::getRGB(123, 47, 190);
            self::$dyeColors[self::COLOR_DYE_CYAN] = Color::getRGB(40, 118, 151);
            self::$dyeColors[self::COLOR_DYE_LIGHT_GRAY] = Color::getRGB(153, 153, 153);
            self::$dyeColors[self::COLOR_DYE_GRAY] = Color::getRGB(67, 67, 67);
            self::$dyeColors[self::COLOR_DYE_PINK] = Color::getRGB(216, 129, 152);
            self::$dyeColors[self::COLOR_DYE_LIME] = Color::getRGB(65, 205, 52);
            self::$dyeColors[self::COLOR_DYE_YELLOW] = Color::getRGB(222, 207, 42);
            self::$dyeColors[self::COLOR_DYE_LIGHT_BLUE] = Color::getRGB(102, 137, 211);
            self::$dyeColors[self::COLOR_DYE_MAGENTA] = Color::getRGB(195, 84, 205);
            self::$dyeColors[self::COLOR_DYE_ORANGE] = Color::getRGB(235, 136, 68);
            self::$dyeColors[self::COLOR_DYE_WHITE] = Color::getRGB(240, 240, 240);
        }
    }

Field Documentation

$dyeColors

$dyeColors = null

static

COLOR_DYE_BLACK

const COLOR_DYE_BLACK = 0

COLOR_DYE_BLUE

const COLOR_DYE_BLUE = 4

COLOR_DYE_BROWN

const COLOR_DYE_BROWN = 3

COLOR_DYE_CYAN

const COLOR_DYE_CYAN = 6

COLOR_DYE_GRAY

const COLOR_DYE_GRAY = 8

COLOR_DYE_GREEN

const COLOR_DYE_GREEN = 2

COLOR_DYE_LIGHT_BLUE

const COLOR_DYE_LIGHT_BLUE = 12

COLOR_DYE_LIGHT_GRAY

const COLOR_DYE_LIGHT_GRAY = 7

COLOR_DYE_LIME

const COLOR_DYE_LIME = 10

COLOR_DYE_MAGENTA

const COLOR_DYE_MAGENTA = 13

COLOR_DYE_ORANGE

const COLOR_DYE_ORANGE = 14

COLOR_DYE_PINK

const COLOR_DYE_PINK = 9

COLOR_DYE_PURPLE

const COLOR_DYE_PURPLE = 5

COLOR_DYE_RED

const COLOR_DYE_RED = 1

COLOR_DYE_WHITE

const COLOR_DYE_WHITE = 15

COLOR_DYE_YELLOW

const COLOR_DYE_YELLOW = 11

---

The documentation for this class was generated from the following file:

• src/pocketmine/utils/Color.php