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

Download:
Games-Board-1.013.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 1.013   Source  

NAME ^

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

VERSION ^

version 1.013

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

  $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 <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: