com.sigio.games.dice

Class Die

java.lang.Object

com.sigio.games.dice.Die

Direct Known Subclasses:

DoublingDie

public class Die
extends java.lang.Object

This class simulates dice of various sizes for use in game programming.

Constructor Summary

Constructors

Constructor and Description
Die() Creates a new Die object with the default number (6) of sides.
Die(int s) Creates a new Die object with s number of sides.

Method Summary

Modifier and Type	Method and Description
int	getSides() Returns the number of sides in a class instance.
int	roll() Simulates rolling a single die.
int	roll(int n) Simulates rolling a number of dice with a number of sides represented by this instance.
void	setSides(int s) Accessor to set the number of sides in a class instance.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Die

public Die(int s)

Creates a new Die object with s number of sides.

Parameters:

s - the number of sides represented by this Die object.

Die

public Die()

Creates a new Die object with the default number (6) of sides. This can be used to simulate your ordinary cube dice.

Method Detail

getSides

public int getSides()

Returns the number of sides in a class instance.

Returns:

the int value of the number of sides in this Die instance.

setSides

public void setSides(int s)

Accessor to set the number of sides in a class instance.

Parameters:

s - the new number of sides for the Die.

roll

public int roll(int n)

Simulates rolling a number of dice with a number of sides represented by this instance. The return value ranges from n * 1 to n * the number of sides in this Die instance.

Parameters:

n - number of dice to roll.

Returns:

an int holding the result of rolling the dice

roll

public int roll()

Simulates rolling a single die. The value ranges from 1 to the number of sides on the Die, which could be determined by calling getSides().

Returns:

an int holding the result of rolling one die

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object