Shlomi Fish > Games-Solitaire-Verify-0.1203 > Games::Solitaire::Verify::State



Annotate this POD



Open  0
View/Report Bugs
Module Version: 0.1203   Source   Latest Release: Games-Solitaire-Verify-0.1701


Games::Solitaire::Verify::State - a class for Solitaire states (or positions) of the entire board.


Version 0.0101


    use Games::Solitaire::Verify::State;

    my $board = <<"EOF";
    Foundations: H-6 C-A D-A S-4
    Freecells:  3D  8H  JH  9H
    : 4C 2C 9C 8C QS JD
    : KS QH
    : QC 9S
    : 5C
    : 2D KD TH TC TD 8D 7C 6D 5S 4D 3C
    : 7H JS KH TS KC QD JC
    : 9D 8S
    : 7S 6C 7D 6S 5D

    # Initialise a board
    my $board = Games::Solitaire::Verify::State->new(
            string => $board,
            variant => "freecell",

    # Prints 8.
    print $board->num_columns(), "\n";

    # Prints ": QC 9S"
    print $board->get_column(2)->to_string(), "\n"



Sets the freecells' object, which should be a Games::Solitaire::Verify::Freecells object.


Adds a new column of cards that should be an Games::Solitaire::Verify::Column object.


Sets the foundations to a value. Should be isa Games::Solitaire::Verify::Foundations .


Returns the contents of the freecell No. $index or undef() if it's empty.

$state->set_freecell($index, $card)

Assigns $card to the contents of the freecell No. $index .

$state->get_foundation_value($suit, $index)

Returns the foundation value for the suit $suit of the foundations No. $index .

$state->increment_foundation_value($suit, $index)

Increments the foundation value for the suit $suit of the foundations No. $index .


Returns the number of decks that the variant has. Useful when querying the foundations.


Returns the number of Freecells in the board.


Returns the number of empty Freecells on the board.


The number of columns in the board.


Gets the column object for column No. $index.


Returns the number of completely unoccupied columns in the board.


Returns a clone of the board, with all of its element duplicated.

my $verdict = $board->verify_and_perform_move($move);

Performs $move on the board. If successful, returns 0. Else returns a non-zero value. See Games::Solitaire::Verify::Move for more information.


Clears/empties the freecell at position $pos .


Stringifies the board into the Freecell Solver solution display notation.


Shlomi Fish,


Please report any bugs or feature requests to bug-games-solitaire-verifysolution-move at, or through the web interface at I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.


You can find documentation for this module with the perldoc command.

    perldoc Games::Solitaire::Verify::Column

You can also look for information at:



Copyright 2008 Shlomi Fish.

This program is released under the following license: MIT/X11 ( ).

syntax highlighting: