cyross-ruby-miyako 2.0.0 → 2.0.5.1.0

data/lib/Miyako/API/sprite_animation.rb

@@ -2,7 +2,7 @@
 =begin
 --
 Miyako v1.5
-Copyright (C) 2007-2008  Cyross Makoto
+Copyright (C) 2007-2009  Cyross Makoto
 
 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public
@@ -29,6 +29,8 @@ module Miyako
     include Layout
     include SingleEnumerable
 
+    attr_accessor :visible #レンダリングの可否(true->描画 false->非描画)
+    
     #===インスタンスの作成
     #アニメーションを行うための初期設定を行う。
     #アニメーションは２種類の方法があり、
@@ -89,6 +91,7 @@ module Miyako
 
       @slist = Array.new
       if s.kind_of?(Sprite)
+        @now = s.to_unit unless @now
         set_layout_size(s.ow, s.oh)
         move_to(s.x, s.y)
         s.snap(self)
@@ -101,6 +104,7 @@ module Miyako
         @pats     = @pat_len / @pat_olen
       elsif s.kind_of?(Array)
         first = s[0]
+        @now = first.to_unit unless @now
         set_layout_size(first.ow, first.oh)
         move_to(first.x, first.y)
         @slist = s.map{|ss|
@@ -163,11 +167,7 @@ module Miyako
       if @slist.length == 0
         @slist = Array.new(@pats){|pat| s }
         @units = Array.new(@pats){|pat|
-          u = SpriteUnitFactory.create(:bitmap=>@slist[pat].bitmap,
-                                       :ox => @slist[pat].ox,
-                                       :oy => @slist[pat].oy,
-                                       :ow => @slist[pat].ow,
-                                       :oh => @slist[pat].oh)
+          u = @slist[pat].to_unit.dup
           px = pat % (@pat_len / @pat_olen)
           if @dir == :h
             u.oy = @slist[pat].oh * @plist[px]
@@ -179,21 +179,9 @@ module Miyako
       elsif @slist.length < @pats
         tmp = @slist
         @slist = @slist.cycle.take(@pats)
-        @units = Array.new(@pats){|pat|
-          SpriteUnitFactory.create(:bitmap=>@slist[pat].bitmap,
-                                   :ox => @slist[pat].ox,
-                                   :oy => @slist[pat].oy,
-                                   :ow => @slist[pat].ow,
-                                   :oh => @slist[pat].oh)
-        }
+        @units = Array.new(@pats){|pat| @slist[pat].to_unit.dup }
       else
-        @units = Array.new(@pats){|pat|
-          SpriteUnitFactory.create(:bitmap=>@slist[p].bitmap,
-                                   :ox => @slist[p].ox,
-                                   :oy => @slist[p].oy,
-                                   :ow => @slist[p].ow,
-                                   :oh => @slist[p].oh)
-        }
+        @units = Array.new(@pats){|pat| @slist[pat].to_unit.dup }
       end
 
       if @move_offset.length == 0
@@ -226,7 +214,7 @@ module Miyako
       @pnum  = 0
       @cnt   = 0
       @exec  = false
-      @visible = false
+      @visible = true
 
       @now = @units[0]
       @now.move_to(@slist[@plist[@pnum]].x + @move_offset[@pnum][0],
@@ -234,9 +222,33 @@ module Miyako
     end
 
     attr_accessor :visible
+ 
+    #=== 現在表示しているスプライトの x 座標の値を取得する
+    #返却値:: x 座標の値
+    def x
+      return @now.x
+    end
+ 
+    #=== 現在表示しているスプライトの y 座標の値を取得する
+    #返却値:: y 座標の値
+    def y
+      return @now.y
+    end
+ 
+    #=== 現在表示しているスプライトの幅を取得する
+    #返却値:: 現在表示しているスプライトの幅(ピクセル単位)
+    def w
+      return @now.ow
+    end
+ 
+    #=== 現在表示しているスプライトの高さを取得する
+    #返却値:: 現在表示しているスプライトの高さ(ピクセル単位)
+    def h
+      return @now.oh
+    end
 
     def update_layout_position #:nodoc:
-      @now.move_to(*@layout.pos) if @now
+      @units.each{|u| u.move_to(*@layout.pos)}
     end
 
     #===現在表示しているスプライトのowを取得する
@@ -253,8 +265,7 @@ module Miyako
 
     #===表示するパターンの番号を変更する
     #_pnum_:: パターン番号
-    #返却値:: 自分自身
-    def pattern(pnum)
+    def pattern=(pnum)
       @pnum = pnum if pnum < @pats
       set_pat
       @cnt = @waits[@plist[@pnum]] if @exec
@@ -263,18 +274,18 @@ module Miyako
 
     #===現在表示しているパターンを取得する
     #返却値:: 現在表示しているスプライトのインスタンス
-    def get_pattern
+    def pattern
       return @plist[@pnum]
     end
 
-    #===あとで書く
-    #_cnum_:: あとで書く
-    #返却値:: あとで書く
-    def character(cnum)
-      return self if cnum >= @chrs
+    #===キャラクター番号を設定する
+		#キャラクター番号(アニメーションさせるときに表示させるパターン群インデックス)
+		#を設定する。範囲外のキャラクター番号が設定された時は何も行わない
+    #_cnum_:: キャラクター番号
+    def character=(cnum)
+      return self if (cnum < 0 || cnum >= @chrs)
       @cnum = cnum
       set_chr
-      return self
     end
 
     #===あとで書く
@@ -287,7 +298,9 @@ module Miyako
       return self
     end
 
-    def get_character #:nodoc:
+		#===現在のキャラクター番号を取得する
+		#返却値:: キャラクター番号（0以上の整数）
+    def character
       return @cnum
     end
     
@@ -297,8 +310,6 @@ module Miyako
     def start
       return self if @exec
       set_pat
-      @now.move_to(@slist[@plist[@pnum]].x + @move_offset[@pnum][0],
-                   @slist[@plist[@pnum]].y + @move_offset[@pnum][1])
       if @dir == :h
         @now.oy += @pos_offset[@pnum]
       else
@@ -342,26 +353,6 @@ module Miyako
     #但し、インスタンス生成時に:loop->falseを設定していれば、アニメーションを終了する
     #返却値:: アニメーションパターンが切り替わればtrue、切り替わらないとき、アニメーションが終了したときはfalseを返す
     def update_animation
-      is_change = false
-      return is_change unless @exec
-      if @dir == :h
-        @now.oy -= @pos_offset[@pnum]
-      else
-        @now.ox -= @pos_offset[@pnum]
-      end
-      if @cnt.kind_of?(Integer)
-        is_change = update_frame
-      else
-        is_change = update_wait_counter
-      end
-      @now.move_to(@slist[@plist[@pnum]].x + @move_offset[@pnum][0],
-                   @slist[@plist[@pnum]].y + @move_offset[@pnum][1])
-      if @dir == :h
-        @now.oy += @pos_offset[@pnum]
-      else
-        @now.ox += @pos_offset[@pnum]
-      end
-      return is_change
     end
 
     def update_frame #:nodoc:
@@ -420,26 +411,34 @@ module Miyako
       return @exec
     end
 
-    # 現在実行中のパターンの元になったスプライトユニットを返す
-    # 返却値:: 現在表示しているスプライトユニット
+    #===現在実行中のパターンの元になったスプライトユニットを返す
+    #得られるインスタンスは複写していないので、インスタンスの値を調整するには、dupメソッドで複製する必要がある
+    #返却値:: 現在表示しているスプライトユニット
     def to_unit
-      return @now.dup
+      return @now
     end
     
-    # 現在実行中のパターンの画像を返す
-    # 返却値:: 現在表示している画像(bitmap)
+    #=== 現在実行中のパターンの画像を返す
+    #返却値:: 現在表示している画像(bitmap)
     def bitmap
       return @now.bitmap
     end
     
     #===現在実行中のパターンの元になったインスタンスを返す
     #取得するパターンは、元になったインスタンスのto_spriteメソッドを呼び出した時の値となる
-    # 返却値:: 現在表示しているスプライト
-    def to_sprite
-      return @slist[@plist[@pnum]].to_sprite
+    #引数1個のブロックを渡せば、スプライトに補正をかけることが出来る
+    #返却値:: 現在表示しているスプライト
+    def to_sprite(&block)
+      return @slist[@plist[@pnum]].to_sprite(&block)
     end
 
-    #===現在の画面の最大の大きさを矩形で取得する
+    #===現在表示しているスプライトの大きさを矩形で取得する
+    #返却値:: 生成された矩形(Rect構造体のインスタンス)
+    def rect
+      return Rect.new(@now.x, @now.y, @now.ow, @now.oh)
+    end
+ 
+    #===現在表示しているスプライトの最大の大きさを矩形で取得する
     #現在のパターンの大きさと同じため、rectメソッドの値と同一となる
     #返却値:: 生成された矩形(Rect構造体のインスタンス)
     def broad_rect
@@ -456,6 +455,27 @@ module Miyako
       @move_offset.clear
       @pos_offset.clear
     end
+
+    #===アニメーションの現在の画像を画面に描画する
+    #転送元の描画範囲は、src側SpriteUnitの(ox,oy)を起点に、src側(ow,oh)の範囲で転送する。
+    #画面の描画範囲は、src側SpriteUnitの(x,y)を起点に設定にする。
+    #ブロック付きで呼び出し可能(レシーバに対応したSpriteUnit構造体が引数として得られるので、補正をかけることが出来る)
+    #(ブロック引数のインスタンスは複写しているので、メソッドの引数として渡した値が持つSpriteUnitには影響しない)
+    #ブロックの引数は、|インスタンスのSpriteUnit|となる。
+    #visibleメソッドの値がfalseのときは描画されない。
+    def render
+    end
+
+    #===アニメーションの現在の画像を画像に描画する
+    #転送元の描画範囲は、src側SpriteUnitの(ox,oy)を起点に、src側(ow,oh)の範囲で転送する。
+    #転送先の描画範囲は、src側SpriteUnitの(x,y)を起点に設定にする。
+    #ブロック付きで呼び出し可能(レシーバに対応したSpriteUnit構造体が引数として得られるので、補正をかけることが出来る)
+    #(ブロック引数のインスタンスは複写しているので、メソッドの引数として渡した値が持つSpriteUnitには影響しない)
+    #ブロックの引数は、|インスタンスのSpriteUnit,転送先のSpriteUnit|となる。
+    #visibleメソッドの値がfalseのときは描画されない。
+    #_dst_:: 転送先ビットマップ(to_unitメソッドを呼び出すことが出来る/値がnilではないインスタンス)
+    def render_to(dst)
+    end
   end
 end
 

data/lib/Miyako/API/spriteunit.rb

@@ -2,7 +2,7 @@
 =begin
 --
 Miyako v2.0
-Copyright (C) 2007-2008  Cyross Makoto
+Copyright (C) 2007-2009  Cyross Makoto
 
 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public
@@ -25,35 +25,63 @@ module Miyako
   #==SpriteUnitを生成するための構造体クラス
   #Structクラスからの継承
   #--
-  #SpriteUnit = Struct.new([:dp], :bitmap, :ox, :oy, :ow, :oh, :x, :y, :dx, :dy, [:effect], [:viewport], :angle, :xscale, :yscale, :px, :py, :qx, :qy)
+  #SpriteUnit = Struct.new(:bitmap, :ox, :oy, :ow, :oh, :x, :y, :cx, :cy)
   #++
   class SpriteUnitBase < Struct
     #===位置を変更する(変化量を指定)
+    #位置を右方向へdxピクセル、下方向へdyピクセル移動する
+    #ブロックを渡すと、ブロック評価中の位置を変更する
     #_dx_:: 移動量(x方向)。単位はピクセル
     #_dy_:: 移動量(y方向)。単位はピクセル
     #返却値:: 自分自身を返す
     def move(dx, dy)
+      o = [self.x, self.y]
       self.x+=dx
       self.y+=dy
+      if block_given?
+        yield
+        self.x, self.y = o
+      end
       return self
     end
 
     #===位置を変更する(位置指定)
+    #左上を(0.0)として、位置を右xピクセル、下yピクセルの位置移動する
+    #ブロックを渡すと、ブロック評価中の位置を変更する
     #_x_:: 移動先位置(x方向)。単位はピクセル
     #_y_:: 移動先位置(y方向)。単位はピクセル
     #返却値:: 自分自身を返す
     def move_to(x, y)
+      o = [self.x, self.y]
       self.x=x
       self.y=y
+      if block_given?
+        yield
+        self.x, self.y = o
+      end
       return self
     end
+    #また、ブロックを渡せば、複製したインスタンスに補正を欠けることが出来る(画像変換も可能)
 
     #===自分自身を返す
     #SpriteUnit対応
     #ダックタイピング用のメソッド
-    #返却値:: 自分自身(複製して返す)
+    #得られるインスタンスは複写していないので、インスタンスの値を調整するには、dupメソッドで複製する必要がある
+    #返却値:: 自分自身
     def to_unit
-      return self.dup
+      return self
+    end
+
+    #===スプライトを生成して返す
+    #ダックタイピング用のメソッド
+    #所持しているSpriteUnitから、Spriteクラスのインスタンスを生成する
+    #但し、bitmapの設定は:type=>:alpha_channelのみ
+    #引数1個のブロックを渡せば、スプライトに補正をかけることが出来る
+    #返却値:: 生成したスプライト
+    def to_sprite
+      sprite = Sprite.new(:unit=>self, :type=>:ac)
+      yield sprite if block_given?
+      return sprite
     end
 
     #===画像の表示矩形を取得する
@@ -74,7 +102,7 @@ module Miyako
   #==スプライト出力情報構造体
   #基本的なことは、Sprite.renderで行うことが出来るが、凝った処理を行う場合は、SpriteUnitを使う
   #--
-  #SpriteUnit = Struct.new([:dp], :bitmap, :ox, :oy, :ow, :oh, :x, :y, [:effect], [:viewport], :angle, :xscale, :yscale, :cx, :cy)
+  #SpriteUnit = Struct.new([:dp], :bitmap, :ox, :oy, :ow, :oh, :x, :y, :cx, :cy)
   #++
   #([数字])は、配列として認識したときのインデックス番号に対応(Struct#[]メソッドを呼び出した時のインデックス)
   #:bitmap([0]) -> 画像データ(SDL::Surfaceクラスのインスタンス)
@@ -84,28 +112,34 @@ module Miyako
   #:oh([4])     -> 描画高さ
   #:x([5])     -> 描画幅
   #:y([6])     -> 描画高さ
-  #:angle([7])  -> 回転角度(ラジアン単位)
-  #:xscale([8]) -> X方向拡大・縮小・鏡像の割合(実数。変換後の幅が32768を切る様にすること)
-  #:yscale([9]) -> Y方向拡大・縮小・鏡像の割合(実数。変換後の幅が32768を切る様にすること)
-  #:cx([10])     -> 回転・拡大・縮小・鏡像の中心座標(x方向)
-  #:cy([11])     -> 回転・拡大・縮小・鏡像の中心座標(y方向)
-  SpriteUnit = SpriteUnitBase.new(:bitmap, :ox, :oy, :ow, :oh, :x, :y, :angle, :xscale, :yscale, :cx, :cy)
+  #:cx([7])     -> 回転・拡大・縮小・鏡像の中心座標(x方向)
+  #:cy([8])     -> 回転・拡大・縮小・鏡像の中心座標(y方向)
+  SpriteUnit = SpriteUnitBase.new(:bitmap, :ox, :oy, :ow, :oh, :x, :y, :cx, :cy)
 
   #==SpriteUnit生成ファクトリクラス
   #SpriteUnit構造体のインスタンスを生成するためのクラス
   class SpriteUnitFactory
-    PARAMS = [:bitmap, :ox, :oy, :ow, :oh, :x, :y, :angle, :xscale, :yscale, :cx, :cy]
+    PARAMS = [:bitmap, :ox, :oy, :ow, :oh, :x, :y, :cx, :cy]
     #==SpriteUnitのインスタンスを生成する
     #params: 初期化するSpriteUnit構造体の値。ハッシュ引数。引数のキーは、SpriteUnitのアクセサ名と同一。省略可能
     def SpriteUnitFactory.create(params = nil)
-      unit = SpriteUnit.new(nil, 0, 0, 0, 0, 0, 0, 0, 1.0, 1.0, 0, 0)
+      unit = SpriteUnit.new(nil, 0, 0, 0, 0, 0, 0, 0, 0)
       return SpriteUnitFactory.apply(unit, params)
     end
 
     #==SpriteUnitの各アクセサに対応した値を設定する
+    #(注)bitmapアクセサに値を設定する場合、ox,oy,ow,ohの値が自動的に、
+    #bitmapに対応する値(ox=0,oy=0,ow=bitmap.w,oh=bitmap.h)が設定される
     #unit: 設定対象のSpriteUnit構造体
     #params: 設定するSpriteUnit構造体の値。ハッシュ引数。引数のキーは、SpriteUnitのアクセサ名と同一
     def SpriteUnitFactory.apply(unit, params)
+      if params && params.has_key?(:bitmap)
+        unit.bitmap = params[:bitmap]
+        unit.ox = 0
+        unit.oy = 0
+        unit.ow = unit.bitmap.w
+        unit.oh = unit.bitmap.h
+      end
       PARAMS.each{|prm| unit[prm] = params[prm] if params.has_key?(prm) } if params
       return unit 
     end

data/lib/Miyako/API/story.rb

@@ -3,7 +3,7 @@
 =begin
 --
 Miyako v2.0
-Copyright (C) 2007-2008  Cyross Makoto
+Copyright (C) 2007-2009  Cyross Makoto
 
 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public
@@ -26,36 +26,66 @@ module Miyako
   #==シーン実行クラス
   #用意したシーンインスタンスを実行
   class Story
-    #===あとで書く
-    #返却値:: あとで書く
-    def prev_label
+    @@sub_scenes = [:sub_scene, :sub_routine]
+    @@over_scenes = [:over_scene]
+  
+    def prev_label #:nodoc:
       return @prev_label
     end
 
-    #===あとで書く
-    #返却値:: あとで書く
-    def next_label
+    def next_label #:nodoc:
       return @next_label
     end
 
-    #===あとで書く
-    #返却値:: あとで書く
-    def upper_label
+    def upper_label #:nodoc:
       return @stack.empty? ? nil : @stack.last[0]
     end
 
     #===インスタンスの作成
-    #
-    #返却値:: あとで書く
+    #ストーリー情報の初期か
+    #返却値:: 生成したインスタンス
     def initialize
       @prev_label = nil
       @next_label = nil
 
-      @stack = Array.new
-
+      @stack = []
+      @fibers = [nil]
+      
       @scene_cache = Hash.new
       @scene_cache_list = Array.new
       @scene_cache_max = 20
+
+      @fiber = Proc.new{|sc, num|
+        raise MiyakoError, "Illegal Script-label name! : #{sc}" unless Scene.has_scene?(sc.to_s)
+        fnum = nil
+        bk_nn = sc
+        uu = sc.new(self)
+        uu.init_inner(@prev_label, self.upper_label)
+        uu.setup
+        ret = true
+        while ret do
+          nn = uu.update
+          uu.render
+          if fnum && @fibers[fnum]
+            @fibers[fnum].resume(true)
+          elsif nn && !(nn.eql?(uu.class)) && @@over_scenes.include?(nn.scene_type)
+            @fibers << Fiber.new(&@fiber)
+            fnum = @fibers.length-1
+            @fibers[fnum].resume(nn, fnum)
+            n = bk_nn
+          end
+          break unless nn
+          ret = Fiber.yield
+        end
+        uu.final
+        uu.dispose
+        if (fnum && @fibers[fnum])
+          @fibers[fnum].resume(nil)
+          @fibers[fnum] = nil
+          fnum = nil
+        end
+        @fibers[num] = nil
+      }
     end
     
     def get_scene(n, s) #:nodoc:
@@ -71,9 +101,9 @@ module Miyako
       return @scene_cache[class_symbol]
     end
 
-    #===あとで書く
-    #_n_:: あとで書く
-    #返却値:: あとで書く
+    #===Storyの実行を始める
+    #"obj.run(MainScene)"と記述すると、SceneモジュールをmixinしたMainSceneクラスのインスタンスを作成し、評価を始める
+    #_n_:: 最初に実行するシーン名(クラス名を定数で)
     def run(n)
       return nil if n == nil
       u = nil
@@ -84,6 +114,7 @@ module Miyako
         on = n
 
         raise MiyakoError, "Illegal Script-label name! : #{n}" unless Scene.has_scene?(n.to_s)
+        raise MiyakoError, "This scene cannot use for Standard Scene! : #{n}" if n.scene_type != :scene
         u = get_scene(n, @stack.size) if u == nil
         u.init_inner(@prev_label, self.upper_label)
         u.setup
@@ -91,43 +122,81 @@ module Miyako
         loop do
           Input.update
           Screen.clear
+          bk_n = on
           n = u.update
-          break unless n && on.eql?(n)
           u.render
+          if @fibers.first
+            raise MiyakoError, "Double over scene from root!" if n && @@over_scenes.include?(n.scene_type)
+            @fibers.first.resume(true, 0)
+          elsif n && @@over_scenes.include?(n.scene_type)
+            @fibers.clear
+            @fibers << Fiber.new(&@fiber)
+            @fibers.first.resume(n, 0)
+            n = bk_n
+          end
           Screen.render
+          break unless n && on.eql?(n)
         end
         u.next = n
         @next_label = n
         u.final
         if n == nil
-          if u.scene_type == :sub_routine && @stack.empty? == false
+          if @@sub_scenes.include?(u.class.scene_type) && @stack.empty? == false
             n, u = @stack.pop
             next
           end
           break
-        elsif n.new(self, false).scene_type == :sub_routine
+        elsif @@sub_scenes.include?(n.scene_type)
           @stack.push([on, u])
           u = nil
         else
           u = nil
         end
       end
+      if @fibers.length > 0
+        @fibers.each{|fiber| fiber.resume(nil) if fiber }
+      end
       @scene_cache_list.each{|sy| @scene_cache[sy].dispose }
       @scene_cache.clear
       @scene_cache_list.clear
     end
     
-    #===あとで書く
+    #==="over_scene"形式のシーンが実行中かどうか判別する
+    #返却値:: "over_scene"形式のシーンが実行中の時はtrueを返す
+    def over_scene_execute?
+      return @now_fiber != nil
+    end
+    
+    #===内部の情報を解放する
     def dispose
       @scene_cache.keys.each{|k| @scene_cache[del_symbol].dispose }
     end
 
     #==シーンモジュール
-    #本モジュールをmixinすることにより、シーンを示すインスタンスを作??することができる
+    #本モジュールをmixinすることにより、シーンを示すインスタンスを作成することができる
+    #mixinするときに気をつけなければいけないのは、本モジュールでは以下のインスタンス変数・モジュール変数を
+    #予約しているため、これらの変数の値を勝手に変えてはいけない
+    #@@scenesモジュール変数(シーンクラス一覧が入っている配列)、@storyインスタンス変数(シーンを呼び出したStoryクラスインスタンス)
+    #@nowインスタンス変数(現在評価しているシーンクラス)、@preインスタンス変数(一つ前に評価していたシーンクラス)
+    #@upperインスタンス変数(sub_routineの呼び元シーンクラス)、@nextインスタンス変数(移動先のシーンクラス)
+    #また、シーンには「シーン形式」がある。
+    #種類は、シーケンスな移動が出来る「通常シーン」、終了したときに移動元に戻る「サブシーン」、
+    #現在実行中のシーン上で並行に実行する「オーバーシーン」の3種類。
+    #デフォルトは「通常シーン」となっている。
+    #判別は、scene_typeクラスメソッドを呼び出すことで可能。デフォルトは、通常シーンを示すシンボル":scene"が返る。
+    #形式を変えるには、scene_typeクラスメソッドをオーバーライドし、返却値を変える。
+    #サブシーンの時はシンボル":sub_scene"、オーバーシーンのときはシンボル":over_scene"を返すように実装する
+    #(注1)同じクラス名のシーンを繰り返し実行したいときは、いったん別のダミーシーンを介してから元のシーンへ移動する必要がある
+    #(注2)オーバーシーン内では、シーンの移動が出来ないが、入れ子形式で別のオーバーシーンを積み上げる形なら移動可能。
     module Scene
 	  @@scenes = {}
 
       def Scene.included(c) #:nodoc:
+        unless c.singleton_methods.include?(:scene_type)
+          def c.scene_type
+            return :scene
+          end
+        end
         @@scenes[c.to_s] = c
       end
 
@@ -139,12 +208,6 @@ module Miyako
         return @@scenes.has_key?(s)
       end
 
-      #===あとで書く
-      #返却値:: あとで書く
-      def scene_type
-        return :scene
-      end
-      
       def initialize(story, check_only=false) #:nodoc:
         return if check_only
         @story = story
@@ -160,34 +223,39 @@ module Miyako
         @upper = u
       end
 
-      #===あとで書く
-      #返却値:: あとで書く
+      #===シーン内で使用するオブジェクトの初期化テンプレートメソッド
+      #シーン内で使用するインスタンスを生成するときなどにこのメソッドを実装する
       def init
       end
 
-      #===あとで書く
-      #返却値:: あとで書く
+      #===シーン内で使用するオブジェクトの初期設定テンプレートメソッド
+      #シーン内で使用するインスタンスの設定を行うときにこのメソッドを実装する
+      #(シーン生成時に生成したインスタンスはキャッシュされ、再利用することができることに注意)
       def setup
       end
 
-      #===あとで書く
-      #返却値:: あとで書く
+      #===シーンの情報を更新するテンプレートメソッド
+      #
+      #現在実行しているシーンを繰り返し実行する場合はインスタンス変数@nowを返すように実装する
+      #nilを返すとシーンの処理を終了する(元のStory#runメソッド呼び出しの次に処理が移る)
+      #但し、scene_typeメソッドの結果が:sub_routneのとき、移動元シーンに戻る
+      #返却値:: 移動先シーンクラス
       def update
         return @now
       end
 
-      #===あとで書く
-      #返却値:: あとで書く
+      #===シーンで指定しているインスタンスを画面に描画するテンプレートメソッド
       def render
       end
 
-      #===あとで書く
-      #返却値:: あとで書く
+      #===シーン内で使用したオブジェクトの後始末を行うテンプレートメソッド
+      #ここでは、解放処理(dispose)ではなく、終了処理(値を変更するなど)に実装する
+      #setupメソッドと対になっているというイメージ
       def final
       end
 
-      #===あとで書く
-      #返却値:: あとで書く
+      #===シーンに使用したデータの解放を記述するテンプレートメソッド
+      #initメソッドと対になっているというイメージ
       def dispose
       end
       
@@ -195,14 +263,23 @@ module Miyako
         @next = label
       end
 
-      #===あとで書く
-      #返却値:: あとで書く
+      #==="over_scene"形式のシーンが実行中かどうか判別する
+      #返却値:: "over_scene"形式のシーンが実行中の時はtrueを返す
+      def over_scene_execute?
+        return @story.over_scene_execute?
+      end
+    
+      #===シーンの解説を返す(テンプレートメソッド)
+      #Sceneモジュールをmixinしたとき、解説文を返す実装をしておくと、
+      #Scene.#lisutupメソッドを呼び出したときに、noticeメソッドの結果を取得できる
+      #返却値:: シーンの解説(文字列)
       def notice
         return ""
       end
 
-      #===あとで書く
-      #返却値:: あとで書く
+      #===登録しているシーン一覧をリストアップする
+      #リストの内容は、"シーンクラス名(文字列),シーンクラス(ポインタ),解説(noticeメソッドの内容)"という書式で取得できる
+      #返却値:: リストアップしたシーンの配列
       def Scene.listup
         list = Array.new
         sns = @@scenes
@@ -210,9 +287,8 @@ module Miyako
         return list
       end
 
-      #===あとで書く
-      #_csvname_:: あとで書く
-      #返却値:: あとで書く
+      #===Scene.#listupメソッドの内容をCSVファイルに保存する
+      #_csvname_:: 保存するCSVファイルパス
       def Scene.listup2csv(csvfname)
         csvfname += ".csv" if csvfname !~ /\.csv$/
         list = self.listup