Class: Battle::Scene::Message

Inherits:
UI::Message::Window show all
Defined in:
docs/5_Battle_01_Scene.rb

Overview

Message Window of the Battle

Constant Summary collapse

MAX_WAIT =

Number of 60th of second to wait while message does not wait for user input

120
WINDOW_SKIN =

Default windowskin of the message

'message_box'

Constants included from UI::Message::Layout

UI::Message::Layout::NAME_SKIN, UI::Message::Layout::PAUSE_SKIN

Instance Attribute Summary collapse

Attributes included from PFM::Message::State

#auto_skip, #last_text, #stay_visible

Attributes included from UI::Message::Layout

#input_number_window

Attributes included from UI::Message::TemporaryOverwrites

#line_number_overwrite, #nameskin_overwrite, #position_overwrite, #width_overwrite, #windowskin_overwrite

Attributes inherited from LiteRGSS::Window

#__index__, #active, #back_opacity, #contents_opacity, #cursor_rect, #cursorskin, #height, #opacity, #ox, #oy, #pause, #pause_x, #pause_y, #pauseskin, #stretch, #viewport, #visible, #width, #window_builder, #windowskin, #x, #y, #z

Instance Method Summary collapse

Methods inherited from UI::Message::Window

#update

Methods included from PFM::Message::State

#at_end_of_line?, #done_drawing_message?, #load_next_instruction, #need_to_show_choice?, #need_to_show_message?, #need_to_show_number_input?, #need_to_wait_user_input?, #parse_and_show_new_message, #showing_message?

Methods included from PFM::Message::Parser

#convert_text_to_properties, #make_instructions, register_marker

Methods included from UI::Message::Draw

#process_big_text_marker, #process_color_marker, #process_marker, #process_picture_marker, #process_speed_marker, #process_style_marker, #process_wait_marker

Methods included from UI::Message::Layout

#can_sub_window_be_updated?, #current_layout, #dispose, #face_speaker_y, #generate_choice_window, #generate_input_number_window, #load_sub_layout, #parse_speaker_position, #show_city_image, #show_face, #show_gold_window, #show_name_window

Methods included from UI::Message::TemporaryOverwrites

#reset_overwrites

Methods inherited from Window

#simple_mouse_in?, #translate_mouse_coords

Methods inherited from LiteRGSS::Window

#lock, #locked?, new, #set_origin, #set_position, #set_size, #unlock, #update

Methods inherited from LiteRGSS::Disposable

#dispose, #disposed?

Constructor Details

#initialize ⇒ Message

Create a new window



239
240
 
# File 'docs/5_Battle_01_Scene.rb', line 239

def initialize(...)
end

Instance Attribute Details

#blocking ⇒ Boolean

If the message will wait user to validate the message forever

Returns:

  • (Boolean) 


234
235
236
 
# File 'docs/5_Battle_01_Scene.rb', line 234

def blocking
  @blocking
end

#wait_input ⇒ Boolean

If the message wait for the user to press a key before skiping

Returns:

  • (Boolean) 


237
238
239
 
# File 'docs/5_Battle_01_Scene.rb', line 237

def wait_input
  @wait_input
end

Instance Method Details

#create_skipper_wait_animation

Function that create the skipper wait animation



256
257
 
# File 'docs/5_Battle_01_Scene.rb', line 256

def create_skipper_wait_animation
end

#current_position ⇒ Symbol, Array

Note:

Always return :bottom if the battler interpreter is not running

Retrieve the current window position

Returns:

  • (Symbol, Array) 


261
262
 
# File 'docs/5_Battle_01_Scene.rb', line 261

def current_position
end

#current_window_builder ⇒ Array

Retrieve the current window_builder

Returns:

  • (Array) 


269
270
 
# File 'docs/5_Battle_01_Scene.rb', line 269

def current_window_builder
end

#current_windowskin ⇒ String

Battle Windowskin

Returns:



265
266
 
# File 'docs/5_Battle_01_Scene.rb', line 265

def current_windowskin
end

#default_horizontal_margin ⇒ Integer

Return the default horizontal margin

Returns:

  • (Integer) 


278
279
 
# File 'docs/5_Battle_01_Scene.rb', line 278

def default_horizontal_margin
end

#default_vertical_margin ⇒ Integer

Return the default vertical margin

Returns:

  • (Integer) 


282
283
 
# File 'docs/5_Battle_01_Scene.rb', line 282

def default_vertical_margin
end

#terminate_message

Terminate the message display



253
254
 
# File 'docs/5_Battle_01_Scene.rb', line 253

def terminate_message
end

#translate_color(color) ⇒ Integer

Translate the color according to the layout configuration

Parameters:

  • color (Integer) —

    color to translate

Returns:

  • (Integer) —

    translated color



274
275
 
# File 'docs/5_Battle_01_Scene.rb', line 274

def translate_color(color)
end

#update_wait_input_auto_skip ⇒ Boolean

Autoskip the wait input

Returns:

  • (Boolean) 


250
251
 
# File 'docs/5_Battle_01_Scene.rb', line 250

def update_wait_input_auto_skip
end

#update_wait_input_skip ⇒ Boolean

Skip the update of wait input

Returns:

  • (Boolean) —

    if the update of wait input should be skipped



246
247
 
# File 'docs/5_Battle_01_Scene.rb', line 246

def update_wait_input_skip
end

#wait_user_input

Process the wait user input phase



242
243
 
# File 'docs/5_Battle_01_Scene.rb', line 242

def wait_user_input
end