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



1462
1463
1464
1465
1466
1467
 
# File 'lib/discordrb/data.rb', line 1462

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).



1455
1456
1457
 
# File 'lib/discordrb/data.rb', line 1455

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.



1458
1459
1460
 
# File 'lib/discordrb/data.rb', line 1458

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).



1452
1453
1454
 
# File 'lib/discordrb/data.rb', line 1452

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).



1449
1450
1451
 
# File 'lib/discordrb/data.rb', line 1449

def red
  @red
end