[ViewVC] Diff of: cvs/Games-Go-SimpleBoard/SimpleBoard.pm

Comparing Games-Go-SimpleBoard/SimpleBoard.pm (file contents):
Revision 1.1 by root, Sun Jun 22 15:05:59 2008 UTC vs.
Revision 1.2 by root, Mon Jun 23 00:38:35 2008 UTC

    }
    @found
 }
-=item $hint = $board->update ([update-structure...])
+=item $hint = $board->update ([update-structures...])
-Structure is
+Each update-structure itself is also an array-ref:
    [$x, $y, $clr, $set, $label, $hint] # update or move
    []                                  # pass
-and changes the board or executes a move, by first clearing the bits
+It changes the board or executes a move, by first clearing the bits
 specified in C<$clr>, then setting bits specified in C<$set>.
 If C<$set> includes C<MARK_LABEL>, the label text must be given in
 C<$label>.
 This function modifies the hint member of the specified path to speed up
 repeated board generation and updates with the same update structures.
 If the hint member is a reference the scalar pointed to by the reference
 is updated instead.
+If all this hint member thing is unclear, just ignore it and specify it
+as C<undef> or leave it out of the array entirely. Do make sure that you
+keep your update structures around, however, as regenerating a full board
+position from hinted update structures is I<much> faster then recreating
+it from fresh update structures.
 Example, make two silly moves:
   $board->update ([[0, 18, -1, MARK_B|MARK_MOVE],
                    [0, 17, -1, MARK_W|MARK_MOVE]);

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines