Documentation

Dice
in package

Dice rolling helper.

Included for historical compatibility only. The Game API is out of support and should not be used in new code.

Tags
author

Daniel Schulz

since
2013-09-20

Table of Contents

Properties

$diceCount  : mixed
$sidesCount  : mixed

Methods

__construct()  : mixed
enclose()  : mixed
getAverage()  : mixed
getMax()  : mixed
getMin()  : mixed
roll()  : mixed
rollEqual()  : mixed
rollHigher()  : mixed
rollImpossible()  : mixed
rollLower()  : mixed
rand()  : mixed

Properties

$diceCount

protected mixed $diceCount

$sidesCount

protected mixed $sidesCount

Methods

__construct()

public __construct(mixed $sidesCount[, mixed $diceCount = 1 ]) : mixed
Parameters
$sidesCount : mixed
$diceCount : mixed = 1

enclose()

public enclose(mixed $value) : mixed
Parameters
$value : mixed

getAverage()

public getAverage() : mixed

getMax()

public getMax() : mixed

getMin()

public getMin() : mixed

roll()

public roll() : mixed

rollEqual()

public rollEqual(mixed $value) : mixed
Parameters
$value : mixed

rollHigher()

public rollHigher(mixed $value) : mixed
Parameters
$value : mixed

rollImpossible()

public rollImpossible() : mixed

rollLower()

public rollLower(mixed $value) : mixed
Parameters
$value : mixed

rand()

protected rand(mixed $min, mixed $max) : mixed
Parameters
$min : mixed
$max : mixed
On this page

Search results