minigl 1.2.6 → 1.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d75703110c27893ced02abaa49767ac4137d1b34
-  data.tar.gz: c376306e0d0a7838ebae01863302a418408ce840
+  metadata.gz: 450b8d40d9d7a949621ae94fac7cdf702742e80a
+  data.tar.gz: e70c4b21bcf68daed5a06704dfbbb2cc16234cfe
 SHA512:
-  metadata.gz: 221538181848507fc1b079eb9ac34d3c80f4740070641e2a1bfaef34ebe34effce282f36680082c4c6d2051eb9261f48af4b4d25a1428ad913c89cbba1694cad
-  data.tar.gz: e0f31296045813f211981db2c5c46a8b0fa0a044642072749d9396c14810739f5f6667d5a029d437497217bb605f8fb9cdb2e9302297e4e3bdb6293a98ecb2c0
+  metadata.gz: 159a32f1c0ea9688e10d8599984b6d0e65ed4579e49c94b80a02bf77c065d7bceca0127be3a011acf174c6d5cd1067f51996c60e17d9a36ed56dece1e340aa7b
+  data.tar.gz: c9bc082ef4e2ce42b531d665ad0be11e65897830fdf4367e6262c2aba790f23bfba857ff4cf01a7d776313a264293b43c9c07851ce6407b73005b1d129d3d3bc

data/README.md

@@ -18,11 +18,12 @@ Please note:
   * The test package is not complete! Most of the functionality
 provided by the gem is difficult to test automatically, but you can check out
 this [working game example](https://github.com/victords/aventura-do-saber).
-  * The [documentation](https://github.com/victords/minigl/wiki) is under
-construction.
+  * The RDoc documentation is now available.
+  * An auxiliary, tutorial-like documentation is under construction
+[here](https://github.com/victords/minigl/wiki).
 
-**Version 1.2.6**
+**Version 1.2.7**
 
-  * Added support for character restriction in `TextField`.
-  * Added `set_position` method to `Button` and `TextField`.
-  * Added RDoc documentation.
+  * Completed and added documentation for the `Effect` class.
+  * Slight adjusts in the documentation.
+  * Slight adjust in the implementation of `Button`.

data/lib/minigl/forms.rb

@@ -4,6 +4,7 @@ module AGL
 	# This class represents a button.
 	class Button
 		# Creates a button.
+		# 
 		# Parameters:
 		# [x] The x-coordinate where the button will be drawn in the screen.
 		# [y] The y-coordinate where the button will be drawn in the screen.
@@ -52,7 +53,7 @@ module AGL
 			end
 			@text_color = text_color
 			@center = center
-			@action = Proc.new &action
+			@action = action
 		
 			@state = :up
 			@img_index = 0
@@ -104,6 +105,7 @@ module AGL
 		end
 		
 		# Sets the position of the button in the screen.
+		# 
 		# Parameters:
 		# [x] The new x-coordinate for the button.
 		# [y] The new y-coordinate for the button.
@@ -121,6 +123,7 @@ module AGL
 		end
 		
 		# Draws the button in the screen.
+		# 
 		# Parameters:
 		# [alpha] The opacity with which the button will be drawn. Allowed values
 		#         vary between 0 (fully transparent) and 255 (fully opaque).
@@ -144,6 +147,7 @@ module AGL
 		attr_reader :text
 		
 		# Creates a new text field.
+		# 
 		# Parameters:
 		# [x] The x-coordinate where the text field will be drawn in the screen.
 		# [y] The y-coordinate where the text field will be drawn in the screen.
@@ -379,6 +383,7 @@ module AGL
 		end
 		
 		# Sets the text of the text field to the specified value.
+		# 
 		# Parameters:
 		# [value] The new text to be set. If it's longer than the +max_length+
 		#         parameter used in the constructor, it will be truncated to
@@ -420,6 +425,7 @@ module AGL
 		end
 		
 		# Sets the position of the text field in the screen.
+		# 
 		# Parameters:
 		# [x] The new x-coordinate for the text field.
 		# [y] The new y-coordinate for the text field.
@@ -435,6 +441,7 @@ module AGL
 		end
 		
 		# Draws the text field in the screen.
+		# 
 		# Parameters:
 		# [alpha] The opacity with which the text field will be drawn. Allowed
 		#         values vary between 0 (fully transparent) and 255 (fully opaque).

data/lib/minigl/game_object.rb

@@ -13,9 +13,12 @@ module AGL
 		attr_accessor :y
 		
 		# Creates a new sprite.
+		# 
 		# Parameters:
-		# [x] The x-coordinate where the sprite will be drawn in the screen.
-		# [y] The y-coordinate where the sprite will be drawn in the screen.
+		# [x] The x-coordinate in the screen (or map) where the sprite will be
+		#     drawn. This can be modified later via the +x+ attribute.
+		# [y] The y-coordinate in the screen (or map) where the sprite will be
+		#     drawn. This can be modified later via the +y+ attribute.
 		# [img] The path to a PNG image or spritesheet, following the MiniGL
 		#       convention: images must be inside a 'data/img' directory, relative
 		#       to the code file, and you must only provide the file name, without
@@ -44,6 +47,7 @@ module AGL
 		
 		# Performs time checking to update the image index according to the
 		# sequence of indices and the interval.
+		# 
 		# Parameters:
 		# [indices] The sequence of image indices used in the animation. The
 		#           indices are determined from left to right, and from top to
@@ -63,6 +67,7 @@ module AGL
 		end
 		
 		# Draws the sprite in the screen
+		# 
 		# Parameters:
 		# [map] A Map object, relative to which the sprite will be drawn (the x
 		#       and y coordinates of the sprite will be changed according to the
@@ -101,9 +106,12 @@ module AGL
 		include Movement
 		
 		# Creates a new game object.
+		# 
 		# Parameters:
-		# [x] The x-coordinate of the object's bounding box.
-		# [y] The y-coordinate of the object's bounding box.
+		# [x] The x-coordinate of the object's bounding box. This can be modified
+		#     later via the +x+ attribute.
+		# [y] The y-coordinate of the object's bounding box. This can be modified
+		#     later via the +y+ attribute.
 		# [w] The width of the object's bounding box.
 		# [h] The height of the object's bounding box.
 		# [img] The image or spritesheet for the object.
@@ -133,6 +141,7 @@ module AGL
 		
 		# Resets the animation timer and immediately changes the image index to
 		# the specified value.
+		# 
 		# Parameters:
 		# [index] The image index to be set.
 		def set_animation index
@@ -147,6 +156,7 @@ module AGL
 		end
 		
 		# Draws the game object in the screen.
+		# 
 		# Parameters:
 		# [map] A Map object, relative to which the object will be drawn (the x
 		#       and y coordinates of the image will be changed according to the
@@ -180,11 +190,38 @@ module AGL
 		end
 	end
 	
-	# :nodoc: all
+	# Represents a visual effect, i.e., a graphic - usually animated - that shows
+	# up in the screen, lasts for a given time and "disappears". You should
+	# explicitly dispose of references to effects whose attribute +dead+ is set
+	# to +true+.
 	class Effect < Sprite
-		def initialize x, y, life_time, img, sprite_cols = nil, sprite_rows = nil, indices = nil, interval = 1
+		# This is +true+ when the effect's lifetime has already passed.
+		attr_reader :dead
+		
+		# Creates a new Effect.
+		#
+		# Parameters:
+		# [x] The x-coordinate in the screen (or map) where the effect will be
+		#     drawn. This can be modified later via the +x+ attribute.
+		# [y] The y-coordinate in the screen (or map) where the effect will be
+		#     drawn. This can be modified later via the +y+ attribute.
+		# [img] The image or spritesheet to use for this effect (see Sprite for
+		#       details on spritesheets).
+		# [sprite_cols] (see Sprite)
+		# [sprite_rows] (see Sprite)
+		# [interval] The interval between steps of the animation, in updates.
+		# [indices] The indices to use in the animation. See Sprite#animate for
+		#           details. If +nil+, it will be the sequence from 0 to
+		#           <code>sprite_cols * sprite_rows - 1</code>.
+		# [lifetime] The lifetime of the effect, in updates. After +update+ is
+		#            called this number of times, the effect will no longer
+		#            be visible, even when +draw+ is called, and the +dead+ flag
+		#            will be set to +true+, so you get to know when to dispose
+		#            of the Effect object. If +nil+, it will be set to
+		#            <code>@indices.length * interval</code>, i.e., the exact time
+		#            needed for one animation cycle to complete.
+		def initialize x, y, img, sprite_cols = nil, sprite_rows = nil, interval = 10, indices = nil, lifetime = nil
 			super x, y, img, sprite_cols, sprite_rows
-			@life_time = life_time
 			@timer = 0
 			if indices
 				@indices = indices
@@ -192,14 +229,24 @@ module AGL
 				@indices = *(0..(@img.length - 1))
 			end
 			@interval = interval
+			if lifetime
+				@lifetime = lifetime
+			else
+				@lifetime = @indices.length * interval
+			end
 		end
 		
+		# Updates the effect, animating and counting its remaining lifetime.
 		def update
-			animate @indices, @interval
-			@timer += 1
-			if @timer == @life_time
-				@dead = true
+			unless @dead
+				animate @indices, @interval
+				@timer += 1
+				@dead = true if @timer == @lifetime
 			end
 		end
+		
+		def draw map = nil, scale_x = 1, scale_y = 1, alpha = 0xff, color = 0xffffff, angle = nil
+			super unless @dead
+		end
 	end
 end

data/lib/minigl/global.rb

@@ -22,6 +22,7 @@ module AGL
 		attr_accessor :h
 		
 		# Creates a new rectangle.
+		# 
 		# Parameters:
 		# [x] The x-coordinate of the rectangle.
 		# [y] The y-coordinate of the rectangle.
@@ -32,6 +33,7 @@ module AGL
 		end
 		
 		# Returns whether this rectangle intersects another.
+		# 
 		# Parameters:
 		# [r] The rectangle to check intersection with.
 		def intersects r
@@ -44,6 +46,7 @@ module AGL
 	class Game
 		# Initializes a MiniGL game. This method must be called before any feature
 		# provided by the library can be used.
+		# 
 		# Parameters:
 		# [window] An instance of a class which inherits from
 		#          <code>Gosu::Window</code>. This will be the game window, used
@@ -154,6 +157,7 @@ module AGL
 		
 		# Returns whether the given key is down in the current frame and was not
 		# down in the frame before.
+		# 
 		# Parameters:
 		# [key] Code of the key to be checked. The available codes are <code>
 		#       Gosu::KbUp, Gosu::KbDown, Gosu::KbReturn, Gosu::KbEscape,
@@ -177,6 +181,7 @@ module AGL
 		end
 		
 		# Returns whether the given key is down in the current frame.
+		# 
 		# Parameters:
 		# [key] Code of the key to be checked. See +key_pressed?+ for details.
 		def self.key_down? key
@@ -185,6 +190,7 @@ module AGL
 		
 		# Returns whether the given key is not down in the current frame but was
 		# down in the frame before.
+		# 
 		# Parameters:
 		# [key] Code of the key to be checked. See +key_pressed?+ for details.
 		def self.key_released? key
@@ -193,6 +199,7 @@ module AGL
 		
 		# Returns whether the given key is being held down. See
 		# <code>Game.initialize</code> for details.
+		# 
 		# Parameters:
 		# [key] Code of the key to be checked. See +key_pressed?+ for details.
 		def self.key_held? key
@@ -246,6 +253,7 @@ module AGL
 		
 		# Returns whether the given button is down in the current frame and was
 		# not down in the frame before.
+		# 
 		# Parameters:
 		# [btn] Button to be checked. Valid values are +:left+, +:middle+ and
 		#       +:right+
@@ -254,6 +262,7 @@ module AGL
 		end
 		
 		# Returns whether the given button is down in the current frame.
+		# 
 		# Parameters:
 		# [btn] Button to be checked. Valid values are +:left+, +:middle+ and
 		#       +:right+
@@ -263,6 +272,7 @@ module AGL
 		
 		# Returns whether the given button is not down in the current frame, but
 		# was down in the frame before.
+		# 
 		# Parameters:
 		# [btn] Button to be checked. Valid values are +:left+, +:middle+ and
 		#       +:right+
@@ -271,6 +281,7 @@ module AGL
 		end
 		
 		# Returns whether the given button has just been double clicked.
+		# 
 		# Parameters:
 		# [btn] Button to be checked. Valid values are +:left+, +:middle+ and
 		#       +:right+
@@ -279,6 +290,7 @@ module AGL
 		end
 		
 		# Returns whether the mouse cursor is currently inside the given area.
+		# 
 		# Parameters:
 		# [x] The x-coordinate of the top left corner of the area.
 		# [y] The y-coordinate of the top left corner of the area.
@@ -317,6 +329,7 @@ module AGL
 		end
 		
 		# Returns a <code>Gosu::Image</code> object.
+		# 
 		# Parameters:
 		# [id] A string or symbol representing the path to the image. If the file
 		#      is inside 'data/img', only the file name is needed. If it's inside
@@ -344,6 +357,7 @@ module AGL
 		# a spritesheet. The image with index 0 will be the top left sprite, and
 		# the following indices raise first from left to right and then from top
 		# to bottom.
+		# 
 		# Parameters:
 		# [id] A string or symbol representing the path to the image. See +img+
 		#      for details.
@@ -366,6 +380,7 @@ module AGL
 		# a tileset. Works the same as +imgs+, except you must provide the tile
 		# size instead of the number of columns and rows, and that the images will
 		# be loaded as tileable.
+		# 
 		# Parameters:
 		# [id] A string or symbol representing the path to the image. It must be
 		#      specified the same way as in +img+, but the base directory is
@@ -387,6 +402,7 @@ module AGL
 		
 		# Returns a <code>Gosu::Sample</code> object. This should be used for
 		# simple and short sound effects.
+		# 
 		# Parameters:
 		# [id] A string or symbol representing the path to the sound. It must be
 		#      specified the same way as in +img+, but the base directory is
@@ -406,6 +422,7 @@ module AGL
 		
 		# Returns a <code>Gosu::Song</code> object. This should be used for the
 		# background musics of your game.
+		# 
 		# Parameters:
 		# [id] A string or symbol representing the path to the song. It must be
 		#      specified the same way as in +img+, but the base directory is
@@ -426,6 +443,7 @@ module AGL
 		# Returns a <code>Gosu::Font</code> object. Fonts are needed to draw text
 		# and used by MiniGL elements like buttons, text fields and TextHelper
 		# objects.
+		# 
 		# Parameters:
 		# [id] A string or symbol representing the path to the song. It must be
 		#      specified the same way as in +img+, but the base directory is

data/lib/minigl/map.rb

@@ -16,6 +16,7 @@ module AGL
 		attr_reader :cam
 		
 		# Creates a new map.
+		# 
 		# Parameters:
 		# [t_w] The width of the tiles.
 		# [t_h] The height of the tiles.
@@ -44,6 +45,7 @@ module AGL
 		
 		# Returns the position in the screen corresponding to the given tile
 		# indices.
+		# 
 		# Parameters:
 		# [map_x] The index of the tile in the horizontal direction. It must be in
 		#         the interval <code>0..t_x_count</code>.
@@ -56,6 +58,7 @@ module AGL
 		# Returns the tile in the map that corresponds to the given position in
 		# the screen, as a Vector, where x is the horizontal index and y the
 		# vertical index.
+		# 
 		# Parameters:
 		# [scr_x] The x-coordinate in the screen.
 		# [scr_y] The y-coordinate in the screen.
@@ -64,6 +67,7 @@ module AGL
 		end
 		
 		# Verifies whether a tile is inside the map.
+		# 
 		# Parameters:
 		# [v] A Vector representing the tile, with x as the horizontal index and
 		#     y as the vertical index.
@@ -73,6 +77,7 @@ module AGL
 		
 		# Sets the top left corner of the viewport to the given position of the
 		# map. Note that this is not the position in the screen.
+		# 
 		# Parameters:
 		# [cam_x] The x-coordinate inside the map, in pixels (not a tile index).
 		# [cam_y] The y-coordinate inside the map, in pixels (not a tile index).
@@ -83,6 +88,7 @@ module AGL
 		end
 		
 		# Moves the viewport by the given amount of pixels.
+		# 
 		# Parameters:
 		# [x] The amount of pixels to move horizontally. Negative values will
 		#     cause the camera to move to the left.

data/lib/minigl/movement.rb

@@ -22,6 +22,7 @@ module AGL
 		attr_reader :passable
 		
 		# Creates a new block.
+		# 
 		# Parameters:
 		# [x] The x-coordinate of the top left corner of the bounding box.
 		# [y] The y-coordinate of the top left corner of the bounding box.
@@ -48,6 +49,7 @@ module AGL
 	# to the +ramps+ array parameter of the +move+ method.
 	class Ramp
 		# Creates a new ramp.
+		# 
 		# Parameters:
 		# [x] The x-coordinate of the top left corner of a rectangle that
 		#     completely (and precisely) encloses the ramp (thought of as a right
@@ -71,6 +73,7 @@ module AGL
 		end
 		
 		# Checks if an object is in contact with this ramp (standing over it).
+		# 
 		# Parameters:
 		# [obj] The object to check contact with. It must have the +x+, +y+, +w+
 		#       and +h+ accessible attributes determining its bounding box.
@@ -80,6 +83,7 @@ module AGL
 		
 		# Checks if an object is intersecting this ramp (inside the corresponding
 		# right triangle and at the floor level or above).
+		# 
 		# Parameters:
 		# [obj] The object to check intersection with. It must have the +x+, +y+,
 		#       +w+ and +h+ accessible attributes determining its bounding box.
@@ -176,6 +180,7 @@ module AGL
 		
 		# Moves this object, based on the forces being applied to it, and
 		# performing collision checking.
+		# 
 		# Parameters:
 		# [forces] A Vector where x is the horizontal component of the resulting
 		#          force and y is the vertical component.
@@ -285,6 +290,7 @@ module AGL
 		
 		# Moves this object as an elevator (i.e., potentially carrying other
 		# objects) towards a given point.
+		# 
 		# Parameters:
 		# [aim] A Vector specifying where the object will move to.
 		# [speed] The constant speed at which the object will move. This must be
@@ -328,6 +334,7 @@ module AGL
 		
 		# Moves this object, without performing any collision checking, towards
 		# the specified point.
+		# 
 		# Parameters:
 		# [aim] A Vector specifying where the object will move to.
 		# [speed] The constant speed at which the object will move. This must be
@@ -357,6 +364,7 @@ module AGL
 		# method must be called repeatedly, and it returns the value that must be
 		# provided to +cur_point+ after the first call). If obstacles are
 		# provided, it will behave as an elevator (as in +move_carrying+).
+		# 
 		# Parameters:
 		# [points] An array of Vectors representing the path that the object will
 		#          perform.

data/lib/minigl/text.rb

@@ -3,6 +3,7 @@ module AGL
 	# text, with control over the text alignment and coloring.
 	class TextHelper
 		# Creates a TextHelper.
+		# 
 		# Parameters:
 		# [font] A <code>Gosu::Font</code> that will be used to draw the text.
 		# [line_spacing] When drawing multiple lines, the distance, in pixels,
@@ -13,6 +14,7 @@ module AGL
 		end
 		
 		# Draws a single line of text.
+		# 
 		# Parameters:
 		# [text] The text to be drawn. No line breaks are allowed.
 		# [x] The horizontal reference for drawing the text. If +mode+ is +:left+,
@@ -41,6 +43,7 @@ module AGL
 		
 		# Draws text, breaking lines when needed and when explicitly caused by the
 		# "\n" character.
+		# 
 		# Parameters:
 		# [text] The text to be drawn. Line breaks are allowed.
 		# [x] The horizontal reference for drawing the text. Works like in

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minigl
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 1.2.7
 platform: ruby
 authors:
 - Victor David Santos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-17 00:00:00.000000000 Z
+date: 2014-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gosu