Module: UI::Message::Layout

Includes:
TemporaryOverwrites
Included in:
Window
Defined in:
docs/4_Systems_004_Message.rb

Overview

Module defining the Message layout

Constant Summary collapse

PAUSE_SKIN =

Name of the pause skin in Graphics/Windowskins/

'Pause2'
NAME_SKIN =

Windowskin for the name window

'message'

Instance Attribute Summary collapse

Attributes included from TemporaryOverwrites

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

Instance Method Summary collapse

Methods included from TemporaryOverwrites

#reset_overwrites

Instance Attribute Details

#input_number_windowUI::InputNumber

Attribute that holds the UI::InputNumber object

Returns:


456
457
458
# File 'docs/4_Systems_004_Message.rb', line 456

def input_number_window
  @input_number_window
end

Instance Method Details

#can_sub_window_be_updated?Boolean

Function that test if sub window can be updated (choice / number)

Returns:

  • (Boolean)
[View source]

563
564
# File 'docs/4_Systems_004_Message.rb', line 563

def can_sub_window_be_updated?
end

#current_layoutConfigs::Project::Texts::MessageConfig

Retrieve the current layout configuration based on the scene

[View source]

472
473
# File 'docs/4_Systems_004_Message.rb', line 472

def current_layout
end

#dispose(with_viewport: false)

Dispose the layout

Parameters:

  • with_viewport (Boolean) (defaults to: false)

    tell to also dispose the viewport of the layout

[View source]

476
477
# File 'docs/4_Systems_004_Message.rb', line 476

def dispose(with_viewport: false)
end

#face_speaker_yInteger

Return the face_speaker y position

Returns:

  • (Integer)
[View source]

582
583
# File 'docs/4_Systems_004_Message.rb', line 582

def face_speaker_y
end

#generate_choice_window

Generate the choice window

[View source]

553
554
# File 'docs/4_Systems_004_Message.rb', line 553

def generate_choice_window
end

#generate_input_number_window

Generate the number input window

[View source]

556
557
# File 'docs/4_Systems_004_Message.rb', line 556

def generate_input_number_window
end

#initialize(*args, scene)

Initialize the states

Parameters:

  • args (Array<Viewport>)

    arguments to forward to parents

  • scene (GamePlay::Base)

    scene holding this message instance

[View source]

468
469
# File 'docs/4_Systems_004_Message.rb', line 468

def initialize(*args, scene)
end

#load_sub_layout

Load the sub layout based on properties

[View source]

585
586
# File 'docs/4_Systems_004_Message.rb', line 585

def load_sub_layout
end

#parse_speaker_position(position) ⇒ Integer

Function that translate the position to a coordinate

Parameters:

  • position (Integer)

    position given by the maker

Returns:

  • (Integer)

    the x position

[View source]

578
579
# File 'docs/4_Systems_004_Message.rb', line 578

def parse_speaker_position(position)
end

#show_city_image

Show the city image

[View source]

569
570
# File 'docs/4_Systems_004_Message.rb', line 569

def show_city_image
end

#show_face(face)

Show a face

Parameters:

[View source]

573
574
# File 'docs/4_Systems_004_Message.rb', line 573

def show_face(face)
end

#show_gold_window

Show a window that tells the player how much money he got

[View source]

559
560
# File 'docs/4_Systems_004_Message.rb', line 559

def show_gold_window
end

#show_name_window

Show the name window

[View source]

566
567
# File 'docs/4_Systems_004_Message.rb', line 566

def show_name_window
end