rgss_db 1.0.0

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # The data class for enemy troops.
+  #
+  class Troop
+    #
+    # The data class for battle events (pages).
+    #
+    class Page
+      #
+      # The data class of battle event [Conditions].
+      #
+      class Condition
+        include RgssDb::Jsonable
+        extend RgssDb::JsonableConstructor
+
+        def initialize
+          @turn_ending = false
+          @turn_valid = false
+          @enemy_valid = false
+          @actor_valid = false
+          @switch_valid = false
+          @turn_a = 0
+          @turn_b = 0
+          @enemy_index = 0
+          @enemy_hp = 50
+          @actor_id = 1
+          @actor_hp = 50
+          @switch_id = 1
+        end
+
+        attr_accessor :turn_ending, :turn_valid, :enemy_valid, :actor_valid, :switch_valid,
+                      :turn_a, :turn_b, :enemy_index, :enemy_hp, :actor_id, :actor_hp, :switch_id
+      end
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # The Superclass of Skill and Item.
+  #
+  class UsableItem < BaseItem
+    include RgssDb::Jsonable
+    extend RgssDb::JsonableConstructor
+
+    def initialize
+      super
+      @scope = 0
+      @occasion = 0
+      @speed = 0
+      @success_rate = 100
+      @repeats = 1
+      @tp_gain = 0
+      @hit_type = 0
+      @animation_id = 0
+      @damage = RPG::UsableItem::Damage.new
+      @effects = []
+    end
+
+    def for_opponent?
+      [1, 2, 3, 4, 5, 6].include?(@scope)
+    end
+
+    def for_friend?
+      [7, 8, 9, 10, 11].include?(@scope)
+    end
+
+    def for_dead_friend?
+      [9, 10].include?(@scope)
+    end
+
+    def for_user?
+      @scope == 11
+    end
+
+    def for_one?
+      [1, 3, 7, 9, 11].include?(@scope)
+    end
+
+    def for_random?
+      [3, 4, 5, 6].include?(@scope)
+    end
+
+    def number_of_targets
+      for_random? ? @scope - 2 : 0
+    end
+
+    def for_all?
+      [2, 8, 10].include?(@scope)
+    end
+
+    def need_selection?
+      [1, 7, 9].include?(@scope)
+    end
+
+    def battle_ok?
+      [0, 1].include?(@occasion)
+    end
+
+    def menu_ok?
+      [0, 2].include?(@occasion)
+    end
+
+    def certain?
+      @hit_type == 0
+    end
+
+    def physical?
+      @hit_type == 1
+    end
+
+    def magical?
+      @hit_type == 2
+    end
+
+    attr_accessor :scope, :occasion, :speed, :animation_id, :success_rate,
+                  :repeats, :tp_gain, :hit_type, :damage, :effects
+  end
+end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # The Superclass of Skill and Item.
+  #
+  class UsableItem < BaseItem
+    #
+    # The data inner class for damage.
+    #
+    class Damage
+      include RgssDb::Jsonable
+      extend RgssDb::JsonableConstructor
+
+      def initialize
+        @type = 0
+        @element_id = 0
+        @formula = "0"
+        @variance = 20
+        @critical = false
+      end
+
+      def none?
+        @type == 0
+      end
+
+      def to_hp?
+        [1, 3, 5].include?(@type)
+      end
+
+      def to_mp?
+        [2, 4, 6].include?(@type)
+      end
+
+      def recover?
+        [3, 4].include?(@type)
+      end
+
+      def drain?
+        [5, 6].include?(@type)
+      end
+
+      def sign
+        recover? ? -1 : 1
+      end
+
+      def eval(a, b, v)
+        [Kernel.eval(@formula), 0].max * sign
+      rescue StandardError
+        0
+      end
+
+      attr_accessor :type, :element_id, :formula, :variance, :critical
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # The Superclass of Skill and Item.
+  #
+  class UsableItem < BaseItem
+    #
+    # The data inner class for use effects.
+    #
+    class Effect
+      include RgssDb::Jsonable
+      extend RgssDb::JsonableConstructor
+
+      def initialize(code = 0, data_id = 0, value1 = 0, value2 = 0)
+        @code = code
+        @data_id = data_id
+        @value1 = value1
+        @value2 = value2
+      end
+
+      attr_accessor :code, :data_id, :value1, :value2
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # The data class for weapons.
+  #
+  class Weapon < EquipItem
+    include RgssDb::Jsonable
+    extend RgssDb::JsonableConstructor
+
+    def initialize
+      super
+      @wtype_id = 0
+      @animation_id = 0
+      @features.push(RPG::BaseItem::Feature.new(31, 1, 0))
+      @features.push(RPG::BaseItem::Feature.new(22, 0, 0))
+    end
+
+    def performance
+      params[2] + params[4] + params.inject(0) { |r, v| r += v }
+    end
+
+    attr_accessor :wtype_id, :animation_id
+  end
+end

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# Application mixins
+require_relative "../../mixins/jsonable"
+require_relative "../../mixins/jsonable_constructor"
+
+# RPGVXAce Data Structures (RPGVXAce.chm::/rgss/g_rpg_data.html)
+require_relative "./rpg/map"
+require_relative "./rpg/map_encounter"
+require_relative "./rpg/map_info"
+
+require_relative "./rpg/event"
+require_relative "./rpg/event_page"
+require_relative "./rpg/event_page_condition"
+require_relative "./rpg/event_page_graphic"
+
+require_relative "./rpg/event_command"
+
+require_relative "./rpg/move_route"
+require_relative "./rpg/move_command"
+
+require_relative "./rpg/base_item"
+require_relative "./rpg/actor"
+require_relative "./rpg/class"
+require_relative "./rpg/usable_item"
+require_relative "./rpg/skill"
+require_relative "./rpg/item"
+require_relative "./rpg/equip_item"
+require_relative "./rpg/weapon"
+require_relative "./rpg/armor"
+require_relative "./rpg/enemy"
+require_relative "./rpg/state"
+
+require_relative "./rpg/base_item_feature"
+
+require_relative "./rpg/usable_item_damage"
+require_relative "./rpg/usable_item_effect"
+
+require_relative "./rpg/class_learning"
+
+require_relative "./rpg/enemy_drop_item"
+require_relative "./rpg/enemy_action"
+
+require_relative "./rpg/troop"
+require_relative "./rpg/troop_member"
+require_relative "./rpg/troop_page"
+require_relative "./rpg/troop_page_condition"
+
+require_relative "./rpg/animation"
+require_relative "./rpg/animation_frame"
+require_relative "./rpg/animation_timing"
+
+require_relative "./rpg/tileset"
+
+require_relative "./rpg/common_event"
+
+require_relative "./rpg/system"
+require_relative "./rpg/system_vehicle"
+require_relative "./rpg/system_terms"
+require_relative "./rpg/system_test_battler"
+
+require_relative "./rpg/audio_file"
+require_relative "./rpg/bgm"
+require_relative "./rpg/bgs"
+require_relative "./rpg/me"
+require_relative "./rpg/se"

data/lib/rgss_db/model/rpg_maker_data/xp/rgss/color.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+#
+# The RGBA color class.
+#
+# Each component is handled with a floating-point value (Float).
+#
+class Color
+  include RgssDb::Jsonable
+  extend RgssDb::JsonableConstructor
+
+  #
+  # Creates a Color object. If alpha is omitted, it is assumed to be 255.
+  #
+  # The default values when no arguments are specified are (0, 0, 0, 0).
+  #
+  # @param red [Integer]
+  # @param green [Integer]
+  # @param blue [Integer]
+  # @param alpha [Integer]
+  #
+  def initialize(red = 0, green = 0, blue = 0, alpha = 0)
+    @red = red
+    @green = green
+    @blue = blue
+    @alpha = [red, green, blue].sum.positive? && alpha.zero? ? 255 : alpha
+  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, @alpha].pack("dddd")
+  end
+
+  #
+  # Creates a new instance using the given binary data
+  #
+  # Note: needed for Marshal module support
+  #
+  # @param serialized_string [String]
+  #
+  # @return [Color]
+  #
+  def self._load(serialized_string)
+    Color.new_serialized(serialized_string)
+  end
+
+  #
+  # Creates a new instance from a serialized string
+  #
+  # Note: needed for Marshal module support
+  #
+  # @param serialized_string [String]
+  #
+  # @return [Color]
+  #
+  def self.new_serialized(serialized_string)
+    # double, double, double, double (double-precision)
+    red, green, blue, alpha = serialized_string.unpack("dddd")
+
+    # Creates the instance
+    Color.new(red, green, blue, alpha)
+  end
+
+  attr_accessor :red, :green, :blue, :alpha
+end

data/lib/rgss_db/model/rpg_maker_data/xp/rgss/rect.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+#
+# The rectangle class.
+#
+class Rect
+  include RgssDb::Jsonable
+  extend RgssDb::JsonableConstructor
+
+  #
+  # Creates a new Rect object.
+  #
+  # The default values when no arguments are specified are (0, 0, 0, 0).
+  #
+  # @param x [Integer]
+  # @param y [Integer]
+  # @param width [Integer]
+  # @param height [Integer]
+  #
+  def initialize(x = 0, y = 0, width = 0, height = 0)
+    @x = x
+    @y = y
+    @width = width
+    @height = height
+  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
+    [@x, @y, @width, @height].pack("llll")
+  end
+
+  #
+  # Creates a new instance using the given binary data
+  #
+  # Note: needed for Marshal module support
+  #
+  # @param serialized_string [String]
+  #
+  # @return [Rect]
+  #
+  def self._load(serialized_string)
+    Rect.new_serialized(serialized_string)
+  end
+
+  #
+  # Creates a new instance from a serialized string
+  #
+  # Note: needed for Marshal module support
+  #
+  # @param serialized_string [String]
+  #
+  # @return [Rect]
+  #
+  def self.new_serialized(serialized_string)
+    # int32_t, int32_t, int32_t, int32_t
+    x, y, width, height = serialized_string.unpack("llll")
+
+    # Creates the instance
+    Rect.new(x, y, width, height)
+  end
+
+  attr_accessor :x, :y, :width, :height
+end

data/lib/rgss_db/model/rpg_maker_data/xp/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/xp/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/xp/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/xp/rpg/actor.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # Data class for actors.
+  #
+  class Actor
+    include RgssDb::Jsonable
+    extend RgssDb::JsonableConstructor
+
+    def initialize
+      @id = 0
+      @name = ""
+      @class_id = 1
+      @initial_level = 1
+      @final_level = 99
+      @exp_basis = 30
+      @exp_inflation = 30
+      @character_name = ""
+      @character_hue = 0
+      @battler_name = ""
+      @battler_hue = 0
+      @parameters = Table.new(6, 100)
+      @weapon_id = 0
+      @armor1_id = 0
+      @armor2_id = 0
+      @armor3_id = 0
+      @armor4_id = 0
+      @weapon_fix = false
+      @armor1_fix = false
+      @armor2_fix = false
+      @armor3_fix = false
+      @armor4_fix = false
+    end
+
+    def to_s
+      @name.to_s
+    end
+
+    attr_accessor :id, :name, :class_id, :initial_level, :final_level, :exp_basis, :exp_inflation, :character_name,
+                  :character_hue, :battler_name, :battler_hue, :parameters, :weapon_id, :armor1_id, :armor2_id,
+                  :armor3_id, :armor4_id, :weapon_fix, :armor1_fix, :armor2_fix, :armor3_fix, :armor4_fix
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # Data class for animation.
+  #
+  class Animation
+    include RgssDb::Jsonable
+    extend RgssDb::JsonableConstructor
+
+    def initialize
+      @id = 0
+      @name = ""
+      @animation_name = ""
+      @animation_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, :animation_name, :animation_hue, :position, :frame_max, :frames, :timings
+  end
+end