rgss_db 1.0.0

data/lib/rgss_db/model/rpg_maker_data/vx/rpg/move_route.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # Data class for the Move route.
+  #
+  class MoveRoute
+    include RgssDb::Jsonable
+    extend RgssDb::JsonableConstructor
+
+    def initialize
+      @repeat = true
+      @skippable = false
+      @wait = false
+      @list = [RPG::MoveCommand.new]
+    end
+
+    attr_accessor :repeat, :skippable, :wait, :list
+  end
+end

data/lib/rgss_db/model/rpg_maker_data/vx/rpg/se.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # Data class for SE. This class has a method to play oneself with Audio module.
+  #
+  class SE < AudioFile
+    include RgssDb::Jsonable
+    extend RgssDb::JsonableConstructor
+
+    def play
+      return if @name.empty?
+
+      Audio.se_play("Audio/SE/" + @name, @volume, @pitch)
+    end
+
+    def self.stop
+      Audio.se_stop
+    end
+  end
+end

data/lib/rgss_db/model/rpg_maker_data/vx/rpg/skill.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # Data class for skills.
+  #
+  class Skill < UsableItem
+    include RgssDb::Jsonable
+    extend RgssDb::JsonableConstructor
+
+    def initialize
+      super
+      @scope = 1
+      @mp_cost = 0
+      @hit = 100
+      @message1 = ""
+      @message2 = ""
+    end
+
+    attr_accessor :mp_cost, :hit, :message1, :message2
+  end
+end

data/lib/rgss_db/model/rpg_maker_data/vx/rpg/state.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # Data class for state.
+  #
+  class State
+    include RgssDb::Jsonable
+    extend RgssDb::JsonableConstructor
+
+    def initialize
+      @id = 0
+      @name = ""
+      @icon_index = 0
+      @restriction = 0
+      @priority = 5
+      @atk_rate = 100
+      @def_rate = 100
+      @spi_rate = 100
+      @agi_rate = 100
+      @nonresistance = false
+      @offset_by_opposite = false
+      @slip_damage = false
+      @reduce_hit_ratio = false
+      @battle_only = true
+      @release_by_damage = false
+      @hold_turn = 0
+      @auto_release_prob = 0
+      @message1 = ""
+      @message2 = ""
+      @message3 = ""
+      @message4 = ""
+      @element_set = []
+      @state_set = []
+      @note = ""
+    end
+
+    def to_s
+      @name.to_s
+    end
+
+    attr_accessor :id, :name, :icon_index, :restriction, :priority, :atk_rate, :def_rate, :spi_rate, :agi_rate,
+                  :nonresistance, :offset_by_opposite, :slip_damage, :reduce_hit_ratio, :battle_only,
+                  :release_by_damage, :hold_turn, :auto_release_prob, :message1, :message2,
+                  :message3, :message4, :element_set, :state_set, :note
+  end
+end

data/lib/rgss_db/model/rpg_maker_data/vx/rpg/system.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # Data class for the system.
+  #
+  class System
+    include RgssDb::Jsonable
+    extend RgssDb::JsonableConstructor
+
+    def initialize
+      @game_title = ""
+      @version_id = 0
+      @party_members = [1]
+      @elements = [nil, ""]
+      @switches = [nil, ""]
+      @variables = [nil, ""]
+      @passages = Table.new(8192)
+      @boat = RPG::System::Vehicle.new
+      @ship = RPG::System::Vehicle.new
+      @airship = RPG::System::Vehicle.new
+      @title_bgm = RPG::BGM.new
+      @battle_bgm = RPG::BGM.new
+      @battle_end_me = RPG::ME.new
+      @gameover_me = RPG::ME.new
+      @sounds = []
+      20.times { @sounds.push(RPG::AudioFile.new) }
+      @test_battlers = []
+      @test_troop_id = 1
+      @start_map_id = 1
+      @start_x = 0
+      @start_y = 0
+      @terms = RPG::System::Terms.new
+      @battler_name = ""
+      @battler_hue = 0
+      @edit_map_id = 1
+    end
+
+    attr_accessor :game_title, :version_id, :party_members, :elements, :switches, :variables, :passages, :boat, :ship,
+                  :airship, :title_bgm, :battle_bgm, :battle_end_me, :gameover_me, :sounds, :test_battlers,
+                  :test_troop_id, :start_map_id, :start_x, :start_y, :terms, :battler_name, :battler_hue, :edit_map_id
+  end
+end

data/lib/rgss_db/model/rpg_maker_data/vx/rpg/system_terms.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module RPG
+  class System
+    #
+    # Data class for terminology.
+    #
+    class Terms
+      include RgssDb::Jsonable
+      extend RgssDb::JsonableConstructor
+
+      def initialize
+        @level = ""
+        @level_a = ""
+        @hp = ""
+        @hp_a = ""
+        @mp = ""
+        @mp_a = ""
+        @atk = ""
+        @def = ""
+        @spi = ""
+        @agi = ""
+        @weapon = ""
+        @armor1 = ""
+        @armor2 = ""
+        @armor3 = ""
+        @armor4 = ""
+        @weapon1 = ""
+        @weapon2 = ""
+        @attack = ""
+        @skill = ""
+        @guard = ""
+        @item = ""
+        @equip = ""
+        @status = ""
+        @save = ""
+        @game_end = ""
+        @fight = ""
+        @escape = ""
+        @new_game = ""
+        @continue = ""
+        @shutdown = ""
+        @to_title = ""
+        @cancel = ""
+        @gold = ""
+      end
+
+      attr_accessor :level, :level_a, :hp, :hp_a, :mp, :mp_a, :atk, :def, :spi, :agi, :weapon, :armor1, :armor2,
+                    :armor3, :armor4, :weapon1, :weapon2, :attack, :skill, :guard, :item, :equip, :status,
+                    :save, :game_end, :fight, :escape, :new_game, :continue, :shutdown, :to_title, :cancel, :gold
+    end
+  end
+end

data/lib/rgss_db/model/rpg_maker_data/vx/rpg/system_test_battler.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RPG
+  class System
+    #
+    # Data class for the battlers used in battle tests.
+    #
+    class TestBattler
+      include RgssDb::Jsonable
+      extend RgssDb::JsonableConstructor
+
+      def initialize
+        @actor_id = 1
+        @level = 1
+        @weapon_id = 0
+        @armor1_id = 0
+        @armor2_id = 0
+        @armor3_id = 0
+        @armor4_id = 0
+      end
+
+      attr_accessor :actor_id, :level, :weapon_id, :armor1_id, :armor2_id, :armor3_id, :armor4_id
+    end
+  end
+end

data/lib/rgss_db/model/rpg_maker_data/vx/rpg/system_vehicle.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RPG
+  class System
+    #
+    # Data class for vehicles.
+    #
+    class Vehicle
+      include RgssDb::Jsonable
+      extend RgssDb::JsonableConstructor
+
+      def initialize
+        @character_name = ""
+        @character_index = 0
+        @bgm = RPG::AudioFile.new
+        @start_map_id = 0
+        @start_x = 0
+        @start_y = 0
+      end
+
+      attr_accessor :character_name, :character_index, :bgm, :start_map_id, :start_x, :start_y
+    end
+  end
+end

data/lib/rgss_db/model/rpg_maker_data/vx/rpg/troop.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # Data class for troops.
+  #
+  class Troop
+    include RgssDb::Jsonable
+    extend RgssDb::JsonableConstructor
+
+    def initialize
+      @id = 0
+      @name = ""
+      @members = []
+      @pages = [RPG::Troop::Page.new]
+    end
+
+    def to_s
+      @name.to_s
+    end
+
+    attr_accessor :id, :name, :members, :pages
+  end
+end

data/lib/rgss_db/model/rpg_maker_data/vx/rpg/troop_member.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RPG
+  class Troop
+    #
+    # Data class for troop members.
+    #
+    class Member
+      include RgssDb::Jsonable
+      extend RgssDb::JsonableConstructor
+
+      def initialize
+        @enemy_id = 1
+        @x = 0
+        @y = 0
+        @hidden = false
+        @immortal = false
+      end
+
+      attr_accessor :enemy_id, :x, :y, :hidden, :immortal
+    end
+  end
+end

data/lib/rgss_db/model/rpg_maker_data/vx/rpg/troop_page.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RPG
+  class Troop
+    #
+    # Data class for battle events (pages).
+    #
+    class Page
+      include RgssDb::Jsonable
+      extend RgssDb::JsonableConstructor
+
+      def initialize
+        @condition = RPG::Troop::Page::Condition.new
+        @span = 0
+        @list = [RPG::EventCommand.new]
+      end
+
+      attr_accessor :condition, :span, :list
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module RPG
+  class Troop
+    class Page
+      #
+      # A database 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/rpg/usable_item.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # Superclass of Skill and Item.
+  #
+  class UsableItem < BaseItem
+    include RgssDb::Jsonable
+    extend RgssDb::JsonableConstructor
+
+    def initialize
+      super
+      @scope = 0
+      @occasion = 0
+      @speed = 0
+      @animation_id = 0
+      @common_event_id = 0
+      @base_damage = 0
+      @variance = 20
+      @atk_f = 0
+      @spi_f = 0
+      @physical_attack = false
+      @damage_to_mp = false
+      @absorb_damage = false
+      @ignore_defense = false
+      @element_set = []
+      @plus_state_set = []
+      @minus_state_set = []
+    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?
+      [11].include?(@scope)
+    end
+
+    def for_one?
+      [1, 3, 4, 7, 9, 11].include?(@scope)
+    end
+
+    def for_two?
+      [5].include?(@scope)
+    end
+
+    def for_three?
+      [6].include?(@scope)
+    end
+
+    def for_random?
+      [4, 5, 6].include?(@scope)
+    end
+
+    def for_all?
+      [2, 8, 10].include?(@scope)
+    end
+
+    def dual?
+      [3].include?(@scope)
+    end
+
+    def need_selection?
+      [1, 3, 7, 9].include?(@scope)
+    end
+
+    def battle_ok?
+      [0, 1].include?(@occasion)
+    end
+
+    def menu_ok?
+      [0, 2].include?(@occasion)
+    end
+
+    attr_accessor :scope, :occasion, :speed, :animation_id, :common_event_id, :base_damage, :variance, :atk_f, :spi_f,
+                  :physical_attack, :damage_to_mp, :absorb_damage, :ignore_defense, :element_set, :plus_state_set,
+                  :minus_state_set
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RPG
+  #
+  # Data class for weapons.
+  #
+  class Weapon < BaseItem
+    include RgssDb::Jsonable
+    extend RgssDb::JsonableConstructor
+
+    def initialize
+      super
+      @animation_id = 0
+      @price = 0
+      @hit = 95
+      @atk = 0
+      @def = 0
+      @spi = 0
+      @agi = 0
+      @two_handed = false
+      @fast_attack = false
+      @dual_attack = false
+      @critical_bonus = false
+      @element_set = []
+      @state_set = []
+    end
+
+    attr_accessor :animation_id, :price, :hit, :atk, :def, :spi, :agi, :two_handed, :fast_attack, :dual_attack,
+                  :critical_bonus, :element_set, :state_set
+  end
+end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# Application mixins
+require_relative "../../mixins/jsonable"
+require_relative "../../mixins/jsonable_constructor"
+
+# RPGVX Data Structures (RPGVX.chm::/rgss/g_rpg_data.html)
+require_relative "./rpg/map"
+require_relative "./rpg/map_info"
+require_relative "./rpg/area"
+
+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/actor"
+
+require_relative "./rpg/class"
+require_relative "./rpg/class_learning"
+
+require_relative "./rpg/base_item"
+require_relative "./rpg/usable_item"
+require_relative "./rpg/skill"
+require_relative "./rpg/item"
+require_relative "./rpg/weapon"
+require_relative "./rpg/armor"
+
+require_relative "./rpg/enemy"
+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/state"
+
+require_relative "./rpg/animation"
+require_relative "./rpg/animation_frame"
+require_relative "./rpg/animation_timing"
+
+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/vx_ace/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/vx_ace/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