net.tridentsdk.world.gen

Class GeneratorRandom

java.lang.Object

net.tridentsdk.world.gen.GeneratorRandom

@ThreadSafe
public class GeneratorRandom
extends Object

Used to generate random values for world generators

Author:

The TridentSDK Team

Constructor Summary

Constructors

Constructor and Description
GeneratorRandom() Creates a new generator random using a random seed
GeneratorRandom(long seed) Creates a new seeded generator random

Method Summary

Modifier and Type	Method and Description
GeneratorRandom	fork() Forks the random using a new random seed generated from this random
GeneratorRandom	fork(long seed) Forks the random using the provided sed
long	scaleUnder(long end, long min, long max) Scales the next random long between the given min and max values
long	seed() Obtains the seed used to generate the random longs
long	under(long end) Obtains the next long between 0 and the upper limit (inclusive)

Methods inherited from class java.lang.Object

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

Constructor Detail

GeneratorRandom

public GeneratorRandom()

Creates a new generator random using a random seed

GeneratorRandom

public GeneratorRandom(long seed)

Creates a new seeded generator random

Parameters:

seed - the seed

Method Detail

fork

public GeneratorRandom fork()

Forks the random using a new random seed generated from this random

Returns:

the new generator random

fork

public GeneratorRandom fork(long seed)

Forks the random using the provided sed

Parameters:

seed - the seed to use

Returns:

the new generator random

under

public long under(long end)

Obtains the next long between 0 and the upper limit (inclusive)

Parameters:

end - the upper bound

Returns:

a random long

scaleUnder

public long scaleUnder(long end,
                       long min,
                       long max)

Scales the next random long between the given min and max values

Helps smooth the random distribution curve

Parameters:

end - the upper random bound

min - the minimum

max - the maximum

Returns:

the scaled random

seed

public long seed()

Obtains the seed used to generate the random longs

Returns:

the seed