File indexing completed on 2024-12-08 03:47:30

0001 /* This file is part of KsirK.
0002    Copyright (C) 2002-2007 Gael de Chalendar <kleag@free.fr>
0003 
0004    KsirK is free software; you can redistribute it and/or
0005    modify it under the terms of the GNU General Public
0006    License as published by the Free Software Foundation, either version 2
0007    of the License, or (at your option) any later version.
0008 
0009    This program is distributed in the hope that it will be useful,
0010    but WITHOUT ANY WARRANTY; without even the implied warranty of
0011    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0012    General Public License for more details.
0013 
0014    You should have received a copy of the GNU General Public License
0015    along with this program; if not, write to the Free Software
0016    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
0017    02110-1301, USA
0018 */
0019 
0020 #ifndef DICE_H
0021 #define DICE_H
0022 
0023 namespace Ksirk
0024 {
0025 
0026 namespace GameLogic
0027 {
0028 
0029 
0030 /**
0031   * This class implements a dice : roll it with its static method to obtain a 
0032   * random number between 1 and 6.
0033   * @author Gaƫl de Chalendar (aka Kleag) 
0034   */
0035 
0036 class Dice
0037 {
0038 public: 
0039     Dice();
0040     ~Dice();
0041     
0042     /** rolls the dice.
0043     @param max the maximum of the dice (six by default)
0044     @return a random integer between one and the argument (six by default) */
0045     static unsigned int roll(unsigned int max=6);
0046 
0047 };
0048 
0049 }
0050 }
0051 
0052 #endif