Ruby Quellcode

#==============================================================================
# ** Achievementsystem (Version 1.0.1)
#------------------------------------------------------------------------------
#  Ermöglicht es, dem Spieler kleine Erfolge zu verbuchen, die er sich auch
#  immer wieder ansehen kann. Die Konfiguration ist sehr einfach:
#    1. Erstelle unter Database/System ein Element "[Achievement]"
#    2. Erstelle unter Database/Items neue Gegenstände, gib ihnen einen
#       Namen, ein Icon und eine Beschreibung, sowie als Element das unter
#       Punkt 1 angelegte Element "[Achievement]"
#    3. Wenn immer der Spieler einen kleinen Erfolg erreicht hat, kann man ihm
#       via CallSkript:
#                        unlock_achievement( item_id )
#       den Erfolg freischalten. Die Item ID ist dabei die ID aus der Database.
#    4. Über das CallSkript:
#           $scene = Scene_Achievement.new
#       kann der Spieler seine bisher freigeschalteten Erfolge sehen.
#  Bemerke: Die Icons eines Achievements sind nicht 24x24 sondern 48x48 Pixel
#  groß.
#  Zusätzlich gibt es noch ein paar Optionen im Quellcode:
#  + Setze die Konstante Display_Locked_Achievements in Zeile 264 auf false,
#    um nur die Achievements aufzulisten, die bereits freigeschaltet wurden.
#  + Setze die Konstante Hide_Locked_Achievments_Info in Zeile 265 auf false,
#    um bei nicht freigeschalteten Achievements trotzdem Name und Beschreibung
#    anzuzeigen.
#  + Bestimme in Zeile 265 welcher Icon für noch nicht freigeschaltete
#    Achievements angezeigt werden soll.
#  + Bestimme in Zeile 208 welcher Titel in der Infobox angezeigt werden soll.
#  + Die verwendeten Textfarben entsprechen den Farben aus ShowText, man kann
#    dafür die Zeilen 192, 199, 246 und 249 anpassen.
#------------------------------------------------------------------------------
#  Autor: Playm
#  Datum: April 2015
#  Maker: RPG Maker XP
#  Einfache Nutzung in nicht-kommerziellen  RMXP  Projekten ist gestattet.
#  Keine kommerzielle Nutzung gestattet. Für Lizenzen an den Autor wenden.
#  Keine Weiterverbreitung in originaler oder abgeänderter Form gestattet.
#==============================================================================
#==============================================================================
# ** Game_Temp
#==============================================================================
class Game_Temp
  #--------------------------------------------------------------------------
  # * Attr
  #--------------------------------------------------------------------------
  attr_accessor :new_unlocked_achievments # Array of ItemIDs of new unlocked
  #--------------------------------------------------------------------------
  # * Alias
  #--------------------------------------------------------------------------
  alias_method( :org_ini_wo_achievments, :initialize )
  #--------------------------------------------------------------------------
  # * Object Initialization
  #--------------------------------------------------------------------------
  def initialize
    org_ini_wo_achievments
    @new_unlocked_achievments = []
  end
end
#==============================================================================
# ** Game_Party
#==============================================================================
class Game_Party
  #--------------------------------------------------------------------------
  # * Public Instance Variables
  #--------------------------------------------------------------------------
  attr_accessor  :achievements   # Array of ItemIDs of unlocked achievements
  #--------------------------------------------------------------------------
  # * Alias
  #--------------------------------------------------------------------------
  alias_method( :org_ini_wo_achievments, :initialize )
  #--------------------------------------------------------------------------
  # * Object Initialization
  #--------------------------------------------------------------------------
  def initialize
    org_ini_wo_achievments
    @achievements = []
  end
end
#==============================================================================
# ** Game Interpreter
#==============================================================================
class Interpreter
  #--------------------------------------------------------------------------
  # * Ein neues Achievement freischalten
  #     item_id  :  ID des Items, das die Achievementdaten enthält.
  #                 Das Item muss das Element "[Achievement]" haben.
  #--------------------------------------------------------------------------
  def unlock_achievement( item_id )
    if item_id_is_valid_achievment?( item_id )
      unless $game_party.achievements.include? item_id
        $game_temp.new_unlocked_achievments << item_id
        $game_party.achievements            << item_id
      end
    else
      msg = "Event %d hat versucht eine invalide Item ID (%d)\n"+
            "als Achievment hinzuzufügen. Vorgang abgebrochen."
      print msg%[ @event_id, item_id ]
    end
    return nil
  end
  #--------------------------------------------------------------------------
  # * Prüfe das Item, ob es sich um ein Achievement handelt.
  #--------------------------------------------------------------------------
  def item_id_is_valid_achievment?( item_id )
    achievement_element = $data_system.elements.index( "[Achievement]" )
    $data_items[ item_id ].element_set.include?( achievement_element )
  end
end
#==============================================================================
# ** Window_Base
#==============================================================================
class Window_Base
  #--------------------------------------------------------------------------
  # * Zeichnet einen BigIcon zentriert innerhalb eines 64x64 Rects.
  #--------------------------------------------------------------------------
  def draw_big_icon( x, y, icon_name )
    bitmap = RPG::Cache.icon( icon_name )
    contents.blt( x + 8, y + 8, bitmap, Rect.new(0,0,48,48))
  end
end
#============================================================================
# ** Window_AchievementInfo
#============================================================================
class Window_AchievementInfo < Window_Base
  #--------------------------------------------------------------------------
  # * Objektinitialisierung
  #--------------------------------------------------------------------------
  def initialize
    super( 640, 0, 32, 96 )
    self.contents = Bitmap.new( 1, 1)
    @phase = :idle
  end
  #--------------------------------------------------------------------------
  # * Frame Update
  #--------------------------------------------------------------------------
  def update
    super
    return check    if @phase == :idle
    return fade_in  if @phase == :fade_in
    return wait     if @phase == :wait
    return fade_out if @phase == :fade_out
  end
  #--------------------------------------------------------------------------
  # * Prüfe, ob ein neues Achievement freigeschaltet wurde
  #--------------------------------------------------------------------------
  def check
    unless $game_temp.new_unlocked_achievments.empty?
      item_id = $game_temp.new_unlocked_achievments.shift
      display_achievement( item_id )
    end
  end
  #--------------------------------------------------------------------------
  # * Einblenden
  #--------------------------------------------------------------------------
  def fade_in
    if x <= 640 - width
      @wait  = 40 # Display Window for 40 frames
      @phase = :wait
      return
    end
    self.x -= 4
  end
  #--------------------------------------------------------------------------
  # * Warten
  #--------------------------------------------------------------------------
  def wait
    @wait -= 1
    @phase = :fade_out if @wait.zero?
  end
  #--------------------------------------------------------------------------
  # * Ausblenden
  #--------------------------------------------------------------------------
  def fade_out
    if x >= 640
      self.x = 640
      @phase = :idle
    end
    self.x += 4
  end
  #--------------------------------------------------------------------------
  # * Ein Achievement anzeigen
  #--------------------------------------------------------------------------
  def display_achievement( item_id )
    item = $data_items[item_id]
    setup_width( nedded_width( item ) )
    draw_achievement( item )
    @phase = :fade_in
  end
  #--------------------------------------------------------------------------
  # * Zeichne die Überschrift
  #--------------------------------------------------------------------------
  def draw_headline( title )
    contents.font.color = text_color( 5 )
    contents.draw_text( 64, 0, contents.width-64, 32, title, 1)
  end
  #--------------------------------------------------------------------------
  # * Zeichne den Namen des Achievements
  #--------------------------------------------------------------------------
  def draw_name( name )
    contents.font.color = text_color( 0 )
    contents.draw_text( 64, 32, contents.width-64, 32, name)
  end
  #--------------------------------------------------------------------------
  # * Zeichne das Achievement
  #--------------------------------------------------------------------------
  def draw_achievement( item )
    contents.clear
    draw_big_icon( 0, 0, item.icon_name )
    draw_headline( "Achievement unlocked" )
    draw_name( item.name )
  end
  #--------------------------------------------------------------------------
  # * Setze die Fensterbreite und lege ein passendes Contentbitmap an
  #--------------------------------------------------------------------------
  def setup_width( cw )
    self.width = cw + 32
    self.contents.dispose
    self.contents = Bitmap.new( cw, height-32 )
  end
  #--------------------------------------------------------------------------
  # * Bestimme wieviel Platz benötigt wird, um den Itemnamen anzuzeigen
  #--------------------------------------------------------------------------
  def nedded_width( item )
    item_name_width = contents.text_size(item.name).width
    [ [(item_name_width / 8) * 8, 192].max, 212 ].min + 64
  end
end
#==============================================================================
# ** Window_Help
#==============================================================================
class Window_Help
  #--------------------------------------------------------------------------
  # * Object Initialization
  #--------------------------------------------------------------------------
  def initialize( width=640, height=64 )
    super(0, 0, width, height)
    self.contents = Bitmap.new(width - 32, height - 32)
  end
  #--------------------------------------------------------------------------
  # * Set Text
  #     name        : first row of text
  #     description : second row of text
  #     enabled     : how to draw second row
  #--------------------------------------------------------------------------
  def set_achievement(name, description, enabled=true)
    if name != @name or description != @description
      contents.clear
      contents.font.color = text_color(4)
      contents.draw_text(4,  0, self.width - 40, 32, name)
      contents.font.color = enabled ? text_color(0) : disabled_color
      contents.draw_text(36, 32, self.width - 72, 32, description)
      @name = name
      @description = name
      @text = nil
    end
  end
end
#==============================================================================
# ** Window_Achievements
#==============================================================================
class Window_Achievements < Window_Selectable
  #--------------------------------------------------------------------------
  # * Konstanten
  #--------------------------------------------------------------------------
  Display_Locked_Achievements  = true
  Hide_Locked_Achievments_Info = true
  Locked_Icon                  = "BigIcon_by_Avery_Chest"
  #--------------------------------------------------------------------------
  # * Object Initialization
  #--------------------------------------------------------------------------
  def initialize
    super(0, 96, 640, 384)
    @column_max = 5
    refresh
    self.index = 0
  end
  #--------------------------------------------------------------------------
  # * Get Item
  #--------------------------------------------------------------------------
  def item
    return @data[self.index]
  end
  #--------------------------------------------------------------------------
  # * Refresh
  #--------------------------------------------------------------------------
  def refresh
    if self.contents != nil
      self.contents.dispose
      self.contents = nil
    end
    # Get the Achievement Element
    achievement_element = $data_system.elements.index( "[Achievement]" )
    # Get all Achievement Items
    @data = $data_items.select do |item|
      item and item.element_set.include? achievement_element
    end
    # Remove Items the Party doesn't unlocked
    unless Display_Locked_Achievements
      @data.delete_if{ |i| not achievement_unlocked?( i ) }
    end
    # If item count is not 0, make a bit map and draw all items
    @item_max = @data.size
    if @item_max > 0
      self.contents = Bitmap.new(width - 32, row_max * row_height)
      for i in 0...@item_max
        draw_item(i)
      end
    end
  end
  #--------------------------------------------------------------------------
  # * Draw Item
  #     index : item number
  #--------------------------------------------------------------------------
  def draw_item(index)
    item = @data[index]
    rect = get_item_rect( index )
    contents.fill_rect(rect, Color.new(0, 0, 0, 0))
    rect.x += (rect.width - 64) / 2
    icon_name = achievement_unlocked?( item ) ? item.icon_name : Locked_Icon
    draw_big_icon( rect.x, rect.y, icon_name )
  end
  #--------------------------------------------------------------------------
  # * Get Drawingrect for Index
  #--------------------------------------------------------------------------
  def get_item_rect( index )
    rect = Rect.new(0,0,0,0)
    rect.width  = self.width / @column_max - 32
    rect.height = row_height
    rect.x = index % @column_max * (rect.width + 32)
    rect.y = index / @column_max * rect.height
    rect
  end
  #--------------------------------------------------------------------------
  # * Update Cursor Rectangle
  #--------------------------------------------------------------------------
  def update_cursor_rect
    super
    rect = get_item_rect( index )
    cursor_rect.set(rect.x, rect.y - oy, rect.width, rect.height)
  end
  #--------------------------------------------------------------------------
  # * Check whether the achievement is already unlocked
  #    item : item which represend achievement
  #--------------------------------------------------------------------------
  def achievement_unlocked?( item )
    $game_party.achievements.include? item.id
  end
  #--------------------------------------------------------------------------
  # * Get row height
  #--------------------------------------------------------------------------
  def row_height
    64
  end
  #--------------------------------------------------------------------------
  # * Help Text Update
  #--------------------------------------------------------------------------
  def update_help
    return if item.nil?
    enabled = achievement_unlocked?( item )
    if Hide_Locked_Achievments_Info and not enabled
      @help_window.set_achievement( '???', '???')
    else
      @help_window.set_achievement( item.name, item.description, enabled)
    end
  end
end
#==============================================================================
# ** Scene_Map
#==============================================================================
class Scene_Map
  #--------------------------------------------------------------------------
  # * Alias
  #--------------------------------------------------------------------------
  alias_method( :org_main_wo_achievements, :main )
  alias_method( :org_update_wo_achievements, :update )
  #--------------------------------------------------------------------------
  # * Main Processing
  #--------------------------------------------------------------------------
  def main
    @achievement_info_window = Window_AchievementInfo.new
    org_main_wo_achievements
    @achievement_info_window.dispose
  end
  #--------------------------------------------------------------------------
  # * Frame Update
  #--------------------------------------------------------------------------
  def update
    @achievement_info_window.update
    org_update_wo_achievements
  end
end
#==============================================================================
# ** Scene_Achievement
#==============================================================================
class Scene_Achievement
  #--------------------------------------------------------------------------
  # * Main Processing
  #--------------------------------------------------------------------------
  def main
    @help_window = Window_Help.new(640, 96) # Make help window, item window
    @item_window = Window_Achievements.new
    @item_window.help_window = @help_window # Associate help window
    Graphics.transition                     # Execute transition
    loop do                                 # Main loop
      Graphics.update                       # Update game screen
      Input.update                          # Update input information
      update                                # Frame update
      break if $scene != self               # Abort loop if screen is changed
    end
    Graphics.freeze                         # Prepare for transition
    @help_window.dispose                    # Dispose of windows
    @item_window.dispose
  end
  #--------------------------------------------------------------------------
  # * Frame Update
  #--------------------------------------------------------------------------
  def update
    @help_window.update
    @item_window.update
    if Input.trigger?(Input::B)
      $game_system.se_play($data_system.cancel_se)
      $scene = Scene_Map.new
    end
  end
end