or2d 0.0.1.pre.rc1 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf0597361e53518e19601f4e1a17341d5bcba4a55eb76541f6b7c228c32222ec
-  data.tar.gz: 8e83ff4280a96860f70ad048b5f41d786ed80fd1d87bb480679d5fe51be00c03
+  metadata.gz: 84ff6f80df77d3cdf1c7d68a9c807c6f91024150984ee4848f6852f7d1f1e73a
+  data.tar.gz: 1f3c4e7a6f0f88acea2ec63ad7c78f5c2a76e8417abbeba4b0fd5fbdbf7b8d53
 SHA512:
-  metadata.gz: 839294376a8000552136d439f56f7043b0398cfe5a1c20a0fe19093bd8fc984ca105db82dd08437b28266690b507914a1fb65fdd1db025afe747efbafdd58661
-  data.tar.gz: a648146556ab88b70f614bc6b6559cf292352b366d04ce2c7504f479d8699d378f1e04bd107a7e049100ac993d853df63c0039b13245b8279d3238fb3ddb5ede
+  metadata.gz: 3c63db0c5fb39018dd3054d4fc83121ab697dca0326f5b46ee3d4ec0f2917df3de83be7bd2cbbdfc6e34ba420f7fa9032ba584caab150c73d6343e20904f9aa9
+  data.tar.gz: a24f90e8eb8749a3f92cc24120ffe1aa21b7906226cd1c110574ed1384839783dad6308664e98b5f8b3af38700a65e844f97fc79ec689cfa2cd44f79e1d5c8d8

data/lib/or2d/camera.rb

@@ -0,0 +1,87 @@
+module OR2D
+  class Camera
+
+    # The target of the camera.
+    # @return [OR2D::Entity] the target of the camera
+    attr_reader :target
+
+    # The viewport of the camera.
+    # @return [OR2D::Entity] the viewport of the camera
+    attr_reader :viewport
+
+    # Constructs a new Camera object.
+    # @param viewport_width [Integer] the width of the viewport
+    # @param viewport_height [Integer] the height of the viewport
+    # @param target [OR2D::Entity] the target of the camera
+    def initialize(viewport_width = OR2D.game.screen_width,
+                   viewport_height = OR2D.game.screen_height,
+                   target = OR2D::Entity.new(:square, { size: 1, x: 0, y: 0, show: false }),
+                   speed = 1)
+      @target = target
+      @speed = speed
+      @viewport = OR2D::Entity.new(:rectangle, {
+        x: (OR2D.game.screen_width / 2) - viewport_width,
+        y: (OR2D.game.screen_height / 2) + viewport_height,
+        width: viewport_width,
+        height: viewport_height,
+        show: false
+      })
+    end
+
+    def update; end
+
+    def scroll(direction, amount, target: false)
+      case direction
+      when :north then scroll_north(amount, target)
+      when :south then scroll_south(amount, target)
+      when :east then scroll_east(amount, target)
+      when :west then scroll_west(amount, target)
+      else raise ArgumentError, "Invalid direction: #{direction}"
+      end
+    end
+
+    # Simulates a northern camera scroll by moving all of the visible entities on the screen to the south.
+    # @param delta_y [Integer] the amount to scroll each entity
+    # @param target [Boolean] whether or not to scroll the target
+    def scroll_north(delta_y, target)
+      OR2D.game.entities.each_value do |entity|
+        next if !target && entity == @target
+
+        entity.screen_y += delta_y
+      end
+    end
+
+    # Simulates a southern camera scroll by moving all of the visible entities on the screen to the north.
+    # @param delta_y [Integer] the amount to scroll each entity
+    # @param target [Boolean] whether or not to scroll the target
+    def scroll_south(delta_y, target)
+      OR2D.game.entities.each_value do |entity|
+        next if !target && entity == @target
+
+        entity.screen_y -= delta_y
+      end
+    end
+
+    # Simulates an eastern camera scroll by moving all of the visible entities on the screen to the west.
+    # @param delta_x [Integer] the amount to scroll each entity
+    # @param target [Boolean] whether or not to scroll the target
+    def scroll_east(delta_x, target)
+      OR2D.game.entities.each_value do |entity|
+        next if !target && entity == @target
+
+        entity.screen_x -= delta_x
+      end
+    end
+
+    # Simulates a western camera scroll by moving all of the visible entities on the screen to the east.
+    # @param delta_x [Integer] the amount to scroll each entity
+    # @param target [Boolean] whether or not to scroll the target
+    def scroll_west(delta_x, target)
+      OR2D.game.entities.each_value do |entity|
+        next if !target && entity == @target
+
+        entity.screen_x += delta_x
+      end
+    end
+  end
+end

data/lib/or2d/cameras/centered.rb

@@ -0,0 +1,39 @@
+module OR2D::Cameras
+  class CenteredCamera < OR2D::Camera
+    def initialize(target = nil)
+      super(OR2D.game.screen_width, OR2D.game.screen_height, target, 1.scale)
+      orientate
+      @scrolling = false
+      @direction = nil
+    end
+
+    def update
+      orientate
+      return unless @scrolling
+
+      case @direction
+      when :north then scroll_north(@speed, false)
+      when :south then scroll_south(@speed, false)
+      when :east then scroll_east(@speed, false)
+      when :west then scroll_west(@speed, false)
+      end
+
+      reset_scrolling
+    end
+
+    def scroll(direction, amount)
+      @scrolling = true
+      @direction = direction
+      @speed = amount
+    end
+
+    def orientate
+      @target.screen_x = OR2D.game.screen_width / 2
+      @target.screen_y = OR2D.game.screen_height / 2
+    end
+
+    def reset_scrolling
+      @scrolling = false
+    end
+  end
+end

data/lib/or2d/cameras/padded.rb

@@ -0,0 +1,65 @@
+module OR2D::Cameras
+  # A PaddedCamera is a camera that has padding. When the target <OR2D::Entity> reaches the edge of the padding, the camera will scroll.
+  class PaddedCamera < OR2D::Camera
+    # Constructs a new PaddedCamera.
+    # @param target [OR2D::Entity] the target of the camera
+    # @param padding_width [Integer] the width of the padding
+    # @param padding_height [Integer] the height of the padding
+    def initialize(padding_width = 512, padding_height = 512, target = nil)
+      @padding_width = padding_width
+      @padding_height = padding_height
+      super(@padding_width, @padding_height, target, 1.scale)
+      orientate
+    end
+
+    # Updates the camera.
+    def update
+      scroll if should_scroll?
+    end
+
+    # Checks if the camera should scroll. This check is done by checking if the target <OR2D::Entity> is within the <OR2D::Cameras::PaddedCamera#boundary>.
+    # @return [Boolean] true if the camera should scroll, false otherwise
+    def should_scroll?
+      should_scroll_east? || should_scroll_west? || should_scroll_north? || should_scroll_south?
+    end
+
+    def should_scroll_east?
+      @target.screen_x >= (@viewport.screen_x + @viewport.width)
+    end
+
+    def should_scroll_west?
+      @target.screen_x <= (@viewport.screen_x - @viewport.width)
+    end
+
+    def should_scroll_north?
+      @target.screen_y <= (@viewport.screen_y - @viewport.height)
+    end
+
+    def should_scroll_south?
+      @target.screen_y >= (@viewport.screen_y + @viewport.height)
+    end
+
+    def scroll
+      if should_scroll_east?
+        super(:east, @speed, target: true)
+        @viewport.screen_x += @speed
+      elsif should_scroll_west?
+        super(:west, @speed, target: true)
+        @viewport.screen_x -= @speed
+      end
+
+      if should_scroll_north?
+        super(:north, @speed, target: true)
+        @viewport.screen_y -= @speed
+      elsif should_scroll_south?
+        super(:south, @speed, target: true)
+        @viewport.screen_y += @speed
+      end
+    end
+
+    def orientate
+      @target.screen_x = @viewport.screen_x + @viewport.width / 2
+      @target.screen_y = @viewport.screen_y + @viewport.height / 2
+    end
+  end
+end

data/lib/or2d/composite.rb

@@ -39,6 +39,16 @@ module OR2D
       OR2D.game.remove_entity(id)
     end
 
+    def each_layer(&block)
+      @layers.each(&block)
+    end
+
+    def toggle_boundary
+      @layers.each_key do |key|
+        OR2D.game.entities[key].toggle_boundary
+      end
+    end
+
     # Show the Composite object.
     def show
       @layers.each do |id, properties|

data/lib/or2d/console.rb

@@ -18,17 +18,16 @@ module OR2D
                                         height: (OR2D.game.window.get(:height) / 2),
                                         color: 'green', opacity: 0.25)
       OR2D.game.window.add(@boundary)
-      @properties = { input_size: (8 * OR2D.scale), output_size: (4 * OR2D.scale), max_length: options[:max_length] || 24 }
-      @properties[:max_lines] = (@boundary.height / (@properties[:output_size] * OR2D.scale)).to_i - @properties[:output_size]
-
+      @properties = { input_size: 8.scale, output_size: 4.scale, max_length: options[:max_length] || 24 }
+      @properties[:max_lines] = (@boundary.height / @properties[:output_size].scale).to_i - @properties[:output_size]
 
       @prompt = options[:prompt] || '>> '
       @buffer = String.new
       @display = OR2D::Composites::Text.new
       @display.add_line(text: 'OR2D Console', color: 'yellow', size: @properties[:output_size],
-                        x: @boundary.x + 16, y: @boundary.y + (16 * OR2D.scale), z: @boundary.z + 1)
+                        x: @boundary.x + 16, y: @boundary.y + 16.scale, z: @boundary.z + 1)
       @input = OR2D::Entity.new(:text, { text: @prompt, color: 'white',
-                                         x: @boundary.x + 16, y: (@boundary.y + @boundary.height) - (16 * OR2D.scale),
+                                         x: @boundary.x + 16, y: (@boundary.y + @boundary.height) - 16.scale,
                                          z: @boundary.z + 1, size: @properties[:input_size],
                                          show: true })
       @state = State.new(:RETRACTED, false, false)
@@ -62,7 +61,7 @@ module OR2D
           @state.drawn = false
         end
       when :PULL_DOWN
-        if @boundary.y <= -16 * OR2D.scale
+        if @boundary.y <= -16.scale
           @boundary.y += 16
           @input.y += 16
           @display.y += 16 unless @display.empty?
@@ -157,8 +156,8 @@ module OR2D
             puts e.backtrace
           end
 
-          @display.add_line(text: "#{@buffer} #=> #{output}", 
-                            size: @properties[:output_size], 
+          @display.add_line(text: "#{@buffer} #=> #{output}",
+                            size: @properties[:output_size],
                             color: 'white',
                             show: true)
           @buffer.clear

data/lib/or2d/entity.rb

@@ -14,20 +14,30 @@ module OR2D
     # @return [Ruby2D::Image, Ruby2D::Sprite, Ruby2D::Text, Ruby2D::Triangle, Ruby2D::Quad, Ruby2D::Circle, Ruby2D::Square, Ruby2D::Line, Ruby2D::Rectangle] the entity's resource
     attr_reader :resource
 
+    # @!attribute [r] previous_x
+    # @return [Integer] the entity's previous x coordinate
+    attr_reader :previous_screen_x
+
+    # @!attribute [r] previous_y
+    # @return [Integer] the entity's previous y coordinate
+    attr_reader :previous_screen_y
+
     # Constructs a new Entity object.
     # @param type [Symbol] the type of entity to create
     # @param options [Hash] the options to create the entity with
     def initialize(type, options = {})
       super(x: options[:x] || 0,
             y: options[:y] || 0,
-            width: options[:width].nil? ? 1 : options[:width] * OR2D.scale,
-            height: options[:height].nil? ? 1 : options[:height] * OR2D.scale,
+            width: options[:width].nil? ? 1 : options[:width].scale,
+            height: options[:height].nil? ? 1 : options[:height].scale,
             opacity: options[:show_boundary] ? 0.55 : 0.0,
             color: 'green')
       @id = options[:id] || SecureRandom.uuid
       @resource = options[:resource] || OR2D::Resource.create(type, options)
       @width = @resource.width if @resource.respond_to?(:width)
       @height = @resource.height if @resource.respond_to?(:height)
+      @previous_screen_x = options[:x] || 0
+      @previous_screen_y = options[:y] || 0
       show if options[:show]
     ensure
       OR2D.game.add_entity(self)
@@ -36,6 +46,7 @@ module OR2D
     # Set the Entity x coordinate.
     # @param x_coordinate [Integer] the x coordinate of the Entity on the screen
     def x=(x_coordinate)
+      @previous_screen_x = @x
       super(x_coordinate)
       @resource.x = x_coordinate if @resource.respond_to?(:x=)
     end
@@ -43,6 +54,7 @@ module OR2D
     # Set the Entity y coordinate.
     # @param y_coordinate [Integer] the y coordinate of the Entity on the screen
     def y=(y_coordinate)
+      @previous_screen_x = @y
       super(y_coordinate)
       @resource.y = y_coordinate if @resource.respond_to?(:y=)
     end
@@ -56,6 +68,10 @@ module OR2D
                        end
     end
 
+    def contains?(x, y)
+      (@x1..@x2).cover?(x) && (@y1..@y4).cover?(y)
+    end
+
     # Show the entity on the game instance window.
     def show
       OR2D.game.window.add(self)
@@ -74,5 +90,12 @@ module OR2D
       OR2D.game.window.remove(@resource) if @resource
       OR2D.game.remove_entity(@id)
     end
+
+    alias screen_x x
+    alias screen_y y
+    alias screen_z z
+    alias screen_x= x=
+    alias screen_y= y=
+    alias screen_z= z=
   end
 end

data/lib/or2d/instance.rb

@@ -88,6 +88,18 @@ module OR2D
       @window.close
     end
 
+    # The width of the game window.
+    # @return [Integer] the width of the game window
+    def screen_width
+      @window.get(:width)
+    end
+
+    # The height of the game window.
+    # @return [Integer] the height of the game window
+    def screen_height
+      @window.get(:height)
+    end
+
     private
 
     def setup
@@ -181,6 +193,5 @@ module OR2D
       puts "An error occurred while processing the current scene: #{e.message}"
       puts e.backtrace if OR2D.debug?
     end
-
   end
 end

data/lib/or2d/patches/float.rb

@@ -0,0 +1,5 @@
+class Float
+  def scale
+    self * OR2D.scale.to_f
+  end
+end

data/lib/or2d/patches/integer.rb

@@ -0,0 +1,7 @@
+class Integer
+
+  # Scale the integer by the game window's scale.
+  def scale
+    self * OR2D.scale
+  end
+end

data/lib/or2d/resource.rb

@@ -41,8 +41,8 @@ module OR2D::Resource
   def create_image(options)
     Ruby2D::Image.new(options[:path],
                       atlas: options[:atlas],
-                      width: options[:width] * OR2D.scale || 4,
-                      height: options[:height] * OR2D.scale || 4,
+                      width: options[:width].scale || 4,
+                      height: options[:height].scale || 4,
                       opacity: options[:opacity] || 1.0,
                       rotate: options[:rotate] || 0,
                       x: options[:x] || 0,
@@ -58,8 +58,8 @@ module OR2D::Resource
                      y1: options[:y1],
                      x2: options[:x2],
                      y2: options[:y2],
-                     z: options[:z],
-                     width: options[:width] * OR2D.scale || 2,
+                     z: options[:z] || 0,
+                     width: options[:width].scale || 2,
                      color: options[:color] || 'yellow',
                      opacity: options[:opacity] || 1.0)
   end
@@ -71,8 +71,8 @@ module OR2D::Resource
     Ruby2D::Rectangle.new(x: options[:x] || 0,
                           y: options[:y] || 0,
                           z: options[:z] || 0,
-                          width: options[:width] * OR2D.scale,
-                          height: options[:height] * OR2D.scale,
+                          width: options[:width].scale,
+                          height: options[:height].scale,
                           color: options[:color] || 'yellow',
                           opacity: options[:opacity] || 1.0)
   end
@@ -83,8 +83,8 @@ module OR2D::Resource
   def create_sprite(options)
     Ruby2D::Sprite.new(options[:path],
                        atlas: options[:atlas],
-                       width: options[:width] ? options[:width] * OR2D.scale : nil,
-                       height: options[:height] ? options[:height] * OR2D.scale : nil,
+                       width: options[:width] ? options[:width].scale : nil,
+                       height: options[:height] ? options[:height].scale : nil,
                        rotate: options[:rotate] || 0,
                        opacity: options[:opacity] || 1.0,
                        loop: options[:loop] || false,
@@ -120,7 +120,7 @@ module OR2D::Resource
                      x: options[:x] || 0,
                      y: options[:y] || 0,
                      z: options[:z] || 0,
-                     size: (options[:size] || 16) * OR2D.scale,
+                     size: (options[:size] || 16).scale,
                      style: options[:style],
                      font: options[:font] || Ruby2D::Font.default,
                      color: options[:color] || 'yellow',

data/lib/or2d/scene.rb

@@ -96,6 +96,11 @@ module OR2D
       Fiber.yield
     end
 
+    def clear_descriptors
+      @descriptors.each_value { |descriptor| OR2D.game.window.off(descriptor) }
+      @descriptors.clear
+    end
+
     # Setup event descriptors.
     def setup_descriptor(label, event, &block)
       @descriptors[label] = OR2D.game.window.on(event, &block)

data/lib/or2d/scenes/placeholder_scene.rb

@@ -42,7 +42,7 @@ module OR2D::Scenes
     def setup_events
       setup_descriptor(:mouse_input, :mouse) do |event|
         @cursor_position.resource.text = "[x: #{event.x}, y: #{event.y}]"
-        @cursor_position.width = @cursor_position.resource.text.length * (6 * OR2D.scale)
+        @cursor_position.width = @cursor_position.resource.text.length * 6.scale
       end
 
       setup_descriptor(:debug_input, :key_up) do |event|

data/lib/or2d.rb

@@ -19,30 +19,37 @@ Dir["#{File.dirname(__FILE__)}/or2d/patches/*.rb"].each { |file| load(file) }
 # @author Patrick W.
 # @since 2023-04-26
 module OR2D
-  autoload :Animation,              'or2d/animation'
-  autoload :Composite,              'or2d/composite'
-  autoload :Console,                'or2d/console'
-  autoload :Entity,                 'or2d/entity'
-  autoload :Instance,               'or2d/instance'
-  autoload :Resource,               'or2d/resource'
-  autoload :Scene,                  'or2d/scene'
+  autoload :Animation, 'or2d/animation'
+  autoload :Composite, 'or2d/composite'
+  autoload :Console, 'or2d/console'
+  autoload :Camera, 'or2d/camera'
+  autoload :Entity, 'or2d/entity'
+  autoload :Instance, 'or2d/instance'
+  autoload :Resource, 'or2d/resource'
+  autoload :Scene, 'or2d/scene'
 
   # The Animations module contains modules and classes for animating objects.
   module Animations
-    autoload :CompositeAnimations,  'or2d/animations/composite_animations'
-    autoload :EntityAnimations,     'or2d/animations/entity_animations'
+    autoload :CompositeAnimations, 'or2d/animations/composite_animations'
+    autoload :EntityAnimations, 'or2d/animations/entity_animations'
+  end
+
+  # The Cameras module contains all of the camera implementations for the OR2D gem.
+  module Cameras
+    autoload :CenteredCamera, 'or2d/cameras/centered'
+    autoload :PaddedCamera, 'or2d/cameras/padded'
   end
 
   # The Composites module contains all of the composite entities for the OR2D gem.
   module Composites
-    autoload :Projectile,           'or2d/composites/projectile'
-    autoload :Sprite,               'or2d/composites/sprite'
-    autoload :Text,                 'or2d/composites/text'
+    autoload :Projectile, 'or2d/composites/projectile'
+    autoload :Sprite, 'or2d/composites/sprite'
+    autoload :Text, 'or2d/composites/text'
   end
 
   # The Scenes module contains all of the scenes for the OR2D gem.
   module Scenes
-    autoload :PlaceholderScene,     'or2d/scenes/placeholder_scene'
+    autoload :PlaceholderScene, 'or2d/scenes/placeholder_scene'
   end
 
   # Is debug mode enabled?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: or2d
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre.rc1
+  version: 0.0.6
 platform: ruby
 authors:
 - Patrick W.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-18 00:00:00.000000000 Z
+date: 2023-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -17,6 +17,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.1
 - !ruby/object:Gem::Dependency
   name: ruby2d
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +44,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.12.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.18'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +100,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.42'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -104,6 +138,9 @@ files:
 - lib/or2d/animation.rb
 - lib/or2d/animations/composite_animations.rb
 - lib/or2d/animations/entity_animations.rb
+- lib/or2d/camera.rb
+- lib/or2d/cameras/centered.rb
+- lib/or2d/cameras/padded.rb
 - lib/or2d/composite.rb
 - lib/or2d/composites/projectile.rb
 - lib/or2d/composites/sprite.rb
@@ -111,6 +148,8 @@ files:
 - lib/or2d/console.rb
 - lib/or2d/entity.rb
 - lib/or2d/instance.rb
+- lib/or2d/patches/float.rb
+- lib/or2d/patches/integer.rb
 - lib/or2d/patches/music.rb
 - lib/or2d/patches/renderable.rb
 - lib/or2d/patches/sound.rb
@@ -134,9 +173,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.4.10
 signing_key: