戦闘背景の変更

■ 概　　要

・戦闘背景に画像を使用できるようにします。
・設定方法として下記のいずれかの方法を利用できます。
　：マップを背景とする。
　：マップＩＤ別に変更する。
　：遠景設定の画像を使用する。
　：敵グループ名で変更する。
　：マップ・エリア名で変更する。
　：地形（タイル）ごとに変更する。

■ スクリーンショット

※ 画像は開発中のものです。

■ 更新履歴

11/08/21 ... v1.2.0
　放射状のぼかし効果追加
　解像度ＭＡＸでもダメージ時に黒背景が見えないように変更
　地形＋敵グループ名で判定するモードを追加

11/08/11 ... v1.1.2
　マップ名で判別する設定の場合にエリア名を無視していた不具合を修正

11/07/02 ... v1.1.1
　ＣＢＳの更新に伴う変更

11/01/27 ... v1.1.0
　ウィンドウの背景(IMG_WINDOW_BACK)の設定で空文字列("")の設定を廃止
　ウィンドウの背景画像に自由なサイズを使用できるように変更
　解像度の変更に対応 (デフォルトより小さいサイズは未確認)

11/01/16 ... v1.0.8
　ウィンドウの背景色の設定を追加
　イベントで次の戦闘背景を指定する機能を追加
　戦闘中に背景を変更する機能を追加

10/04/05 ... v1.0.7
　一部、内部処理を変更

09/11/23 ... v1.0.6
　表示モードが３もしくは４のときにエラーがでる不具合を修正

09/11/23 ... v1.0.5
　キーチェックを行うように変更
　背景マップのトーン設定を追加
　遠景未設定で背景が黒になってしまう不具合を修正
　敵グループ名、マップ名の<BB:>を処理しないように変更

09/09/08 ... v1.0.4
　戦闘背景画像の横サイズが544pxに対応
　ただし、推奨サイズではありませんので、画面が揺れたときなど画像が途切れます。

09/06/25 ... v1.0.3
　地形判定モードで、0 => "" と設定すると背景が黒になる不具合を修正
　戦闘テスト時に「敵グループ名で判定」の場合は、背景画像を表示するように変更
　（それ以外は、0 に設定された背景を表示します。マップ画像の場合は黒背景です。）

09/06/08 ... v1.0.2
　戦闘テスト時にエラーがでる不具合を修正

09/02/12 ... v1.0.1
　背景のマップ画像がずれて表示される不具合を修正
　地形判定モードで、0 => "" と設定すると背景が黒になる不具合を修正
　地形判定モードで、未設定のハッシュキーを使用するとエラーになるように変更

09/02/05 ... v1.0.0 公開

■ スクリプト

#******************************************************************************
#
#    ＊ 戦闘背景の変更
#
#  --------------------------------------------------------------------------
#    バージョン ：  1.2.0
#    対      応 ：  RPGツクールVX : RGSS2
#    制  作  者 ：  ＣＡＣＡＯ
#    配  布  元 ：  https://cacaosoft.mars.jp/
#  --------------------------------------------------------------------------
#   == 概    要 ==
#
#    ： 戦闘背景の表示方法を変更します。
#    ※ デフォルトの表示方法は使用できなくなります。
#
#  --------------------------------------------------------------------------
#   == 注意事項 ==
#
#    ※ 一部の表示方法では、他に必要となるスクリプトがあります。
#       MODE 4 : マップ名で判定する場合 "Cacao Base Script"
#       MODE 5 : 地形(タイル)で判定する場合 KGCさんの "タイルセット拡張"
#
#  --------------------------------------------------------------------------
#   == 使用方法 ==
#
#    ★ 一時的に戦闘背景を変更する
#     change_battleback("ファイル名")
#    ※ 空文字列の場合は、マップを背景とします。
#    ※ マップイベントで使用した場合は、次の戦闘の背景となります。
#
#
#******************************************************************************

#==============================================================================
# ◆ 設定項目
#==============================================================================
module CAO
module BattleBack
  #--------------------------------------------------------------------------
  # ◇ 背景の表示方法
  #--------------------------------------------------------------------------
  #     0 ... マップ画像
  #     1 ... 固定・マップで判定
  #     2 ... 遠景で判定
  #     3 ... 敵グループ名で判定
  #     4 ... マップ名で判定 (CBS必須)
  #     5 ... 地形で判定 (KGCさんのタイルセット拡張スクリプト必須)
  #     6 ... 地形 ＋ 敵グループ名で判定 (敵グループ名を優先)
  #--------------------------------------------------------------------------
    MODE = 6
  #--------------------------------------------------------------------------
  # ◇ 放射状のぼかし効果
  #--------------------------------------------------------------------------
    RADIAL_BLUR = false
  #--------------------------------------------------------------------------
  # ◇ 影を非表示
  #--------------------------------------------------------------------------
    NO_FLOOR = true
  #--------------------------------------------------------------------------
  # ◇ ウィンドウの背景
  #--------------------------------------------------------------------------
  #   nil    .. ウィンドウの背景を描画しない
  #   String .. 指定されたファイル名の画像を描画する
  #   Color  .. 指定された Color オブジェクトで塗りつぶす
  #--------------------------------------------------------------------------
    IMG_WINDOW_BACK = nil
  #--------------------------------------------------------------------------
  # ◇ 背景マップのトーン
  #--------------------------------------------------------------------------
    BACK_MAP_TONE = Tone.new(-48, -48, -48, 128)
  #--------------------------------------------------------------------------
  # ◇ 画像設定
  #--------------------------------------------------------------------------
    IMG_BACK = {} # この行は消さないでください。
    
    # 固定画像 (ファイル名のみ変更可)
    IMG_BACK[0] = ""
    
    # ユーザー登録画像 (追加削除可)
    IMG_BACK[18] = "Mountains"
    
    IMG_BACK["海"] = "Ocean"
    IMG_BACK["山"] = "Mountains"
end
end # module CAO


#/////////////////////////////////////////////////////////////////////////////#
#                                                                             #
#                下記のスクリプトを変更する必要はありません。                 #
#                                                                             #
#/////////////////////////////////////////////////////////////////////////////#


module CAO::BattleBack
  #--------------------------------------------------------------------------
  # ● 正規表現
  #--------------------------------------------------------------------------
  REGEXP_BACKTYPE = /<BB:(.+?)>/
  #--------------------------------------------------------------------------
  # ● 画像設定のキーチェック
  #--------------------------------------------------------------------------
  def self.key_check(key)
    if CAO::BattleBack::IMG_BACK[key].nil?
      print "key : '#{key}' の画像が設定されていません"
    end
  end
end

module Cache
  #--------------------------------------------------------------------------
  # ● アニメーション グラフィックの取得
  #     filename : ファイル名
  #--------------------------------------------------------------------------
  def self.battleback(filename)
    return filename ? load_bitmap("Graphics/Battlebacks/", filename) : nil
  end
end

class Game_Temp
  #--------------------------------------------------------------------------
  # ● 公開インスタンス変数
  #--------------------------------------------------------------------------
  attr_accessor :battleback               # 戦闘背景のファイル名
  #--------------------------------------------------------------------------
  # ● オブジェクト初期化
  #--------------------------------------------------------------------------
  alias _cao_battleback_initialize initialize
  def initialize
    @battleback = nil
    _cao_battleback_initialize
  end
end

class Game_Interpreter
  #--------------------------------------------------------------------------
  # ● 戦闘背景の変更
  #--------------------------------------------------------------------------
  def change_battleback(filename)
    $game_temp.battleback = filename
    return unless $game_temp.in_battle
    $scene.instance_variable_get(:@spriteset).refresh_battleback
  end
end

class Spriteset_Battle
  #--------------------------------------------------------------------------
  # ● 定数
  #--------------------------------------------------------------------------
  BATTLEBACK_W = 720                    # 戦闘背景の横幅
  BATTLEBACK_H = Graphics.height        # 戦闘背景の縦幅
  #--------------------------------------------------------------------------
  # ○ バトルフロアスプライトの作成
  #--------------------------------------------------------------------------
  alias _cao_battleback_create_battlefloor create_battlefloor
  def create_battlefloor
    _cao_battleback_create_battlefloor
    # モンスター下の影画像の可視状態
    @battlefloor_sprite.opacity = 0 if CAO::BattleBack::NO_FLOOR
  end
  #--------------------------------------------------------------------------
  # ○ バトルバックスプライトの作成
  #--------------------------------------------------------------------------
  def create_battleback
    @battleback_sprite = Sprite.new(@viewport1)
    @battleback_sprite.ox = BATTLEBACK_W / 2
    @battleback_sprite.x = Graphics.width / 2
    refresh_battleback
  end
  #--------------------------------------------------------------------------
  # ● 戦闘背景のリフレッシュ
  #--------------------------------------------------------------------------
  def refresh_battleback
    @battleback_sprite.bitmap ||= Bitmap.new(BATTLEBACK_W, BATTLEBACK_H)
    @battleback_sprite.bitmap.clear
    @battleback_sprite.tone.set(0, 0, 0, 0)
    # 戦闘背景を描画
    battleback = @battleback_sprite.bitmap    # 実際に表示される背景画像
    source = self.battleback                  # 元となる背景画像
    if CAO::BattleBack::RADIAL_BLUR
      battleback.stretch_blt(battleback.rect, source, source.rect)
      battleback.radial_blur(90, 12)
    else
      battleback.blt((BATTLEBACK_W - source.width) / 2, 0, source, source.rect)
    end
    # ウィンドウ背景を描画
    draw_windowback
  end
  #--------------------------------------------------------------------------
  # ● 背景画像のタイプを取得
  #--------------------------------------------------------------------------
  def battleback_type
    # 一時背景が空文字列の場合は、マップ画像
    return 0 if $game_temp.battleback == ""
    # 戦闘テストの場合は[初期背景]もしくは[黒] (トループ名で判定以外)
    return nil if $BTEST && CAO::BattleBack::MODE != 3
    # 一時背景が設定されていない場合は、設定通り
    return CAO::BattleBack::MODE if $game_temp.battleback == nil
    # 一時背景を適用
    return 9
  end
  #--------------------------------------------------------------------------
  # ● 戦闘背景画像の取得
  #--------------------------------------------------------------------------
  def battleback
    result = nil                            # [戻り値] Bitmap オブジェクト
    background = CAO::BattleBack::IMG_BACK  # 画像設定
    # 戦闘背景の表示モード分岐
    case battleback_type
    when 0  # マップ画像
      bitmap = $game_temp.background_bitmap
      @battleback_sprite.tone = CAO::BattleBack::BACK_MAP_TONE
    when 1  # 固定・マップ判定
      if background.has_key?($game_map.map_id)
        result = Cache.battleback(background[$game_map.map_id])
      end
    when 2  # 遠景判定
      if $game_map.parallax_name != ""
        result = Cache.parallax($game_map.parallax_name)
      end
    when 3  # 敵グループ名判定
      if CAO::BattleBack::REGEXP_BACKTYPE =~ $game_troop.troop.name
        CAO::BattleBack.key_check($1)
        result = Cache.battleback(background[$1])
      end
    when 4  # マップ名判定
      for name in $game_map.area_name
        next unless CAO::BattleBack::REGEXP_BACKTYPE === name
        CAO::BattleBack.key_check($1)
        result = Cache.battleback(background[$1])
        break
      end
      if result || CAO::BattleBack::REGEXP_BACKTYPE === $game_map.map_name
        CAO::BattleBack.key_check($1)
        result = Cache.battleback(background[$1])
      end
    when 5  # 地形判定 (KGC)
      tag = $game_map.terrain_tag($game_player.x, $game_player.y)
      if background.has_key?(tag) && background[tag] != ""
        result = Cache.battleback(background[tag])
      end
    when 6  # 地形 ＋ 敵グループ名
      # グループ名
      if CAO::BattleBack::REGEXP_BACKTYPE =~ $game_troop.troop.name
        CAO::BattleBack.key_check($1)
        result = Cache.battleback(background[$1])
      end
      # 地形
      for i in [1, 0]
        break if result != nil
        tile_id = $game_map.data[$game_player.x, $game_player.y, i]
        next if tile_id == 0
        if tile_id < 2048
          result = Cache.battleback(background[tile_id - 1536 + 128])
        else
          result = Cache.battleback(background[(tile_id - 2048) / 48])
        end
      end
    when 9
      result = Cache.battleback($game_temp.battleback)
      $game_temp.battleback = nil   # 一度の表示で無効 (戦闘単位ではない)
    end
    # 戦闘背景が確定していない場合
    unless result
      # 固定画像のファイル名が設定されていない場合
      if background[0] == nil || background[0] == ""
        # マップ画像を背景
        result = $game_temp.background_bitmap
        @battleback_sprite.tone = CAO::BattleBack::BACK_MAP_TONE
      else
        result = Cache.battleback(background[0])
      end
    end
    return result
  end
  #--------------------------------------------------------------------------
  # ● ウィンドウ背景の描画
  #--------------------------------------------------------------------------
  def draw_windowback
    back_type = CAO::BattleBack::IMG_WINDOW_BACK
    case back_type
    when String
      img_wb = Cache.system(back_type)
      x = (BATTLEBACK_W - img_wb.width) / 2
      y = BATTLEBACK_H - img_wb.height
      @battleback_sprite.bitmap.blt(x, y, img_wb, img_wb.rect)
    when Color
      x = 0
      y = BATTLEBACK_H - 128
      @battleback_sprite.bitmap.fill_rect(x, y, BATTLEBACK_W, 128, back_type)
    end
  end
end

■ 必須事項

■ 戦闘背景

フォルダ名：Graphics/Battlebacks
ファイル名：任意 (設定項目で変更可能)
サ　イ　ズ：544 x 288以上（推奨 640x288, 640x416）
※ 画像を使用しない場合は必要ありません。
※ Battlebacks フォルダは、新規作成してください。
※ 背景画像は、ツクールの素材管理機能では追加できません。

横サイズは、568px以上なければ画面が揺れた際に画像が途切れてしまいます。
また、非推奨サイズであれば、画面中央に自動調整され表示されます。
縦サイズは、288px以上なければ、メッセージウィンドウより上の位置で画像が途切れます。
288～416pxの範囲であれば、ウィンドウ背景を設定して隠すことができます。
また、416px以降は一切表示されません。

■ ウィンドウ背景

フォルダ名：Graphics/System
ファイル名：任意 (設定項目で変更可能)
サ　イ　ズ：制限なし
※ 画像を使用しない場合は必要ありません。

デフォルトの状態だと、ウィンドウの縦幅は 128px です。
ですので、544x128 の画像を用意するといいと思います。
ウィンドウ背景は、ウィンドウの位置とは関係なく中央下に自動で位置調整されます。
これは、中途半端な戦闘背景を使用したときにそれを隠すための設定だからです。
ウィンドウを非表示にして、画像を背景とするようなことは想定していません。

■ 設定項目

■ 背景の表示方法

MODE = 0

0:マップ画像: 戦闘に入る前のマップをそのまま背景に使用します。
背景の明るさの調整は、Spriteset_Battle のクラス定数 CAO_BACK_TONE で行えます。
1:固定・マップで判定: マップＩＤごとに決められた背景を表示します。
2:遠景で判定: マップの設定で設定された遠景を背景として使用します。
3:敵グループ名で判定: 敵グループ名に<BB:○○>と記述することで背景を指定できます。
※ 画像設定で IMG_BACK["○○"] = "" のように同じキーワードで設定します。
4:マップ名で判定: この機能を使用するには、Cacao Base Script が別途必要となります。
マップ・エリア名に<BB:○○>と記述することで背景を指定できます。
※ 画像設定で IMG_BACK["○○"] = "" のように同じキーワードで設定します。
5:地形で判定: この機能を使用するには、 KGC Software （タイルセット拡張）が別途必要となります。
※ KGCさんのスクリプトに関しての質問はお答えできません。
6:地形＋敵グループ名: 敵グループ名に<BB:○○>と記述することで背景を指定できます。
※ 画像設定で IMG_BACK["○○"] = "" のように同じキーワードで設定します。
もし、この設定がなければ地形の設定が使用されます。
地形は、TileA のもののみ設定できます。
※ MODE 5 と違い、KGCさんのスクリプトは必要ありません。

■ 放射状のぼかし効果

RADIAL_BLUR = false

true にすると右のような背景になります。(デフォルトと違い動きません)

※ アニメーションは行いません。

■ 影を非表示

NO_FLOOR = true

■ ウィンドウの背景

IMG_WINDOW_BACK = Color.new(0, 0, 0)

ウィンドウの背景を設定します。
設定値がnilの場合は、背景を描画しません。
ファイル名を設定した場合は、その画像を描画します。
Color オブジェクトを設定した場合は、その色で塗り潰します。

ＸＰの戦闘背景などのサイズの合わないものをを使用する場合は、
背景が中途半端な位置で切れてしまいますので nil 設定にはしない方が良いと思います。

■ 背景マップのトーン

BACK_MAP_TONE = Tone.new(-48, -48, -48, 128)

戦闘背景がマップ画像の場合に色調を変更します。

■ 画像設定

※ 表示モードが 0 のマップ画像、2 の遠景で判定では、使用しません。

IMG_BACK = {} # この行は消さないでください。

# 固定画像 (ファイル名のみ変更可)
IMG_BACK[0] = "Grassland"

# ユーザー登録画像 (追加削除可)
IMG_BACK["海"] = "Ocean"
IMG_BACK["山"] = "Mountains"

画像設定では、IMG_BACK[キーワード] = "ファイル名"という行を追加して設定します。

固定画像とは、基本となる画像です。
IMG_BACK[0] = "ファイル名"
背景設定がない場合などにこの画像が表示されます。
また、ファイル名を設定しなかった場合（IMG_BACK[0] = ""）、マップ画像を表示します。

ユーザー登録画像は、表示モードごとに設定方法が異なります。
この設定は、自由に追加・削除可能です。
設定行にカーソルを移動して Ctrl+D を押すとその行が複製されますので、
後は、必要な部分を書き換えると簡単に設定できますよ。

1:固定・マップで判定
　IMG_BACK[マップＩＤ] = "ファイル名"
3:敵グループ名で判定
　IMG_BACK["適当な文字列"] = "ファイル名"
　例）IMG_BACK["海"] = "Filename" の場合、<BB:海>
4:マップ名で判定
　IMG_BACK["適当な文字列"] = "ファイル名"
　例）IMG_BACK["山"] = "Filename" の場合、<BB:山>
5:地形で判定
　IMG_BACK[地形タグ] = "ファイル名"
6:地形＋敵グループ名で判定
　IMG_BACK["適当な文字列"] = "ファイル名"
　MODE 3 と同じ設定方法です。
　IMG_BACK[地形Index] = "ファイル名"
　タイルＩＤではなく並んでいる順番を使用します。
　左上のタイルを 0 として、右へ数えてください。
　拙作の Index Checker を使用すると数える必要がなくなりますよ。
　

■ 背景の設定文字

※ こちらは、設定項目内にはありませんので検索してください。

REGEXP_BACKTYPE = /<BB:(.+?)>/

背景の設定文字は、デフォルトでは <BB:○○> としますが、
上記の定数の設定を変更することで、変更できます。

正規表現が分からない場合は、無闇に変更しないでください。
競合の心配がないのなら BB などの表記は冗長なだけですので、
/\[(.+?)\]/のように変更することで [草原] スライム*2 などの表記に変更できます。

■ 使用方法

■ 戦闘背景の変更

change_battleback("ファイル名")

イベントコマンド「スクリプト」内で使用します。
マップイベントで使用した場合、次の戦闘の一度だけ指定された背景で開始します。
バトルイベントで使用した場合は、現在の背景を変更します。