[XP Script] Dialog System - Printable Version

Dialog System

Code:
#==============================================================================

# ** Dialog system

#------------------------------------------------------------------------------

# Zeriab

# Version 1.0

# 2007-11-07 (Year-Month-Day)

#------------------------------------------------------------------------------

# * Description :

#

#   A small framework like script for dialogs

#------------------------------------------------------------------------------

# * License :

#

#   Copyright (C) 2007  Zeriab

#

#   This program is free software: you can redistribute it and/or modify

#   it under the terms of the GNU Lesser Public License as published by

#   the Free Software Foundation, either version 3 of the License, or

#   (at your option) any later version.

#

#   This program is distributed in the hope that it will be useful,

#   but WITHOUT ANY WARRANTY; without even the implied warranty of

#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

#   GNU Lesser Public License for more details.

#

#   For the full license see <http://www.gnu.org/licenses/> 

#   The GNU General Public License: http://www.gnu.org/licenses/gpl.txt

#   The GNU Lesser General Public License: http://www.gnu.org/licenses/lgpl.txt

#------------------------------------------------------------------------------

# * Instructions :

#

#   You can place this script pretty much anyway you like.

#   Place it above any other Dialogs you might be using.

#   Increase the STARTING_Z_VALUE if you have trouble with the dialog not

#   on top.

#==============================================================================

class Dialog

  STARTING_Z_VALUE = 1500 # Default value is 1500

  attr_accessor :value

  attr_writer :marked_to_close

  #--------------------------------------------------------------------------

  # * Getter with 'false' as default value

  #--------------------------------------------------------------------------

  def marked_to_close

    @marked_to_close = false  if @marked_to_close.nil?

    return @marked_to_close

  end

  #--------------------------------------------------------------------------

  # * Initialization

  #--------------------------------------------------------------------------

  def mark_to_close

    self.marked_to_close = true

  end

  #--------------------------------------------------------------------------

  # * Show the dialog

  #   Returns the value from the dialog

  #--------------------------------------------------------------------------

  def self.show(*args, &block)

    dialog = self.new(*args, &block)

    dialog.marked_to_close = false

    return dialog.main

  end

  #--------------------------------------------------------------------------

  # * Initialization

  #--------------------------------------------------------------------------

  def initialize(*args, &block)

    # For subclasses to overwrite

  end

  #--------------------------------------------------------------------------

  # * Main processing

  #--------------------------------------------------------------------------

  def main

    # Create the dimmed background

    create_background

    # Create Windows

    main_window

    # Main loop

    loop do

      # Update game screen

      Graphics.update

      # Update input information

      Input.update

      # Frame update

      update

      # Abort loop if the dialog should close

      if marked_to_close

        break

      end

    end

    # Dispose of windows

    main_dispose

    # Dispose of background

    dispose_background

    # Update input information

    Input.update

    # Returns the acquired value

    return self.value

  end

  #--------------------------------------------------------------------------

  # * Create the dimmed background

  #--------------------------------------------------------------------------

  def create_background

    bitmap = Bitmap.new(640,480)

    bitmap.fill_rect(0,0,640,480,Color.new(0,0,0,128))

    @background_sprite = Sprite.new

    @background_sprite.z = STARTING_Z_VALUE

    @background_sprite.bitmap = bitmap

  end

  #--------------------------------------------------------------------------

  # * Create the windows

  #--------------------------------------------------------------------------

  def main_window

    # For the subclasses to override

    # Remember to set their z.value to at least STARTING_Z_VALUE + 1

  end

  #--------------------------------------------------------------------------

  # * Dispose the background

  #--------------------------------------------------------------------------

  def dispose_background

    @background_sprite.dispose

  end

  #--------------------------------------------------------------------------

  # * Dispose the windows

  #--------------------------------------------------------------------------

  def main_dispose

    # For the subclasses to override

    # Dispose your windows here

  end

  #--------------------------------------------------------------------------

  # * Frame Update

  #--------------------------------------------------------------------------

  def update

    # For the subclasses to override

    if Input.trigger?(Input::B)

      mark_to_close

    end

  end

end

An example - A Yes/No Dialog

Code:
#============================================================================

# * A Simple Yes/No dialog

#============================================================================

class Dialog_YesNo < Dialog

  # self.value: false = No, true = Yes

  #--------------------------------------------------------------------------

  # * A show method

  #--------------------------------------------------------------------------

  def initialize(default_value = false, text = nil)

    # Sets the default value

    self.value = default_value

    @text = text

    # Sets the menu index

    if default_value

      @menu_index = 0

    else

      @menu_index = 1

    end

  end

  #--------------------------------------------------------------------------

  # * Create the windows

  #--------------------------------------------------------------------------

  def main_window

    @disposables = []

    # The command window

    @command_window = Window_Command.new(80, ['Yes', 'No'])

    @command_window.index = @menu_index

    @command_window.x = (640 - @command_window.width) / 2

    @command_window.y = (480 - @command_window.height) / 2

    @command_window.z = STARTING_Z_VALUE + 1

    @disposables << @command_window

    # The text window

    if @text.is_a?(String)

      @text_window = Window_Help.new

      @text_window.set_text(@text, 1)

      @text_window.z = STARTING_Z_VALUE + 1

      @disposables << @text_window

    end

  end

  #--------------------------------------------------------------------------

  # * Dispose the windows

  #--------------------------------------------------------------------------

  def main_dispose

    @disposables.each {|element| element.dispose}

  end

  #--------------------------------------------------------------------------

  # * Frame Update

  #--------------------------------------------------------------------------

  def update

    @command_window.update

    if Input.trigger?(Input::B)

      mark_to_close

    end

    if Input.trigger?(Input::C)

      if @command_window.index == 0

        self.value = true

      else

        self.value = false

      end

      mark_to_close

    end

  end

end

The idea is that you can all this dialog anywhere with the code:

Code:
# Code before

var = Dialog_YesNo.show(default_value, text) # Calls the dialog

# Code after

The dialog should then be shown and the code after will only be executed after the player chooses yes or no. It will return false if No is selected and true if Yes is selected.
Then the code placed after the call will be executed. You can say it will freeze execution until the dialog is closed.
The principle is that you can call this code anyway. In script calls as well as in normal scripts.
Here is an example of a script call:

Code:
s = 'Do you want to open the chest?'

v = Dialog_YesNo.show(true, s)

$game_switches[5] = v

Here is an event using this:

Angry Chest

I assume you know how to make page 2 and page 3 yourself.

I know. This can easily be done with the normal choice system in events. So what about an example where its use is more clear?
Did you know that if you try to save on a slot where there already is a savegame it does not ask if you want to overwrite? It simply just overwrites the savegame. Let us say we don't want that. The remedy?

Code:
class Scene_Save < Scene_File

  alias scene_save_overwrite_dialog_on_decision on_decision

  #--------------------------------------------------------------------------

  # * Decision Processing

  #--------------------------------------------------------------------------

  def on_decision(filename)

    if File.exist?(filename)

      var = Dialog_YesNo.show(false, 'Do you want to overwrite' +

                                     ' the old savegame?')

      unless var

        $game_system.se_play($data_system.buzzer_se)

        return

      end

    end

    scene_save_overwrite_dialog_on_decision(filename)

  end

end

Just paste this anywhere below the original Scene_Save.