サブコマンドウィンドウ

■ 概　　要

・ウィンドウをベースとしたサブコマンドを追加します。

■ スクリーンショット

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

■ 更新履歴

21/10/29 ... v1.1.3
　ウィンドウの設定 :opacity の挙動が説明と違う問題を修正（説明に合わせた）
　ウィンドウの設定 :back を追加（旧 :opacity）

17/07/15 ... v1.1.2
　ウィンドウの設定 :opacity が機能しない不具合を修正

13/11/17 ... v1.1.1
　サブコマンドが表示されない不具合を修正

13/10/27 ... v1.1.0
　並び替えを行なうとエラーの出る不具合を修正

13/06/12 ... v1.0.3
　コマンド処理の変更に伴い更新

13/03/03 ... v1.0.2
　アクター選択後にシーン遷移を行なうとコマンドウィンドウが表示される不具合を修正

12/07/13 ... v1.0.1
　サブコマンドの識別子が無視される不具合を修正
　ウィンドウの開閉動作を追加

12/07/10 ... v1.0.0
　公開

■ スクリプト

#******************************************************************************
#
#    ＊ サブコマンドウィンドウ
#
#  --------------------------------------------------------------------------
#    バージョン ： 1.1.3
#    対      応 ： RPGツクールVX Ace : RGSS3
#    制  作  者 ： ＣＡＣＡＯ
#    配  布  元 ： https://cacaosoft.mars.jp/
#  --------------------------------------------------------------------------
#   == 概    要 ==
#
#    ： ウィンドウをベースとしたサブコマンドを追加します。
#
#  --------------------------------------------------------------------------
#   == 注意事項 ==
#
#    ※ 動作には Custom Menu Base と コマンドウィンドウ が必要です。
#    ※ 項目の設定は、Custom Menu Base で行ってください。
#
#
#******************************************************************************


#==============================================================================
# ◆ 設定項目
#==============================================================================
module CAO::CM::SubCommand
  #--------------------------------------------------------------------------
  # ◇ ウィンドウの設定
  #--------------------------------------------------------------------------
  CONFIGURATION = {}
  CONFIGURATION[:sub] = {
    dx: 160, dy: 0, column: 1, width: 160
  }
  #--------------------------------------------------------------------------
  # ◇ 自動位置修正
  #--------------------------------------------------------------------------
  AUTO_ALIGNMENT = true
end


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


class Window_MenuSubCommand < Window_CustomMenuCommand
  include CAO::CM::SubCommand
  #--------------------------------------------------------------------------
  # ● オブジェクト初期化
  #--------------------------------------------------------------------------
  def initialize
    super(nil)
    self.openness = 0
    deactivate
  end
  #--------------------------------------------------------------------------
  # ● ウィンドウ幅の取得
  #--------------------------------------------------------------------------
  def window_width
    return params(:width, super)
  end
  #--------------------------------------------------------------------------
  # ● ウィンドウ高さの取得
  #--------------------------------------------------------------------------
  def window_height
    return params(:height, fitting_height(row_max))
  end
  #--------------------------------------------------------------------------
  # ●
  #--------------------------------------------------------------------------
  def window_opacity
    return params(:opacity, params(:back, true) ? 255 : 0)
  end
  #--------------------------------------------------------------------------
  # ● 桁数の取得
  #--------------------------------------------------------------------------
  def col_max
    return params(:column, super).tap {|col| break item_max if col < 0 }
  end
  #--------------------------------------------------------------------------
  # ● 横に項目が並ぶときの空白の幅を取得
  #--------------------------------------------------------------------------
  def spacing
    return params(:space, super)
  end
  #--------------------------------------------------------------------------
  # ● アライメントの取得
  #--------------------------------------------------------------------------
  def alignment
    return params(:align, super)
  end
  #--------------------------------------------------------------------------
  # ● 決定ボタンが押されたときの処理
  #--------------------------------------------------------------------------
  def process_ok
    symbol = @@last_command_symbol
    super
    @@last_command_symbol = symbol
  end
  #--------------------------------------------------------------------------
  # ●
  #--------------------------------------------------------------------------
  def params(key, default)
    param = CONFIGURATION[@ident] && CONFIGURATION[@ident][key]
    return param == nil ? default : param
  end
  #--------------------------------------------------------------------------
  # ●
  #--------------------------------------------------------------------------
  def init_command(ident)
    @ident = ident
    clear_command_list
    make_command_list
    self.width = window_width
    self.height = window_height
    create_contents
    refresh
    self.x = params(:x, 0)
    self.y = params(:y, 0)
    self.opacity = window_opacity
    select(0)
  end
end

class Scene_Menu
  #--------------------------------------------------------------------------
  # ○ オプションウィンドウの作成
  #--------------------------------------------------------------------------
  alias _cao_cm_sub_create_option_window create_option_window
  def create_option_window
    _cao_cm_sub_create_option_window
    @subcommand_window = Window_MenuSubCommand.new
  end
  #--------------------------------------------------------------------------
  # ○ サブコマンドウィンドウを開く
  #--------------------------------------------------------------------------
  alias _cao_cm_sub_open_sub_command open_sub_command
  def open_sub_command
    symbol = @command_window.current_data.sub
    subconf = CAO::CM::SubCommand::CONFIGURATION[symbol]
    if subconf
      cr = @command_window.item_rect(@command_window.index)
      if subconf[:dx]
        @subcommand_window.x += @command_window.x
        @subcommand_window.x += cr.x + subconf[:dx]
      end
      if subconf[:dy]
        @subcommand_window.y += @command_window.y
        @subcommand_window.y += cr.y + subconf[:dy]
      end
    end
    # 画面内に収まるように位置を調整
    if CAO::CM::SubCommand::AUTO_ALIGNMENT
      if Graphics.width < @subcommand_window.x + @subcommand_window.width
        @subcommand_window.x = Graphics.width - @subcommand_window.width
      end
      @subcommand_window.x = 0 if @subcommand_window.x < 0
      if Graphics.height < @subcommand_window.y + @subcommand_window.height
        @subcommand_window.y = Graphics.height - @subcommand_window.height
      end
      @subcommand_window.y = 0 if @subcommand_window.y < 0
    end
    _cao_cm_sub_open_sub_command
  end
  #--------------------------------------------------------------------------
  # ○ コマンド実行後の処理
  #--------------------------------------------------------------------------
  alias _cao_cm_sub_post_terminate post_terminate
  def post_terminate
    _cao_cm_sub_post_terminate
    if current_console.current_data.refresh_items.include?(:command)
      @subcommand_window.refresh
    end
  end
end

■ 使用準備

■ 背景画像

■

■ 設定項目

■ サブコマンドの設定

サブコマンドの設定は、ベーススクリプトで行います。
サブコマンドで表示する項目も、メインと共通の設定となります。

コマンド設定

「メニュー項目の設定」でサブコマンドを呼び出すコマンドの設定をします。

項目処理

:sub => メニュー識別子

※ 同時に他の項目処理(:scene,:command,:personal)を行わないでください。
例）COMMAND_ITEMS[:file] = { :sub => :sub_file }

オプション

:sw_sub => false,

trueに設定すると、サブ表示時にメインを非表示にします。例）COMMAND_ITEMS[:file] = { :sw_sub => true }

メニュー設定

「表示項目の設定」でサブコマンドの設定します。
メインのコマンド設定と同じように作成してください。
例）COMMANDS[:sub_file] = [:save, :load]

■ ウィンドウの設定

サブコマンドウィンドウの設定を行います。
CONFIGURATION[メニュー識別子] = { 設定項目 }のように設定します。
メニュー識別子は、「表示項目の設定」と同じものです。
設定項目は、以下のようになります。

:x, :y   .. 表示する座標
:dx, :dy .. 表示する座標 (選択項目からの距離)
:width   .. ウィンドウの横幅 (省略可)
:height  .. ウィンドウの縦幅 (省略時、項目数にあわせる)
:column  .. 横に並べる項目数 (省略時、１)
:space   .. 横に項目が並ぶときの空白の幅 (省略可)
:opacity .. ウィンドウの不透明度 (0-255)
:back    .. ウィンドウの有無 (true: 表示, false: 非表示) ※ opacity が優先
:align   .. 項目の表示位置 (0:左寄せ　1:中央寄せ　2:右寄せ)

■ 使用方法

■ サンプル

# == ベーススクリプト ==
# メニュー項目の設定
COMMAND_ITEMS[:save] = {
  :name     => "セーブ",
  :command  => Scene_Save,
  :enable   => "!$game_system.save_disabled",
}
COMMAND_ITEMS[:load] = {
  :name     => "ロード",
  :command  => Scene_Load,
  :enable   => "DataManager.save_file_exists?",
}
COMMAND_ITEMS[:file] = {
  :name => "ファイル",
  :sub  => :sub_file,
}

# 表示項目の設定
COMMANDS[:main]     = [:item, :skill, :equip, :status, :file, :game_end]
COMMANDS[:sub_file] = [:save, :load]


# == サブコマンド ==
# ウィンドウの設定
CONFIGURATION[:sub_file] = { dx: 160, dy: 0, width: 160 }

■ 概 要