MARKUST'S PROFILE

#==============================================================================
# 
# ▼ Yanfly Engine Ace - Terrain Battlebacks v1.00
# -- Last Updated: 2011.12.30
# -- Level: Normal
# -- Requires: n/a
#
# Modified by MikePj on 2012.11.13 
#
# Comments below.
#
# This is a heavly modified version of yanfly's Region Battlebacks made to use
# Terrain tags as appose to Region IDs.
# Why did i make this? Well as cool as it is to use regions to tell the game 
# what battlebacks to use, i prefer to simply set it by way of terrain tags.. 
# and i could be wrong, but i THINK that is how it's done in 2K and 2K3.. 
# but i COULD be wrong. *laughs* i'm wrong a lot >_<
#
# Some instructions fallow
#
# Anyhow, it still works basically the same way as Region Battlebacks did
# only now you have to apply the terrain tags you want used in the 
# database under tilesets, and then below you assign what battle backs for
# what tags.
# You can also change what battle backs are used while play, by the same 
# methods as before, only it's terrain rather than region.
# Anyhow, i hope you all enjoy this and i hope it's useful.
# A very special thanks to Yanfly for doing most of the legwork i know i 
# could NEVER EVER do. Also, a lot of credit. What i did to change this 
# script was rather simple..so.. yeah lol
#==============================================================================

$imported = {} if $imported.nil?
$imported["YEA-TerrainBattleBacks"] = true

#==============================================================================
# ▼ Updates
# =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
# 2011.12.30 - Started Script and Finished.
# 
#==============================================================================
# ▼ Introduction
# =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
# RPG Maker VX Ace lacks any kind of a good battleback management system. All
# battlebacks for the overworld are predetermined based on their autotile. This
# becomes a problem when users would like to use different autotiles or when
# users aren't using an overworld tileset. This script allows developers to
# bind certain battlebacks to terrains and have the battleback shown change and
# vary depending on the terrain tag used if no specified battleback is used for
# that map.
# 
#==============================================================================
# ▼ Instructions
# =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
# To install this script, open up your script editor and copy/paste this script
# to an open slot below ▼ Materials/素材 but above ▼ Main. Remember to save.
# 
# -----------------------------------------------------------------------------
# Map Notetags - These notetags go in the map notebox in a map's properties.
# -----------------------------------------------------------------------------
# <terrain battlebacks>
#  x-y: string
#  x-y: string
# </terrain battlebacks>
# This will set the terrain x to change battleback y to the string for the image
# filename. Insert as many "x-y: string" as needed for custom battlebacks. The
# terrain battlebacks that aren't defined will refer to the hash in the terrain
# Battlebacks script module.
# 
#==============================================================================
# ▼ Compatibility
# =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
# This script is made strictly for RPG Maker VX Ace. It is highly unlikely that
# it will run with RPG Maker VX without adjusting.
# 
#==============================================================================

module YEA
  module BATTLEBACKS
    
    #=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
    # - Default Terrain Settings -
    #=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
    # This will set the default backdrops for maps without custom terrain
    # settings. These settings will always be used unless there is a forced
    # battleback or the map specifies certain battlebacks. Note that if your
    # party encounters battles while on a ship, the ship battleback will take
    # priority over all of these. Adjust the ship battlebacks further below.
    #=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
    DEFAULT ={
    # TerrainID => [Battleback1,       Battleback2],
             0 => ["Field B", ""],
             1 => ["Field B", ""],
             2 => ["Forest D", "Forest Foliage"],
    } # Do not remove this.
    
    #=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
    # - Other Default Settings -
    #=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
    # These settings will be applied for battleback areas without marked terrain
    # battlebacks. They'll appear when nothing in the above hash appears and
    # there is no specified battleback.
    #=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
    DEFAULT_BATTLEBACK_FOOT1 = "Field B"   # Battleback1 for traveling on foot.
    DEFAULT_BATTLEBACK_FOOT2 = ""   # Battleback2 for traveling on foot.
    DEFAULT_BATTLEBACK_SHIP1 = "ff2_psp_ship_deck" # Battleback1 for traveling on ship.
    DEFAULT_BATTLEBACK_SHIP2 = "" # Battleback2 for traveling on ship.
    
  end # BATTLEBACKS
end # YEA

#==============================================================================
# ▼ Editting anything past this point may potentially result in causing
# computer damage, incontinence, explosion of user's head, coma, death, and/or
# halitosis so edit at your own risk.
#==============================================================================

module YEA
  module REGEXP
  module MAP
    
    TERRAIN_BATTLEBACKS_ON  = /<(?:TERRAIN_BATTLEBACKS|terrain battlebacks)>/i
    TERRAIN_BATTLEBACKS_OFF = /<\/(?:TERRAIN_BATTLEBACKS|terrain battlebacks)>/i
    TERRAIN_BATTLEBACK_TAG   = /(\d+)([-－])(\d+):[ ](.*)/i
    
  end # MAP
  end # REGEXP
end # YEA

#==============================================================================
# ■ RPG::Map
#==============================================================================

class RPG::Map
  
  #--------------------------------------------------------------------------
  # public instance variables
  #--------------------------------------------------------------------------
  attr_accessor :terrain_battlebacks
  
  #--------------------------------------------------------------------------
  # common cache: load_notetags_rbb
  #--------------------------------------------------------------------------
  def load_notetags_rbb
    @terrain_battlebacks = YEA::BATTLEBACKS::DEFAULT.clone
    @terrain_battlebacks_on = false
    #---
    self.note.split(/[\r\n]+/).each { |line|
      case line
      #---
      when YEA::REGEXP::MAP::TERRAIN_BATTLEBACKS_ON
        @terrain_battlebacks_on = true
      when YEA::REGEXP::MAP::TERRAIN_BATTLEBACKS_OFF
        @terrain_battlebacks_on = false
      when YEA::REGEXP::MAP::TERRAIN_BATTLEBACK_TAG
        next unless @terrain_battlebacks_on
        rid = $1.to_i
        @terrain_battlebacks[rid] = ["", ""] if @terrain_battlebacks[rid].nil?
        case $3.to_i
        when 1
          @terrain_battlebacks[rid][0] = $4.to_s
        when 2
          @terrain_battlebacks[rid][1] = $4.to_s
        end
      #---
      end
    } # self.note.split
    #---
  end
  
end # RPG::Map


#==============================================================================
# ■ Spriteset_Battle
#==============================================================================

class Spriteset_Battle
  
  #--------------------------------------------------------------------------
  # overwrite method: battleback1_name
  #--------------------------------------------------------------------------
  def battleback1_name
    if $BTEST
      $data_system.battleback1_name
    elsif $game_map.battleback1_name
      $game_map.battleback1_name
    else
      overworld_battleback1_name
    end
  end
  
  #--------------------------------------------------------------------------
  # overwrite method: battleback2_name
  #--------------------------------------------------------------------------
  def battleback2_name
    if $BTEST
      $data_system.battleback2_name
    elsif $game_map.battleback2_name
      $game_map.battleback2_name
    else
      overworld_battleback2_name
    end
  end
  
  #--------------------------------------------------------------------------
  # alias method: normal_battleback1_name
  #--------------------------------------------------------------------------
  alias normal_battleback1_name_rbb normal_battleback1_name
  def normal_battleback1_name
    $game_map.terrain_battleback1 || normal_battleback1_name_rbb
  end
  
  #--------------------------------------------------------------------------
  # alias method: normal_battleback2_name
  #--------------------------------------------------------------------------
  alias normal_battleback2_name_rbb normal_battleback2_name
  def normal_battleback2_name
    $game_map.terrain_battleback2 || normal_battleback2_name_rbb
  end
  
  #--------------------------------------------------------------------------
  # overwrite method: default_battleback1_name
  #--------------------------------------------------------------------------
  def default_battleback1_name
    return YEA::BATTLEBACKS::DEFAULT_BATTLEBACK_FOOT1
  end
  
  #--------------------------------------------------------------------------
  # overwrite method: default_battleback2_name
  #--------------------------------------------------------------------------
  def default_battleback2_name
    return YEA::BATTLEBACKS::DEFAULT_BATTLEBACK_FOOT2
  end
  
  #--------------------------------------------------------------------------
  # overwrite method: ship_battleback1_name
  #--------------------------------------------------------------------------
  def ship_battleback1_name
    return YEA::BATTLEBACKS::DEFAULT_BATTLEBACK_SHIP1
  end
  
  #--------------------------------------------------------------------------
  # overwrite method: ship_battleback2_name
  #--------------------------------------------------------------------------
  def ship_battleback2_name
    return YEA::BATTLEBACKS::DEFAULT_BATTLEBACK_SHIP2
  end
  
end # Spriteset_Battle

#==============================================================================
# ■ Game_Map
#==============================================================================

class Game_Map
  
  #--------------------------------------------------------------------------
  # alias method: setup
  #--------------------------------------------------------------------------
  alias game_map_setup_rbb setup
  def setup(map_id)
    game_map_setup_rbb(map_id)
    @map.load_notetags_rbb
  end
  
  #--------------------------------------------------------------------------
  # new method: terrain_battlebacks
  #--------------------------------------------------------------------------
  def terrain_battlebacks
    return @map.terrain_battlebacks
  end
  
  #--------------------------------------------------------------------------
  # new method: terrain_battleback1
  #--------------------------------------------------------------------------
  def terrain_battleback1
    return terrain_battlebacks[$game_player.terrain_tag][0]
  end
  
  #--------------------------------------------------------------------------
  # new method: terrain_battleback2
  #--------------------------------------------------------------------------
  def terrain_battleback2
    return terrain_battlebacks[$game_player.terrain_tag][1]
  end
  
end # Game_Map

#==============================================================================
# 
# ▼ End of File
# 
#==============================================================================