Die

net.namibsun.dice.objects.Die

Direct Known Subclasses:

ClassicDie, TextDie
```
public class Die
```
Abstract class that defines common Dice behaviour for different dice types

Constructor Summary

Constructors
Constructor and Description
`Die(BaseActivity context, android.view.View view, Theme theme, java.lang.String storedValueKey, int limit, int minimum, int initialValue, int wiggleAnimationResource)` Abstract class that defines common Dice behaviour for different dice types

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`draw()` Draws the Current Information as the View
`BaseActivity`	`getContext()` :
`int`	`getCurrentValue()` The current value of the die
`int`	`getLimit()` :
`int`	`getMinimum()` :
`java.security.SecureRandom`	`getRandom()` An object that can generate random numbers
`java.lang.String`	`getStoredValueKey()` :
`Theme`	`getTheme()` :
`int`	`getValue()`
`android.view.View`	`getView()` :
`int`	`getWiggleAnimationResource()` :
`boolean`	`isAnimating()`
`void`	`next(java.lang.Integer specificNumber)` Displays the next value in the view
`int`	`nextRandomNumber()` Generates a new random number within the limits
`void`	`roll()` Rolls the Die according to the settings provided by the theme
`void`	`setCurrentValue(int p)` The current value of the die
`void`	`setLimit(int p)` :
`void`	`setMinimum(int p)` :
`void`	`setTheme(Theme p)` :
`void`	`updateTheme(Theme theme)` Updates the theme of the Die

- Constructor Detail
  - Die
```
public Die(BaseActivity context,
           android.view.View view,
           Theme theme,
           java.lang.String storedValueKey,
           int limit,
           int minimum,
           int initialValue,
           int wiggleAnimationResource)
```
    Abstract class that defines common Dice behaviour for different dice types
    
    Parameters:
    
    context - : The Activity using the Die
    
    view - : The View displaying the die
    
    theme - : The theme that defines the look of the View
    
    storedValueKey - : The key string used to store the current value in the shared preferences
    
    limit - : The maximum value of the Die
    
    minimum - : The minimum value of the Die
    
    initialValue - : The initial value of the Die
    
    wiggleAnimationResource - : Overrides the default wiggle animation if set
    
    context - : The Activity using the Die
    
    view - : The View displaying the die
    
    theme - : The theme that defines the look of the View
    
    storedValueKey - : The key string used to store the current value in the shared preferences
    
    limit - : The maximum value of the Die
    
    minimum - : The minimum value of the Die
    
    initialValue - : The initial value of the Die
    
    wiggleAnimationResource - : Overrides the default wiggle animation if set
- Method Detail
  - draw
```
public void draw()
```
    Draws the Current Information as the View
  - getCurrentValue
```
public int getCurrentValue()
```
    The current value of the die
  - setCurrentValue
```
public void setCurrentValue(int p)
```
    The current value of the die
  - getRandom
```
public java.security.SecureRandom getRandom()
```
    An object that can generate random numbers
  - next
```
public void next(java.lang.Integer specificNumber)
```
    Displays the next value in the view
    
    Parameters:
    
    specificNumber - : Instead of a random number, display a specific number
  - updateTheme
```
public void updateTheme(Theme theme)
```
    Updates the theme of the Die
    
    Parameters:
    
    theme - : The theme to change to
  - roll
```
public void roll()
```
    Rolls the Die according to the settings provided by the theme
  - getValue
```
public int getValue()
```
    Returns:
    
    The current value of the die
  - isAnimating
```
public boolean isAnimating()
```
    Returns:
    
    true if the die is currently being animated, false otherwise
  - nextRandomNumber
```
public int nextRandomNumber()
```
    Generates a new random number within the limits
    
    Returns:
    
    The generated random number
  - getContext
```
public BaseActivity getContext()
```
    :
    The Activity using the Die
  - getView
```
public android.view.View getView()
```
    :
    The View displaying the die
  - getTheme
```
public Theme getTheme()
```
    :
    The theme that defines the look of the View
  - setTheme
```
public void setTheme(Theme p)
```
    :
    The theme that defines the look of the View
    
    Parameters:
    
    p - : The theme that defines the look of the View
  - getStoredValueKey
```
public java.lang.String getStoredValueKey()
```
    :
    The key string used to store the current value in the shared preferences
  - getLimit
```
public int getLimit()
```
    :
    The maximum value of the Die
  - setLimit
```
public void setLimit(int p)
```
    :
    The maximum value of the Die
    
    Parameters:
    
    p - : The maximum value of the Die
  - getMinimum
```
public int getMinimum()
```
    :
    The minimum value of the Die
  - setMinimum
```
public void setMinimum(int p)
```
    :
    The minimum value of the Die
    
    Parameters:
    
    p - : The minimum value of the Die
  - getWiggleAnimationResource
```
public int getWiggleAnimationResource()
```
    :
    Overrides the default wiggle animation if set

Class Die

Constructor Summary

Method Summary

Constructor Detail

Die

Method Detail

draw

getCurrentValue

setCurrentValue

getRandom

next

updateTheme

roll

getValue

isAnimating

nextRandomNumber

getContext

getView

getTheme

setTheme

getStoredValueKey

getLimit

setLimit

getMinimum

setMinimum

getWiggleAnimationResource