#==============================================================================
# ** Battlebacks VX
#------------------------------------------------------------------------------
#    by DerVVulfman
#    version 1.2
#    03-29-2008
#    RGSS2
#------------------------------------------------------------------------------
#
#  INTRODUCTION:
#
#  This system reintroduces the use of 'Battleback' graphics into your pro-
#  jects, something that was sadly lacking in tbe RPGMaker VX system.
#
#------------------------------------------------------------------------------
#
#  SCRIPT CALLS:
#
#  There's only one script call that you need to know.
#
#  --Changing Battlebacks--
#  Given that this system allows you to use 'Battlebacks, you may find a need
#  to 'change' the battleback in-game. Unfortunately, this can't be done with
#  a pre-rendered map event, so I had to make a script call:
#
#          $game_system.battleback = "filename"
#
#  The filename is whatever is stored within the folder that you have speci-
#  fied in the configuration section (in the BATTLEBACK_DIR value).
# 
#------------------------------------------------------------------------------
#
#  THANKS:
#
#  To Fantasy at RPG RPG Revolution for noticing a bug when using the 'Battle
#  Test' feature.
#
#------------------------------------------------------------------------------
#  TERMS AND CONDITIONS:
#
#  Free to use, even in commercial projects.  Just note that I need some form
#  of due credit... even a mere mention in some end titles.
#
#==============================================================================

  #========================================================================
  #  **  C  O  N  F  I  G  U  R  A  T  I  O  N      S  Y  S  T  E  M  **  #
  #======================================================================== 
 
  # Name of directory (used in cache)
    BATTLEBACK_DIR = "Graphics/Battlebacks/"

  # List of battlebacks by Map ID.
  #                    MapID    Filename                 
    BATTLEBACK_LIST = {
  1 => "BG7",
  2 => "BG7",
  10 => "BG002",
  13 => "BG7",
  14 => "BG8",
  15 => "BG2",
  22 => "BG003",
  23 => "BG003",
  31 => "BG2",
  33 => "BG004",
  40 => "BG3",
  50 => "BG3",
  55 => "BG0011",
  58 => "BG1",
  59 => "BG1",
  61 => "BG2", 
  62 => "BG2",   
  64 => "BG8",   
  65 => "BG7", 
  66 => "BG8",
  69 => "bg000", 
  70 => "BG1", 
  77 => "BG005", 
  78 => "BG005", 
  84 => "BG005",   
  86 => "BG11",
  88 => "BG12",
  89 => "BG12",
  101 => "BG18",
  102 => "BG18",
  105 => "BG18",
  109 => "BG17",   
  112 => "BG17",
  113 => "BG5",
  116 => "BG5",
  117 => "BG23", 
  120 => "BG16",
  127 => "BG19",
  134 => "BG2",
  144 => "BG23",
  146 => "BG23",
  147 => "BG23",
  148 => "BG29",
  150 => "BG23", 
  152 => "BG26",
  151 => "BG31",
  153 => "BG26",
  154 => "BG25",
  155 => "BG27", 
  156 => "BG24",
  157 => "BG005",
  158 => "BG7",
  159 => "BG30",
  170 => "BG28"
 
 
  }
  # The name of the battleback used
  # when using the Battle Test feature.
    BATTLEBACK_TEST = "BG004"                     

                 
#==============================================================================
# ** Cache
#------------------------------------------------------------------------------
#  This module loads each of graphics, creates a Bitmap object, and retains it.
# To speed up load times and conserve memory, this module holds the created
# Bitmap object in the internal hash, allowing the program to return
# preexisting objects when the same bitmap is requested again.
#==============================================================================

module Cache
  #--------------------------------------------------------------------------
  # * Get Battleback Graphic
  #    filename : Filename
  #-------------------------------------------------------------------------- 
  def self.battleback(filename)
    load_bitmap(BATTLEBACK_DIR, filename)
  end
end


#==============================================================================
# ** Game_System
#------------------------------------------------------------------------------
#  This class handles system-related data. Also manages vehicles and BGM, etc.
# The instance of this class is referenced by $game_system.
#==============================================================================

class Game_System
  #--------------------------------------------------------------------------
  # * Public Instance Variables
  #--------------------------------------------------------------------------
  attr_accessor :battleback              # filename of battleback
  #--------------------------------------------------------------------------
  # * Object Initialization
  #--------------------------------------------------------------------------
  alias bback_initialize initialize
  def initialize
    bback_initialize
    @battleback = nil
  end
end



#==============================================================================
# ** Spriteset_Battle
#------------------------------------------------------------------------------
#  This class brings together battle screen sprites. It's used within the
# Scene_Battle class.
#==============================================================================

class Spriteset_Battle
  #--------------------------------------------------------------------------
  # * Create Battleback Sprite
  #--------------------------------------------------------------------------
  alias bback_create_battleback create_battleback
  def create_battleback
    # Perform and exit for battletests
    if $BTEST
      if BATTLEBACK_TEST != nil
        # Create Battleback sprite
        @battleback_sprite = Sprite.new(@viewport1)
        # Load image from cache
        @battleback_sprite.bitmap = Cache.battleback(BATTLEBACK_TEST)
        return
      else
        bback_create_battleback
        return
      end
    end
    # If map used 'called' battleback. 
    if $game_system.battleback != nil
      # Create Battleback sprite
      @battleback_sprite = Sprite.new(@viewport1)
      # Load image from cache
      @battleback_sprite.bitmap = Cache.battleback($game_system.battleback)   
    # If map has assigned battleback
    elsif BATTLEBACK_LIST.key?($game_map.map_id)
      # Create Battleback sprite
      @battleback_sprite = Sprite.new(@viewport1)
      # Load image from cache
      @battleback_sprite.bitmap = Cache.battleback(BATTLEBACK_LIST[$game_map.map_id])
    # Otherwise, as normal
    else
      # Perform the original call
      bback_create_battleback
    end
  end 
  #--------------------------------------------------------------------------
  # * Create Battlefloor Sprite
  #-------------------------------------------------------------------------- 
  alias bback_create_battlefloor create_battlefloor
  def create_battlefloor
    # Disable battlefloor for existing battleback maps
    if BATTLEBACK_LIST.key?($game_map.map_id) or $game_system.battleback != nil
      @battlefloor_sprite = Sprite.new(@viewport1)
      return
    end
    # Disable for battletests with set battleback
    if $BTEST
      if BATTLEBACK_TEST != nil
        @battlefloor_sprite = Sprite.new(@viewport1)
        return
      end
    end
    # Perform the original call
    bback_create_battlefloor
  end
end