rgss_db 1.0.0

data/lib/rgss_db/model/rpg_maker_data/vx_ace/rgss/table.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+#
+# The multidimensional array class.
+#
+# Each element is an integer of 2 signed bytes ranging from -32,768 to 32,767.
+#
+class Table
+  include RgssDb::Jsonable
+  extend RgssDb::JsonableConstructor
+
+  #
+  # Creates a Table object.
+  #
+  # Specifies the size of each dimension in the multidimensional array. 1-, 2-, and 3-dimensional arrays are possible.
+  #
+  # Arrays with no parameters are also permitted.
+  #
+  # @param xsize [Integer]
+  # @param ysize [Integer]
+  # @param zsize [Integer]
+  #
+  def initialize(xsize, ysize = 0, zsize = 0)
+    # RMXP needs dimensions
+    @dim = 1
+    @dim = 2 if ysize.positive?
+    @dim = 3 if zsize.positive?
+    @x = xsize
+    @y = ysize
+    @z = zsize
+    @data = []
+  end
+
+  #
+  # Dumps this instance into a binary string
+  #
+  # Note: needed for Marshal module support
+  #
+  # @return [String]
+  #
+  def _dump(*)
+    # int32_t, int32_t, int32_t, int32_t, int32_t, int16_t *
+    [@dim, @x, @y, @z, @x * @y * @z, *@data].pack("llllls*")
+  end
+
+  #
+  # Creates a new instance using the given binary data
+  #
+  # Note: needed for Marshal module support
+  #
+  # @param serialized_string [String]
+  #
+  # @return [Table]
+  #
+  def self._load(serialized_string)
+    Table.new_serialized(serialized_string)
+  end
+
+  #
+  # Creates a new instance from a serialized string
+  #
+  # Note: needed for Marshal module support
+  #
+  # @param serialized_string [String]
+  #
+  # @return [Table]
+  #
+  def self.new_serialized(serialized_string)
+    # int32_t, int32_t, int32_t, int32_t, int32_t, int16_t *
+    dim, x, y, z, size, *data = serialized_string.unpack("llllls*")
+
+    # Checks if written size value matches the actual size of the table
+    raise "Table: bad file format (size mismatch)" unless size == (x * y * z)
+    # Double check no data was lost
+    raise "Table: bad file format (data length mismatch)" unless size == data.length
+
+    # Creates the instance
+    table = Table.new(0, 0, 0)
+    table.dim = dim
+    table.x = x
+    table.y = y
+    table.z = z
+    table.data = data
+    table
+  end
+
+  #
+  # Returns a table instance for JSON deserialization
+  #
+  # @param args [Array]
+  #
+  # @return [Table]
+  #
+  def self.json_new(*args)
+    Table.new(0, 0, 0)
+  end
+
+  attr_accessor :dim, :x, :y, :z, :data
+end

data/lib/rgss_db/model/rpg_maker_data/vx_ace/rgss/tone.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+#
+# The color tone class.
+#
+# Each component is handled with a floating-point value (Float).
+#
+class Tone
+  include RgssDb::Jsonable
+  extend RgssDb::JsonableConstructor
+
+  #
+  # Creates a Tone object. If gray is omitted, it is assumed to be 0.
+  #
+  # The default values when no arguments are specified are (0, 0, 0, 0).
+  #
+  # @param red [Integer]
+  # @param green [Integer]
+  # @param blue [Integer]
+  # @param gray [Integer]
+  #
+  def initialize(red = 0, green = 0, blue = 0, gray = 0)
+    @red = red
+    @green = green
+    @blue = blue
+    @gray = gray
+  end
+
+  #
+  # Dumps this instance into a binary string
+  #
+  # Note: needed for Marshal module support
+  #
+  # @return [String]
+  #
+  def _dump(*)
+    # double, double, double, double (double-precision)
+    [@red, @green, @blue, @gray].pack("dddd")
+  end
+
+  #
+  # Creates a new instance using the given binary data
+  #
+  # Note: needed for Marshal module support
+  #
+  # @param serialized_string [String]
+  #
+  # @return [Tone]
+  #
+  def self._load(serialized_string)
+    Tone.new_serialized(serialized_string)
+  end
+
+  #
+  # Creates a new instance from a serialized string
+  #
+  # Note: needed for Marshal module support
+  #
+  # @param serialized_string [String]
+  #
+  # @return [Tone]
+  #
+  def self.new_serialized(serialized_string)
+    # double, double, double, double (double-precision)
+    red, green, blue, gray = serialized_string.unpack("dddd")
+
+    # Creates the instance
+    Tone.new(red, green, blue, gray)
+  end
+
+  attr_accessor :red, :green, :blue, :gray
+end

data/lib/rgss_db/model/rpg_maker_data/vx_ace/rgss.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Application mixins
+require_relative "../../mixins/jsonable"
+require_relative "../../mixins/jsonable_constructor"
+
+# RGSS Impl.
+require_relative "./rgss/color"
+require_relative "./rgss/rect"
+require_relative "./rgss/table"
+require_relative "./rgss/tone"

data/lib/rgss_db/model/rpg_maker_data/vx_ace/rpg/actor.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # The data class for actors.
+  #
+  class Actor < BaseItem
+    include RgssDb::Jsonable
+    extend RgssDb::JsonableConstructor
+
+    def initialize
+      super
+      @nickname = ""
+      @class_id = 1
+      @initial_level = 1
+      @max_level = 99
+      @character_name = ""
+      @character_index = 0
+      @face_name = ""
+      @face_index = 0
+      @equips = [0, 0, 0, 0, 0]
+    end
+
+    attr_accessor :nickname, :class_id, :initial_level, :max_level, :character_name, :character_index, :face_name,
+                  :face_index, :equips
+  end
+end

data/lib/rgss_db/model/rpg_maker_data/vx_ace/rpg/animation.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # The data class for animation.
+  #
+  class Animation
+    include RgssDb::Jsonable
+    extend RgssDb::JsonableConstructor
+
+    def initialize
+      @id = 0
+      @name = ""
+      @animation1_name = ""
+      @animation1_hue = 0
+      @animation2_name = ""
+      @animation2_hue = 0
+      @position = 1
+      @frame_max = 1
+      @frames = [RPG::Animation::Frame.new]
+      @timings = []
+    end
+
+    def to_s
+      @name.to_s
+    end
+
+    attr_accessor :id, :name, :animation1_name, :animation1_hue, :animation2_name,
+                  :animation2_hue, :position, :frame_max, :frames, :timings
+  end
+end

data/lib/rgss_db/model/rpg_maker_data/vx_ace/rpg/animation_frame.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # The data class for animation.
+  #
+  class Animation
+    #
+    # The data class for animation frames.
+    #
+    class Frame
+      include RgssDb::Jsonable
+      extend RgssDb::JsonableConstructor
+
+      def initialize
+        @cell_max = 0
+        @cell_data = Table.new(0, 0)
+      end
+
+      attr_accessor :cell_max, :cell_data
+    end
+  end
+end

data/lib/rgss_db/model/rpg_maker_data/vx_ace/rpg/animation_timing.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # The data class for animation.
+  #
+  class Animation
+    #
+    # The data class for the timing of an animation's SE and flash effects.
+    #
+    class Timing
+      include RgssDb::Jsonable
+      extend RgssDb::JsonableConstructor
+
+      def initialize
+        @frame = 0
+        @se = RPG::SE.new("", 80)
+        @flash_scope = 0
+        @flash_color = Color.new(255, 255, 255, 255)
+        @flash_duration = 5
+      end
+
+      attr_accessor :frame, :se, :flash_scope, :flash_color, :flash_duration
+    end
+  end
+end

data/lib/rgss_db/model/rpg_maker_data/vx_ace/rpg/armor.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # The data class for armor.
+  #
+  class Armor < EquipItem
+    include RgssDb::Jsonable
+    extend RgssDb::JsonableConstructor
+
+    def initialize
+      super
+      @atype_id = 0
+      @etype_id = 1
+      @features.push(RPG::BaseItem::Feature.new(22, 1, 0))
+    end
+
+    attr_accessor :atype_id
+  end
+end

data/lib/rgss_db/model/rpg_maker_data/vx_ace/rpg/audio_file.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # A superclass of BGM, BGS, ME, and SE.
+  #
+  class AudioFile
+    include RgssDb::Jsonable
+    extend RgssDb::JsonableConstructor
+
+    def initialize(name = "", volume = 100, pitch = 100)
+      @name = name
+      @volume = volume
+      @pitch = pitch
+    end
+
+    def to_s
+      @name.to_s
+    end
+
+    attr_accessor :name, :volume, :pitch
+  end
+end

data/lib/rgss_db/model/rpg_maker_data/vx_ace/rpg/base_item.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+#
+# RPG classes module
+#
+module RPG
+  #
+  # A superclass of actor, class, skill, item, weapon, armor, enemy, and state.
+  #
+  # Some items are unnecessary depending on the type of data, but they are included for convenience sake.
+  #
+  class BaseItem
+    include RgssDb::Jsonable
+    extend RgssDb::JsonableConstructor
+
+    def initialize
+      @id = 0
+      @name = ""
+      @icon_index = 0
+      @description = ""
+      @features = []
+      @note = ""
+    end
+
+    def to_s
+      @name.to_s
+    end
+
+    attr_accessor :id, :name, :icon_index, :description, :features, :note
+  end
+end

data/lib/rgss_db/model/rpg_maker_data/vx_ace/rpg/base_item_feature.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+#
+# RPG classes module
+#
+module RPG
+  #
+  # A superclass of actor, class, skill, item, weapon, armor, enemy, and state.
+  #
+  # Some items are unnecessary depending on the type of data, but they are included for convenience sake.
+  #
+  class BaseItem
+    #
+    # The data inner class for features.
+    #
+    class Feature
+      include RgssDb::Jsonable
+      extend RgssDb::JsonableConstructor
+
+      def initialize(code = 0, data_id = 0, value = 0)
+        @code = code
+        @data_id = data_id
+        @value = value
+      end
+
+      attr_accessor :code, :data_id, :value
+    end
+  end
+end

data/lib/rgss_db/model/rpg_maker_data/vx_ace/rpg/bgm.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # The data class for BGM. This class has functionality for playing itself using an Audio module.
+  #
+  class BGM < AudioFile
+    include RgssDb::Jsonable
+    extend RgssDb::JsonableConstructor
+
+    @@last = RPG::BGM.new
+    def play(pos = 0)
+      if @name.empty?
+        Audio.bgm_stop
+        @@last = RPG::BGM.new
+      else
+        Audio.bgm_play("Audio/BGM/" + @name, @volume, @pitch, pos)
+        @@last = clone
+      end
+    end
+
+    def replay
+      play(@pos)
+    end
+
+    def self.stop
+      Audio.bgm_stop
+      @@last = RPG::BGM.new
+    end
+
+    def self.fade(time)
+      Audio.bgm_fade(time)
+      @@last = RPG::BGM.new
+    end
+
+    def self.last
+      @@last.pos = Audio.bgm_pos
+      @@last
+    end
+
+    attr_accessor :pos
+  end
+end

data/lib/rgss_db/model/rpg_maker_data/vx_ace/rpg/bgs.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # The data class for BGS. This class has functionality for playing itself using an Audio module.
+  #
+  class BGS < AudioFile
+    include RgssDb::Jsonable
+    extend RgssDb::JsonableConstructor
+
+    @@last = RPG::BGS.new
+    def play(pos = 0)
+      if @name.empty?
+        Audio.bgs_stop
+        @@last = RPG::BGS.new
+      else
+        Audio.bgs_play("Audio/BGS/" + @name, @volume, @pitch, pos)
+        @@last = clone
+      end
+    end
+
+    def replay
+      play(@pos)
+    end
+
+    def self.stop
+      Audio.bgs_stop
+      @@last = RPG::BGS.new
+    end
+
+    def self.fade(time)
+      Audio.bgs_fade(time)
+      @@last = RPG::BGS.new
+    end
+
+    def self.last
+      @@last.pos = Audio.bgs_pos
+      @@last
+    end
+
+    attr_accessor :pos
+  end
+end

data/lib/rgss_db/model/rpg_maker_data/vx_ace/rpg/class.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # The data class for class.
+  #
+  class Class < BaseItem
+    include RgssDb::Jsonable
+    extend RgssDb::JsonableConstructor
+
+    def initialize
+      super
+      @exp_params = [30, 20, 30, 30]
+      @params = Table.new(8, 100)
+      @learnings = []
+      @features.push(RPG::BaseItem::Feature.new(23, 0, 1))
+      @features.push(RPG::BaseItem::Feature.new(22, 0, 0.95))
+      @features.push(RPG::BaseItem::Feature.new(22, 1, 0.05))
+      @features.push(RPG::BaseItem::Feature.new(22, 2, 0.04))
+      @features.push(RPG::BaseItem::Feature.new(41, 1))
+      @features.push(RPG::BaseItem::Feature.new(51, 1))
+      @features.push(RPG::BaseItem::Feature.new(52, 1))
+    end
+
+    def exp_for_level(level)
+      lv = level.to_f
+      basis = @exp_params[0].to_f
+      extra = @exp_params[1].to_f
+      acc_a = @exp_params[2].to_f
+      acc_b = @exp_params[3].to_f
+      (basis * ((lv - 1)**(0.9 + acc_a / 250)) * lv * (lv + 1) / (6 + lv**2 / 50 / acc_b) + (lv - 1) * extra)
+        .round.to_i
+    end
+
+    attr_accessor :exp_params, :params, :learnings
+  end
+end

data/lib/rgss_db/model/rpg_maker_data/vx_ace/rpg/class_learning.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # The data class for class.
+  #
+  class Class < BaseItem
+    #
+    # The data class for a class's [Skills to Learn].
+    #
+    class Learning
+      include RgssDb::Jsonable
+      extend RgssDb::JsonableConstructor
+
+      def initialize
+        @level = 1
+        @skill_id = 1
+        @note = ""
+      end
+
+      attr_accessor :level, :skill_id, :note
+    end
+  end
+end

data/lib/rgss_db/model/rpg_maker_data/vx_ace/rpg/common_event.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # The data class for common events.
+  #
+  class CommonEvent
+    include RgssDb::Jsonable
+    extend RgssDb::JsonableConstructor
+
+    def initialize
+      @id = 0
+      @name = ""
+      @trigger = 0
+      @switch_id = 1
+      @list = [RPG::EventCommand.new]
+    end
+
+    def autorun?
+      @trigger == 1
+    end
+
+    def parallel?
+      @trigger == 2
+    end
+
+    def to_s
+      @name.to_s
+    end
+
+    attr_accessor :id, :name, :trigger, :switch_id, :list
+  end
+end

data/lib/rgss_db/model/rpg_maker_data/vx_ace/rpg/enemy.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # The data class for enemies.
+  #
+  class Enemy < BaseItem
+    include RgssDb::Jsonable
+    extend RgssDb::JsonableConstructor
+
+    def initialize
+      super
+      @battler_name = ""
+      @battler_hue = 0
+      @params = [100, 0, 10, 10, 10, 10, 10, 10]
+      @exp = 0
+      @gold = 0
+      @drop_items = Array.new(3) { RPG::Enemy::DropItem.new }
+      @actions = [RPG::Enemy::Action.new]
+      @features.push(RPG::BaseItem::Feature.new(22, 0, 0.95))
+      @features.push(RPG::BaseItem::Feature.new(22, 1, 0.05))
+      @features.push(RPG::BaseItem::Feature.new(31, 1, 0))
+    end
+
+    attr_accessor :battler_name, :battler_hue, :params, :exp, :gold, :drop_items, :actions
+  end
+end

data/lib/rgss_db/model/rpg_maker_data/vx_ace/rpg/enemy_action.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # The data class for enemies.
+  #
+  class Enemy < BaseItem
+    #
+    # The data class for enemy [Actions].
+    #
+    class Action
+      include RgssDb::Jsonable
+      extend RgssDb::JsonableConstructor
+
+      def initialize
+        @skill_id = 1
+        @condition_type = 0
+        @condition_param1 = 0
+        @condition_param2 = 0
+        @rating = 5
+      end
+
+      attr_accessor :skill_id, :condition_type, :condition_param1, :condition_param2, :rating
+    end
+  end
+end

data/lib/rgss_db/model/rpg_maker_data/vx_ace/rpg/enemy_drop_item.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # The data class for enemies.
+  #
+  class Enemy < BaseItem
+    #
+    # The data class for enemy [Drop Items].
+    #
+    class DropItem
+      include RgssDb::Jsonable
+      extend RgssDb::JsonableConstructor
+
+      def initialize
+        @kind = 0
+        @data_id = 1
+        @denominator = 1
+      end
+
+      attr_accessor :kind, :data_id, :denominator
+    end
+  end
+end

data/lib/rgss_db/model/rpg_maker_data/vx_ace/rpg/equip_item.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # A superclass of weapons and armor.
+  #
+  class EquipItem < BaseItem
+    include RgssDb::Jsonable
+    extend RgssDb::JsonableConstructor
+
+    def initialize
+      super
+      @price = 0
+      @etype_id = 0
+      @params = [0] * 8
+    end
+    attr_accessor :price, :etype_id, :params
+  end
+end