Ricardo SIGNES > Games-Board-1.013 > Games::Board::Space

Download:
Games-Board-1.013.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 1.013   Source  

NAME ^

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

VERSION ^

version 1.013

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.

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.

AUTHOR ^

Ricardo SIGNES <rjbs@cpan.org>

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.

syntax highlighting: