gembots 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4be29acf29ee4311539f3c2e8374881bf51299e9
-  data.tar.gz: 1229f2c5c5d1b91240ff1060bbeeb4d6e8bad372
+  metadata.gz: ad9de32649b753655ebb462ea3f56dc2f2227e83
+  data.tar.gz: 74426bf3ccbdf33f3357bf28c6c8c248f47b397e
 SHA512:
-  metadata.gz: 35df3db678bf53c2548d3d15c2652b6525b798cbec9d97f1b59596f0d834075a69e92c868c9b4ff36b31a4f33d3674f99a359d55a08dbe29a172c6b29a65de59
-  data.tar.gz: 42dbe16b897a16314a0a42010b383b68861120f7ab28ac020e070f156dc8fe251ed4da25072473a7e64f5ba3c17936eb2f0bbf2589d58b7516dfd59373386ec6
+  metadata.gz: c1e86f79ca9ab9ae37c6306c9f7f81e45b6eba6ab929ebfb92ca85ac7948120ab1e687e34709940a52e2f632c2a81638998c13bb625928af39eb2c20084b2643
+  data.tar.gz: 2fdf7b3c7e5a9fb8f380eab5257ca3fb68ab4d10d0338c7e00b6807f86d650ac7e2e6cddd13f3d01782a166ff054f9a4f89043b91117af7425d95f7440e633dc

data/lib/gembots/arena.rb

@@ -1,9 +1,11 @@
 require 'gembots'
 require 'gembots/projectile'
 
+# Class used for initializing the arena and opening the window.
 class Gembots::Arena < Gosu::Window
+  # Array containing an instance of each bot in the arena
   attr_reader :bots
-  attr_reader :arena
+
   def initialize *bots
     super 640, 480, false
     self.caption = "Gembots battle"
@@ -17,15 +19,23 @@ class Gembots::Arena < Gosu::Window
     end
   end
 
+  # Method called via Gosu.
+  # It simply calls the draw method for each projectile and bot.
   def draw
     @bots.each &:draw
     @projs.each &:draw
   end
 
+  # Method called via Gosu.
+  # It calls the update method for each projectile and bot.
+  # It also checks to see if a projectile has hit a bot, and deletes the bot and projectile if it has.
   def update
     @bots.each &:update
+    @projs.each &:update
+
     @bots.each do |bot|
       bot.on_idle if bot.actions.empty?
+
       @projs.each do |proj|
         if (Gosu::distance bot.x, bot.y, proj.x, proj.y) < 10
           @bots.delete bot
@@ -33,14 +43,15 @@ class Gembots::Arena < Gosu::Window
         end
       end
     end
-
-    @projs.each &:update
   end
 
+  # Method called via Gosu.
+  # If the escape key is pressed, then the window closes.
   def button_down id
     close if id == Gosu::KbEscape
   end
 
+  # Spawns a Projectile instance at bot's position and angle.
   def spawn_proj bot
     @projs << Gembots::Projectile.new(self, bot.x, bot.y, bot.angle)
   end

data/lib/gembots/bot.rb

@@ -1,9 +1,20 @@
 require 'gembots'
 
+# Class used for creating a robot.
 class Gembots::Robot
-  attr_reader :x, :y, :angle, :actions
+  # X and Y positions
+  attr_reader :x, :y
 
+  # Current angle of robot.
+  attr_reader :angle
+
+  # Array containing arrays that represent actions that need to be completed.
+  # The format is like: `[[:move, 10], [:turn, 90]]`, meaning the robot will move 10 forward, then turn 90 degrees clockwise.
+  attr_reader :actions
+
+  # Creates a new instance of the robot.
   def initialize window
+    @warped = false
     @actions = []
     @window = window
     @images = Gosu::Image::load_tiles(window, "media/tank.png", 32, 32, false)
@@ -11,18 +22,32 @@ class Gembots::Robot
     @x = @y = @angle = @cur_image = 0.0
   end
 
+  # Method called via the arena.
+  # Warps the robot to the position specified.
   def warp x, y
-    @x, @y = x, y
+    @x, @y = x, y unless @warped
+    @warped = true
   end
 
+  # Appends a turn action to the actions array.
+  # The update method will turn the robot clockwise for the degree specified.
+  # If the degree is not specified, it defaults to 10.
+  # Use a negative value to rotate counter-clockwise.
   def turn angle=10
     @actions << [:turn, angle]
   end
 
+  # Appends a move action to the actions array.
+  # The update method will move the robot forward the distance specified.
+  # If the distance is not specified, it defaults to 10.
+  # Use a negative value to move in reverse.
   def move dist=10
     @actions << [:move, dist]
   end
 
+  # Method called via the arena.
+  # This attempts to preform the first action in the actions array.
+  # If it finishes the action, it will pop that actions from the actions array, allowing it to preform the next.
   def update
     return if @actions.empty?
     case @actions[0][0]
@@ -56,11 +81,14 @@ class Gembots::Robot
     end
   end
 
+  # Method called via the arena.
   def draw
     @images[@cur_image].draw_rot @x, @y, 1, @angle - 90 % 360
     @image.draw_rot @x, @y, 1, @angle - 90 % 360
   end
 
+  # Appends a fire action to the actions array.
+  # The update method will call the arena's spawn_proj method.
   def fire
     @actions << [:fire]
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gembots
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - L8D