Shlomi Fish > Games-Solitaire-Verify-0.1400 > Games::Solitaire::Verify::Card

Download:
Games-Solitaire-Verify-0.1400.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.1400   Source  

NAME ^

Games::Solitaire::Verify::Card - a class wrapper for an individual Solitaire card.

VERSION ^

version 0.1400

SYNOPSIS ^

    use Games::Solitaire::Verify::Card;

    # Initialise a Queen-of-Hearts
    my $queen_of_hearts = Games::Solitaire::Verify::Card->new(
        {
            string => "QH",
            id => 4,
            data => { %DATA },
        },
    );

METHODS ^

$class->get_suits_seq()

Returns the expected sequence of the suits - "H", "S", "C", "D".

$class->calc_rank($rank_string)

Calculates the numerical rank of the string passed as argument.

Example:

    my $ten = Games::Solitaire::Verify::Card->calc_rank("T")
    # Prints 10.
    print "$ten\n";

$class->calc_rank_with_0($rank_string)

Same as calc_rank only supporting "0" as the zero'th card.

$card->data()

Arbitrary data that is associated with the card. Can hold any scalar.

$card->id()

A simple identifier that identifies the card. Should be a string.

$card->rank()

Returns the rank of the card as an integer. Ace is 1, 2-10 are 2-10; J is 11, Q is 12 and K is 13.

$card->suit()

Returns "H", "C", "D" or "S" depending on the suit.

$card->color()

Returns "red" or "black" depending on the rank of the card.

$card->color_for_suit($suit)

Get the color of the suit $suit (which may be different than the card's suit).

my $copy = $card->clone();

Clones the card into a new copy.

$card->to_string()

Converts the card to a string representation.

$card->fast_s()

A cached string representation. (Use with care).

$class->rank_to_string($rank_idx)

Converts the rank to a string.

$card->is_flipped()

Determines if the card is flipped.

$card->set_flipped($flipped_bool)

Sets the card’s flipped status.

AUTHOR ^

Shlomi Fish <shlomif@cpan.org>

COPYRIGHT AND LICENSE ^

This software is Copyright (c) 2014 by Shlomi Fish.

This is free software, licensed under:

  The MIT (X11) License

BUGS ^

Please report any bugs or feature requests on the bugtracker website http://rt.cpan.org/NoAuth/Bugs.html?Dist=Games-Solitaire-Verify or by email to bug-games-solitaire-verify@rt.cpan.org.

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.

SUPPORT ^

Perldoc

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

  perldoc Games::Solitaire::Verify

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.

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 http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Games-Solitaire-Verify. You will be automatically notified of any progress on the request by the system.

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

http://bitbucket.org/shlomif/fc-solve

  git clone http://bitbucket.org/shlomif/fc-solve
syntax highlighting: