ruby-miyako 2.1.0 → 2.1.1

data/lib/Miyako/API/map.rb

@@ -20,99 +20,9 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 ++
 =end
 
-require 'csv'
 require 'forwardable'
 
 module Miyako
-  #==マップチップ構造体に配列化メソッド(to_a)を定義するための構造体クラス
-  #インデックス参照メソッドを追加
-  class MapChipStruct < Struct
-    #===インスタンスを配列化する
-    #Map/FixedMap.newメソッド内部で、MapChip構造体と、その配列とのダックタイピングのために用意
-    #返却値:: 自分自身を[]囲んだオブジェクトを返す
-    def to_a
-      return [self]
-    end
-  end
-
-  #=マップチップ定義構造体
-  MapChip = MapChipStruct.new(:chip_image, :chips, :size, :chip_size, :access_types, :collision_table, :access_table)
-
-  #=マップチップ作成ファクトリクラス
-  class MapChipFactory
-    #===マップチップを作成するためのファクトリクラス
-    #_csv_filename_:: マップチップファイル名(CSVファイル)
-    #_use_alpha_:: 画像にαチャネルを使うかどうかのフラグ。trueのときは画像のαチャネルを使用、falseのときはカラーキーを使用。デフォルトはtrue
-    def MapChipFactory.load(csv_filename, use_alpha = true)
-      raise MiyakoIOError.no_file(csv_filename) unless File.exist?(csv_filename)
-      lines = CSV.read(csv_filename)
-      raise MiyakoFileFormatError, "This file is not Miyako Map Chip file! : #{csv_filename}" unless lines.shift[0] == "Miyako Mapchip"
-      spr = use_alpha ? Sprite.new({:filename => lines.shift[0], :type => :alpha_channel}) : Sprite.new({:file_name => lines.shift[0], :type => :color_key})
-      tmp = lines.shift
-      chip_size = Size.new(tmp[0].to_i, tmp[1].to_i)
-      size = Size.new(spr.w / chip_size.w, spr.h / chip_size.h)
-      chips = size.w * size.h
-      access_types = lines.shift[0].to_i
-      collision_table = Array.new(access_types){|at|
-        Array.new(chips){|n| Collision.new(lines.shift.map{|s| s.to_i}) }
-      }
-      access_table = Array.new(access_types){|at|
-        Array.new(chips){|n|
-          lines.shift.map{|s|
-            v = eval(s)
-            next v if (v == true || v == false)
-            v = v.to_i
-            next false if v == 0
-            true
-          }
-        }
-      }
-      return MapChip.new(spr, chips, size, chip_size, access_types, collision_table, access_table)
-    end
-  end
-  
-  #==アクセス方向定義クラス
-  #マップチップのアクセステーブルを参照する際に、状態(入る(:in)・出る(:out))と
-  #方向(:left, :right, :up, :down)から、アクセステーブルの指標を取得する必要がある。
-  #このクラスでは、その指標を取得するメソッドを用意している
-  class AccessIndex
-    @@accesses = {
-      in:  { right: 2, left: 4, up: 6, down: 0},
-      out: { right: 3, left: 5, up: 1, down: 7}
-    }
-    @@accesses2 = {
-      in:  [[-1,0,6],[2,-1,-1],[4,-1,-1]],
-      out: [[-1,7,1],[3,-1,-1],[5,-1,-1]]
-    }
-
-    #===状態と方向からアクセステーブルの指標を取得する
-    #アクセステーブルには、2種類の状態(入る=:in, 出る=:out)と、
-    #4種類の方向(左=:left, 右=:right, 上=:up, 下=:down)から構成される
-    #配列となっている。本メソッドで、状態・方向に対応するシンボルから配列の要素指標を取得する。
-    #指定外のシンボルを渡すと例外が発生する
-    #_state_:: 状態を示すシンボル(:in, :out)
-    #_direction_:: 方向を示すシンボル(:left, :right, :up, :down)
-    #返却値:: アクセステーブルの指標番号(整数)
-    def AccessIndex.index(state, direction)
-      raise MiyakoValueError, "can't find AcceessIndex state symbol! #{state}" unless @@accesses.has_key?(state)
-      raise MiyakoValueError, "can't find AcceessIndex direction symbol! #{direction}" unless @@accesses[state].has_key?(direction)
-      return @@accesses[state][direction]
-    end
-
-    #===状態と移動量からアクセステーブルの指標を取得する
-    #アクセステーブルには、2種類の状態(入る=:in, 出る=:out)と、移動量(dx,dy)から構成される
-    #配列となっている。本メソッドで、状態に対応するシンボル、整数から配列の要素指標を取得する。
-    #指定外のシンボルを渡すと例外が発生する
-    #_state_:: 状態を示すシンボル(:in, :out)
-    #_dx_:: x方向移動量
-    #_dy_:: y方向移動量
-    #返却値:: アクセステーブルの指標番号(整数)。何も移動しない場合は-1が返る
-    def AccessIndex.index2(state, dx, dy)
-      raise MiyakoValueError, "can't find AcceessIndex state symbol! #{state}" unless @@accesses.has_key?(state)
-      return @@accesses2[state][dx < -1 ? -1 : dx > 1 ? 1 : 0][dy < -1 ? -1 : dy > 1 ? 1 : 0]
-    end
-  end
-
   #==マップ定義クラス
   class Map
     include SpriteBase
@@ -123,6 +33,9 @@ module Miyako
 
     attr_accessor :visible #レンダリングの可否(true->描画 false->非描画)
     attr_reader :map_layers, :mapchips, :pos, :size, :w, :h
+    alias_method :map_size, :size
+    alias_method :map_w, :w
+    alias_method :map_h, :h
 
     class MapLayer #:nodoc: all
       include SpriteBase
@@ -130,7 +43,7 @@ module Miyako
       extend Forwardable
 
       attr_accessor :visible #レンダリングの可否(true->描画 false->非描画)
-      attr_reader :mapchip, :mapchip_units, :pos, :size
+      attr_reader :mapchip, :mapchip_units, :pos, :size, :ignore_list
 
       def round(v, max) #:nodoc:
         v = max + (v % max) if v < 0
@@ -174,9 +87,11 @@ module Miyako
                                    :oh => @oh)
         }
         @visible = true
+        @def_ignore = -1
+        @ignore_list = []
         resize
       end
-    
+
       def initialize_copy(obj) #:nodoc:
         @mapchip = @mapchip.dup
         @size = @size.dup
@@ -214,6 +129,15 @@ module Miyako
                          @modpy2[round(y, @size.h)])
       end
 
+      #===レイヤー配列を取得する
+      #レイヤーを構成している配列を取得する
+      #取得した配列にアクセスするときの書式は、以下のようになる。
+      #layer[y][x]
+      #返却値:: 所持しているレイヤー配列
+      def layer
+        @mapdat
+      end
+
       #===実座標を使用して、指定のレイヤー・位置のマップチップ番号を取得
       #イベントレイヤーでの番号はイベント番号と一致する
       #_x_:: マップチップ単位での位置(ピクセル単位)
@@ -243,62 +167,76 @@ module Miyako
       #===キャラクタとマップチップが重なっているかどうか問い合わせる
       #指定の矩形のキャラクタが、指定の位置のマップチップのコリジョンと重なっているかどうか問い合わせる
       #引数は、Rect(x,y,w,h)形式(Rect構造体、[x,y,w,h]の配列)で渡す
-      #指定の位置のマップチップ番号が-1(未定義)のときはnilを返す
+      #指定の位置のマップチップ番号が以下の時はnilを返す
+      #1)-1(未定義)のとき
+      #2)FixexMapLayer#ignore_listに含まれているとき
+      #3)引数ignoresに含まれているとき
       #_type_:: 移動形式(0以上の整数)
       #_pos_:: 調査対象のマップチップの位置
       #_collision_:: キャラクタのコリジョン
-      #_rect_:: キャラクタの矩形
+      #_cpos_:: キャラクタの位置
       #返却値:: コリジョンが重なっていれば、そのときのマップチップ番号を返す。重なっていなければnilを返す
-      def collision?(type, pos, collision, rect)
+      def collision?(type, pos, collision, cpos, *ignores)
         code = get_code(*pos.to_a)
-        return nil if code == -1
-        return @mapchip.collision_table[type][code].collision?(pos, collision, rect) ? code : nil
+        return nil if (code == @def_ignore or @ignore_list.include?(code) or ignores.flatten.include?(code))
+        return @mapchip.collision_table[type][code].collision?(pos, collision, cpos) ? code : nil
       end
 
       #===キャラクタとマップチップが隣り合っているかどうか問い合わせる
       #指定の矩形のキャラクタが、指定の位置のマップチップのコリジョンと隣り合っているかどうか問い合わせる
       #引数は、Rect(x,y,w,h)形式(Rect構造体、[x,y,w,h]の配列)で渡す
-      #指定の位置のマップチップ番号が-1(未定義)のときはnilを返す
+      #指定の位置のマップチップ番号が以下の時はnilを返す
+      #1)-1(未定義)のとき
+      #2)FixexMapLayer#ignore_listに含まれているとき
+      #3)引数ignoresに含まれているとき
       #_type_:: 移動形式(0以上の整数)
       #_pos_:: 調査対象のマップチップの位置
       #_collision_:: キャラクタのコリジョン
-      #_rect_:: キャラクタの矩形
+      #_cpos_:: キャラクタの位置
       #返却値:: コリジョンが隣り合っていれば、そのときのマップチップ番号を返す。隣り合っていなければnilを返す
-      def meet?(type, pos, collision, rect)
+      def meet?(type, pos, collision, cpos, *ignores)
         code = get_code(*pos.to_a)
-        return nil if code == -1
-        return @mapchip.collision_table[type][code].meet?(pos, collision, rect) ? code : nil
+        return nil if (code == @def_ignore or @ignore_list.include?(code) or ignores.flatten.include?(code))
+        return @mapchip.collision_table[type][code].meet?(pos, collision, cpos) ? code : nil
       end
 
       #===キャラクタとマップチップが覆い被さっているかどうか問い合わせる
       #指定の矩形のキャラクタが、指定の位置のマップチップのコリジョンを覆い被さっているかどうか問い合わせる
       #引数は、Rect(x,y,w,h)形式(Rect構造体、[x,y,w,h]の配列)で渡す
-      #指定の位置のマップチップ番号が-1(未定義)のときはnilを返す
+      #指定の位置のマップチップ番号が以下の時はnilを返す
+      #1)-1(未定義)のとき
+      #2)FixexMapLayer#ignore_listに含まれているとき
+      #3)引数ignoresに含まれているとき
       #_type_:: 移動形式(0以上の整数)
       #_pos_:: 調査対象のマップチップの位置
       #_collision_:: キャラクタのコリジョン
-      #_rect_:: キャラクタの矩形
+      #_cpos_:: キャラクタの位置
       #返却値:: どちらかのコリジョンが覆い被さっていれば、そのときのマップチップ番号を返す。
       #被さっていなければnilを返す
-      def cover?(type, pos, collision, rect)
+      def cover?(type, pos, collision, cpos, *ignores)
         code = get_code(*pos.to_a)
-        return nil if code == -1
-        return @mapchip.collision_table[type][code].cover?(pos, collision, rect) ? code : nil
+        return nil if (code == @def_ignore or @ignore_list.include?(code) or ignores.flatten.include?(code))
+        return @mapchip.collision_table[type][code].cover?(pos, collision, cpos) ? code : nil
       end
 
       #===キャラクタとマップチップが重なっているかどうか問い合わせる
       #指定の位置と方向で、指定の位置のマップチップ上で移動できるかどうか問い合わせる
-      #指定の位置のマップチップ番号が-1(未定義)のとき、移動していない(dx==0 and dy==0)ときはtrueを返す
+      #指定の位置のマップチップ番号が以下の時はnilを返す
+      #1)-1(未定義)のとき
+      #2)FixexMapLayer#ignore_listに含まれているとき
+      #3)引数ignoresに含まれているとき
+      #また、dx==0, dy==0のときもtrueを返す
       #_type_:: 移動形式(0以上の整数)
       #_inout_:: 入退形式(:in もしくは :out)
       #_pos_:: 調査対象のマップチップの位置
       #_dx_:: 移動量(x座標)
       #_dy_:: 移動量(y座標)
       #返却値:: 移動可能ならばtrueを返す
-      def can_access?(type, inout, pos, dx, dy)
+      def can_access?(type, inout, pos, dx, dy, *ignores)
+        return true if dx == 0 and dy == 0
         code = get_code(pos[0]+dx, pos[1]+dy)
-        return true if code == -1
-        index = AccessIndex.index2(inout, dx, dy)
+        return true if (code == @def_ignore or @ignore_list.include?(code) or ignores.flatten.include?(code))
+        index = MapDir.index2(inout, dx, dy)
         return true if index == -1
         return @mapchip.access_table[type][code][index]
       end
@@ -306,6 +244,8 @@ module Miyako
       def dispose #:nodoc:
         @mapdat = nil
         @baseimg = nil
+        @ignore_list.clear
+        @ignore_list = []
       end
 
       #===マップレイヤーを画面に描画する
@@ -337,84 +277,82 @@ module Miyako
     #また、各レイヤにMapChip構造体を渡すとき、レイヤ数より要素数が少ないときは、先頭に戻って繰り返し渡す仕様になっている
     #各MapChip構造体のマップチップの大きさを同じにしておく必要がある
     #_mapchips_:: マップチップ構造体群(MapChip構造体単体もしくは配列)
-    #_layer_csv_:: レイヤーファイル(CSVファイル)
-    #_event_manager_:: MapEventManagerクラスのインスタンス
+    #_map_struct_:: MapStruct構造体のインスタンス
+    #_event_manager_:: MapEventManagerクラスのインスタンス。省略時（イベントを使わない時）はnil
     #返却値:: 生成したインスタンス
-    def initialize(mapchips, layer_csv, event_manager)
-      raise MiyakoIOError.no_file(layer_csv) unless File.exist?(layer_csv)
-      @event_layers = []
-      @em = event_manager.dup
-      @em.set(self)
+    def initialize(mapchips, map_struct, event_manager=nil)
+      if event_manager
+        @em = event_manager.dup
+        @em.set(self)
+      else
+        @em = nil
+      end
       @mapchips = mapchips.to_a
       @visible = true
       @pos = Point.new(0, 0)
-      layer_data = CSV.readlines(layer_csv)
-      raise MiyakoFileFormatError, "This file is not Miyako Map Layer file! : #{layer_csv}" unless layer_data.shift[0] == "Miyako Maplayer"
-
-      tmp = layer_data.shift # 空行の空読み込み
 
-      @size = Size.new(*(tmp[0..1].map{|v| v.to_i}))
+      @size = map_struct.size
       @w = @size.w
       @h = @size.h
-      
-      layers = layer_data.shift[0].to_i
-      
-      evlist = []
-      brlist = []
-      layers.times{|n|
-        name = layer_data.shift[0]
-        values = []
-        @size.h.times{|y|
-          values << layer_data.shift.map{|m| m.to_i}
-        }
-        if name == "<event>"
-          evlist << values
-        else
-          brlist << values
-        end
-      }
 
-      evlist.each{|events|
-        event_layer = Array.new
-        events.each_with_index{|ly, y|
-          ly.each_with_index{|code, x|
-            next unless @em.include?(code)
-            event_layer.push(@em.create(code, x * @mapchips.first.chip_size.w, y * @mapchips.first.chip_size.h))
+      @event_layers = []
+      if map_struct.elayers
+        raise MiyakoError "Event Manager is not registered!" unless @em
+        map_struct.elayers.each{|events|
+          event_layer = Array.new
+          events.each_with_index{|ly, y|
+            ly.each_with_index{|code, x|
+              next unless @em.include?(code)
+              event_layer.push(@em.create(code, x * @mapchips.first.chip_size.w, y * @mapchips.first.chip_size.h))
+            }
           }
+          @event_layers << event_layer
         }
-        @event_layers << event_layer
-      }
+      end
+
+      @event_layers << [] if @event_layers.empty?
 
       mc = @mapchips.cycle
-      @mapchips = mc.take(layers)
+      @mapchips = mc.take(map_struct.layer_num)
       @map_layers = []
-      brlist.each{|br|
+      map_struct.layers.each{|br|
         br = br.map{|b| b.map{|bb| bb >= @mapchips.first.chips ? -1 : bb } }
         @map_layers.push(MapLayer.new(mc.next, br, @size))
       }
     end
-    
+
     def initialize_copy(obj) #:nodoc:
       @map_layers = @map_layers.dup
       @event_layers = @event_layers.dup
-      @em = em.dup
+      @em = @em.dup if @em
       @mapchips = @mapchips.dup
       @size = @size.dup
       @pos = @pos.dup
     end
 
     #===マップにイベントを追加する
+    # EventManagerが登録されていないときや登録されていないイベント番号で追加したときは例外を返す
     #_idx_:: 追加するイベントレイヤの指標
     #_code_:: イベント番号(Map.newメソッドで渡したイベント番号に対応)
-    #_x_:: マップ上の位置(x方向)
-    #_y_:: マップ常温位置(y方向)
+    #_x_:: マップ上の初期位置(x方向)
+    #_y_:: マップ上の初期位置(y方向)
     #返却値:: 自分自身を返す
     def add_event(idx, code, x, y)
-      return self unless @em.include?(code)
+      raise MiyakoError "Event Manager is not registered!" unless @em
+      raise MiyakoError "Unregisted event code! : #{code}" unless @em.include?(code)
       @event_layers[idx].push(@em.create(code, x, y))
       return self
     end
 
+    #===マップに生成済みのイベントを追加する
+    #_idx_:: 追加するイベントレイヤの指標
+    #_event_:: イベント番号(Map.newメソッドで渡したイベント番号に対応)
+    #返却値:: 自分自身を返す
+    def append_event(idx, event)
+      @event_layers[idx].push(event)
+      return self
+    end
+
     #===マップを移動(移動量指定)
     #_dx_:: 移動量(x方向)
     #_dy_:: 移動量(y方向)
@@ -507,7 +445,7 @@ module Miyako
       yield code if block_given?
       return code
     end
-    
+
     #===対象のマップチップ番号の画像を置き換える
     #_idx_:: 置き換えるマップチップレイヤー番号
     #_code_:: 置き換えるマップチップ番号
@@ -517,7 +455,7 @@ module Miyako
       @map_layers[idx].mapchip_units[code] = base
       return self
     end
-    
+
     #===マップチップ１枚の大きさを取得する
     #マップチップの大きさが32×32ピクセルの場合は、[32,32]のSize構造体が返る
     #返却値:: マップチップのサイズ(Size構造体)
@@ -555,6 +493,113 @@ module Miyako
       return @event_layers
     end
 
+    #===指定のレイヤーのイベントに対してupdateメソッドを呼び出す
+    #イベントレイヤーidxの全てのイベントに対してupdateメソッドを呼び出す
+    #ただし、updateメソッドに渡されるレイヤーは、idxで指定したレイヤーのイベントのみ渡される
+    #_idx_:: 更新するイベントレイヤーの番号
+    #_params_:: イベントのupdateメソッドを呼び出すときに渡す引数。可変個数
+    #返却値:: レシーバ
+    def event_update(idx, *params)
+      @event_layers[idx].each{|event| event.update(self, @event_layers[idx], *params) }
+      self
+    end
+
+    #===全てのイベントに対してupdateメソッドを呼び出す
+    #全レイヤーのイベントを呼び出すことに注意
+    #updateメソッドに渡されるレイヤーは、そのイベントが登録されているレイヤーのみ渡される
+    #_params_:: イベントのupdateメソッドを呼び出すときに渡す引数。可変個数
+    def all_event_update(*params)
+      @event_layers.each{|el| el.each{|event| event.update(self, el, *params) } }
+      self
+    end
+
+    #===指定のレイヤーのイベントに対してupdate2メソッドを呼び出す
+    #イベントレイヤーidxの全てのイベントに対してupdateメソッドを呼び出す
+    #_idx_:: 更新するイベントレイヤーの番号
+    #_params_:: イベントのupdateメソッドを呼び出すときに渡す引数。可変個数
+    #返却値:: レシーバ
+    def event_update2(idx, *params)
+      @event_layers[idx].each{|event| event.update2(*params) }
+      self
+    end
+
+    #===全てのイベントに対してupdate2メソッドを呼び出す
+    #全レイヤーのイベントを呼び出すことに注意
+    #_params_:: イベントのupdate2メソッドを呼び出すときに渡す引数。可変個数
+    def all_event_update2(*params)
+      @event_layers.each{|el| el.each{|event| event.update2(*params) } }
+      self
+    end
+
+    #===指定のレイヤーのイベントに対してmove!メソッドを呼び出す
+    #イベントレイヤーidxの全てのイベントに対してmove!メソッドを呼び出す
+    #_idx_:: 更新するイベントレイヤーの番号
+    #_dx_:: x座標の移動量
+    #_dy_:: y座標の移動量
+    #_params_:: イベントのmove!メソッドを呼び出すときに渡す引数。可変個数
+    #返却値:: レシーバ
+    def event_move!(idx, dx, dy, *params)
+      @event_layers[idx].each{|event| event.move!(dx, dy, *params) }
+      self
+    end
+
+    #===全てのイベントに対してmove!メソッドを呼び出す
+    #全レイヤーのイベントを呼び出すことに注意
+    #_dx_:: x座標の移動量
+    #_dy_:: y座標の移動量
+    #_params_:: イベントのmove!メソッドを呼び出すときに渡す引数。可変個数
+    #返却値:: レシーバ
+    def all_event_move!(dx, dy, *params)
+      @event_layers.each{|el| el.each{|event| event.move!(dx, dy, *params) } }
+      self
+    end
+
+    #===指定のレイヤーのイベントに対してsprite_move!メソッドを呼び出す
+    #イベントレイヤーidxの全てのイベントに対してsprite_move!メソッドを呼び出す
+    #_idx_:: 更新するイベントレイヤーの番号
+    #_dx_:: x座標の移動量
+    #_dy_:: y座標の移動量
+    #_params_:: イベントのmove!メソッドを呼び出すときに渡す引数。可変個数
+    #返却値:: レシーバ
+    def event_sprite_move!(idx, dx, dy, *params)
+      @event_layers[idx].each{|event| event.sprite_move!(dx, dy, *params) }
+      self
+    end
+
+    #===全てのイベントに対してsprite_move!メソッドを呼び出す
+    #全レイヤーのイベントを呼び出すことに注意
+    #_dx_:: x座標の移動量
+    #_dy_:: y座標の移動量
+    #_params_:: イベントのmove!メソッドを呼び出すときに渡す引数。可変個数
+    #返却値:: レシーバ
+    def all_event_sprite_move!(dx, dy, *params)
+      @event_layers.each{|el| el.each{|event| event.sprite_move!(dx, dy, *params) } }
+      self
+    end
+
+    #===指定のレイヤーのイベントに対してsprite_move!メソッドを呼び出す
+    #イベントレイヤーidxの全てのイベントに対してsprite_move!メソッドを呼び出す
+    #_idx_:: 更新するイベントレイヤーの番号
+    #_dx_:: x座標の移動量
+    #_dy_:: y座標の移動量
+    #_params_:: イベントのmove!メソッドを呼び出すときに渡す引数。可変個数
+    #返却値:: レシーバ
+    def event_pos_move!(idx, dx, dy, *params)
+      @event_layers[idx].each{|event| event.pos_move!(dx, dy, *params) }
+      self
+    end
+
+    #===全てのイベントに対してsprite_move!メソッドを呼び出す
+    #全レイヤーのイベントを呼び出すことに注意
+    #_dx_:: x座標の移動量
+    #_dy_:: y座標の移動量
+    #_params_:: イベントのmove!メソッドを呼び出すときに渡す引数。可変個数
+    #返却値:: レシーバ
+    def all_event_pos_move!(dx, dy, *params)
+      @event_layers.each{|el| el.each{|event| event.pos_move!(dx, dy, *params) } }
+      self
+    end
+
     #===マップを画面に描画する
     #転送する画像は、マップ上のから(-margin.x, -margin.y)(単位：ピクセル)の位置に対応するチップを左上にして描画する
     #各レイヤ－を、レイヤーインデックス番号の若い順に描画する