Class: Arkaan::Chatrooms::Message

Inherits:

Object

• Object
• Arkaan::Chatrooms::Message

Includes:

Arkaan::Concerns::Enumerable, Mongoid::Document, Mongoid::Timestamps

Defined in:

lib/arkaan/chatrooms/message.rb

Overview

This model represents an in-game tchat message sent in the tchat of a campaign.

Instance Attribute Summary

• #campaign ⇒ Arkaan::Chatrooms::Campaign

  The chatroom in which the message has been emitted.

• #data ⇒ Hash

  The additional data passed to the message (arguments of the command, or content of the text).

• #deleted ⇒ Boolean

  TRUE if the message has been marked as deleted by its user, FALSE otherwise.

• #player ⇒ Arkaan::Account

  The account that has emitted the message in the campaign.

• #raw ⇒ String

  The content as typed by the user, without any parsing or transformation.

• #type ⇒ Symbol

  The type of message (plain text or command) contained in the data, used to display it.

Instance Attribute Details

#campaign ⇒ Arkaan::Chatrooms::Campaign

# File 'lib/arkaan/chatrooms/message.rb', line 27

belongs_to :chatroom, class_name: 'Arkaan::Chatrooms::Campaign', inverse_of: :messages

#data ⇒ Hash

# File 'lib/arkaan/chatrooms/message.rb', line 17

field :data, type: Hash, default: {}

#deleted ⇒ Boolean

# File 'lib/arkaan/chatrooms/message.rb', line 23

field :deleted, type: Boolean, default: false

#player ⇒ Arkaan::Account

# File 'lib/arkaan/chatrooms/message.rb', line 30

belongs_to :account, class_name: 'Arkaan::Account', inverse_of: :messages

#raw ⇒ String

# File 'lib/arkaan/chatrooms/message.rb', line 20

field :raw, type: String, default: ''

#type ⇒ Symbol

# File 'lib/arkaan/chatrooms/message.rb', line 14

enum_field :type, %i[text command], default: :text