org.spongepowered.api.util.weighted

Interface SeededVariableAmount<T>

Type Parameters:

T - The seed object type

All Known Implementing Classes:

SeededVariableAmount.WrappedVariableAmount

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface SeededVariableAmount<T>

Represents a value which may vary depending on a seed object.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SeededVariableAmount.WrappedVariableAmount<T> A SeededVariableAmount which wraps another VariableAmount and defers all operations to the inner VariableAmount without the seed.

Method Summary

Modifier and Type	Method and Description
static <T> SeededVariableAmount<T>	fixed(double value) Creates a new 'fixed' variable amount, calls to getAmount(java.util.Random, T) will always return the fixed value.
double	getAmount(Random rand, T seed) Gets an instance of the variable amount depending on the given random object and the seed object.
default int	getFlooredAmount(Random rand, T seed) Gets the amount as if from getAmount(Random, Object) but floored to the nearest integer equivalent.
static <T> SeededVariableAmount<T>	wrapped(VariableAmount value) Creates a new variable amount wrapping the given VariableAmount, calls to getAmount(java.util.Random, T) will always return wrapped amounts value.

Method Detail

fixed

static <T> SeededVariableAmount<T> fixed(double value)

Creates a new 'fixed' variable amount, calls to getAmount(java.util.Random, T) will always return the fixed value.

Type Parameters:

T - The seed object type

Parameters:

value - The fixed value

Returns:

A variable amount representation

wrapped

static <T> SeededVariableAmount<T> wrapped(VariableAmount value)

Creates a new variable amount wrapping the given VariableAmount, calls to getAmount(java.util.Random, T) will always return wrapped amounts value.

Type Parameters:

T - The seed object type

Parameters:

value - The wrapped variable amount

Returns:

A variable amount representation

getAmount

double getAmount(Random rand,
                 T seed)

Gets an instance of the variable amount depending on the given random object and the seed object.

Parameters:

rand - The random object

seed - The seed object

Returns:

The amount

getFlooredAmount

default int getFlooredAmount(Random rand,
                             T seed)

Gets the amount as if from getAmount(Random, Object) but floored to the nearest integer equivalent.

Parameters:

rand - The random object

seed - The seed object

Returns:

The floored amount