.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Games::Sequential 3"
.TH Games::Sequential 3 "2008-01-05" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Games::Sequential \- sequential games framework with OO interface
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    package My::GamePos;
\&    use base qw(Games::Sequential::Position);
.Ve
.PP
.Vb 1
\&    sub apply { ... }
.Ve
.PP
.Vb 3
\&    package main;
\&    use My::GamePos;
\&    use Games::Sequential;
.Ve
.PP
.Vb 2
\&    my $pos = My::GamePos->new;
\&    my $game = Games::Sequential->new($pos);
.Ve
.PP
.Vb 3
\&    $game->debug(1);
\&    $game->move($mv);
\&    $game->undo;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Games::Sequential is a framework for producing sequential games.
Among other things it keeps track of the sequence of moves, and
provides an unlimited \f(CW\*(C`undo()\*(C'\fR mechanism. It also has methods to
\&\f(CW\*(C`clone()\*(C'\fR or take a \f(CW\*(C`snapshot()\*(C'\fR of a game.
.PP
Users must pass an object representing the initial state of the
game as the first argument to \f(CW\*(C`new()\*(C'\fR. This object must provide
the two methods \f(CW\*(C`copy()\*(C'\fR and \f(CW\*(C`apply()\*(C'\fR. You can use
Games::Sequential::Position as a base class, in which case the
\&\f(CW\*(C`copy()\*(C'\fR method will be provided for you. The \f(CW\*(C`apply()\*(C'\fR method
must take a move and apply it to the current position, producing
the next position in the game. 
.SH "METHODS"
.IX Header "METHODS"
Users must not modify the referred-to values of references
returned by any of the below methods.
.ie n .IP "new $initialpos [@list]" 4
.el .IP "new \f(CW$initialpos\fR [@list]" 4
.IX Item "new $initialpos [@list]"
Create and return a new Games::Sequential object. The first
argument must be an object representing the initial position of
the game. The \f(CW\*(C`debug\*(C'\fR option can also be set here. 
.IP "_init [@list]" 4
.IX Item "_init [@list]"
\&\fIInternal method\fR
.Sp
Initialize a Games::Sequential object.
.IP "debug [$value]" 4
.IX Item "debug [$value]"
Return current debug level and, if invoked with an argument, set
to new value.
.IP "peek_pos" 4
.IX Item "peek_pos"
Return reference to current position.
Use this for drawing the board etc.
.IP "peek_move" 4
.IX Item "peek_move"
Return reference to last applied move.
.ie n .IP "move $move" 4
.el .IP "move \f(CW$move\fR" 4
.IX Item "move $move"
Apply \f(CW$move\fR to the current position, keeping track of history.
A reference to the new position is returned, or undef on failure.
.IP "undo" 4
.IX Item "undo"
Undo last move. A reference to the previous position is returned,
or undef if there was no more moves to undo.
.SH "TODO"
.IX Header "TODO"
Implement the missing methods \f(CW\*(C`clone()\*(C'\fR, \f(CW\*(C`snapshot()\*(C'\fR,
\&\f(CW\*(C`save()\*(C'\fR & \f(CW\*(C`resume()\*(C'\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
The author's website, describing this and other projects:
<http://brautaset.org/software/>
.SH "AUTHOR"
.IX Header "AUTHOR"
Stig Brautaset, <stig@brautaset.org>
.SH "COPYRIGHT AND LICENCE"
.IX Header "COPYRIGHT AND LICENCE"
Copyright (C) 2004\-2005 by Stig Brautaset
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.3 or,
at your option, any later version of Perl 5 you may have available.