• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdegames API Reference
  • KDE Home
  • Contact Us
 

libkdegames/libkdegamesprivate/kgame

Public Member Functions | List of all members
KGameSequence Class Reference

#include <KGame/KGameSequence>

Inheritance diagram for KGameSequence:
Inheritance graph
[legend]

Public Member Functions

 KGameSequence ()
 
virtual ~KGameSequence ()
 
virtual int checkGameOver (KPlayer *player)
 
KPlayer * currentPlayer () const
 
KGame * game () const
 
virtual KPlayer * nextPlayer (KPlayer *last, bool exclusive=true)
 
virtual void setCurrentPlayer (KPlayer *p)
 
void setGame (KGame *game)
 

Detailed Description

This class takes care of round or move management as well of the gameover condition.

It is especially used for round based games. For these games nextPlayer and checkGameOver are the most important methods.

You can subclass KGameSequence and use KGame::setGameSequence to use your own rules. Note that KGame will take ownership and therefore will delete the object on destruction. Round/move management class

Author
Andreas Beckermann b_man.nosp@m.n@gm.nosp@m.x.de

Definition at line 44 of file kgamesequence.h.

Constructor & Destructor Documentation

KGameSequence::KGameSequence ( )

Definition at line 41 of file kgamesequence.cpp.

KGameSequence::~KGameSequence ( )
virtual

Definition at line 46 of file kgamesequence.cpp.

Member Function Documentation

int KGameSequence::checkGameOver ( KPlayer *  player)
virtual

Check whether the game is over.

The default implementation always returns 0.

Parameters
playerthe player who made the last move
Returns
anything else but 0 is considered as game over

Definition at line 141 of file kgamesequence.cpp.

KPlayer * KGameSequence::currentPlayer ( ) const

Definition at line 61 of file kgamesequence.cpp.

KGame * KGameSequence::game ( ) const
Returns
The KGame object this sequence is for, or NULL if none.

Definition at line 56 of file kgamesequence.cpp.

KPlayer * KGameSequence::nextPlayer ( KPlayer *  last,
bool  exclusive = true 
)
virtual

Select the next player in a turn based game.

In an asynchronous game this function has no meaning. Overwrite this function for your own game sequence. Per default it selects the next player in the playerList

Definition at line 71 of file kgamesequence.cpp.

void KGameSequence::setCurrentPlayer ( KPlayer *  p)
virtual

Definition at line 66 of file kgamesequence.cpp.

void KGameSequence::setGame ( KGame *  game)

Set the KGame object for this sequence.

This is called automatically by KGame::setGameSequence and you should not call it.

Definition at line 51 of file kgamesequence.cpp.


The documentation for this class was generated from the following files:
  • kgamesequence.h
  • kgamesequence.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:44:48 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

libkdegames/libkdegamesprivate/kgame

Skip menu "libkdegames/libkdegamesprivate/kgame"
  • Main Page
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdegames API Reference

Skip menu "kdegames API Reference"
  • granatier
  • kapman
  • kblackbox
  • kgoldrunner
  • kigo
  • kmahjongg
  • KShisen
  • ksquares
  • libkdegames
  •   highscore
  •   libkdegamesprivate
  •     kgame
  • libkmahjongg
  • palapeli
  •   libpala

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal