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



2513
2514
2515
2516
2517
2518
 
# File 'lib/discordrb/data.rb', line 2513

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



2506
2507
2508
 
# File 'lib/discordrb/data.rb', line 2506

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.



2509
2510
2511
 
# File 'lib/discordrb/data.rb', line 2509

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



2503
2504
2505
 
# File 'lib/discordrb/data.rb', line 2503

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



2500
2501
2502
 
# File 'lib/discordrb/data.rb', line 2500

def red
  @red
end