Class: Discordrb::ColourRGB

Inherits:

Object

• Object
• Discordrb::ColourRGB

Defined in:

lib/discordrb/colour_rgb.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

• #blue ⇒ Integer readonly

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

• #combined ⇒ Integer (also: #to_i) readonly

  The colour's RGB values combined into one integer.

• #green ⇒ Integer readonly

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

• #red ⇒ Integer readonly

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

Instance Method Summary

• #hex ⇒ String (also: #hexadecimal)

  The colour as a hexadecimal.

• #initialize(combined) ⇒ ColourRGB constructor

  Make a new colour from the combined value.

Constructor Details

#initialize(combined) ⇒ ColourRGB

Make a new colour from the combined value.

Examples:

Initialize a with a base 10 integer

ColourRGB.new(7506394) #=> ColourRGB
ColourRGB.new(0x7289da) #=> ColourRGB

Initialize a with a hexadecimal string

ColourRGB.new('7289da') #=> ColourRGB

# File 'lib/discordrb/colour_rgb.rb', line 27

def initialize(combined)
  @combined = combined.is_a?(String) ? combined.to_i(16) : combined
  @red = (@combined >> 16) & 0xFF
  @green = (@combined >> 8) & 0xFF
  @blue = @combined & 0xFF
end

Instance Attribute Details

#blue ⇒ Integer (readonly)

# File 'lib/discordrb/colour_rgb.rb', line 14

def blue
  @blue
end

#combined ⇒ Integer (readonly) Also known as: to_i

# File 'lib/discordrb/colour_rgb.rb', line 17

def combined
  @combined
end

#green ⇒ Integer (readonly)

# File 'lib/discordrb/colour_rgb.rb', line 11

def green
  @green
end

#red ⇒ Integer (readonly)

# File 'lib/discordrb/colour_rgb.rb', line 8

def red
  @red
end

Instance Method Details

#hex ⇒ String Also known as: hexadecimal

# File 'lib/discordrb/colour_rgb.rb', line 35

def hex
  @combined.to_s(16)
end