Module: Gamefic::Active::Messaging

Included in:
Gamefic::Active
Defined in:
lib/gamefic/active/messaging.rb

Overview

A module for active entities that provides a default Messenger with a few shortcuts.

Instance Method Summary collapse

Instance Method Details

#buffer(&block) ⇒ String

Create a temporary buffer while yielding the given block and return the buffered text.

Returns:



42
43
44
 
# File 'lib/gamefic/active/messaging.rb', line 42

def buffer &block
  messenger.buffer(&block)
end

#flush ⇒ String

Clear the current buffer.

Returns:

  • (String) —

    The buffer’s messages



49
50
51
 
# File 'lib/gamefic/active/messaging.rb', line 49

def flush
  messenger.flush
end

#messages ⇒ String

Returns:



34
35
36
 
# File 'lib/gamefic/active/messaging.rb', line 34

def messages
  messenger.messages
end

#messenger ⇒ Messenger

Returns:



10
11
12
 
# File 'lib/gamefic/active/messaging.rb', line 10

def messenger
  @messenger ||= Messenger.new
end

#stream(message) ⇒ Object

Send a message to the entity as raw text.

Unlike #tell, this method will not wrap the message in HTML paragraphs.

Parameters:



29
30
31
 
# File 'lib/gamefic/active/messaging.rb', line 29

def stream(message)
  messenger.stream message
end

#tell(message) ⇒ Object

Send a message to the entity.

This method will automatically wrap the message in HTML paragraphs. To send a message without paragraph formatting, use #stream instead.

Parameters:



20
21
22
 
# File 'lib/gamefic/active/messaging.rb', line 20

def tell(message)
  messenger.tell message
end