NAME

Games::Board::Space - a parent class for spaces on game board

VERSION

version 1.014

SYNOPSIS

  use Games::Board;

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

  $board->add_space(Games::Board::Space->new(
    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 spaces on a game board.

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 space and returns it.

id

This method returns the id of the space.

board

This method returns board on which this space sits.

dir_id

  my $id = $space->dir_id($dir);

This method returns the id of the space found in the given direction from this space.

dir

  my $new_space = $space->dir($dir);

This method returns the space found in the given direction from this space.

contains

  my $bool = $space->contains($piece);

This method returns a true value if the space contains the passed piece.

receive

  $space->receive($piece);

This method will place the given piece onto this space.

take

  $space->take($piece);

This method removes the piece from this 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.