Jerome Quelin > WWW-DaysOfWonder-Memoir44-2.120510 > WWW::DaysOfWonder::Memoir44::Scenario

Download:
WWW-DaysOfWonder-Memoir44-2.120510.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

Open  0
View/Report Bugs
Module Version: 2.120510   Source   Latest Release: WWW-DaysOfWonder-Memoir44-3.000

NAME ^

WWW::DaysOfWonder::Memoir44::Scenario - scenario object

VERSION ^

version 2.120510

DESCRIPTION ^

This module represents a scenario with all its attributes.

ATTRIBUTES ^

my $int = $scenario->id;

Id of the scenario.

my $str = $scenario->name;

Name of the scenario.

my $str = $scenario->operation;

Operation the scenario is part of.

my $date = $scenario->updated;

Date of last scenario update (format yyyy-mm-dd).

my $int = $scenario->rating;

Average scenario rating (1, 2 or 3).

my $str = $scenario->front;

Front where the scenario takes place. Can be West, East, Mediterranean, etc.

my $str = $scenario->author;

Who wrote the scenario.

my $str = $scenario->board;

Country, beach, winter or desert.

my $str = $scenario->format;

Standard, overlord or breakthru.

my $str = $scenario->source;

Game (bundled with board game), approved (official extensions), public (all the other).

my $bool = $scenario->need_tp;

Whether terrain pack extension is needed.

my $bool = $scenario->need_ef;

Whether eastern front extension is needed.

my $bool = $scenario->need_mt;

Whether mediterranean theater extension is needed.

my $bool = $scenario->need_pt;

Whether pacific theater extension is needed.

my $bool = $scenario->need_ap;

Whether air pack extension is needed.

my $bool = $scenario->need_bm;

Whether battle maps extension is needed.

my $bool = $scenario->need_cb;

Whether campaign book extension is needed.

METHODS ^

as_string

    my $str = $scenario->as_string;

Return a line (with a final \n) dumping the scenario and all its attributes. It is also the method called for stringification, eg when doing stuff like:

    print $scenario;

tp

ef

pt

mt

ap

    my $str = $scenario->tp;
    my $str = $scenario->ef;
    my $str = $scenario->pt;
    my $str = $scenario->mt;
    my $str = $scenario->ap;

Those five methods return either an empty string or the abbreviation of the expansion depending on the value of the need_XX boolean attribute of the $scenario. They are useful for display purposes.

langs

    my $str = $scenario->langs;

Return a string with existing language versions this scenario separated by commas. eg en,fr.

rating_as_star

    my $str = $scenario->rating_as_star;

Return a string of 0 to 3 stars * depending on the rating attribute of the $scenario.

AUTHOR ^

Jerome Quelin

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2009 by Jerome Quelin.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

syntax highlighting: