Button_Common_Events.rb

#==============================================================================
#
# ▼ Yanfly Engine Ace - Button Common Events v1.00
# -- Last Updated: 2012.01.09
# -- Level: Normal
# -- Requires: n/a
#
#==============================================================================

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

#==============================================================================
# ▼ Updates
# =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
# 2012.01.09 - Started Script and Finished.
# 2019 - Anonymous edit that added all the applicable key bindings
#==============================================================================
# ▼ Introduction
# =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
# RPG Maker VX Ace supports 8 different action buttons to use. However, only
# 3 of those are used (A, B, and C) on the field map. The rest of them aren't
# used at all. This script allows usage of the L, R, X, Y, and Z buttons by
# binding them to common events.
#
#==============================================================================
# ▼ 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.
#
# Modify the COMMON_EVENT hash in the script module to adjust which common
# events are used for each button.
#
#==============================================================================
# ▼ 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 BUTTON_EVENT

    #=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
    # - Button Settings -
    #=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
    # This sets the common events that are to run when the particular button
    # is pressed. The following chart shows the respective keyboard buttons.
    #
    #   :Button    Default Keyboard Button
    #      :L        Q
    #      :R        W
    #      :X        A
    #      :Y        S
    #      :Z        D
    #
    # If you do not wish to associate a button with a common event, set the
    # common event for that button to 0.
    #=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
    COMMON_EVENT ={
    # :Button => Common Event,
           :L =>   1,    # Runs common event 1
           :R =>   0,
           :X =>   0,
           :Y =>   0,
           :Z =>   0,

           :SHIFT =>   0,  #Since this is the run button, I don't recommend this one

           :CTRL =>   0,
           :ALT =>   0,

           :F5 =>   0,
           :F6 =>   0,
           :F7 =>   0,
           :F8 =>   0,
           :F9 =>   0,

           #These are not recommended to be used, for obvious reasons
           :UP =>   0,
           :DOWN =>   0,
           :LEFT =>   0,
           :RIGHT =>   0,

    } # Do not remove this.

  end # BUTTON_EVENT
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.
#==============================================================================

#==============================================================================
# ■ Scene_Map
#==============================================================================

class Scene_Map < Scene_Base

  #--------------------------------------------------------------------------
  # alias method: update_scene
  #--------------------------------------------------------------------------
  alias scene_map_update_scene_bce update_scene
  def update_scene
    scene_map_update_scene_bce
    update_button_common_events unless scene_changing?
  end

  #--------------------------------------------------------------------------
  # new method: update_button_common_events
  #--------------------------------------------------------------------------
  def update_button_common_events
    for key in YEA::BUTTON_EVENT::COMMON_EVENT
      next unless Input.trigger?(key[0])
      next if key[1] <= 0
      $game_temp.reserve_common_event(key[1])
    end
  end

end # Scene_Map

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