Ricardo SIGNES > Games-Board-1.011 > Games::Board::Piece

Download:
Games-Board-1.011.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 1.011   Source   Latest Release: Games-Board-1.013

NAME ^

Games::Board::Piece -- a parent class for board game pieces

VERSION ^

 $Id: /my/cs/projects/board/trunk/lib/Games/Board/Piece.pm 27799 2006-11-11T02:23:32.940873Z rjbs  $

SYNOPSIS ^

  use Games::Board;

  my $board = Games::Board->new;

  $board->add_space(
        id   => 'go',
        dir  => { next => 'mediterranean', prev => 'boardwalk' },
        cost => undef
  );

  my $tophat = Games::Board::Piece->new(id => 'tophat')->move(to => 'go');

DESCRIPTION ^

This module provides a base class for representing the pieces in a board game.

METHODS ^

new

This method constructs a new game piece and returns it.

id

This returns the piece's id.

board

This returns the board object to which the piece is related.

current_space_id

This returns the id of the space on which the piece currently rests, if any. It it's not on any space, it returns undef.

current_space

This returns the Space on which the piece currently rests, if any. It it's not on any space, it returns undef.

move(dir => 'up')
move(to => $space)

This method moves the piece to a new space on the board. If the method call is in the first form, the piece is moved to the space in the given direction from the piece's current space. If the method call is in the second form, and $space is a Games::Board::Space object, the piece is moved to that space.

TODO ^

implement this dist!

AUTHOR ^

Ricardo SIGNES <rjbs@cpan.org>

COPYRIGHT ^

Copyright 2003-2004 by Ricardo Signes <rjbs@cpan.org>

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

See http://www.perl.com/perl/misc/Artistic.html

syntax highlighting: