Map Menu System, View map & transfer player Options

[Artofmin]

MAP MENU

Beta 1.2

1 December 2009

Intro
This script let player open a map from item menu (by default) and browse the list of location from the map menu and transfer player to the desire location.

Features

• View Map and Transfer/Teleport player.
• Show selectable location.
• Show Current Location map id/name.
• Add and Remove location.
• Auto detect/get map id in database (display it in the Location List).
• Screen flashes/fade when transferring/teleporting.

New Features Beta 1.2 By Fox536

• Easier and efficient way to add map/location for teleporting (in script).
• Unknown location will not be display (can be change). This will make your game more realistic and unpredictable.
• The scroll down list/selectable (location list) is hidden (it will only scroll down/select to the available/known location list). Can be change.
• ADD and REMOVE location list with easy call script.

Screenshots (Old screenshots. Download the new Beta 1.2 for more info)




The highlighted areas (cyan) indicate the same name of the map database and Location List (in the Map Menu).

1. Location List (I’ve set the maximum index to 20). List of the map are display here.
2. The map image display area. You can change the size (using graphic editing program) so it fill up to the bottom.
3. A window that show current map name.
4. This is merely an image editing (done with photoshop).
5. The RED OUTLINE display the selected location (done with photoshop).

The Demo Beta 1.2update (click here)

The Script

Map Menu Beta 1.2

CODE

###############################################################################
# Map Menu (View map & transfer player) Beta 1.2                              #
###############################################################################
# Edited by Artofmin                                                          #
# Beta Released Date: 11 October 2009 (Beta 1.0)                              #
# Date Update: 1 December 2009                                                #
#=============================================================================#
# Beta 1.2                                                                    #
# Originally updated/edited by: Fox536                                        #
# Date: 30 November 2009                                                      #
#=============================================================================#
# Intro:                                                                      #
# To use item 029: Map as a map (view map etc).                               #
# This script is base from Moghunter’s MOG_Character Select Screen V1.1.      #
# http://atelier-rgss.com/Index.html). I’ve edit it so it can be use for      #
# viewing Map, Location List, Current Location and Transfer player.           #
#=============================================================================#
# Credits:                                                                    #
#                                                                             #
# Moghunter                     = I use the MOG_Character Select Screen V1.1  #
#                                 as reference.                               #
#                                                                             #
# Fox536   (Creation Asylum)    = Making this script more user friendly and   #
#                                 solved things/feature that I would never    #
#                                 figured out.                                #
#                                                                             #
# Sid Meier’s Civilization III  = currently use its map graphic as sample.    #
#=============================================================================#
# Thanks:                                                                     #
#                                                                             #
# Khattar  (Creation Asylum)    = I’ve read his post about player transfer &  #
#                                 some tutorial.                              #
# GubiD    (Creation Asylum)    = I’ve read his post about transfer script.   #
#=============================================================================#
# Note:                                                                       #
# Don’t have to credit me. I edited/implemented this script as practice.      #
# BTW, I’m NOT a scripter, if you have any problem with this script…well,     #
# I’ll try to help. If you’re a scripter, feel free to edit this script.      #
# This script is free (commercial or non commercial).                         #
#                                                                             #
# If you’re using this script, please CREDITS to:                             #
# Fox536   (Creation Asylum)                                                  #
#                                                                             #
# Fox536: I did minor edits to the script but it still runs completely        #
# the same in game... just made edits to make it easier for game creation.    #
#                                                                             #
###############################################################################

# MAP_PLACES[Map ID] = [true, Map ID, Player X, Player Y, Player Direction}
MAP_PLACES = {}
MAP_PLACES[1] = [true, 1,  9, 13, 8]
MAP_PLACES[2] = [true, 2,  9,  1, 2]
MAP_PLACES[3] = [true, 3, 18,  5, 4]
MAP_PLACES[4] = [true, 4,  9, 12, 8]
MAP_PLACES[5] = [true, 5,  2,  8, 6]

# to add a map use
# $game_temp.add_map(x)
# to remove a map use
# $game_temp.remove_map(x)

###################
# Window Location # Create the Current Location window.
###################
class Window_Location < Window_Base
  ###################
  #   initialize    #
  ###################
  def initialize
    super(0, 0, 160, 76)
    self.contents = Bitmap.new(width - 32, height - 32)
    self.contents.font.name = "Arial"
    self.contents.font.size = 15
    refresh
  end
  ###################
  #     refresh     #
  ###################
  def refresh
    self.contents.clear
    data = load_data("Data/MapInfos.rxdata")
    self.contents.font.color = system_color
    self.contents.draw_text(0, -8, 120, 32, "Current Location", 3)
    self.contents.font.color = normal_color
    self.contents.draw_text(0, 18, 140, 32,data[$game_map.map_id].name, 3)
  end
end

###############
# Window List # Create the Location List window.
###############
class Window_List < Window_Base
  ###################
  #   initialize    #
  ###################
  def initialize
    super(0, 0, 160, 404)
    self.contents = Bitmap.new(width - 32, height - 32)
    self.contents.font.name = "Arial"
    self.contents.font.size = 15
    refresh
  end
  ###################
  #     Refresh     #
  ###################
  def refresh
    self.contents.clear
    self.contents.font.color = system_color
    self.contents.draw_text(0, -10, 150, 32, "Location List", 3)
  end
end

###############
# Win Maplist # Create the Location List index.
###############
class Win_Maplist < Window_Selectable
  ###################
  #   initialize    #
  ###################
  def initialize
    super(0, 32, 160, 372)
    @column_max = 1
    self.opacity = 0
    refresh    
    self.index = 1
    self.visible = false
  end
  ###################
  #      item       #
  ###################
  def item
    return @data[self.index]
  end
  ###################
  #     refresh     #
  ###################
  def refresh
    if self.contents != nil
      self.contents.dispose
      self.contents = nil
    end
    @item_max = $game_temp.map_size
    if @item_max > 0
      self.contents = Bitmap.new(width - 32, row_max * 32)
      self.contents.font.name = "Arial"
      self.contents.font.size = 15
      self.contents.clear
      data = load_data("Data/MapInfos.rxdata")
      self.contents.font.color = normal_color
      # Display Location Name
      for i in 0...$game_temp.map_size
        if $game_temp.map_check($game_temp.tele_maps[i]) == true
          self.contents.draw_text(4, 32*i, 150, 32, data[$game_temp.tele_maps[i]].name, 3)
        else
          self.contents.draw_text(4, 32*i, 150, 32, "???", 3)  
        end
      end
      
    end
  end
end

################# This is the main script.
# Scene_Maplist # Call using “$scene = Scene_Maplist.new”
################# (without “”).
class Scene_Maplist
  ###################
  #      main       #
  ###################
  def main
    # Display Current Location Window
    @window_location = Window_Location.new
    @window_location.y = 404
    @window_location.x = 0
    # Display Location List Window
    @window_list = Window_List.new
    @window_list.y = 0
    @window_list.x = 0
    # Display Map Menu System
    @command_window = Win_Maplist.new
    @command_window.back_opacity = 0
    @command_window.visible = true
    @command_window.index = 0
    @maplist_back = Sprite.new
    @maplist_back.bitmap = RPG::Cache.picture("mp_menu0")
    @maplist_back.opacity = 255
    @maplist_sel = Sprite.new
    Graphics.transition
    loop do
      Graphics.update
      Input.update
      update
      if $scene != self
        break
      end
    end
    Graphics.freeze
    @command_window.dispose
    @maplist_back.dispose
    @maplist_sel.dispose
    @window_location.dispose
    @window_list.dispose
    $game_map.autoplay
    $game_map.update
  end
  ###################
  #     update      #
  ###################
  def update
    @command_window.update    
    @maplist_sel.opacity += 10
    # Display Location Picture/Image  
    if $game_temp.map_check($game_temp.tele_maps[@command_window.index]) == true
      @maplist_sel.bitmap = RPG::Cache.picture(sprintf("Map%03d", $game_temp.tele_maps[@command_window.index])) rescue @a = 1
    end
    if Input.trigger?(Input::B)
      Audio.se_play("Audio/SE/003-System03", 80,100)
      $scene = Scene_Item.new
    end    
    if Input.trigger?(Input::C)
      Audio.se_play("Audio/SE/007-System07", 80,100)
      case @command_window.index
      # Transfer the Player  
      when 0..4
        if $game_temp.map_check($game_temp.tele_maps[@command_window.index]) == true
          $game_screen.start_flash(Color.new(0, 0, 0, 255), 30)    
          $game_temp.player_transferring  = MAP_PLACES[$game_temp.tele_maps[@command_window.index]][0]
          $game_temp.player_new_map_id    = MAP_PLACES[$game_temp.tele_maps[@command_window.index]][1]
          $game_temp.player_new_x         = MAP_PLACES[$game_temp.tele_maps[@command_window.index]][2]
          $game_temp.player_new_y         = MAP_PLACES[$game_temp.tele_maps[@command_window.index]][3]
          $game_temp.player_new_direction = MAP_PLACES[$game_temp.tele_maps[@command_window.index]][4]
          $scene = Scene_Map.new
        end
      end
    end
  end
end


#==============================================================================
# ** Game_Temp
#------------------------------------------------------------------------------
#  This class handles temporary data that is not included with save data.
#  Refer to "$game_temp" for the instance of this class.
#==============================================================================

# use this to add a map to the array
# $game_temp.add_map(x)
# use this to check if the map has been added
# $game_temp.map_check(x)
# use this to check the size of the array
# $game_temp.map_size

class Game_Temp
  #--------------------------------------------------------------------------
  # * Public Instance Variables
  #--------------------------------------------------------------------------
  attr_accessor :availible_maps_tele     # maps the player can teleport to
  
  #--------------------------------------------------------------------------
  # * Object Initialization
  #--------------------------------------------------------------------------
  alias map_tele_initialize initialize
  ###################
  #   initialize    # Adds the variable to the game_temp class
  ###################
  def initialize
    map_tele_initialize
    @availible_maps_tele = []
  end
  ###################
  #    add_map      # Adds the map to the teleport list and sorts
  ###################
  def add_map(x)
    unless map_check(x)
      @availible_maps_tele += [x]
      @availible_maps_tele.sort!
    end
  end
  ###################
  #   remove_map    # Removes the map from the teleport list and sorts
  ###################
  def remove_map(x)
    if map_check(x)
      @availible_maps_tele -= [x]
      @availible_maps_tele.sort!
    end
  end
  ###################
  #    map_check    # Checks the teleport list for the map id
  ###################
  def map_check(x=0)
    return @availible_maps_tele.include?(x)
  end
  ###################
  #    map_size     # Checks the amount of maps availiable to teleport to
  ###################
  def map_size
    return [@availible_maps_tele.size, 0].max
  end
  ###################
  #    tele_maps    # Returns the array of map_ids:@availible_maps_tele
  ###################
  def tele_maps
    return @availible_maps_tele
  end
end

Instructions
Place the script ABOVE Main.
Download and play the Demo for more info.

Compatibility
Unknown

Credits & Thanks:
Moghunter (http://atelier-rgss.com/Index.html).
Fox536...Making this script more user friendly and solved things/feature that I would never figured out.
Sid Meier’s Civilization III
Khattar & GubiD …it was due to their post (about player transferring script & tutorial) I’m able to edit/implement this script.

Author's Notes
No need to credit me…feel free to edit or upgrade it.
This script is free (commercial or non commercial).

If you’re using this script, please CREDITS to:
Fox536

PLEASE…do comments or critics. Thanks for reading this post.

This post has been edited by Artofmin: Feb 14 2010, 06:06 AM

[Artofmin]

BUMP

Demo and Script (Beta 1.1) & download link updated. Please check the first post. Add and fixed few things.

[Jedi Knight]

Very nice and effective!
Maybe, if you want to improve it, you could insert the possibility to use an image larger than the screen that can move itself to show the correct location.

This post has been edited by Jedi Knight: Oct 19 2009, 11:06 AM

[GubiD]

Pretty cool! I like it.

[Artofmin]

@Jedi Knight
Thanks! I think I know what you were saying…it just that I’m still new with scripting (still learning).
Maybe I’ll try to make that improvement/feature for next version, or for new map system.

@GubiD
Thanks! To receive complement from excellent scripter such as you is…truly awesome!

[Artofmin]

BUMP

Beta 1.2

Demo and Script & download link updated. Please check the first post.
Big thanks to Fox536 for editing and updating the script to be more efficient.

[Fox536]

Hey can anyone think of any more features that could added?

[SplasH3]

Dude, really awesome, great job!

[Artofmin]

Well, I’m thinking of some new/optional features:

1. User can choose to use an in-game map or picture as the map system background. The map can be any sizes and have animations and other appropriate events. When selecting a location, the camera/screen should move to the location on the map and that area/location should be highlight/mark in some way.
2. A confirmation pop-up when player selected the location to teleport/transfer (a simple YES or No choice is ok).
3. An optional REGIONAL location list (so the location is sort base on their region…like BOF 4 game).
4. User can have multiple map menu…er like Septerra Core game (I got the idea for this map system from this game).

Mmm…there’s more I think…

[Kirye]

Hey there, i'm new to the site and saw this script. Being exactly what I needed I tried it out, but I have a couple of questions. ><

- Why is it that only the first 5 locations work? I set up 12 locations but as it seems only the first 5 actually teleport you to your desired location. The rest of them show up on the list, and on the side map, but when pressed will only make a sound and stay in the same window. I looked around the script, but I couldn't find where it went wrong.

- When you have a few locations and then save and load the same file, you start out with nothing again. Is it possible to retain the locations?

Sorry for the many questions, i've been looking for this type of script for a while and haven't found a good one yet. >< This is the best one i've seen so far.

[Artofmin]

Sorry for the late reply...and thank for the questions (I should test the demo thoroughly).

- Why is it that only the first 5 locations work? I set up 12 locations but as it seems only the first 5 actually teleport you to your desired location. The rest of them show up on the list, and on the side map, but when pressed will only make a sound and stay in the same window. I looked around the script, but I couldn't find where it went wrong.

Look in the script at LINE 51 – 55 (these are the default setting for the 5 maps). To add new locations for teleportation follow this step:
1. MAP_PLACES[1] = [true, 1, 9, 13, 8] DEFAULT
MAP_PLACES[2] = [true, 2, 9, 1, 2] DEFAULT
MAP_PLACES[3] = [true, 3, 18, 5, 4] DEFAULT
MAP_PLACES[4] = [true, 4, 9, 12, 8] DEFAULT
MAP_PLACES[5] = [true, 5, 2, 8, 6] DEFAULT
MAP_PLACES[6] = [true, 6, 2, 8, 6] <== THIS IS THE NEW MAP (see below for the value)
MAP_PLACES[Map ID] = [true, Map ID, Player X, Player Y, Player Direction}

2. You MUST make new graphic pics for each maps (the pics that highlighted specific location) and named the pics Map001, Map002 and so on (the numbering correspond the Map ID in your game) and place the pics/files in Pictures folder. The mp_menu0 pic is for the background image of the map menu.

3. Then you must assign Switch, make Event in the Maker XP. Download and check the demo.

- When you have a few locations and then save and load the same file, you start out with nothing again. Is it possible to retain the locations?

YES...check the demo (there’s must be an easier way...)

I may have screwed the script setting before (sorry Fox536), please check these line:
Line 299 : return [@availible_maps_tele.size, 0].max
- change the 0 to 1

Line 155 : self.contents.draw_text(4, 32*i, 150, 32, "???", 3)
- OPTIONAL. You can change the ??? to whatever desired text (or let in blank) to be shown if there’s none available location.

*the latest demo is update with above settings.

[Kirye]

Actually what I meant in question 1 was quickly solved by a code I completely missed. >< The one that said 0-4, I just changed the 4 to 12 and it works now.

As for the gametemp, I found a workaround for it. I just made a common event constantly give me the code as long as a switch saying that I should have it is active. No lag from it either, surprisingly.

But thanks for the update, I had to stop working on the game for a bit so I can get the map working, but it's going back on schedule. Kudos on the script.

[Norton]

Absolutely fantastic!!! I'll be using this for my galaxy map! :D