SA_DiceBag.h

   1 //
   2 //  SA_DiceBag.h
   3 //
   4 //  Copyright 2016-2021 Said Achmiz.
   5 //  See LICENSE and README.md for more info.
   6
   7 #import <Foundation/Foundation.h>
   8
   9 typedef NS_OPTIONS(NSUInteger, SA_DiceRollingOptions) {
  10         SA_DiceRollingExplodingDice = 1 << 1
  11 };
  12
  13 /****************************************/
  14 #pragma mark SA_DiceBag class declaration
  15 /****************************************/
  16
  17 @interface SA_DiceBag : NSObject
  18
  19 /****************************/
  20 #pragma mark - Public methods
  21 /****************************/
  22
  23 -(NSUInteger) biggestPossibleDieSize;
  24
  25 // -------------
  26 // Regular dice.
  27 // -------------
  28
  29 -(NSUInteger) rollDie:(NSUInteger)dieSize;
  30
  31 -(NSArray <NSNumber *> *) rollNumber:(NSUInteger)number
  32                                                           ofDice:(NSUInteger)dieSize;
  33
  34 -(NSArray <NSNumber *> *) rollNumber:(NSUInteger)number
  35                                                           ofDice:(NSUInteger)dieSize
  36                                                  withOptions:(SA_DiceRollingOptions)options;
  37
  38 // -----------
  39 // Fudge dice.
  40 // -----------
  41
  42 -(char) rollFudgeDie;
  43
  44 -(NSArray <NSNumber *> *) rollFudgeDice:(NSUInteger)number;
  45
  46 @end