net.tridentsdk.server.world.change

Class DefaultMassChange

java.lang.Object

net.tridentsdk.server.world.change.DefaultMassChange

All Implemented Interfaces:

MassChange

@NotThreadSafe
public class DefaultMassChange
extends Object
implements MassChange

The default implementation of MassChange, should be suitable for most usage cases

Should only be used by one thread, if needed by more than one, make two separate changes instead

Example usage:

 MassChange change = new DefaultMassChange(...);
 change.setBlock(...);
 change.setBlock(...);
 .
 .
 .
 change.commitChanges()

Constructor Summary

Constructors

Constructor and Description
DefaultMassChange(World world)

Method Summary

Modifier and Type	Method and Description
boolean	commitChanges() Sends the block changes to the clients and does lighting recalculations
void	setBlock(int x, int y, int z, int id) Add a change to make at when this change is committed
void	setBlock(int x, int y, int z, int id, byte data) Add a change to make at when this change is committed
void	setBlock(int x, int y, int z, Substance substance) Add a change to make at when this change is committed
void	setBlock(int x, int y, int z, Substance substance, byte data) Add a change to make at when this change is committed
void	setBlock(Position coords, int id) Add a change to make at when this change is committed
void	setBlock(Position coords, int id, byte data) Add a change to make at when this change is committed
void	setBlock(Position coords, Substance substance) Add a change to make at when this change is committed
void	setBlock(Position coords, Substance substance, byte data) Add a change to make at when this change is committed

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultMassChange

public DefaultMassChange(World world)

Method Detail

setBlock

public void setBlock(int x,
                     int y,
                     int z,
                     int id)
              throws IllegalStateException

Description copied from interface: MassChange

Add a change to make at when this change is committed

Specified by:

setBlock in interface MassChange

Parameters:

x - the x of the block to set

y - the y of the block to set

z - the z of the block to set

id - the block id to change the block to

Throws:

IllegalStateException - if this change has already been committed

setBlock

public void setBlock(int x,
                     int y,
                     int z,
                     Substance substance)
              throws IllegalStateException

Description copied from interface: MassChange

Add a change to make at when this change is committed

Specified by:

setBlock in interface MassChange

Parameters:

x - the x of the block to set

y - the y of the block to set

z - the z of the block to set

substance - the substance to change the block to

Throws:

IllegalStateException - if this change has already been committed

setBlock

public void setBlock(int x,
                     int y,
                     int z,
                     Substance substance,
                     byte data)
              throws IllegalStateException

Description copied from interface: MassChange

Add a change to make at when this change is committed

Specified by:

setBlock in interface MassChange

Parameters:

x - the x of the block to set

y - the y of the block to set

z - the z of the block to set

substance - the substance to change the block to

data - the data value to give the new block

Throws:

IllegalStateException

setBlock

public void setBlock(int x,
                     int y,
                     int z,
                     int id,
                     byte data)
              throws IllegalStateException

Description copied from interface: MassChange

Add a change to make at when this change is committed

Specified by:

setBlock in interface MassChange

Parameters:

x - the x of the block to set

y - the y of the block to set

z - the z of the block to set

id - the block id to change the block to

data - the data value to give the new block

Throws:

IllegalStateException - if this change has already been committed

setBlock

public void setBlock(Position coords,
                     int id)
              throws IllegalStateException

Description copied from interface: MassChange

Add a change to make at when this change is committed

Specified by:

setBlock in interface MassChange

Parameters:

coords - the position to set, values will be rounded

id - the id to change the block to

Throws:

IllegalStateException - if this change has already been committed

setBlock

public void setBlock(Position coords,
                     int id,
                     byte data)
              throws IllegalArgumentException,
                     IllegalStateException

Description copied from interface: MassChange

Add a change to make at when this change is committed

Specified by:

setBlock in interface MassChange

Parameters:

coords - the position to set, values will be rounded

id - the id to change the block to

data - the data value to change the block to

Throws:

IllegalArgumentException - if coords are not from the same world as this change

IllegalStateException - if this change has already been committed

setBlock

public void setBlock(Position coords,
                     Substance substance)
              throws IllegalArgumentException,
                     IllegalStateException

Description copied from interface: MassChange

Add a change to make at when this change is committed

Specified by:

setBlock in interface MassChange

Parameters:

coords - the position to set, values will be rounded

substance - the substance to change the block to

Throws:

IllegalArgumentException - if coords are not from the same world as this change

IllegalStateException - if this change has already been committed

setBlock

public void setBlock(Position coords,
                     Substance substance,
                     byte data)
              throws IllegalArgumentException,
                     IllegalStateException

Description copied from interface: MassChange

Add a change to make at when this change is committed

Specified by:

setBlock in interface MassChange

Parameters:

coords - the position to set, values will be rounded

substance - the id to change the block to

data - the data value to change the block to

Throws:

IllegalArgumentException - if coords are not from the same world as this change

IllegalStateException - if this change has already been committed

commitChanges

public boolean commitChanges()
                      throws IllegalStateException

Description copied from interface: MassChange

Sends the block changes to the clients and does lighting recalculations

This instance of MassChange will be rendered useless after this method is called, and should be discarded

Specified by:

commitChanges in interface MassChange

Returns:

Whether or not the changes were successful.

Throws:

IllegalStateException - if this change has already been committed