Class: PFM::Message::Properties

Inherits:
Object
  • Object
show all
Defined in:
docs/4_Systems_004_Message.rb

Overview

Class holding all the properties for the currently showing message

Defined Under Namespace

Classes: Face

Constant Summary collapse

PROPERTIES =

All the properties that can be set in :[]: with the function to call to compute the property parameters

Returns:

{'name' => :parse_speaker_name, 'face' => :parse_speaker_face, 'city' => :parse_city_filename, 'can_skip' => :parse_can_skip, 'windowskin' => :parse_window_skin, 'lookto' => :look_to_event, 'align' => :parse_message_align}

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(parsed_text) ⇒ Properties

Create a new Properties object

Parameters:



137
138
 
# File 'docs/4_Systems_004_Message.rb', line 137

def initialize(parsed_text)
end

Instance Attribute Details

#align ⇒ Symbol (readonly)

Get the message alignment

Returns:

  • (Symbol) —

    :left, :right, :center



134
135
136
 
# File 'docs/4_Systems_004_Message.rb', line 134

def align
  @align
end

#can_skip_message ⇒ Boolean (readonly)

Tell if user can skip the message using directional keys

Returns:

  • (Boolean) 


125
126
127
 
# File 'docs/4_Systems_004_Message.rb', line 125

def can_skip_message
  @can_skip_message
end

#city_filename ⇒ String? (readonly)

Get the city image to show

Returns:



122
123
124
 
# File 'docs/4_Systems_004_Message.rb', line 122

def city_filename
  @city_filename
end

#faces ⇒ Array<Face> (readonly)

Get all the faces to show

Returns:



119
120
121
 
# File 'docs/4_Systems_004_Message.rb', line 119

def faces
  @faces
end

#look_to ⇒ Integer (readonly)

Get the ID of the event to look to

Returns:

  • (Integer) 


131
132
133
 
# File 'docs/4_Systems_004_Message.rb', line 131

def look_to
  @look_to
end

#name ⇒ String? (readonly)

Get the name to show

Returns:



113
114
115
 
# File 'docs/4_Systems_004_Message.rb', line 113

def name
  @name
end

#name_color ⇒ Integer? (readonly)

Get the color of the name to show

Returns:

  • (Integer, nil) 


116
117
118
 
# File 'docs/4_Systems_004_Message.rb', line 116

def name_color
  @name_color
end

#parsed_text ⇒ String (readonly)

Parsed text of the message

Returns:



107
108
109
 
# File 'docs/4_Systems_004_Message.rb', line 107

def parsed_text
  @parsed_text
end

#show_gold_window ⇒ Boolean

Tell that the message should show the gold window

Returns:

  • (Boolean) 


110
111
112
 
# File 'docs/4_Systems_004_Message.rb', line 110

def show_gold_window
  @show_gold_window
end

#windowskin_overwrite ⇒ String (readonly)

Get the windowsking overwrite of the current message

Returns:



128
129
130
 
# File 'docs/4_Systems_004_Message.rb', line 128

def windowskin_overwrite
  @windowskin_overwrite
end

Instance Method Details

#process_look_to

Process the lookto operation



140
141
 
# File 'docs/4_Systems_004_Message.rb', line 140

def process_look_to
end