stattr 0.0.7 → 0.1.0

data/lib/stattr.rb

@@ -1,93 +1,180 @@
+# Stattr includes some basic functions that could be used in a Tabletop RPG application
+#
+# @author Alex Jarvis
 
 module Stattr
-  Normstats = ['STR', 'DEX', 'CHA', 'INT', 'WIS', 'CON'] 
-  
-  class Dice
+
+  # How many sides the most common die has - rewrite to fit your game. 
+  #
+  DICE_SIDES = 6 
+    
+  # Represents a single instance of the result of a dice roll  
+  # 
+  class DiceRoll 
+    
+    # @attribute sides [Integer] The number of sides the dice in this roll have. 
+    #
+    # @attribute count [Integer] The number of die being rolled.
+    #
     attr_accessor :sides, :count
-    def initialize(sides=6, count=1)
+    
+    # New instance of DiceRoll.
+    #
+    # @param [Integer] sides
+    #
+    # @param [Integer] count
+    #
+    # @return [Object] DiceRoll object
+    #
+    def initialize(sides=DICE_SIDES, count=1)
       @sides = sides
       @count = count
-    end
-
-    def self.roll(sides=6, count=1)
+    end #initialize
+     
+    # Roll a new die. 
+    #
+    # @param [Integer] sides
+    #
+    # @param [Integer] count
+    #
+    # @return [Object] DiceRoll object 
+    #
+    def self.new_roll(sides = DICE_SIDES, count=1)
+      # make a new dice object, then roll it. 
       new(sides, count).roll
-    end  
-
+    end #self.roll
+   
+    # From 1 to count, that many [sides] sided die.
+    # 
+    # @return [Integer] Gives each outcome to Roll. 
+    #
     def rolls
       (1..count).map { |d| rand(sides) + 1 }
-    end
-
+    end #rolls
+    
+    # Adds the rolls from rolls together. 
+    #
+    # @return [Integer] combined rolls 
+    #
     def roll
       rolls.inject(0) { |total, d| total += d }
-    end  
-  end
-  
-
-    
+    end #roll
+  end #DiceRoll
 
-#This iterates through the Stat list and turns each stat into a key. It then rolls 3 d6's to get the starting value for that stat.
-def statroll 
-    stathash = {} 
-        Normstats.each do |stat|
-            stathash[stat] = modstat(Stattr::Dice.roll(6,3))
-        end
-    stathash
-end
+  # Represents the list of Statistics that a player has. 
+  #
+	class StatList 
 
+    # A list of all stats. Currently locked into D+D style stats. 
+    #
+	  attr_accessor :str, :dex, :cha, :con, :wis, :int
 
-#Classes 
-# Extend these to increase the overall functionality of your app/game! 
-
-
-class Statlist 
-attr_accessor :str, :dex, :cha, :con, :wis, :int
-@@sides = 6 
-@@dicenum = 3 
-    def initialize 
-        @str = modstat(Stattr::Dice.roll(@@sides, @@dicenum))
-        @dex = modstat(Stattr::Dice.roll(@@sides, @@dicenum))
-        @cha = modstat(Stattr::Dice.roll(@@sides, @@dicenum))
-        @con = modstat(Stattr::Dice.roll(@@sides, @@dicenum))
-        @wis = modstat(Stattr::Dice.roll(@@sides, @@dicenum))
-        @int = modstat(Stattr::Dice.roll(@@sides, @@dicenum))
-    end
-  def modstat(r)
-  modlist = []
-    case r
-    when 3
-       modlist = [r, -4]
-    when (4..5) 
-       modlist = [r, -3]
-    when (6..7)
-       modlist = [r, -2]
-    when (8..9)
-       modlist = [r, -1]
-    when (10..11)
-       modlist = [r, 0]
-    when (12..13)
-       modlist = [r, 1]
-    when (14..15)
-       modlist = [r, 2]
-    when (16..17)
-       modlist = [r, 3]
-    when 18
-       modlist = [r, 4]
-   else 
-        puts "nothing"
-    end
-modlist
-end
-end
-
-class Playerchar
-attr_accessor :stats, :name
-
-    def initialize(name) 
-        @name = name
-        @stats = Statlist.new
-    end
-end
-
-end 
+    # Create a new Statlist. 
+    #
+    # @param [Array] str
+    #
+    # @param [Array] dex
+    #
+    # @param [Array] cha
+    #
+    # @param [Array] con
+    #
+    # @param [Array] wis
+    #
+    # @param [Array] int
+    #
+    def initialize(str=10, dex=10, cha=10, con=10, wis=10, int=10)  
+      @str = modstat(str)
+      @dex = modstat(dex) 
+      @cha = modstat(cha)
+      @con = modstat(con)
+      @wis = modstat(wis)
+      @int = modstat(int)
+    end #initialize
+    
+    # Takes a given value of a stat and creates a D+D style modifier. 
+    #
+    # @return [Array] modlist. [0] is the stat, [1] is the modifier. 
+    #
+    def modstat(r)
+      modr = ((r-10)/2).to_int
+      modlist = [r, modr]
+      modlist
+    end #modstat
+  end #StatList
+  
+  # CharacterSheet of a given PlayerCharacter. 
+  #
+	class CharacterSheet 
 
+    # @attribute stats [Object] A StatList object 
+    #
+    # @attribute name [String] The Player Character's name 
+    #
+  	attr_accessor :stats, :name
 
+    # new instance of CharacterSheet
+    #
+    # @param [String] name 
+    #
+  	def initialize(name) # :notnew:
+    	@name = name
+      # creates StatList object with '10' as a default for each. 
+    	@stats = StatList.new(10,10,10,10,10,10)
+  	end #initialize 
+		
+    # This is how you roll a brand new random character. 
+    #
+    # @param [String] name 
+    #
+    # @return [Object] New Charactersheet 
+    #
+		def self.roll_char(name)
+      char = CharacterSheet.new(name) 
+      char.stats = StatList.new(
+      DiceRoll.new_roll(DICE_SIDES, 3),
+      DiceRoll.new_roll(DICE_SIDES, 3),
+      DiceRoll.new_roll(DICE_SIDES, 3),
+      DiceRoll.new_roll(DICE_SIDES, 3),
+      DiceRoll.new_roll(DICE_SIDES, 3),
+      DiceRoll.new_roll(DICE_SIDES, 3)
+      )
+		  char	
+		end # self.roll_char
+	end #CharacterSheet
+  
+  # Player class represents a human, who may have multiple character sheets. 
+  #
+  class Player 
+  
+  # @attribute fname [String] The First Name of the Player   
+  #
+  # @attribute lname [String] The last Name of the Player   
+  #
+  # @attribute characters [Array] An array containing Charactersheet objects
+  #
+  attr_accessor :fname, :lname, :characters
+    
+    # Create new Player object
+    #
+    # @param [String] fname
+    #
+    # @param [String] lname
+    #
+    def initialize(fname, lname) 
+      @fname = fname
+      @lname = lname 
+      @characters = []
+    end #initialize
+  
+    # Creates a new randomly generated character associated with Player 
+    #
+    # @param [String] name 
+    #
+    def new_char(name)
+      new_char = CharacterSheet.roll_char(name)
+      self.characters << new_char 
+    end #roll_char
+  end #Player
+      
+end #Stattr

metadata

@@ -1,67 +1,47 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: stattr
-version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 7
-  version: 0.0.7
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Alex Jarvis
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-05-07 00:00:00 -04:00
-default_executable: 
+date: 2012-05-24 00:00:00.000000000 Z
 dependencies: []
-
-description: Stattr is a Gem that includes a number of useful functions for rolling dice in a game like Dungeons and Dragons.
+description: Stattr is a Gem that includes a number of useful functions for rolling
+  dice in a game like Dungeons and Dragons.
 email: alxjrvs@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/stattr.rb
-has_rdoc: true
 homepage: https://github.com/alxjrvs/Stattr
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Stattr; Because rolling dice is hard.
 test_files: []
-
+has_rdoc: