Games::Risk::Continent - continent object


Games-Risk documentation  | view source Contained in the Games-Risk distribution.

Index


NAME

Top

Games::Risk::Continent - continent object

VERSION

Top

version 3.103040

SYNOPSIS

Top

    my $id = Games::Risk::Continent->new(\%params);

DESCRIPTION

Top

This module implements a map continent, with all its characteristics.

METHODS

Top

Constructor

* my $player = Games::Risk::Continent->new( \%params )

Create a new continent. Mandatory params are id, name and bonus (see below in Accessors for a quick definition).

Accessors

The following accessors (acting as mutators, ie getters and setters) are available for Games::Risk::Continent objects:

* bonus()

number of bonus armies given when a player controls every country in the continent.

* id()

unique id assigned to the continent.

* name()

continent name.

Public methods

* $continent->add_country( $country )

Store $country (a Games::Risk::Country object) as a country located within the $continent.

* $continent->destroy()

Remove all circular references of $continent, to prevent memory leaks.

* my @countries = $continent->countries()

Return the list of countries located in $continent.

* my $p0wned = $continent->is_owned( $player )

Return true if $player is the owner of all $continent's countries.

SEE ALSO

Top

Games::Risk.

AUTHOR

Top

  Jerome Quelin

COPYRIGHT AND LICENSE

Top


Games-Risk documentation  | view source Contained in the Games-Risk distribution.