search.cpan.org is shutting down
Shlomi Fish > Games-Solitaire-Verify > Games::Solitaire::Verify::Card
Module Version: 0.1800

# NAME

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

version 0.1800

# 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 },
},
);```

version 0.1800

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

## my [@ranks] = \$class->get_ranks_strings()

Returns an (effectively constant) array reference of rank strings.

( Added in version 0.17 .)

## \$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>

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 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.

# SUPPORT

## Perldoc

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

`  perldoc Games::Solitaire::Verify::Card`

## Websites

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.
`  git clone git://github.com/shlomif/fc-solve.git`