Class: Discordrb::ColourRGB

Inherits:
Object
  • Object
show all
Defined in:
lib/discordrb/data.rb

Overview

A colour (red, green and blue values). Used for role colours. If you prefer the American spelling, the alias ColorRGB is also available.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(combined) ⇒ ColourRGB

Make a new colour from the combined value.

Parameters:

  • combined (Integer) —

    The colour's RGB values combined into one integer



1493
1494
1495
1496
1497
1498
 
# File 'lib/discordrb/data.rb', line 1493

def initialize(combined)
  @combined = combined
  @red = (combined >> 16) & 0xFF
  @green = (combined >> 8) & 0xFF
  @blue = combined & 0xFF
end

Instance Attribute Details

#blue ⇒ Integer (readonly)

Returns the blue part of this colour (0-255).

Returns:

  • (Integer) —

    the blue part of this colour (0-255).



1486
1487
1488
 
# File 'lib/discordrb/data.rb', line 1486

def blue
  @blue
end

#combined ⇒ Integer (readonly)

Returns the colour's RGB values combined into one integer.

Returns:

  • (Integer) —

    the colour's RGB values combined into one integer.



1489
1490
1491
 
# File 'lib/discordrb/data.rb', line 1489

def combined
  @combined
end

#green ⇒ Integer (readonly)

Returns the green part of this colour (0-255).

Returns:

  • (Integer) —

    the green part of this colour (0-255).



1483
1484
1485
 
# File 'lib/discordrb/data.rb', line 1483

def green
  @green
end

#red ⇒ Integer (readonly)

Returns the red part of this colour (0-255).

Returns:

  • (Integer) —

    the red part of this colour (0-255).



1480
1481
1482
 
# File 'lib/discordrb/data.rb', line 1480

def red
  @red
end