Jonathan Rockway > Weewar-0.01 > Weewar::Game

Download:
Weewar-0.01.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Source  

NAME ^

Weewar::Game - a weewar game

SYNOPSIS ^

   my $game = WeeWar::game->new({ id => 27093 });
   $game->name;

METHODS ^

name

Returns the name of the game

id

Returns the game's id

state

Returns the game's state, something like "lobby", "running", "finished", etc.

round

Returns the current turn number if the game is in the running state.

pending_invites

Returns true if the game is still waiting for some players to accept invites. False otherwise.

pace

Returns the number of seconds before an idle player can be kicked.

type

Returns the game type

map

Returns the name of the map this game is using

map_url

Returns the URL of the current map's description page

credits_per_base

Returns the number of credits a base generates each turn

initial_credits

Returns the number of credits each player starts with

playing_since

If the game is in progress, returns a DateTime object representing the game's start time.

players

Returns a list of Weewar::Users that are playing this game.

SEE ALSO ^

See Weewar for the main docs.

syntax highlighting: