NAME

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

VERSION

version 1.014

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.

PERL VERSION

This module should work on any version of perl still receiving updates from the Perl 5 Porters. This means it should work on any version of perl released in the last two to three years. (That is, if the most recently released version is v5.40, then this module should work on both v5.40 and v5.38.)

Although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. The version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl.

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

$piece->move(dir => 'up')

$piece->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.

AUTHOR

Ricardo SIGNES <cpan@semiotic.systems>

COPYRIGHT AND LICENSE

This software is copyright (c) 2003 by Ricardo SIGNES.

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