Games:...::State(3pm)

📦

version 0.2601 · 2 versions

0.2601 · fedora 43 (latest)
0.2601 · fedora 44

💖 Games::Solitaire::Verify::State — the perl 3pm manual, but make it cute 💖

okay bestie, sit down, we're doing Games::Solitaire::Verify::State, a whole class for Solitaire states (or positions, same thing, no gatekeeping) of the entire board. Yes, the whole thing. Every freecell, every foundation, every column, all of it. She's giving main character energy for the entire solitaire table 💅

✨ NAME ✨

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

🎀 VERSION 🎀

version 0.2601 — yes she's numbered, yes she's iconic ⭐

🦋 SYNOPSIS 🦋

here's the vibe, literally just look at it:

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
EOF

# 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"

(yes there are two my $boards, no we're not fixing it, that's how the original rolls, and the last line has no semicolon either — not me pointing that out 🙈)

💅 FUNCTIONS 💅

🌸 `$self->set_freecells($freecells)`

Sets the freecells' object, which should be a Games::Solitaire::Verify::Freecells object. like, hand her the right object pls 🫶

🌸 `$self->add_column($columns)`

Adds a new column of cards that should be an Games::Solitaire::Verify::Column object. one more column, slay 💐

🌸 `$self->set_foundations($foundations);`

Sets the foundations to a value. Should be isa Games::Solitaire::Verify::Foundations . periodt, foundation secured 👑

🌸 `$state->get_freecell($index)`

Returns the contents of the freecell No. $index or undef() if it's empty. lowkey empty freecells are just vibes 🕳️

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

Assigns $card to the contents of the freecell No. $index . put the card down bestie 🃏

🌸 `$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 . go up, go up ⬆️✨

🌸 `$board->num_decks()`

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

🌸 `$board->num_freecells()`

Returns the number of Freecells in the board. count 'em 💀

🌸 `$board->num_empty_freecells()`

Returns the number of empty Freecells on the board. the lonely ones 😭

🌸 `$board->num_columns()`

The number of columns in the board. (in the synopsis it prints 8, iconic of her)

🌸 `$board->get_column($index)`

Gets the column object for column No. $index . 🏛️

🌸 `$board->num_empty_columns()`

Returns the number of completely unoccupied columns in the board. untouched, pristine, no cap 🌵

🌸 `$board->clone()`

Returns a clone of the board, with all of its element duplicated. she's her own twin fr fr 👯‍♀️

🌸 `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. verdict delivered, court adjourned ⚖️🔥

🌸 `$self->clear_freecell($index)`

Clears/empties the freecell at position $pos . 🧹✨

🌸 `$board->verify_contents({max_rank => 13});`

Verify that all the cards inside the state are present and exactly once. 'max_rank' should be 13 unless you want to only include cards up to a lower rank.

This method either throws an exception object or returns normally. so like, it's either fine or it's throwing hands 😤

(New in version 0.1900 .) 🍼

🌸 `$self->to_string()`

Stringifies the board into the Freecell Solver solution display notation. she speaks fluent notation 🗣️💬

🫶 SUPPORT 🫶

🌈 Websites

The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.

MetaCPAN

A modern, open-source CPAN search engine, useful to view POD in HTML format.

<https://metacpan.org/release/Games-Solitaire-Verify>

RT: CPAN's Bug Tracker

The RT ( Request Tracker ) website is the default bug/issue tracking system for CPAN.

<https://rt.cpan.org/Public/Dist/Display.html?Name=Games-Solitaire-Verify>

CPANTS

The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.

<http://cpants.cpanauthors.org/dist/Games-Solitaire-Verify>

CPAN Testers

The CPAN Testers is a network of smoke testers who run automated tests on uploaded CPAN distributions.

<http://www.cpantesters.org/distro/G/Games-Solitaire-Verify>

CPAN Testers Matrix

The CPAN Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms.

<http://matrix.cpantesters.org/?dist=Games-Solitaire-Verify>

CPAN Testers Dependencies

The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution.

<http://deps.cpantesters.org/?module=Games::Solitaire::Verify>

🌈 Bugs / Feature Requests

Please report any bugs or feature requests by email to "bug-games-solitaire-verify at rt.cpan.org", or through the web interface at <https://rt.cpan.org/Public/Bug/Report.html?Queue=Games-Solitaire-Verify>. You will be automatically notified of any progress on the request by the system. bestie the system will literally text you back 📬💖

🌈 Source Code

The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)

<https://github.com/shlomif/fc-solve>

git clone git://github.com/shlomif/fc-solve.git

👑 AUTHOR 👑

Shlomi Fish <shlomif@cpan.org> — the author himself, we stan 🫡💜

💀 BUGS 💀

Please report any bugs or feature requests on the bugtracker website <https://github.com/shlomif/fc-solve/issues>

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature. receipts or it didn't happen 🧾✨

🌸 COPYRIGHT AND LICENSE 🌸

This is free software, licensed under:

The MIT (X11) License

and that's the whole page, bestie 🎀 perl v5.42.0, dated 2025-07-25, straight out of the Games:...::State(3pm) docs. go forth and verify some solitaire states, you absolute legend 💖🦋⭐

📦 where this page comes from

fedora 43: perl-Games-Solitaire-Verify 0.2601-3.fc43 · MIT
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms

Games:...::State(3pm)

💖 Games::Solitaire::Verify::State — the perl 3pm manual, but make it cute 💖

✨ NAME ✨

🎀 VERSION 🎀

🦋 SYNOPSIS 🦋

💅 FUNCTIONS 💅

🌸 $self->set_freecells($freecells)

🌸 $self->add_column($columns)

🌸 $self->set_foundations($foundations);

🌸 $state->get_freecell($index)

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

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

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

🌸 $board->num_decks()

🌸 $board->num_freecells()

🌸 $board->num_empty_freecells()

🌸 $board->num_columns()

🌸 $board->get_column($index)

🌸 $board->num_empty_columns()

🌸 $board->clone()

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

🌸 $self->clear_freecell($index)

🌸 $board->verify_contents({max_rank => 13});

🌸 $self->to_string()