openrgss 0.1 → 0.1.2

data/lib/openrgss/rect.rb

@@ -0,0 +1,78 @@
+class Rect
+
+  # The x-coordinate of the rectangle's upper left corner.
+  attr_accessor :x
+
+  # The y-coordinate of the rectangle's upper left corner.
+  attr_accessor :y
+
+  # The rectangle's width.
+  attr_accessor :width
+
+  # The rectangle's height.
+  attr_accessor :height
+
+  # :call-seq:
+  # Rect.new(x, y, width, height)
+  # Rect.new
+  #
+  # Creates a new Rect object.
+  #
+  # The default values when no arguments are specified are (0, 0, 0, 0).
+
+  def initialize(x=0, y=0, width=0, height=0)
+    set(x, y, width, height)
+  end
+
+  # :call-seq:
+  # set(x, y, width, height)
+  # set(rect)
+  #
+  # Sets all parameters at once.
+  #
+  # The second format copies all the components from a separate Rect object.
+
+  def set(x, y=0, width=0, height=0)
+    if x.is_a? Rect
+      rect    = x
+      @x      = rect.x
+      @y      = rect.y
+      @width  = rect.width
+      @height = rect.height
+    else
+      @x      = x
+      @y      = y
+      @width  = width
+      @height = height
+    end
+  end
+
+  def to_s
+    "(#{x}, #{y}, #{width}, #{height})"
+  end
+
+  # Sets all components to 0.
+  def empty
+    set(0, 0, 0, 0)
+  end
+
+  # Vergleichsmethode
+  def == other
+    if other.kind_of?(Rect) then
+      x == other.x && y == other.y && width == other.width && height == other.height
+    else
+      raise TypeError.new("Can't convert #{other.class} to Rect")
+    end
+  end
+
+  # Serialisiert das Objekt
+  def _dump limit
+    [x, y, width, height].pack("iiii")
+  end
+
+  # Deserialisiert das Objekt
+  def self._load str
+    new(*str.unpack("iiii"))
+  end
+
+end

data/lib/openrgss/rgss.rb

@@ -0,0 +1,302 @@
+require 'sdl'
+require 'logger'
+
+# The following built-in functions are defined in RGSS.
+
+module RGSS
+
+  Log        = Logger.new(STDOUT)
+  @resources = []
+  @load_path = []
+
+  class << self
+    # 标题
+    attr_accessor :title
+
+    # get_file的读取路径，目录字符串的数组
+    attr_accessor :load_path
+
+    # get_file的自动补全扩展名，以点开头的扩展名字符串的数组
+    attr_accessor :load_ext
+
+    # 屏幕上显示的资源，Drawable的数组
+    attr_accessor :resources
+
+    # 显示帧率
+    attr_accessor :show_fps
+
+    def title=(title) # :NODOC:
+      @title = title
+      SDL::WM.set_caption(title, title)
+    end
+
+    # 在load_path指定的目录中查找文件，会自动补全Autoload_Extname里指定的扩展面给，默认为 .png, .jpg, .gif, .bmp, .ogg, .wma, .mp3, .wav, .mid
+    #
+    # 在Audio和Bitmap的内部自动调用
+    #
+    # 如果找不到文件，将返回filename本身
+
+    def get_file(filename)
+      ([nil] + RGSS.load_path).each do |directory|
+        ([''] + load_ext).each do |extname|
+          path = File.expand_path filename + extname, directory
+          if File.exist? path
+            return path
+          end
+        end
+      end
+      filename
+    end
+
+    # 初始化RGSS引擎，将会在rgss_main内部自动调用
+
+    def init
+      SDL.init SDL::INIT_EVERYTHING
+      Graphics.entity = SDL::Screen.open(Graphics.width, Graphics.height, 0, SDL::HWSURFACE|SDL::HWPALETTE)
+      SDL::Mixer.open(SDL::Mixer::DEFAULT_FREQUENCY, SDL::Mixer::DEFAULT_FORMAT, SDL::Mixer::DEFAULT_CHANNELS, 1536)
+      SDL::TTF.init
+      self.title = @title
+    end
+
+    # 指定是否显示帧率
+
+    def show_fps=(show_fps)
+      if show_fps
+        SDL::WM.set_caption("#{title} - #{Graphics.real_fps}fps", title)
+      else
+        SDL::WM.set_caption(title, title)
+      end
+
+      @show_fps = show_fps
+    end
+
+    # 引擎的更新，将在Graphics.update和Input.update的内部自动调用
+
+    def update
+      if @show_fps and @fps != Graphics.real_fps
+        SDL::WM.set_caption("#{title} - #{Graphics.real_fps}fps", title)
+        @fps = Graphics.real_fps
+      end
+
+      while event = SDL::Event.poll
+        case event
+        when SDL::Event::Quit
+          exit
+        when SDL::Event::KeyDown, SDL::Event::KeyUp
+          Input.events << event
+        else #when
+             #Log.debug "unhandled event: #{event}"
+        end
+      end
+    end
+  end
+  self.load_ext  = ['.png', '.jpg', '.gif', '.bmp', '.ogg', '.wma', '.mp3', '.wav', '.mid']
+  self.load_path = []
+  # Evaluates the provided block one time only.
+  #
+  # Detects a reset within a block with a press of the F12 key and returns to the beginning if reset.
+  #  rgss_main { SceneManager.run }
+
+  def rgss_main
+    RGSS.init
+    begin
+      yield
+    rescue RGSSReset
+      RGSS.resources.clear
+      retry
+    end
+  end
+
+  # Stops script execution and only repeats screen refreshing. Defined for use in script introduction.
+  #
+  # Equivalent to the following.
+  #
+  #  loop { Graphics.update }
+
+  def rgss_stop
+
+  end
+
+  # Loads the data file indicated by filename and restores the object.
+  #
+  #  $data_actors = load_data("Data/Actors.rvdata2")
+  #
+  # This function is essentially the same as:
+  #
+  #  File.open(filename, "rb") { |f|
+  #    obj = Marshal.load(f)
+  #  }
+  #
+  # However, it differs in that it can load files from within encrypted archives.
+
+  def load_data(filename)
+    File.open(filename, "rb") { |f|
+      obj = Marshal.load(f)
+    }
+  end
+
+  # Saves the object obj to the data file indicated by filename.
+  #
+  #  save_data($data_actors, "Data/Actors.rvdata2")
+  #
+  # This function is the same as:
+  #  File.open(filename, "wb") { |f|
+  #    Marshal.dump(obj, f)
+  #  }
+
+  def save_data(obj, filename)
+    File.open(filename, "wb") { |f|
+      Marshal.dump(obj, f)
+    }
+  end
+
+  # Outputs the arguments to the message box. If a non-string object has been supplied as an argument, it will be converted into a string with to_s and output.
+  #
+  # Returns nil.
+  #
+  # <b>(Not Implemented in OpenRGSS)</b>
+  def msgbox(*args)
+    if RUBY_PLATFORM['mingw'] or RUBY_PLATFORM['mswin']
+      require 'dl'
+      @@msgbox = DL.dlopen('user32')['MessageBoxA', 'ILSSI']
+      msgbox.call(0, args.collect{|arg|arg.to_s}.join("\n"), title, 0)
+    else
+      puts args
+    end
+  end
+
+  # Outputs obj to the message box in a human-readable format. Identical to the following code (see Object#inspect):
+  #
+  #  msgbox obj.inspect, "\n", obj2.inspect, "\n", ...
+  #
+  # Returns nil.
+  #
+  # <b>(Not Implemented in OpenRGSS)</b>
+  def msgbox_p(*args)
+    msgbox args.collect{|obj|obj.inspect}.join("\n")
+  end
+
+  module Drawable
+    attr_accessor :x, :y, :viewport, :created_at
+    attr_reader :z, :visible
+
+    def initialize(viewport=nil)
+      @created_at  = Time.now
+      @viewport    = viewport
+      self.visible = @visible
+    end
+
+    def viewport=(viewport)
+      @viewport    = viewport
+      self.visible = @visible
+    end
+
+    def >(v)
+      return false if self.viewport.nil?&&v.viewport
+      unless (v.viewport.nil?)
+        return false if self.viewport.z<v.viewport.z
+        return false if self.viewport.z==v.viewport.z and self.viewport.created_at<v.viewport.created_at
+      end
+      return false if self.z<v.z
+      return false if self.z==v.z and self.y<v.y
+      return false if self.z==v.z and self.y==v.y and self.created_at<v.created_at
+      return true
+    end
+
+    #$a=0
+    def <=>(v)
+      #print $a+=1
+      return 1 if (self>v)
+      return -1
+    end
+
+    def z=(z)
+      return if z==@z
+      @z = z
+
+      self.visible = true if @visible and !@disposed
+    end
+
+    def y=(y)
+      return if y==@y
+      @y = y
+      # RGSS.resources.sort
+      self.visible = true if @visible and !@disposed
+    end
+
+    def disposed?
+      @disposed
+    end
+
+    def dispose
+      @disposed = true
+      RGSS.resources.delete self
+    end
+
+    def visible=(visible)
+      #if @visible
+      #  RGSS.resources.delete self
+      #end
+      @visible = visible
+      RGSS.resources.delete self unless @visible
+      if @visible
+        RGSS.resources.delete self
+        RGSS.resources<< self
+        #   RGSS.resources.sort
+      end
+=begin
+      if @visible
+        RGSS.resources.each_with_index { |resource, index|
+
+          #TODO: 简化逻辑
+          if resource.viewport
+            resource_viewport_z = resource.viewport.z
+            resource_viewport_y = resource.viewport.y
+          else
+            resource_viewport_z = 0
+            resource_viewport_y = 0
+          end
+          if self.viewport
+            self_viewport_z = self.viewport.z
+            self_viewport_y = self.viewport.y
+          else
+            self_viewport_z = 0
+            self_viewport_y = 0
+          end
+
+          return RGSS.resources.insert(index-1, self) if (
+          if self_viewport_z == resource_viewport_z
+            if self_viewport_y == resource_viewport_y
+              if (self.viewport.nil? and resource.viewport) or (self.viewport and resource.viewport and self.viewport.created_at < resource.viewport.created_at)
+                true
+              elsif (self.viewport and resource.viewport.nil?) or (self.viewport and resource.viewport and self.viewport.created_at > resource.viewport.created_at)
+                false
+              elsif self.z == resource.z
+                if self.y == resource.y
+                  self.created_at < resource.created_at
+                else
+                  self.y < resource.y
+                end
+              else
+                self.y < resource.y
+              end
+            else
+              self_viewport_y < resource_viewport_y
+            end
+          else
+            self_viewport_z < resource_viewport_z
+          end
+          )
+
+        }
+        RGSS.resources += [self]
+      end
+=end
+    end
+
+    def draw(destination=Graphics)
+      raise NotImplementedError
+    end
+
+  end
+end

data/lib/openrgss/rgsserror.rb

@@ -0,0 +1,7 @@
+# An exception class providing notifications of RGSS internal errors.
+#
+# Generated when, for instance, trying to access Bitmap or Sprite class objects that have already been freed.
+
+class RGSSError < StandardError
+
+end

data/lib/openrgss/rgssreset.rb

@@ -0,0 +1,7 @@
+# Exception class providing notifications for when the F12 key is pressed during game execution.
+#
+# Name changed from the hidden class Reset before RGSS2.
+
+class RGSSReset < Exception
+
+end

data/lib/openrgss/sprite.rb

@@ -0,0 +1,135 @@
+# The sprite class. Sprites are the basic concept used to display characters and other objects on the game screen.
+
+class Sprite
+  # Refers to the bitmap (Bitmap) used for the sprite's starting point.
+  attr_accessor :bitmap
+
+  # The box (Rect) taken from a bitmap.
+  attr_accessor :src_rect
+
+
+  # Refers to the viewport (Viewport) associated with the sprite.
+  attr_accessor :viewport
+
+  # The x-coordinate of the sprite's starting point.
+  attr_accessor :ox
+
+  # The y-coordinate of the sprite's starting point.
+  attr_accessor :oy
+
+  # The sprite's x-axis zoom level. 1.0 denotes actual pixel size.
+  attr_accessor :zoom_x
+
+  # The sprite's y-axis zoom level. 1.0 denotes actual pixel size.
+  attr_accessor :zoom_y
+
+  # The sprite's angle of rotation. Specifies up to 360 degrees of counterclockwise rotation. However, drawing a rotated sprite is time-consuming, so avoid overuse.
+  attr_accessor :angle
+
+  # Defines the amplitude, frequency, speed, and phase of the wave effect. A raster scroll effect is achieved by using a sinusoidal function to draw the sprite with each line's horizontal position slightly different from the last.
+  #
+  # wave_amp is the wave amplitude and wave_length is the wave frequency, and each is specified by a number of pixels.
+  #
+  # wave_speed specifies the speed of the wave animation. The default is 360, and the larger the value, the faster the effect.
+  #
+  # wave_phase specifies the phase of the top line of the sprite using an angle of up to 360 degrees. This is updated each time the update method is called. It is not necessary to use this property unless it is required for two sprites to have their wave effects synchronized.
+  attr_accessor :wave_amp
+  attr_accessor :wave_length
+  attr_accessor :wave_speed
+  attr_accessor :wave_phase
+
+  # A flag denoting the sprite has been flipped horizontally. If TRUE, the sprite will be drawn flipped. The default is false.
+  attr_accessor :mirror
+
+  # The bush depth and opacity of a sprite. This can be used to represent a situation such as the character's legs being hidden by bushes.
+  #
+  # For bush_depth, the number of pixels for the bush section is specified. The default value is 0.
+  #
+  # For bush_opacity, the opacity of the bush section from 0 to 255 is specified. Out-of-range values will be corrected automatically. The default value is 128.
+  #
+  # The bush_opacity value will be multiplied by opacity. For example, if both opacity and bush_opacity are set to 128, it will be handled as a transparency on # top of a transparency, for an actual opacity of 64.
+  attr_accessor :bush_depth
+  attr_accessor :bush_opacity
+
+  # The sprite's opacity (0-255). Out-of-range values are automatically corrected.
+  attr_accessor :opacity
+
+  # The sprite's blending mode (0: normal, 1: addition, 2: subtraction).
+  attr_accessor :blend_type
+
+  # The color (Color) to be blended with the sprite. Alpha values are used in the blending ratio.
+  #
+  # Handled separately from the color blended into a flash effect. However, the color with the higher alpha value when displayed will have the higher priority when blended.
+  attr_accessor :color
+
+  # The sprite's color tone (Tone).
+  attr_accessor :tone
+
+  include RGSS::Drawable
+
+  # Creates a new sprite object. Specifies a viewport (Viewport) when necessary.
+
+  def initialize(viewport=nil)
+    @src_rect = Rect.new(0, 0, 0, 0)
+    @x        = 0
+    @y        = 0
+    @z        = 0
+    @ox       = 0
+    @oy       = 0
+    @zoom_x   = 1
+    @zoom_y   = 1
+    @angle    = 0
+    @src_rect = Rect.new
+    @color    = Color.new
+    @tone     = Tone.new
+    @opacity  = 255
+    @visible  = true
+    super(viewport)
+  end
+
+  def bitmap=(bitmap)
+    @src_rect.set(0, 0, bitmap.width, bitmap.height) if bitmap
+    @bitmap = bitmap
+  end
+
+  # Begins flashing the sprite. duration specifies the number of frames flashing will last.
+  #
+  # If color is set to nil, the sprite will disappear while flashing.
+
+  def flash(color, duration)
+
+  end
+
+  # Advances the sprite flash or wave phase. As a general rule, this method is called once per frame.
+  #
+  # It is not necessary to call this if a flash or wave is not needed.
+
+  def update
+
+  end
+
+  # Gets the width of the sprite. Equivalent to src_rect.width.
+  def width
+    bitmap.width
+  end
+
+  # Gets the height of the sprite. Equivalent to src_rect.height.
+  def height
+    bitmap.height
+  end
+
+  def draw(destination=Graphics)
+    return unless bitmap and opacity > 0
+
+    base_x = @x-@ox
+    base_y = @y-@oy
+    if viewport
+      destination.entity.set_clip_rect(viewport.rect.x, viewport.rect.y, viewport.rect.width, viewport.rect.height)
+      base_x += viewport.rect.x - viewport.ox
+      base_y += viewport.rect.y - viewport.oy
+    end
+
+    SDL::Surface.blit(@bitmap.entity, @src_rect.x, @src_rect.y, @src_rect.width, @src_rect.height, destination.entity, base_x, base_y)
+    destination.entity.set_clip_rect(0, 0, destination.width, destination.height) if viewport
+  end
+end