Battlefield 0.0.9 → 0.1.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea35d68f2814c70585aa9f1520c7eb501cf6365d
-  data.tar.gz: 7e1e69a87a0f70caaae3f96f68341d7d4d32044a
+  metadata.gz: 7db41d3f12bc6be854fb8390b3cae6b7000acd8b
+  data.tar.gz: a7edebab8e1c6c34b4866d7c801338237cdc5169
 SHA512:
-  metadata.gz: d53ac2d164dc1bc2680f7a286c13e65f93d993c2fed8d708dc7d3e5e082ad0f45cc94ffc1fe62bf5eed8687adc7c685a070a1587baef37244e9a7513e6340b56
-  data.tar.gz: b938407b8c1622d7e47a28a961a7f57e33255418ffbeefe15e38e06836b8d99f19554fd8143407b1cb46dde17681df000819b6fea018f3a5ab94e3bc77a93f67
+  metadata.gz: 926c60085b735bf4bbd292525cd8dcb0482cb270556385e0630a499abe4ab397a2f5b3d6efd4191ab9a53aa0b7588a886f2b142e5197eae38c8ba22f86fd591c
+  data.tar.gz: 04f99b38c4ab5fd75b0ccef0bb243ae402f5a587821e2803bd709d7a2d71689f42c4eae7cc44e29ee5c83653ae56a0aecb0a5caaadd7b741abef0863b0820416

data/lib/battlefield.rb

@@ -1,10 +1,10 @@
 =begin
 If you want to make a new enemy, you have two ways to do it:
 1. Directly initialize it
-Creature.new (insert health here)
+_enemy_ = Creature.new(rand(100))
 
-2. Create a new class
-class (Insert enemy name here) < Creature
+2. Create  a new class
+class _Insert enemy name here_ < Creature
 	def initialize; @health = _insert health here_; end
 end
 
@@ -13,39 +13,38 @@ Common ancestor of any battle-able objects
 =end
 class Creature 
 	attr_accessor :health
-# Really should specify health and now you can battle
-	def initialize(health = 0)
+# Initializes a Creature. Parameter health sets the Creature's health.
+	def initialize(health)
 		@health = health
 	end
 # Damage function
 	def damage(amt)
 		@health -= amt
 	end
-# rolling function - higher # = more power
+# Rolling function - higher # = more power.
 	def roll
 		(1..6).to_a.sample; end 
 # roll twice
 	def droll
 		self.roll + self.roll
 	end
-# The 1st argument is your attack power. The other is the enemy's. You heal c1 - c2 health
+# The 1st argument is your attack power. The other is the enemy's. You heal c1 - c2 health.
 	def heal(c1, c2) 
 		@health += c1 - c2
 	end
 end
-# To use, create an instance first
+# The Hero is the main character in any story. Works great for the player's avatar.
 class Hero < Creature
-# The hero starts with 100 health
-	def initialize
-		@health = 100
+# Initializes a new Hero. Sets health to 100.
+	def initialize; @health = 100
 	end
 end
-# Initializes an ArmoredCreature. It takes a reduced amount of damage.
-class ArmoredCreature < Creature
+# ArmouredCreatures take a reduced amount of damage.
+class ArmouredCreature < Creature
 	attr_reader = :armour
-# specify damage reduction as a float in parameter armour
-	def initialize(health = 0, armour = 0.5); @health, @armour = health, armor; end
-# Reduces damage by multiplying it by armour
+# Initializes an ArmoredCreature. Parameter armour sets the damage reduction rate. It should be a float.
+	def initialize(health, armour); @health, @armour = health, armor; end
+# Reduces damage by multiplying it by armour.
 	def damage(amt)
 		@health -= (amt*@armour)
 	end
@@ -78,4 +77,8 @@ def battle(hero, enemy, heal = false)
 		end
 		sleep 2
 	end
-end
+end
+# Initializes a new Creature. If no arguments are given, health is set to 0.
+def Creature(health = 0); Creature.new health; end
+# Initializes a new ArmouredCreature. By default, health is set to 0 and armour is set to 0.5
+def ArmouredCreature(health=0, armour=0.5); ArmouredCreature.new health, armour; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Battlefield
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0.pre
 platform: ruby
 authors:
 - Zachary Perlmutter
@@ -28,14 +28,14 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.3.0