The Charlie Mini-Map / Dynamic Maps Patch

[DerVVulfman]

The Charlie Mini-Map / Dynamic Maps Patch
Version: 1.2

Introduction
This is a crucial patch required for anyone using the redesigned version of the "Passable Mini-Map" by Charlie Fleed, and the upgraded version of Near Fantastica's "Dynamic Maps" script, both of which were released by DerVVulfman. Without this patch and the instructions that are contained within, the proper display of the mini-maps will falter.




Script

The Script

Code:

#==============================================================================
# ** The Charlie Mini-Map / Dynamic Maps Patch
#------------------------------------------------------------------------------
#    by DerVVulfman
#    version 1.2
#    03-29-2022 (mm/dd/yyyy)
#    RGSS / RPGMaker XP
#    Requires:  Charlie's Mini-Map Extended
#               Dynamic Maps Expanded
#==============================================================================
#
#  INTRODUCTION:
#  =============
#                                
#  This is a crucial patch required  for anyone using  the redesigned version
#  of the  "Passable Mini-Map" by Charlie Fleed,  and the upgraded version of
#  Near Fantastica's "Dynamic Maps" script,  both of which  were released  by
#  DerVVulfman.   Without this patch  and the instructions that are contained
#  within, the proper display of the mini-maps will falter.
#
#==============================================================================
#
#  INSTALLATION:
#
#  Insofar as script placement, the "Charlie's Mini-Map Extended" system must
#  be placed above the "Dynamic Maps Expanded" script within the Script Data-
#  base.  And this patch is placed below both.   In essence, the list of your
#  scripts should look like so:
#
#  * Charlie's Mini-Map Extended - Instructions and Configuration
#  * Charlie's Mini-Map Extended - Main Engine
#  * Dynamic Maps Expanded
#  * The Charlie Mini-Map / Dynamic Maps Patch
#
#  However,  this alone does not fix the issue.   Work must be performed upon
#  both the Mini-Map and Dynamic Map scripts themselves, The conflict between
#  the two scripts appears within the  'setup'  method of the Game_Map class.
#  For this patch to work, you will need to edit/remove the setup method from
#  both of these; this by either cutting the method out or commenting it out.
#  But not only that, but the alias command to which each is attached.
#
#  Within "Charlie's Mini-Map Extended",  go to line 320  within the system's
#  engine code. Here you will see both the alias command and the setup method
#  which need to be removed.  The alias statement that likewise needs removal
#  is "alias game_map_passmap_cf_setup setup"
#
#  And within the "Dynamic Maps Expanded" script, head towards line 130 which
#  brings you to both the alias and setup code which needs to be removed. And
#  the alias statement of "alias dm_orig_setup setup" does have to go.
#
#  Once these alterations are made and this patch appears below both systems,
#  then you should no longer have any issues with the two.
#
#
#==============================================================================
#
#  COMPATABILITY:
#
#  This patch's primary focus  is to work  with "Charlie's Mini-Map Extended"
#  and "Dynamic Maps Expanded",  both being rewrites of the originals by Near
#  Fantastica and Charlie Fleed.
#
#  Use of this patch is possible  with earlier versions of the two,  but does
#  require alteration  of the patch's code itself  as the newer versions adds
#  additional values which enhances features or fixes system errors. However,
#  the request to remove the setup methods  within the earlier versions would
#  still apply.
#
#==============================================================================
#
#  Terms of Use:
#
#  Free for use, even in commercial projects. Due credit is required,  not
#  only for me but for the authors and supporters of the two systems which
#  this patch is designed.
#
#==============================================================================



#==============================================================================
# ** Game_Map
#------------------------------------------------------------------------------
#  This class handles the map. It includes scrolling and passable determining
#  functions. Refer to "$game_map" for the instance of this class.
#==============================================================================

class Game_Map
  #--------------------------------------------------------------------------
  # * Alias Listingd
  #--------------------------------------------------------------------------
  alias charlie_dynamic_patch_setup setup
  #--------------------------------------------------------------------------
  # * Setup
  #     map_id : map ID
  #--------------------------------------------------------------------------
  def setup(map_id)
    # Save current map
    save_dynamic_map(@map_id)
    # Handle Minimap on/off settings
    setup_minimap_off(map_id)
    # Perform original call if test for Dynamic Map fails
    if $game_system.game_map_d.get_map(map_id).nil?
      charlie_dynamic_patch_setup(map_id)
    end
    # Create zoom, allowing zoom per map
    @minimap_zoom = PassMap::ZOOM
    test          = setup_zoom_test(map_id)
    @minimap_zoom = test unless test.nil?    
    # New variables
    $game_temp.refresh_passmap  = true    
    # Exit without reloading dynamic map if test for Dynamic Map fails
    return if $game_system.game_map_d.get_map(map_id).nil?
    # Load Dynamic Map
    load_dynamic_map(map_id)
  end
end

Instructions
Plenty, and within the patch itself. Heck, it is nearly 70% instructions.






Compatibility
This patch's primary focus is to work with "Charlie's Mini-Map Extended" and "Dynamic Maps Expanded", both being rewrites of the originals by Near Fantastica and Charlie Fleed.

Use of this patch is possible with earlier versions of the two, but does require alteration of the patch's code itself as the newer versions adds additional values which enhances features or fixes system errors. However, the request to remove the setup methods within the earlier versions would still apply.

[DerVVulfman]

BUMP
to Version 1.1

There is not really anything new about this patch other than it being updated to work with the latest version of Dynamic Maps - Expanded.   Two methods of the so-mentioned Dynamic Maps script were renamed, so the update of this patch was necessary.

[DerVVulfman]

BUMP
to Version 1.2

A very simple update to the patch which only involved the reorganization and relocation of three statements that govern the map zoom value.  These three were initially executed when the player enters a new map in order to determine the proper zoom scale for the minimap.

However, the location for these statements and when the determination of the zoom scale needed to be reconsidered given this was a patch for a dynamic map.  As a dynamic map saves map states, entering a previously entered and explored map would restore previous values.  Unfortunately, this would at times overwrite proper values or invalidate the statements needed to retrieve the minimap scale.

As such, this update corrects the oversight and now resets the minimap zoom effect later in the patch and after any dynamic map data would be reloaded.