net.tridentsdk.world

Interface MassChange

All Known Implementing Classes:

DefaultMassChange, ThreadSafeChange

@NotThreadSafe
public interface MassChange

Change large amounts of blocks at one time

Don't forget to call commitChanges() to finish the operation

An instance of this class can be acquired using net.tridentsdk.registry.Factory#newMassChange(net.tridentsdk.world.World)

Normally, block changes cause changes to immediately be sent to the client which can be expensive with large amounts of changes being sent at once near a lot of players

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

Method Detail

setBlock

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

Add a change to make at when this change is committed

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

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

Add a change to make at when this change is committed

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

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

Add a change to make at when this change is committed

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

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

Add a change to make at when this change is committed

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

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

Add a change to make at when this change is committed

Parameters:

coords - the position to set, values will be rounded

id - the id 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

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

Add a change to make at when this change is committed

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

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

Add a change to make at when this change is committed

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

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

Add a change to make at when this change is committed

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

boolean commitChanges()
               throws IllegalStateException

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

Returns:

Whether or not the changes were successful.

Throws:

IllegalStateException - if this change has already been committed