/ 
VANAMBURG-Magic-0.04
River stage zero No dependents
/ VANAMBURG::SuitSingletonSHoCkeD

VANAMBURG::SuitSingletonSHoCkeD

Provides access to instances of VANAMBURG::OrderedSuit to efficiently represent the suits in a SHoCkeD style deck stack.

spade

An instance of VANAMBURG::OrderedSuit to efficiently represent the Spades suit in a SHoCkeD stack.

heart

An instance of VANAMBURG::OrderedSuit to efficiently represent the Hearts suit in a SHoCkeD stack.

club

An instance of VANAMBURG::OrderedSuit to efficiently represent the Clubs suit in a SHoCkeD stack.

diamond

An instance of VANAMBURG::OrderedSuit to efficiently represent the Diamonds suit in a SHoCkeD stack.

suit_cycle

An array reference holding each of the suit instances in an ordered in SHoCkeD order.

opposite_suit

Returns the mate of the card passed as input.

my $heart = $self->opposite_suit($self->diamond);

next_suit

Returns the suit following the input suit for a SHoCkeD packet.

my $heart = $self->next_suit($self->spade);
my $spade = $self->next_suit($self->diamond);

previous_suit

Returns the suit preceding the input suit for a SHoCkeD packet.

my $heart   = $self->previous_suit($self->club);
my $diamond = $self->previous_suit($self->spade);