Volity::Seat 0.6.5

Volity::Seat is a Volity seat, containing some players.

SYNOPSIS

# From within a Volity::Game subclasss code:
my @seats = $self->seats;

# Or, given a Volity::Player object:
my $seat = $player->seat;

# Now tell the seat they just picked up the Three of Clubs:
$seat->call_ui_function("draw_card", "3C")

An objects of this class represents a seat at a Volity table. Volity players who are actually playing a game sit in seats, and referees address game-specific RPC calls to seats, not to individual players. See the main Volity documentation for more information about the seat concept: http://www.volity.org/wiki/index.cgi?action=browse&id=Seats

USAGE

As a game programmer, you need never create, modify, or destroy these objects yourself; that is all handled for you by the other objects that make up a Frivolity-run table, particularly the referee (see Volity::Referee). However, several methods of Volity::Game, the module you subclass to create your own Perl-based Volity game, will return objects of this class. Several crucial functions of communicating with a games players involve calling methods on these objects, including the all-important call_ui_function method (described below).

Your Volity::Game subclass must define some variables that assist the referee in seat creation, particularly the seat_ids and required_seat_ids class variables. If you wish to extend this class for your game, you can speficy a Volity::Seat subclass to use through Volity::Games seat_class method. All these are described in detail within Volity::Game.